Add Account class and tests

CHANGELOG.md

@@ -8,7 +8,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
 ## [7.0.6] - [UNRELEASED]
 
-[ ADD REFERENCES TO YOUR WORK HERE UPON PRs. PLEASE ADOPT THE VERSION IF YOUR PR REQUIRES. ]
+This release adds a new `Account` class intended as a modern replacement for `ethereumjs-account`. It has a shape of `Account(nonce?: BN, balance?: BN, stateRoot?: Buffer, codeHash?: Buffer)`. The static factory methods assist in creating an `Account` object from varying data types: `Object: fromAccountData`, `RLP: fromRlpSerializedAccount`, and `Array: fromValuesArray`.
+
+Example usage:
+
+```typescript
+import { Account, BN } from 'ethereumjs-util'
+
+const account = new Account(
+  new BN(0), // nonce, default: 0
+  new BN(1).pow(18), // balance, default: 0
+  undefined, // stateRoot, default: KECCAK256_RLP (hash of RLP of null)
+  undefined, // codeHash, default: KECCAK256_NULL (hash of null)
+)
+```
+
+For more examples see `test/account.spec.ts`.
 
 ## [7.0.5] - 2020-09-09
 

README.md

@@ -32,6 +32,7 @@ assert.equal(new BN('dead', 16).add(new BN('101010', 2)), 57047)
 ### Modules
 
 - [account](docs/modules/_account_.md)
+  - Account class
   - Private/public key and address-related functionality (creation, validation, conversion)
 - [address](docs/modules/_address_.md)
   - Address class and type

docs/README.md

@@ -6,6 +6,7 @@
 
 ### Modules
 
+* ["@types/ethjs-util/index"](modules/__types_ethjs_util_index_.md)
 * ["account"](modules/_account_.md)
 * ["address"](modules/_address_.md)
 * ["bytes"](modules/_bytes_.md)

docs/classes/_account_.account.md

@@ -0,0 +1,167 @@
+[ethereumjs-util](../README.md) › ["account"](../modules/_account_.md) › [Account](_account_.account.md)
+
+# Class: Account
+
+## Hierarchy
+
+* **Account**
+
+## Index
+
+### Constructors
+
+* [constructor](_account_.account.md#constructor)
+
+### Properties
+
+* [balance](_account_.account.md#balance)
+* [codeHash](_account_.account.md#codehash)
+* [nonce](_account_.account.md#nonce)
+* [stateRoot](_account_.account.md#stateroot)
+
+### Methods
+
+* [isContract](_account_.account.md#iscontract)
+* [isEmpty](_account_.account.md#isempty)
+* [serialize](_account_.account.md#serialize)
+* [fromAccountData](_account_.account.md#static-fromaccountdata)
+* [fromRlpSerializedAccount](_account_.account.md#static-fromrlpserializedaccount)
+* [fromValuesArray](_account_.account.md#static-fromvaluesarray)
+
+## Constructors
+
+###  constructor
+
+\+ **new Account**(`nonce`: BN‹›, `balance`: BN‹›, `stateRoot`: Buffer‹›, `codeHash`: Buffer‹›): *[Account](_account_.account.md)*
+
+*Defined in [account.ts:77](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L77)*
+
+This constructor takes the values, validates and assigns them.
+Use the static factory methods to assist in creating an Account from varying data types.
+
+**Parameters:**
+
+Name | Type | Default |
+------ | ------ | ------ |
+`nonce` | BN‹› | new BN(0) |
+`balance` | BN‹› | new BN(0) |
+`stateRoot` | Buffer‹› | KECCAK256_RLP |
+`codeHash` | Buffer‹› | KECCAK256_NULL |
+
+**Returns:** *[Account](_account_.account.md)*
+
+## Properties
+
+###  balance
+
+• **balance**: *BN*
+
+*Defined in [account.ts:43](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L43)*
+
+___
+
+###  codeHash
+
+• **codeHash**: *Buffer*
+
+*Defined in [account.ts:45](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L45)*
+
+___
+
+###  nonce
+
+• **nonce**: *BN*
+
+*Defined in [account.ts:42](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L42)*
+
+___
+
+###  stateRoot
+
+• **stateRoot**: *Buffer*
+
+*Defined in [account.ts:44](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L44)*
+
+## Methods
+
+###  isContract
+
+▸ **isContract**(): *boolean*
+
+*Defined in [account.ts:112](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L112)*
+
+Returns a `Boolean` deteremining if the account is a contract.
+
+**Returns:** *boolean*
+
+___
+
+###  isEmpty
+
+▸ **isEmpty**(): *boolean*
+
+*Defined in [account.ts:119](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L119)*
+
+Returns a `Boolean` determining if the account is empty.
+
+**Returns:** *boolean*
+
+___
+
+###  serialize
+
+▸ **serialize**(): *Buffer*
+
+*Defined in [account.ts:105](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L105)*
+
+Returns the RLP serialization of the account as a `Buffer`.
+
+**Returns:** *Buffer*
+
+___
+
+### `Static` fromAccountData
+
+▸ **fromAccountData**(`accountData`: [AccountData](../interfaces/_account_.accountdata.md)): *[Account](_account_.account.md)‹›*
+
+*Defined in [account.ts:47](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L47)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`accountData` | [AccountData](../interfaces/_account_.accountdata.md) |
+
+**Returns:** *[Account](_account_.account.md)‹›*
+
+___
+
+### `Static` fromRlpSerializedAccount
+
+▸ **fromRlpSerializedAccount**(`serialized`: Buffer): *[Account](_account_.account.md)‹›*
+
+*Defined in [account.ts:58](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L58)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`serialized` | Buffer |
+
+**Returns:** *[Account](_account_.account.md)‹›*
+
+___
+
+### `Static` fromValuesArray
+
+▸ **fromValuesArray**(`values`: Buffer[]): *[Account](_account_.account.md)‹›*
+
+*Defined in [account.ts:68](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L68)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`values` | Buffer[] |
+
+**Returns:** *[Account](_account_.account.md)‹›*

docs/interfaces/_account_.accountdata.md

@@ -0,0 +1,48 @@
+[ethereumjs-util](../README.md) › ["account"](../modules/_account_.md) › [AccountData](_account_.accountdata.md)
+
+# Interface: AccountData
+
+## Hierarchy
+
+* **AccountData**
+
+## Index
+
+### Properties
+
+* [balance](_account_.accountdata.md#optional-balance)
+* [codeHash](_account_.accountdata.md#optional-codehash)
+* [nonce](_account_.accountdata.md#optional-nonce)
+* [stateRoot](_account_.accountdata.md#optional-stateroot)
+
+## Properties
+
+### `Optional` balance
+
+• **balance**? : *BNLike*
+
+*Defined in [account.ts:19](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L19)*
+
+___
+
+### `Optional` codeHash
+
+• **codeHash**? : *BufferLike*
+
+*Defined in [account.ts:21](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L21)*
+
+___
+
+### `Optional` nonce
+
+• **nonce**? : *BNLike*
+
+*Defined in [account.ts:18](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L18)*
+
+___
+
+### `Optional` stateRoot
+
+• **stateRoot**? : *BufferLike*
+
+*Defined in [account.ts:20](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L20)*

docs/modules/__types_ethjs_util_index_.md

@@ -0,0 +1,5 @@
+[ethereumjs-util](../README.md) › ["@types/ethjs-util/index"](__types_ethjs_util_index_.md)
+
+# Module: "@types/ethjs-util/index"
+
+