Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ content/
```

Each product directory contains:

- `index.mdx` - Main documentation entry point
- `changelog.mdx` - Version history and changes
- Subdirectories for specific features/modules
Expand Down Expand Up @@ -107,32 +108,38 @@ Sidebar navigation is handled in `src/navigation/` where multiple navigation JSO
### Key Components

#### Layout Components

- `DocsLayoutClient` - Client-side docs layout with sidebar
- `BaseLayoutProps` - Shared layout configuration
- `PageClient` - Individual page wrapper

#### UI Components

- `Card` & `SmallCard` - Content cards for homepage
- `TOC` - Table of contents with scrollspy
- `Search` - Search interface with custom results
- `ThemeToggle` - Theme switching
- `VersionBanner` - Version-specific messaging

#### Custom Icons

Product-specific icons located in `src/components/icons/`:

- Ethereum, Arbitrum, StarkNet, Stellar, Polkadot chains
- Product icons for Contracts, Defender, Monitor, etc.
- Tool icons for Wizard, Ethernaut, etc.

### Content Features

#### MDX Enhancements

- **Math Support**: LaTeX math rendering with KaTeX
- **Mermaid Diagrams**: Flowcharts and diagrams
- **Code Highlighting**: Multi-theme syntax highlighting
- **OpenAPI Integration**: Automatic API documentation generation

#### Interactive Elements

- **OpenZeppelin Wizard**: Embedded contract generation tool
- **Code Examples**: Copy-to-clipboard functionality
- **Version Switching**: Multi-version documentation support
Expand Down Expand Up @@ -178,8 +185,6 @@ node scripts/generate-api-docs.js \
--examples-output examples
```

This wil lexport the contents to

### Automated Setup

In the case you want to setup an automated GitHub workflow to create these API docs visit the [docs-api-generation-workflows](https://github.com/OpenZeppelin/docs-api-generation-workflows) for more info. This repo (`OpenZeppelin/docs`) is the `Docs Receiver` side of the equation.
Expand Down
243 changes: 3 additions & 240 deletions content/relayer/1.1.x/changelog.mdx

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions content/relayer/1.2.x/api/callPlugin.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Execute a plugin and receive the sanitized result
full: true
_openapi:
method: POST
route: /api/v1/plugins/{plugin_id}/call
toc: []
structuredData:
headings: []
contents:
- content: >-
Logs and traces are only returned when the plugin is configured with
`emit_logs` / `emit_traces`.

Plugin-provided errors are normalized into a consistent payload
(`code`, `details`) and a derived

message so downstream clients receive a stable shape regardless of how
the handler threw.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`.
Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived
message so downstream clients receive a stable shape regardless of how the handler threw.

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"post"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/cancelTransaction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Cancels a specific transaction by its ID.
full: true
_openapi:
method: DELETE
route: /api/v1/relayers/{relayer_id}/transactions/{transaction_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/{transaction_id}","method":"delete"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/createNotification.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Creates a new notification.
full: true
_openapi:
method: POST
route: /api/v1/notifications
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/notifications","method":"post"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/createRelayer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Creates a new relayer.
full: true
_openapi:
method: POST
route: /api/v1/relayers
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers","method":"post"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/createSigner.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Creates a new signer.
full: true
_openapi:
method: POST
route: /api/v1/signers
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/signers","method":"post"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/deleteNotification.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Deletes a notification by ID.
full: true
_openapi:
method: DELETE
route: /api/v1/notifications/{notification_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"delete"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/deletePendingTransactions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Deletes all pending transactions for a specific relayer.
full: true
_openapi:
method: DELETE
route: /api/v1/relayers/{relayer_id}/transactions/pending
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/pending","method":"delete"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/deleteRelayer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Deletes a relayer by ID.
full: true
_openapi:
method: DELETE
route: /api/v1/relayers/{relayer_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}","method":"delete"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/deleteSigner.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Deletes a signer by ID.
full: true
_openapi:
method: DELETE
route: /api/v1/signers/{signer_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/signers/{signer_id}","method":"delete"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getNotification.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Retrieves details of a specific notification by ID.
full: true
_openapi:
method: GET
route: /api/v1/notifications/{notification_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"get"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getRelayer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Retrieves details of a specific relayer by ID.
full: true
_openapi:
method: GET
route: /api/v1/relayers/{relayer_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}","method":"get"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getRelayerBalance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Retrieves the balance of a specific relayer.
full: true
_openapi:
method: GET
route: /api/v1/relayers/{relayer_id}/balance
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/balance","method":"get"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getRelayerStatus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Fetches the current status of a specific relayer.
full: true
_openapi:
method: GET
route: /api/v1/relayers/{relayer_id}/status
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/status","method":"get"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getSigner.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Retrieves details of a specific signer by ID.
full: true
_openapi:
method: GET
route: /api/v1/signers/{signer_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/signers/{signer_id}","method":"get"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getTransactionById.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Retrieves a specific transaction by its ID.
full: true
_openapi:
method: GET
route: /api/v1/relayers/{relayer_id}/transactions/{transaction_id}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/{transaction_id}","method":"get"}]} webhooks={[]} hasHead={false} />
15 changes: 15 additions & 0 deletions content/relayer/1.2.x/api/getTransactionByNonce.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Retrieves a transaction by its nonce value.
full: true
_openapi:
method: GET
route: /api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce}
toc: []
structuredData:
headings: []
contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce}","method":"get"}]} webhooks={[]} hasHead={false} />
29 changes: 29 additions & 0 deletions content/relayer/1.2.x/api/health.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Health routes implementation
full: true
_openapi:
method: GET
route: /v1/health
toc: []
structuredData:
headings: []
contents:
- content: >-
Note: OpenAPI documentation for these endpoints can be found in the
`openapi.rs` file

Handles the `/health` endpoint.


Returns an `HttpResponse` with a status of `200 OK` and a body of
`"OK"`.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file
Handles the `/health` endpoint.

Returns an `HttpResponse` with a status of `200 OK` and a body of `"OK"`.

<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.2.0/openapi.json"} operations={[{"path":"/v1/health","method":"get"}]} webhooks={[]} hasHead={false} />
Loading