Skip to content

feat: added scaffold eth 2 extension tutorial #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keenbeen32 merged 1 commit into from
Sep 23, 2025
Merged

feat: added scaffold eth 2 extension tutorial #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions docs/HyperIndex/Tutorials/tutorial-scaffold-eth-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
id: tutorial-scaffold-eth-2
title: Scaffold-Eth-2 Envio Extension
sidebar_label: Scaffold-Eth-2 Extension
slug: /scaffold-eth-2-extension-tutorial
---

# Scaffold-Eth-2 Envio Extension

## Introduction

The Scaffold-ETH 2 Envio extension makes indexing your deployed smart contracts as simple as possible. Generate a boilerplate indexer for your deployed contracts with a single click and start indexing their events immediately.

With this extension, you get:
- 🔍 **Automatic indexer generation** from your deployed contracts
- 📊 **Status dashboard** with links to Envio metrics and database
- 🔄 **One-click regeneration** to update the indexer when you deploy new contracts
- 📈 **GraphQL API** for querying your indexed blockchain data

## Prerequisites

Before starting, ensure you have the following installed:

- **[Node.js v20](https://nodejs.org/en/download/current)** _(v20 or newer required)_
- **[pnpm](https://pnpm.io/installation)** _(for Envio indexer)_
- **[Docker Desktop](https://www.docker.com/products/docker-desktop/)** _(required to run the Envio indexer locally)_
- **[Yarn](https://yarnpkg.com/getting-started/install)** _(for Scaffold-ETH)_

Comment on lines +24 to +28
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add Foundry (Anvil/Forge) to prerequisites.

Steps use yarn chain and yarn deploy which, in Scaffold‑ETH 2 defaults, rely on Foundry (anvil/forge). Without it, the tutorial will fail.

 - **[Yarn](https://yarnpkg.com/getting-started/install)** _(for Scaffold-ETH)_
+
+Recommended (if using the default Scaffold‑ETH 2 setup):
+- **[Foundry (anvil & forge)](https://book.getfoundry.sh/getting-started/installation)** _(required for `yarn chain` and `yarn deploy` in the default template)_
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **[Node.js v20](https://nodejs.org/en/download/current)** _(v20 or newer required)_
- **[pnpm](https://pnpm.io/installation)** _(for Envio indexer)_
- **[Docker Desktop](https://www.docker.com/products/docker-desktop/)** _(required to run the Envio indexer locally)_
- **[Yarn](https://yarnpkg.com/getting-started/install)** _(for Scaffold-ETH)_
- **[Node.js v20](https://nodejs.org/en/download/current)** _(v20 or newer required)_
- **[pnpm](https://pnpm.io/installation)** _(for Envio indexer)_
- **[Docker Desktop](https://www.docker.com/products/docker-desktop/)** _(required to run the Envio indexer locally)_
- **[Yarn](https://yarnpkg.com/getting-started/install)** _(for Scaffold-ETH)_
Recommended (if using the default Scaffold-ETH 2 setup):
- **[Foundry (anvil & forge)](https://book.getfoundry.sh/getting-started/installation)** _(required for `yarn chain` and `yarn deploy` in the default template)_
🤖 Prompt for AI Agents 
In docs/HyperIndex/Tutorials/tutorial-scaffold-eth-2.md around lines 24 to 28,
the prerequisites list omits Foundry (Anvil/Forge) which Scaffold‑ETH steps use
via `yarn chain` and `yarn deploy`; update the list to add Foundry (Anvil/Forge)
as a required prerequisite, mention that Anvil is needed to run the local chain
and Forge for deployments, and include a link to Foundry installation docs
(https://book.getfoundry.sh/) and a short note that Foundry must be installed
and in PATH before running the tutorial.

## Step 1: Create a New Scaffold-ETH 2 Project with Envio Extension

To create a new Scaffold-ETH 2 project with the Envio extension already integrated:

```bash
npx create-eth@latest -e enviodev/scaffold-eth-2-extension
```
Comment on lines +33 to +35
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

🧩 Analysis chain

Verify create-eth template flag syntax.

Confirm that passing a GitHub template via -e enviodev/scaffold-eth-2-extension is valid and whether a -- separator is needed (some setups require npx create-eth@latest -- -e ...).

🌐 Web query:

What is the correct syntax for using `npx create-eth@latest` with the `-e` flag to pass a GitHub template repo? Is `--` required before flags, and does `-e enviodev/scaffold-eth-2-extension` work?

💡 Result:

Short answer: Use the -e flag directly — no leading "--" required. Syntax:

npx create-eth@latest -e /[:branch]

Example (from the docs): npx create-eth@latest -e ChangoMan/charts-extension. [1][2]

Notes:

  • The :branch part is optional (defaults to the repo's default branch). [2][3]
  • You only need -- if you must stop npx/npm from parsing further arguments and forward them to the created CLI; for passing the extension name itself the documented form above is correct (no --). [1][2]

About your specific repo: -e enviodev/scaffold-eth-2-extension will only work if that exact GitHub repo exists. I could not find a repo with that exact name; enviodev has a scaffold-eth-2-envio repo (enviodev/scaffold-eth-2-envio). Use the real repo name, e.g.:

npx create-eth@latest -e enviodev/scaffold-eth-2-envio

If you want, tell me the exact GitHub repo name and I’ll verify it. [4][1]

Sources:
[1] create-eth-extensions README / usage.
[2] Scaffold-ETH 2 docs — How to install extensions (examples showing -e user/repo[:branch]).
[3] Scaffold-ETH docs / Available extensions list.
[4] Example enviodev repo (scaffold-eth-2-envio) on GitHub.

Update create-eth example: use -e (no --) and correct repo name

  • npx create-eth@latest -e <user>/<repo>[:branch] is the correct form — no -- is required to pass the -e template flag.
  • The example repo enviodev/scaffold-eth-2-extension appears incorrect; replace with the actual repo (e.g., enviodev/scaffold-eth-2-envio) so the command works.
  • Location: docs/HyperIndex/Tutorials/tutorial-scaffold-eth-2.md lines 33–35.
🤖 Prompt for AI Agents 
In docs/HyperIndex/Tutorials/tutorial-scaffold-eth-2.md around lines 33 to 35,
the create-eth example uses an incorrect flag form and repo name; update the
command to use the short template flag syntax (-e) without a leading -- and
replace the incorrect repo "enviodev/scaffold-eth-2-extension" with the correct
repo name (for example "enviodev/scaffold-eth-2-envio") so the command reads in
the form: npx create-eth@latest -e <user>/<repo>[:branch].



## Step 2: Start the Local Blockchain

Navigate to your project directory and start the local blockchain:

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

This will start a local blockchain node for development.

## Step 3: Deploy Your Contracts

In a new terminal window, navigate to your project directory and deploy the default smart contracts:

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

This will deploy the default contracts to the local blockchain. This step is optional and can also be done once you've created your own smart contracts and deployed them using `yarn deploy`.

## Step 4: Start Scaffold-ETH Frontend

From your project directory, start the Scaffold-ETH frontend:

```bash
yarn start
```

This will start the Scaffold-ETH frontend at `http://localhost:3000`.

## Step 5: Generate the Indexer

Navigate to the Envio page in your Scaffold-ETH frontend at `http://localhost:3000/envio` and click the **"Generate"** button. This should only be done once you've created a smart contract and ran `yarn deploy`. This will create the boilerplate indexer from your deployed contracts.

<img src="/img/scaffold-eth-2-envio-page.png" alt="Scaffold-ETH 2 Envio Dashboard" width="100%"/>

The Envio page also includes a helpful "How to Use" section with step-by-step instructions.

## Step 6: Start the Indexer

Navigate to the Envio package directory and start the indexer:

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

This will begin indexing your contract events.

## Regenerating the Indexer

When you deploy new contracts or make changes to existing ones, you'll need to regenerate the indexer:

### Via Frontend Dashboard
1. Go to the Envio page at `http://localhost:3000/envio`
2. Click "Generate" to regenerate the boilerplate indexer

### Via Command Line
```bash
cd packages/envio
pnpm update
pnpm codegen
```

> **Note:** Regenerating will overwrite any custom handlers, config, and schema changes, creating a fresh boilerplate indexer based on your deployed contracts. After regenerating, you'll need to stop the running indexer (Ctrl+C) and restart it with `pnpm dev` for the changes to take effect.

63 changes: 63 additions & 0 deletions docs/HyperIndex/supported-networks/chainweb-testnet-22.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: chainweb-testnet-22
title: Chainweb Testnet 22
sidebar_label: Chainweb Testnet 22
slug: /chainweb-testnet-22
---
Comment on lines +2 to +6
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Align id/slug with supported-networks convention

Match the expected doc id and URL path to ensure sidebar linking works.

-id: chainweb-testnet-22
+id: supported-networks/chainweb-testnet-22
@@
-slug: /chainweb-testnet-22
+slug: /supported-networks/chainweb-testnet-22
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: chainweb-testnet-22
title: Chainweb Testnet 22
sidebar_label: Chainweb Testnet 22
slug: /chainweb-testnet-22
---
id: supported-networks/chainweb-testnet-22
title: Chainweb Testnet 22
sidebar_label: Chainweb Testnet 22
slug: /supported-networks/chainweb-testnet-22
---
🤖 Prompt for AI Agents 
In docs/HyperIndex/supported-networks/chainweb-testnet-22.md lines 2-6, the
frontmatter id and slug don't follow the supported-networks convention; change
the id to supported-networks-chainweb-testnet-22 and the slug to
/supported-networks/chainweb-testnet-22 (keep title and sidebar_label as-is) so
the doc path and sidebar linking match the repository convention.


# Chainweb Testnet 22

## Indexing Chainweb Testnet 22 Data with Envio

| **Field** | **Value** |
|-------------------------------|----------------------------------------------------------------------------------------------------|
| **Chainweb Testnet 22 Chain ID** | 5922 |
| **HyperSync URL Endpoint** | [https://chainweb-testnet-22.hypersync.xyz](https://chainweb-testnet-22.hypersync.xyz) or [https://5922.hypersync.xyz](https://5922.hypersync.xyz) |
| **HyperRPC URL Endpoint** | [https://chainweb-testnet-22.rpc.hypersync.xyz](https://chainweb-testnet-22.rpc.hypersync.xyz) or [https://5922.rpc.hypersync.xyz](https://5922.rpc.hypersync.xyz) |

---

### Tier

STONE 🪨

### Overview

Envio is a modular hyper-performant data indexing solution for Chainweb Testnet 22, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC).

HyperSync accelerates the synchronization of historical data on Chainweb Testnet 22, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods.

Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service.

To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import).

---

### Defining Network Configurations

```yaml
name: IndexerName # Specify indexer name
description: Indexer Description # Include indexer description
networks:
- id: 5922 # Chainweb Testnet 22
start_block: START_BLOCK_NUMBER # Specify the starting block
contracts:
- name: ContractName
address:
- "0xYourContractAddress1"
- "0xYourContractAddress2"
handler: ./src/EventHandlers.ts
events:
- event: Event # Specify event
- event: Event
```

With these steps completed, your application will be set to efficiently index Chainweb Testnet 22 data using Envio’s blockchain indexer.

For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file).

### Support

Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help!

---
63 changes: 63 additions & 0 deletions docs/HyperIndex/supported-networks/chainweb-testnet-23.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: chainweb-testnet-23
title: Chainweb Testnet 23
sidebar_label: Chainweb Testnet 23
slug: /chainweb-testnet-23
---
Comment on lines +2 to +6
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Align id/slug with supported-networks convention

Same issue as 22/24 pages; fix id and slug.

-id: chainweb-testnet-23
+id: supported-networks/chainweb-testnet-23
@@
-slug: /chainweb-testnet-23
+slug: /supported-networks/chainweb-testnet-23
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: chainweb-testnet-23
title: Chainweb Testnet 23
sidebar_label: Chainweb Testnet 23
slug: /chainweb-testnet-23
---
id: supported-networks/chainweb-testnet-23
title: Chainweb Testnet 23
sidebar_label: Chainweb Testnet 23
slug: /supported-networks/chainweb-testnet-23
---
🤖 Prompt for AI Agents 
In docs/HyperIndex/supported-networks/chainweb-testnet-23.md lines 2-6, the
frontmatter id and slug don't follow the supported-networks convention; update
id to "supported-networks/chainweb-testnet-23" and slug to
"/supported-networks/chainweb-testnet-23" (leave title/sidebar_label as-is) so
they match the pattern used by the 22/24 pages.


# Chainweb Testnet 23

## Indexing Chainweb Testnet 23 Data with Envio

| **Field** | **Value** |
|-------------------------------|----------------------------------------------------------------------------------------------------|
| **Chainweb Testnet 23 Chain ID** | 5923 |
| **HyperSync URL Endpoint** | [https://chainweb-testnet-23.hypersync.xyz](https://chainweb-testnet-23.hypersync.xyz) or [https://5923.hypersync.xyz](https://5923.hypersync.xyz) |
| **HyperRPC URL Endpoint** | [https://chainweb-testnet-23.rpc.hypersync.xyz](https://chainweb-testnet-23.rpc.hypersync.xyz) or [https://5923.rpc.hypersync.xyz](https://5923.rpc.hypersync.xyz) |

---

### Tier

STONE 🪨

### Overview

Envio is a modular hyper-performant data indexing solution for Chainweb Testnet 23, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC).

HyperSync accelerates the synchronization of historical data on Chainweb Testnet 23, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods.

Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service.

To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import).

---

### Defining Network Configurations

```yaml
name: IndexerName # Specify indexer name
description: Indexer Description # Include indexer description
networks:
- id: 5923 # Chainweb Testnet 23
start_block: START_BLOCK_NUMBER # Specify the starting block
contracts:
- name: ContractName
address:
- "0xYourContractAddress1"
- "0xYourContractAddress2"
handler: ./src/EventHandlers.ts
events:
- event: Event # Specify event
- event: Event
```

With these steps completed, your application will be set to efficiently index Chainweb Testnet 23 data using Envio’s blockchain indexer.

For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file).

### Support

Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help!

---
63 changes: 63 additions & 0 deletions docs/HyperIndex/supported-networks/chainweb-testnet-24.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: chainweb-testnet-24
title: Chainweb Testnet 24
sidebar_label: Chainweb Testnet 24
slug: /chainweb-testnet-24
---
Comment on lines +2 to +6
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Doc id/slug likely mismatched with sidebar generator

supported-networks.json/sidebars expect doc ids like "supported-networks/chainweb-testnet-24". Current frontmatter sets id to "chainweb-testnet-24" and slug to top-level, which will break sidebar linking and URL consistency.

Apply:

-id: chainweb-testnet-24
+id: supported-networks/chainweb-testnet-24
@@
-slug: /chainweb-testnet-24
+slug: /supported-networks/chainweb-testnet-24
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: chainweb-testnet-24
title: Chainweb Testnet 24
sidebar_label: Chainweb Testnet 24
slug: /chainweb-testnet-24
---
id: supported-networks/chainweb-testnet-24
title: Chainweb Testnet 24
sidebar_label: Chainweb Testnet 24
slug: /supported-networks/chainweb-testnet-24
---
🤖 Prompt for AI Agents 
In docs/HyperIndex/supported-networks/chainweb-testnet-24.md around lines 2 to
6, the frontmatter id and slug are top-level values and should be namespaced to
match the sidebar generator; update id to
"supported-networks/chainweb-testnet-24" and change slug to
"/supported-networks/chainweb-testnet-24" (leave title and sidebar_label as-is)
so the sidebar and URL generation use the correct namespaced doc id and path.


# Chainweb Testnet 24

## Indexing Chainweb Testnet 24 Data with Envio

| **Field** | **Value** |
|-------------------------------|----------------------------------------------------------------------------------------------------|
| **Chainweb Testnet 24 Chain ID** | 5924 |
| **HyperSync URL Endpoint** | [https://chainweb-testnet-24.hypersync.xyz](https://chainweb-testnet-24.hypersync.xyz) or [https://5924.hypersync.xyz](https://5924.hypersync.xyz) |
| **HyperRPC URL Endpoint** | [https://chainweb-testnet-24.rpc.hypersync.xyz](https://chainweb-testnet-24.rpc.hypersync.xyz) or [https://5924.rpc.hypersync.xyz](https://5924.rpc.hypersync.xyz) |

---

### Tier

STONE 🪨

### Overview

Envio is a modular hyper-performant data indexing solution for Chainweb Testnet 24, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC).

HyperSync accelerates the synchronization of historical data on Chainweb Testnet 24, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods.

Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service.

To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import).

---

### Defining Network Configurations

```yaml
name: IndexerName # Specify indexer name
description: Indexer Description # Include indexer description
networks:
- id: 5924 # Chainweb Testnet 24
start_block: START_BLOCK_NUMBER # Specify the starting block
contracts:
- name: ContractName
address:
- "0xYourContractAddress1"
- "0xYourContractAddress2"
handler: ./src/EventHandlers.ts
events:
- event: Event # Specify event
- event: Event
```

With these steps completed, your application will be set to efficiently index Chainweb Testnet 24 data using Envio’s blockchain indexer.

For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file).

### Support

Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help!

---
63 changes: 63 additions & 0 deletions docs/HyperIndex/supported-networks/sentient-testnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: sentient-testnet
title: Sentient Testnet
sidebar_label: Sentient Testnet
slug: /sentient-testnet
---
Comment on lines +2 to +6
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Align id/slug with supported-networks convention

Update to ensure the networks sidebar item "supported-networks/sentient-testnet" resolves and URL lives under /supported-networks/.

-id: sentient-testnet
+id: supported-networks/sentient-testnet
@@
-slug: /sentient-testnet
+slug: /supported-networks/sentient-testnet
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: sentient-testnet
title: Sentient Testnet
sidebar_label: Sentient Testnet
slug: /sentient-testnet
---
id: supported-networks/sentient-testnet
title: Sentient Testnet
sidebar_label: Sentient Testnet
slug: /supported-networks/sentient-testnet
---
🤖 Prompt for AI Agents 
In docs/HyperIndex/supported-networks/sentient-testnet.md around lines 2 to 6,
the frontmatter id and slug do not follow the supported-networks convention;
change the id to "supported-networks/sentient-testnet" and the slug to
"/supported-networks/sentient-testnet" so the sidebar item resolves under
/supported-networks/ (keep title and sidebar_label as-is).


# Sentient Testnet

## Indexing Sentient Testnet Data with Envio

| **Field** | **Value** |
|-------------------------------|----------------------------------------------------------------------------------------------------|
| **Sentient Testnet Chain ID** | 1184075182 |
| **HyperSync URL Endpoint** | [https://sentient-testnet.hypersync.xyz](https://sentient-testnet.hypersync.xyz) or [https://1184075182.hypersync.xyz](https://1184075182.hypersync.xyz) |
| **HyperRPC URL Endpoint** | [https://sentient-testnet.rpc.hypersync.xyz](https://sentient-testnet.rpc.hypersync.xyz) or [https://1184075182.rpc.hypersync.xyz](https://1184075182.rpc.hypersync.xyz) |

---

### Tier

STONE 🪨

### Overview

Envio is a modular hyper-performant data indexing solution for Sentient Testnet, enabling applications and developers to efficiently index and aggregate real-time and historical blockchain data. Envio offers three primary solutions for indexing and accessing large amounts of data: [HyperIndex](/docs/HyperIndex/overview) (a customizable indexing framework), [HyperSync](/docs/HyperSync/overview) (a real-time indexed data layer), and [HyperRPC](/docs/HyperSync/overview-hyperrpc) (extremely fast read-only RPC).

HyperSync accelerates the synchronization of historical data on Sentient Testnet, enabling what usually takes hours to sync millions of events to be completed in under a minute—up to 1000x faster than traditional RPC methods.

Designed to optimize the user experience, Envio offers automatic code generation, flexible language support, multi-chain data aggregation, and a reliable, cost-effective hosted service.

To get started, see our documentation or follow our quickstart [guide](/docs/HyperIndex/contract-import).

---

### Defining Network Configurations

```yaml
name: IndexerName # Specify indexer name
description: Indexer Description # Include indexer description
networks:
- id: 1184075182 # Sentient Testnet
start_block: START_BLOCK_NUMBER # Specify the starting block
contracts:
- name: ContractName
address:
- "0xYourContractAddress1"
- "0xYourContractAddress2"
handler: ./src/EventHandlers.ts
events:
- event: Event # Specify event
- event: Event
```

With these steps completed, your application will be set to efficiently index Sentient Testnet data using Envio’s blockchain indexer.

For more information on how to set up your config, define a schema, and write event handlers, refer to the guides section in our [documentation](/docs/HyperIndex/configuration-file).

### Support

Can’t find what you’re looking for or need support? Reach out to us on [Discord](https://discord.com/invite/Q9qt8gZ2fX); we’re always happy to help!

---
4 changes: 4 additions & 0 deletions docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ Here is a table of the currently supported networks on HyperRPC and their respec
| Celo | 42220 | https://celo.rpc.hypersync.xyz or https://42220.rpc.hypersync.xyz | |
| Chainweb Testnet 20 | 5920 | https://chainweb-testnet-20.rpc.hypersync.xyz or https://5920.rpc.hypersync.xyz | |
| Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.rpc.hypersync.xyz or https://5921.rpc.hypersync.xyz | |
| Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.rpc.hypersync.xyz or https://5922.rpc.hypersync.xyz | |
| Chainweb Testnet 23 | 5923 | https://chainweb-testnet-23.rpc.hypersync.xyz or https://5923.rpc.hypersync.xyz | |
| Chainweb Testnet 24 | 5924 | https://chainweb-testnet-24.rpc.hypersync.xyz or https://5924.rpc.hypersync.xyz | |
| Chiliz | 88888 | https://chiliz.rpc.hypersync.xyz or https://88888.rpc.hypersync.xyz | |
| Citrea Testnet | 5115 | https://citrea-testnet.rpc.hypersync.xyz or https://5115.rpc.hypersync.xyz | |
| Curtis | 33111 | https://curtis.rpc.hypersync.xyz or https://33111.rpc.hypersync.xyz | |
Expand Down Expand Up @@ -86,6 +89,7 @@ Here is a table of the currently supported networks on HyperRPC and their respec
| Rootstock | 30 | https://rootstock.rpc.hypersync.xyz or https://30.rpc.hypersync.xyz | |
| Saakuru | 7225878 | https://saakuru.rpc.hypersync.xyz or https://7225878.rpc.hypersync.xyz | |
| Scroll | 534352 | https://scroll.rpc.hypersync.xyz or https://534352.rpc.hypersync.xyz | |
| Sentient Testnet | 1184075182 | https://sentient-testnet.rpc.hypersync.xyz or https://1184075182.rpc.hypersync.xyz | |
| Sepolia | 11155111 | https://sepolia.rpc.hypersync.xyz or https://11155111.rpc.hypersync.xyz | |
| Shimmer Evm | 148 | https://shimmer-evm.rpc.hypersync.xyz or https://148.rpc.hypersync.xyz | |
| Soneium | 1868 | https://soneium.rpc.hypersync.xyz or https://1868.rpc.hypersync.xyz | |
Expand Down
Loading