diff --git a/kroma-validator/cmd/README.md b/kroma-validator/cmd/README.md index 4d8f5b2fa..969a5cc4d 100644 --- a/kroma-validator/cmd/README.md +++ b/kroma-validator/cmd/README.md @@ -21,46 +21,12 @@ kroma-validator [command] --help ## Commands -### Commands for Validator System V1 - -The following commands are available in Validator System V1. Note that these commands will be **deprecated** and -removed in the future after the new validator system is introduced. You can still use `withdraw` and `unbond` even -after the transition to the Validator System V2. - -- `deposit` - Deposit ETH to `ValidatorPool`. - - `--amount [value]` - _(Required)_ The amount of ETH to deposit (in Wei). - - ```bash - kroma-validator deposit --amount 100000000 - ``` - -- `withdraw` - Withdraw ETH from `ValidatorPool`. - - `--amount [value]` - _(Required)_ The amount of ETH to withdraw (in Wei). - - ```bash - kroma-validator withdraw --amount 100000000 - ``` - -- `withdrawTo` - Withdraw ETH from `ValidatorPool` to specific address. - - `--address` - _(Required)_ The address to receive withdrawn ETH. - - `--amount [value]` - _(Required)_ The amount of ETH to withdraw (in Wei). - - ```bash - kroma-validator withdrawTo --address 0x0000000000000000000000000000000000000001 --amount 100000000 - ``` - -- `unbond` - Manually unbond the bonded ETH from `ValidatorPool` (including reward distribution). - - ```bash - kroma-validator unbond - ``` - -### Commands for Validator System V2 (_EXPERIMENTAL_) +### Commands for Validator System V2 The following commands are available in Validator System V2: - `register` - Register as new validator to `ValidatorManager`. - - `--amount [value]` - _(Required)_ The amount of tokens to delegate initially (in Wei). + - `--amount [value]` - _(Required)_ The amount of tokens to deposit initially (in Wei). - `--commission-rate [value]` - _(Required)_ The initial commission rate of the validator (in %). - `--withdraw-account [value]` - _(Required)_ The address to withdraw deposited asset token. @@ -80,50 +46,60 @@ The following commands are available in Validator System V2: kroma-validator unjail ``` -- `changeCommissionRate init` - Initiate the commission rate change of the validator in `ValidatorManager`. +- `changeCommission init` - Initiate the commission rate change of the validator in `ValidatorManager`. - `--commission-rate [value]` - _(Required)_ The new commission rate of the validator (in %). ```bash - kroma-validator changeCommissionRate init --commission-rate 5 + kroma-validator changeCommission init --commission-rate 5 ``` -- `changeCommissionRate finalize` - Finalize the commission rate change of the validator in `ValidatorManager`. +- `changeCommission finalize` - Finalize the commission rate change of the validator in `ValidatorManager`. ```bash - kroma-validator changeCommissionRate finalize + kroma-validator changeCommission finalize ``` -- `delegate` - Self-delegate asset tokens to the `AssetManager`. - - `--amount [value]` - _(Required)_ The amount of tokens to delegate (in Wei). +- `depositKro` - Deposit asset tokens to the `AssetManager`. + - `--amount [value]` - _(Required)_ The amount of tokens to deposit (in Wei). ```bash - kroma-validator delegate --amount 100000000 + kroma-validator depositKro --amount 100000000 ``` -- `undelegate init` - Initiate the undelegation of asset tokens from the `AssetManager`. - - `--amount [value]` - _(Required)_ The amount of tokens to undelegate (in Wei). +Note that withdraw of the deposited asset and reward must be done with the withdraw account that was set during the +registration. Please make sure that you must keep the private key of the withdraw account safe, since it cannot be +modified after the registration. + +### Commands for Validator System V1 (_DEPRECATED_) + +The following commands are available in Validator System V1. Note that these commands are **deprecated** and +will be removed since the new validator system is introduced. You can still use `withdraw` and `unbond` to withdraw +and unbond your ETH from the old `ValidatorPool`. + +- `deposit` - Deposit ETH to `ValidatorPool`. + - `--amount [value]` - _(Required)_ The amount of ETH to deposit (in Wei). ```bash - kroma-validator undelegate init --amount 100000000 + kroma-validator deposit --amount 100000000 ``` -- `undelegate finalize` - Finalize the undelegations of asset tokens from the `AssetManager`. - Should be called after 1 week has passed from the `undelegate init` command. +- `withdraw` - Withdraw ETH from `ValidatorPool`. + - `--amount [value]` - _(Required)_ The amount of ETH to withdraw (in Wei). ```bash - kroma-validator undelegate finalize + kroma-validator withdraw --amount 100000000 ``` -- `claim init` - Initiate the claim of validator reward from the `AssetManager`. - - `--amount [value]` - _(Required)_ The amount of tokens to claim (in Wei). +- `withdrawTo` - Withdraw ETH from `ValidatorPool` to specific address. + - `--address` - _(Required)_ The address to receive withdrawn ETH. + - `--amount [value]` - _(Required)_ The amount of ETH to withdraw (in Wei). ```bash - kroma-validator claim init --amount 100000000 + kroma-validator withdrawTo --address 0x0000000000000000000000000000000000000001 --amount 100000000 ``` -- `claim finalize` - Finalize the claim of validator reward from the `AssetManager`. Should be called after 1 week - has passed from the `claim init` command. +- `unbond` - Manually unbond the bonded ETH from `ValidatorPool` (including reward distribution). ```bash - kroma-validator claim finalize + kroma-validator unbond ```