Class ContractDecoder

The ContractDecoder class. Spawns the ContractInstanceDecoder class. Also, decodes transactions and logs. See below for a method listing.

Hierarchy

ContractDecoder

Index

Constructors

constructor

Properties

Accessors

context

Methods

Constructors

Protected constructor

new ContractDecoder(contract: Contract, compilation: Compilation, wireDecoder: WireDecoder, artifact?: Artifact): ContractDecoder

- Defined in decoder/lib/decoders.ts:737
Parameters
- contract: Contract
- compilation: Compilation
- wireDecoder: WireDecoder
- Optional artifact: Artifact
Returns ContractDecoder

Properties

Private allocations

allocations: AllocationInfo

Private artifact

artifact: Artifact

Private compilation

compilation: Compilation

Private contextHash

contextHash: string

Private contexts

contexts: DecoderContexts

Private contract

contract: Contract

Private contractNetwork

contractNetwork: string

Private contractNode

contractNode: AstNode

Private noBytecodeAllocations

noBytecodeAllocations: object

Type declaration

[selector: string]: CalldataAndReturndataAllocation

Private stateVariableReferences

stateVariableReferences: StateVariableAllocation[]

Private userDefinedTypes

userDefinedTypes: TypesById

Private web3

web3: Web3

Private wireDecoder

wireDecoder: WireDecoder

Accessors

Private context

get context(): DecoderContext

- Defined in decoder/lib/decoders.ts:837
Returns DecoderContext

Methods

abifyCalldataDecoding

abifyCalldataDecoding(decoding: CalldataDecoding): CalldataDecoding

- Defined in decoder/lib/decoders.ts:1005
See WireDecoder.abifyCalldataDecoding.

Parameters
- decoding: CalldataDecoding
Returns CalldataDecoding

abifyLogDecoding

abifyLogDecoding(decoding: LogDecoding): LogDecoding

- Defined in decoder/lib/decoders.ts:1012
See WireDecoder.abifyLogDecoding.

Parameters
- decoding: LogDecoding
Returns LogDecoding

decodeLog

decodeLog(log: Log): Promise<LogDecoding[]>

- Defined in decoder/lib/decoders.ts:986
This method is asynchronous.

See WireDecoder.decodeLog.

Parameters
- log: Log
  
  The log to be decoded.
Returns Promise<LogDecoding[]>

decodeReturnValue

decodeReturnValue(abi: FunctionAbiEntry, data: string, options?: ReturnOptions): Promise<ReturndataDecoding[]>

- Defined in decoder/lib/decoders.ts:873
This method is asynchronous.

Decodes the return value of a call. Return values can be ambiguous, so this so this function returns an array of ReturndataDecodings.

Note that return values are decoded in strict mode, so none of the decodings should contain errors; if a decoding would contain an error, instead it is simply excluded from the list of possible decodings.

If there are multiple possible decodings, they will always be listed in the following order:
1. The decoded return value from a successful call.
2. The decoded revert message from a call that reverted with a message.
3. A decoding indicating that the call reverted with no message.
4. A decoding indicating that the call self-destructed.
You can check the kind and field to distinguish between these.

If no possible decodings are found, the returned array of decodings will be empty.

Note that different decodings may use different decoding modes.

Decoding creation calls with this method is not supported. If you simply want to decode a revert message from an arbitrary call that you know failed, you may also want to see the decodeRevert function in @truffle/codec.
Parameters
- abi: FunctionAbiEntry
  
  The abi entry for the function call whose return value is being decoded.
- data: string
  
  The data to be decoded, as a hex string (beginning with "0x").
- Default value options: ReturnOptions = {}
  
  Additional options, such as the block the call occurred in. See ReturnOptions for more information.
Returns Promise<ReturndataDecoding[]>

Protected decodeReturnValueWithAdditionalContexts

decodeReturnValueWithAdditionalContexts(abi: FunctionAbiEntry, data: string, options?: ReturnOptions, additionalContexts?: DecoderContexts, contextHash?: string): Promise<ReturndataDecoding[]>

- Defined in decoder/lib/decoders.ts:888
Parameters
- abi: FunctionAbiEntry
- data: string
- Default value options: ReturnOptions = {}
- Default value additionalContexts: DecoderContexts = {}
- Default value contextHash: string = this.contextHash
Returns Promise<ReturndataDecoding[]>

decodeTransaction

decodeTransaction(transaction: Transaction): Promise<CalldataDecoding>

- Defined in decoder/lib/decoders.ts:974
This method is asynchronous.

See WireDecoder.decodeTransaction.

Parameters
- transaction: Transaction
  
  The transaction to be decoded.
Returns Promise<CalldataDecoding>

events

events(options?: EventOptions): Promise<DecodedLog[]>

- Defined in decoder/lib/decoders.ts:996
This method is asynchronous.

See WireDecoder.events.

Parameters
- Default value options: EventOptions = {}
  
  Used to determine what events to fetch; see the documentation on the EventOptions type for more.
Returns Promise<DecodedLog[]>

forInstance

forInstance(address?: string): Promise<ContractInstanceDecoder>

- Defined in decoder/lib/decoders.ts:949
This method is asynchronous.

Constructs a contract instance decoder for a given instance of this contract.

Parameters
- Optional address: string
  
  The address of the contract instance decode. If left out, it will be autodetected. If an invalid address is provided, this method will throw an exception.
Returns Promise<ContractInstanceDecoder>

Protected getAllocations

getAllocations(): AllocationInfo

- Defined in decoder/lib/decoders.ts:1021
Returns AllocationInfo

Private getCode

getCode(address: string, block: DecoderTypes.RegularizedBlockSpecifier): Promise<Uint8Array>

- Defined in decoder/lib/decoders.ts:955
Parameters
- address: string
- block: DecoderTypes.RegularizedBlockSpecifier
Returns Promise<Uint8Array>

Protected getContractInfo

getContractInfo(): ContractInfo

- Defined in decoder/lib/decoders.ts:1042
Returns ContractInfo

Protected getStateVariableReferences

getStateVariableReferences(): StateVariableAllocation[]

- Defined in decoder/lib/decoders.ts:1028
Returns StateVariableAllocation[]

Protected getWireDecoder

getWireDecoder(): WireDecoder

- Defined in decoder/lib/decoders.ts:1035
Returns WireDecoder

Protected init

init(): Promise<void>

- Defined in decoder/lib/decoders.ts:833
Returns Promise<void>

Private regularizeBlock

regularizeBlock(block: DecoderTypes.BlockSpecifier): Promise<DecoderTypes.RegularizedBlockSpecifier>

- Defined in decoder/lib/decoders.ts:962
Parameters
- block: DecoderTypes.BlockSpecifier
Returns Promise<DecoderTypes.RegularizedBlockSpecifier>

Generated using TypeDoc