Skip to content

Add Proof of Read API Section#17

Merged
evchip merged 6 commits into
mainfrom
feature/proof-of-read-api
Jun 16, 2025
Merged

Add Proof of Read API Section#17
evchip merged 6 commits into
mainfrom
feature/proof-of-read-api

Conversation

@evchip

@evchip evchip commented Jun 16, 2025

Copy link
Copy Markdown
Collaborator

Description

  • Add xChainRead overview section to guide developers on contract integration
  • Add xChainRead API section to guide developers and users on fetching and submitting read proofs
  • Remove some unused sections and update home page to be up to date on t1's progress

@netlify

netlify Bot commented Jun 16, 2025

Copy link
Copy Markdown

Deploy Preview for t1docs ready!

Name Link
🔨 Latest commit ae6f116
🔍 Latest deploy log https://app.netlify.com/projects/t1docs/deploys/68503b70be265300080ba021
😎 Deploy Preview https://deploy-preview-17--t1docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@evchip evchip requested a review from aharvet June 16, 2025 11:24
@evchip evchip self-assigned this Jun 16, 2025
@notion-workspace

Copy link
Copy Markdown

Document how PoR works

aharvet
aharvet previously approved these changes Jun 16, 2025
Comment thread docs/api/xChainRead/overview.md Outdated

### 3. Handle Proof Response

Once the read request is processed, the result will be posted to the [API](./api-reference). You can fetch the proof from the API and verify it with your contract. The `verifyProofOfRead` function is used to verify the proof. It takes a `bytes` calldata as input, which contains the encoded proof of read. If the proof is valid, the function will return the request ID and the result of the target function. If the proof is invalid, the function will revert.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"It takes a bytes calldata as input" -> I would specify that it's the data returned by the api call.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, thanks!


**Parameters**:
- `address` (string, required): Your contract address
- `direction` (string, optional): L1_TO_L2 or L2_TO_L1

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aren't there any option for arbitrum and base ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, these are Arbitrum and Base. L1 is Arbitrum and L2 is Base. It's a bit of a long story, but that is the state of Postman right now.

@evchip evchip requested a review from aharvet June 16, 2025 15:44
@evchip evchip merged commit b878a2d into main Jun 16, 2025
5 checks passed
@OrestTa OrestTa deleted the feature/proof-of-read-api branch October 9, 2025 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants