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

Update block docs / additional constructor renamings #3615

Merged
merged 4 commits into from
Aug 27, 2024

Conversation

scorbajio
Copy link
Contributor

This change updates the block package documentation with new function names for standalone constructor functions refactored in #3489.

- `Block.fromRPC(blockData: JsonRpcBlock, uncles?: any[], opts?: BlockOptions)`
- `Block.fromJsonRpcProvider(provider: string | EthersProvider, blockTag: string | bigint, opts: BlockOptions)`
- `createBlock(blockData: BlockData = {}, opts?: BlockOptions)`
- `createBlockFromRLPSerializedBlock(serialized: Uint8Array, opts?: BlockOptions)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, this has been forgotten to rename with the simplified name.

Will directly push here, also the code change.

@holgerd77 holgerd77 changed the title Update block docs with new static constructor function names Update block docs / additional constructor renamings Aug 27, 2024
Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 39.82%. Comparing base (4470cc3) to head (f54864f).
Report is 21 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

Flag Coverage Δ
block 66.82% <100.00%> (-6.64%) ⬇️
blockchain 84.92% <ø> (?)
client ?
common 89.68% <ø> (?)
devp2p 0.00% <ø> (?)
evm 64.78% <ø> (?)
genesis 0.00% <ø> (?)
statemanager 66.17% <ø> (?)
trie 52.05% <ø> (?)
tx ?
util 70.20% <ø> (?)
wallet ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Member

@holgerd77 holgerd77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@holgerd77 holgerd77 merged commit 6061e05 into master Aug 27, 2024
40 checks passed
@holgerd77 holgerd77 deleted the block-static-constructors-documentation-update branch August 27, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants