Skip to content
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.

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

more fixes #565

Merged
merged 1 commit into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<!-- * [Exploring Ethereum](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)
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

<figure><img src="../../../.gitbook/assets/intro/injective-logo.png" width="100%" /></figure>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This section contains Substreams tutorials specific to EVM-compatible chains (e.g. Ethereum, Polygon or BNB).
This section contains Substreams how-to-guides specific to EVM-compatible chains (e.g. Ethereum, Polygon or BNB).
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -57,7 +57,7 @@ In the following sections, you will go through every module, run the correspondi

### The Project Structure

<figure><img src="../../../../.gitbook/assets/tutorials/eth-explorer-structure.png" /><figcaption><p>Ethereum Explorer Project Structure</p></figcaption></figure>
<figure><img src="../../../../../.gitbook/assets/tutorials/eth-explorer-structure.png" /><figcaption><p>Ethereum Explorer Project Structure</p></figcaption></figure>

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).
Expand All @@ -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`):

<figure><img src="../../../../.gitbook/assets/tutorials/eth-explorer-manifest.png" width="100%" /><figcaption><p>Ethereum Explorer Manifest</p></figcaption></figure>
<figure><img src="../../../../../.gitbook/assets/tutorials/eth-explorer-manifest.png" width="100%" /><figcaption><p>Ethereum Explorer Manifest</p></figcaption></figure>

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.
Expand All @@ -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`.

Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

<figure><img src="../../../.gitbook/assets/tutorials/solana-learn.png" width="100%" /></figure>
Loading