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

Add sinks table #443

Merged
merged 7 commits into from
Mar 26, 2024
Merged
Changes from 1 commit
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
Next Next commit
WIP
  • Loading branch information
enoldev committed Mar 11, 2024
commit 99dc4674097e1d146f25355b102c23bd4cbeae46
19 changes: 19 additions & 0 deletions docs/new/consume/sinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
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.

| Name | Support | Maintainer | Source Code |
|-----------|---------|------------------|-------------|
| SQL | O | StreamingFast |[GitHub](https://github.com/streamingfast/substreams-sink-sql)|
| Go SDK | O | StreamingFast |[GitHub](https://github.com/streamingfast/substreams-sink-kv)|
| Rust SDK | O | StreamingFast |[GitHub](https://github.com/streamingfast/substreams-sink)|
| JS SDK | O | StreamingFast |[GitHub](https://github.com/substreams-js/substreams-js)|
| KV Store | C | Community |[GitHub](https://github.com/streamingfast/substreams-sink-kv)|
| KV Store | O | Pinax |[GitHub](https://github.com/pinax-network/substreams-sink-prometheus)|
| KV Store | C | Community |[GitHub](https://github.com/streamingfast/substreams-sink-mongodb
)|
| PubSub | O | StreamingFast |[GitHub](https://substreams.streamingfast.io/documentation/consume/other-ways-of-consuming/pubsub)|
| PubSub | C | Community |[GitHub](https://github.com/streamingfast/substreams-sink-files)|

* O = Official Support
* C = Community Support
22 changes: 17 additions & 5 deletions docs/new/references/chains-and-endpoints.md
Original file line number Diff line number Diff line change
@@ -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,11 +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) | |
| Aptos | [`aptos.extractor.v1.Block`](https://github.com/aptos-labs/aptos-core/blob/main/crates/aptos-protos/proto/aptos/extractor/v1/extractor.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
## StreamingFast Endpoints

* **Ethereum Mainnet**: `mainnet.eth.streamingfast.io:443`
* **Ethereum Görli**: `goerli.eth.streamingfast.io:443`
@@ -50,9 +51,20 @@ Protobuf definitions and public endpoints are provided for the supported protoco
* **NEAR Testnet**: `testnet.near.streamingfast.io:443`
* **Solana mainnet-beta**: `mainnet.sol.streamingfast.io:443`
* **Arweave Mainnet**: `mainnet.arweave.streamingfast.io:443`
* **Aptos Testnet**: `testnet.aptos.streamingfast.io:443`
* **Bitcoin Mainnet**: `mainnet.btc.streamingfast.io:443`

## 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`

## Others

You can support other blockchains for Substreams through Firehose instrumentation. Learn more in the [official Firehose documentation](https://firehose.streamingfast.io/).