Skip to content

Commit

Permalink
Merge pull request #174 from ava-labs/readme-requirements
Browse files Browse the repository at this point in the history
Add system and API requirements to README
  • Loading branch information
cam-schultz authored Feb 9, 2024
2 parents c96d096 + 511c342 commit d235b12
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 subnet 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
Expand Down

0 comments on commit d235b12

Please sign in to comment.