Merge pull request #956 from ethereumjs/public-td-method

Public Blockchain.getTotalDifficulty() method

packages/blockchain/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 (modification: no type change headlines) and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 5.0.0-rc.1 UNRELEASED
+
+- Exposed private `Blockchain._getTd()` total difficulty function as `Blockchain.getTotalDifficulty()`, PR [#956](https://github.com/ethereumjs/ethereumjs-vm/issues/956)
+
 ## 5.0.0-beta.2 - 2020-11-12
 
 This is the second beta release towards a final library release, see [beta.1 release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/%40ethereumjs%2Fblockchain%405.0.0-beta.1) for an overview on the full changes since the last publicly released version.

packages/blockchain/docs/README.md

@@ -6,4 +6,9 @@
 
 ### Modules
 
+* ["db/cache"](modules/_db_cache_.md)
+* ["db/constants"](modules/_db_constants_.md)
+* ["db/helpers"](modules/_db_helpers_.md)
+* ["db/manager"](modules/_db_manager_.md)
+* ["db/operation"](modules/_db_operation_.md)
 * ["index"](modules/_index_.md)

packages/blockchain/docs/classes/_db_helpers_.dbop.md

@@ -0,0 +1,116 @@
+[@ethereumjs/blockchain](../README.md) › ["db/helpers"](../modules/_db_helpers_.md) › [DBOp](_db_helpers_.dbop.md)
+
+# Class: DBOp
+
+The DBOp class aids creating database operations which is used by `level` using a more high-level interface
+
+## Hierarchy
+
+* **DBOp**
+
+## Index
+
+### Properties
+
+* [baseDBOp](_db_helpers_.dbop.md#basedbop)
+* [cacheString](_db_helpers_.dbop.md#cachestring)
+* [operationTarget](_db_helpers_.dbop.md#operationtarget)
+
+### Methods
+
+* [updateCache](_db_helpers_.dbop.md#updatecache)
+* [del](_db_helpers_.dbop.md#static-del)
+* [get](_db_helpers_.dbop.md#static-get)
+* [set](_db_helpers_.dbop.md#static-set)
+
+## Properties
+
+###  baseDBOp
+
+• **baseDBOp**: *DBOpData*
+
+*Defined in [db/operation.ts:49](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L49)*
+
+___
+
+###  cacheString
+
+• **cacheString**: *string | undefined*
+
+*Defined in [db/operation.ts:50](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L50)*
+
+___
+
+###  operationTarget
+
+• **operationTarget**: *[DBTarget](../enums/_db_operation_.dbtarget.md)*
+
+*Defined in [db/operation.ts:48](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L48)*
+
+## Methods
+
+###  updateCache
+
+▸ **updateCache**(`cacheMap`: [CacheMap](../modules/_db_manager_.md#cachemap)): *void*
+
+*Defined in [db/operation.ts:128](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L128)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`cacheMap` | [CacheMap](../modules/_db_manager_.md#cachemap) |
+
+**Returns:** *void*
+
+___
+
+### `Static` del
+
+▸ **del**(`operationTarget`: [DBTarget](../enums/_db_operation_.dbtarget.md), `key?`: [DatabaseKey](../modules/_db_operation_.md#databasekey)): *[DBOp](_db_helpers_.dbop.md)*
+
+*Defined in [db/operation.ts:122](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L122)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`operationTarget` | [DBTarget](../enums/_db_operation_.dbtarget.md) |
+`key?` | [DatabaseKey](../modules/_db_operation_.md#databasekey) |
+
+**Returns:** *[DBOp](_db_helpers_.dbop.md)*
+
+___
+
+### `Static` get
+
+▸ **get**(`operationTarget`: [DBTarget](../enums/_db_operation_.dbtarget.md), `key?`: [DatabaseKey](../modules/_db_operation_.md#databasekey)): *[DBOp](_db_helpers_.dbop.md)*
+
+*Defined in [db/operation.ts:103](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L103)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`operationTarget` | [DBTarget](../enums/_db_operation_.dbtarget.md) |
+`key?` | [DatabaseKey](../modules/_db_operation_.md#databasekey) |
+
+**Returns:** *[DBOp](_db_helpers_.dbop.md)*
+
+___
+
+### `Static` set
+
+▸ **set**(`operationTarget`: [DBTarget](../enums/_db_operation_.dbtarget.md), `value`: Buffer | object, `key?`: [DatabaseKey](../modules/_db_operation_.md#databasekey)): *[DBOp](_db_helpers_.dbop.md)*
+
+*Defined in [db/operation.ts:108](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L108)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`operationTarget` | [DBTarget](../enums/_db_operation_.dbtarget.md) |
+`value` | Buffer | object |
+`key?` | [DatabaseKey](../modules/_db_operation_.md#databasekey) |
+
+**Returns:** *[DBOp](_db_helpers_.dbop.md)*

packages/blockchain/docs/classes/_db_operation_.dbop.md

@@ -0,0 +1,116 @@
+[@ethereumjs/blockchain](../README.md) › ["db/operation"](../modules/_db_operation_.md) › [DBOp](_db_operation_.dbop.md)
+
+# Class: DBOp
+
+The DBOp class aids creating database operations which is used by `level` using a more high-level interface
+
+## Hierarchy
+
+* **DBOp**
+
+## Index
+
+### Properties
+
+* [baseDBOp](_db_operation_.dbop.md#basedbop)
+* [cacheString](_db_operation_.dbop.md#cachestring)
+* [operationTarget](_db_operation_.dbop.md#operationtarget)
+
+### Methods
+
+* [updateCache](_db_operation_.dbop.md#updatecache)
+* [del](_db_operation_.dbop.md#static-del)
+* [get](_db_operation_.dbop.md#static-get)
+* [set](_db_operation_.dbop.md#static-set)
+
+## Properties
+
+###  baseDBOp
+
+• **baseDBOp**: *DBOpData*
+
+*Defined in [db/operation.ts:49](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L49)*
+
+___
+
+###  cacheString
+
+• **cacheString**: *string | undefined*
+
+*Defined in [db/operation.ts:50](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L50)*
+
+___
+
+###  operationTarget
+
+• **operationTarget**: *[DBTarget](../enums/_db_operation_.dbtarget.md)*
+
+*Defined in [db/operation.ts:48](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L48)*
+
+## Methods
+
+###  updateCache
+
+▸ **updateCache**(`cacheMap`: [CacheMap](../modules/_db_manager_.md#cachemap)): *void*
+
+*Defined in [db/operation.ts:128](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L128)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`cacheMap` | [CacheMap](../modules/_db_manager_.md#cachemap) |
+
+**Returns:** *void*
+
+___
+
+### `Static` del
+
+▸ **del**(`operationTarget`: [DBTarget](../enums/_db_operation_.dbtarget.md), `key?`: [DatabaseKey](../modules/_db_operation_.md#databasekey)): *[DBOp](_db_helpers_.dbop.md)*
+
+*Defined in [db/operation.ts:122](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L122)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`operationTarget` | [DBTarget](../enums/_db_operation_.dbtarget.md) |
+`key?` | [DatabaseKey](../modules/_db_operation_.md#databasekey) |
+
+**Returns:** *[DBOp](_db_helpers_.dbop.md)*
+
+___
+
+### `Static` get
+
+▸ **get**(`operationTarget`: [DBTarget](../enums/_db_operation_.dbtarget.md), `key?`: [DatabaseKey](../modules/_db_operation_.md#databasekey)): *[DBOp](_db_helpers_.dbop.md)*
+
+*Defined in [db/operation.ts:103](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L103)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`operationTarget` | [DBTarget](../enums/_db_operation_.dbtarget.md) |
+`key?` | [DatabaseKey](../modules/_db_operation_.md#databasekey) |
+
+**Returns:** *[DBOp](_db_helpers_.dbop.md)*
+
+___
+
+### `Static` set
+
+▸ **set**(`operationTarget`: [DBTarget](../enums/_db_operation_.dbtarget.md), `value`: Buffer | object, `key?`: [DatabaseKey](../modules/_db_operation_.md#databasekey)): *[DBOp](_db_helpers_.dbop.md)*
+
+*Defined in [db/operation.ts:108](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/blockchain/src/db/operation.ts#L108)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`operationTarget` | [DBTarget](../enums/_db_operation_.dbtarget.md) |
+`value` | Buffer | object |
+`key?` | [DatabaseKey](../modules/_db_operation_.md#databasekey) |
+
+**Returns:** *[DBOp](_db_helpers_.dbop.md)*