@trunx-io/plugin-eosio
v1.0.1
Published
Plugin containing EOSIO commands for TrunxIO Wallet
Downloads
4
Readme
@trunx-io/plugin-eosio
Plugin containing EOSIO commands for TrunxIO Wallet
Usage
$ npm install -g @trunx-io/plugin-eosio
$ @trunx-io/plugin-eosio COMMAND
running command...
$ @trunx-io/plugin-eosio (-v|--version|version)
@trunx-io/plugin-eosio/1.0.1 darwin-arm64 node-v18.4.0
$ @trunx-io/plugin-eosio --help [COMMAND]
USAGE
$ @trunx-io/plugin-eosio COMMAND
...
Commands
@trunx-io/plugin-eosio eosio:buyram PAYER RECEIVER AMOUNT
@trunx-io/plugin-eosio eosio:claimrewards OWNER
@trunx-io/plugin-eosio eosio:delegatebw FROM RECEIVER STAKE_NET_QUANTITY STAKE_CPU_QUANTITY
@trunx-io/plugin-eosio eosio:fetch
@trunx-io/plugin-eosio eosio:listbw ACCOUNT
@trunx-io/plugin-eosio eosio:listproducers
@trunx-io/plugin-eosio eosio:regproducer PRODUCER PRODUCER_KEY [URL] [LOCATION]
@trunx-io/plugin-eosio eosio:regproxy PROXY
@trunx-io/plugin-eosio eosio:sellram ACCOUNT BYTES
@trunx-io/plugin-eosio eosio:transfer FROM TO QUANTITY [MEMO]
@trunx-io/plugin-eosio eosio:undelegatebw FROM RECEIVER UNSTAKE_NET_QUANTITY UNSTAKE_CPU_QUANTITY
@trunx-io/plugin-eosio eosio:unregproducer PRODUCER
@trunx-io/plugin-eosio eosio:unregproxy PROXY
@trunx-io/plugin-eosio eosio:voteproducer SUBCOMMAND VOTER PRODUCER
@trunx-io/plugin-eosio esr:decode TX
@trunx-io/plugin-eosio esr:encode TX
@trunx-io/plugin-eosio eosio:buyram PAYER RECEIVER AMOUNT
Buy RAM.
USAGE
$ @trunx-io/plugin-eosio eosio:buyram PAYER RECEIVER AMOUNT
ARGUMENTS
PAYER account paying for the RAM
RECEIVER account receiving the bought resources
AMOUNT amount of tokens to pay for RAM
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Buy RAM.
See code: src/commands/eosio/buyram.js
@trunx-io/plugin-eosio eosio:claimrewards OWNER
Claim producer rewards.
USAGE
$ @trunx-io/plugin-eosio eosio:claimrewards OWNER
ARGUMENTS
OWNER account to claim rewards for
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Claim producer rewards.
See code: src/commands/eosio/claimrewards.js
@trunx-io/plugin-eosio eosio:delegatebw FROM RECEIVER STAKE_NET_QUANTITY STAKE_CPU_QUANTITY
Delegate bandwidth to a user account
USAGE
$ @trunx-io/plugin-eosio eosio:delegatebw FROM RECEIVER STAKE_NET_QUANTITY STAKE_CPU_QUANTITY
ARGUMENTS
FROM account to delegate from
RECEIVER account to delegate to
STAKE_NET_QUANTITY token amount to stake for NET
STAKE_CPU_QUANTITY token amount to stake for CPU
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
-t, --transfer transfer voting and staking rights to account
DESCRIPTION
...
Delegate bandwidth to a user account
See code: src/commands/eosio/delegatebw.js
@trunx-io/plugin-eosio eosio:fetch
Fetch some data from an EOSIO/DFuse endpoint
USAGE
$ @trunx-io/plugin-eosio eosio:fetch
OPTIONS
-d, --data=data json formatted string of data to query
-e, --endpoint=endpoint (required) endpoint to query (do not include server; use -s flag to specify server)
-s, --server=server EOSIO node
DESCRIPTION
Fetch some data from an EOSIO/DFuse endpoint.
See code: src/commands/eosio/fetch.js
@trunx-io/plugin-eosio eosio:listbw ACCOUNT
List bandwidth for the user account
USAGE
$ @trunx-io/plugin-eosio eosio:listbw ACCOUNT
ARGUMENTS
ACCOUNT account to query
OPTIONS
-s, --server=server EOSIO node. Will use `selectedServer` from user config if defined.
DESCRIPTION
...
List bandwidth for the user account
See code: src/commands/eosio/listbw.js
@trunx-io/plugin-eosio eosio:listproducers
List block producers
USAGE
$ @trunx-io/plugin-eosio eosio:listproducers
OPTIONS
-l, --lower_bound=lower_bound lower bound of query results; used for pagination
-n, --limit=limit [default: 10] number of producers to return
-s, --server=server EOSIO node
DESCRIPTION
...
List block producers
See code: src/commands/eosio/listproducers.js
@trunx-io/plugin-eosio eosio:regproducer PRODUCER PRODUCER_KEY [URL] [LOCATION]
Register an existing user account as a block producer.
USAGE
$ @trunx-io/plugin-eosio eosio:regproducer PRODUCER PRODUCER_KEY [URL] [LOCATION]
ARGUMENTS
PRODUCER account to register as a producer
PRODUCER_KEY public key to use for signing
URL url with information about the producer
LOCATION relative location; for nearest neighbor scheduling
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Register an existing user account as a block producer.
See code: src/commands/eosio/regproducer.js
@trunx-io/plugin-eosio eosio:regproxy PROXY
Register an existing user account as a proxy for voting.
USAGE
$ @trunx-io/plugin-eosio eosio:regproxy PROXY
ARGUMENTS
PROXY account to register as a proxy
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Register an existing user account as a proxy for voting.
See code: src/commands/eosio/regproxy.js
@trunx-io/plugin-eosio eosio:sellram ACCOUNT BYTES
Buy RAM.
USAGE
$ @trunx-io/plugin-eosio eosio:sellram ACCOUNT BYTES
ARGUMENTS
ACCOUNT account receiving tokens for sold RAM
BYTES number of RAM bytes to sell (must be in increments of 1024 on UTX network)
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Buy RAM.
See code: src/commands/eosio/sellram.js
@trunx-io/plugin-eosio eosio:transfer FROM TO QUANTITY [MEMO]
Transfer tokens from one account to another.
USAGE
$ @trunx-io/plugin-eosio eosio:transfer FROM TO QUANTITY [MEMO]
ARGUMENTS
FROM account sending tokens
TO account receiving tokens
QUANTITY amount of tokens to send
MEMO memo attached to the transfer
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Transfer tokens from one account to another.
See code: src/commands/eosio/transfer.js
@trunx-io/plugin-eosio eosio:undelegatebw FROM RECEIVER UNSTAKE_NET_QUANTITY UNSTAKE_CPU_QUANTITY
Undelegate bandwidth for the user account
USAGE
$ @trunx-io/plugin-eosio eosio:undelegatebw FROM RECEIVER UNSTAKE_NET_QUANTITY UNSTAKE_CPU_QUANTITY
ARGUMENTS
FROM account to undelegate from
RECEIVER account to undelegate to
UNSTAKE_NET_QUANTITY token amount to unstake for NET
UNSTAKE_CPU_QUANTITY token amount to unstake for CPU
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Undelegate bandwidth for the user account
See code: src/commands/eosio/undelegatebw.js
@trunx-io/plugin-eosio eosio:unregproducer PRODUCER
Unregister an account from being a block producer.
USAGE
$ @trunx-io/plugin-eosio eosio:unregproducer PRODUCER
ARGUMENTS
PRODUCER account to register as a producer
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Unregister an account from being a block producer.
See code: src/commands/eosio/unregproducer.js
@trunx-io/plugin-eosio eosio:unregproxy PROXY
Register an existing user account as a proxy for voting.
USAGE
$ @trunx-io/plugin-eosio eosio:unregproxy PROXY
ARGUMENTS
PROXY account to unregister as a proxy
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Register an existing user account as a proxy for voting.
See code: src/commands/eosio/unregproxy.js
@trunx-io/plugin-eosio eosio:voteproducer SUBCOMMAND VOTER PRODUCER
Vote to approve or unapprove a producer or proxy.
USAGE
$ @trunx-io/plugin-eosio eosio:voteproducer SUBCOMMAND VOTER PRODUCER
ARGUMENTS
SUBCOMMAND specify the subcommand to use: [prods, proxy, approve, unapprove]. see help for more info.
VOTER account used to vote for a producer
PRODUCER producer (or proxy) to vote for (existing votes will not be changed)
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Vote for producers or set a voting proxy.
Subcommands: [prods, proxy, approve, unapprove]
- 'proxy': Vote your stake through a proxy
- 'prods': Vote for one or more producers
- 'approve': Add one producer to list of voted producers
- 'unapprove': Remove one producer from list of voted producers
See code: src/commands/eosio/voteproducer.js
@trunx-io/plugin-eosio esr:decode TX
Parse ESR transaction and print the raw result
USAGE
$ @trunx-io/plugin-eosio esr:decode TX
ARGUMENTS
TX Transaction in ESR format
OPTIONS
-p, --permission=permission [default: ............1,............2] account@permission used to sign transaction.
-s, --server=server [default: https://eos.greymass.com] EOSIO node used for fetching ABIs
DESCRIPTION
Parse ESR transaction and print the raw result.
See code: src/commands/esr/decode.js
@trunx-io/plugin-eosio esr:encode TX
Encode EOSIO transaction as Singing Request
USAGE
$ @trunx-io/plugin-eosio esr:encode TX
ARGUMENTS
TX EOSIO Transaction in JSON format
OPTIONS
-s, --server=server EOSIO node used for fetching ABIs and chain_id. Defaults to: https://eos.greymass.com
DESCRIPTION
Encode EOSIO transaction as Singing Request.
See code: src/commands/esr/encode.js