Merge pull request #278 from ethereumjs/new-release

New release v7.0.6

Author: holgerd77

CHANGELOG.md

@@ -6,7 +6,7 @@ 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).
 
-## [7.0.6] - [UNRELEASED]
+## [7.0.6] - 2020-10-07
 
 ### New `Account` class
 
@@ -31,21 +31,27 @@ const account = new Account(
 )
 ```
 
-For more info see the documentation or examples of usage in `test/account.spec.ts`.
+For more info see the documentation, examples of usage in `test/account.spec.ts` or
+PR [#275](https://github.com/ethereumjs/ethereumjs-util/pull/275).
 
 ### New export: TypeScript types
 
-A new file with helpful TypeScript types has been added to the exports of this project.
+A new file with helpful TypeScript types has been added to the exports of this project,
+see PR [#275](https://github.com/ethereumjs/ethereumjs-util/pull/275).
 
 In this release it contains `BNLike`, `BufferLike`, and `TransformableToBuffer`.
 
 ### Address.toBuffer()
 
-The Address class has as a new method `address.toBuffer()` that will give you a copy of the underlying `address.buf`.
+The Address class has as a new method `address.toBuffer()` that will give you a copy of the underlying `address.buf`
+(PR [#277](https://github.com/ethereumjs/ethereumjs-util/pull/277)).
 
 ### `toBuffer()` now converts TransformableToBuffer
 
-The `toBuffer()` exported function now additionally converts any object with a `toBuffer()` method.
+The `toBuffer()` exported function now additionally converts any object with a `toBuffer()` method
+(PR [#277](https://github.com/ethereumjs/ethereumjs-util/pull/277)).
+
+[7.0.6]: https://github.com/ethereumjs/ethereumjs-util/compare/v7.0.5...v7.0.6
 
 ## [7.0.5] - 2020-09-09
 

docs/classes/_account_.account.md

@@ -36,7 +36,7 @@
 
 *Defined in [account.ts:61](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L61)*
 
-This constructor takes the values, validates and assigns them.
+This constructor assigns and validates the values.
 Use the static factory methods to assist in creating an Account from varying data types.
 
 **Parameters:**
@@ -88,9 +88,9 @@ ___
 
 ▸ **isContract**(): *boolean*
 
-*Defined in [account.ts:96](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L96)*
+*Defined in [account.ts:106](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L106)*
 
-Returns a `Boolean` deteremining if the account is a contract.
+Returns a `Boolean` determining if the account is a contract.
 
 **Returns:** *boolean*
 
@@ -100,9 +100,11 @@ ___
 
 ▸ **isEmpty**(): *boolean*
 
-*Defined in [account.ts:103](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L103)*
+*Defined in [account.ts:115](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L115)*
 
 Returns a `Boolean` determining if the account is empty.
+For more details about account emptiness see [EIP-161](https://eips.ethereum.org/EIPS/eip-161).
+Note: The stateRoot is also checked to be empty since in Frontier it was possible to create a contract with no code where nonce remained 0 but some values were written to storage in the constructor (thus stateRoot is not KECCAK256_RLP).
 
 **Returns:** *boolean*
 
@@ -112,7 +114,7 @@ ___
 
 ▸ **serialize**(): *Buffer*
 
-*Defined in [account.ts:89](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L89)*
+*Defined in [account.ts:99](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L99)*
 
 Returns the RLP serialization of the account as a `Buffer`.
 

docs/classes/_address_.address.md

@@ -19,6 +19,7 @@
 ### Methods
 
 * [isZero](_address_.address.md#iszero)
+* [toBuffer](_address_.address.md#tobuffer)
 * [toString](_address_.address.md#tostring)
 * [fromPrivateKey](_address_.address.md#static-fromprivatekey)
 * [fromPublicKey](_address_.address.md#static-frompublickey)
@@ -65,6 +66,18 @@ Is address zero.
 
 ___
 
+###  toBuffer
+
+▸ **toBuffer**(): *Buffer*
+
+*Defined in [address.ts:95](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/address.ts#L95)*
+
+Returns Buffer representation of address.
+
+**Returns:** *Buffer*
+
+___
+
 ###  toString
 
 ▸ **toString**(): *string*

docs/interfaces/_types_.transformabletoarray.md

@@ -0,0 +1,34 @@
+[ethereumjs-util](../README.md) › ["types"](../modules/_types_.md) › [TransformableToArray](_types_.transformabletoarray.md)
+
+# Interface: TransformableToArray
+
+## Hierarchy
+
+* **TransformableToArray**
+
+## Index
+
+### Methods
+
+* [toArray](_types_.transformabletoarray.md#toarray)
+* [toBuffer](_types_.transformabletoarray.md#optional-tobuffer)
+
+## Methods
+
+###  toArray
+
+▸ **toArray**(): *Uint8Array*
+
+*Defined in [types.ts:30](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/types.ts#L30)*
+
+**Returns:** *Uint8Array*
+
+___
+
+### `Optional` toBuffer
+
+▸ **toBuffer**(): *Buffer*
+
+*Defined in [types.ts:31](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/types.ts#L31)*
+
+**Returns:** *Buffer*

docs/interfaces/_types_.transformabletobuffer.md

@@ -10,14 +10,25 @@
 
 ### Methods
 
+* [toArray](_types_.transformabletobuffer.md#optional-toarray)
 * [toBuffer](_types_.transformabletobuffer.md#tobuffer)
 
 ## Methods
 
+### `Optional` toArray
+
+▸ **toArray**(): *Uint8Array*
+
+*Defined in [types.ts:39](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/types.ts#L39)*
+
+**Returns:** *Uint8Array*
+
+___
+
 ###  toBuffer
 
 ▸ **toBuffer**(): *Buffer*
 
-*Defined in [types.ts:10](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/types.ts#L10)*
+*Defined in [types.ts:38](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/types.ts#L38)*
 
 **Returns:** *Buffer*

docs/modules/_account_.md

@@ -38,15 +38,15 @@
 
 • **publicToAddress**: *pubToAddress* = pubToAddress
 
-*Defined in [account.ts:246](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L246)*
+*Defined in [account.ts:258](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L258)*
 
 ## Functions
 
 ### `Const` generateAddress
 
 ▸ **generateAddress**(`from`: Buffer, `nonce`: Buffer): *Buffer*
 
-*Defined in [account.ts:168](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L168)*
+*Defined in [account.ts:180](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L180)*
 
 Generates an address of a newly created contract.
 
@@ -65,7 +65,7 @@ ___
 
 ▸ **generateAddress2**(`from`: Buffer, `salt`: Buffer, `initCode`: Buffer): *Buffer*
 
-*Defined in [account.ts:189](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L189)*
+*Defined in [account.ts:201](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L201)*
 
 Generates an address for a contract created using CREATE2.
 
@@ -85,7 +85,7 @@ ___
 
 ▸ **importPublic**(`publicKey`: Buffer): *Buffer*
 
-*Defined in [account.ts:269](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L269)*
+*Defined in [account.ts:281](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L281)*
 
 Converts a public key to the Ethereum format.
 
@@ -103,7 +103,7 @@ ___
 
 ▸ **isValidAddress**(`hexAddress`: string): *boolean*
 
-*Defined in [account.ts:116](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L116)*
+*Defined in [account.ts:128](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L128)*
 
 Checks if the address is a valid. Accepts checksummed addresses too.
 
@@ -121,7 +121,7 @@ ___
 
 ▸ **isValidChecksumAddress**(`hexAddress`: string, `eip1191ChainId?`: undefined | number): *boolean*
 
-*Defined in [account.ts:156](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L156)*
+*Defined in [account.ts:168](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L168)*
 
 Checks if the address is a valid checksummed address.
 
@@ -142,7 +142,7 @@ ___
 
 ▸ **isValidPrivate**(`privateKey`: Buffer): *boolean*
 
-*Defined in [account.ts:207](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L207)*
+*Defined in [account.ts:219](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L219)*
 
 Checks if the private key satisfies the rules of the curve secp256k1.
 
@@ -160,7 +160,7 @@ ___
 
 ▸ **isValidPublic**(`publicKey`: Buffer, `sanitize`: boolean): *boolean*
 
-*Defined in [account.ts:217](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L217)*
+*Defined in [account.ts:229](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L229)*
 
 Checks if the public key satisfies the rules of the curve secp256k1
 and the requirements of Ethereum.
@@ -180,9 +180,9 @@ ___
 
 ▸ **isZeroAddress**(`hexAddress`: string): *boolean*
 
-*Defined in [account.ts:289](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L289)*
+*Defined in [account.ts:301](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L301)*
 
-Checks if a given address is a zero address.
+Checks if a given address is the zero address.
 
 **Parameters:**
 
@@ -198,7 +198,7 @@ ___
 
 ▸ **privateToAddress**(`privateKey`: Buffer): *Buffer*
 
-*Defined in [account.ts:252](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L252)*
+*Defined in [account.ts:264](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L264)*
 
 Returns the ethereum address of a given private key.
 
@@ -216,7 +216,7 @@ ___
 
 ▸ **privateToPublic**(`privateKey`: Buffer): *Buffer*
 
-*Defined in [account.ts:260](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L260)*
+*Defined in [account.ts:272](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L272)*
 
 Returns the ethereum public key of a given private key.
 
@@ -234,7 +234,7 @@ ___
 
 ▸ **pubToAddress**(`pubKey`: Buffer, `sanitize`: boolean): *Buffer*
 
-*Defined in [account.ts:237](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L237)*
+*Defined in [account.ts:249](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L249)*
 
 Returns the ethereum address of a given public key.
 Accepts "Ethereum public keys" and SEC1 encoded keys.
@@ -254,13 +254,13 @@ ___
 
 ▸ **toChecksumAddress**(`hexAddress`: string, `eip1191ChainId?`: undefined | number): *string*
 
-*Defined in [account.ts:131](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L131)*
+*Defined in [account.ts:143](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L143)*
 
 Returns a checksummed address.
 
 If a eip1191ChainId is provided, the chainId will be included in the checksum calculation. This
 has the effect of checksummed addresses for one chain having invalid checksums for others.
-For more details, consult EIP-1191.
+For more details see [EIP-1191](https://eips.ethereum.org/EIPS/eip-1191).
 
 WARNING: Checksums with and without the chainId will differ. As of 2019-06-26, the most commonly
 used variation in Ethereum was without the chainId. This may change in the future.
@@ -280,8 +280,8 @@ ___
 
 ▸ **zeroAddress**(): *string*
 
-*Defined in [account.ts:280](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L280)*
+*Defined in [account.ts:292](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L292)*
 
-Returns a zero address.
+Returns the zero address.
 
 **Returns:** *string*