formatters

Index

Functions

• inputAddressFormatter
• inputBlockNumberFormatter
• inputCallFormatter
• inputDefaultBlockNumberFormatter
• inputLogFormatter
• inputPostFormatter
• inputSignFormatter
• inputStorageKeysFormatter
• inputTopicFormatter
• inputTransactionFormatter
• outputBigIntegerFormatter
• outputBlockFormatter
• outputLogFormatter
• outputPostFormatter
• outputProofFormatter
• outputSyncingFormatter
• outputTransactionFormatter
• outputTransactionReceiptFormatter
• txInputOptionsFormatter

Functions

inputAddressFormatter

• inputAddressFormatter(address: string): string

• @deprecated

  Use format function from web3-utils package instead

  ---

  Parameters

  • address: string

  Returns string

inputBlockNumberFormatter

• inputBlockNumberFormatter(blockNumber: undefined | Numbers): undefined | string

• @deprecated

  Use format function from web3-utils package instead Returns the given block number as hex string or the predefined block number ‘latest’, ‘pending’, ‘earliest’, ‘genesis’

  ---

  Parameters

  • blockNumber: undefined | Numbers

  Returns undefined | string

inputCallFormatter

• inputCallFormatter(options: TransactionInput, defaultAccount?: string): Mutable<TransactionOutput>

• @deprecated

  Use format function from web3-utils package instead Formats the input of a transaction and converts all values to HEX

  ---

  Parameters

  • options: TransactionInput

  • optionaldefaultAccount: string

  Returns Mutable<TransactionOutput>

inputDefaultBlockNumberFormatter

• inputDefaultBlockNumberFormatter(blockNumber: undefined | Numbers, defaultBlock: Numbers): undefined | string

• @deprecated

  Use format function from web3-utils package instead Returns the given block number as hex string or does return the defaultBlock property of the current module

  ---

  Parameters

  • blockNumber: undefined | Numbers

  • defaultBlock: Numbers

  Returns undefined | string

inputLogFormatter

• inputLogFormatter(filter: Filter): Filter

• @deprecated

  Use format function from web3-utils package instead

  ---

  Parameters

  • filter: Filter

  Returns Filter

inputPostFormatter

• inputPostFormatter(post: PostOutput): PostInput

• @deprecated

  Use format function from web3-utils package instead Formats the input of a whisper post and converts all values to HEX

  ---

  Parameters

  • post: PostOutput

  Returns PostInput

inputSignFormatter

• inputSignFormatter(data: string): string

• @deprecated

  Use format function from web3-utils package instead Hex encodes the data passed to eth_sign and personal_sign

  ---

  Parameters

  • data: string

  Returns string

inputStorageKeysFormatter

• inputStorageKeysFormatter(keys: string[]): string[]

• @deprecated

  Use format function from web3-utils package instead Will format the given storage key array values to hex strings.

  ---

  Parameters

  • keys: string[]

  Returns string[]

inputTopicFormatter

• inputTopicFormatter(topic: string): null | string

• @deprecated

  Use format function from web3-utils package instead

  ---

  Parameters

  • topic: string

  Returns null | string

inputTransactionFormatter

• inputTransactionFormatter(options: TransactionInput, defaultAccount?: string): Mutable<TransactionOutput>

• @deprecated

  Use format function from web3-utils package instead Formats the input of a transaction and converts all values to HEX

  ---

  Parameters

  • options: TransactionInput

  • optionaldefaultAccount: string

  Returns Mutable<TransactionOutput>

outputBigIntegerFormatter

• outputBigIntegerFormatter(number: Numbers): number | bigint

• @deprecated

  Use format function from web3-utils package instead Should the format output to a big number

  ---

  Parameters

  • number: Numbers

  Returns number | bigint

outputBlockFormatter

• outputBlockFormatter(block: BlockInput): BlockOutput

• @deprecated

  Use format function from web3-utils package instead Formats the output of a block to its proper values

  @function

  outputBlockFormatter

  ---

  Parameters

  • block: BlockInput

  Returns BlockOutput

outputLogFormatter

• outputLogFormatter(log: Partial<LogsInput>): LogsOutput

• @deprecated

  Use format function from web3-utils package instead Formats the output of a log

  @function

  outputLogFormatter

  ---

  Parameters

  • log: Partial<LogsInput>

  Returns LogsOutput

outputPostFormatter

• outputPostFormatter(post: PostInput): PostOutput

• @deprecated

  Use format function from web3-utils package instead Formats the output of a received post message

  @function

  outputPostFormatter

  ---

  Parameters

  • post: PostInput

  Returns PostOutput

outputProofFormatter

• outputProofFormatter(proof: Proof): Proof

• @deprecated

  Use format function from web3-utils package instead Will format the given proof response from the node.

  ---

  Parameters

  • proof: Proof

  Returns Proof

outputSyncingFormatter

• outputSyncingFormatter(result: SyncInput): SyncOutput

• @deprecated

  Use format function from web3-utils package instead

  ---

  Parameters

  • result: SyncInput

  Returns SyncOutput

outputTransactionFormatter

• outputTransactionFormatter(tx: TransactionInput): TransactionOutput

• @deprecated

  Use format function from web3-utils package instead Formats the output of a transaction to its proper values

  @function

  outputTransactionFormatter

  ---

  Parameters

  • tx: TransactionInput

  Returns TransactionOutput

outputTransactionReceiptFormatter

• outputTransactionReceiptFormatter(receipt: ReceiptInput): ReceiptOutput

• @deprecated

  Use format function from web3-utils package instead Formats the output of a transaction receipt to its proper values

  ---

  Parameters

  • receipt: ReceiptInput

  Returns ReceiptOutput

txInputOptionsFormatter

• txInputOptionsFormatter(options: TransactionInput): Mutable<TransactionOutput>

• @deprecated

  Use format function from web3-utils package instead Formats the input of a transaction and converts all values to HEX

  ---

  Parameters

  • options: TransactionInput

  Returns Mutable<TransactionOutput>