Regenerated the documentation

docs/README.md

@@ -17,6 +17,7 @@
 
 * [EVMResult](interfaces/evmresult.md)
 * [ExecResult](interfaces/execresult.md)
+* [NewContractEvent](interfaces/newcontractevent.md)
 * [RunBlockOpts](interfaces/runblockopts.md)
 * [RunBlockResult](interfaces/runblockresult.md)
 * [RunCallOpts](interfaces/runcallopts.md)
@@ -28,5 +29,29 @@
 * [TxReceipt](interfaces/txreceipt.md)
 * [VMOpts](interfaces/vmopts.md)
 
+### Functions
+
+* [OOGResult](#oogresult)
+
 ---
 
+## Functions
+
+<a id="oogresult"></a>
+
+###  OOGResult
+
+▸ **OOGResult**(gasLimit: *`BN`*): [ExecResult](interfaces/execresult.md)
+
+*Defined in [evm/evm.ts:80](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/evm/evm.ts#L80)*
+
+**Parameters:**
+
+| Name | Type |
+| ------ | ------ |
+| gasLimit | `BN` |
+
+**Returns:** [ExecResult](interfaces/execresult.md)
+
+___
+

docs/classes/vm.md

@@ -4,6 +4,8 @@
 
 Execution engine which can be used to run a blockchain, individual blocks, individual transactions, or snippets of EVM bytecode.
 
+This class is an AsyncEventEmitter, which means that event handlers are run to completion before continuing. If an error is thrown in an event handler, it will bubble up to the VM and thrown from the method call that triggered the event.
+
 ## Hierarchy
 
  `any`
@@ -19,6 +21,7 @@ Execution engine which can be used to run a blockchain, individual blocks, indiv
 ### Properties
 
 * [_common](vm.md#_common)
+* [_opcodes](vm.md#_opcodes)
 * [allowUnlimitedContractSize](vm.md#allowunlimitedcontractsize)
 * [blockchain](vm.md#blockchain)
 * [opts](vm.md#opts)
@@ -44,7 +47,7 @@ Execution engine which can be used to run a blockchain, individual blocks, indiv
 
 ⊕ **new VM**(opts?: *[VMOpts](../interfaces/vmopts.md)*): [VM](vm.md)
 
-*Defined in [index.ts:61](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L61)*
+*Defined in [index.ts:74](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L74)*
 
 Instantiates a new [VM](vm.md) Object.
 
@@ -66,7 +69,16 @@ ___
 
 **● _common**: *`Common`*
 
-*Defined in [index.ts:58](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L58)*
+*Defined in [index.ts:70](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L70)*
+
+___
+<a id="_opcodes"></a>
+
+###  _opcodes
+
+**● _opcodes**: *`OpcodeList`*
+
+*Defined in [index.ts:74](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L74)*
 
 ___
 <a id="allowunlimitedcontractsize"></a>
@@ -75,16 +87,16 @@ ___
 
 **● allowUnlimitedContractSize**: *`boolean`*
 
-*Defined in [index.ts:61](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L61)*
+*Defined in [index.ts:73](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L73)*
 
 ___
 <a id="blockchain"></a>
 
 ###  blockchain
 
-**● blockchain**: *`any`*
+**● blockchain**: *`Blockchain`*
 
-*Defined in [index.ts:60](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L60)*
+*Defined in [index.ts:72](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L72)*
 
 ___
 <a id="opts"></a>
@@ -93,7 +105,7 @@ ___
 
 **● opts**: *[VMOpts](../interfaces/vmopts.md)*
 
-*Defined in [index.ts:57](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L57)*
+*Defined in [index.ts:69](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L69)*
 
 ___
 <a id="statemanager"></a>
@@ -102,7 +114,7 @@ ___
 
 **● stateManager**: *[StateManager](statemanager.md)*
 
-*Defined in [index.ts:59](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L59)*
+*Defined in [index.ts:71](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L71)*
 
 ___
 
@@ -114,7 +126,7 @@ ___
 
 ▸ **_emit**(topic: *`string`*, data: *`any`*): `Promise`<`any`>
 
-*Defined in [index.ts:160](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L160)*
+*Defined in [index.ts:192](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L192)*
 
 **Parameters:**
 
@@ -132,7 +144,7 @@ ___
 
 ▸ **copy**(): [VM](vm.md)
 
-*Defined in [index.ts:152](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L152)*
+*Defined in [index.ts:184](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L184)*
 
 Returns a copy of the [VM](vm.md) instance.
 
@@ -145,10 +157,12 @@ ___
 
 ▸ **runBlock**(opts: *[RunBlockOpts](../interfaces/runblockopts.md)*): `Promise`<[RunBlockResult](../interfaces/runblockresult.md)>
 
-*Defined in [index.ts:124](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L124)*
+*Defined in [index.ts:148](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L148)*
 
 Processes the `block` running all of the transactions it contains and updating the miner's account
 
+This method modifies the state. If `generate` is `true`, the state modifications will be reverted if an exception is raised. If it's `false`, it won't revert if the block's header is invalid. If an error is thrown from an event handler, the state may or may not be reverted.
+
 **Parameters:**
 
 | Name | Type | Description |
@@ -164,10 +178,12 @@ ___
 
 ▸ **runBlockchain**(blockchain: *`any`*): `Promise`<`void`>
 
-*Defined in [index.ts:115](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L115)*
+*Defined in [index.ts:134](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L134)*
 
 Processes blocks and adds them to the blockchain.
 
+This method modifies the state.
+
 **Parameters:**
 
 | Name | Type | Description |
@@ -183,10 +199,12 @@ ___
 
 ▸ **runCall**(opts: *[RunCallOpts](../interfaces/runcallopts.md)*): `Promise`<[EVMResult](../interfaces/evmresult.md)>
 
-*Defined in [index.ts:138](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L138)*
+*Defined in [index.ts:168](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L168)*
 
 runs a call (or create) operation.
 
+This method modifies the state.
+
 **Parameters:**
 
 | Name | Type |
@@ -202,10 +220,12 @@ ___
 
 ▸ **runCode**(opts: *[RunCodeOpts](../interfaces/runcodeopts.md)*): `Promise`<[ExecResult](../interfaces/execresult.md)>
 
-*Defined in [index.ts:145](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L145)*
+*Defined in [index.ts:177](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L177)*
 
 Runs EVM code.
 
+This method modifies the state.
+
 **Parameters:**
 
 | Name | Type |
@@ -221,10 +241,12 @@ ___
 
 ▸ **runTx**(opts: *[RunTxOpts](../interfaces/runtxopts.md)*): `Promise`<[RunTxResult](../interfaces/runtxresult.md)>
 
-*Defined in [index.ts:131](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/index.ts#L131)*
+*Defined in [index.ts:159](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/index.ts#L159)*
 
 Process a transaction. Run the vm. Transfers eth. Checks balances.
 
+This method modifies the state. If an error is thrown, the modifications are reverted, except when the error is thrown from an event handler. In the latter case the state may or may not be reverted.
+
 **Parameters:**
 
 | Name | Type |

docs/classes/vmerror.md

@@ -27,7 +27,7 @@
 
 ⊕ **new VmError**(error: *[ERROR](../enums/error.md)*): [VmError](vmerror.md)
 
-*Defined in [exceptions.ts:17](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L17)*
+*Defined in [exceptions.ts:18](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L18)*
 
 **Parameters:**
 
@@ -47,7 +47,7 @@ ___
 
 **● error**: *[ERROR](../enums/error.md)*
 
-*Defined in [exceptions.ts:16](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L16)*
+*Defined in [exceptions.ts:17](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L17)*
 
 ___
 <a id="errortype"></a>
@@ -56,7 +56,7 @@ ___
 
 **● errorType**: *`string`*
 
-*Defined in [exceptions.ts:17](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L17)*
+*Defined in [exceptions.ts:18](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L18)*
 
 ___
 

docs/enums/error.md

@@ -12,6 +12,7 @@
 * [INVALID_OPCODE](error.md#invalid_opcode)
 * [OUT_OF_GAS](error.md#out_of_gas)
 * [OUT_OF_RANGE](error.md#out_of_range)
+* [REFUND_EXHAUSTED](error.md#refund_exhausted)
 * [REVERT](error.md#revert)
 * [STACK_OVERFLOW](error.md#stack_overflow)
 * [STACK_UNDERFLOW](error.md#stack_underflow)
@@ -28,7 +29,7 @@
 
 **CREATE_COLLISION**:  = "create collision"
 
-*Defined in [exceptions.ts:11](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L11)*
+*Defined in [exceptions.ts:11](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L11)*
 
 ___
 <a id="internal_error"></a>
@@ -37,7 +38,7 @@ ___
 
 **INTERNAL_ERROR**:  = "internal error"
 
-*Defined in [exceptions.ts:10](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L10)*
+*Defined in [exceptions.ts:10](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L10)*
 
 ___
 <a id="invalid_jump"></a>
@@ -46,7 +47,7 @@ ___
 
 **INVALID_JUMP**:  = "invalid JUMP"
 
-*Defined in [exceptions.ts:5](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L5)*
+*Defined in [exceptions.ts:5](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L5)*
 
 ___
 <a id="invalid_opcode"></a>
@@ -55,7 +56,7 @@ ___
 
 **INVALID_OPCODE**:  = "invalid opcode"
 
-*Defined in [exceptions.ts:6](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L6)*
+*Defined in [exceptions.ts:6](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L6)*
 
 ___
 <a id="out_of_gas"></a>
@@ -64,7 +65,7 @@ ___
 
 **OUT_OF_GAS**:  = "out of gas"
 
-*Defined in [exceptions.ts:2](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L2)*
+*Defined in [exceptions.ts:2](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L2)*
 
 ___
 <a id="out_of_range"></a>
@@ -73,7 +74,16 @@ ___
 
 **OUT_OF_RANGE**:  = "value out of range"
 
-*Defined in [exceptions.ts:7](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L7)*
+*Defined in [exceptions.ts:7](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L7)*
+
+___
+<a id="refund_exhausted"></a>
+
+###  REFUND_EXHAUSTED
+
+**REFUND_EXHAUSTED**:  = "refund exhausted"
+
+*Defined in [exceptions.ts:13](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L13)*
 
 ___
 <a id="revert"></a>
@@ -82,7 +92,7 @@ ___
 
 **REVERT**:  = "revert"
 
-*Defined in [exceptions.ts:8](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L8)*
+*Defined in [exceptions.ts:8](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L8)*
 
 ___
 <a id="stack_overflow"></a>
@@ -91,7 +101,7 @@ ___
 
 **STACK_OVERFLOW**:  = "stack overflow"
 
-*Defined in [exceptions.ts:4](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L4)*
+*Defined in [exceptions.ts:4](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L4)*
 
 ___
 <a id="stack_underflow"></a>
@@ -100,7 +110,7 @@ ___
 
 **STACK_UNDERFLOW**:  = "stack underflow"
 
-*Defined in [exceptions.ts:3](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L3)*
+*Defined in [exceptions.ts:3](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L3)*
 
 ___
 <a id="static_state_change"></a>
@@ -109,7 +119,7 @@ ___
 
 **STATIC_STATE_CHANGE**:  = "static state change"
 
-*Defined in [exceptions.ts:9](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L9)*
+*Defined in [exceptions.ts:9](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L9)*
 
 ___
 <a id="stop"></a>
@@ -118,7 +128,7 @@ ___
 
 **STOP**:  = "stop"
 
-*Defined in [exceptions.ts:12](https://github.com/ethereumjs/ethereumjs-vm/blob/3e1633c/lib/exceptions.ts#L12)*
+*Defined in [exceptions.ts:12](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/exceptions.ts#L12)*
 
 ___