Skip to content

Commit 873345d

Browse files
holgerd77holgerd77
committed
Rebuild documentation
1 parent ab8256b commit 873345d

File tree

9 files changed

+350
-126
lines changed

9 files changed

+350
-126
lines changed

‎docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@
1111
* ["constants"](modules/_constants_.md)
1212
* ["externals"](modules/_externals_.md)
1313
* ["hash"](modules/_hash_.md)
14+
* ["helpers"](modules/_helpers_.md)
1415
* ["object"](modules/_object_.md)
1516
* ["signature"](modules/_signature_.md)

‎docs/interfaces/_signature_.ecdsasignature.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@
2020

2121
• **r**: *Buffer*
2222

23-
*Defined in [signature.ts:8](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/signature.ts#L8)*
23+
*Defined in [signature.ts:9](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/signature.ts#L9)*
2424

2525
___
2626

2727
### s
2828

2929
• **s**: *Buffer*
3030

31-
*Defined in [signature.ts:9](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/signature.ts#L9)*
31+
*Defined in [signature.ts:10](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/signature.ts#L10)*
3232

3333
___
3434

3535
### v
3636

3737
• **v**: *number*
3838

39-
*Defined in [signature.ts:7](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/signature.ts#L7)*
39+
*Defined in [signature.ts:8](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/signature.ts#L8)*

‎docs/modules/_account_.md

Lines changed: 26 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
* [generateAddress](_account_.md#const-generateaddress)
1414
* [generateAddress2](_account_.md#const-generateaddress2)
1515
* [importPublic](_account_.md#const-importpublic)
16-
* [isPrecompiled](_account_.md#const-isprecompiled)
1716
* [isValidAddress](_account_.md#const-isvalidaddress)
1817
* [isValidChecksumAddress](_account_.md#const-isvalidchecksumaddress)
1918
* [isValidPrivate](_account_.md#const-isvalidprivate)
@@ -31,15 +30,15 @@
3130

3231
• **publicToAddress**: *pubToAddress* = pubToAddress
3332

34-
*Defined in [account.ts:163](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L163)*
33+
*Defined in [account.ts:160](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L160)*
3534

3635
## Functions
3736

3837
### `Const` generateAddress
3938

4039
▸ **generateAddress**(`from`: Buffer, `nonce`: Buffer): *Buffer*
4140

42-
*Defined in [account.ts:75](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L75)*
41+
*Defined in [account.ts:82](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L82)*
4342

4443
Generates an address of a newly created contract.
4544

@@ -56,19 +55,19 @@ ___
5655

5756
### `Const` generateAddress2
5857

59-
▸ **generateAddress2**(`from`: Buffer | string, `salt`: Buffer | string, `initCode`: Buffer | string): *Buffer*
58+
▸ **generateAddress2**(`from`: Buffer, `salt`: Buffer, `initCode`: Buffer): *Buffer*
6059

61-
*Defined in [account.ts:95](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L95)*
60+
*Defined in [account.ts:103](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L103)*
6261

6362
Generates an address for a contract created using CREATE2.
6463

6564
**Parameters:**
6665

6766
Name | Type | Description |
6867
------ | ------ | ------ |
69-
`from` | Buffer | string | The address which is creating this new address |
70-
`salt` | Buffer | string | A salt |
71-
`initCode` | Buffer | string | The init code of the contract being created |
68+
`from` | Buffer | The address which is creating this new address |
69+
`salt` | Buffer | A salt |
70+
`initCode` | Buffer | The init code of the contract being created |
7271

7372
**Returns:** *Buffer*
7473

@@ -78,7 +77,7 @@ ___
7877

7978
▸ **importPublic**(`publicKey`: Buffer): *Buffer*
8079

81-
*Defined in [account.ts:186](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L186)*
80+
*Defined in [account.ts:183](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L183)*
8281

8382
Converts a public key to the Ethereum format.
8483

@@ -92,47 +91,29 @@ Name | Type |
9291

9392
___
9493

95-
### `Const` isPrecompiled
96-
97-
▸ **isPrecompiled**(`address`: Buffer | string): *boolean*
98-
99-
*Defined in [account.ts:117](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L117)*
100-
101-
Returns true if the supplied address belongs to a precompiled account (Byzantium).
102-
103-
**Parameters:**
104-
105-
Name | Type |
106-
------ | ------ |
107-
`address` | Buffer | string |
108-
109-
**Returns:** *boolean*
110-
111-
___
112-
11394
### `Const` isValidAddress
11495

115-
▸ **isValidAddress**(`address`: string): *boolean*
96+
▸ **isValidAddress**(`hexAddress`: string): *boolean*
11697

117-
*Defined in [account.ts:20](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L20)*
98+
*Defined in [account.ts:21](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L21)*
11899

119100
Checks if the address is a valid. Accepts checksummed addresses too.
120101

121102
**Parameters:**
122103

123104
Name | Type |
124105
------ | ------ |
125-
`address` | string |
106+
`hexAddress` | string |
126107

127108
**Returns:** *boolean*
128109

129110
___
130111

131112
### `Const` isValidChecksumAddress
132113

133-
▸ **isValidChecksumAddress**(`address`: string, `eip1191ChainId?`: undefined | number): *boolean*
114+
▸ **isValidChecksumAddress**(`hexAddress`: string, `eip1191ChainId?`: undefined | number): *boolean*
134115

135-
*Defined in [account.ts:66](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L66)*
116+
*Defined in [account.ts:70](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L70)*
136117

137118
Checks if the address is a valid checksummed address.
138119

@@ -142,7 +123,7 @@ See toChecksumAddress' documentation for details about the eip1191ChainId parame
142123

143124
Name | Type |
144125
------ | ------ |
145-
`address` | string |
126+
`hexAddress` | string |
146127
`eip1191ChainId?` | undefined | number |
147128

148129
**Returns:** *boolean*
@@ -153,7 +134,7 @@ ___
153134

154135
▸ **isValidPrivate**(`privateKey`: Buffer): *boolean*
155136

156-
*Defined in [account.ts:125](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L125)*
137+
*Defined in [account.ts:121](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L121)*
157138

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

@@ -171,7 +152,7 @@ ___
171152

172153
▸ **isValidPublic**(`publicKey`: Buffer, `sanitize`: boolean): *boolean*
173154

174-
*Defined in [account.ts:135](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L135)*
155+
*Defined in [account.ts:131](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L131)*
175156

176157
Checks if the public key satisfies the rules of the curve secp256k1
177158
and the requirements of Ethereum.
@@ -189,17 +170,17 @@ ___
189170

190171
### `Const` isZeroAddress
191172

192-
▸ **isZeroAddress**(`address`: string): *boolean*
173+
▸ **isZeroAddress**(`hexAddress`: string): *boolean*
193174

194-
*Defined in [account.ts:27](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L27)*
175+
*Defined in [account.ts:29](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L29)*
195176

196177
Checks if a given address is a zero address.
197178

198179
**Parameters:**
199180

200181
Name | Type |
201182
------ | ------ |
202-
`address` | string |
183+
`hexAddress` | string |
203184

204185
**Returns:** *boolean*
205186

@@ -209,7 +190,7 @@ ___
209190

210191
▸ **privateToAddress**(`privateKey`: Buffer): *Buffer*
211192

212-
*Defined in [account.ts:169](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L169)*
193+
*Defined in [account.ts:166](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L166)*
213194

214195
Returns the ethereum address of a given private key.
215196

@@ -227,7 +208,7 @@ ___
227208

228209
▸ **privateToPublic**(`privateKey`: Buffer): *Buffer*
229210

230-
*Defined in [account.ts:177](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L177)*
211+
*Defined in [account.ts:174](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L174)*
231212

232213
Returns the ethereum public key of a given private key.
233214

@@ -245,7 +226,7 @@ ___
245226

246227
▸ **pubToAddress**(`pubKey`: Buffer, `sanitize`: boolean): *Buffer*
247228

248-
*Defined in [account.ts:154](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L154)*
229+
*Defined in [account.ts:151](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L151)*
249230

250231
Returns the ethereum address of a given public key.
251232
Accepts "Ethereum public keys" and SEC1 encoded keys.
@@ -263,9 +244,9 @@ ___
263244

264245
### `Const` toChecksumAddress
265246

266-
▸ **toChecksumAddress**(`address`: string, `eip1191ChainId?`: undefined | number): *string*
247+
▸ **toChecksumAddress**(`hexAddress`: string, `eip1191ChainId?`: undefined | number): *string*
267248

268-
*Defined in [account.ts:42](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L42)*
249+
*Defined in [account.ts:45](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L45)*
269250

270251
Returns a checksummed address.
271252

@@ -280,7 +261,7 @@ used variation in Ethereum was without the chainId. This may change in the futur
280261

281262
Name | Type |
282263
------ | ------ |
283-
`address` | string |
264+
`hexAddress` | string |
284265
`eip1191ChainId?` | undefined | number |
285266

286267
**Returns:** *string*
@@ -291,7 +272,7 @@ ___
291272

292273
▸ **zeroAddress**(): *string*
293274

294-
*Defined in [account.ts:11](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L11)*
275+
*Defined in [account.ts:12](https://github.com/ethereumjs/ethereumjs-util/blob/master/src/account.ts#L12)*
295276

296277
Returns a zero address.
297278

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy