Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 2.46 KB

enrolRewardProgram.md

File metadata and controls

50 lines (35 loc) · 2.46 KB
Raw

twix-node enrolRewardProgram

It enrols the nodes in the rewards program by announcing the enrol transaction to the registration address. You can also use this command to update the program registration when you change the node public key or server host.

Currently, the only program that can be enrolled post-launch is 'SuperNode'.

twix-node enrolRewardProgram

It enrols the nodes in the rewards program by announcing the enrol transaction to the registration address. You can also use this command to update the program registration when you change the node public key or server host.

USAGE
  $ twix-node enrolRewardProgram

OPTIONS
  -h, --help              It shows the help of this command.
  -t, --target=target     [default: target] The target folder where the twix-node network is generated
  -u, --url=url           [default: http://localhost:3000] the network url

  --maxFee=maxFee         the max fee used when announcing (absolute). The node min multiplier will be used if it is not
                          provided.

  --noPassword            When provided, Bootstrap will not use a password, so private keys will be stored in plain
                          text. Use with caution.

  --password=password     A password used to encrypt and decrypt private keys in preset files like addresses.yml and
                          preset.yml. Bootstrap prompts for a password by default, can be provided in the command line
                          (--password=XXXX) or disabled in the command line (--noPassword).

  --ready                 If --ready is provided, the command will not ask for confirmation when announcing
                          transactions.

  --useKnownRestGateways  Use the best NEM node available when announcing. Otherwise the command will use the node
                          provided by the --url parameter.

DESCRIPTION
  Currently, the only program that can be enrolled post-launch is 'SuperNode'.

EXAMPLES
  $ twix-node enrolRewardProgram
  $ twix-node enrolRewardProgram --noPassword
  $ twix-node enrolRewardProgram --useKnownRestGateways
  $ twix-node enrolRewardProgram --password 1234 --url http://external-rest:3000
  $ echo "$MY_ENV_VAR_PASSWORD" | twix-node enrolRewardProgram --url http://external-rest:3000

See code: src/commands/enrolRewardProgram.ts