docs: add architecture pages and secure payment integration guide#83
docs: add architecture pages and secure payment integration guide#83AllenAJ wants to merge 4 commits intoRequestNetwork:mainfrom
Conversation
Greptile SummaryThis PR adds four new architecture reference pages under Key changes:
Issues found:
Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant App as Your App
participant SDK as Request Network SDK
participant Node as Request Node
participant IPFS as IPFS
participant Chain as Smart Contracts (on-chain)
participant Graph as The Graph
App->>SDK: Create / update / pay request
SDK->>Node: Relay request content
Node->>IPFS: Persist encrypted/plain request payload
IPFS-->>Node: CID returned
Node->>Chain: Anchor CID on-chain (RequestHashStorage)
Chain-->>Node: Tx confirmed
Note over Chain,Graph: Payment proxy emits event with paymentReference
Chain->>Graph: Index storage & payment events
App->>SDK: Retrieve request / detect payment
SDK->>Node: Query request data
Node->>Graph: Fetch indexed events
Graph-->>Node: Events returned
Node-->>SDK: Request state + balance
SDK-->>App: Request object with payment status
Reviews (1): Last reviewed commit: "docs: add protocol architecture pages to..." | Re-trigger Greptile |
| Request Network contracts are grouped into three categories: | ||
|
|
||
| - **Storage contracts**: anchor IPFS CIDs and storage-related state | ||
| - **Payment contracts**: process payment flows across supported chains | ||
| - **REQ token and burn mechanism contracts**: support protocol token economics |
There was a problem hiding this comment.
REQ token category promised but never documented
The overview declares three contract categories, including REQ token and burn mechanism contracts, but there is no corresponding section in the body of the page. Only Storage contracts, Payment contracts, and Single Request Proxy contracts are covered. Readers who arrive looking for REQ token contract details will find the category listed but no content.
Either add a dedicated section for REQ token/burn mechanism contracts, or remove the third bullet from the overview until that content is ready.
| Request Network contracts are grouped into three categories: | |
| - **Storage contracts**: anchor IPFS CIDs and storage-related state | |
| - **Payment contracts**: process payment flows across supported chains | |
| - **REQ token and burn mechanism contracts**: support protocol token economics | |
| Request Network contracts are grouped into three categories: | |
| - **Storage contracts**: anchor IPFS CIDs and storage-related state | |
| - **Payment contracts**: process payment flows across supported chains | |
| - **Single request proxy contracts**: simplified payment flow entry points |
| ## Step 1: Sign in with wallet | ||
|
|
||
| 1. Go to [dashboard.request.network](https://dashboard.request.network/). | ||
| 2. Connect your EVM wallet and sign the authentication message. | ||
| 3. Keep this session active for the next steps. | ||
|
|
||
| <Warning> | ||
| Wallet sessions expire after around 15 minutes. If your session expires, sign in again from Dashboard. | ||
| </Warning> | ||
|
|
||
| ## Step 2: Create a payment destination | ||
|
|
||
| A payment destination registers where you receive payments, by linking your wallet address to a token on a chain. | ||
|
|
||
| 1. In Dashboard, navigate to payment destination setup. | ||
| 2. Select chain and token. | ||
| 3. Confirm creation. |
There was a problem hiding this comment.
Use
<Steps> for sequential procedures
The style guide (AGENTS.md) states: "Use Steps for procedures and sequential instructions." All six numbered steps in this guide (## Step 1 through ## Step 6) form a sequential procedure and should use the <Steps> / <Step> Mintlify components instead of bare H2 headings.
The same pattern applies to the ordered-list flows in resources/private-requests-using-encryption.mdx (Encryption flow, lines 17–20; Decryption flow, lines 24–27) and the numbered flow in resources/sdk-and-request-node-overview.mdx (lines 36–40).
Example of the recommended structure for this guide:
<Steps>
<Step title="Sign in with wallet">
Go to [dashboard.request.network](https://dashboard.request.network/), connect your EVM wallet, and sign the authentication message.
</Step>
<Step title="Create a payment destination">
...
</Step>
</Steps>Context Used: AGENTS.md (source)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Add a dedicated API setup page for connecting Claude Code and Cursor via MCP, including Request Network Mintlify MCP and llms endpoints, then wire it into nav. Made-with: Cursor
This reverts commit e998f88.
Summary
sdk-and-request-node-overviewpayment-networksprivate-requests-using-encryptionsmart-contracts-overviewdocs.jsonnavigation to include the new architecture pages under Resourcesapi-features/secure-payment-integration-guide.mdxWhy
This PR closes key public docs gaps by making:
Test plan
mint devScope notes
Connect AI Toolswas split into a separate PR: docs: add Connect AI Tools setup with MCP #84