|
|
|
|
@@ -1,3 +1,70 @@
|
|
|
|
|
# Substreams Integration
|
|
|
|
|
|
|
|
|
|
Coming Soon
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
We have integrated the **Ambient** protocol as a reference, see `/substreams/ethereum-ambient` for more information.
|
|
|
|
|
|
|
|
|
|
## Step by step
|
|
|
|
|
|
|
|
|
|
1. Install [Rust](https://www.rust-lang.org/tools/install), you can do so with the following command:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
1. Install [Substreams CLI](https://substreams.streamingfast.io/getting-started/installing-the-cli), you can either use brew:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
brew install streamingfast/tap/substreams
|
|
|
|
|
```
|
|
|
|
|
use precompiled binaries
|
|
|
|
|
```bash
|
|
|
|
|
# Use correct binary for your platform
|
|
|
|
|
LINK=$(curl -s https://api.github.com/repos/streamingfast/substreams/releases/latest | awk '/download.url.*linux/ {print $2}' | sed 's/"//g')
|
|
|
|
|
curl -L $LINK | tar zxf -
|
|
|
|
|
```
|
|
|
|
|
or compile from source:
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/streamingfast/substreams
|
|
|
|
|
cd substreams
|
|
|
|
|
go install -v ./cmd/substreams
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
1. Start by making a local copy of the Propeller Protocol Lib repository:
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/propeller-heads/propeller-protocol-lib
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Understanding the Substreams integration
|
|
|
|
|
|
|
|
|
|
Substreams is a new indexing technology, which uses Rust modules to compose raw blockchain data streams into higher level data streams, in out case specific to the protocol. These modules together with the protobuf definitions and manifest are then wrapped into SPKG packages (more info [here](https://substreams.streamingfast.io/quick-access/glossary#spkg-.spkg)) that is then run remotely on the Substreams server.
|
|
|
|
|
|
|
|
|
|
For more information, read the [quick explanation of Substreams](https://thegraph.com/docs/en/substreams/) or jump into the [Substreams documentation](https://substreams.streamingfast.io/). It describes the functions that need to be implemented as well as the manifest file.
|
|
|
|
|
|
|
|
|
|
### ProtoBuf files
|
|
|
|
|
|
|
|
|
|
Generally these describe the raw blockchain data that we get on the input stream and the output data that we want to produce using the Rust module.
|
|
|
|
|
|
|
|
|
|
If you are unfamiliar with ProtoBuf at all, you can start with the [official documentation](https://protobuf.dev/overview/).
|
|
|
|
|
|
|
|
|
|
First get familiar with the raw ProtoBuf definitions provided by us:
|
|
|
|
|
- [common.proto](../../../proto/tycho/evm/v1/common.proto) - Common types used by all integration types
|
|
|
|
|
- [vm.proto](../../../proto/tycho/evm/v1/vm.proto) - Types specific to the VM integration
|
|
|
|
|
|
|
|
|
|
You can also create your own intermediate ProtoBufs. These files should reside in your own substreams package, e.g. `./substreams/ethereum-template/proto/custom-messages.proto`. You have to link these files in the `substreams.yaml` file, see the [manifest docs](https://substreams.streamingfast.io/developers-guide/creating-your-manifest) for more information or you can look at the official substreams example integration of [UniswapV2](https://github.com/messari/substreams/blob/master/uniswap-v2/substreams.yaml#L20-L22).
|
|
|
|
|
|
|
|
|
|
*Note: Internally we are referring to the substreams integration as `Tycho`, which is why our protobuf files are under the `proto/tycho` directory.*
|
|
|
|
|
|
|
|
|
|
### Rust module
|
|
|
|
|
|
|
|
|
|
The goal of the rust module is to implement the logic that will transform the raw blockchain data into the desired output data.
|
|
|
|
|
|
|
|
|
|
*This is the actual integration code that you will be writing!*
|
|
|
|
|
|
|
|
|
|
The module is a Rust library that is compiled into a SPKG (`.spkg`) file using the Substreams CLI and then loaded by the Substreams server. It is defined by the `lib.rs` file (see the [Ambient reference example](../../../substreams/ethereum-ambient/src/lib.rs)).
|
|
|
|
|
|
|
|
|
|
Read our [Substreams README.md](../../../substreams/README.md) for more information on how to write the Rust module.
|
|
|
|
|
|
|
|
|
|
### Testing
|
|
|
|
|
|
|
|
|
|
Read the [Substreams testing docs](../../../substreams/README.md#testing-your-implementation) for more information on how to test your integration.
|
|
|
|
|
|
pistomat