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

Update block docs / additional constructor renamings #3615

Merged
merged 4 commits into from
Aug 27, 2024
Merged

Update block docs / additional constructor renamings #3615

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
796d728
Update block docs with new constructor function names
scorbajio Aug 26, 2024
fd14417
Merge branch 'master' into block-static-constructors-documentation-up…
holgerd77 Aug 27, 2024
8a36d64
Rename createBlockFromRLPSerializedBlock -> createBlockFromRLP
holgerd77 Aug 27, 2024
f54864f
Rename blockHeaderFromRpc -> createBlockHeaderFromRPC
holgerd77 Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/block/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ npm install @ethereumjs/block

### Introduction

There are five static factories to instantiate a `Block`:
There are five standalone functions to instantiate a `Block`:

- `Block.fromBlockData(blockData: BlockData = {}, opts?: BlockOptions)`
- `Block.fromRLPSerializedBlock(serialized: Uint8Array, opts?: BlockOptions)`
- `Block.fromValuesArray(values: BlockBytes, opts?: BlockOptions)`
- `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.

- `createBlockFromBytesArray(values: BlockBytes, opts?: BlockOptions)`
- `createBlockFromRPC(blockParams: JsonRpcBlock, uncles?: any[], opts?: BlockOptions)`
- `createBlockFromJsonRPCProvider(provider: string | EthersProvider, blockTag: string | bigint, opts: BlockOptions)`

For `BlockHeader` instantiation analog factory methods exists, see API docs linked below.

Expand Down
Loading