denote api methods in readme

ava-labs · Oct 25, 2023 · 6c8a869 · 6c8a869
1 parent c05368e
commit 6c8a869
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -36,7 +36,11 @@ The relayer is configured via a JSON file, the path to which is passed in via th
 - The ID of the Avalanche network to which the relayer will connect. Defaults to `1` (Mainnet).
 
 `"p-chain-api-url": string`
-- The URL of the Avalanche P-Chain API node to which the relayer will connect.
+- The URL of the Avalanche P-Chain API node to which the relayer will connect. This API node needs to have the following methods enabled:
+  - info.peers
+  - platform.getHeight
+  - platform.validatedBy
+  - platform.getValidatorsAt
 
 `"encrypt-connection": boolean`
 - Whether or not to encrypt the connection to the P-Chain API node. Defaults to `true`.