Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Inaccurate description of sender-public-key flag in Commander #7987

Closed
Tracked by #7210
bobanm opened this issue Jan 11, 2023 · 0 comments · Fixed by #7985
Closed
Tracked by #7210

Inaccurate description of sender-public-key flag in Commander #7987

bobanm opened this issue Jan 11, 2023 · 0 comments · Fixed by #7985

Comments

@bobanm
Copy link
Contributor

bobanm commented Jan 11, 2023

The description for sender-public-key flag currently is quite inaccurate.

For transaction:sign:

Sign the transaction with provided sender public key, when passphrase is not provided

  • conceptually: you don't sign anything using a public key
  • functionally: the public key here is used to calculate the multisig account address, while the signing is done using private key which is derived from the provided passphrase
  • procedurally: if passphrase is not provided in flags, a user will be prompted to enter it

For transaction:create:

Creates the transaction with provided sender publickey, when passphrase is not provided

Also, for transaction:create the description is in transaction/create.ts while the description for transaction:sign is in utils/flags.ts.

Since flag description should be the same, it should go in utils/flags.ts file, which is command independent.

A more accurate description of the flag would be:

Set a custom senderPublicKey property for the transaction, to be used when account address does not correspond to signer's private key

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant