web3-eth-accounts

Index

Classes

• AccessListEIP2930Transaction
• BaseTransaction
• Common
• FeeMarketEIP1559Transaction
• Transaction
• TransactionFactory
• Wallet

Enumerations

• Capability
• Chain
• ConsensusAlgorithm
• ConsensusType
• CustomChain
• Hardfork
• TypeOutput

Functions

• assertIsUint8Array
• bigIntToHex
• bigIntToUint8Array
• bigIntToUnpaddedUint8Array
• create
• decrypt
• ecrecover
• encrypt
• hashMessage
• intToUint8Array
• isAccessList
• isAccessListUint8Array
• padToEven
• parseAndValidatePrivateKey
• parseGethGenesis
• privateKeyToAccount
• privateKeyToAddress
• privateKeyToPublicKey
• recover
• recoverTransaction
• setLengthLeft
• sign
• signTransaction
• stripHexPrefix
• stripZeros
• toType
• toUint8Array
• uint8ArrayToBigInt
• unpadUint8Array
• zeros

Interfaces

• AccessListEIP2930TxData
• BootstrapNodeConfig
• ChainConfig
• ChainName
• ChainsConfig
• CommonOpts
• CustomCommonOpts
• ECDSASignature
• FeeMarketEIP1559TxData
• GenesisBlockConfig
• GethConfigOpts
• HardforkConfig
• JsonTx
• TransformableToArray
• TxOptions
• Web3Account
• WebStorage

Namespaces

• txUtils

Type Aliases

• AccessList
• AccessListEIP2930ValuesArray
• AccessListItem
• AccessListUint8Array
• AccessListUint8ArrayItem
• BigIntLike
• CasperConfig
• CliqueConfig
• EthashConfig
• FeeMarketEIP1559ValuesArray
• NestedUint8Array
• PrefixedHexString
• SignFunction
• SignResult
• SignTransactionFunction
• SignTransactionResult
• SignatureObject
• ToBytesInputTypes
• TxData
• TxValuesArray
• TypeOutputReturnType
• TypedTransaction
• Uint8ArrayLike

Variables

• keyStoreSchema

Type Aliases

AccessList

AccessList: AccessListItem[]

AccessListEIP2930ValuesArray

AccessListEIP2930ValuesArray: [Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, AccessListUint8Array, Uint8Array?, Uint8Array?, Uint8Array?]

Uint8Array values array for an AccessListEIP2930Transaction

AccessListItem

AccessListItem: { address: PrefixedHexString; storageKeys: PrefixedHexString[] }

Type declaration

• address: PrefixedHexString

• storageKeys: PrefixedHexString[]

AccessListUint8Array

AccessListUint8Array: AccessListUint8ArrayItem[]

AccessListUint8ArrayItem

AccessListUint8ArrayItem: [Uint8Array, Uint8Array[]]

BigIntLike

BigIntLike: bigint | PrefixedHexString | number | Uint8Array

CasperConfig

CasperConfig: Record<string, unknown>

CliqueConfig

CliqueConfig: { epoch: number; period: number }

Type declaration

• epoch: number

• period: number

EthashConfig

EthashConfig: Record<string, unknown>

FeeMarketEIP1559ValuesArray

FeeMarketEIP1559ValuesArray: [Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, Uint8Array, AccessListUint8Array, Uint8Array?, Uint8Array?, Uint8Array?]

Uint8Array values array for a FeeMarketEIP1559Transaction

NestedUint8Array

NestedUint8Array: (Uint8Array | NestedUint8Array)[]

PrefixedHexString

PrefixedHexString: string

SignFunction

SignFunction: (data: string, privateKey: string) => SignResult

Type declaration

• • (data: string, privateKey: string): SignResult

  • Parameters

    • data: string

    • privateKey: string

    Returns SignResult

SignResult

SignResult: SignatureObject & { message?: string; signature: string }

SignTransactionFunction

SignTransactionFunction: (transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>) => SignTransactionResult

Type declaration

• • (transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>): SignTransactionResult

  • Parameters

    • transaction: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData | Record<string, unknown>

    Returns SignTransactionResult

SignTransactionResult

SignTransactionResult: SignatureObject & { rawTransaction: string; transactionHash: string }

SignatureObject

SignatureObject: { messageHash: string; r: string; s: string; v: string }

Type declaration

• messageHash: string

• r: string

• s: string

• v: string

ToBytesInputTypes

ToBytesInputTypes: PrefixedHexString | number | bigint | Uint8Array | number[] | TransformableToArray | null | undefined

TxData

TxData: { data?: Uint8ArrayLike; gasLimit?: Numbers | Uint8Array; gasPrice?: Numbers | Uint8Array | null; nonce?: Numbers | Uint8Array; r?: Numbers | Uint8Array; s?: Numbers | Uint8Array; to?: Address | Uint8Array | HexString; type?: Numbers; v?: Numbers | Uint8Array; value?: Numbers | Uint8Array }

Legacy Transaction Data

---

Type declaration

• optionaldata?: Uint8ArrayLike

  This will contain the data of the message or the init of a contract.

• optionalgasLimit?: Numbers | Uint8Array

  The transaction's gas limit.

• optionalgasPrice?: Numbers | Uint8Array | null

  The transaction's gas price.

• optionalnonce?: Numbers | Uint8Array

  The transaction's nonce.

• optionalr?: Numbers | Uint8Array

  EC signature parameter.

• optionals?: Numbers | Uint8Array

  EC signature parameter.

• optionalto?: Address | Uint8Array | HexString

  The transaction's the address is sent to.

• optionaltype?: Numbers

  The transaction type

• optionalv?: Numbers | Uint8Array

  EC recovery ID.

• optionalvalue?: Numbers | Uint8Array

  The amount of Ether sent.

TxValuesArray

TxValuesArray: Uint8Array[]

Uint8Array values array for a legacy Transaction

TypeOutputReturnType

TypeOutputReturnType: { 0: number; 1: bigint; 2: Uint8Array; 3: PrefixedHexString }

Type declaration

• 0: number

• 1: bigint

• 2: Uint8Array

• 3: PrefixedHexString

TypedTransaction

TypedTransaction: Transaction | AccessListEIP2930Transaction | FeeMarketEIP1559Transaction

Uint8ArrayLike

Uint8ArrayLike: Uint8Array | number[] | number | bigint | PrefixedHexString

Variables

constkeyStoreSchema

keyStoreSchema: { properties: { address: { type: string }; crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }; id: { type: string }; version: { type: string } }; required: string[]; type: string } = ...

Type declaration

• properties: { address: { type: string }; crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }; id: { type: string }; version: { type: string } }

  • address: { type: string }

    • type: string

  • crypto: { properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }; required: string[]; type: string }

    • properties: { cipher: { type: string }; cipherparams: { type: string }; ciphertext: { type: string }; kdf: { type: string }; kdfparams: { type: string }; mac: { type: string }; salt: { type: string } }

      • cipher: { type: string }

        • type: string

      • cipherparams: { type: string }

        • type: string

      • ciphertext: { type: string }

        • type: string

      • kdf: { type: string }

        • type: string

      • kdfparams: { type: string }

        • type: string

      • mac: { type: string }

        • type: string

      • salt: { type: string }

        • type: string

    • required: string[]

    • type: string

  • id: { type: string }

    • type: string

  • version: { type: string }

    • type: string

• required: string[]

• type: string