Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vadiminc committed Aug 21, 2023
1 parent e0260d4 commit d1067a1
Show file tree
Hide file tree
Showing 13 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ To run you will use the "shares" command

- keystore-path (kp) = The validator keystore file/folder path, if a folder is provided all keystore files within the provided folder will be split according to the provided arguments
- password (ps) = The keystore file encryption password, if a folder was provided the password will be used for all keystore files in the folder
- operator-ids (oids) = Comma-separated list of operator IDs. The amount must be 3f+1 compatible.
- operator-keys (oks) = Comma-separated list of operator keys (same sequence as operator ids). The amount must be 3f+1 compatible.
- operator-ids (oids) = Comma-separated list of operator IDs. The amount must be 3f+1 compatible
- operator-keys (oks) = Comma-separated list of operator keys (same sequence as operator ids). The amount must be 3f+1 compatible
- output-folder (of) = Target folder path to output the key shares file
- owner-address (oa) = The cluster owner address (in the SSV contract)
- owner-nonce (on) = The validator registration nonce of the account (owner address) within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool.
- multi-shares (ms) = Keystore path will accept multiple keystores from a folder path, all files must have the same password.
- owner-nonce (on) = The validator registration nonce of the account (owner address) within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool
- multi-shares (ms) = Keystore path will accept multiple keystores from a folder path, all files must have the same password
```bash
# single file
yarn cli shares --keystore=keystore.json --password=test --operator-ids=1,2,3,4 --operator-keys=LS..,LS..,LS..,LS.. --output-folder=./ --owner-address=... --owner-nonce=..
Expand Down
2 changes: 1 addition & 1 deletion dist/tsc/src/commands/actions/arguments/multi-shares.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions dist/tsc/src/commands/actions/arguments/operator-ids.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions dist/tsc/src/commands/actions/arguments/owner-nonce.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/tsc/src/commands/actions/arguments/owner-nonce.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/commands/actions/arguments/multi-shares.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ export default {
action: 'store_true',
default: false,
required: false,
help: 'Keystore path will accept multiple keystores from a folder path, all files must have the same password.'
help: 'Keystore path will accept multiple keystores from a folder path, all files must have the same password'
}
};
4 changes: 2 additions & 2 deletions src/commands/actions/arguments/operator-ids.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default {
options: {
type: String,
required: true,
help: 'Comma-separated list of operator IDs. The amount must be 3f+1 compatible.'
help: 'Comma-separated list of operator IDs. The amount must be 3f+1 compatible'
},
interactive: {
repeat: 'Input another operator?',
Expand All @@ -31,7 +31,7 @@ export default {
},
validateList: (items: []) => {
if (!isOperatorsLengthValid(items.length)) {
throw new Error('Invalid operators amount. Enter an 3f+1 compatible amount of operator ids.');
throw new Error('Invalid operators amount. Enter an 3f+1 compatible amount of operator ids');
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/commands/actions/arguments/operator-public-keys.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default {
options: {
type: String,
required: true,
help: 'Comma-separated list of operator keys (same sequence as operator ids). The amount must be 3f+1 compatible.'
help: 'Comma-separated list of operator keys (same sequence as operator ids). The amount must be 3f+1 compatible'
},
interactive: {
options: {
Expand Down
4 changes: 2 additions & 2 deletions src/commands/actions/arguments/owner-nonce.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ export default {
options: {
type: Number,
required: true,
help: 'The validator registration nonce of the account (owner address) within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool.'
help: 'The validator registration nonce of the account (owner address) within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool'
},
interactive: {
options: {
type: 'number',
message: 'Please provide a valid owner nonce of the account (owner address) obtained using the ssv-scanner tool.',
message: 'Please provide a valid owner nonce of the account (owner address) obtained using the ssv-scanner tool',
}
}
};

0 comments on commit d1067a1

Please sign in to comment.