Skip to content

Update API docs for Read Result #33

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
evchip merged 3 commits into from
Jul 16, 2025
Merged

Update API docs for Read Result #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f41a9f
update references of direction query param for read result API to Arb…
evchip Jul 14, 2025
234ec15
change references of v05 to v06
evchip Jul 14, 2025
28bc527
Merge branch 'main' into update/read-request-api-direction-query-param
evchip Jul 16, 2025
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
13 changes: 5 additions & 8 deletions docs/integration/7683/solver-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Location: offchain

Timing: once a new `ProofOfReadRootCommitted` event has been emitted

Base URL: `https://api.v05.t1protocol.com`
Base URL: `https://api.v06.t1protocol.com`

Endpoint: `/api/read-proofs`

Expand All @@ -92,17 +92,14 @@ Method: `GET`
|-----------|------|----------|-------------|---------|

| `address` | string | No | Address that called `verifySettlement` | - |

| `direction` | string | Yes | Direction of the read: `"L1_TO_L2"` \| `"L2_TO_L1"` | - |

| `direction` | string | Yes | Direction of the read: `"ARB_TO_BASE"` \| `"BASE_TO_ARB"` | - |
| `page` | number | Yes | Page number to fetch | `1` |

| `page_size` | number | Yes | Items per page | `100` |

**Example Request:**

```bash
curl "https://api.v05.t1protocol.com/api/read-proofs?address=0x123...&direction=L1_TO_L2&page=1&page_size=100"
curl "https://api.v06.t1protocol.com/api/read-proofs?address=0x123...&direction=ARB_TO_BASE&page=1&page_size=100"
```

The HTTP call will return the following structure as a response :
Expand All @@ -126,8 +123,8 @@ interface Result {
}

enum Direction {
L1_TO_L2 = 'L1_TO_L2',
L2_TO_L1 = 'L2_TO_L1',
ARB_TO_BASE = 'ARB_TO_BASE',
BASE_TO_ARB = 'BASE_TO_ARB',
}

interface ClaimInfo {
Expand Down
8 changes: 4 additions & 4 deletions docs/integration/xChainRead/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ sidebar_position: 2

Retrieve proof data for cross-chain read requests.

**URL**: https://api.v05.t1protocol.com/api/read-proofs
**URL**: https://api.v06.t1protocol.com/api/read-proofs

**Parameters**:

- `address` (string, required): Address of the EOA that triggered the Proof of Read request
- `direction` (string, optional): L1_TO_L2 or L2_TO_L1
- `direction` (string, optional): ARB_TO_BASE or BASE_TO_ARB
- `page` (number, optional): Page number
- `page_size` (number, optional): Results per page

**Example**:
https://api.v05.t1protocol.com/api/read-proofs?address=0x81B5e00e15fb3ee055aB5e616Ccb52fA935D3534&direction=L1_TO_L2&page=1&page_size=100
https://api.v06.t1protocol.com/api/read-proofs?address=0x81B5e00e15fb3ee055aB5e616Ccb52fA935D3534&direction=ARB_TO_BASE&page=1&page_size=100

**Response Format**:

Expand All @@ -32,7 +32,7 @@ https://api.v05.t1protocol.com/api/read-proofs?address=0x81B5e00e15fb3ee055aB5e6
"block_number": 163780939,
"message_hash": "0x94cdea443c0f6034de6bdf781ce159055546c0e42632db5215558c392088ee8f",
"tx_sender": "0x42d389A9007e446b92C0ce7bd8F42Ea10292881B",
"direction": "L1_TO_L2", // Arbitrum Sepolia to Base Sepolia
"direction": "ARB_TO_BASE", // Arbitrum Sepolia to Base Sepolia
"claim_info": {
"from": "0x81B5e00e15fb3ee055aB5e616Ccb52fA935D3534",
"to": "0xf96B8CcB029E0932fe36da0CeDd2b035E2c1695d",
Expand Down
6 changes: 3 additions & 3 deletions examples/sdk/fetchAndVerifyProofOfRead.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
import { ethers } from 'ethers';

enum Direction {
ARB_TO_BASE = 'L1_TO_L2',
BASE_TO_ARB = 'L2_TO_L1',
ARB_TO_BASE = 'ARB_TO_BASE',
BASE_TO_ARB = 'BASE_TO_ARB',
}

interface ClaimInfo {
Expand Down Expand Up @@ -63,7 +63,7 @@ interface VerifiedProofReturn {
const XCHAINREADER_ABI = [
'function verifyProofOfRead(bytes encodedProofOfRead) external view returns (bytes32, bytes)',
];
const API_BASE_URL = 'https://api.v05.t1protocol.com/api';
const API_BASE_URL = 'https://api.v06.t1protocol.com/api';
const ARB_RPC_URL = 'https://arbitrum-sepolia-rpc.publicnode.com';
const BASE_RPC_URL = 'https://base-sepolia-rpc.publicnode.com';
const ARB_XCHAINREADER_ADDRESS = '0x42d389A9007e446b92C0ce7bd8F42Ea10292881B';
Expand Down