Repository navigation
Conversation
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 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
Remove the unsupported vault_cloud signer type · New Update the minimum Rust version to 1.93 · New Remove the trailing comma from the JSON example · New Link to the relayer section in the configuration guide · New Sign user authorization entries before submitting · New Correct the fee-token collection behavior for relayer mode · New Use an AssetSpec object for payment assets · New Remove the stray code-fence opener · New Show a credit4 AssetSpec for the payment asset · New List only supported REST operation types · New Use the classic asset code and issuer for the trustline · New Remove the params wrapper from the transaction request · New Require Rust 1.93 for the v1.9.0 release · New Link directly to the configuration guide · New Align the registered plugin path and plugin ID · New Use the supported Relayer configuration fields · New Sign user authorization entries before extracting their XDRs · New Update the minimum Rust version to 1.93 · New Require Rust 1.93 in the Solana setup instructions · New Link to the relayer section in the configuration guide · New
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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Documentation Pull Request
Summary
adds docs for release version v1.9.0
Type of Change
Related Issues
Fixes #
Relates to #
Checklist
pnpm run buildpnpm run checkAdditional Notes