Skip to content

Commit 8d3541b

Browse files
authored
Redirect TAP Version to indexer docs (#774)
Signed-off-by: Gustavo Inacio <[email protected]>
1 parent 51106cf commit 8d3541b

File tree

24 files changed

+645
-810
lines changed

24 files changed

+645
-810
lines changed

website/pages/ar/tap.mdx

+28-35
Original file line numberDiff line numberDiff line change
@@ -45,53 +45,58 @@ As long as you run `tap-agent` and `indexer-agent`, everything will be executed
4545

4646
### Contracts
4747

48-
| Contract | Arbitrum Sepolia | Arbitrum Mainnet |
49-
| ------------------- | ------------------------------------------ | ------------------------------------------ |
50-
| Contract | Arbitrum Sepolia (421614) | Arbitrum Mainnet (42161) |
51-
| TAP Verifier | 0xfC24cE7a4428A6B89B52645243662A02BA734ECF | 0x33f9E93266ce0E108fc85DdE2f71dab555A0F05a |
52-
| AllocationIDTracker | 0xAaC28a10d707bbc6e02029f1bfDAEB5084b2aD11 | 0x5B2F33d7Ca6Ec88f5586f2528f58c20843D9FE7c |
53-
| Escrow | 0x1e4dC4f9F95E102635D8F7ED71c5CdbFa20e2d02 | 0x8f477709eF277d4A880801D01A140a9CF88bA0d3 |
48+
| Contract | Arbitrum Sepolia (421614) | Arbitrum Mainnet (42161) |
49+
| ------------------- | -------------------------------------------- | -------------------------------------------- |
50+
| TAP Verifier | `0xfC24cE7a4428A6B89B52645243662A02BA734ECF` | `0x33f9E93266ce0E108fc85DdE2f71dab555A0F05a` |
51+
| AllocationIDTracker | `0xAaC28a10d707bbc6e02029f1bfDAEB5084b2aD11` | `0x5B2F33d7Ca6Ec88f5586f2528f58c20843D9FE7c` |
52+
| Escrow | `0x1e4dC4f9F95E102635D8F7ED71c5CdbFa20e2d02` | `0x8f477709eF277d4A880801D01A140a9CF88bA0d3` |
5453

5554
### Gateway
5655

57-
| Component | Edge and Node (Testnet) | Edge and Node Mainnet (42161) |
58-
| --- | --- | --- |
59-
| Sender | 0xC3dDf37906724732FfD748057FEBe23379b0710D | 0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467 |
60-
| Signers | 00xFb142dE83E261e43a81e9ACEADd1c66A0DB121FE | 0xfF4B7A5EfD00Ff2EC3518D4F250A27e4c29A2211 |
61-
| Aggregator | [for testnet](https://tap-aggregator.testnet.thegraph.com) | [for Mainnet](https://tap-aggregator.network.thegraph.com) |
56+
| Component | Edge and Node Mainnet (Arbitrum Sepolia) | Edge and Node Testnet (Aribtrum Mainnet) |
57+
| ---------- | --------------------------------------------- | --------------------------------------------- |
58+
| Sender | `0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467` | `0xC3dDf37906724732FfD748057FEBe23379b0710D` |
59+
| Signers | `0xfF4B7A5EfD00Ff2EC3518D4F250A27e4c29A2211` | `0xFb142dE83E261e43a81e9ACEADd1c66A0DB121FE` |
60+
| Aggregator | `https://tap-aggregator.network.thegraph.com` | `https://tap-aggregator.testnet.thegraph.com` |
6261

6362
### Requirements
6463

6564
In addition to the typical requirements to run an indexer, you’ll need a `tap-escrow-subgraph` endpoint to query TAP updates. You can use The Graph Network to query or host yourself on your `graph-node`.
6665

67-
> Note: `indexer-cli` does not currently have a command to index this subgraph like it does for `graph-network`. As a result, you have to index it manually.
66+
- [Graph TAP Aribtrum Sepolia subgraph (for The Graph testnet)](https://thegraph.com/explorer/subgraphs/7ubx365MiqBH5iUz6XWXWT8PTof5BVAyEzdb8m17RvbD)
67+
- [Graph TAP Arbitrum One subgraph (for The Graph mainnet)](https://thegraph.com/explorer/subgraphs/4sukbNVTzGELnhdnpyPqsf1QqtzNHEYKKmJkgaT8z6M1)
68+
69+
> Note: `indexer-agent` does not currently handle the indexing of this subgraph like it does for the network subgraph deployement. As a result, you have to index it manually.
6870
6971
## Migration Guide
7072

71-
### Prerequisites
73+
### Software versions
7274

73-
Make sure you have the following version: `<insert the version here>`
75+
The required software version can be found [here](https://github.com/graphprotocol/indexer/blob/main/docs/networks/arbitrum-one.md#latest-releases).
7476

7577
### Steps
7678

7779
1. **Indexer Agent**
7880

7981
- Follow the [same process](https://github.com/graphprotocol/indexer/pkgs/container/indexer-agent#graph-protocol-indexer-components).
80-
- Use the new argument `tap-subgraph-endpoint`.
82+
- Give the new argument `--tap-subgraph-endpoint` to activate the new TAP codepaths and enable redeeming of TAP RAVs.
8183

8284
2. **Indexer Service**
8385

84-
- Fully replace your current configuration with the new application.
85-
- You can reuse some of the values in your environment variables and command arguments inside the configuration.
86-
> It’s critical to install the new `tap-agent` component to receive your payments.
86+
- Fully replace your current configuration with the [new Indexer Service rs](https://github.com/graphprotocol/indexer-rs). It's recommend that you use the [container image](https://github.com/orgs/graphprotocol/packages?repo_name=indexer-rs).
87+
- Like the older version, you can scale Indexer Service horizontally easily. It is still stateless.
88+
89+
3. **TAP Agent**
8790

88-
3. **Configure**
91+
- Run _one_ single instance of [TAP Agent](https://github.com/graphprotocol/indexer-rs) at all times. It's recommend that you use the [container image](https://github.com/orgs/graphprotocol/packages?repo_name=indexer-rs).
8992

90-
Configuration is shared between components, enabling you to use a single configuration for both `indexer-service` and `tap-agent`. Each component will use the required fields.
93+
4. **Configure Indexer Service and TAP Agent**
94+
95+
Configuration is a TOML file shared between `indexer-service` and `tap-agent`, supplied with the argument `--config /path/to/config.toml`.
9196

9297
Check out the full [configuration](https://github.com/graphprotocol/indexer-rs/blob/main/config/maximal-config-example.toml) and the [default values](https://github.com/graphprotocol/indexer-rs/blob/main/config/default_values.toml)
9398

94-
For minimal configuration, use the following:
99+
For minimal configuration, use the following template:
95100

96101
```bash
97102
# You will have to change *all* the values below to match your setup.
@@ -159,27 +164,15 @@ max_amount_willing_to_lose_grt = 20
159164

160165
[tap.sender_aggregator_endpoints]
161166
# Key-Value of all senders and their aggregator endpoints
162-
0xdeadbeefcafebabedeadbeefcafebabedeadbeef = "https://example.com/aggregate-receipts"
163-
0x0123456789abcdef0123456789abcdef01234567 = "https://other.example.com/aggregate-receipts"
167+
# This one below is for the E&N testnet gateway for example.
168+
0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467 = "https://tap-aggregator.network.thegraph.com"
164169
```
165170

166171
Notes:
167172

168173
- Values for `tap.sender_aggregator_endpoints` can be found in the [gateway section](/tap/#gateway).
169174
- Values for `blockchain.receipts_verifier_address` must be used accordingly to the [Blockchain addresses section](/tap/#contracts) using the appropriate chain id.
170175

171-
### Running
172-
173-
| Component | Version | Image Link |
174-
| --- | --- | --- |
175-
| indexer-service | v1.0.0-rc.6 | [indexer-service](https://github.com/graphprotocol/indexer-rs/pkgs/container/indexer-service-rs/264320627?tag=1.0.0-rc.6) |
176-
| indexer-agent | PR #995 | [indexer-agent](https://github.com/graphprotocol/indexer/pkgs/container/indexer-agent/266166026?tag=sha-d98cf80) |
177-
| tap-agent | v1.0.0-rc.6 | [tap-agent](https://github.com/graphprotocol/indexer-rs/pkgs/container/indexer-tap-agent/264320547?tag=1.0.0-rc.6) |
178-
179-
**Command argument**
180-
181-
With a configuration file `config.toml` setup, you can either run the following docker-image or use the config args: `--config/path/to/config.toml`
182-
183176
**Log Level**
184177

185178
- You can set the log level by using the `RUST_LOG` environment variable.

website/pages/cs/tap.mdx

+28-35
Original file line numberDiff line numberDiff line change
@@ -45,53 +45,58 @@ As long as you run `tap-agent` and `indexer-agent`, everything will be executed
4545

4646
### Contracts
4747

48-
| Contract | Arbitrum Sepolia | Arbitrum Mainnet |
49-
| ------------------- | ------------------------------------------ | ------------------------------------------ |
50-
| Contract | Arbitrum Sepolia (421614) | Arbitrum Mainnet (42161) |
51-
| TAP Verifier | 0xfC24cE7a4428A6B89B52645243662A02BA734ECF | 0x33f9E93266ce0E108fc85DdE2f71dab555A0F05a |
52-
| AllocationIDTracker | 0xAaC28a10d707bbc6e02029f1bfDAEB5084b2aD11 | 0x5B2F33d7Ca6Ec88f5586f2528f58c20843D9FE7c |
53-
| Escrow | 0x1e4dC4f9F95E102635D8F7ED71c5CdbFa20e2d02 | 0x8f477709eF277d4A880801D01A140a9CF88bA0d3 |
48+
| Contract | Arbitrum Sepolia (421614) | Arbitrum Mainnet (42161) |
49+
| ------------------- | -------------------------------------------- | -------------------------------------------- |
50+
| TAP Verifier | `0xfC24cE7a4428A6B89B52645243662A02BA734ECF` | `0x33f9E93266ce0E108fc85DdE2f71dab555A0F05a` |
51+
| AllocationIDTracker | `0xAaC28a10d707bbc6e02029f1bfDAEB5084b2aD11` | `0x5B2F33d7Ca6Ec88f5586f2528f58c20843D9FE7c` |
52+
| Escrow | `0x1e4dC4f9F95E102635D8F7ED71c5CdbFa20e2d02` | `0x8f477709eF277d4A880801D01A140a9CF88bA0d3` |
5453

5554
### Gateway
5655

57-
| Component | Edge and Node (Testnet) | Edge and Node Mainnet (42161) |
58-
| --- | --- | --- |
59-
| Sender | 0xC3dDf37906724732FfD748057FEBe23379b0710D | 0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467 |
60-
| Signers | 00xFb142dE83E261e43a81e9ACEADd1c66A0DB121FE | 0xfF4B7A5EfD00Ff2EC3518D4F250A27e4c29A2211 |
61-
| Aggregator | [for testnet](https://tap-aggregator.testnet.thegraph.com) | [for Mainnet](https://tap-aggregator.network.thegraph.com) |
56+
| Component | Edge and Node Mainnet (Arbitrum Sepolia) | Edge and Node Testnet (Aribtrum Mainnet) |
57+
| ---------- | --------------------------------------------- | --------------------------------------------- |
58+
| Sender | `0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467` | `0xC3dDf37906724732FfD748057FEBe23379b0710D` |
59+
| Signers | `0xfF4B7A5EfD00Ff2EC3518D4F250A27e4c29A2211` | `0xFb142dE83E261e43a81e9ACEADd1c66A0DB121FE` |
60+
| Aggregator | `https://tap-aggregator.network.thegraph.com` | `https://tap-aggregator.testnet.thegraph.com` |
6261

6362
### Requirements
6463

6564
In addition to the typical requirements to run an indexer, you’ll need a `tap-escrow-subgraph` endpoint to query TAP updates. You can use The Graph Network to query or host yourself on your `graph-node`.
6665

67-
> Note: `indexer-cli` does not currently have a command to index this subgraph like it does for `graph-network`. As a result, you have to index it manually.
66+
- [Graph TAP Aribtrum Sepolia subgraph (for The Graph testnet)](https://thegraph.com/explorer/subgraphs/7ubx365MiqBH5iUz6XWXWT8PTof5BVAyEzdb8m17RvbD)
67+
- [Graph TAP Arbitrum One subgraph (for The Graph mainnet)](https://thegraph.com/explorer/subgraphs/4sukbNVTzGELnhdnpyPqsf1QqtzNHEYKKmJkgaT8z6M1)
68+
69+
> Note: `indexer-agent` does not currently handle the indexing of this subgraph like it does for the network subgraph deployement. As a result, you have to index it manually.
6870
6971
## Migration Guide
7072

71-
### Prerequisites
73+
### Software versions
7274

73-
Make sure you have the following version: `<insert the version here>`
75+
The required software version can be found [here](https://github.com/graphprotocol/indexer/blob/main/docs/networks/arbitrum-one.md#latest-releases).
7476

7577
### Steps
7678

7779
1. **Indexer Agent**
7880

7981
- Follow the [same process](https://github.com/graphprotocol/indexer/pkgs/container/indexer-agent#graph-protocol-indexer-components).
80-
- Use the new argument `tap-subgraph-endpoint`.
82+
- Give the new argument `--tap-subgraph-endpoint` to activate the new TAP codepaths and enable redeeming of TAP RAVs.
8183

8284
2. **Indexer Service**
8385

84-
- Fully replace your current configuration with the new application.
85-
- You can reuse some of the values in your environment variables and command arguments inside the configuration.
86-
> It’s critical to install the new `tap-agent` component to receive your payments.
86+
- Fully replace your current configuration with the [new Indexer Service rs](https://github.com/graphprotocol/indexer-rs). It's recommend that you use the [container image](https://github.com/orgs/graphprotocol/packages?repo_name=indexer-rs).
87+
- Like the older version, you can scale Indexer Service horizontally easily. It is still stateless.
88+
89+
3. **TAP Agent**
8790

88-
3. **Configure**
91+
- Run _one_ single instance of [TAP Agent](https://github.com/graphprotocol/indexer-rs) at all times. It's recommend that you use the [container image](https://github.com/orgs/graphprotocol/packages?repo_name=indexer-rs).
8992

90-
Configuration is shared between components, enabling you to use a single configuration for both `indexer-service` and `tap-agent`. Each component will use the required fields.
93+
4. **Configure Indexer Service and TAP Agent**
94+
95+
Configuration is a TOML file shared between `indexer-service` and `tap-agent`, supplied with the argument `--config /path/to/config.toml`.
9196

9297
Check out the full [configuration](https://github.com/graphprotocol/indexer-rs/blob/main/config/maximal-config-example.toml) and the [default values](https://github.com/graphprotocol/indexer-rs/blob/main/config/default_values.toml)
9398

94-
For minimal configuration, use the following:
99+
For minimal configuration, use the following template:
95100

96101
```bash
97102
# You will have to change *all* the values below to match your setup.
@@ -159,27 +164,15 @@ max_amount_willing_to_lose_grt = 20
159164

160165
[tap.sender_aggregator_endpoints]
161166
# Key-Value of all senders and their aggregator endpoints
162-
0xdeadbeefcafebabedeadbeefcafebabedeadbeef = "https://example.com/aggregate-receipts"
163-
0x0123456789abcdef0123456789abcdef01234567 = "https://other.example.com/aggregate-receipts"
167+
# This one below is for the E&N testnet gateway for example.
168+
0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467 = "https://tap-aggregator.network.thegraph.com"
164169
```
165170

166171
Notes:
167172

168173
- Values for `tap.sender_aggregator_endpoints` can be found in the [gateway section](/tap/#gateway).
169174
- Values for `blockchain.receipts_verifier_address` must be used accordingly to the [Blockchain addresses section](/tap/#contracts) using the appropriate chain id.
170175

171-
### Running
172-
173-
| Component | Version | Image Link |
174-
| --- | --- | --- |
175-
| indexer-service | v1.0.0-rc.6 | [indexer-service](https://github.com/graphprotocol/indexer-rs/pkgs/container/indexer-service-rs/264320627?tag=1.0.0-rc.6) |
176-
| indexer-agent | PR #995 | [indexer-agent](https://github.com/graphprotocol/indexer/pkgs/container/indexer-agent/266166026?tag=sha-d98cf80) |
177-
| tap-agent | v1.0.0-rc.6 | [tap-agent](https://github.com/graphprotocol/indexer-rs/pkgs/container/indexer-tap-agent/264320547?tag=1.0.0-rc.6) |
178-
179-
**Command argument**
180-
181-
With a configuration file `config.toml` setup, you can either run the following docker-image or use the config args: `--config/path/to/config.toml`
182-
183176
**Log Level**
184177

185178
- You can set the log level by using the `RUST_LOG` environment variable.

0 commit comments

Comments
 (0)