From bb8dfe976fe463c717429098f8b29176bd674170 Mon Sep 17 00:00:00 2001 From: cam-schultz Date: Tue, 6 Feb 2024 19:05:57 +0000 Subject: [PATCH 1/2] requirements in readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 988a4a37..f701b7ab 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,23 @@ Reference relayer implementation for cross-chain Avalanche Warp Message delivery. +## Requirements +### System Requirements +- Ubuntu 22.04 or later + - Tested on x86_64/amd64 architecture. +- MacOS 14.3 or later + - Tested on arm64 architecture (Apple silicon). + +### API Requirements +- AWM Relayer requires access to Avalanche API nodes for the P-Chain as well as any connected subnets. The API nodes must have the following methods enabled: + - Each csubnet API node must have enabled: + - eth API (RPC and WS) + - The P-Chain API node must have enabled: + - info.peers + - platform.getHeight + - platform.validatedBy + - platform.getValidatorsAt OR platform.getCurrentValidators + ## Usage ### Building From 511c3424b2efe0e2ce8689b59a0886e41ac1e861 Mon Sep 17 00:00:00 2001 From: cam-schultz <78878559+cam-schultz@users.noreply.github.com> Date: Thu, 8 Feb 2024 09:59:20 -0600 Subject: [PATCH 2/2] Update README.md Co-authored-by: Michael Kaplan <55204436+michaelkaplan13@users.noreply.github.com> Signed-off-by: cam-schultz <78878559+cam-schultz@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f701b7ab..314036f5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Reference relayer implementation for cross-chain Avalanche Warp Message delivery ### API Requirements - AWM Relayer requires access to Avalanche API nodes for the P-Chain as well as any connected subnets. The API nodes must have the following methods enabled: - - Each csubnet API node must have enabled: + - Each subnet API node must have enabled: - eth API (RPC and WS) - The P-Chain API node must have enabled: - info.peers