feat: middleware changes #490
Conversation
WalkthroughThis update modifies documentation across several files. It updates a document title for clarity, removes unused imports from a documentation file, clarifies field descriptions and examples in API documentation, and enhances instructions for handling multiple smart contracts in subgraph middleware setup, including folder structure and configuration examples. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
User->>Docs: Reads subgraph setup documentation
Docs-->>User: Shows folder structure for multiple contracts
Docs-->>User: Provides example config for multiple datasources
User->>Docs: Reads API portal setup documentation
Docs-->>User: Clarifies 'from' field as wallet address and gives example
Docs-->>User: Updates 'gasLimit' example value
Possibly related PRs
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx (1)
511-513: RefinegasLimitexample punctuation
Good inclusion of a zero-gas network example. For readability, consider adding a comma after “e.g.”:- e.g. 100,000,000,000 + e.g., 100,000,000,000🧰 Tools
🪛 LanguageTool
[uncategorized] ~511-~511: Loose punctuation mark.
Context: ...ss, depending on roles. -gasLimit: Use a reasonably high value for zero-ga...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~511-~511: Possible missing comma found.
Context: ...sonably high value for zero-gas private networks e.g. 100,000,000,000. For others, det...(AI_HYDRA_LEO_MISSING_COMMA)
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx (2)
105-128: Illustrate subgraph folder structure for multiple contracts
The example for organizing multiple contracts is clear and practical. For consistency, you might replace the hyphen after “look like” with a colon.🧰 Tools
🪛 LanguageTool
[uncategorized] ~126-~126: You might be missing the article “a” here.
Context: ...o.ts ``` You can keep all the names in small case and have one set each for each sma...(AI_EN_LECTOR_MISSING_DETERMINER_A)
129-130: Fix typo in heading
The word “contrat” is misspelled; please correct to “contract”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/docs/application-kits/asset-tokenization/xvp-settlement.mdx(1 hunks)content/docs/building-with-settlemint/evm-chains-guide/audit-logs.mdx(0 hunks)content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx(1 hunks)content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx(3 hunks)
💤 Files with no reviewable changes (1)
- content/docs/building-with-settlemint/evm-chains-guide/audit-logs.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx
[uncategorized] ~508-~508: Loose punctuation mark.
Context: ... #### Field descriptions - **from`**: Address of the wallet that will initiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~509-~509: Possible missing comma found.
Context: ...lly, this is the deployer private key's address e.g. 0x03739d74f28817826936F671e9C59777...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~511-~511: Loose punctuation mark.
Context: ...ss, depending on roles. - gasLimit: Use a reasonably high value for zero-ga...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~511-~511: Possible missing comma found.
Context: ...sonably high value for zero-gas private networks e.g. 100,000,000,000. For others, det...
(AI_HYDRA_LEO_MISSING_COMMA)
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx
[uncategorized] ~126-~126: You might be missing the article “a” here.
Context: ...o.ts ``` You can keep all the names in small case and have one set each for each sma...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build
🔇 Additional comments (3)
content/docs/application-kits/asset-tokenization/xvp-settlement.mdx (1)
2-2: Title update looks good
The concise title “XvP atomic settlements” aligns with other guides and improves clarity.content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx (1)
508-510: Clarify thefromfield description
The updated bullet correctly specifies thatfromis the deployer private key’s address initiating the transaction.🧰 Tools
🪛 LanguageTool
[uncategorized] ~508-~508: Loose punctuation mark.
Context: ...#### Field descriptions - **from`**: Address of the wallet that will initiat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~509-~509: Possible missing comma found.
Context: ...lly, this is the deployer private key's address e.g. 0x03739d74f28817826936F671e9C59777...(AI_HYDRA_LEO_MISSING_COMMA)
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx (1)
193-214: Approve JSON datasources example
The multiple-datasourcessubgraph.config.jsonsnippet is well-formatted and aligns with best practices.
No description provided.