From f6da031d3ade43d15e2e63ae8f9119d4b2b75e7a Mon Sep 17 00:00:00 2001 From: Enol <51820585+enoldev@users.noreply.github.com> Date: Tue, 26 Mar 2024 12:04:32 +0100 Subject: [PATCH] Add sinks table (#443) --- .gitbook.yaml | 8 ++++++ docs/SUMMARY.md | 2 +- docs/new/consume/other-sinks/README.md | 27 +++++++++++++++++++++ docs/new/references/chains-and-endpoints.md | 22 ++++++++++++++--- 4 files changed, 54 insertions(+), 5 deletions(-) create mode 100644 docs/new/consume/other-sinks/README.md diff --git a/.gitbook.yaml b/.gitbook.yaml index 2c118fdaf..d63893988 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -54,6 +54,14 @@ redirects: tutorials/rust/option: ./new/tutorials/rust/option.md tutorials/rust/result: ./new/tutorials/rust/result.md tutorials/eth-calls: ./new/develop/chain-specific/evm/eth-calls.md + documentation/consume/other-ways-of-consuming: ./new/consume/other-sinks/README.md + documentation/consume/other-ways-of-consuming/kv: ./new/consume/other-sinks/kv.md + documentation/consume/other-ways-of-consuming/mongodb: ./new/consume/other-sinks/mongodb.md + documentation/consume/other-ways-of-consuming/files: ./new/consume/other-sinks/files.md + documentation/consume/other-ways-of-consuming/prometheus: ./new/consume/other-sinks/prometheus.md + documentation/consume/other-ways-of-consuming/pubsub: ./new/consume/other-sinks/pubsub.md + + diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 805edfac6..35b7bc709 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -20,7 +20,7 @@ * [JavaScript](new/consume/stream/javascript.md) * [Go](new/consume/stream/go.md) * [Substreams:Subgraph](new/consume/subgraph/subgraph.md) - * [Other Ways of Consuming](documentation/consume/other-ways-of-consuming/README.md) + * [Other Ways of Consuming](new/consume/other-sinks/README.md) * [Files](new/consume/other-sinks/files.md) * [Key-Value Store](new/consume/other-sinks/kv.md) * [MongoDB](new/consume/other-sinks/mongodb.md) diff --git a/docs/new/consume/other-sinks/README.md b/docs/new/consume/other-sinks/README.md new file mode 100644 index 000000000..c02631541 --- /dev/null +++ b/docs/new/consume/other-sinks/README.md @@ -0,0 +1,27 @@ +A Substreams package defines the data you want to extract from the blockchain. Then, you can consume that data by using one of the many sinks available. Sinks are integrations that allow you to send the extracted data to different destinations, such as a SQL database, a file or a subgraph. + +Some of the sinks are officially supported by one or several Substreams providers (i.e. active support is provided), but other sinks are community-driven and support can't be guaranteed. + +## Official + +| Name | Support | Maintainer | Source Code | +|-----------|---------|------------------|-------------| +| SQL | O | StreamingFast |[substreams-sink-sql](https://github.com/streamingfast/substreams-sink-sql)| +| Go SDK | O | StreamingFast |[substreams-sink](https://github.com/streamingfast/substreams-sink)| +| Rust SDK | O | StreamingFast |[substreams-sink-rust](https://github.com/streamingfast/substreams-sink-rust)| +| JS SDK | O | StreamingFast |[substreams-js](https://github.com/substreams-js/substreams-js)| +| KV Store | O | StreamingFast |[substreams-sink-kv](https://github.com/streamingfast/substreams-sink-kv)| +| Prometheus| O | Pinax |[substreams-sink-prometheus](https://github.com/pinax-network/substreams-sink-prometheus)| +| Webhook | O | Pinax |[substreams-sink-webhook](https://github.com/pinax-network/substreams-sink-webhook)| +| CSV | O | Pinax |[substreams-sink-csv](https://github.com/pinax-network/substreams-sink-csv)| +| PubSub | O | StreamingFast |[substreams-sink-pubsub](https://github.com/streamingfast/substreams-sink-pubsub)| + +## Community + +| Name | Support | Maintainer | Source Code | +|-----------|---------|------------------|-------------| +| MongoDB | C | Community |[substreams-sink-mongodb](https://github.com/streamingfast/substreams-sink-mongodb)| +| Files | C | Community |[substreams-sink-files](https://github.com/streamingfast/substreams-sink-files)| + +* O = Official Support (by one of the main Substreams providers) +* C = Community Support diff --git a/docs/new/references/chains-and-endpoints.md b/docs/new/references/chains-and-endpoints.md index 356235d80..adbf6542a 100644 --- a/docs/new/references/chains-and-endpoints.md +++ b/docs/new/references/chains-and-endpoints.md @@ -10,10 +10,12 @@ The different blockchains have separate endpoints that Substreams uses. You will ### Supported blockchains and protobuf models +There are different Substreams providers that you can use. StreamingFast and Pinax are the largest providers currently. + Protobuf definitions and public endpoints are provided for the supported protocols and chains. {% hint style="success" %} -**Tip**: All of the endpoints listed in the documentation require [authentication](authentication.md) before use. +**Tip**: All of the endpoints listed in the documentation require [authentication](../common/authentication.md) before use. {% endhint %} {% hint style="warning" %} @@ -30,10 +32,10 @@ Protobuf definitions and public endpoints are provided for the supported protoco | NEAR | [`sf.near.type.v1.Block`](https://github.com/streamingfast/firehose-near/blob/develop/proto/sf/near/type/v1/type.proto) | | | 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.v1.Block`](https://github.com/figment-networks/proto-cosmos/blob/main/sf/cosmos/type/v1/type.proto) | | -| Arweave | [`sf.arweave.type.v1.Block`](https://github.com/streamingfast/firehose-arweave/blob/develop/proto/sf/arweave/type/v1/type.proto) | | | +| Arweave | [`sf.arweave.type.v1.Block`](https://github.com/streamingfast/firehose-arweave/blob/develop/proto/sf/arweave/type/v1/type.proto) | | | Bitcoin | [`sf.bitcoin.type.v1.Block`](https://github.com/streamingfast/firehose-bitcoin/blob/develop/proto/sf/bitcoin/type/v1/type.proto) | | -## Endpoints +## Official Endpoints * **Ethereum Mainnet**: `mainnet.eth.streamingfast.io:443` * **Ethereum Görli**: `goerli.eth.streamingfast.io:443` @@ -51,6 +53,18 @@ Protobuf definitions and public endpoints are provided for the supported protoco * **Arweave Mainnet**: `mainnet.arweave.streamingfast.io:443` * **Bitcoin Mainnet**: `mainnet.btc.streamingfast.io:443` -## Others +## Community Endpoints + +### Pinax Endpoints + +* **Ethereum Mainnet**: `eth.substreams.pinax.network:9000` +* **Ethereum Görli**: `goerli.substreams.pinax.network:9000` +* **Ethereum Sepolia**: `sepolia.substreams.pinax.network:9000` +* **Polygon Mainnet**: `polygon.substreams.pinax.network:9000` +* **Mumbai Testnet**: `mumbai.substreams.pinax.network:9000` +* **BNB**: `bsc.substreams.pinax.network:9000` +* **Chapel Testnet**: `bsc.substreams.pinax.network:9000` +* **NEAR Mainnet**: `near.substreams.pinax.network:9000` +* **NEAR Testnet**: `neartest.substreams.pinax.network:9000` You can support other blockchains for Substreams through Firehose instrumentation. Learn more in the [official Firehose documentation](https://firehose.streamingfast.io/).