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.

Sign up for GitHub

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

Jump to bottom

Rename HistoricBlockData to HistoricalBlockData #3471

Closed
kevaundray opened this issue Nov 29, 2023 · 1 comment · Fixed by #3476
Closed

Rename HistoricBlockData to HistoricalBlockData #3471

kevaundray opened this issue Nov 29, 2023 · 1 comment · Fixed by #3476
Assignees
@benesjan

Comments

@kevaundray
Copy link
Contributor

kevaundray commented Nov 29, 2023 •
edited
Loading

Problem

The meaning we want to convey here is that the data in the block is from the past which historic does not convey.

Solution

Rename historic to historical
@benesjan
Copy link
Contributor

benesjan commented Nov 29, 2023 •
edited
Loading

Thinking about this I am not sure I even like the "HistoricalBlockData" name because it doesn't have to be historical (it can be of latest block) and I don't think the use of "historical" makes sense.

It's like calling L2Block HistoricalL2Block just because it can be old.

In PrivateContext we call it just block_data.

It seems to me that based on the contents it would be much better to call it a block header because that it's exactly what it is called in other blockchains given that this data is a preimage to block hash:

"Each block within the blockchain is identified by a hash, generated using the SHA256 cryptographic hash algorithm on the header of the block. Each block also references a previous block, known as the parent block, through the “previous block hash” field in the block header."

@benesjan benesjan mentioned this issue Nov 29, 2023
Merged
4 tasks
benesjan added a commit that referenced this issue Nov 30, 2023
@benesjan
refactor: naming fixes (#3476)
1db30bf 
Fixes #3471

1. historic -> historical
2. `HistoricBlockData`  -> `BlockHeader`
3. `Historic Blocks Tree` -> `Blocks Tree`
4. Blocks Tree was sometimes incorrectly referred to as Blocks Tree
Roots so I fixed that in [this
commit](8c9ae59).
5. Rewrote documentation of `perform_blocks_tree_membership_checks` in
[this
commit](8c9ae59)
as it was confusing.
6. Fixed some stale naming of note hash tree (private data tree)
AztecBot pushed a commit to AztecProtocol/aztec-nr that referenced this issue Dec 2, 2023
@benesjan @AztecBot
refactor: naming fixes (#3476)
3d2aba3 
Fixes AztecProtocol/aztec-packages#3471

1. historic -> historical
2. `HistoricBlockData`  -> `BlockHeader`
3. `Historic Blocks Tree` -> `Blocks Tree`
4. Blocks Tree was sometimes incorrectly referred to as Blocks Tree
Roots so I fixed that in [this
commit](AztecProtocol/aztec-packages@8c9ae59).
5. Rewrote documentation of `perform_blocks_tree_membership_checks` in
[this
commit](AztecProtocol/aztec-packages@8c9ae59)
as it was confusing.
6. Fixed some stale naming of note hash tree (private data tree)
superstar0402 added a commit to superstar0402/aztec-nr that referenced this issue Aug 16, 2024
@superstar0402
refactor: naming fixes (#3476)
bda0fd9 
Fixes AztecProtocol/aztec-packages#3471

1. historic -> historical
2. `HistoricBlockData`  -> `BlockHeader`
3. `Historic Blocks Tree` -> `Blocks Tree`
4. Blocks Tree was sometimes incorrectly referred to as Blocks Tree
Roots so I fixed that in [this
commit](AztecProtocol/aztec-packages@8c9ae59).
5. Rewrote documentation of `perform_blocks_tree_membership_checks` in
[this
commit](AztecProtocol/aztec-packages@8c9ae59)
as it was confusing.
6. Fixed some stale naming of note hash tree (private data tree)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@benesjan benesjan

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor: naming fixes AztecProtocol/aztec-packages
2 participants
@benesjan @kevaundray