Rainbow Bridge CLI

CLI to manage and verify the bridge between NEAR and Ethereum

• Rainbow Bridge CLI
• Usage
• Commands

Usage

$ npm install -g rainbow-bridge
$ bridge COMMAND
running command...
$ bridge (-v|--version|version)
rainbow-bridge/0.0.10 darwin-x64 node-v14.16.1
$ bridge --help [COMMAND]
USAGE
  $ bridge COMMAND
...

Commands

• bridge eth:deploy CONTRACTPATH
• bridge eth:keys:add PRIVATEKEY [NAME]
• bridge eth:keys:use IDENTIFIER
• bridge factory:metadata_emitter [ADDRESS]
• bridge factory:pause
• bridge factory:unpause
• bridge help [COMMAND]
• bridge list
• bridge monitor
• bridge tokens:list
• bridge tokens:metadata TOKENADDRESS
• bridge tokens:set_icon TOKENS
• bridge tokens:set_metadata TOKEN
• bridge tools:deploy-contracts TOKENS CONTRACT
• bridge tools:generate-config FILE
• bridge tools:migrate-icons TOKENS CONTRACT
• bridge use BRIDGE_ID

bridge eth:deploy CONTRACTPATH

Add Ethereum Key into the Key Store.

USAGE
  $ bridge eth deploy CONTRACTPATH

OPTIONS
  -h, --help  show CLI help

See code: src/commands/eth/deploy.ts

bridge eth:keys:add PRIVATEKEY [NAME]

Add Ethereum Key into the Key Store.

USAGE
  $ bridge eth keys add PRIVATEKEY [NAME]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/eth/keys/add.ts

bridge eth:keys:use IDENTIFIER

Add Ethereum Key into the Key Store.

USAGE
  $ bridge eth keys use IDENTIFIER

OPTIONS
  -h, --help  show CLI help

See code: src/commands/eth/keys/use.ts

bridge factory:metadata_emitter [ADDRESS]

Pause factory

USAGE
  $ bridge factory metadata_emitter [ADDRESS]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/factory/metadata_emitter.ts

bridge factory:pause

Pause factory

USAGE
  $ bridge factory pause

OPTIONS
  -d, --deposit  Pause deposits
  -h, --help     show CLI help
  -s, --status   Show the current paused status of the contract.
  -t, --deploy   Pause deploy token

See code: src/commands/factory/pause.ts

bridge factory:unpause

Unpause factory

USAGE
  $ bridge factory unpause

OPTIONS
  -d, --deposit  Pause deposits
  -h, --help     show CLI help
  -s, --status   Show the current paused status of the contract.
  -t, --deploy   Pause deploy token

See code: src/commands/factory/unpause.ts

bridge help [COMMAND]

display help for bridge

USAGE
  $ bridge help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bridge list

List all bridges available

USAGE
  $ bridge list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/list.ts

bridge monitor

Expose bridge information through prometheus metrics

USAGE
  $ bridge monitor

OPTIONS
  -h, --help  show CLI help
  -l, --list  List information tracked

See code: src/commands/monitor.ts

bridge tokens:list

List all tokens deployed

USAGE
  $ bridge tokens list

OPTIONS
  -e, --etherscan  link to etherscan
  -h, --help       show CLI help
  -n, --near       link to NEAR Explorer
  -r, --raw        raw token address

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

bridge tokens:metadata TOKENADDRESS

Check metadata from ERC20 tokens

USAGE
  $ bridge tokens metadata TOKENADDRESS

OPTIONS
  -e, --erc20  Show metadata from ERC20
  -h, --help   show CLI help

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

bridge tokens:set_icon TOKENS

Set icons of bridged ERC20 (NEP141) tokens. Pass the path to https://github.com/aurora-is-near/bridge-assets/tree/master/tokens on your local machine.

USAGE
  $ bridge tokens set_icon TOKENS

OPTIONS
  -h, --help  show CLI help

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

bridge tokens:set_metadata TOKEN

Set metadata of bridged ERC20 (NEP141) tokens

USAGE
  $ bridge tokens set_metadata TOKEN

OPTIONS
  -b, --bulk  Set metadata from file
  -h, --help  show CLI help

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

bridge tools:deploy-contracts TOKENS CONTRACT

Deploy contracts in batch

USAGE
  $ bridge tools deploy-contracts TOKENS CONTRACT

ARGUMENTS
  TOKENS    List with all tokens address. Generate using `bridge tokens list`
  CONTRACT  Binary contract path

OPTIONS
  -h, --help  show CLI help

See code: src/commands/tools/deploy-contracts.ts

bridge tools:generate-config FILE

Generate config/base.ts file from yml file automatically. This is used to have automatically fully typed config file.

USAGE
  $ bridge tools generate-config FILE

OPTIONS
  -h, --help  show CLI help

See code: src/commands/tools/generate-config.ts

bridge tools:migrate-icons TOKENS CONTRACT

Apply icon migration to all bridged tokens.

USAGE
  $ bridge tools migrate-icons TOKENS CONTRACT

ARGUMENTS
  TOKENS    List with all tokens address. Generate using `bridge tokens list`
  CONTRACT  New bridge token contract

OPTIONS
  -h, --help  show CLI help

See code: src/commands/tools/migrate-icons.ts

bridge use BRIDGE_ID

Select bridge to be used

USAGE
  $ bridge use BRIDGE_ID

OPTIONS
  -h, --help  show CLI help

See code: src/commands/use.ts