Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI for the light client #1307

Closed
romac opened this issue Apr 28, 2023 · 0 comments · Fixed by #1308
Closed

CLI for the light client #1307

romac opened this issue Apr 28, 2023 · 0 comments · Fixed by #1308
Assignees
Labels
enhancement New feature or request feature light-client Issues/features which involve the light client

Comments

@romac
Copy link
Member

romac commented Apr 28, 2023

Description

Implement a simple CLI for the light client, to verify headers up to a given height, perform attack detection, and report the evidence (if any) to primary and witness nodes.

Definition of "done"

A CLI for the light client can be invoked with the following interface:


Usage: tendermint-light-client-cli [OPTIONS] --chain-id <CHAIN_ID> --primary <PRIMARY> --witnesses <WITNESSES> --trusted-height <TRUSTED_HEIGHT> --trusted-hash <TRUSTED_HASH>

Options:
      --chain-id <CHAIN_ID>
          Identifier of the chain
      --primary <PRIMARY>
          Primary RPC address
      --witnesses <WITNESSES>
          Comma-separated list of witnesses RPC addresses
      --trusted-height <TRUSTED_HEIGHT>
          Height of trusted header
      --trusted-hash <TRUSTED_HASH>
          Hash of trusted header
      --height <HEIGHT>
          Height of the header to verify
      --trust-threshold <TRUST_THRESHOLD>
          Trust threshold [default: 2/3]
      --trusting-period <TRUSTING_PERIOD>
          Trusting period, in seconds (default: two weeks) [default: 1209600]
      --max-clock-drift <MAX_CLOCK_DRIFT>
          Maximum clock drift, in seconds [default: 5]
      --max-block-lag <MAX_BLOCK_LAG>
          Maximum block lag, in seconds [default: 5]
  -v, --verbose...
          Increase verbosity, can be repeated up to 2 times
  -h, --help
          Print help
  -V, --version
          Print version
@romac romac added the enhancement New feature or request label Apr 28, 2023
@romac romac self-assigned this Apr 28, 2023
@romac romac added light-client Issues/features which involve the light client feature labels Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature light-client Issues/features which involve the light client
Projects
None yet
1 participant