_account_.md

ethereumjs-util › "account"

Module: "account"

Index

Variables

• publicToAddress

Functions

• generateAddress
• generateAddress2
• importPublic
• isPrecompiled
• isValidAddress
• isValidChecksumAddress
• isValidPrivate
• isValidPublic
• isZeroAddress
• privateToAddress
• privateToPublic
• pubToAddress
• toChecksumAddress
• zeroAddress

Variables

Const publicToAddress

• publicToAddress: pubToAddress = pubToAddress

Defined in account.ts:163

Functions

Const generateAddress

▸ generateAddress(from: Buffer, nonce: Buffer): Buffer

Defined in account.ts:75

Generates an address of a newly created contract.

Parameters:

Name	Type	Description
from	Buffer	The address which is creating this new address
nonce	Buffer	The nonce of the from account

Returns: Buffer

---

Const generateAddress2

▸ generateAddress2(from: Buffer | string, salt: Buffer | string, initCode: Buffer | string): Buffer

Defined in account.ts:95

Generates an address for a contract created using CREATE2.

Parameters:

Name	Type	Description
from	Buffer | string	The address which is creating this new address
salt	Buffer | string	A salt
initCode	Buffer | string	The init code of the contract being created

Returns: Buffer

---

Const importPublic

▸ importPublic(publicKey: Buffer): Buffer

Defined in account.ts:186

Converts a public key to the Ethereum format.

Parameters:

Name	Type
publicKey	Buffer

Returns: Buffer

---

Const isPrecompiled

▸ isPrecompiled(address: Buffer | string): boolean

Defined in account.ts:117

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

Parameters:

Name	Type
address	Buffer | string

Returns: boolean

---

Const isValidAddress

▸ isValidAddress(address: string): boolean

Defined in account.ts:20

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

Parameters:

Name	Type
address	string

Returns: boolean

---

Const isValidChecksumAddress

▸ isValidChecksumAddress(address: string, eip1191ChainId?: undefined | number): boolean

Defined in account.ts:66

Checks if the address is a valid checksummed address.

See toChecksumAddress' documentation for details about the eip1191ChainId parameter.

Parameters:

Name	Type
address	string
eip1191ChainId?	undefined | number

Returns: boolean

---

Const isValidPrivate

▸ isValidPrivate(privateKey: Buffer): boolean

Defined in account.ts:125

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

Parameters:

Name	Type
privateKey	Buffer

Returns: boolean

---

Const isValidPublic

▸ isValidPublic(publicKey: Buffer, sanitize: boolean): boolean

Defined in account.ts:135

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

Parameters:

Name	Type	Default	Description
publicKey	Buffer	-	The two points of an uncompressed key, unless sanitize is enabled
sanitize	boolean	false	Accept public keys in other formats

Returns: boolean

---

Const isZeroAddress

▸ isZeroAddress(address: string): boolean

Defined in account.ts:27

Checks if a given address is a zero address.

Parameters:

Name	Type
address	string

Returns: boolean

---

Const privateToAddress

▸ privateToAddress(privateKey: Buffer): Buffer

Defined in account.ts:169

Returns the ethereum address of a given private key.

Parameters:

Name	Type	Description
privateKey	Buffer	A private key must be 256 bits wide

Returns: Buffer

---

Const privateToPublic

▸ privateToPublic(privateKey: Buffer): Buffer

Defined in account.ts:177

Returns the ethereum public key of a given private key.

Parameters:

Name	Type	Description
privateKey	Buffer	A private key must be 256 bits wide

Returns: Buffer

---

Const pubToAddress

▸ pubToAddress(pubKey: Buffer, sanitize: boolean): Buffer

Defined in account.ts:154

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

Parameters:

Name	Type	Default	Description
pubKey	Buffer	-	The two points of an uncompressed key, unless sanitize is enabled
sanitize	boolean	false	Accept public keys in other formats

Returns: Buffer

---

Const toChecksumAddress

▸ toChecksumAddress(address: string, eip1191ChainId?: undefined | number): string

Defined in account.ts:42

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.

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.

Parameters:

Name	Type
address	string
eip1191ChainId?	undefined | number

Returns: string

---

Const zeroAddress

▸ zeroAddress(): string

Defined in account.ts:11

Returns a zero address.

Returns: string