web3-eth-accounts

Index

Classes

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

Enumerations

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

Functions

• arrToBufArr
• assertIsBuffer
• bigIntToBuffer
• bigIntToHex
• bigIntToUnpaddedBuffer
• bufArrToArr
• bufferToBigInt
• bufferToHex
• create
• decrypt
• ecrecover
• encrypt
• hashMessage
• intToBuffer
• isAccessList
• isAccessListBuffer
• padToEven
• parseAndValidatePrivateKey
• parseGethGenesis
• privateKeyToAccount
• privateKeyToAddress
• recover
• recoverTransaction
• setLengthLeft
• sign
• signTransaction
• stripHexPrefix
• toBuffer
• toType
• unpadBuffer
• zeros

Interfaces

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

Type Aliases

• AccessList
• AccessListBuffer
• AccessListBufferItem
• AccessListEIP2930ValuesArray
• AccessListItem
• BigIntLike
• BufferLike
• CasperConfig
• CliqueConfig
• EthashConfig
• FeeMarketEIP1559ValuesArray
• NestedBufferArray
• NestedUint8Array
• PrefixedHexString
• SignFunction
• SignResult
• SignTransactionFunction
• SignTransactionResult
• SignatureObject
• ToBufferInputTypes
• TxData
• TxValuesArray
• TypeOutputReturnType
• TypedTransaction

Variables

• keyStoreSchema

Type Aliases

AccessList

AccessList: AccessListItem[]

AccessListBuffer

AccessListBuffer: AccessListBufferItem[]

AccessListBufferItem

AccessListBufferItem: [Buffer, Buffer[]]

AccessListEIP2930ValuesArray

AccessListEIP2930ValuesArray: [Buffer, Buffer, Buffer, Buffer, Buffer, Buffer, Buffer, AccessListBuffer, Buffer?, Buffer?, Buffer?]

Buffer values array for an AccessListEIP2930Transaction

AccessListItem

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

Type declaration

• address: PrefixedHexString

• storageKeys: PrefixedHexString[]

BigIntLike

BigIntLike: bigint | PrefixedHexString | number | Buffer

BufferLike

BufferLike: Buffer | Uint8Array | number[] | number | bigint | TransformableToBuffer | PrefixedHexString

CasperConfig

CasperConfig: Record<string, unknown>

CliqueConfig

CliqueConfig: { epoch: number; period: number }

Type declaration

• epoch: number

• period: number

EthashConfig

EthashConfig: Record<string, unknown>

FeeMarketEIP1559ValuesArray

FeeMarketEIP1559ValuesArray: [Buffer, Buffer, Buffer, Buffer, Buffer, Buffer, Buffer, Buffer, AccessListBuffer, Buffer?, Buffer?, Buffer?]

Buffer values array for a FeeMarketEIP1559Transaction

NestedBufferArray

NestedBufferArray: (Buffer | NestedBufferArray)[]

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

ToBufferInputTypes

ToBufferInputTypes: PrefixedHexString | number | bigint | Buffer | Uint8Array | number[] | TransformableToArray | TransformableToBuffer | null | undefined

TxData

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

Legacy Transaction Data

---

Type declaration

• optionaldata?: BufferLike

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

• optionalgasLimit?: Numbers | Buffer

  The transaction’s gas limit.

• optionalgasPrice?: Numbers | Buffer | null

  The transaction’s gas price.

• optionalnonce?: Numbers | Buffer

  The transaction’s nonce.

• optionalr?: Numbers | Buffer

  EC signature parameter.

• optionals?: Numbers | Buffer

  EC signature parameter.

• optionalto?: Address | Buffer | HexString

  The transaction’s the address is sent to.

• optionaltype?: Numbers

  The transaction type

• optionalv?: Numbers | Buffer

  EC recovery ID.

• optionalvalue?: Numbers | Buffer

  The amount of Ether sent.

TxValuesArray

TxValuesArray: Buffer[]

Buffer values array for a legacy Transaction

TypeOutputReturnType

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

Type declaration

• 0: number

• 1: bigint

• 2: Buffer

• 3: PrefixedHexString

TypedTransaction

TypedTransaction: Transaction | AccessListEIP2930Transaction | FeeMarketEIP1559Transaction

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