This package provides customizable ready-made processor scripts for ERC721 or ERC1155 NFT tokens, collections and metadata fetching using Flair indexer.
-
Make sure you have created your indexing cluster as described in Getting Started.
-
Install the solution package:
pnpm install @flair-sdk/solution-indexing-nft
- Add the solution to your manifest.yml.mustache usually created from starter-boilerplate repository:
# ./manifest.yml.mustache
# ...
# Usually each indexing cluster has defined one or more filter groups.
# For this solution you need a filter group that contains addresses of ERC721 contracts.
# Also, this solution will add relevant event "topics" for ERC721 Transfer and Approval events
# so that they are emitted for processing.
#
# Note: if you have a factory contract, or need to dynamically add addresses it is possible,
# refer to examples repository (https://github.com/flair-sdk/examples).
filterGroups:
- id: default
updateStrategy: replace
addresses:
- fromFile: ./contracts.csv
# ...
solutions:
- source: '@flair-sdk/solution-indexing-nft'
config:
erc721:
enabled: true
erc1155:
enabled: false
addTopicsToFilterGroup: default
env:
MY_ENV_VAR: my-value
metadata:
resolveUri: true
fetchContent: true
ipfsGateways:
- endpoint: https://ipfs.io/ipfs/
headers:
x-api-key: my-api-key
arweaveGateways:
- endpoint: https://arweave.net/
headers:
x-api-key: my-api-key
- Deploy your cluster:
pnpm generate-and-deploy