README
AirSwap CLI
Command Line Interface (CLI) for the AirSwap Network
- About → https://about.airswap.io/
- Website → https://www.airswap.io/
- Blog → https://blog.airswap.io/
Key Management
AirSwap CLI uses the native password manager of your system. On macOS, keys are managed by the Keychain, on Linux they are managed by the Secret Service API/libsecret, and on Windows they are managed by Credential Vault.
Quick Start
Install the CLI globally
$ yarn global add airswap
Create a new account to use for the CLI (recommended)
$ airswap account:generate
Import the newly generated or an existing private key
$ airswap account:import
Explore the Network
Set the active Ethereum chain
$ airswap chain
Get URLs for active servers
$ airswap registry:list
Get a quote from a specific peer
$ airswap quote:get
Get the best quote from all peers
$ airswap quote:best
Balance Management
Get balances for known tokens
$ airswap balances
Transfer a balance to another account
$ airswap token:transfer
Deposit an ETH balance to WETH
$ airswap weth:deposit
Withdraw an ETH balance from WETH
$ airswap weth:withdraw
Rinkeby Resources
- ETH to pay for transactions - Faucet
- WETH for trading -
0xc778417e063141139fce010982780140aa0cd5ab
Etherscan - DAI for trading -
0x5592ec0cfb4dbc12d3ab100b257153436a1f0fea
Etherscan - AST for staking -
0xcc1cbd4f67cceb7c001bd4adf98451237a193ff8
Etherscan / Faucet
All Commands
airswap account:delete
airswap account:export
airswap account:generate
airswap account:import
airswap balances
airswap chain
airswap gas
airswap help [COMMAND]
airswap ip
airswap metadata:add
airswap metadata:delete
airswap metadata:lookup
airswap metadata:update
airswap order:best
airswap order:get
airswap quote:best
airswap quote:get
airswap quote:max
airswap quote:stream
airswap registry:add
airswap registry:enable
airswap registry:get
airswap registry:list
airswap registry:remove
airswap registry:url
airswap token:approve
airswap token:transfer
airswap weth:deposit
airswap weth:withdraw
airswap account:delete
delete the current ethereum account
delete the current ethereum account
USAGE
$ airswap account:delete
See code: src/commands/account/delete.ts
airswap account:export
export the current ethereum account
export the current ethereum account
USAGE
$ airswap account:export
See code: src/commands/account/export.ts
airswap account:generate
generate a new ethereum account
generate a new ethereum account
USAGE
$ airswap account:generate
See code: src/commands/account/generate.ts
airswap account:import
import an ethereum account
import an ethereum account
USAGE
$ airswap account:import
See code: src/commands/account/import.ts
airswap balances
display token balances
display token balances
USAGE
$ airswap balances
See code: src/commands/balances.ts
airswap chain
set the active ethereum chain
set the active ethereum chain
USAGE
$ airswap chain
See code: src/commands/chain.ts
airswap gas
set gas price for transactions
set gas price for transactions
USAGE
$ airswap gas
See code: src/commands/gas.ts
airswap help [COMMAND]
display help for airswap
display help for <%= config.bin %>
USAGE
$ airswap help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
airswap ip
display local network addresses
display local network addresses
USAGE
$ airswap ip
See code: src/commands/ip.ts
airswap metadata:add
add token to local metadata
add token to local metadata
USAGE
$ airswap metadata:add
See code: src/commands/metadata/add.ts
airswap metadata:delete
delete token from local metadata
delete token from local metadata
USAGE
$ airswap metadata:delete
See code: src/commands/metadata/delete.ts
airswap metadata:lookup
lookup token in local metadata
lookup token in local metadata
USAGE
$ airswap metadata:lookup
See code: src/commands/metadata/lookup.ts
airswap metadata:update
update local metadata from remote sources
update local metadata from remote sources
USAGE
$ airswap metadata:update
See code: src/commands/metadata/update.ts
airswap order:best
get the best available order
get the best available order
USAGE
$ airswap order:best
See code: src/commands/order/best.ts
airswap order:get
get an order from a peer
get an order from a peer
USAGE
$ airswap order:get
See code: src/commands/order/get.ts
airswap quote:best
get the best available quote
get the best available quote
USAGE
$ airswap quote:best
See code: src/commands/quote/best.ts
airswap quote:get
get a quote from a peer
get a quote from a peer
USAGE
$ airswap quote:get
See code: src/commands/quote/get.ts
airswap quote:max
get a max quote from a peer
get a max quote from a peer
USAGE
$ airswap quote:max
See code: src/commands/quote/max.ts
airswap quote:stream
stream quotes for a swap
stream quotes for a swap
USAGE
$ airswap quote:stream
See code: src/commands/quote/stream.ts
airswap registry:add
add supported tokens to the registry
add supported tokens to the registry
USAGE
$ airswap registry:add
See code: src/commands/registry/add.ts
airswap registry:enable
enable staking on the registry
enable staking on the registry
USAGE
$ airswap registry:enable
See code: src/commands/registry/enable.ts
airswap registry:get
get urls from the registry
get urls from the registry
USAGE
$ airswap registry:get
See code: src/commands/registry/get.ts
airswap registry:list
list supported tokens from registry
list supported tokens from registry
USAGE
$ airswap registry:list
See code: src/commands/registry/list.ts
airswap registry:remove
remove supported tokens from the registry
remove supported tokens from the registry
USAGE
$ airswap registry:remove
See code: src/commands/registry/remove.ts
airswap registry:url
set server url on the registry
set server url on the registry
USAGE
$ airswap registry:url
See code: src/commands/registry/url.ts
airswap token:approve
approve a token for trading
approve a token for trading
USAGE
$ airswap token:approve
See code: src/commands/token/approve.ts
airswap token:transfer
transfer tokens to another account
transfer tokens to another account
USAGE
$ airswap token:transfer
See code: src/commands/token/transfer.ts
airswap weth:deposit
deposit eth to weth
deposit eth to weth
USAGE
$ airswap weth:deposit
See code: src/commands/weth/deposit.ts
airswap weth:withdraw
withdraw eth from weth
withdraw eth from weth
USAGE
$ airswap weth:withdraw
See code: src/commands/weth/withdraw.ts