Skip to content

Commit

Permalink
docs: generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
evertonfraga committed Jun 5, 2020
1 parent 56a8731 commit 282fdfb
Show file tree
Hide file tree
Showing 13 changed files with 1,013 additions and 220 deletions.
1 change: 1 addition & 0 deletions packages/vm/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@
* ["runCode"](modules/_runcode_.md)
* ["runTx"](modules/_runtx_.md)
* ["state/index"](modules/_state_index_.md)
* ["state/interface"](modules/_state_interface_.md)
* ["state/stateManager"](modules/_state_statemanager_.md)
34 changes: 17 additions & 17 deletions packages/vm/docs/classes/_index_.vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This class is an AsyncEventEmitter, please consult the README to learn how to us

\+ **new VM**(`opts`: [VMOpts](../interfaces/_index_.vmopts.md)): *[VM](_index_.vm.md)*

*Defined in [index.ts:84](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L84)*
*Defined in [index.ts:86](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L86)*

Instantiates a new [VM](_index_.vm.md) Object.

Expand All @@ -64,15 +64,15 @@ Name | Type | Default | Description |

**_common**: *Common*

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

___

### _emit

**_emit**: *function*

*Defined in [index.ts:73](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L73)*
*Defined in [index.ts:74](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L74)*

#### Type declaration:

Expand All @@ -91,47 +91,47 @@ ___

**_opcodes**: *OpcodeList*

*Defined in [index.ts:72](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L72)*
*Defined in [index.ts:73](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L73)*

___

### allowUnlimitedContractSize

**allowUnlimitedContractSize**: *boolean*

*Defined in [index.ts:71](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L71)*
*Defined in [index.ts:72](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L72)*

___

### blockchain

**blockchain**: *Blockchain*

*Defined in [index.ts:70](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L70)*
*Defined in [index.ts:71](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L71)*

___

### opts

**opts**: *[VMOpts](../interfaces/_index_.vmopts.md)*

*Defined in [index.ts:67](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L67)*
*Defined in [index.ts:68](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L68)*

___

### stateManager

**stateManager**: *[StateManager](_state_index_.statemanager.md)*
**stateManager**: *[StateManager](../interfaces/_state_index_.statemanager.md)*

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

## Methods

### copy

**copy**(): *[VM](_index_.vm.md)*

*Defined in [index.ts:220](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L220)*
*Defined in [index.ts:223](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L223)*

Returns a copy of the [VM](_index_.vm.md) instance.

Expand All @@ -143,7 +143,7 @@ ___

**init**(): *Promise‹void›*

*Defined in [index.ts:140](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L140)*
*Defined in [index.ts:143](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L143)*

**Returns:** *Promise‹void›*

Expand All @@ -153,7 +153,7 @@ ___

**runBlock**(`opts`: [RunBlockOpts](../interfaces/_runblock_.runblockopts.md)): *Promise‹[RunBlockResult](../interfaces/_runblock_.runblockresult.md)*

*Defined in [index.ts:180](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L180)*
*Defined in [index.ts:183](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L183)*

Processes the `block` running all of the transactions it contains and updating the miner's account

Expand All @@ -175,7 +175,7 @@ ___

**runBlockchain**(`blockchain`: any): *Promise‹void›*

*Defined in [index.ts:165](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L165)*
*Defined in [index.ts:168](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L168)*

Processes blocks and adds them to the blockchain.

Expand All @@ -195,7 +195,7 @@ ___

**runCall**(`opts`: [RunCallOpts](../interfaces/_runcall_.runcallopts.md)): *Promise‹[EVMResult](../interfaces/_evm_evm_.evmresult.md)*

*Defined in [index.ts:202](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L202)*
*Defined in [index.ts:205](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L205)*

runs a call (or create) operation.

Expand All @@ -215,7 +215,7 @@ ___

**runCode**(`opts`: [RunCodeOpts](../interfaces/_runcode_.runcodeopts.md)): *Promise‹[ExecResult](../interfaces/_evm_evm_.execresult.md)*

*Defined in [index.ts:212](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L212)*
*Defined in [index.ts:215](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L215)*

Runs EVM code.

Expand All @@ -235,7 +235,7 @@ ___

**runTx**(`opts`: [RunTxOpts](../interfaces/_runtx_.runtxopts.md)): *Promise‹[RunTxResult](../interfaces/_runtx_.runtxresult.md)*

*Defined in [index.ts:192](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L192)*
*Defined in [index.ts:195](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L195)*

Process a transaction. Run the vm. Transfers eth. Checks balances.

Expand All @@ -257,7 +257,7 @@ ___

**create**(`opts`: [VMOpts](../interfaces/_index_.vmopts.md)): *Promise‹[VM](_index_.vm.md)*

*Defined in [index.ts:80](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L80)*
*Defined in [index.ts:82](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/vm/lib/index.ts#L82)*

VM async constructor. Creates engine instance and initializes it.

Expand Down
Loading

0 comments on commit 282fdfb

Please sign in to comment.