Skip to content

Commit 549efb5

Browse files
tirumerlatirumerla
authored
Merge pull request #98 from OpenZeppelin/update-relayer-docs-v1.3
Update relayer docs v1.3
2 parents 1aca331 + ac696f9 commit 549efb5

85 files changed

Lines changed: 8313 additions & 347 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/relayer/1.1.x/quickstart.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Expected Result: A successful request should return an HTTP 200 status code alon
152152

153153
## Using the relayer through the API
154154

155-
For detailed API usage, refer to the [API Reference](./api) page.
155+
For detailed API usage, refer to the [API Reference](/relayer/1.1.x/api) page.
156156

157157
## Using the relayer through the SDK
158158

‎content/relayer/1.1.x/solana.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ curl --location --request POST 'http://localhost:8080/api/v1/relayers/solana-exa
194194
}'
195195
```
196196

197-
See [API Reference](https://release-v1-0-0%2D%2Dopenzeppelin-relayer.netlify.app/api_docs.html) and [SDK examples](https://github.com/OpenZeppelin/openzeppelin-relayer-sdk/tree/main/examples/solana) for full details and examples.
197+
See [API Reference](/relayer/1.1.x/api) and [SDK examples](https://github.com/OpenZeppelin/openzeppelin-relayer-sdk/tree/main/examples/solana) for full details and examples.
198198

199199
## Security
200200

‎content/relayer/1.1.x/stellar.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ curl --location --request POST 'http://localhost:8080/api/v1/relayers/<stellar_r
155155
}'
156156
```
157157

158-
See [API Reference](https://release-v1-0-0%2D%2Dopenzeppelin-relayer.netlify.app/api_docs.html) for full details and examples.
158+
See [API Reference](/relayer/1.1.x/api) for full details and examples.
159159

160160
### Asset Types
161161

‎content/relayer/1.2.x/evm.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ curl --location --request GET 'http://localhost:8080/api/v1/relayers/sepolia-exa
239239
--header 'Authorization: Bearer <api_key>'
240240
```
241241

242-
See [API Reference](https://release-v1-0-0%2D%2Dopenzeppelin-relayer.netlify.app/api_docs.html) for full details and examples.
242+
See [API Reference](/relayer/1.2.x/api) for full details and examples.
243243

244244
## Transaction Lifecycle
245245

‎content/relayer/1.2.x/network_configuration.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ Once networks are defined, reference them in your relayer configurations:
381381

382382
## See Also
383383

384-
* [Relayer Configuration](/relayer#relayer_configuration)
385-
* [Quickstart Guide](/relayer/quickstart)
386-
* [Solana Integration](/relayer/solana)
387-
* [API Reference](/relayer/api)
384+
* [Relayer Configuration](/relayer/1.2.x/configuration)
385+
* [Quickstart Guide](/relayer/1.2.x/quickstart)
386+
* [Solana Integration](/relayer/1.2.x/solana)
387+
* [API Reference](/relayer/1.2.x/api)

‎content/relayer/1.2.x/quickstart.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Expected Result: A successful request should return an HTTP 200 status code alon
156156

157157
## Using the relayer through the API
158158

159-
For detailed API usage, refer to the [API Reference](https://release-v1-0-0%2D%2Dopenzeppelin-relayer.netlify.app/api_docs.html) page.
159+
For detailed API usage, refer to the [API Reference](/relayer/1.2.x/api) page.
160160

161161
## Using the relayer through the SDK
162162

‎content/relayer/1.2.x/stellar.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ When using `transaction_xdr`:
228228

229229
</Callout>
230230

231-
See [API Reference](https://release-v1-0-0%2D%2Dopenzeppelin-relayer.netlify.app/api_docs.html) for full details and examples.
231+
See [API Reference](/relayer/1.2.x/api) for full details and examples.
232232

233233
### Asset Types
234234

‎content/relayer/1.3.x/api/buildSponsoredTransaction.mdx‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Prepares a sponsored (gasless) transaction with fee payments.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/relayers/{relayer_id}/transactions/sponsored/build
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents:
11+
- content: >-
12+
This endpoint builds a transaction where the relayer will pay the
13+
network fees on behalf of the user.
14+
15+
The user pays fees in a token of their choice (e.g., USDC) instead of
16+
the native network currency.
17+
18+
19+
The endpoint accepts either a pre-built transaction XDR or a set of
20+
operations to build a transaction from.
21+
22+
It returns a prepared transaction that includes:
23+
24+
- The transaction XDR (base64 encoded) ready for signing
25+
26+
- The fee amount in both the fee token and native currency (stroops
27+
for Stellar)
28+
29+
- The fee token identifier
30+
31+
- The transaction validity timestamp
32+
33+
34+
After receiving the prepared transaction, the user must sign it and
35+
submit it through the standard
36+
37+
transaction submission endpoint. For Stellar, the transaction will be
38+
wrapped in a fee-bump transaction
39+
40+
where the relayer pays the network fees.
41+
---
42+
43+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
44+
45+
This endpoint builds a transaction where the relayer will pay the network fees on behalf of the user.
46+
The user pays fees in a token of their choice (e.g., USDC) instead of the native network currency.
47+
48+
The endpoint accepts either a pre-built transaction XDR or a set of operations to build a transaction from.
49+
It returns a prepared transaction that includes:
50+
- The transaction XDR (base64 encoded) ready for signing
51+
- The fee amount in both the fee token and native currency (stroops for Stellar)
52+
- The fee token identifier
53+
- The transaction validity timestamp
54+
55+
After receiving the prepared transaction, the user must sign it and submit it through the standard
56+
transaction submission endpoint. For Stellar, the transaction will be wrapped in a fee-bump transaction
57+
where the relayer pays the network fees.
58+
59+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.3.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/sponsored/build","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.3.x/api/callPlugin.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Execute a plugin and receive the sanitized result
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/plugins/{plugin_id}/call
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents:
11+
- content: >-
12+
Logs and traces are only returned when the plugin is configured with
13+
`emit_logs` / `emit_traces`.
14+
15+
Plugin-provided errors are normalized into a consistent payload
16+
(`code`, `details`) and a derived
17+
18+
message so downstream clients receive a stable shape regardless of how
19+
the handler threw.
20+
---
21+
22+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
23+
24+
Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`.
25+
Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived
26+
message so downstream clients receive a stable shape regardless of how the handler threw.
27+
28+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.3.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.3.x/api/cancelTransaction.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Cancels a specific transaction by its ID.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/relayers/{relayer_id}/transactions/{transaction_id}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.3.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/{transaction_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

0 commit comments

Comments
 (0)