Skip to content

chore: plat-7575 Docs fixes (#153) #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tirumerla merged 1 commit into from
Apr 7, 2025
Merged

chore: plat-7575 Docs fixes (#153) #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion docs/modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
* xref:quickstart.adoc[Quickstart]
* xref:api_reference.adoc[API Reference]
* xref:structure.adoc[Project Structure]
* link:rust_docs/doc/openzeppelin_relayer/index.html[Technical Rust Documentation]
* xref:roadmap.adoc[Project Roadmap]
16 changes: 13 additions & 3 deletions docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
= OpenZeppelin Relayer
:description: User guide for setting up and configuring OpenZeppelin Relayer.

== Overview

CAUTION: This software is in alpha stage. Use in production environments at your own risk.

OpenZeppelin Relayer is a service that provides infrastructure to relay transactions to the EVM & Non-EVM networks. It is designed to be used as a backend for dApps that need to interact with these networks.

**Features**

== Features

- **Multi-Chain Support**: Interact with multiple blockchain networks, including Solana and EVM-based chains.
- **Transaction Relaying**: Submit transactions to supported blockchain networks efficiently.
- **Transaction Signing**: Securely sign transactions using configurable key management.
Expand All @@ -21,7 +25,8 @@ OpenZeppelin Relayer is a service that provides infrastructure to relay transact
- **Metrics and Observability**: Monitor application performance using Prometheus and Grafana.
- **Docker Support**: Deploy the relayer using Docker for both development and production environments.

**Supported Networks**

== Supported Networks

- Solana
- EVM (Basic support for Ethereum and other EVM-compatible chains):
Expand All @@ -42,6 +47,7 @@ To get started immediately, see xref:quickstart.adoc[Quickstart].

== Technical Overview


[mermaid,width=100%]
....
%%{init: {
Expand Down Expand Up @@ -606,6 +612,7 @@ Available configuration fields
==== 2. Notifications

* `notifications` array, which should contain, at least, one valid configuration:

[source,json]
----
"notifications": [
Expand Down Expand Up @@ -649,6 +656,7 @@ Available configuration fields
==== 3. Relayers

* `relayers` array, containing at least one valid relayer configuration:

[source,json]
----
"relayers": [
Expand Down Expand Up @@ -815,7 +823,8 @@ Policies

Full `config/config.json` example with evm and solana relayers definitions using keystore signer:

```json
[source,json]
----
{
"relayers": [
{
Expand Down Expand Up @@ -882,6 +891,7 @@ Full `config/config.json` example with evm and solana relayers definitions using
]
}
```
----

=== RPC URL Configuration

Expand Down
Loading