🔥 Unit testing framework for Subgraph development on The Graph protocol. ⚙️

Hi,

when I run docker build -t matchstick . I get following error

 => ERROR [14/15] RUN npm run codegen                                                                                                6.9s
------
 > [14/15] RUN npm run codegen:
#18 1.619
#18 1.619 > nft-share-platform-ropsten@ codegen /matchstick
#18 1.619 > graph codegen
#18 1.619
#18 6.794 /matchstick/node_modules/@graphprotocol/graph-cli/src/codegen/schema.js:9
#18 6.794   static BYTES = Symbol("Bytes")
#18 6.794                ^
#18 6.794
#18 6.794 SyntaxError: Unexpected token =
#18 6.794     at Module._compile (internal/modules/cjs/loader.js:723:23)
#18 6.794     at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
#18 6.794     at Module.load (internal/modules/cjs/loader.js:653:32)
#18 6.794     at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
#18 6.794     at Function.Module._load (internal/modules/cjs/loader.js:585:3)
#18 6.794     at Module.require (internal/modules/cjs/loader.js:692:17)
#18 6.794     at require (internal/modules/cjs/helpers.js:25:18)
#18 6.794     at Object.<anonymous> (/matchstick/node_modules/@graphprotocol/graph-cli/src/schema.js:5:27)
#18 6.794     at Module._compile (internal/modules/cjs/loader.js:778:30)
#18 6.794     at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
#18 6.801 npm ERR! code ELIFECYCLE
#18 6.801 npm ERR! errno 1
#18 6.802 npm ERR! nft-share-platform-ropsten@ codegen: `graph codegen`
#18 6.803 npm ERR! Exit status 1
#18 6.803 npm ERR!
#18 6.803 npm ERR! Failed at the nft-share-platform-ropsten@ codegen script.
#18 6.804 npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
#18 6.822
#18 6.822 npm ERR! A complete log of this run can be found in:
#18 6.822 npm ERR!     /root/.npm/_logs/2022-03-16T14_58_53_712Z-debug.log
------
executor failed running [/bin/sh -c npm run codegen]: exit code: 1

This is my Dockerfile

ARG BUILDPLATFORM=linux/x86_64

ENV ARGS=""

RUN apt update
RUN apt install -y nodejs
RUN apt install -y npm
RUN apt install -y git
RUN apt install -y postgresql
RUN apt install -y curl
RUN apt install -y cmake

RUN curl -OL https://github.com/LimeChain/matchstick/releases/download/0.3.0/binary-linux-20
RUN chmod a+x binary-linux-20

RUN mkdir matchstick
WORKDIR /matchstick

COPY ../ .

RUN npm run codegen
RUN npm run build

CMD ../binary-linux-20 ${ARGS}

When I run npm run codegen in my subgraph project it finishes without error.

Host PC is Windows 11. Any ideas what went wrong?

Hi, I was trying to use version 5 on an m1 Mac, but could not get it to install the correct binary.

I downloaded the m1 binary from the release and manually replaced the one inside binary-install-raw/bin/0.5.0/binary-macos-11 - all seems to work now.

This is the error I faced:

Downloading release from https://github.com/LimeChain/matchstick/releases/download/0.5.0/binary-macos-11
binary-macos-11 has been installed!
dyld[81528]: Library not loaded: /usr/local/opt/postgresql/lib/libpq.5.dylib
  Referenced from: /Users/.../node_modules/binary-install-raw/bin/0.5.0/binary-macos-11
  Reason: tried: '/usr/local/opt/postgresql/lib/libpq.5.dylib' (no such file), '/usr/local/lib/libpq.5.dylib' (mach-o file, but is an incompatible architecture (have 'arm64', need 'x86_64')), '/usr/lib/libpq.5.dylib' (no such file)

When running graph test from /Users/<user>/code/rift/rift-subgraph/rinkeby, the following occurs:

💬 Compiling vault/updated_vault...
thread 'main' panicked at '🆘 Internal error during compilation: No such file or directory (os error 2).
Command path: "/Users/<user>/code/rift/rift-subgraph/rinkeby/node_modules/assemblyscript/bin/asc"
Globals path: "/Users/<user>/code/rift/rift-subgraph/rinkeby/node_modules/@graphprotocol/graph-ts/global/global.ts"
Libs folder: "/Users/<user>/code/rift/rift-subgraph/rinkeby/node_modules"', src/compiler.rs:131:17
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
error Command failed with exit code 101.

In /Users/<user>/code/rift/rift-subgraph/rinkeby/node_modules/assemblyscript/bin/, there exist 2 files:

• asc.js
• asinit.js

The coverage flag update in 0.2.3 does not seem to be working. I get the following error when using -c

This is the same if I try to run naively on Linux or in a dockerfile similar to the subgraph-demo setup

config:

"@graphprotocol/graph-cli": "0.25.1",
"@graphprotocol/graph-ts": "0.24.1",
"matchstick-as": "0.2.3",

Hey hi, not sure where to ask for help.

I'm basically trying to run Matchstick, which by the way amazing project. But I'm getting the following

Not sure what to do.

I have a Mac M1 but I was even trying to make it work in Ubuntu and the same problem.

Can you help please? Thanks

what should I do when encounter this error?

ERROR TS2554: Expected 15 arguments, but got 14.

 let defaultBlock = new ethereum.Block(defaultAddressBytes, defaultAddressBytes, defaultAddressBytes, defaultAddress,
    defaultAddressBytes, defaultAddressBytes, defaultAddressBytes, defaultBigInt, defaultBigInt,
    defaultBigInt, defaultBigInt, defaultBigInt, defaultBigInt, defaultBigInt);
                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 in ~lib/matchstick-as/assembly/defaults.ts(6,20)

ERROR TS2554: Expected 9 arguments, but got 8.

 let defaultTransaction = new ethereum.Transaction(defaultAddressBytes, defaultBigInt, defaultAddress,
    defaultAddress, defaultBigInt, defaultBigInt, defaultBigInt, defaultAddressBytes);
                          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 in ~lib/matchstick-as/assembly/defaults.ts(9,26)

FAILURE 2 compile error(s)
thread 'main' panicked at '🆘 Critical: Please attend to the compilation errors above!', src/main.rs:158:9

Try to find a better solution to accumulate and display the full path for each failed test, something like in the screenshot below:

The solution I came up with initially here is not reliable enough and does not handle some cases, which is a problem.

Research Estimate: 2-3 days We can provide After research is finished

This error will get thrown when he can't find the node_modules folder. thread 'main' panicked at '🆘 Path to lib "./node_modules" does not exist!', src/compiler/mod.rs:37:13 I'm in a monorepo where the node modules folder is in the root. But since my tests are in a package sub dir, I can't run these tests. Can the matchstick.yaml file be extended to provide a custom path to the node modules folder?

Matchstick version: "matchstick-as": "^0.5.4"

After running yarn test, matchstick attempts to download a binary with undefined in the path

https://github.com/LimeChain/matchstick/releases/download/undefined/binary-macos-11 returns a 404

it should be https://github.com/LimeChain/matchstick/releases/download/0.5.4/binary-macos-11

(base) ~/OpenQ-Fullstack/OpenQ-Graph > yarn test
yarn run v1.22.17
warning ../../package.json: No license field
$ graph test
Fetching latest version tag
Downloading release from https://github.com/LimeChain/matchstick/releases/download/undefined/binary-macos-11
Error fetching release: Request failed with status code 404
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Running matchstick-as 0.5.0, if there is a call that has not been mocked, the CLI output does not provide any information/context on which test case (ideally, which line in the source code!) caused it. All that is output is:

thread 'main' panicked at '🆘 Could not find a mocked function for function with address: 0xbd0d…5660, name: lp_token, signature lp_token():(address), params: [].', src/context.rs:849:13

It would be far more helpful if that context was given. Thanks!

Ubuntu 22.04 only includes libssl3 (not libssl.1.1)

matchstick: error while loading shared libraries: libssl.so.1.1: cannot open shared object file: No such file or director

Same goes for libcrypto.so.1.1.

If I link the libraries(sudo ln -s /usr/lib/x86_64-linux-gnu/libssl.so.3 /usr/lib/x86_64-linux-gnu/libssl.so.1.1, sudo ln -s /usr/lib/x86_64-linux-gnu/libcrypto.so.3 /usr/lib/x86_64-linux-gnu/libcrypto.so.1.1) I get the following error:

../matchstick: /lib/x86_64-linux-gnu/libssl.so.1.1: version `OPENSSL_1_1_0' not found (required by ../matchstick)
../matchstick: /lib/x86_64-linux-gnu/libcrypto.so.1.1: version `OPENSSL_1_1_0' not found (required by ../matchstick)

Only solution is to install an officially unsuported version:

wget archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb
sudo dpkg -i ./libssl1.1_1.1.1f-1ubuntu2_amd64.deb

I'm trying to write some tests with assertions like addressEquals and bigIntEquals because the fieldEquals assertion seems unnecessarily verbose and repetitive. However, when using these assertions compilation fails with type errors like Address is not assignable to Address and BigInt is not assignable to BigInt:

ERROR TS2322: Type '~lib/@graphprotocol/graph-ts/common/numbers/Address' is not assignable to type '~lib/matchstick-as/node_modules/@graphprotocol/graph-ts/common/numbers/Address'.

                 Address.fromBytes(nftListedEvent.nftAddress),

ERROR TS2322: Type '~lib/@graphprotocol/graph-ts/common/numbers/BigInt' is not assignable to type '~lib/matchstick-as/node_modules/@graphprotocol/graph-ts/common/numbers/BigInt'.

             assert.bigIntEquals(nftListedEvent.nftId, listing.nft.id)

I would expect the types used in the latest version of the matchstick-as package to match the types used in the latest version of the @graphprotocol/graph-ts where I import Address and BigInt from, but it seems this is not the case currently. I'm using the latest versions of @graphprotocol/[email protected], @graphprotocol/[email protected], and [email protected]. It does look like there's a 0.5.4 version of matchstick tagged on github, but that hasn't been published to npm.

Code for reference:

import { describe, test, assert, afterAll, clearStore } from 'matchstick-as'
import { Address, BigInt } from '@graphprotocol/graph-ts'
import { NftListedEvent } from '../generated/schema'
import {
    handleNftListed,
    getEventId
} from '../src/nifty'
import { createNftListedEvent } from './nifty-utils'

// No object literals or destructuring in AssemblyScript is rough >.<

class Nft {
    address: Address
    id: BigInt

    constructor(address: Address, id: BigInt) {
        this.address = address
        this.id = id
    }
}

class Listing {
    nft: Nft
    price: BigInt
    seller: Address

    constructor(nft: Nft, price: BigInt, seller: Address) {
        this.nft = nft
        this.price = price
        this.seller = seller
    }
}

let listing = new Listing(
    new Nft(
        Address.fromString('0x0000000000000000000000000000000000000001'),
        BigInt.fromI32(0)
    ),
    BigInt.fromI32(100),
    Address.fromString('0x0000000000000000000000000000000000000002')
)

describe('Events', () => {
    afterAll(() => {
        clearStore()
    })

    describe('NftListed', () => {
        test('stores an NftListedEvent entity', () => {
            let event = createNftListedEvent(
                listing.nft.address,
                listing.nft.id,
                listing.price,
                listing.seller
            )
            handleNftListed(event)

            let nftListedEvent = NftListedEvent.load(getEventId(event))

            if (nftListedEvent == null) {
                throw new Error('NftListedEvent not found')
            }

            assert.entityCount('NftListedEvent', 1)
            assert.addressEquals(
                Address.fromBytes(nftListedEvent.nftAddress),
                listing.nft.address
            )
            assert.bigIntEquals(nftListedEvent.nftId, listing.nft.id)
            assert.bigIntEquals(nftListedEvent.price, listing.price)
            assert.addressEquals(
                Address.fromBytes(nftListedEvent.seller),
                listing.seller
            )
        })
    })
})

Given the following schema

holders: [OfferHolder!]! @derivedFrom(field: "offer")

If there are no holders shouldn't it return an empty array? I have an older subgraph that works in this way and couldn't find any documentation on if this has changed?

With the above calling

offers.holders.length

results in an unexpected null error, alternatively if I make the field look this way

holders: [OfferHolder!] @derivedFrom(field: "offer")

It always returns null even if there are holders present

Also important to check what dependencies completing this task has - if it requires more than just the sfeth dependency to run firehose (like for example the geth node) revisit this assignment with someone from the graph. Firehose integration should be as decoupled as possible.

This relies on #364 being done

May require you to create a 1 transaction blocks if the traces given are per transaction and not per block since firehose only works with bundles of blocks.