Skip to content

Commit c0b49b7

Browse files
committed
docs(README): link to crate-level docs and say what aggregator is
Signed-off-by: Joseph Livesey <[email protected]>
1 parent fff4e83 commit c0b49b7

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ payment (a Receipt Aggregate Voucher, or RAV). This aggregate payment can then b
88
verified on-chain by a payment verifier, reducing the number of transactions and
99
simplifying the payment process.
1010

11+
## Documentation for Individual Components
12+
13+
- [tap_aggregator](tap_aggregator/README.md)
14+
- [tap_core](tap_core/README.md) - links to this `README` for now.
15+
1116
## Key Components
1217

1318
- **Sender:** Initiates the payment.

tap_aggregator/README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
A stateless JSON-RPC service that lets clients request an aggregate receipt from a list of individual receipts.
44

5+
TAP Aggregator is run by [gateway](https://github.com/edgeandnode/gateway/blob/main/README.md)
6+
operators.
7+
8+
As described in the [gateway README section on TAP](https://github.com/edgeandnode/gateway/blob/main/README.md#tap):
9+
10+
> The `gateway` acts as a TAP sender, where each indexer request is sent with a TAP receipt. The `gateway` operator is expected to run 2 additional services:
11+
>
12+
> - `tap-aggregator` (this crate!): public endpoint where indexers can aggregate receipts into RAVs
13+
> - [tap-escrow-manager](https://github.com/edgeandnode/tap-escrow-manager): maintains escrow balances for the TAP sender. This service requires data exported by the gateway into the "indexer requests" topic to calculate the value of outstanding receipts to each indexer.
14+
>
15+
> The `gateway` operator is also expected to manage at least 2 wallets:
16+
>
17+
> - sender: requires ETH for transaction gas and GRT to allocate into TAP escrow balances for paying indexers
18+
> - authorized signer: used by the `gateway` and `tap-aggregator` to sign receipts and RAVs
19+
520
## Settings
621

722
```txt
@@ -80,20 +95,20 @@ form:
8095
}
8196
```
8297

83-
| Field | Type | Description |
84-
| ------------- | --------- | -------------------------------------------------------------------------------------------------------- |
85-
| `data` | `Object` | The response data. Method specific, see each method's documentation. |
86-
| `warnings` | `Array` | (Optional) A list of warnings. If the list is empty, no warning field is added to the JSON-RPC response. |
98+
| Field | Type | Description |
99+
| ---------- | -------- | -------------------------------------------------------------------------------------------------------- |
100+
| `data` | `Object` | The response data. Method specific, see each method's documentation. |
101+
| `warnings` | `Array` | (Optional) A list of warnings. If the list is empty, no warning field is added to the JSON-RPC response. |
87102

88103
WARNING: Always check for warnings!
89104

90105
Warning object format (similar to the standard JSON-RPC error object):
91106

92-
| Field | Type | Description |
93-
| ------------- | --------- | ------------------------------------------------------------------------------------------------ |
94-
| `code` | `Integer` | A number that indicates the error type that occurred. |
95-
| `message` | `String` | A short description of the error. |
96-
| `data` | `Object` | (Optional) A primitive or structured value that contains additional information about the error. |
107+
| Field | Type | Description |
108+
| --------- | --------- | ------------------------------------------------------------------------------------------------ |
109+
| `code` | `Integer` | A number that indicates the error type that occurred. |
110+
| `message` | `String` | A short description of the error. |
111+
| `data` | `Object` | (Optional) A primitive or structured value that contains additional information about the error. |
97112

98113
We define these warning codes:
99114

0 commit comments

Comments
 (0)