Skip to content
This repository has been archived by the owner on Jun 17, 2021. It is now read-only.

Commit

Permalink
Regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alcuadrado committed Jun 25, 2019
1 parent cdf0b3c commit a91eaf3
Showing 1 changed file with 25 additions and 19 deletions.
44 changes: 25 additions & 19 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ ___

**● publicToAddress**: *[pubToAddress]()* = pubToAddress

*Defined in [account.ts:151](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L151)*
*Defined in [account.ts:160](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L160)*

___
<a id="setlength"></a>
Expand Down Expand Up @@ -225,7 +225,7 @@ Converts a `Buffer` or `Array` to JSON.
| ba | `any` | (Buffer\|Array) |

**Returns:** `any`
(Array|String|null)
(Array\|String\|null)

___
<a id="buffertohex"></a>
Expand All @@ -236,7 +236,7 @@ ___

*Defined in [bytes.ts:111](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/bytes.ts#L111)*

Converts a `Buffer` into a hex `String`.
Converts a `Buffer` into a `0x`\-prefixed hex `String`.

**Parameters:**

Expand Down Expand Up @@ -376,7 +376,7 @@ ___

**generateAddress**(from: *`Buffer`*, nonce: *`Buffer`*): `Buffer`

*Defined in [account.ts:63](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L63)*
*Defined in [account.ts:72](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L72)*

Generates an address of a newly created contract.

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

**generateAddress2**(from: *`Buffer` \| `string`*, salt: *`Buffer` \| `string`*, initCode: *`Buffer` \| `string`*): `Buffer`

*Defined in [account.ts:83](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L83)*
*Defined in [account.ts:92](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L92)*

Generates an address for a contract created using CREATE2.

Expand Down Expand Up @@ -436,7 +436,7 @@ ___

**importPublic**(publicKey: *`Buffer`*): `Buffer`

*Defined in [account.ts:174](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L174)*
*Defined in [account.ts:183](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L183)*

Converts a public key to the Ethereum format.

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

**isPrecompiled**(address: *`Buffer` \| `string`*): `boolean`

*Defined in [account.ts:105](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L105)*
*Defined in [account.ts:114](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L114)*

Returns true if the supplied address belongs to a precompiled account (Byzantium).

Expand Down Expand Up @@ -491,17 +491,20 @@ ___

### `<Const>` isValidChecksumAddress

**isValidChecksumAddress**(address: *`string`*): `boolean`
**isValidChecksumAddress**(address: *`string`*, chainId?: *`undefined` \| `number`*): `boolean`

*Defined in [account.ts:54](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L54)*
*Defined in [account.ts:63](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L63)*

Checks if the address is a valid checksummed address.

If a chainId is provided, the address is compared to an EIP-1191 checksum. Otherwise, it will be compared to an EIP-55 checksum.

**Parameters:**

| Name | Type |
| ------ | ------ |
| address | `string` |
| `Optional` chainId | `undefined` \| `number` |

**Returns:** `boolean`

Expand All @@ -512,7 +515,7 @@ ___

**isValidPrivate**(privateKey: *`Buffer`*): `boolean`

*Defined in [account.ts:113](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L113)*
*Defined in [account.ts:122](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L122)*

Checks if the private key satisfies the rules of the curve secp256k1.

Expand All @@ -531,7 +534,7 @@ ___

**isValidPublic**(publicKey: *`Buffer`*, sanitize?: *`boolean`*): `boolean`

*Defined in [account.ts:123](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L123)*
*Defined in [account.ts:132](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L132)*

Checks if the public key satisfies the rules of the curve secp256k1 and the requirements of Ethereum.

Expand Down Expand Up @@ -632,7 +635,7 @@ ___

**privateToAddress**(privateKey: *`Buffer`*): `Buffer`

*Defined in [account.ts:157](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L157)*
*Defined in [account.ts:166](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L166)*

Returns the ethereum address of a given private key.

Expand All @@ -651,7 +654,7 @@ ___

**privateToPublic**(privateKey: *`Buffer`*): `Buffer`

*Defined in [account.ts:165](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L165)*
*Defined in [account.ts:174](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L174)*

Returns the ethereum public key of a given private key.

Expand All @@ -670,7 +673,7 @@ ___

**pubToAddress**(pubKey: *`Buffer`*, sanitize?: *`boolean`*): `Buffer`

*Defined in [account.ts:142](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L142)*
*Defined in [account.ts:151](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L151)*

Returns the ethereum address of a given public key. Accepts "Ethereum public keys" and SEC1 encoded keys.

Expand Down Expand Up @@ -742,7 +745,7 @@ Left Pads an `Array` or `Buffer` with leading zeros till it has `length` bytes.
| `Default value` right | `boolean` | false | whether to start padding form the left or right |

**Returns:** `any`
(Buffer|Array)
(Buffer\|Array)

___
<a id="setlengthright"></a>
Expand All @@ -763,7 +766,7 @@ Right Pads an `Array` or `Buffer` with leading zeros till it has `length` bytes.
| length | `number` | the number of bytes the output should be |

**Returns:** `any`
(Buffer|Array)
(Buffer\|Array)

___
<a id="sha256"></a>
Expand Down Expand Up @@ -808,17 +811,20 @@ ___

### `<Const>` toChecksumAddress

**toChecksumAddress**(address: *`string`*): `string`
**toChecksumAddress**(address: *`string`*, chainId?: *`undefined` \| `number`*): `string`

*Defined in [account.ts:35](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L35)*
*Defined in [account.ts:38](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L38)*

Returns a checksummed address.

If a chainId is provided, the result will be an EIP-1191 checksum. Otherwise, it will be an EIP-55 checksum.

**Parameters:**

| Name | Type |
| ------ | ------ |
| address | `string` |
| `Optional` chainId | `undefined` \| `number` |

**Returns:** `string`

Expand Down Expand Up @@ -882,7 +888,7 @@ Trims leading zeros from a `Buffer` or an `Array`.
| a | `any` | (Buffer\|Array\|String) |

**Returns:** `any`
(Buffer|Array|String)
(Buffer\|Array\|String)

___
<a id="zeroaddress"></a>
Expand Down

0 comments on commit a91eaf3

Please sign in to comment.