regen-score-squid's Introduction

Squid ABI template

An experimental template is used to generate a squid that indexes EVM logs and transactions of choice from a contract address. Supports automatic ABI lookups for public contracts using the Etherscan API

Usage

Install the Squid CLI:

npm i -g @subsquid/cli

Init the template and install the dependencies

sqd init my-abi-squid --template https://github.com/subsquid/squid-abi-template
cd my-abi-squid
npm i

Run sqd generate with the appropriate flags.

Usage: sqd generate [options]

Options:
  --address <contract>      contract address
  --archive <url>           archive endpoint 
  --abi <path>              (Optional) path or URL to the abi file. If omitted, the Etherscan API is used.
  -e, --event <name...>     one or multiple events to be indexed. '*' will index all events
  -f, --function <name...>. one or multiple contract functions to be indexed. '*' will index all functions
  --from <block>            start indexing from the given block. 
  --etherscan-api <url>     (Optional) an Etherscan-compatible API to fetch contract ABI by a known address. Default: https://api.etherscan.io/

Build and run the squid

sqd build
sqd up
sqd migration:generate
sqd process

The indexing will start.

In a separate window, start the GraphQL API server at localhost:4350/graphql:

sqd serve

Inspect schema.graphql, src/processor.ts and start hacking!

For more details on how to build and deploy a squid, see the docs.

Example

Generate

npx squid-gen-abi \
--address 0x2E645469f354BB4F5c8a05B3b30A929361cf77eC \
--archive https://eth.archive.subsquid.io \
--event NewGravatar \
--event UpdatedGravatar \
--function createGravatar \
--from 6000000

Explore

query MyQuery {
  events(orderBy: block_timestamp_ASC) {
    id
    name
    block {
      number
      timestamp
    }
    ... on NewGravatarEvent {
      id0
      imageUrl
      owner
    }
    ... on UpdatedGravatarEvent {
      id0
      imageUrl
      owner
    }
  }
}