Envio HyperIndex

https://docs.envio.dev/docs/
Admin
Envio HyperIndex is a blazing-fast, developer-friendly multichain blockchain indexer that transforms...
Tokens:174,739
Snippets:2,393
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Go Client

Source: https://docs.envio.dev/docs/HyperSync/hypersync-clients

Install the community-maintained Go client using the go get command.

```bash
go get github.com/enviodev/hypersync-client-go
```

--------------------------------

### Clone the HyperSync quickstart repository

Source: https://docs.envio.dev/docs/HyperSync/hypersync-quickstart

Download the minimal example repository to begin working with HyperSync.

```bash
git clone https://github.com/enviodev/hypersync-quickstart.git
cd hypersync-quickstart
```

--------------------------------

### Clone and Setup evm-address-summary

Source: https://docs.envio.dev/docs/HyperSync/tutorial-address-transactions

Commands to clone the repository and install necessary dependencies.

```bash
git clone https://github.com/enviodev/evm-address-summary.git
cd evm-address-summary
```

```bash
pnpm install
```

--------------------------------

### Start Frontend

Source: https://docs.envio.dev/docs/HyperIndex/scaffold-eth-2-extension-tutorial

Launch the Scaffold-ETH frontend application.

```bash
yarn start
```

--------------------------------

### Run HyperIndex Development Commands

Source: https://docs.envio.dev/docs/HyperIndex/solana/getting-started

Standard commands to install dependencies, generate types, and start the local development environment.

```bash
pnpm install            # if you didn't let init do it
pnpm envio codegen      # regenerate types from config.yaml + schema.graphql
pnpm envio dev          # start Postgres + the indexer + GraphQL (Docker)
```

```bash
pnpm envio local docker up   # start Postgres + Hasura
pnpm envio codegen
pnpm envio start             # run the indexer against the running stack
```

--------------------------------

### Start Envio Indexer

Source: https://docs.envio.dev/docs/HyperIndex/scaffold-eth-2-extension-tutorial

Navigate to the Envio package directory and start the indexing process.

```bash
cd packages/envio
pnpm dev
```

--------------------------------

### Install Python Client

Source: https://docs.envio.dev/docs/HyperSync/hypersync-clients

Install the HyperSync Python package via pip.

```bash
pip install hypersync
```

--------------------------------

### Finalize Initialization

Source: https://docs.envio.dev/docs/HyperIndex/tutorial-indexing-fuel

Complete the setup process by selecting the finish option.

```text
? Would you like to add another contract?
> I'm finished
  Add a new address for same contract on same network
  Add a new contract (with a different ABI)
[Current contract: SwayFarm, on network: Fuel]
```

--------------------------------

### Protocol Mapping Examples

Source: https://docs.envio.dev/docs/HyperIndex/websockets

Examples showing the conversion of HTTP/HTTPS endpoints to WS/WSS for WebSocket connections.

```text
https://indexer.hyperindex.xyz/123abcd/graphql
```

```text
wss://indexer.hyperindex.xyz/123abcd/graphql
```

```text
http://localhost:8080/v1/graphql
```

```text
ws://localhost:8080/v1/graphql
```

--------------------------------

### Start Local Blockchain

Source: https://docs.envio.dev/docs/HyperIndex/scaffold-eth-2-extension-tutorial

Launch the local development blockchain node.

```bash
cd your-project-name
yarn chain
```

--------------------------------

### Install project dependencies

Source: https://docs.envio.dev/docs/HyperSync/hypersync-quickstart

Install the required packages using pnpm.

```bash
# Using pnpm (recommended)
pnpm install
```

--------------------------------

### Corrected Configuration and Schema Examples

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Examples showing how to rename entities to avoid reserved word conflicts.

```yaml
contracts:  - name: ClassContract # Good: Not a reserved word    abi_file_path: ./abis/MyContract.json
```

```graphql
type UserInterface { # Good: Not a reserved word  id: ID!  name: String!}
```

--------------------------------

### Finish Contract Setup

Source: https://docs.envio.dev/docs/HyperIndex/quickstart

Decide whether to add more contracts or complete the initialization process.

```bash
? Would you like to add another contract?
> I'm finished
  Add a new address for same contract on same network
  Add a new network for same contract
  Add a new contract (with a different ABI)
```

--------------------------------

### envio start

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Runs the indexer in a production environment.

```APIDOC
## envio start

### Description
Executes the indexer in a production-ready mode.

### Usage
`envio start`
```

--------------------------------

### Install Dependencies

Source: https://docs.envio.dev/docs/HyperIndex/websockets

Commands to install the necessary packages for WebSocket support in a Node.js environment.

```bash
npm install graphql-ws ws
# or
yarn add graphql-ws ws
```

--------------------------------

### Start Local Development Indexer

Source: https://docs.envio.dev/docs/HyperIndex/greeter-tutorial

Initializes the local development environment and begins indexing data.

```bash
pnpm dev
```

--------------------------------

### Install Envio Cloud CLI

Source: https://docs.envio.dev/docs/HyperIndex/envio-cloud-cli

Install the CLI globally using npm or execute it directly using npx.

```bash
npm install -g envio-cloud
```

```bash
npx envio-cloud <command>
```

--------------------------------

### Ponder configuration example

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Example of a Ponder configuration file using TypeScript.

```typescript
export default createConfig({  chains: {    mainnet: { id: 1, rpc: process.env.PONDER_RPC_URL_1 },  },  contracts: {    MyToken: {      abi: myTokenAbi,      chain: "mainnet",      address: "0xabc...",      startBlock: 18000000,    },  },});
```

--------------------------------

### Install Rust Client

Source: https://docs.envio.dev/docs/HyperSync/hypersync-clients

Add the hypersync-client and tokio dependencies to your Cargo.toml file.

```toml
[dependencies]
hypersync-client = "0.1"
tokio = { version = "1", features = ["full"] }
```

--------------------------------

### Configure start block

Source: https://docs.envio.dev/docs/HyperIndex/running-locally

Sets a recent start block in config.yaml to speed up development iteration.

```yaml
- id: 1 # Ethereum mainnet
  start_block: 19000000 # Recent block for faster dev iteration
```

--------------------------------

### Install Node.js HyperSync Client

Source: https://docs.envio.dev/docs/HyperSync/hypersync-clients

Commands to install the HyperSync client package using common Node.js package managers.

```bash
# Using npm
npm install @envio-dev/hypersync-client

# Using yarn
yarn add @envio-dev/hypersync-client

# Using pnpm
pnpm add @envio-dev/hypersync-client
```

--------------------------------

### Initialize HyperIndex Project

Source: https://docs.envio.dev/docs/HyperIndex/quickstart

Select the Contract Import option during the initial project setup.

```bash
? Choose an initialization option
  Template
> Contract Import
[↑↓ to move, enter to select]
```

--------------------------------

### Configure start block

Source: https://docs.envio.dev/docs/HyperIndex/configuration-file

Define the starting block for data ingestion. Setting to 0 allows HyperSync to automatically find the first relevant block.

```yaml
chains:
  - id: 1
    start_block: 0 # HyperSync will fast-forward to the first relevant block
    contracts:
      - name: Greeter
        address: "0x9D02A17dE4E68545d3a58D3a20BbBE0399E05c9c"
```

--------------------------------

### Define Environment Variables

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Example of required environment variables for HyperSync access and service configuration.

```text
ENVIO_API_TOKEN=your-secret-token
ENVIO_RPC_URL=https://arbitrum.direct.dev/your-api-key
ENVIO_COINGECKO_API_KEY=api-key
ENVIO_TUI=false
```

--------------------------------

### Define Block Range

Source: https://docs.envio.dev/docs/HyperIndex/error-codes

Example of valid start and end block configuration where the end block exceeds the start block.

```yaml
start_block: 10000000
end_block: 20000000 # Must be greater than start_block
```

--------------------------------

### Get All Transactions for an Address

Source: https://docs.envio.dev/docs/HyperSync/hypersync-curl-examples

Retrieves transactions involving a specific address as either sender or receiver, starting from block 15,362,000.

```bash
curl --request POST \
  --url https://eth.hypersync.xyz/query \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "from_block": 15362000,
    "transactions": [
        {
            "from": ["0xdb255746609baadd67ef44fc15b5e1d04befbca7"]
        },
        {
            "to": ["0xdb255746609baadd67ef44fc15b5e1d04befbca7"]
        }
    ],
    "field_selection": {
        "block": [
            "number",
            "timestamp",
            "hash"
        ],
        "transaction": [
            "block_number",
            "transaction_index",
            "hash",
            "from",
            "to"
        ]
    }
}'
```

--------------------------------

### Post-Initialization Instruction

Source: https://docs.envio.dev/docs/HyperIndex/tutorial-indexing-fuel

Command to navigate into the newly created project directory.

```bash
Please run `cd sway-farm-indexer` to run the rest of the envio commands
```

--------------------------------

### Choose Initialization Option

Source: https://docs.envio.dev/docs/HyperIndex/greeter-tutorial

Select the initialization method for the new indexer project.

```text
? Choose an initialization option
> Template
  Contract Import
```

--------------------------------

### Get All Logs for a Smart Contract

Source: https://docs.envio.dev/docs/HyperSync/hypersync-curl-examples

Retrieves all event logs emitted by a specific contract address starting from block 0.

```bash
curl --request POST \
  --url https://eth.hypersync.xyz/query \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "from_block": 0,
    "logs": [
        {
            "address": ["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]
        }
    ],
    "field_selection": {
        "block": [
            "number",
            "timestamp",
            "hash"
        ],
        "log": [
            "block_number",
            "log_index",
            "transaction_index",
            "data",
            "address",
            "topic0",
            "topic1",
            "topic2",
            "topic3"
        ],
        "transaction": [
            "block_number",
            "transaction_index",
            "hash",
            "from",
            "to",
            "value",
            "input"
        ]
    }
}'
```

--------------------------------

### Get Blob Data for the Optimism Chain

Source: https://docs.envio.dev/docs/HyperSync/hypersync-curl-examples

Retrieves type 3 blob transactions from the Optimism sequencer address starting from block 20,000,000.

```bash
curl --request POST \
  --url https://eth.hypersync.xyz/query \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "from_block": 20000000,
    "transactions": [
        {
            "from": ["0x6887246668a3b87F54DeB3b94Ba47a6f63F32985"],
            "to": ["0xFF00000000000000000000000000000000000010"],
            "type": [3]
        }
    ],
    "field_selection": {
        "block": [
            "number",
            "timestamp",
            "hash"
        ],
        "transaction": [
            "block_number",
            "transaction_index",
            "hash",
            "from",
            "to",
            "type"
        ]
    }
}'
```

--------------------------------

### Get Successful or Failed Transactions

Source: https://docs.envio.dev/docs/HyperSync/hypersync-curl-examples

Queries transactions based on status (1 for success, 0 for failure) by dynamically calculating the starting block from the current chain height.

```bash
# Get current height and calculate starting block
height=$((`curl https://eth.hypersync.xyz/height | jq .height` - 10))

# Query successful transactions (change status to 0 for failed transactions)
curl --request POST \
  --url https://eth.hypersync.xyz/query \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data "{
    \"from_block\": ${height},
    \"transactions\": [
        {
            \"status\": 1
        }
    ],
    \"field_selection\": {
        \"block\": [
            \"number\",
            \"timestamp\",
            \"hash\"
        ],
        \"transaction\": [
            \"block_number\",
            \"transaction_index\",
            \"hash\",
            \"from\",
            \"to\"
        ]
    }
  }"
```

--------------------------------

### Initialize HyperIndex Project

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

CLI prompts for setting up a new indexer project, including folder naming, language selection, ecosystem choice, and initialization method.

```text
? Specify a folder name (ENTER to skip): sway-farm-indexer
```

```text
? Which language would you like to use?  JavaScript> TypeScript  ReScript[↑↓ to move, enter to select, type to filter]
```

```text
? Choose blockchain ecosystem  Evm> Fuel[↑↓ to move, enter to select, type to filter]
```

```text
? Choose an initialization option  Template> Contract Import[↑↓ to move, enter to select, type to filter]
```

```text
? What is the path to your json abi file? ./sway-farm/contract/out/debug/contract-abi.json
```

--------------------------------

### Choose Initialization Option

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Prompt for selecting the initialization method.

```text
? Choose an initialization option> Template  Contract Import
```

--------------------------------

### Override Start Block per Contract

Source: https://docs.envio.dev/docs/HyperIndex/configuration-file

Specify a custom start block for individual contracts to override the default chain-level start block.

```yaml
chains:
  - id: 1 # ethereum-mainnet
    start_block: 18000000 # Default start block for all contracts on this chain
    contracts:
      - name: ERC20
        address:
          - "0x1111111111111111111111111111111111111111"
          - "0x2222222222222222222222222222222222222222"
        start_block: 18500000 # Override for this contract
      - name: Greeter
        address: "0x9D02A17dE4E68545d3a58D3a20BbBE0399E05c9c"
        # Uses chain default (18000000)
```

--------------------------------

### Initialize a Solana Project

Source: https://docs.envio.dev/docs/HyperIndex/whats-new-in-v3

Use the CLI to initialize a new project configured for Solana (SVM) indexing.

```bash
pnpx envio init svm
```

--------------------------------

### Create Scaffold-ETH 2 Project with Envio

Source: https://docs.envio.dev/docs/HyperIndex/scaffold-eth-2-extension-tutorial

Initialize a new project using the Envio extension template.

```bash
npx create-eth@latest -e enviodev/scaffold-eth-2-extension
```

--------------------------------

### Run HyperSync example scripts

Source: https://docs.envio.dev/docs/HyperSync/hypersync-quickstart

Execute different versions of the Uniswap V3 event retrieval scripts.

```bash
# Run minimal version (recommended for beginners)
node run-simple.js

# Run full version with progress bar
node run.js

# Run version with terminal UI
node run-tui.js
```

--------------------------------

### Contract Initialization CLI

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Commands used during the interactive setup process for naming, addressing, and finishing the indexer initialization.

```text
? What is the name of this contract? SwayFarm
```

```text
? What is the address of the contract? 0xf5b08689ada97df7fd2fbd67bee7dea6d219f117c1dc9345245da16fe4e99111[Use the proxy address if your abi is a proxy implementation]
```

```text
? Would you like to add another contract?> I'm finished  Add a new address for same contract on same network  Add a new contract (with a different ABI)[Current contract: SwayFarm, on network: Fuel]
```

--------------------------------

### Start Indexer with Benchmarking

Source: https://docs.envio.dev/docs/HyperIndex/benchmarking

Enable performance metric collection during indexer execution. Do not use in production as it consumes memory and writes to disk.

```bash
pnpm envio start --bench
```

--------------------------------

### Configure Per-Event Start Blocks

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Overrides start blocks per chain using the where callback in event handlers.

```javascript
indexer.onEvent(  {    contract: "UniV4",    event: "Pool",    where: ({ chain }) => {      let startBlock: number;      switch (chain.id) {        case 1:          startBlock = 18_000_000;          break;        case 8453:          startBlock = 2_000_000;          break;        default: {          const _exhaustive: never = chain.id;          return false;        }      }      return {        block: { number: { _gte: startBlock } },      };    },  },  async ({ event, context }) => {    // Handler logic  },);
```

--------------------------------

### Choose Initialization Option

Source: https://docs.envio.dev/docs/HyperIndex/tutorial-indexing-fuel

Select the initialization method; Contract Import is used for existing contracts.

```text
? Choose an initialization option
  Template
> Contract Import
[↑↓ to move, enter to select, type to filter]
```

--------------------------------

### Invalid Configuration and Schema Examples

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Examples of configuration and schema definitions that use reserved words, which will cause errors.

```yaml
contracts:  - name: class # Error: 'class' is a reserved word in JavaScript    abi_file_path: ./abis/MyContract.json
```

```graphql
type interface { # Error: 'interface' is a reserved word in JavaScript and TypeScript  id: ID!  name: String!}
```

--------------------------------

### Deploy and Manage Indexers via CLI

Source: https://docs.envio.dev/docs/HyperIndex/quickstart-with-ai

Install the CLI and execute commands for authentication, adding indexers, and monitoring deployments. All commands support JSON output for integration with scripts.

```bash
npm install -g envio-cloud

envio-cloud login --token $ENVIO_GITHUB_TOKEN
envio-cloud indexer add --name my-indexer --repo my-repo
envio-cloud deployment status my-indexer <commit> --watch-till-synced
envio-cloud deployment logs my-indexer <commit> --follow
```

--------------------------------

### Configure Per-Event Start Blocks

Source: https://docs.envio.dev/docs/HyperIndex/whats-new-in-v3

Specify custom start blocks per chain within the where callback to override global configurations.

```typescript
indexer.onEvent(
  {
    contract: "UniV4",
    event: "Pool",
    where: ({ chain }) => {
      let startBlock: number;
      switch (chain.id) {
        case 1:
          startBlock = 18_000_000;
          break;
        case 8453:
          startBlock = 2_000_000;
          break;
        default: {
          const _exhaustive: never = chain.id;
          return false;
        }
      }
      return {
        block: { number: { _gte: startBlock } },
      };
    },
  },
  async ({ event, context }) => {
    // Handler logic
  },
);
```

--------------------------------

### Configure HyperSync for Different Networks

Source: https://docs.envio.dev/docs/HyperSync/hypersync-quickstart

Demonstrates how to initialize the HypersyncClient for various EVM-compatible networks by updating the URL.

```javascript
// Ethereum Mainnet
const client = new HypersyncClient({
  url: "https://eth.hypersync.xyz",
  apiToken: process.env.ENVIO_API_TOKEN!,
});

// Arbitrum
const client = new HypersyncClient({
  url: "https://arbitrum.hypersync.xyz",
  apiToken: process.env.ENVIO_API_TOKEN!,
});

// Base
const client = new HypersyncClient({
  url: "https://base.hypersync.xyz",
  apiToken: process.env.ENVIO_API_TOKEN!,
});
```

--------------------------------

### Select Blockchain for Block Explorer Import

Source: https://docs.envio.dev/docs/HyperIndex/quickstart

Choose the target network from the list of supported EVM-compatible chains.

```bash
? Which blockchain would you like to import a contract from?
> ethereum-mainnet
  goerli
  optimism
  base
  bsc
  gnosis
  polygon
[↑↓ to move, enter to select]
```

--------------------------------

### GET /health

Source: https://docs.envio.dev/docs/HyperSync/solana

Performs a health check on the service.

```APIDOC
## GET /health

### Description
Performs a health check on the service.

### Method
GET

### Endpoint
/health
```

--------------------------------

### Run Codegen and Development Server

Source: https://docs.envio.dev/docs/HyperIndex/migrate-to-v3

Execute these commands to generate code and start the development environment after migration.

```bash
pnpm envio codegen
pnpm dev
```

--------------------------------

### GET /height

Source: https://docs.envio.dev/docs/HyperSync/solana

Retrieves the current synced slot number.

```APIDOC
## GET /height

### Description
Retrieves the current synced slot number in JSON format.

### Method
GET

### Endpoint
/height
```

--------------------------------

### GET /height

Source: https://docs.envio.dev/docs/HyperSync/hypersync-curl-examples

Retrieves the current block height of the chain.

```APIDOC
## GET /height

### Description
Returns the current block height of the indexed chain.

### Method
GET

### Endpoint
https://eth.hypersync.xyz/height

### Response
#### Success Response (200)
- **height** (integer) - The current block height.
```

--------------------------------

### Select Events to Index

Source: https://docs.envio.dev/docs/HyperIndex/tutorial-indexing-fuel

Choose specific events from the ABI to index. The first example shows all available events, and the second shows the selection for the tutorial.

```text
? Which events would you like to index?
> [x] NewPlayer
  [x] PlantSeed
  [x] SellItem
  [x] InvalidError
  [x] Harvest
  [x] BuySeeds
  [x] LevelUp
[↑↓ to move, space to select one, → to all, ← to none, type to filter]
```

```text
? Which events would you like to index?
> [x] NewPlayer
  [ ] PlantSeed
  [x] SellItem
  [ ] InvalidError
  [ ] Harvest
  [ ] BuySeeds
  [x] LevelUp
[↑↓ to move, space to select one, → to all, ← to none, type to filter]
```

--------------------------------

### Initialize a HyperIndex project

Source: https://docs.envio.dev/docs/HyperIndex/migrate-from-alchemy

Use this command to scaffold a new HyperIndex project using a template.

```bash
pnpx envio init template --name alchemy-migration --directory alchemy-migration --template  greeter --api-token "YOUR_ENVIO_API_KEY"
```

--------------------------------

### GET /height/sse

Source: https://docs.envio.dev/docs/HyperSync/solana

Provides a server-sent events stream of the head slot.

```APIDOC
## GET /height/sse

### Description
Provides a server-sent events stream of the head slot.

### Method
GET

### Endpoint
/height/sse
```

--------------------------------

### GET /health

Source: https://docs.envio.dev/docs/HyperSync/solana-curl-examples

Checks the health status of the Solana HyperSync service.

```APIDOC
## GET /health

### Description
Returns the health status of the Solana HyperSync service.

### Method
GET

### Endpoint
https://solana.hypersync.xyz/health
```

--------------------------------

### List Repositories

Source: https://docs.envio.dev/docs/HyperIndex/envio-cloud-cli

List all repositories associated with the authenticated account.

```bash
envio-cloud repos
envio-cloud repos -o json
```

--------------------------------

### Initialize Envio Indexer

Source: https://docs.envio.dev/docs/HyperIndex/contract-state

Command to initialize a new Envio project.

```bash
pnpx envio init
```

--------------------------------

### Select Programming Language

Source: https://docs.envio.dev/docs/HyperIndex/greeter-tutorial

Choose the preferred language for writing event handlers during project setup.

```text
? Which language would you like to use?
> JavaScript
  TypeScript
  ReScript
```

--------------------------------

### Define GraphQL Schema

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Example of a GraphQL type definition for an indexer schema.

```graphql
type UserInterface { # Good: Not a reserved word  id: ID!  name: String!}
```

--------------------------------

### Calculating Financial Fees

Source: https://docs.envio.dev/docs/HyperIndex/schema

Example of applying a fee rate to an amount with rounding.

```typescript
function calculateFee(amount: BigDecimal, feeRate: BigDecimal): BigDecimal {
  // Calculate fee with proper rounding
  return amount.times(feeRate).dp(2);
}

const tradeAmount = new BigDecimal("1250.75");
const feeRate = new BigDecimal("0.0025"); // 0.25%
const fee = calculateFee(tradeAmount, feeRate); // 3.13
```

--------------------------------

### Initialize the Hypersync Client

Source: https://docs.envio.dev/docs/HyperSync/hypersync-quickstart

Instantiate the client with a network URL and an API token.

```javascript
import { HypersyncClient } from "@envio-dev/hypersync-client";

// Initialize Hypersync client
const client = new HypersyncClient({
  url: "https://eth.hypersync.xyz", // Change this URL for different networks
  apiToken: process.env.ENVIO_API_TOKEN!,
});
```

--------------------------------

### Project directory structure

Source: https://docs.envio.dev/docs/HyperIndex/solana/getting-started

The standard file layout generated after running the initialization command.

```text
my-indexer/
├── config.yaml          # chain + program/instruction selection
├── schema.graphql       # the entities you index into
├── src/
│   └── handlers/…ts     # your onInstruction / onSlot handlers
├── .env                 # ENVIO_API_TOKEN, RPC URL
└── package.json
```

--------------------------------

### Indexing Metadata Response

Source: https://docs.envio.dev/docs/HyperIndex/observability

Example JSON response structure for the _meta query.

```json
{
  "data": {
    "_meta": [
      {
        "chainId": 1,
        "progressBlock": 22817138,
        "eventsProcessed": 2380000,
        "bufferBlock": 22820499,
        "firstEventBlock": 21688545,
        "sourceBlock": 23368264,
        "readyAt": null,
        "isReady": false,
        "startBlock": 0,
        "endBlock": null
      },
      {
        "chainId": 10,
        "progressBlock": 137848820,
        "eventsProcessed": 2455000,
        "bufferBlock": 137873621,
        "firstEventBlock": 130990676,
        "sourceBlock": 141168975,
        "readyAt": null,
        "isReady": false,
        "startBlock": 0,
        "endBlock": null
      }
    ]
  }
}
```

--------------------------------

### Define Ponder Schema

Source: https://docs.envio.dev/docs/HyperIndex/migrate-from-ponder

Example of a Ponder schema definition using TypeScript.

```typescript
import { onchainTable, primaryKey, index } from "ponder";

export const token = onchainTable("token", (t) => ({
  address: t.hex().primaryKey(),
  symbol: t.text().notNull(),
  balance: t.bigint().notNull(),
}));

export const transferEvent = onchainTable(
  "transfer_event",
  (t) => ({
    id: t.text().primaryKey(),
    from: t.hex().notNull(),
    to: t.hex().notNull(),
    amount: t.bigint().notNull(),
    timestamp: t.integer().notNull(),
  }),
  (table) => ({
    fromIdx: index().on(table.from),
  }),
);
```

--------------------------------

### Initialize HyperIndex Project

Source: https://into.md/https:/docs.envio.dev/docs/HyperIndex-LLM/hyperindex-complete

Initial prompt to select the project initialization method.

```text
? Choose an initialization option  Template> Contract Import[↑↓ to move, enter to select]
```

--------------------------------

### Define RPC URL

Source: https://docs.envio.dev/docs/HyperIndex/error-codes

Example of a correctly formatted RPC URL string.

```text
https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY
```

--------------------------------

### GET /height/sse

Source: https://docs.envio.dev/docs/HyperSync/solana-curl-examples

Streams the current block height using Server-Sent Events.

```APIDOC
## GET /height/sse

### Description
Streams height updates via Server-Sent Events. Use `curl -N` to disable buffering.

### Method
GET

### Headers
- **Accept**: text/event-stream
```
Tokens:
Raw