Skip to content

Commit 62b0468

Browse files
collins-wtirumerla
collins-w
and
tirumerla
authored
feat: add relayer version 1.5.0 docs (#173)
* feat: add relayer version 1.5.0 docs * chore: Fix navigation & fix latest docs --------- Co-authored-by: tirumerla <[email protected]>
1 parent 670a0a0 commit 62b0468

131 files changed

Lines changed: 10129 additions & 411 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.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ temp-*/
3535
next-env.d.ts
3636
old-docs
3737
.claude
38+
.serena
3839
TODO.md
3940
broken-links.md
4041

‎content/relayer/1.5.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.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/sponsored/build","method":"post"}]} webhooks={[]} hasHead={false} />

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Execute a plugin with optional wildcard route routing
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+
The endpoint supports wildcard route routing, allowing plugins to
23+
implement custom routing logic:
24+
25+
- `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = "")
26+
27+
- `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via
28+
query parameter
29+
30+
- `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL
31+
path (route = "/verify")
32+
33+
34+
The route is passed to the plugin handler via the `context.route`
35+
field.
36+
37+
You can specify a custom route either by appending it to the URL path
38+
or by using the `route` query parameter.
39+
---
40+
41+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
42+
43+
Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`.
44+
Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived
45+
message so downstream clients receive a stable shape regardless of how the handler threw.
46+
47+
The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic:
48+
- `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = "")
49+
- `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter
50+
- `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = "/verify")
51+
52+
The route is passed to the plugin handler via the `context.route` field.
53+
You can specify a custom route either by appending it to the URL path or by using the `route` query parameter.
54+
55+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.x/api/callPluginGet.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Execute a plugin via GET (must be enabled per plugin)
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /api/v1/plugins/{plugin_id}/call
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents:
11+
- content: >-
12+
This endpoint is disabled by default. To enable it for a given plugin,
13+
set
14+
15+
`allow_get_invocation: true` in the plugin configuration.
16+
17+
18+
When invoked via GET:
19+
20+
- `params` is an empty object (`{}`)
21+
22+
- query parameters are passed to the plugin handler via
23+
`context.query`
24+
25+
- wildcard route routing is supported the same way as POST (see
26+
`doc_call_plugin`)
27+
28+
- Use the `route` query parameter or append the route to the URL path
29+
---
30+
31+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
32+
33+
This endpoint is disabled by default. To enable it for a given plugin, set
34+
`allow_get_invocation: true` in the plugin configuration.
35+
36+
When invoked via GET:
37+
- `params` is an empty object (`{}`)
38+
- query parameters are passed to the plugin handler via `context.query`
39+
- wildcard route routing is supported the same way as POST (see `doc_call_plugin`)
40+
- Use the `route` query parameter or append the route to the URL path
41+
42+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"get"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.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.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/{transaction_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.x/api/createNotification.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Creates a new notification.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/notifications
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.5.0/openapi.json"} operations={[{"path":"/api/v1/notifications","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.x/api/createRelayer.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Creates a new relayer.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/relayers
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.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.x/api/createSigner.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Creates a new signer.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/signers
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.5.0/openapi.json"} operations={[{"path":"/api/v1/signers","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.x/api/deleteNotification.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Deletes a notification by ID.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/notifications/{notification_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.5.0/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/relayer/1.5.x/api/deletePendingTransactions.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Deletes all pending transactions for a specific relayer.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/relayers/{relayer_id}/transactions/pending
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.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/pending","method":"delete"}]} webhooks={[]} hasHead={false} />

0 commit comments

Comments
 (0)