`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/) 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:
``sh npx airnode-admin --help`To see the parameters of a command:`sh npx airnode-admin $COMMAND --help`

`Requester commands`

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`Provider commands`

`$3`

Creates a provider and returns a provider ID.

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`airnode-admin`

> A CLI to interact with the Airnode contracts

To see all commands:
``sh npx airnode-admin --help`To see the parameters of a command:`sh npx airnode-admin $COMMAND --help`

`Requester commands`

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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

`Provider commands`

`$3`

Creates a provider and returns a provider ID.

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

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

`$3`

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

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

`$3`

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

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

`$3`

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

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