Skip to content

Commit baf4b86

Browse files
Add missing datasource headers (#749)
1 parent 290a8eb commit baf4b86

File tree

8 files changed

+16
-2
lines changed

8 files changed

+16
-2
lines changed

docs/3.datasources/1.abi_etherscan.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: "Etherscan is a popular Ethereum blockchain explorer. It provides a
44
network: "ethereum"
55
---
66

7+
# Etherscan
8+
79
[Etherscan](https://etherscan.io/) is a popular Ethereum blockchain explorer. It provides a public API to fetch ABIs of verified contracts. DipDup can use its API to fetch ABIs for contracts being indexed.
810

911
To use this datasource, add the following section in config:

docs/3.datasources/2.coinbase.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Coinbase"
33
description: "A connector for Coinbase Exchange API. Provides get_candles and get_oracle_data methods. It may be useful in enriching indexes of DeFi contracts with off-chain data."
44
---
55

6+
# Coinbase
7+
68
A connector for [Coinbase Exchange API](https://docs.cloud.coinbase.com/exchange/docs/welcome). Provides `get_candles` and `get_oracle_data` methods. It may be useful in enriching indexes of DeFi contracts with off-chain data.
79

810
```yaml [dipdup.yaml]

docs/3.datasources/3.evm_node.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: "DipDup can connect to any EVM-compatible node via JSON-RPC. It can
44
network: "ethereum"
55
---
66

7+
# EVM node
8+
79
DipDup can connect to any EVM-compatible node via JSON-RPC. It can be used as a "last mile" datasource for EVM indexes (data that is not in Subsquid Archives yet) or as a standalone datasource for handlers and hooks.
810

911
Examples below show how to connect to Infura and Alchemy nodes for Ethereum mainnet indexes. You can also use your own node, but make sure it has all the necessary data (e.g. archive node).

docs/3.datasources/5.http.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "HTTP"
33
description: "If you need to perform arbitrary requests to APIs not supported by DipDup, use generic HTTP datasource instead of plain aiohttp requests. That way you can use the same features DipDup uses for internal requests: retry with backoff, rate limiting, Prometheus integration etc."
44
---
55

6+
# Generic HTTP
7+
68
If you need to perform arbitrary requests to APIs not supported by DipDup, use generic HTTP datasource instead of plain `aiohttp` requests. That way you can use the same features DipDup uses for internal requests: retry with backoff, rate limiting, Prometheus integration etc.
79

810
```yaml [dipdup.yaml]

docs/3.datasources/6.ipfs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "IPFS"
33
description: "While working with contract/token metadata, a typical scenario is to fetch it from IPFS. DipDup has a separate datasource to perform such requests via public nodes."
44
---
55

6+
# IPFS
7+
68
While working with contract/token metadata, a typical scenario is to fetch it from IPFS. DipDup has a separate datasource to perform such requests via public nodes.
79

810
```yaml [dipdup.yaml]

docs/3.datasources/7.tezos_tzkt.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: "TzKT provides REST endpoints to query historical data for Tezos bl
44
network: "tezos"
55
---
66

7+
# TzKT
8+
79
[TzKT](https://api.tzkt.io/) provides REST endpoints to query historical data for Tezos blockchain. Flexible filters allow to request only data needed for your application and drastically speed up the indexing process.
810

911
```yaml [dipdup.yaml]

docs/3.datasources/8.tzip_metadata.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: "dipdup-metadata is a standalone companion indexer for DipDup writt
44
network: "tezos"
55
---
66

7+
# TZIP metadata
8+
79
[dipdup-metadata](https://github.com/dipdup-io/metadata) is a standalone companion indexer for DipDup written in Go. Configure datasource in the following way:
810

911
```yaml [dipdup.yaml]

docs/5.advanced/4.metadata-interface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: "Metadata interface"
33
description: "When issuing a token on Tezos blockchain, there is an important yet not enough covered aspect related to how various ecosystem applications (wallets, explorers, marketplaces, and others) will display and interact with it."
44
---
55

6+
# Metadata interface
7+
68
::banner{type="warning"}
79
This page currently describes the metadata interface only for Tezos blockchain. For EVM-based chains the process is roughly the same. We will add the EVM-specific details later.
810
::
911

10-
# Metadata interface
11-
1212
When issuing a token on Tezos blockchain, there is an important yet not enough covered aspect related to how various ecosystem applications (wallets, explorers, marketplaces, and others) will display and interact with it. It's about token metadata, stored wholly or partially on-chain but intended for off-chain use only.
1313

1414
## Token metadata standards

0 commit comments

Comments
 (0)