Usage

For details about the technical architecture and to contribute, see the GitHub repository.
For questions, reach out on the Polygon R&D Discord.

Installation

Install the package using npm or Yarn.

npm install @maticnetwork/chain-indexer-framework

yarn add @maticnetwork/chain-indexer-framework

// Import the chain-indexer-framework module
const chain-indexer-framework = require('@maticnetwork/chain-indexer-framework');

The repository includes two prebuilt examples that cover the full producer-transformer-consumer pipeline:

MATIC transfer indexer: indexes MATIC transfer events from the Ethereum blockchain.
NFT balancer: indexes NFT transfers and maintains NFT balances.

See the examples README for setup instructions.

⌘I