Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: api-reference
title: API Reference
sidebar_label: API Reference
sidebar_position: 1
sidebar_position: 2
---

# API Reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: frontend
title: Frontend Integration
sidebar_label: Frontend Integration
sidebar_position: 2
title: ERC 7683 Frontend Integration
sidebar_label: ERC 7683 Frontend Integration
sidebar_position: 3
---

# Frontend Integration for 7683 Intent Bridging
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: xChainRead
id: overview
title: xChainRead Overview
sidebar_label: xChainRead
sidebar_label: Overview
sidebar_position: 1
---

Expand Down Expand Up @@ -92,8 +92,8 @@ The `requestRead` function is used to request a cross-chain read. It takes a `Re

### 3. Handle Proof Response

Once the read request is processed, the result will be posted to the [API](../../api/xChainRead/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 can be fetched via the `handle_read_result_with_proof_calldata` field from the API. 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.
Once the read request is processed, the result will be posted to the [API](../xChainRead/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 can be fetched via the `handle_read_result_with_proof_calldata` field from the API. 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.

## Next Steps

- [API Reference](../../api/xChainRead/api-reference) - Detailed API documentation
- [API Reference](../xChainRead/api-reference) - Detailed API documentation
11 changes: 2 additions & 9 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ require('dotenv').config()
module.exports = {
customFields: {
// Analytics proxy URL
analyticsProxyUrl: process.env.REACT_APP_AMPLITUDE_PROXY_URL,
// analyticsProxyUrl: process.env.REACT_APP_AMPLITUDE_PROXY_URL,
// Determines if staging env
stagingEnv: process.env.REACT_APP_STAGING,
// From node
Expand Down Expand Up @@ -36,18 +36,11 @@ module.exports = {
className: 'V3_active',
},
{
to: '/integration/7683/xChainRead',
to: '/integration/xChainRead/overview',
label: 'Integration',
position: 'left',
className: 'V3_active',
},
{
to: '/api/xChainRead/api-reference',
label: 'API',
position: 'left',
className: 'V3_active',
},

{
// TODO(docs): Publish docs repo and make public at this URL
href: 'https://github.com/t1protocol/',
Expand Down
1 change: 0 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
apiSidebar: [{ type: 'autogenerated', dirName: 'api' }],
integrationSidebar: [{ type: 'autogenerated', dirName: 'integration' }],
conceptsSidebar: [{ type: 'autogenerated', dirName: 'concepts' }],
contractsSidebar: [{ type: 'autogenerated', dirName: 'contracts' }],
Expand Down