transactions-with-internals-and-reverts

Index EVM transactions including internal calls and revert reasons

This repository shows how to listen to EVM transactions (include internal transactions) and store them in your database. It also tracks failed transactions and automatically resolves the revert reason.

Table of Contents

• 🏁 Getting Started
• 💎 Examples
• 🚀 Next Steps
• 🤔 FAQ

Getting Started

1️⃣ Clone this repo:

git clone https://github.com/flair-sdk/starter-boilerplate.git transactions-with-internals-and-reverts
cd transactions-with-internals-and-reverts

2️⃣ Install packages and authenticate:

pnpm i
pnpm flair auth

3️⃣ Set the namespace and config.json:

config.dev.json and config.prod.json are sample configs for dev and prod clusters.

Set a globally unique namespace in each config file (recommended to use {ORG_NAME}-{ENV}; e.g sushiswap-dev or sushiswap-prod) and then run:

# Setting configs for dev testing
cp config.dev.json config.json

# Or setting it for production
cp config.prod.json config.json

4️⃣ Generate manifest.yml and deploy:

pnpm generate-and-deploy

For the first time it'll take few minutes to create your cluster components.

5️⃣ Backfill certain contracts or block ranges:

# Index last recent 100 blocks of a contract like this:
pnpm flair backfill --chain 1 --address 0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc -d backward --max-blocks 100 --emit evm-transactions

Or you can backfill for a specific block number, if you have certain events you wanna test with:

pnpm flair backfill --chain 1 -b 17998797 --emit evm-transactions

Or backfill for the recent data in the last X minutes:

pnpm flair backfill --chain 1 --min-timestamp="5 mins ago" -d backward --emit evm-transactions

6️⃣ Look at the logs:

pnpm flair logs --full -tag Level=warn
pnpm flair logs --full -tag TransactionHash=0xXXXXX
pnpm flair logs --full -tag ProcessorId=swap-events
pnpm flair logs --full -tag ProcessorId=swap-events --watch

7️⃣ Explore the data in playground:

Visit the playground and run the following query in Examples section.

Examples

Get all entity types total count

• Method: POST
• Endpoint: https://api.flair.build/
• Headers: X-API-KEY: <your-api-key>
• Body:

query {
  sql(
    query: """
      SELECT
          COUNT(*) as totalCount,
          entityType
      FROM
          entities
      WHERE
          namespace = 'transactions-with-internals-and-reverts-dev'
      GROUP BY entityType
      ORDER BY totalCount DESC
      LIMIT 10
    """
  ) {
    stats {
      elapsedMs
    }
    rows
  }
}

Next Steps

You can use the Database real-time syncing mechanism to push the historical and real-time. Visit Database docs on how to do it.

FAQ

Q: How do I enable/disable real-time ingestion for indexer?
A: For each indexer defined in config.json, you can enable/disable it via the enabled: true/false flag. Remember to run pnpm generate-and-deploy for the changes to apply on the cluster.