@sisou/albatross-remote (arpl)

Straight-forward remote management for Nimiq Albatross nodes

Usage
Options
Commands

Usage

$ npm install -g @sisou/albatross-remote
$ arpl COMMAND
running command...
$ arpl (-v|--version|version)
@sisou/albatross-remote/0.2.1 linux-x64 node-v14.16.0
$ arpl --help [COMMAND]
USAGE
  $ arpl COMMAND
...

Options

  -u, --url   The URL of the RPC server, overwrites host and port
              options (default: [http|ws]://localhost:8648[/ws])
  -h, --host  Hostname of the RPC server (default: localhost)
  -p, --port  Port of the RPC server (default: 8648)

Commands

arpl account:create
arpl account:get ADDRESS
arpl account:import PRIVATEKEY
arpl account:list
arpl account:lock ADDRESS
arpl account:unlock ADDRESS
arpl block:follow
arpl block:get [NUMBER_OR_HASH]
arpl help [COMMAND]
arpl raw COMMAND [OPTIONS]
arpl repl
arpl stake:list
arpl stake:move WALLET FROM_VALIDATOR_ID TO_VALIDATOR_ID VALUE
arpl stake:recover WALLET VALUE
arpl stake:restart WALLET VALIDATOR_ID VALUE
arpl stake:start WALLET VALIDATOR_ID VALUE
arpl stake:stop WALLET VALIDATOR_ID VALUE
arpl status
arpl transaction:get HASH
arpl transaction:send WALLET RECIPIENT VALUE
arpl validator:drop VALIDATOR_ID SECRET_KEY RECIPIENT VALUE
arpl validator:new WALLET SECRET_KEY VALUE
arpl validator:reactivate WALLET VALIDATOR_ID SECRET_KEY
arpl validator:retire WALLET VALIDATOR_ID SECRET_KEY
arpl validator:unpark WALLET VALIDATOR_ID SECRET_KEY
arpl validator:update WALLET VALIDATOR_ID SECRET_KEY

`arpl account:create`

Create a new account in the node

USAGE
  $ arpl account:create

OPTIONS
  --password=password  Password to encrypt the key
  --unlock             Unlock the account after creation

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

`arpl account:get ADDRESS`

Show account information

USAGE
  $ arpl account:get ADDRESS

ARGUMENTS
  ADDRESS  Address of the account to display

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

`arpl account:import PRIVATEKEY`

Import an account by its private key

USAGE
  $ arpl account:import PRIVATEKEY

ARGUMENTS
  PRIVATEKEY  Private key in HEX or Base64 format

OPTIONS
  --password=password  Password to encrypt the key
  --unlock             Unlock the account after import

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

`arpl account:list`

List accounts available in node

USAGE
  $ arpl account:list

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

`arpl account:lock ADDRESS`

Lock an account

USAGE
  $ arpl account:lock ADDRESS

ARGUMENTS
  ADDRESS  Address of the account to lock

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

`arpl account:unlock ADDRESS`

Unlock an account

USAGE
  $ arpl account:unlock ADDRESS

ARGUMENTS
  ADDRESS  Address of the account to unlock

OPTIONS
  --password=password  Password to decrypt the key

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

`arpl block:follow`

Stream blocks live

USAGE
  $ arpl block:follow

See code: src/commands/block/follow.ts

`arpl block:get [NUMBER_OR_HASH]`

Show block information

USAGE
  $ arpl block:get [NUMBER_OR_HASH]

ARGUMENTS
  NUMBER_OR_HASH  [default: latest] Block number or hash of the block to get

OPTIONS
  --full  Include block body in information (transactions, etc.)

See code: src/commands/block/get.ts

`arpl help [COMMAND]`

display help for arpl

USAGE
  $ arpl help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`arpl raw COMMAND [OPTIONS]`

Run a raw Nimiq JSON-RPC command

USAGE
  $ arpl raw COMMAND [OPTIONS]

See code: src/commands/raw.ts

`arpl repl`

Open an interactive REPL session to run commands

USAGE
  $ arpl repl

EXAMPLE
  $ repl

See code: @sisou/oclif-plugin-repl

`arpl stake:list`

List validators and stakes

USAGE
  $ arpl stake:list

OPTIONS
  --plain  Display plain command output

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

`arpl stake:move WALLET FROM_VALIDATOR_ID TO_VALIDATOR_ID VALUE`

Move stake between validators (rededicate)

USAGE
  $ arpl stake:move WALLET FROM_VALIDATOR_ID TO_VALIDATOR_ID VALUE

ARGUMENTS
  WALLET             Address of unlocked account that owns the stake
  FROM_VALIDATOR_ID  ID of the validator to move stake from
  TO_VALIDATOR_ID    ID of the validator to move stake to
  VALUE              [NIM] Staking amount to move

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/stake/move.ts

`arpl stake:recover WALLET VALUE`

Recover stopped stake to the account (unstake)

USAGE
  $ arpl stake:recover WALLET VALUE

ARGUMENTS
  WALLET  Address of unlocked account that owns the stake
  VALUE   NIM amount to recover

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/stake/recover.ts

`arpl stake:restart WALLET VALIDATOR_ID VALUE`

Restart staking with a validator (reactivate)

USAGE
  $ arpl stake:restart WALLET VALIDATOR_ID VALUE

ARGUMENTS
  WALLET        Address of unlocked account to restart staking with
  VALIDATOR_ID  ID of the validator to stake with
  VALUE         NIM amount to stake

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/stake/restart.ts

`arpl stake:start WALLET VALIDATOR_ID VALUE`

Start staking with a validator (stake)

USAGE
  $ arpl stake:start WALLET VALIDATOR_ID VALUE

ARGUMENTS
  WALLET        Address of unlocked account to start staking with
  VALIDATOR_ID  ID of the validator to stake with
  VALUE         NIM amount to stake

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/stake/start.ts

`arpl stake:stop WALLET VALIDATOR_ID VALUE`

Stop staking with a validator (retire)

USAGE
  $ arpl stake:stop WALLET VALIDATOR_ID VALUE

ARGUMENTS
  WALLET        Address of unlocked account that owns the stake
  VALIDATOR_ID  ID of the validator to stop staking with
  VALUE         NIM amount to retire

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/stake/stop.ts

`arpl status`

Show the current status of the node

USAGE
  $ arpl status

See code: src/commands/status.ts

`arpl transaction:get HASH`

Show transaction information

USAGE
  $ arpl transaction:get HASH

ARGUMENTS
  HASH  Transaction hash of the transaction to get

See code: src/commands/transaction/get.ts

`arpl transaction:send WALLET RECIPIENT VALUE`

Send a transaction

USAGE
  $ arpl transaction:send WALLET RECIPIENT VALUE

ARGUMENTS
  WALLET     Address of unlocked account to send transaction from
  RECIPIENT  Address of recipient
  VALUE      NIM amount to send

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/transaction/send.ts

`arpl validator:drop VALIDATOR_ID SECRET_KEY RECIPIENT VALUE`

Drop an inactive validator

USAGE
  $ arpl validator:drop VALIDATOR_ID SECRET_KEY RECIPIENT VALUE

ARGUMENTS
  VALIDATOR_ID  ID of the validator to drop
  SECRET_KEY    Secret key of the validator to drop
  RECIPIENT     Address to receive validator stake
  VALUE         NIM amount to drop

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/validator/drop.ts

`arpl validator:new WALLET SECRET_KEY VALUE`

USAGE
  $ arpl validator:new WALLET SECRET_KEY VALUE

ARGUMENTS
  WALLET      Address of unlocked account to send transaction from
  SECRET_KEY  Secret key of the new validator
  VALUE       NIM amount to stake (min. 1000 NIM)

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --reward-address=reward-address  Reward address for the validator (default: sending address)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/validator/new.ts

`arpl validator:reactivate WALLET VALIDATOR_ID SECRET_KEY`

Reactivate an inactive validator

USAGE
  $ arpl validator:reactivate WALLET VALIDATOR_ID SECRET_KEY

ARGUMENTS
  WALLET        Address of unlocked account to send transaction from
  VALIDATOR_ID  ID of the validator to reactivate
  SECRET_KEY    Secret key of the validator to reactivate

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/validator/reactivate.ts

`arpl validator:retire WALLET VALIDATOR_ID SECRET_KEY`

Retire an active validator

USAGE
  $ arpl validator:retire WALLET VALIDATOR_ID SECRET_KEY

ARGUMENTS
  WALLET        Address of unlocked account to send transaction from
  VALIDATOR_ID  ID of the validator to retire
  SECRET_KEY    Secret key of the validator to retire

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/validator/retire.ts

`arpl validator:unpark WALLET VALIDATOR_ID SECRET_KEY`

Unpark a parked validator

USAGE
  $ arpl validator:unpark WALLET VALIDATOR_ID SECRET_KEY

ARGUMENTS
  WALLET        Address of unlocked account to send transaction from
  VALIDATOR_ID  ID of the validator to unpark
  SECRET_KEY    Secret key of the validator to unpark

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

See code: src/commands/validator/unpark.ts

`arpl validator:update WALLET VALIDATOR_ID SECRET_KEY`

Update reward address or secret key of a validator

USAGE
  $ arpl validator:update WALLET VALIDATOR_ID SECRET_KEY

ARGUMENTS
  WALLET        Address of unlocked account to send transaction from
  VALIDATOR_ID  ID of the validator to update
  SECRET_KEY    Current secret key of the validator

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --reward-address=reward-address  New reward address for the validator (default: no change)
  --secret-key=secret-key          New secret key for the validator (default: no change)
  --validity-start=validity-start  Validity start height of the transaction (default: latest)

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

Eligioo / arpl