npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sisou/albatross-remote

v0.24.0

Published

Straight-forward remote management for Nimiq Albatross nodes

Downloads

371

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

sisousisou

Keywords

oclif

Readme

@sisou/albatross-remote (arpl)

Straight-forward remote management for Nimiq Albatross nodes

oclif Version Downloads/week License

Usage

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

Connection 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)

Request Options

  -t, --timeout   Timeout for request in ms, set to 0 to disable (default: 5000)
  -m, --metadata  Show response metadata (default: false)

Commands

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:follow ADDRESS

Stream account events live

USAGE
  $ arpl account:follow ADDRESS

ARGUMENTS
  ADDRESS  Address of the account to follow

See code: src/commands/account/follow.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:transactions ADDRESS

List transactions for an address (newest first)

USAGE
  $ arpl account:transactions ADDRESS

ARGUMENTS
  ADDRESS  Address to display transactions for

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --max=max               Max number of transactions to return
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)
  --startAt=startAt       Transaction hash to start at, used for paging

ALIASES
  $ arpl account:txs

See code: src/commands/account/transactions.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 (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 peer:id

Get the local peer ID of the node

USAGE
  $ arpl peer:id

See code: src/commands/peer/id.ts

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:add WALLET VALUE

Add stake to a staker

USAGE
  $ arpl stake:add WALLET VALUE

ARGUMENTS
  WALLET  Address of unlocked account to add stake from
  VALUE   NIM amount to add

OPTIONS
  --address=address                Staker address to add stake to (default: sender address)
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl staker:stake

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

arpl stake:deactivate WALLET [AMOUNT]

Deactivate stake, for moving to another validator or retiring

USAGE
  $ arpl stake:deactivate WALLET [AMOUNT]

ARGUMENTS
  WALLET  Address of unlocked account that owns the stake

  AMOUNT  Amount of NIM that should be deactivated. Omit this argument and pass --all instead to deactivate all active
          stake.

OPTIONS
  --all                            Deactivate all active stake
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --fee-wallet=fee-wallet          Address of unlocked account to pay the fee from (default: fee is paid from stake)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl staker:deactivate

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

arpl stake:get STAKER_ADDRESS

Show information for a staker

USAGE
  $ arpl stake:get STAKER_ADDRESS

ARGUMENTS
  STAKER_ADDRESS  Address of staker to show information for

OPTIONS
  --plain  Display plain command output

ALIASES
  $ arpl staker:get

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

arpl stake:list

List validators and their stakes

USAGE
  $ arpl stake:list

OPTIONS
  --plain  Display plain command output

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

arpl stake:move WALLET NEW_VALIDATOR_ADDRESS

Move stake to another validator (update)

USAGE
  $ arpl stake:move WALLET NEW_VALIDATOR_ADDRESS

ARGUMENTS
  WALLET                 Address of unlocked account that owns the stake
  NEW_VALIDATOR_ADDRESS  Address of the validator to move stake to

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --fee-wallet=fee-wallet          Address of unlocked account to pay the fee from (default: fee is paid from stake)
  --no-reactivate                  Do not reactivate all stake after changing delegation
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl staker:update

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

arpl stake:remove WALLET [AMOUNT]

Remove stake (unstake) back to your account

USAGE
  $ arpl stake:remove WALLET [AMOUNT]

ARGUMENTS
  WALLET  Address of unlocked account that owns the stake

  AMOUNT  Amount of NIM that should be removed/unstaked. Omit this argument and pass --all instead to remove/unstake all
          retired stake.

OPTIONS
  --all                            Remove/unstake all retired stake
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --recipient=recipient            Address to receive stake (default: WALLET)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl staker:remove
  $ arpl stake:unstake
  $ arpl staker:unstake

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

arpl stake:retire WALLET [AMOUNT]

Retire stake, for removing/unstaking

USAGE
  $ arpl stake:retire WALLET [AMOUNT]

ARGUMENTS
  WALLET  Address of unlocked account that owns the stake
  AMOUNT  Amount of NIM that should be retired. Omit this argument and pass --all instead to retire all inactive stake.

OPTIONS
  --all                            Retire all inactive stake
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --fee-wallet=fee-wallet          Address of unlocked account to pay the fee from (default: fee is paid from stake)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl staker:retire

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

arpl stake:start WALLET VALIDATOR_ADDRESS VALUE

Start staking with a validator (new staker)

USAGE
  $ arpl stake:start WALLET VALIDATOR_ADDRESS VALUE

ARGUMENTS
  WALLET             Address of unlocked account to start staking from
  VALIDATOR_ADDRESS  Address 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)
  --staker-wallet=staker-wallet    Address of unlocked staker account (default: WALLET)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl staker:new

See code: src/commands/stake/start.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

ALIASES
  $ arpl tx: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
  --data=data                      HEX-encoded data
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

ALIASES
  $ arpl tx:send

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

arpl validator:deactivate WALLET VALIDATOR_ADDRESS SIGNING_SECRET_KEY

Deactivate an active validator

USAGE
  $ arpl validator:deactivate WALLET VALIDATOR_ADDRESS SIGNING_SECRET_KEY

ARGUMENTS
  WALLET              Address of unlocked account to send transaction from (fees are taken from this account)
  VALIDATOR_ADDRESS   Address of the validator
  SIGNING_SECRET_KEY  Secret key used to sign the deactivate transaction

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

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

arpl validator:delete WALLET

Delete a retired validator

USAGE
  $ arpl validator:delete WALLET

ARGUMENTS
  WALLET  Address of unlocked account that owns the validator

OPTIONS
  --dry                            Return serialized transaction without sending it
  --fee=fee                        Fee in Luna (default: 0)
  --recipient=recipient            Address to receive validator deposit (default: sender address)
  --validity-start=validity-start  [default: +0] Validity start height of the transaction

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

arpl validator:get VALIDATOR_ADDRESS

Show information for a validator

USAGE
  $ arpl validator:get VALIDATOR_ADDRESS

ARGUMENTS
  VALIDATOR_ADDRESS  Address of validator to show information for

OPTIONS
  --plain  Display plain command output

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

arpl validator:new WALLET SIGNING_SECRET_KEY VOTING_SECRET_KEY

Register a new validator (requires 10k NIM deposit)

USAGE
  $ arpl validator:new WALLET SIGNING_SECRET_KEY VOTING_SECRET_KEY

ARGUMENTS
  WALLET              Address of unlocked account to send transaction from (deposit and fees are taken from this
                      account)

  SIGNING_SECRET_KEY  Secret key used to sign Micro blocks and retire, reactivate & unpark transactions (default:
                      sending address)

  VOTING_SECRET_KEY   BLS secret key used when signing votes (for Macro blocks and view changes)

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)
  --signal-data=signal-data              32-byte signal data (default: none)

  --validator-address=validator-address  Address of unlocked account that will own the validator (default: sending
                                         address)

  --validity-start=validity-start        [default: +0] Validity start height of the transaction

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

arpl validator:reactivate WALLET VALIDATOR_ADDRESS SIGNING_SECRET_KEY

Reactivate an inactive validator

USAGE
  $ arpl validator:reactivate WALLET VALIDATOR_ADDRESS SIGNING_SECRET_KEY

ARGUMENTS
  WALLET              Address of unlocked account to send transaction from (fees are taken from this account)
  VALIDATOR_ADDRESS   Address of the validator
  SIGNING_SECRET_KEY  Secret key used to sign the reactivate transaction

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

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

arpl validator:retire WALLET VALIDATOR_ADDRESS

Retire an active or deactivated validator

USAGE
  $ arpl validator:retire WALLET VALIDATOR_ADDRESS

ARGUMENTS
  WALLET             Address of unlocked account to send transaction from (fees are taken from this account)
  VALIDATOR_ADDRESS  Address of unlocked account that owns the validator

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

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

arpl validator:update WALLET VALIDATOR_ADDRESS

Update reward address or secret key of a validator

USAGE
  $ arpl validator:update WALLET VALIDATOR_ADDRESS

ARGUMENTS
  WALLET             Address of unlocked account to send transaction from (fees are taken from this account)
  VALIDATOR_ADDRESS  Address of unlocked account that owns 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)
  --signal-data=signal-data                New 32-byte signal data (default: no change)

  --signing-secret-key=signing-secret-key  New secret key used to sign Micro blocks and retire, reactivate & unpark
                                           transactions (default: no change)

  --validity-start=validity-start          [default: +0] Validity start height of the transaction

  --voting-secret-key=voting-secret-key    New BLS secret key used when signing votes (default: no change)

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