Abyss CLI

A very simple CLI interface to interact with the Abyss protocol.

abyss <command> <options>

Commands and Options

start --rpc-url: Set RPC URL. --private-key: Set private key for transaction signing.

balance --token: Asset to get balance of, if not passed, defaults to $ABYSS on the chain. --address: Address to get balance.

generate-keys --secret-key: Set user defined secret key. --auto-gen: Auto generate secret key, overrides --secret-key. --amount: Amount to generate key for. --output-folder: Folder to write keys to.

swap --token: Asset to swap to $ABYSS. --amount: Amount to swap to $ABYSS. --receiver: Address to receive defaults to user.

redeem --token: Asset to swap $ABYSS to. --amount: Amount of $ABYSS to swap. --receiver: Address to receive defaults to user.

key-data --key: Key --from: JSON file, crated by generate-keys to read deposit keys from, overrides --keys.

deposit --deposit-keys: A space separated list of deposit keys. --from: JSON file, crated by generate-keys to read deposit keys from, overrides --deposit-keys.

withdraw --withdrawal-key: Withdrawal Key. --secret-key: Secret key linked with withdrawal key. --recipient: Address to receive $ABYSS. --amount: Amount to withdraw. --all: Amount to withdraw overrides --amount.

How to Use

Step 1: Install abyss-cli.

npm install -g abyss

Step 2: Start the tool.

abyss

All options are optionally passed. When one option is missing or all are missing, Abyss will prompt you to fill out the skipped options individually.