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

Eth2 client: naming improvements #814

Open
sept-en opened this issue Sep 19, 2022 · 3 comments
Open

Eth2 client: naming improvements #814

sept-en opened this issue Sep 19, 2022 · 3 comments
Assignees
Labels
enhancement good first issue Good for newcomers rust Pull requests that update Rust code

Comments

@sept-en
Copy link
Contributor

sept-en commented Sep 19, 2022

eth2-client contains some unclear and ambiguous variable names:

  • unfinalized_headers could either mean execution headers or beacon headers.
  • network could either mean the NEAR network that the contract is deployed to or the Ethereum network that the client watches.
  • submitters could be interpreted as likely a list of registered submitters, num_submitted_headers_by_submitter may be a more appropriate name.
  • max_submitted_headers refers to the number of unfinalized headers that the relay should submit in one batch but could be interpreted as coupled to max_submitted_blocks_by_account; headers_batch_size may be a more appropriate name.

Additionally, the variable light_client_updates_submission_frequency_in_epochs is specified to represent "N submissions per epoch," which is technically a period (the inverse of the frequency).

@sept-en sept-en added good first issue Good for newcomers enhancement rust Pull requests that update Rust code labels Sep 19, 2022
@olga24912
Copy link
Contributor

unfinalized_headers -- should be renamed in the Eth2 Light Client contract

@olga24912
Copy link
Contributor

submitters -- it is story about contract as well

@sept-en
Copy link
Contributor Author

sept-en commented Oct 4, 2022

@olga24912 exactly, that issue is about the contract.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue Good for newcomers rust Pull requests that update Rust code
Projects
None yet
Development

No branches or pull requests

3 participants