From 7bc69718affcc7f6dcc833b8554b1cc66b91ffea Mon Sep 17 00:00:00 2001 From: Josh Kauffman Date: Fri, 19 Jun 2026 15:06:04 -0400 Subject: [PATCH] docs: add agent skills references and remove unsupported chains - Add agent skills tip hints to all tutorial pages (EVM, Solana, NEAR, Monad, TRON, Injective, Stellar, World Chain, account changes, foundational store) and key how-to pages (getting started, develop guide, Rust, protobuf, testing, SQL sinks) - Remove Starknet and MANTRA tutorial pages entirely - Remove all mentions of Katana and Sei EVM across docs - Clean up chains-and-endpoints.md and ethereum-data-model.md to match Co-Authored-By: Claude Sonnet 4.6 --- docs/SUMMARY.md | 2 - docs/getting-started.md | 6 ++- .../foundational-modules.md | 6 --- .../develop-your-own-substreams.md | 4 ++ .../generic/creating-protobuf-schemas.md | 4 ++ .../generic/rust/rust.md | 6 ++- docs/how-to-guides/sinks/sinks.md | 4 ++ docs/references/chains-and-endpoints.md | 5 -- docs/references/ethereum-data-model.md | 1 - docs/references/testing.md | 4 ++ .../tutorials/consuming-foundational-store.md | 4 ++ docs/tutorials/cosmos-compatible/injective.md | 4 ++ docs/tutorials/cosmos-compatible/mantra.md | 54 ------------------- docs/tutorials/evm.md | 4 ++ docs/tutorials/intro-to-tutorials.md | 6 ++- docs/tutorials/monad.md | 4 ++ docs/tutorials/near.md | 4 ++ docs/tutorials/solana/account-changes.md | 4 ++ docs/tutorials/solana/solana.md | 4 ++ docs/tutorials/starknet.md | 54 ------------------- docs/tutorials/stellar.md | 4 ++ docs/tutorials/tron.md | 4 ++ docs/tutorials/world-chain.md | 4 ++ 23 files changed, 69 insertions(+), 127 deletions(-) delete mode 100644 docs/tutorials/cosmos-compatible/mantra.md delete mode 100644 docs/tutorials/starknet.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 8287cfc82..013d795b6 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -14,8 +14,6 @@ * [on Monad](tutorials/monad.md) * [on TRON](tutorials/tron.md) * [on Injective](tutorials/cosmos-compatible/injective.md) - * [on MANTRA](tutorials/cosmos-compatible/mantra.md) - * [on Starknet](tutorials/starknet.md) * [on Stellar](tutorials/stellar.md) * [on World Chain](tutorials/world-chain.md) * [Consuming a Foundational Store](tutorials/consuming-foundational-store.md) diff --git a/docs/getting-started.md b/docs/getting-started.md index f0b1be78a..d4766b8f4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -19,12 +19,14 @@ If you can't find a Substreams package that meets your specific needs, you can d - [EVM](./tutorials/evm.md) - [Solana](./tutorials/solana/solana.md) -- [Starknet](./tutorials/starknet.md) - [Injective](./tutorials/cosmos-compatible/injective.md) -- [MANTRA](./tutorials/cosmos-compatible/mantra.md) To build and optimize your Substreams from zero, use the minimal path within the [Dev Container](./references/devcontainer-ref.md) to setup your environment and follow the [How-To Guides](./how-to-guides/develop-your-own-substreams/develop-your-own-substreams.md). +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](./how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to give it deep expertise in Substreams development patterns, Rust modules, protobuf schemas, and debugging techniques. +{% endhint %} + ## Learn - **Substreams Reliability Guarantees**: With a simple reconnection policy, Substreams guarantees you'll [Never Miss Data](./references/reliability-guarantees.md). diff --git a/docs/how-to-guides/composing-substreams/foundational-modules.md b/docs/how-to-guides/composing-substreams/foundational-modules.md index a3193c1d8..bf70f70ab 100644 --- a/docs/how-to-guides/composing-substreams/foundational-modules.md +++ b/docs/how-to-guides/composing-substreams/foundational-modules.md @@ -35,12 +35,6 @@ Cosmos-compatible chains include modules for: - **IBC Transfers**: Inter-blockchain communication tracking - **Chain-Specific Features**: Modules tailored for Injective, Osmosis, and other Cosmos chains -### Starknet -Starknet foundational modules provide: - -- **Cairo program interactions**: Parsed Cairo program calls and state changes -- **Account operations**: Account deployment and upgrade tracking - ### TRON TRON foundational modules offer: diff --git a/docs/how-to-guides/develop-your-own-substreams/develop-your-own-substreams.md b/docs/how-to-guides/develop-your-own-substreams/develop-your-own-substreams.md index 5f83366cf..28f0920bb 100644 --- a/docs/how-to-guides/develop-your-own-substreams/develop-your-own-substreams.md +++ b/docs/how-to-guides/develop-your-own-substreams/develop-your-own-substreams.md @@ -4,6 +4,10 @@ These how-to guides walk through creating a Substreams that uses raw blockchain **Important**_:_ These how-to guides are in-depth walkthroughs of building highly performance indexers for your dapp. Less experienced users may want to reference the [Tutorials](../../tutorials/intro-to-tutorials.md) for a quick start. {% endhint %} +{% hint style="info" %} +**Tip**: Speed up development by installing the [Substreams agent skills](./generic/agent-skills.md) in your AI coding assistant (Claude Code, Cursor, VS Code). The `substreams-dev` skill provides expert guidance on Rust modules, manifest configuration, protobuf design, and debugging. +{% endhint %} + Choose your ecosystem to get started: - [General](./generic/local-development/README.md) - Cross-chain topics including local development, Rust, Protobuf, and agent skills diff --git a/docs/how-to-guides/develop-your-own-substreams/generic/creating-protobuf-schemas.md b/docs/how-to-guides/develop-your-own-substreams/generic/creating-protobuf-schemas.md index 137bbbed8..278582789 100644 --- a/docs/how-to-guides/develop-your-own-substreams/generic/creating-protobuf-schemas.md +++ b/docs/how-to-guides/develop-your-own-substreams/generic/creating-protobuf-schemas.md @@ -12,6 +12,10 @@ Substreams uses Google Protocol Buffers extensively. Protocol Buffers, also refe **Tip**: Protobufs define the input and output for modules. {% endhint %} +{% hint style="info" %} +**Tip**: The [substreams-dev agent skill](./agent-skills.md) includes expert knowledge on protobuf schema design for blockchain data modeling — install it in your AI coding assistant to get guidance while designing your schemas. +{% endhint %} + Learn more about the details of Google Protocol Buffers in the official documentation provided by Google. **Google Protocol Buffer Documentation** diff --git a/docs/how-to-guides/develop-your-own-substreams/generic/rust/rust.md b/docs/how-to-guides/develop-your-own-substreams/generic/rust/rust.md index 9ad55ff04..02fde062e 100644 --- a/docs/how-to-guides/develop-your-own-substreams/generic/rust/rust.md +++ b/docs/how-to-guides/develop-your-own-substreams/generic/rust/rust.md @@ -4,4 +4,8 @@ Currently, the only programming language supported to build Substreams is Rust, If you have experience with typed programming languages, such as Go or Java, you should be able to understand and learn Rust pretty easily. However, there some features and standards that are specific to the Rust programming language. -The Substreams team recommends following the official [Rust by Example tutorial](https://doc.rust-lang.org/rust-by-example/), which pretty much includes everything you should know about Rust. At the same time, the following sections cover some features and standards that are important when developing Substreams. \ No newline at end of file +The Substreams team recommends following the official [Rust by Example tutorial](https://doc.rust-lang.org/rust-by-example/), which pretty much includes everything you should know about Rust. At the same time, the following sections cover some features and standards that are important when developing Substreams. + +{% hint style="info" %} +**Tip**: The [substreams-dev agent skill](../agent-skills.md) can assist with Rust patterns specific to Substreams — including `Option`/`Result` handling, avoiding excessive cloning, and writing WASM-compatible code. +{% endhint %} \ No newline at end of file diff --git a/docs/how-to-guides/sinks/sinks.md b/docs/how-to-guides/sinks/sinks.md index 1e43667e6..f70148ec0 100644 --- a/docs/how-to-guides/sinks/sinks.md +++ b/docs/how-to-guides/sinks/sinks.md @@ -1,5 +1,9 @@ Once you find a package that fits your needs, you can choose how you want to consume the data. Sinks are integrations that allow you to send the extracted data to different destinations, such as a SQL database, or a file. +{% hint style="info" %} +**Tip**: Building a SQL sink? The [substreams-sql agent skill](../develop-your-own-substreams/generic/agent-skills.md) gives your AI coding assistant expert knowledge on database change (CDC) patterns, relational mappings, PostgreSQL, and ClickHouse schema design. +{% endhint %} + {% hint style="info" %} **Note**: Some of the sinks are officially supported by StreamingFast (i.e. active support is provided), but other sinks are community-driven and support can’t be guaranteed. {% endhint %} diff --git a/docs/references/chains-and-endpoints.md b/docs/references/chains-and-endpoints.md index b34d5be6f..619f49b9d 100644 --- a/docs/references/chains-and-endpoints.md +++ b/docs/references/chains-and-endpoints.md @@ -34,7 +34,6 @@ Protobuf definitions and public endpoints are provided for the supported protoco | Solana | [`sf.solana.type.v1.Block`](https://github.com/streamingfast/firehose-solana/blob/develop/proto/sf/solana/type/v1/type.proto) | [solana-v0.1.0.spkg](https://github.com/streamingfast/sf-solana/releases/download/v0.1.0/solana-v0.1.0.spkg) | | Cosmos | [`sf.cosmos.type.v2.Block`](https://github.com/streamingfast/firehose-cosmos/blob/develop/cosmos/proto/sf/cosmos/type/v2/block.proto#L10) | | | Antelope | [`sf.antelope.type.v1.Block`](https://buf.build/pinax/firehose-antelope/docs/main:sf.antelope.type.v1#sf.antelope.type.v1.Block) | | -| Starknet | [`sf.starknet.type.v1.Block`](https://github.com/streamingfast/firehose-starknet/blob/main/proto/sf/starknet/type/v1/block.proto#L8) | | | Stellar | [`sf.stellar.type.v1.Block`](https://github.com/streamingfast/firehose-stellar/blob/main/proto/sf/stellar/type/v1/block.proto#L7) | | @@ -75,16 +74,12 @@ The data missing in the Base Block makes the corresponding Protobuf field empty. - **Injective EVM Testnet**: `testnet.injective-evm.streamingfast.io:443` - **Injective Mainnet**: `mainnet.injective.streamingfast.io:443` - **Injective Testnet**: `testnet.injective.streamingfast.io:443` -- **Sei EVM Mainnet**: `evm-mainnet.sei.streamingfast.io:443` -- **Starknet Mainnet**: `mainnet.starknet.streamingfast.io:443` -- **Starknet Testnet**: `testnet.starknet.streamingfast.io:443` - **Base Mainnet**: `base-mainnet.streamingfast.io:443` - **Monad Mainnet**: `mainnet-base.monad.streamingfast.io:443` - **Stellar Mainnet**: `mainnet.stellar.streamingfast.io:443` - **Stellar Testnet**: `testnet.stellar.streamingfast.io:443` - **Unichain Mainnet**: `mainnet.unichain.streamingfast.io:443` - **World Chain Mainnet**: `mainnet.worldchain.streamingfast.io:443` -- **Katana Mainnet**: `katana.streamingfast.io:443` ## Community Endpoints diff --git a/docs/references/ethereum-data-model.md b/docs/references/ethereum-data-model.md index 454ccbbd1..149429988 100644 --- a/docs/references/ethereum-data-model.md +++ b/docs/references/ethereum-data-model.md @@ -26,7 +26,6 @@ This version refers to the `Block` emitted by the Firehose trace. - This version is currently in place for the following chains: - Optimism - Ethereum Hoodi - - Sei EVM - This version fixes the known issue of version 3. ## Prague-enabled blockchains diff --git a/docs/references/testing.md b/docs/references/testing.md index 0d5c320be..c55cd5625 100644 --- a/docs/references/testing.md +++ b/docs/references/testing.md @@ -2,6 +2,10 @@ This reference covers testing strategies for Substreams applications, from unit testing individual handlers to integration testing complete modules with real blockchain data. +{% hint style="info" %} +**Tip**: The [substreams-testing agent skill](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) gives your AI coding assistant expert knowledge on unit testing, integration testing, performance testing, and CI/CD patterns for Substreams. +{% endhint %} + ## Why Testing Matters Blockchain data is immutable and mistakes are permanent. Testing is critical because: diff --git a/docs/tutorials/consuming-foundational-store.md b/docs/tutorials/consuming-foundational-store.md index 5f0023c9c..880e02c40 100644 --- a/docs/tutorials/consuming-foundational-store.md +++ b/docs/tutorials/consuming-foundational-store.md @@ -2,6 +2,10 @@ This guide explains how to consume data from a Foundational Store in your Substreams modules. Foundational Stores provide efficient access to pre-processed blockchain data for building complex data processing pipelines. +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## What is a Foundational Store? A Foundational Store is a high-performance, multi-backend key-value storage system designed for Substreams ingestion and serving. It provides: diff --git a/docs/tutorials/cosmos-compatible/injective.md b/docs/tutorials/cosmos-compatible/injective.md index 08286cc3c..260cc863e 100644 --- a/docs/tutorials/cosmos-compatible/injective.md +++ b/docs/tutorials/cosmos-compatible/injective.md @@ -7,6 +7,10 @@ In this tutorial, you'll learn how to initialize a Injective-based Substreams pr The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your Injective Substreams Project 1. [Install the Substreams CLI](../../how-to-guides/cli/installing-the-cli.md). diff --git a/docs/tutorials/cosmos-compatible/mantra.md b/docs/tutorials/cosmos-compatible/mantra.md deleted file mode 100644 index 1793ea40d..000000000 --- a/docs/tutorials/cosmos-compatible/mantra.md +++ /dev/null @@ -1,54 +0,0 @@ -Tutorial on MANTRA -================= - -In this tutorial, you'll learn how to initialize a Mantra-based Substreams project using the Substreams CLI (`substreams init` command). - -{% hint style="info" %} - The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../../references/devcontainer-ref.md), which launches a Linux-based virtual environment. -{% endhint %} - -## Step 1: Initialize Your MANTRA Substreams Project - -1. [Install the Substreams CLI](../../how-to-guides/cli/installing-the-cli.md). - -2. Running `substreams init` will give you the option to choose between two MANTRA project options. Select the one that best fits your requirements: - - **MANTRA-hello-world**: Creates a simple Substreams module that outputs all `transfer` events. It demonstrates how to access the full Mantra block, iterate over events, and filter by a specific event `type`. - - **MANTRA-events**: Creates a Substreams that extracts MANTRA events using the cached [MANTRA Foundational Module](https://substreams.dev/packages/mantra-common/v0.1.0), filtered by one or more smart contract addresses. This includes type `wasm` events. - -{% hint style="info" %} -Tip: Have the start block of your transaction or specific events ready. -{% endhint %} - -## Step 2: Visualize the Data - -1. Run `substreams auth` to create your [account](https://thegraph.market/) and generate an authentication token (JWT), then pass this token back as input. - -2. Run `substreams build` to compile the project. - -3. Run `substreams gui` to visualize and iterate on your extracted data. - -## Step 2.5: (Optionally) Transform the Data - -1. Open the `src/lib.rs` file that has been generated. - -2. Modify the transformations made to the data as needed. Every time you modify the code, you will have to recompile the project with `substreams build`. - -## Step 3: Load the Data - -To make your Substreams queryable (as opposed to [direct streaming](../../how-to-guides/sinks/stream/stream.md)), you can automatically send the data to a SQL data by using the [SQL sink](../../how-to-guides/sinks/sql/sql.md) or through [PubSub](../../how-to-guides/sinks/pubsub.md). - -## Additional Resources - -You may find these additional resources helpful for developing your first MANTRA application. - -### Dev Container Reference - -The [Dev Container Reference](../../references/devcontainer-ref.md) helps you navigate the container and its common errors. - -### CLI Reference - -The [CLI reference](../../references/cli/command-line-interface.md) lets you explore all the tools available in the Substreams CLI. - -### Substreams Components Reference - -The [Components Reference](../../references/substreams-components/) dives deeper into navigating the `substreams.yaml`. diff --git a/docs/tutorials/evm.md b/docs/tutorials/evm.md index fd3bd5ecf..93da89657 100644 --- a/docs/tutorials/evm.md +++ b/docs/tutorials/evm.md @@ -8,6 +8,10 @@ In this tutorial, you'll learn how to initialize a EVM-based Substreams project The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your EVM Substreams Project 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md) diff --git a/docs/tutorials/intro-to-tutorials.md b/docs/tutorials/intro-to-tutorials.md index 44ac264bb..e7d0d8bfb 100644 --- a/docs/tutorials/intro-to-tutorials.md +++ b/docs/tutorials/intro-to-tutorials.md @@ -1,5 +1,9 @@ These tutorials demonstrate how to quickly index on-chain data for your application across various blockchains using the Substreams CLI. +{% hint style="info" %} +**Tip**: Using Claude Code, Cursor, or VS Code with AI? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to give your AI assistant expert knowledge of Substreams patterns as you work through these tutorials. +{% endhint %} + Substreams data streams are available on the chains listed [here](../references/chains-and-endpoints.md). To support Substreams a [Firehose](https://thegraph.com/docs/en/new-chain-integration/) endpoint must be available. If your blockchain is not supported, please ask in Discord. Then, consult the relevant ecosystem guide to get started using Substreams real-time data streams: @@ -9,7 +13,5 @@ If your blockchain is not supported, please ask in Discord. Then, consult the re - [NEAR](./near.md) - [Monad](./monad.md) - [Tron](./tron.md) -- [Starknet](./starknet.md) - [Injective](./cosmos-compatible/injective.md) -- [Mantra](./cosmos-compatible/mantra.md) - [Stellar](./stellar.md) diff --git a/docs/tutorials/monad.md b/docs/tutorials/monad.md index 418fec849..a9f6de577 100644 --- a/docs/tutorials/monad.md +++ b/docs/tutorials/monad.md @@ -11,6 +11,10 @@ Due to Monad full nodes not providing access to arbitrary historic state, eth_ca The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your Monad Substreams Project 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md). diff --git a/docs/tutorials/near.md b/docs/tutorials/near.md index a55738487..a373910ac 100644 --- a/docs/tutorials/near.md +++ b/docs/tutorials/near.md @@ -7,6 +7,10 @@ In this tutorial, you'll learn how to initialize a NEAR-based Substreams project The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your NEAR Substreams Project 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md). diff --git a/docs/tutorials/solana/account-changes.md b/docs/tutorials/solana/account-changes.md index 34019d1a0..bd2616b1f 100644 --- a/docs/tutorials/solana/account-changes.md +++ b/docs/tutorials/solana/account-changes.md @@ -10,6 +10,10 @@ By the end of this tutorial, you will have a working Substreams feed that allows Data for Solana account changes is available on a rolling three-month window. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + For each Solana Account block, only the latest update per account is recorded, see the [Protobuf Referece](https://buf.build/streamingfast/firehose-solana/file/main:sf/solana/type/v1/account.proto). If an account is deleted, a payload with `deleted == True` is provided. Additionally, events of low importance we're omitted, such as those with the special owner “Vote11111111…” account or changes that do not affect the account data (ex: lamport changes). {% hint style="success" %} The Account Changes Substreams natively handles a change of ownership upon delete. {% endhint %} diff --git a/docs/tutorials/solana/solana.md b/docs/tutorials/solana/solana.md index a0b3d3ebc..b41b1f753 100644 --- a/docs/tutorials/solana/solana.md +++ b/docs/tutorials/solana/solana.md @@ -7,6 +7,10 @@ In this tutorial, you'll learn how to initialize a Solana-based Substreams proje The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your Solana Substreams Project 1. [Install the Substreams CLI](../../how-to-guides/cli/installing-the-cli.md). diff --git a/docs/tutorials/starknet.md b/docs/tutorials/starknet.md deleted file mode 100644 index c3713807b..000000000 --- a/docs/tutorials/starknet.md +++ /dev/null @@ -1,54 +0,0 @@ -Tutorial on Starknet -================= - -In this tutorial, you'll learn how to initialize a Starknet-based Substreams project using the Substreams CLI (`substreams init` command). - -{% hint style="info" %} - The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. -{% endhint %} - -## Step 1: Initialize Your Starknet Substreams Project - -1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md). - -2. Running `substreams init` will give you the option to choose between two Starknet project options. Select the one that best fits your requirements: - - **starknet-hello-world**: Creates a Substreams that outputs all the events of the Starknet token. It teaches how to access the full Starknet Block, how to iterate over transactions and how to filter on specific event addresses. - - **starknet-events**: Creates a Substreams that extracts and decodes Starknet events and calls using the cached [Starknet Foundational Module](https://substreams.dev/packages/starknet-foundational/v0.1.4), filtered by one or more smart contract addresses. Contract ABIs are retrieved from Starkscan. If an ABI isn’t available, you’ll need to provide it yourself. - -{% hint style="info" %} -Note: Starknet ABIs are mutable within blocks, therefore the current ABI of your smart-contract may change in a future block. -{% endhint %} - -## Step 2: Visualize the Data - -1. Run `substreams auth` to create your [account](https://thegraph.market/) and generate an authentication token (JWT), then pass this token back as input. - -2. Run `substreams build` to compile the project. - -3. Run `substreams gui` to visualize and iterate on your extracted data. - -## Step 2.5: (Optionally) Transform the Data - -1. Open the `src/lib.rs` file that has been generated. - -2. Modify the transformations made to the data as needed. Every time you modify the code, you will have to recompile the project with `substreams build`. - -## Step 3: Load the Data - -To make your Substreams queryable (as opposed to [direct streaming](../how-to-guides/sinks/stream/stream.md)), you can automatically send the data to a SQL data by using the [SQL sink](../how-to-guides/sinks/sql/sql.md) or through [PubSub](../how-to-guides/sinks/pubsub.md). - -## Additional Resources - -You may find these additional resources helpful for developing your first Starknet application. - -### Dev Container Reference - -The [Dev Container Reference](../references/devcontainer-ref.md) helps you navigate the container and its common errors. - -### CLI Reference - -The [CLI reference](../references/cli/command-line-interface.md) lets you explore all the tools available in the Substreams CLI. - -### Substreams Components Reference - -The [Components Reference](../references/substreams-components/) dives deeper into navigating the `substreams.yaml`. diff --git a/docs/tutorials/stellar.md b/docs/tutorials/stellar.md index 13a041df8..ca19f0804 100644 --- a/docs/tutorials/stellar.md +++ b/docs/tutorials/stellar.md @@ -7,6 +7,10 @@ In this guide, you'll learn how to initialize a Stellar-based Substreams project The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your Stellar Substreams Project 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md). diff --git a/docs/tutorials/tron.md b/docs/tutorials/tron.md index 23f5046bc..dda3c1991 100644 --- a/docs/tutorials/tron.md +++ b/docs/tutorials/tron.md @@ -7,6 +7,10 @@ In this tutorial, you'll learn how to initialize a TRON-based Substreams project The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your TRON Substreams Project 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md). diff --git a/docs/tutorials/world-chain.md b/docs/tutorials/world-chain.md index 7695a30ab..b0ba65e51 100644 --- a/docs/tutorials/world-chain.md +++ b/docs/tutorials/world-chain.md @@ -8,6 +8,10 @@ In this tutorial, you'll learn how to initialize a World Chain-based Substreams The CLI installation is supported only on Linux and macOS. If you're using Windows, consider using the [DevContainer environment](../references/devcontainer-ref.md), which launches a Linux-based virtual environment. {% endhint %} +{% hint style="info" %} +**Tip**: Using an AI coding assistant? Install the [Substreams agent skills](../how-to-guides/develop-your-own-substreams/generic/agent-skills.md) to get expert Substreams guidance while building. +{% endhint %} + ## Step 1: Initialize Your World Chain Substreams Project 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md)