Skip to content

Commit

Permalink
beta.1 release: rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
holgerd77 committed Oct 21, 2020
1 parent af0f76e commit 8324e9e
Show file tree
Hide file tree
Showing 170 changed files with 10,848 additions and 6,317 deletions.
266 changes: 181 additions & 85 deletions packages/block/docs/classes/_block_.block.md

Large diffs are not rendered by default.

248 changes: 172 additions & 76 deletions packages/block/docs/classes/_header_.blockheader.md

Large diffs are not rendered by default.

266 changes: 181 additions & 85 deletions packages/block/docs/classes/_index_.block.md

Large diffs are not rendered by default.

248 changes: 172 additions & 76 deletions packages/block/docs/classes/_index_.blockheader.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/block/docs/interfaces/_index_.blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

**getBlock**(`hash`: Buffer): *Promise‹[Block](../classes/_block_.block.md)*

*Defined in [types.ts:75](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L75)*
*Defined in [types.ts:113](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L113)*

**Parameters:**

Expand Down
14 changes: 8 additions & 6 deletions packages/block/docs/interfaces/_index_.blockdata.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,24 @@ A block's data.

### `Optional` header

**header**? : *Buffer | [PrefixedHexString](../modules/_index_.md#prefixedhexstring) | [BufferLike](../modules/_index_.md#bufferlike)[] | [BlockHeaderData](_index_.blockheaderdata.md)*
**header**? : *[HeaderData](_index_.headerdata.md)*

*Defined in [types.ts:69](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L69)*
*Defined in [types.ts:68](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L68)*

Header data for the block

___

### `Optional` transactions

**transactions**? : *Array‹Buffer | [PrefixedHexString](../modules/_index_.md#prefixedhexstring) | [BufferLike](../modules/_index_.md#bufferlike)[] | TxData›*
**transactions**? : *Array‹TxData›*

*Defined in [types.ts:70](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L70)*
*Defined in [types.ts:69](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L69)*

___

### `Optional` uncleHeaders

**uncleHeaders**? : *Array‹Buffer | [PrefixedHexString](../modules/_index_.md#prefixedhexstring) | [BufferLike](../modules/_index_.md#bufferlike)[] | [BlockHeaderData](_index_.blockheaderdata.md)*
**uncleHeaders**? : *Array‹[HeaderData](_index_.headerdata.md)*

*Defined in [types.ts:71](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L71)*
*Defined in [types.ts:70](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L70)*
149 changes: 0 additions & 149 deletions packages/block/docs/interfaces/_index_.blockheaderdata.md

This file was deleted.

63 changes: 63 additions & 0 deletions packages/block/docs/interfaces/_index_.blockoptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
[@ethereumjs/block](../README.md)["index"](../modules/_index_.md)[BlockOptions](_index_.blockoptions.md)

# Interface: BlockOptions

An object to set to which blockchain the blocks and their headers belong. This could be specified
using a Common object, or `chain` and `hardfork`. Defaults to mainnet without specifying a
hardfork.

## Hierarchy

* **BlockOptions**

## Index

### Properties

* [common](_index_.blockoptions.md#optional-common)
* [hardforkByBlockNumber](_index_.blockoptions.md#optional-hardforkbyblocknumber)
* [initWithGenesisHeader](_index_.blockoptions.md#optional-initwithgenesisheader)

## Properties

### `Optional` common

**common**? : *Common*

*Defined in [types.ts:20](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L20)*

A Common object defining the chain and the hardfork a block/block header belongs to.

Default: `Common` object set to `mainnet` and the HF currently defined as the default
hardfork in the `Common` class.

Current default hardfork: `istanbul`

___

### `Optional` hardforkByBlockNumber

**hardforkByBlockNumber**? : *undefined | false | true*

*Defined in [types.ts:26](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L26)*

Determine the HF by the block number

Default: `false` (HF is set to whatever default HF is set by the Common instance)

___

### `Optional` initWithGenesisHeader

**initWithGenesisHeader**? : *undefined | false | true*

*Defined in [types.ts:37](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/src/types.ts#L37)*

Turns the block header into the canonical genesis block header

If set to `true` all other header data is ignored.

If a Common instance is passed the instance need to be set to `chainstart` as a HF,
otherwise usage of this option will throw

Default: `false`
49 changes: 0 additions & 49 deletions packages/block/docs/interfaces/_index_.chainoptions.md

This file was deleted.

Loading

0 comments on commit 8324e9e

Please sign in to comment.