diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index b46592ce..ad0f0495 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -16,8 +16,8 @@ ## How-To Guides * [Develop a Substreams](new/how-to-guides/develop-your-own-substreams/develop-your-own-substreams.md) - * [on EVM](new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/exploring-ethereum.md) - + * [on EVM](new/how-to-guides/develop-your-own-substreams/evm) + * [Exploring Ethereum](new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/exploring-ethereum.md) * [Mapping Blocks](new/how-to-guides/evm/exploring-ethereum/map\_block\_meta\_module.md) * [Filter Transactions](new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map\_filter\_transactions\_module.md) * [Retrieve Events of a Smart Contract](new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map\_contract\_events\_module.md) diff --git a/docs/new/how-to-guides/develop-your-own-substreams/cosmos/cosmos.md b/docs/new/how-to-guides/develop-your-own-substreams/cosmos/cosmos.md index 8cf0f934..bc2a46cf 100644 --- a/docs/new/how-to-guides/develop-your-own-substreams/cosmos/cosmos.md +++ b/docs/new/how-to-guides/develop-your-own-substreams/cosmos/cosmos.md @@ -1,3 +1,3 @@ -The section contains tutorials showcasing how to develop a Substreams that can extract data from the Cosmos ecosystem. +This section contains how-to guides showcasing how to develop a Substreams to index data within the Cosmos ecosystem.
\ No newline at end of file diff --git a/docs/new/how-to-guides/develop-your-own-substreams/evm/evm.md b/docs/new/how-to-guides/develop-your-own-substreams/evm/evm.md index c6be6497..39099e38 100644 --- a/docs/new/how-to-guides/develop-your-own-substreams/evm/evm.md +++ b/docs/new/how-to-guides/develop-your-own-substreams/evm/evm.md @@ -1 +1 @@ -This section contains Substreams tutorials specific to EVM-compatible chains (e.g. Ethereum, Polygon or BNB). \ No newline at end of file +This section contains Substreams how-to-guides specific to EVM-compatible chains (e.g. Ethereum, Polygon or BNB). \ No newline at end of file diff --git a/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/exploring-ethereum.md b/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/exploring-ethereum.md index 90260767..8883d5c1 100644 --- a/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/exploring-ethereum.md +++ b/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/exploring-ethereum.md @@ -5,7 +5,7 @@ Getting started with Substreams might feel challenging, but you are not alone! T {% hint style="success" %} **Tip**: This tutorial teaches you how to build a Substreams from scratch. -Remember that you can auto-generate your Substreams module by using the [code-generation tools](../../../../tutorials/evm.md). +Remember that you can auto-generate a filtered Substreams module by using the [code-generation tools](../../../../tutorials/evm.md). {% endhint %} The Ethereum block model for Substreams is represented by the [`sf.ethereum.type.v2.Block`](https://github.com/streamingfast/firehose-ethereum/blob/develop/proto/sf/ethereum/type/v2/type.proto) Rust struct. @@ -57,7 +57,7 @@ In the following sections, you will go through every module, run the correspondi ### The Project Structure -

Ethereum Explorer Project Structure

+

Ethereum Explorer Project Structure

1. The `proto` folder contains the Protobuf definitions for the transformations. In this example, there are three Protobuf objects, which are the outputs of the Substreams module mentioned in the previous section: BlockMeta (which represents the information of an Ethereum block), Transaction (which is an abstraction for an Ethereum transaction), and Event (an abstraction for an Ethereum event). @@ -68,7 +68,7 @@ In this example, there are three Protobuf objects, which are the outputs of the Let's take a closer look at the Substreams manifest (`substreams.yml`): -

Ethereum Explorer Manifest

+

Ethereum Explorer Manifest

1. The `protobuf` section specifies the location of the Protobuf files used in the Substreams (i.e. where are the files defining the objects that you are going to use as output). In this example, the files are under the `proto` folder. 2. When you run Substreams, you are really executing a Rust application inside a WASM container. Therefore, Substreams needs to know where is the WASM executable. The `binaries` section specifies the location of the WASM executable. @@ -79,9 +79,9 @@ In this example, the `map_block_meta` module is a mapper that takes a raw Ethere You may find these additional resources helpful for developing your first Solana application. -The [CLI reference](../references/cli/command-line-interface.md) lets you explore all the tools available in the Substreams CLI. +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 deeeper into navigating the `substreams.yaml`. +The [Components Reference](../../../../references/substreams-components/) dives deeeper into navigating the `substreams.yaml`. diff --git a/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_block_meta_module.md b/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_block_meta_module.md index 634de032..1d8d0e82 100644 --- a/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_block_meta_module.md +++ b/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_block_meta_module.md @@ -5,7 +5,7 @@ This module takes a raw Ethereum block and returns a reduced version of a block, {% hint style="success" %} **Tip**: This tutorial teaches you how to build a Substreams from scratch. -Remember that you can auto-generate your Substreams module by usig the [code-generation tools](../../../getting-started/evm/emv-first-sql.md). +Remember that you can auto-generate a filtered Substreams module by using the [code-generation tools](../../../../tutorials/evm.md). {% endhint %} Let's run the Substreams first, and then go through the code. diff --git a/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_contract_events_module.md b/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_contract_events_module.md index c75c5587..73d6bb65 100644 --- a/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_contract_events_module.md +++ b/docs/new/how-to-guides/develop-your-own-substreams/evm/exploring-ethereum/map_contract_events_module.md @@ -2,12 +2,6 @@ Given a smart contract address passed as a parameter, this module returns the logs attached to the contract. -{% hint style="success" %} -**Tip**: This tutorial teaches you how to build a Substreams from scratch. - -Remember that you can auto-generate your Substreams module by usig the [code-generation tools](../../../getting-started/evm/emv-first-sql.md). -{% endhint %} - ### Running the Substreams First, generate the Protobuf modules and build the Rust code: diff --git a/docs/new/how-to-guides/develop-your-own-substreams/solana/solana.md b/docs/new/how-to-guides/develop-your-own-substreams/solana/solana.md index f0c73e2b..5cfcb982 100644 --- a/docs/new/how-to-guides/develop-your-own-substreams/solana/solana.md +++ b/docs/new/how-to-guides/develop-your-own-substreams/solana/solana.md @@ -1,3 +1,3 @@ -In the following sections, you will find several Solana tutorials showcasing how you can easily extract data using Substreams. +In the following sections, you will find several Solana how-to guides showcasing how you can index data using Substreams.
\ No newline at end of file