airswap
TypeScript icon, indicating that this package has built-in type declarations

4.3.1 • Public • Published

AirSwap CLI

Command Line Interface (CLI) for the AirSwap Network

Version License Downloads/week Discord Twitter Follow

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

Set the active chain

$ airswap chain

All Commands

airswap account:delete

delete the current ethereum account

USAGE
  $ airswap account:delete

DESCRIPTION
  delete the current ethereum account

See code: src/commands/account/delete.ts

airswap account:export

export the current ethereum account

USAGE
  $ airswap account:export

DESCRIPTION
  export the current ethereum account

See code: src/commands/account/export.ts

airswap account:generate

generate a new ethereum account

USAGE
  $ airswap account:generate

DESCRIPTION
  generate a new ethereum account

See code: src/commands/account/generate.ts

airswap account:import

import an ethereum account

USAGE
  $ airswap account:import

DESCRIPTION
  import an ethereum account

See code: src/commands/account/import.ts

airswap approve

approve a token for trading

USAGE
  $ airswap approve

DESCRIPTION
  approve a token for trading

See code: src/commands/approve.ts

airswap balances

display token balances

USAGE
  $ airswap balances

DESCRIPTION
  display token balances

See code: src/commands/balances.ts

airswap best

compare order pricing from servers

USAGE
  $ airswap best

DESCRIPTION
  compare order pricing from servers

See code: src/commands/best.ts

airswap chain

set the active chain

USAGE
  $ airswap chain

DESCRIPTION
  set the active chain

See code: src/commands/chain.ts

airswap gas

set gas price for transactions

USAGE
  $ airswap gas

DESCRIPTION
  set gas price for transactions

See code: src/commands/gas.ts

airswap help [COMMANDS]

Display help for airswap.

USAGE
  $ airswap help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for airswap.

See code: @oclif/plugin-help

airswap inspect

inspect protocols for a server

USAGE
  $ airswap inspect

DESCRIPTION
  inspect protocols for a server

See code: src/commands/inspect.ts

airswap ip

display local network addresses

USAGE
  $ airswap ip

DESCRIPTION
  display local network addresses

See code: src/commands/ip.ts

airswap metadata:add

add token to local metadata

USAGE
  $ airswap metadata:add

DESCRIPTION
  add token to local metadata

See code: src/commands/metadata/add.ts

airswap metadata:delete

delete token from local metadata

USAGE
  $ airswap metadata:delete

DESCRIPTION
  delete token from local metadata

See code: src/commands/metadata/delete.ts

airswap metadata:lookup

lookup token in local metadata

USAGE
  $ airswap metadata:lookup

DESCRIPTION
  lookup token in local metadata

See code: src/commands/metadata/lookup.ts

airswap metadata:update

update local metadata from remote sources

USAGE
  $ airswap metadata:update

DESCRIPTION
  update local metadata from remote sources

See code: src/commands/metadata/update.ts

airswap order

get an order from a server

USAGE
  $ airswap order

DESCRIPTION
  get an order from a server

See code: src/commands/order.ts

airswap protocols:add

add supported protocols to the registry

USAGE
  $ airswap protocols:add

DESCRIPTION
  add supported protocols to the registry

See code: src/commands/protocols/add.ts

airswap protocols:list

list activated protocols

USAGE
  $ airswap protocols:list

DESCRIPTION
  list activated protocols

See code: src/commands/protocols/list.ts

airswap protocols:remove

remove supported protocols from the registry

USAGE
  $ airswap protocols:remove

DESCRIPTION
  remove supported protocols from the registry

See code: src/commands/protocols/remove.ts

airswap registry:approve

enable staking on the registry

USAGE
  $ airswap registry:approve

DESCRIPTION
  enable staking on the registry

See code: src/commands/registry/approve.ts

airswap registry:eject

remove url, protocols, and tokens from registry

USAGE
  $ airswap registry:eject

DESCRIPTION
  remove url, protocols, and tokens from registry

See code: src/commands/registry/eject.ts

airswap registry:list

get urls from the registry

USAGE
  $ airswap registry:list

DESCRIPTION
  get urls from the registry

See code: src/commands/registry/list.ts

airswap registry:revoke

disable staking on the registry

USAGE
  $ airswap registry:revoke

DESCRIPTION
  disable staking on the registry

See code: src/commands/registry/revoke.ts

airswap registry:status

check status of url, protocols, and tokens on registry

USAGE
  $ airswap registry:status

DESCRIPTION
  check status of url, protocols, and tokens on registry

See code: src/commands/registry/status.ts

airswap registry:url

set server url on the registry

USAGE
  $ airswap registry:url

DESCRIPTION
  set server url on the registry

See code: src/commands/registry/url.ts

airswap revoke

revoke a token approval

USAGE
  $ airswap revoke

DESCRIPTION
  revoke a token approval

See code: src/commands/revoke.ts

airswap stream

stream quotes for a swap

USAGE
  $ airswap stream

DESCRIPTION
  stream quotes for a swap

See code: src/commands/stream.ts

airswap tokens:add

add supported tokens to the registry

USAGE
  $ airswap tokens:add

DESCRIPTION
  add supported tokens to the registry

See code: src/commands/tokens/add.ts

airswap tokens:list

list activated tokens

USAGE
  $ airswap tokens:list

DESCRIPTION
  list activated tokens

See code: src/commands/tokens/list.ts

airswap tokens:remove

remove supported tokens from the registry

USAGE
  $ airswap tokens:remove

DESCRIPTION
  remove supported tokens from the registry

See code: src/commands/tokens/remove.ts

airswap transfer

transfer tokens to another account

USAGE
  $ airswap transfer

DESCRIPTION
  transfer tokens to another account

See code: src/commands/transfer.ts

airswap wrapped:deposit

deposit eth to weth

USAGE
  $ airswap wrapped:deposit

DESCRIPTION
  deposit eth to weth

See code: src/commands/wrapped/deposit.ts

airswap wrapped:withdraw

withdraw eth from weth

USAGE
  $ airswap wrapped:withdraw

DESCRIPTION
  withdraw eth from weth

See code: src/commands/wrapped/withdraw.ts

Readme

Keywords

Package Sidebar

Install

npm i airswap

Weekly Downloads

18

Version

4.3.1

License

MIT

Unpacked Size

292 kB

Total Files

135

Last publish

Collaborators

  • airswap
  • dmosites