airnode-admin

airnode-admin

A CLI to interact with the Airnode contracts

All commands require you to either provide a providerUrl (e.g., https://ropsten.infura.io/v3/<KEY>) or a chain (e.g., ropsten). Using chain will use the default ethers.js provider, which may rate-limit you.

Commands that require mnemonic will make an on-chain transaction. Make sure that the wallet that is associated with the mnemonic is funded. The application will not exit until the transaction is confirmed.

To see all commands:

npx airnode-admin --help

To see the parameters of a command:

npx airnode-admin $COMMAND --help

Requester commands

create-requester

Creates a requester and returns a requester index. Note down your requester index because you will be using it in future interactions.

npx airnode-admin create-requester \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --requesterAdmin 0x5c17cb...

update-requester-admin

Updates the requester admin. The mnemonic you provide here has to belong to the previous requester admin.

npx airnode-admin update-requester-admin \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --requesterIndex 6 \
  --requesterAdmin 0xe97301...

derive-designated-wallet

Derives the address of the wallet designated by a provider for a requester.

npx airnode-admin derive-designated-wallet \
  --chain ropsten \
  --providerId 0xe1e0dd... \
  --requesterIndex 6

endorse-client

Endorses a client contract so that its requests can be fulfilled by the requester's designated wallet. The mnemonic you provide here has to belong to the requester admin.

npx airnode-admin endorse-client \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --requesterIndex 6 \
  --clientAddress 0x2c2e12...

unendorse-client

Unendorses a client contract so that its requests can no longer be fulfilled by the requester's designated wallet. The mnemonic you provide here has to belong to the requester admin.

npx airnode-admin unendorse-client \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --requesterIndex 6 \
  --clientAddress 0x2c2e12...

create-template

Reads a file, uses its contents to create a template and returns the template ID. See the /example directory for an example template file.

npx airnode-admin create-template \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --templateFilePath ./template.json

request-withdrawal

Requests a withdrawal from the wallet designated by a provider for a requester, and returns the request ID. The mnemonic you provide here has to belong to the requester admin.

npx airnode-admin request-withdrawal \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --providerId 0xe1e0dd... \
  --requesterIndex 6 \
  --destination 0x98aaba...

check-withdrawal-request

Checks the status of the withdrawal request with the given ID.

npx airnode-admin check-withdrawal-request \
  --chain ropsten \
  --withdrawalRequestId 0x011d1b...

Provider commands

create-provider

Creates a provider and returns a provider ID.

You probably should not be using this. Airnode will create your provider during deployment.

npx airnode-admin create-provider \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --providerAdmin 0xc2193d...

update-provider-admin

Updates the provider admin. The mnemonic you provide here has to belong to the previous provider admin.

npx airnode-admin update-provider-admin \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --providerId 0xe1e0dd... \
  --providerAdmin 0x60558a...

derive-endpoint-id

Derives the endpoint ID using the OIS title and the endpoint name using the convention described here.

npx airnode-admin derive-endpoint-id \
  --oisTitle "My OIS title..." \
  --endpointName "My endpoint name..."

update-authorizers

Updates the authorizers of an endpoint belonging to a provider. The mnemonic you provide here has to belong to the provider admin. See the /example directory for an example authorizers file.

npx airnode-admin update-authorizers \
  --chain ropsten \
  --mnemonic "nature about salad..." \
  --providerId 0xe1e0dd... \
  --endpointId 0x260558... \
  --authorizersFilePath ./authorizers.json