You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/index.adoc
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,15 @@
3
3
= OpenZeppelin Relayer
4
4
:description: User guide for setting up and configuring OpenZeppelin Relayer.
5
5
6
+
== Overview
7
+
6
8
CAUTION: This software is in alpha stage. Use in production environments at your own risk.
7
9
8
10
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.
9
11
10
-
**Features**
12
+
13
+
== Features
14
+
11
15
- **Multi-Chain Support**: Interact with multiple blockchain networks, including Solana and EVM-based chains.
12
16
- **Transaction Relaying**: Submit transactions to supported blockchain networks efficiently.
13
17
- **Transaction Signing**: Securely sign transactions using configurable key management.
@@ -21,7 +25,8 @@ OpenZeppelin Relayer is a service that provides infrastructure to relay transact
21
25
- **Metrics and Observability**: Monitor application performance using Prometheus and Grafana.
22
26
- **Docker Support**: Deploy the relayer using Docker for both development and production environments.
23
27
24
-
**Supported Networks**
28
+
29
+
== Supported Networks
25
30
26
31
- Solana
27
32
- EVM (Basic support for Ethereum and other EVM-compatible chains):
@@ -42,6 +47,7 @@ To get started immediately, see xref:quickstart.adoc[Quickstart].
42
47
43
48
== Technical Overview
44
49
50
+
45
51
[mermaid,width=100%]
46
52
....
47
53
%%{init: {
@@ -606,6 +612,7 @@ Available configuration fields
606
612
==== 2. Notifications
607
613
608
614
* `notifications` array, which should contain, at least, one valid configuration:
615
+
609
616
[source,json]
610
617
----
611
618
"notifications": [
@@ -649,6 +656,7 @@ Available configuration fields
649
656
==== 3. Relayers
650
657
651
658
* `relayers` array, containing at least one valid relayer configuration:
659
+
652
660
[source,json]
653
661
----
654
662
"relayers": [
@@ -815,7 +823,8 @@ Policies
815
823
816
824
Full `config/config.json` example with evm and solana relayers definitions using keystore signer:
817
825
818
-
```json
826
+
[source,json]
827
+
----
819
828
{
820
829
"relayers": [
821
830
{
@@ -882,6 +891,7 @@ Full `config/config.json` example with evm and solana relayers definitions using
0 commit comments