-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: lightclient verification flags (#2097)
* add more fields to the chains struct * add migration script * add comments * add changelog and generate files * add comments for proto files * generate files after adding comments * generate files after adding comments * remove migration script * refactor enums to use small case * replace chain functions with variables * generate files 3 * add section for v15.0.0 in changelog.md * add issue for removing pointers from chain list functions * modify verification flags * generate files * add cli docs * add bitcoin headers * add changelog * ad some unit tests for verification_flags.go * add breaking changes section * add trim space for cli inputs * refactor verification flags into enabled chains * add unit tests for block header verification * fix changelog * generate files 3 * rename enabled chains to supported chains * add enabled chain query to zetacliet tests * generate files 4 * Update pkg/chains/chain.go Co-authored-by: Lucas Bertrand <[email protected]> * add check for duplicated chain id * fix comments and identifier names --------- Co-authored-by: Lucas Bertrand <[email protected]>
- Loading branch information
Showing
89 changed files
with
4,099 additions
and
2,047 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
docs/cli/zetacored/zetacored_tx_lightclient_disable-header-verification.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # tx lightclient disable-header-verification | ||
|
|
||
| Disable header verification for the list of chains separated by comma | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Provide a list of chain ids separated by comma to disable block header verification for the specified chain ids. | ||
|
|
||
| Example: | ||
| To disable verification flags for chain ids 1 and 56 | ||
| zetacored tx lightclient disable-header-verification "1,56" | ||
|
|
||
|
|
||
| ``` | ||
| zetacored tx lightclient disable-header-verification [list of chain-id] [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -a, --account-number uint The account number of the signing account (offline mode only) | ||
| --aux Generate aux signer data instead of sending a tx | ||
| -b, --broadcast-mode string Transaction broadcasting mode (sync|async) | ||
| --chain-id string The network chain ID | ||
| --dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible) | ||
| --fee-granter string Fee granter grants fees for the transaction | ||
| --fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer | ||
| --fees string Fees to pay along with transaction; eg: 10uatom | ||
| --from string Name or address of private key with which to sign | ||
| --gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000) | ||
| --gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1) | ||
| --gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom) | ||
| --generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name) | ||
| -h, --help help for disable-header-verification | ||
| --keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) | ||
| --keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used | ||
| --ledger Use a connected Ledger device | ||
| --node string [host]:[port] to tendermint rpc interface for this chain | ||
| --note string Note to add a description to the transaction (previously --memo) | ||
| --offline Offline mode (does not allow any online functionality) | ||
| -o, --output string Output format (text|json) | ||
| -s, --sequence uint The sequence number of the signing account (offline mode only) | ||
| --sign-mode string Choose sign mode (direct|amino-json|direct-aux), this is an advanced feature | ||
| --timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height | ||
| --tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator | ||
| -y, --yes Skip tx broadcasting prompt confirmation | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --home string directory for config and data | ||
| --log_format string The logging format (json|plain) | ||
| --log_level string The logging level (trace|debug|info|warn|error|fatal|panic) | ||
| --log_no_color Disable colored logs | ||
| --trace print out full stack trace on errors | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [zetacored tx lightclient](zetacored_tx_lightclient.md) - lightclient transactions subcommands | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,26 @@ | ||
| # Messages | ||
|
|
||
| ## MsgUpdateVerificationFlags | ||
| ## MsgEnableHeaderVerification | ||
|
|
||
| UpdateVerificationFlags updates the light client verification flags. | ||
| This disables/enables blocks verification of the light client for the specified chain. | ||
| Emergency group can disable flags, it requires operational group if at least one flag is being enabled | ||
| EnableHeaderVerification enables the verification flags for the given chain IDs | ||
| Enabled chains allow the submissions of block headers and using it to verify the correctness of proofs | ||
|
|
||
| ```proto | ||
| message MsgUpdateVerificationFlags { | ||
| message MsgEnableHeaderVerification { | ||
| string creator = 1; | ||
| VerificationFlags verification_flags = 2; | ||
| int64 chain_id_list = 2; | ||
| } | ||
| ``` | ||
|
|
||
| ## MsgDisableHeaderVerification | ||
|
|
||
| DisableHeaderVerification disables the verification flags for the given chain IDs | ||
| Disabled chains do not allow the submissions of block headers or using it to verify the correctness of proofs | ||
|
|
||
| ```proto | ||
| message MsgDisableHeaderVerification { | ||
| string creator = 1; | ||
| int64 chain_id_list = 2; | ||
| } | ||
| ``` | ||
|
|
Oops, something went wrong.