Skip to content

Commit

Permalink
v4.2.1; readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
dmosites committed Feb 9, 2024
1 parent be221df commit ee036c7
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 82 deletions.
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v12.22.1
v18.19.0
114 changes: 34 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,58 +36,12 @@ Import the newly generated or an existing private key
$ airswap account:import
```

# Explore the Network

Set the active chain ([ChainIds](https://github.com/airswap/airswap-protocols/blob/8ddcacf9ab7b9b5778e5003c56564e7ae55afc9c/tools/constants/index.ts#L28))
Set the active chain

```
$ airswap chain
```

Get URLs for active servers

```
$ airswap registry:get
```

Get a quote from a specific peer

```
$ airswap rfq:get
```

Get the best quote from all peers

```
$ airswap rfq:best
```

# Balance Management

Get balances for known tokens

```
$ airswap balances
```

Transfer a balance to another account

```
$ airswap token:transfer
```

Deposit a native balance (e.g. ETH) into wrapped (e.g. WETH)

```
$ airswap wrapped:deposit
```

Withdraw a native balance from wrapped

```
$ airswap wrapped:withdraw
```

# All Commands

<!-- commands -->
Expand Down Expand Up @@ -138,7 +92,7 @@ DESCRIPTION
delete the current ethereum account
```

_See code: [src/commands/account/delete.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/account/delete.ts)_
_See code: [src/commands/account/delete.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/account/delete.ts)_

## `airswap account:export`

Expand All @@ -152,7 +106,7 @@ DESCRIPTION
export the current ethereum account
```

_See code: [src/commands/account/export.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/account/export.ts)_
_See code: [src/commands/account/export.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/account/export.ts)_

## `airswap account:generate`

Expand All @@ -166,7 +120,7 @@ DESCRIPTION
generate a new ethereum account
```

_See code: [src/commands/account/generate.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/account/generate.ts)_
_See code: [src/commands/account/generate.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/account/generate.ts)_

## `airswap account:import`

Expand All @@ -180,7 +134,7 @@ DESCRIPTION
import an ethereum account
```

_See code: [src/commands/account/import.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/account/import.ts)_
_See code: [src/commands/account/import.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/account/import.ts)_

## `airswap approve`

Expand All @@ -194,7 +148,7 @@ DESCRIPTION
approve a token for trading
```

_See code: [src/commands/approve.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/approve.ts)_
_See code: [src/commands/approve.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/approve.ts)_

## `airswap balances`

Expand All @@ -208,7 +162,7 @@ DESCRIPTION
display token balances
```

_See code: [src/commands/balances.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/balances.ts)_
_See code: [src/commands/balances.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/balances.ts)_

## `airswap best`

Expand All @@ -222,7 +176,7 @@ DESCRIPTION
compare order pricing from servers
```

_See code: [src/commands/best.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/best.ts)_
_See code: [src/commands/best.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/best.ts)_

## `airswap chain`

Expand All @@ -236,7 +190,7 @@ DESCRIPTION
set the active chain
```

_See code: [src/commands/chain.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/chain.ts)_
_See code: [src/commands/chain.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/chain.ts)_

## `airswap gas`

Expand All @@ -250,7 +204,7 @@ DESCRIPTION
set gas price for transactions
```

_See code: [src/commands/gas.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/gas.ts)_
_See code: [src/commands/gas.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/gas.ts)_

## `airswap help [COMMANDS]`

Expand Down Expand Up @@ -284,7 +238,7 @@ DESCRIPTION
inspect protocols for a server
```

_See code: [src/commands/inspect.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/inspect.ts)_
_See code: [src/commands/inspect.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/inspect.ts)_

## `airswap ip`

Expand All @@ -298,7 +252,7 @@ DESCRIPTION
display local network addresses
```

_See code: [src/commands/ip.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/ip.ts)_
_See code: [src/commands/ip.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/ip.ts)_

## `airswap metadata:add`

Expand All @@ -312,7 +266,7 @@ DESCRIPTION
add token to local metadata
```

_See code: [src/commands/metadata/add.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/metadata/add.ts)_
_See code: [src/commands/metadata/add.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/metadata/add.ts)_

## `airswap metadata:delete`

Expand All @@ -326,7 +280,7 @@ DESCRIPTION
delete token from local metadata
```

_See code: [src/commands/metadata/delete.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/metadata/delete.ts)_
_See code: [src/commands/metadata/delete.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/metadata/delete.ts)_

## `airswap metadata:lookup`

Expand All @@ -340,7 +294,7 @@ DESCRIPTION
lookup token in local metadata
```

_See code: [src/commands/metadata/lookup.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/metadata/lookup.ts)_
_See code: [src/commands/metadata/lookup.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/metadata/lookup.ts)_

## `airswap metadata:update`

Expand All @@ -354,7 +308,7 @@ DESCRIPTION
update local metadata from remote sources
```

_See code: [src/commands/metadata/update.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/metadata/update.ts)_
_See code: [src/commands/metadata/update.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/metadata/update.ts)_

## `airswap order`

Expand All @@ -368,7 +322,7 @@ DESCRIPTION
get an order from a server
```

_See code: [src/commands/order.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/order.ts)_
_See code: [src/commands/order.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/order.ts)_

## `airswap protocols:add`

Expand All @@ -382,7 +336,7 @@ DESCRIPTION
add supported protocols to the registry
```

_See code: [src/commands/protocols/add.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/protocols/add.ts)_
_See code: [src/commands/protocols/add.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/protocols/add.ts)_

## `airswap protocols:list`

Expand All @@ -396,7 +350,7 @@ DESCRIPTION
list activated protocols
```

_See code: [src/commands/protocols/list.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/protocols/list.ts)_
_See code: [src/commands/protocols/list.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/protocols/list.ts)_

## `airswap protocols:remove`

Expand All @@ -410,7 +364,7 @@ DESCRIPTION
remove supported protocols from the registry
```

_See code: [src/commands/protocols/remove.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/protocols/remove.ts)_
_See code: [src/commands/protocols/remove.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/protocols/remove.ts)_

## `airswap registry:approve`

Expand All @@ -424,7 +378,7 @@ DESCRIPTION
enable staking on the registry
```

_See code: [src/commands/registry/approve.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/registry/approve.ts)_
_See code: [src/commands/registry/approve.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/registry/approve.ts)_

## `airswap registry:eject`

Expand All @@ -438,7 +392,7 @@ DESCRIPTION
remove url, protocols, and tokens from registry
```

_See code: [src/commands/registry/eject.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/registry/eject.ts)_
_See code: [src/commands/registry/eject.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/registry/eject.ts)_

## `airswap registry:list`

Expand All @@ -452,7 +406,7 @@ DESCRIPTION
get urls from the registry
```

_See code: [src/commands/registry/list.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/registry/list.ts)_
_See code: [src/commands/registry/list.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/registry/list.ts)_

## `airswap registry:revoke`

Expand All @@ -466,7 +420,7 @@ DESCRIPTION
disable staking on the registry
```

_See code: [src/commands/registry/revoke.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/registry/revoke.ts)_
_See code: [src/commands/registry/revoke.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/registry/revoke.ts)_

## `airswap registry:status`

Expand All @@ -480,7 +434,7 @@ DESCRIPTION
check status of url, protocols, and tokens on registry
```

_See code: [src/commands/registry/status.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/registry/status.ts)_
_See code: [src/commands/registry/status.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/registry/status.ts)_

## `airswap registry:url`

Expand All @@ -494,7 +448,7 @@ DESCRIPTION
set server url on the registry
```

_See code: [src/commands/registry/url.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/registry/url.ts)_
_See code: [src/commands/registry/url.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/registry/url.ts)_

## `airswap revoke`

Expand All @@ -508,7 +462,7 @@ DESCRIPTION
revoke a token approval
```

_See code: [src/commands/revoke.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/revoke.ts)_
_See code: [src/commands/revoke.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/revoke.ts)_

## `airswap stream`

Expand All @@ -522,7 +476,7 @@ DESCRIPTION
stream quotes for a swap
```

_See code: [src/commands/stream.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/stream.ts)_
_See code: [src/commands/stream.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/stream.ts)_

## `airswap tokens:add`

Expand All @@ -536,7 +490,7 @@ DESCRIPTION
add supported tokens to the registry
```

_See code: [src/commands/tokens/add.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/tokens/add.ts)_
_See code: [src/commands/tokens/add.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/tokens/add.ts)_

## `airswap tokens:list`

Expand All @@ -550,7 +504,7 @@ DESCRIPTION
list activated tokens
```

_See code: [src/commands/tokens/list.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/tokens/list.ts)_
_See code: [src/commands/tokens/list.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/tokens/list.ts)_

## `airswap tokens:remove`

Expand All @@ -564,7 +518,7 @@ DESCRIPTION
remove supported tokens from the registry
```

_See code: [src/commands/tokens/remove.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/tokens/remove.ts)_
_See code: [src/commands/tokens/remove.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/tokens/remove.ts)_

## `airswap transfer`

Expand All @@ -578,7 +532,7 @@ DESCRIPTION
transfer tokens to another account
```

_See code: [src/commands/transfer.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/transfer.ts)_
_See code: [src/commands/transfer.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/transfer.ts)_

## `airswap wrapped:deposit`

Expand All @@ -592,7 +546,7 @@ DESCRIPTION
deposit eth to weth
```

_See code: [src/commands/wrapped/deposit.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/wrapped/deposit.ts)_
_See code: [src/commands/wrapped/deposit.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/wrapped/deposit.ts)_

## `airswap wrapped:withdraw`

Expand All @@ -606,5 +560,5 @@ DESCRIPTION
withdraw eth from weth
```

_See code: [src/commands/wrapped/withdraw.ts](https://github.com/airswap/airswap-cli/blob/v4.2.0/src/commands/wrapped/withdraw.ts)_
_See code: [src/commands/wrapped/withdraw.ts](https://github.com/airswap/airswap-cli/blob/v4.2.1/src/commands/wrapped/withdraw.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "airswap",
"description": "Command Line Interface (CLI) for the AirSwap Network",
"version": "4.2.0",
"version": "4.2.1",
"license": "MIT",
"repository": {
"type": "git",
Expand Down

0 comments on commit ee036c7

Please sign in to comment.