Skip to content

docs(README): link to crate-level docs and say what aggregator is #261

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 22, 2025
Merged

docs(README): link to crate-level docs and say what aggregator is #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ payment (a Receipt Aggregate Voucher, or RAV). This aggregate payment can then b
verified on-chain by a payment verifier, reducing the number of transactions and
simplifying the payment process.

## Documentation for Individual Components

- [tap_aggregator](tap_aggregator/README.md)
- [tap_core](tap_core/README.md) - links to this `README` for now.

## Key Components

- **Sender:** Initiates the payment.
Expand Down
33 changes: 24 additions & 9 deletions tap_aggregator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

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

TAP Aggregator is run by [gateway](https://github.com/edgeandnode/gateway/blob/main/README.md)
operators.

As described in the [gateway README section on TAP](https://github.com/edgeandnode/gateway/blob/main/README.md#tap):

> 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:
>
> - `tap-aggregator` (this crate!): public endpoint where indexers can aggregate receipts into RAVs
> - [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.
>
> The `gateway` operator is also expected to manage at least 2 wallets:
>
> - sender: requires ETH for transaction gas and GRT to allocate into TAP escrow balances for paying indexers
> - authorized signer: used by the `gateway` and `tap-aggregator` to sign receipts and RAVs

## Settings

```txt
Expand Down Expand Up @@ -80,20 +95,20 @@ form:
}
```

| Field | Type | Description |
| ------------- | --------- | -------------------------------------------------------------------------------------------------------- |
| `data` | `Object` | The response data. Method specific, see each method's documentation. |
| `warnings` | `Array` | (Optional) A list of warnings. If the list is empty, no warning field is added to the JSON-RPC response. |
| Field | Type | Description |
| ---------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `data` | `Object` | The response data. Method specific, see each method's documentation. |
| `warnings` | `Array` | (Optional) A list of warnings. If the list is empty, no warning field is added to the JSON-RPC response. |

WARNING: Always check for warnings!

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

| Field | Type | Description |
| ------------- | --------- | ------------------------------------------------------------------------------------------------ |
| `code` | `Integer` | A number that indicates the error type that occurred. |
| `message` | `String` | A short description of the error. |
| `data` | `Object` | (Optional) A primitive or structured value that contains additional information about the error. |
| Field | Type | Description |
| --------- | --------- | ------------------------------------------------------------------------------------------------ |
| `code` | `Integer` | A number that indicates the error type that occurred. |
| `message` | `String` | A short description of the error. |
| `data` | `Object` | (Optional) A primitive or structured value that contains additional information about the error. |

We define these warning codes:

Expand Down
Loading