Command Reference

bennyfi

Flags

--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
SUBCOMMANDS:
CMD:
access-nft
DESCRIPTION:
view, create and manage the access nfts
SUBCOMMANDS:
CMD:
init
DESCRIPTION:
Init NFT contract
CMD:
list-assets owner
DESCRIPTION:
list access nft assets
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
mint account
DESCRIPTION:
Mint pool manager access nft
CMD:
admin
DESCRIPTION:
admin commands
SUBCOMMANDS:
CMD:
init
DESCRIPTION:
Runs the init script specified in the config file
CMD:
reset limit table1 table2 ...
DESCRIPTION:
Clears the specified contract tables:
Parameters:
limit: number of rows to delete on each call to the contract
table1..n: tables to delete
existing tables: auths authtokens balances entries categories projects pools terms yieldsources settings
CMD:
set-open-permission
DESCRIPTION:
Configures the open permission, creates the open permission associated to the contract account and
links it to appropriate actions.
It uses the public key in the config file with name "open-permission-key"
CMD:
auth
DESCRIPTION:
The auth module stores accounts, notes, and an authorization level as an integer.
The most powerful authorization level is 0, also known as SUDO, and the other levels are as follows:
ADMIN = 10
ROUND_MANAGER = 40
PLAYER = 50
BENEFICIARY = 60
DISABLED = 70
Create new authorization levels using any integer. The lower the number, the more powerful
the authorization. Use account multisig to manage the full SUDO authorization.
Example usage:
bennyfi auth set jonathan 10 --notes "jonathan will be taking over new user setups"
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-n, --notes string             notes that are saved with auth records
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
SUBCOMMANDS:
CMD:
claim-stakes
DESCRIPTION:
Triggers the contract to check for auths with expired stake waiting time that stake needs to be claimed
CMD:
erase [account]
DESCRIPTION:
erase the on-chain authorization for an account
CMD:
lapse-time <account>
DESCRIPTION:
***ONLY FOR TESTING*** Lapses auth stake waiting period events
CMD:
list
DESCRIPTION:
show the on-chain authorizations
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-n, --notes string             notes that are saved with auth records
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
set <account> <level>
DESCRIPTION:
set the on-chain authorization settings for an account
CMD:
stake <account> <level>
DESCRIPTION:
stake to upgrade to an auth level, supported auth levels are 40(ROUND MANAGER), 60(BENEFICIARY)
CMD:
unstake <account> [authorizer]
DESCRIPTION:
unstake to downgrade from an auth level, supported auth levels to downgrade from are 40(ROUND MANAGER), 60(BENEFICIARY)
CMD:
auth-token
DESCRIPTION:
Manage authorized tokens and their roles, token roles can be one of:
"stake": Used for staking only
"reward": Used for rewards only]
Example usage:
bennyfi auth-token set-role eosio.token stake "4.0000 EOS" "10000.0000 EOS"
SUBCOMMANDS:
CMD:
erase symbol
DESCRIPTION:
erase authorized token
CMD:
erase-role symbol token-role
DESCRIPTION:
erase authorized token role
CMD:
list
DESCRIPTION:
show the authorized tokens
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
set-role token-contract token-role min-value max-value
DESCRIPTION:
set the role a token will play in bennyfi. Token role can be one of ['stake': Used for staking only, 'reward': Used for rewards only]
CMD:
backup
DESCRIPTION:
Backup and restore table data
SUBCOMMANDS:
CMD:
list
DESCRIPTION:
List existing backups
CMD:
restore backup-name
DESCRIPTION:
Restore tables from existing backup
CMD:
save
DESCRIPTION:
Save a backup of the current table states
CMD:
bank
DESCRIPTION:
manage the on-chain bank for your dapp, view balances, deposit and withdraw
SUBCOMMANDS:
CMD:
balances
DESCRIPTION:
show user balances
FLAGS:
-a, --account string           Account of the token holder
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
deposit token-contract quantity [token-holder]
DESCRIPTION:
Make a deposit into bennyfi
CMD:
withdraw quantity [token-holder]
DESCRIPTION:
Make a withdraw out of bennyfi
CMD:
categories
DESCRIPTION:
manage the on-chain category configurations
SUBCOMMANDS:
CMD:
erase category [authorizer]
DESCRIPTION:
Erase category
CMD:
list
DESCRIPTION:
show available categories
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
set category name description image [authorizer]
DESCRIPTION:
Create or update category
CMD:
contract
DESCRIPTION:
commands focused on contract deployment
SUBCOMMANDS:
CMD:
commits
DESCRIPTION:
Lists available smart contract repo commits
CMD:
deploy
DESCRIPTION:
Deploys the bennyfi contract or proposes a transaction to deploy the contract
if the proposer flag is specified a multisig proposal transaction to deploy the contract
is pushed and the account is used as the proposer
if proposer flag is not specified the contract is deployed using the contract active permission
FLAGS:
-c, --commit string            Commit to checkout, build and deploy
--config string            config file (default is ./bennyfi.yaml)
-d, --dir string               Compiled contract files dir, this option takes precedence over commit
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --proposer string          Proposer of the transaction
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
entries
DESCRIPTION:
view, create and manage the entries
SUBCOMMANDS:
CMD:
claim entryID [participant]
DESCRIPTION:
Claims return from an unlocked round
CMD:
list
DESCRIPTION:
list entries
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-p, --participant string       Participant to list entries for
--pos uint                 Position to list entry for, has to be with the round option
-r, --round uint               RoundID to list entries for
-s, --start-value string       Value to start displaying items from
-e, --status string            Entry status, can be used in conjunction with round
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
new roundID [participant]
DESCRIPTION:
Enter a participant into a round
CMD:
unstake entryID [participant]
DESCRIPTION:
Unstakes entry from a timed out round, or unstakes entry and reward from a unlocked round
CMD:
vesting entryID [participant]
DESCRIPTION:
Perform vesting of entry in vesting state
CMD:
help [command]
DESCRIPTION:
Help provides help for any command in the application.
Simply type bennyfi help [path to command] for full details.
CMD:
msig
DESCRIPTION:
commands focused on multisig transactions
SUBCOMMANDS:
CMD:
approve proposer proposal
DESCRIPTION:
Approves a multisig transaction
if the approver flag is specified this account is used as the approver if not the default account
FLAGS:
-a, --approver string          Approver of the multisig transaction
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
exec proposer proposal
DESCRIPTION:
Executes a multisig transaction
if the executor flag is specified this account is used as the executor if not the default account
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-e, --executor string          Executor of the multisig transaction
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
nft
DESCRIPTION:
manage NFTs
SUBCOMMANDS:
CMD:
list-assets
DESCRIPTION:
list assets
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-g, --group string             Group
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-o, --owner string             Owner
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
list-frames
DESCRIPTION:
list nft frames
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
list-groups
DESCRIPTION:
list nft groups
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
reset limit
DESCRIPTION:
Clears the marble contract tables
CMD:
nft-reward
DESCRIPTION:
create and configure nft rewards
SUBCOMMANDS:
CMD:
list
DESCRIPTION:
list configured nft rewards
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
new groupName frameName manager maxSupply [authorizer]
DESCRIPTION:
Creates a new simple nft reward
CMD:
reset
DESCRIPTION:
Clears marble nft adaptor contract tables
FLAGS:
-a, --all                      Reset all tables, including settings
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
set funder roundID distribution groupName frameName
DESCRIPTION:
Sets a new reward in the marble nft adaptor contract
CMD:
set-manager groupName manager newManager
DESCRIPTION:
Sets a new manager for the nft group
CMD:
pools
DESCRIPTION:
view, create and manage the pools
SUBCOMMANDS:
CMD:
fast-forward PoolID
DESCRIPTION:
***ONLY FOR TESTING*** fast forwards pool to unlock
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --pool uint                PoolID to fast forward
-s, --start uint               PoolID to start fast forwarding from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
fund poolID [funder]
DESCRIPTION:
Fund pool reward that is in pending state
CMD:
lapse-time PoolID
DESCRIPTION:
***ONLY FOR TESTING*** Lapses pool timed events
CMD:
list [termID]
DESCRIPTION:
list pools
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-m, --manager string           Pool manager
-s, --start-value string       Value to start displaying items from
-e, --state string             Pool state
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
new pools-json
DESCRIPTION:
Create a new pool, pool must be specified as a json:
Ex. pools new '{"term_id": 0, "pool_name":"Manager Funded 1", "pool_description":"Manager Funded 1", "pool_category":"funded", "start_time":"'2023-08-09T21:09:30'", "project_id": 1, "pool_manager":"bennyfipmgr1"}'
CMD:
start [PoolID]
DESCRIPTION:
Starts pool if poolId is specified, if not it starts pools in startable state
CMD:
timed-events
DESCRIPTION:
Triggers the contract to check the state of events that are time based
CMD:
timeout
DESCRIPTION:
Triggers the contract to check for pools that need to be timedout
CMD:
unlock [poolId]
DESCRIPTION:
Triggers the contract to check for pools that need to be unlocked, if poolId is specified the unlock pool action is called on the pool
CMD:
unstake-timedout
DESCRIPTION:
Triggers the contract to check for timedout pools that need to be unstaked
CMD:
unstake-unlocked
DESCRIPTION:
Triggers the contract to check for unlocked pools that need to be unstaked
CMD:
vesting
DESCRIPTION:
Triggers the contract to check for pools that need to be vesting
CMD:
projects
DESCRIPTION:
view, create and manage the projects
SUBCOMMANDS:
CMD:
erase <projectID> <erase> [authorizer]
DESCRIPTION:
Mark/Unmark projects as erased the erase parameter is a boolean value to indicate whether to mark or unmark
CMD:
list
DESCRIPTION:
list projects
FLAGS:
-d, --alternative              Alternative json format
-a, --authorizer string        Authorizer to list projects for
-b, --beneficiary string       Beneficiary to list projects for
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-p, --project uint             ProjectID to be used in combination with authorizer or beneficiary to be able to paginate results
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
new beneficiary name <artifacts-cid> [requests-cid] [-a authorizer]
DESCRIPTION:
Create a new project
FLAGS:
-a, --authorizer string        Round Manager authorizing the project
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
update projectID name artifactsCID [-a authorizer]
DESCRIPTION:
Update project
FLAGS:
-a, --authorizer string        Round Manager authorizing the project
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
rex
DESCRIPTION:
mock rex commands
SUBCOMMANDS:
CMD:
init tokenContract
DESCRIPTION:
Initializes the mock rex contract
CMD:
init-conf tokenContract
DESCRIPTION:
Initializes the rex configuration table without initializing the rex pool table, should be used when the contract has already been initialized and the configuration settings needs to be updated
CMD:
list-balances
DESCRIPTION:
Lists rex balances
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
list-conf
DESCRIPTION:
shows the rex configuration table
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
list-initial-pool
DESCRIPTION:
shows the rex initial pool table that is used to reset the pool when the deposit account gets to 0
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
list-pool
DESCRIPTION:
shows the rex pool table
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
reset-balance
DESCRIPTION:
Erases the rex balance table
CMD:
reset-conf
DESCRIPTION:
Erases the rex configuration table
CMD:
reset-initial-pool
DESCRIPTION:
Erases the rex initial pool table
CMD:
reset-pool
DESCRIPTION:
Erases the rex pool table
CMD:
set-initial-pool
DESCRIPTION:
Sets the initial pool, which is used to reset the contract every time the deposit count returns to 0
CMD:
set-lendable-increment lendableIncrement
DESCRIPTION:
Sets the rex lendable increment, should be used when the contract has already been initialized and the lendable increment needs to be updated
CMD:
settings
DESCRIPTION:
settings module manages on-chain configuration settings for your dapp
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
SUBCOMMANDS:
CMD:
append [-t type] [setting-name] [setting-value]
DESCRIPTION:
append a value to an existing on-chain configuration setting
if the proposer flag is specified a multisig proposal transaction to append the setting
is pushed and the account is used as the proposer, the contract account as the authority
if proposer flag is not specified the setting is appended using the default user
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --proposer string          Proposer of the transaction
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
clip [-t type] [setting-name] [setting-value]
DESCRIPTION:
erases all instances of the provided value from the settings list of values
if the proposer flag is specified a multisig proposal transaction to clip the setting
is pushed and the account is used as the proposer, the contract account as the authority
if proposer flag is not specified the setting is clipped using the default user
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --proposer string          Proposer of the transaction
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
erase [setting-name]
DESCRIPTION:
erase an on-chain configuration setting
use the contract flag to specify the contract you want to work with, it defaults to the bennyfi contract
if the proposer flag is specified a multisig proposal transaction to erase the setting
is pushed and the account is used as the proposer, the contract account as the authority
if proposer flag is not specified the setting is erased using the default user
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --proposer string          Proposer of the transaction
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
list
DESCRIPTION:
list the on-chain configuration settings
use the contract flag to specify the contract you want to work with, it defaults to the bennyfi contract
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
set [-t type] [setting-name] [setting-value]
DESCRIPTION:
create or update a new on-chain configuration setting
use the contract flag to specify the contract you want to work with, it defaults to the bennyfi contract
if the proposer flag is specified a multisig proposal transaction to set the setting
is pushed and the account is used as the proposer, the contract account as the authority
if proposer flag is not specified the setting is set using the default user
Possible values for type are:
- asset
- name
- int64
- uint32
- uint64
- string
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --proposer string          Proposer of the transaction
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
setup-default
DESCRIPTION:
sets up default configuration values specified under the settings key of the config value
if the proposer flag is specified a multisig proposal transaction to set the setting
is pushed and the account is used as the proposer, the contract account as the authority
if proposer flag is not specified the setting is set using the default user
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-a, --contract string          contract to manage settings for
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-p, --proposer string          Proposer of the transaction
-t, --type string              data type of the setting to set (string, int64, asset, name, timepoint) (default "string")
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
terms
DESCRIPTION:
manage the on-chain term configurations
SUBCOMMANDS:
CMD:
erase <termID> <erase> [authorizer]
DESCRIPTION:
Mark/Unmark terms as erased the erase parameter is a boolean value to indicate whether to mark or unmark
CMD:
list
DESCRIPTION:
show available terms
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
new terms-json
DESCRIPTION:
Creates a new set of terms to create rounds from, terms must be specified as a json
Ex. terms new '{"term_name": "REX Public Project Funding Vesting 1","authorizer": "bennyfipmgr1", "pool_type": "yield","pool_access": "public","entry_stake":"75.0000 BTLOS", "num_participants":3, "staking_period_hrs":120, "enrollment_time_out_hrs":24, "beneficiary_entry_fee_perc_x100000":400000,"pool_manager_entry_fee_perc_x100000":300000, "distribution_definitions": [{"first": "maintoken","second": ["DistributionDefinitionFT", {"all_participants_perc_x100000": 500000,"beneficiary_perc_x100000": 200000,"pool_manager_perc_x100000": 100000, "yield_source": "tlosrex", "reward":"0.0000 BTLOS", "winners_perc_x100000":[10000000], "vesting_config": {"config": []}}]}, {"first": "projecttoken","second": ["DistributionDefinitionFT",{"all_participants_perc_x100000": 700000,"beneficiary_perc_x100000": 400000,"pool_manager_perc_x100000": 200000, "reward":"1000.0000 PRJA", "winners_perc_x100000":[7000000, 2000000, 1000000], "vesting_config": {"config": [{"first": "percentage_x100000","second": [ "uint32",  2000000]},{"first": "period_hrs","second": [ "uint32", 12]}]}}]}],"default_values": []}'
CMD:
test
DESCRIPTION:
commands focused on testing functionality
SUBCOMMANDS:
CMD:
draw-rn roundID numParticipants winnerPosition
DESCRIPTION:
Enables the sending a random number to the contract to select the winner, winnerPosition should be zero based
CMD:
fill-round roundID
DESCRIPTION:
Creates new accounts and enters them into a round,
if the count flag is specified it creates and enters the specified number of accounts,
if count is not specified then it creates and enters the number of participants required to fill the round
FLAGS:
--config string            config file (default is ./bennyfi.yaml)
-c, --count uint32             Participants to create and enter round
-H, --http-header strings      HTTP header to add to JSON-RPC requests
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
recover-balances
DESCRIPTION:
Before the contract is cleared it transfers tokens from the user's balances to their accounts
CMD:
recover-tokens
DESCRIPTION:
After a contract is cleared it transfers tokens from the bennyfi contract to the token contract
CMD:
tlos-rex-yield
DESCRIPTION:
view and manage the tlos rex yield stakes
SUBCOMMANDS:
CMD:
lapse-time RoundID
DESCRIPTION:
***ONLY FOR TESTING*** Lapses stake timed events
CMD:
list
DESCRIPTION:
list TLOS REX Stakes
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
-e, --state string             Stake state
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
move-from-savings
DESCRIPTION:
Triggers the contract to check for tlos REX Yield stakes that need move rex from savings
CMD:
reset limit table1 table2 ...
DESCRIPTION:
Clears the specified contract tables:
Parameters:
limit: number of rows to delete on each call to the contract
table1..n: tables to delete
existing tables: stakes settings
CMD:
sell-rex
DESCRIPTION:
Triggers the contract to check for tlos REX Yield stakes that need to sell rex
CMD:
set-open-permission
DESCRIPTION:
Configures the open permission, creates the open permission associated to the contract account and
links it to appropriate actions.
It uses the public key in the config file with name "tlos-rex-yield-open-permission-key"
CMD:
withdraw-rex
DESCRIPTION:
Triggers the contract to check for tlos REX Yield stakes that need to withdraw rex
CMD:
token
DESCRIPTION:
manage tokens
SUBCOMMANDS:
CMD:
create contract authorizer issuer maxSupply
DESCRIPTION:
Creates a new token
CMD:
vault
DESCRIPTION:
The vault is a secure key store (wallet). Your key is stored encrypted by the passphrase.
SUBCOMMANDS:
CMD:
add
CMD:
create
DESCRIPTION:
Create a new encrypted key vault.
This functionality has been copied from the 'eosc' project. https://github.com/sebastianmontero/eosc
A vault contains encrypted private keys, and with 'daoctl' or 'eosc', can be used to
securely sign transactions.
You can create a passphrase protected vault with:
daoctl vault create --keys=2
This uses the default --vault-type=passphrase
You can create a Google Cloud Platform KMS-wrapped vault with:
eosc vault create --keys=2 --vault-type=kms-gcp --kms-gcp-keypath projects/.../locations/.../keyRings/.../cryptoKeys/name
You can then use this vault for the different eosc/daoctl operations.
FLAGS:
--comment string           Comment field in the vault's json file.
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-i, --import                   Whether to import keys instead of creating them. This takes precedence over --keys, and private keys will be inputted on the command line.
-k, --keys int                 Number of keypairs to create
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
-t, --vault-type string        Vault type. One of: passphrase, kms-gcp (default "passphrase")
CMD:
export
CMD:
list
DESCRIPTION:
List public keys inside an the vault.
The wallet file contains a list of public keys for easy reference, but
you cannot trust that these public keys have their counterpart in the
wallet, unless you check with the "list" command.
CMD:
yield-source
DESCRIPTION:
manage the on-chain yield sources
SUBCOMMANDS:
CMD:
erase <yield-source> [authorizer]
DESCRIPTION:
Erase yield source
CMD:
list
DESCRIPTION:
show available yield sources
FLAGS:
-d, --alternative              Alternative json format
-c, --colorize                 Colorize json
--config string            config file (default is ./bennyfi.yaml)
-H, --http-header strings      HTTP header to add to JSON-RPC requests
-j, --json                     Display in json format
--kms-gcp-keypath string   Path to the cryptoKeys within a keyRing on GCP
-l, --limit uint32             Number of items to display (default 100)
-s, --start-value string       Value to start displaying items from
--vault-file string        Wallet file that contains encrypted key material (default "./vault.json")
CMD:
set <yield-source-json>
DESCRIPTION:
Creates or Updates a yield source, the yield source must be specified as a json
Ex. yield-source set '{ "yield_source": "tlosrex", "yield_source_name": "tlos rex", "yield_source_description": "tlos rex", "stake_symbol": "4,BTLOS", "adaptor_contract": "tlosrex", "yield_source_cid": "", "entry_fee_percentage_of_yield_x100000": 300000, "daily_yield_x100000": 3726, "token_value": "0.8500 USD", "beny_value": "0.3000 USD", "authorizer": "bennyfi" }'