Skip to content

docs: add docs for release version v1.9.0 - #267

Open
collins-w wants to merge 2 commits into
mainfrom
add-version-1.9.0-docs
Open

collins-w wants to merge 2 commits into
mainfrom
add-version-1.9.0-docs

Conversation

@collins-w

Copy link
Copy Markdown
Collaborator

Documentation Pull Request

Summary

adds docs for release version v1.9.0

Type of Change

  • New documentation
  • Documentation update/revision
  • Fix typos or grammar
  • Restructure/reorganize content
  • Add examples or tutorials
  • Update API documentation
  • Other: ___________

Related Issues

Fixes #
Relates to #

Checklist

Additional Notes

@collins-w
collins-w requested a review from a team as a code owner November 4, 2026 15:57
@netlify

netlify Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 37ce26c
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/6aed8e77eaa7ca27660d2b65
😎 Deploy Preview https://deploy-preview-267--openzeppelin-docs-v2.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.

Copilot AI left a comment

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.

🟡 Changes recommended

Unresolved documentation errors include insufficient Rust prerequisites, invalid configuration and API examples, and unsigned Stellar authorization flows that would cause builds, requests, or transactions to fail.

27 open issues

And 7 more that still need to be addressed.

What changed in this PR

Adds versioned documentation for OpenZeppelin Relayer v1.9.0 and promotes 1.9.x to the latest stable documentation version.

Changes:

  • Updates release-version metadata while retaining previous stable versions.
  • Adds integration, configuration, and tutorial pages, including Soroban gas abstraction and Zama FHEVM workflows.
  • Adds release-specific API reference pages backed by the v1.9.0 OpenAPI document.
File Description
content/​relayer/​latest-versions.js Updated as part of this pull request.
content/​relayer/​1.9.x/​zama-fhevm.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​structure.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​stellar.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​solana.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​roadmap.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​quickstart.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​plugins/​channels.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​network_configuration.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​index.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​guides/​zama-fhevm-counter-guide.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​guides/​stellar-x402-facilitator-guide.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​guides/​stellar-sponsored-transactions-guide.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​guides/​stellar-channels-guide.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​guides/​index.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​evm.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​configuration/​storage.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​configuration/​signers.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​updateSigner.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​updateRelayer.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​updatePlugin.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​updateNotification.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​updateNetwork.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​signTypedData.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​signTransaction.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​sign.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​sendTransaction.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​scrapeMetrics.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​scrape_metrics.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​rpc.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​replaceTransaction.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​readiness.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​quoteSponsoredTransaction.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​metricDetail.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​metric_detail.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listTransactions.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listSigners.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listRelayers.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listPlugins.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listNotifications.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listNetworks.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​listMetrics.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​list_metrics.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​index.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​health.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getTransactionByNonce.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getTransactionById.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getSigner.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getRelayerStatus.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getRelayerBalance.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getRelayer.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getPlugin.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getNotification.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​getNetwork.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​deleteSigner.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​deleteRelayer.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​deletePendingTransactions.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​deleteNotification.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​createSigner.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​createRelayer.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​createNotification.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​cancelTransaction.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​callPluginGet.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​callPlugin.mdx Updated as part of this pull request.
content/​relayer/​1.9.x/​api/​buildSponsoredTransaction.mdx Updated as part of this pull request.

Review effort: Balanced


- `local` (local keystore files)
- `vault` (HashiCorp Vault secret storage)
- `vault_cloud` (hosted HashiCorp Vault)
For a step-by-step setup, see [Quick Start Guide](/relayer/1.9.x/quickstart).
Key prerequisites:

- Rust 2021, version `1.88` or later
],
"min_balance": 1000000000000000000
}
},
- `min_balance`: Minimum balance required for the relayer to operate (in wei)
- `eip1559_pricing`: Enable/disable EIP-1559 pricing methodology for transaction fees

You can check all options in [User Documentation - Relayers](/relayer/1.9.x#3_relayers).
// Extract function and auth XDRs
const op = assembled.operations[0];
const func = op.func.toXDR('base64');
const auth = (op.auth ?? []).map((a) => a.toXDR('base64'));
}
```

For general relayer configuration options, check [User Documentation - Relayers](/relayer/1.9.x#3_relayers).

<Callout type="info">

**Asset Support**: Currently, only classic Stellar assets (credit_alphanum4 and credit_alphanum12) are supported for sponsored transactions. Soroban token support will be available in a future release.
```json
{
"type": "credit_alphanum4",
"code": "USDC",
Comment on lines +508 to +509
| Vector | `"vec": ["u32": 1, "u32": 2, "u32": 3]` | Array of ScVal values |
| Map | `"map": ["key": "symbol": "name", "val": "string": "MyToken"]` | Key-value pairs |

- `local` (local keystore files)
- `vault` (HashiCorp Vault secret storage)
- `vault_cloud` (hosted HashiCorp Vault)
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.

3 participants