Class ResultsParser

Legacy component. For parsing contract query responses, use the "SmartContractQueriesController" instead. For parsing smart contract outcome (return data), use the "SmartContractTransactionsOutcomeParser" instead. For parding smart contract events, use the "TransactionEventsParser" instead.

Parses contract query responses and smart contract results. The parsing involves some heuristics, in order to handle slight inconsistencies (e.g. some SCRs are present on API, but missing on Gateway).

Index

Constructors

constructor

new ResultsParser(options?): ResultsParser
Parameters
- Optional options: IResultsParserOptions
Returns ResultsParser
- Defined in src/smartcontracts/resultsParser.ts:73

Properties

`Private` `Readonly` argsSerializer

argsSerializer: IArgsSerializer

Methods

`Private` createBundleOnEasilyFoundResultWithReturnData

createBundleOnEasilyFoundResultWithReturnData(results): null | UntypedOutcomeBundle
Parameters
- results: IContractResults
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:236

`Private` createBundleOnInvalidTransaction

createBundleOnInvalidTransaction(transaction): null | UntypedOutcomeBundle
Parameters
- transaction: ITransactionOnNetwork
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:220

`Private` createBundleOnSignalError

createBundleOnSignalError(logs): null | UntypedOutcomeBundle
Parameters
- logs: ITransactionLogs
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:252

`Private` createBundleOnSimpleMoveBalance

createBundleOnSimpleMoveBalance(transaction): null | UntypedOutcomeBundle
Parameters
- transaction: ITransactionOnNetwork
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:205

`Private` createBundleOnTooMuchGasWarning

createBundleOnTooMuchGasWarning(logs): null | UntypedOutcomeBundle
Parameters
- logs: ITransactionLogs
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:269

`Private` createBundleOnWriteLogWhereFirstTopicEqualsAddress

createBundleOnWriteLogWhereFirstTopicEqualsAddress(logs, address): null | UntypedOutcomeBundle
Parameters
- logs: ITransactionLogs
- address: IAddress
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:290

`Protected` createBundleWithCustomHeuristics

createBundleWithCustomHeuristics(_transaction, _transactionMetadata): null | UntypedOutcomeBundle
Override this method (in a subclass of ResultsParser) if the basic heuristics of the parser are not sufficient.
Parameters
- _transaction: ITransactionOnNetwork
- _transactionMetadata: TransactionMetadata
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:315

`Private` createBundleWithFallbackHeuristics

createBundleWithFallbackHeuristics(transaction, transactionMetadata): null | UntypedOutcomeBundle
Parameters
- transaction: ITransactionOnNetwork
- transactionMetadata: TransactionMetadata
Returns null | UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:319

doParseEvent

doParseEvent(options): any
Internal
For internal use only.

Once the legacy "ResultParser" is deprecated & removed, this logic will be absorbed into "TransactionEventsParser".
Parameters
- options: {
      dataItems: Buffer[];
      eventDefinition: {
          inputs: IEventInputDefinition[];
      };
      topics: Buffer[];
  }
  - dataItems: Buffer[]
  - eventDefinition: {
    inputs: IEventInputDefinition[];
    }
    - inputs: IEventInputDefinition[]
  - topics: Buffer[]
Returns any
- Defined in src/smartcontracts/resultsParser.ts:399

parseEvent

parseEvent(transactionEvent, eventDefinition): any
Legacy method, use "TransactionEventsParser.parseEvent()" instead.
Parameters
- transactionEvent: ITransactionEvent
- eventDefinition: {
  inputs: IEventInputDefinition[];
  }
  - inputs: IEventInputDefinition[]
Returns any
- Defined in src/smartcontracts/resultsParser.ts:372

parseOutcome

parseOutcome(transaction, endpoint): TypedOutcomeBundle
Legacy method, use "SmartContractTransactionsOutcomeParser.parseExecute()" instead.
Parameters
- transaction: ITransactionOnNetwork
- endpoint: {
  output: IParameterDefinition[];
  }
  - output: IParameterDefinition[]
Returns TypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:113

parseOutcomeFromUntypedBundle

parseOutcomeFromUntypedBundle(bundle, endpoint): {
    firstValue: TypedValue;
    lastValue: TypedValue;
    returnCode: ReturnCode;
    returnMessage: string;
    secondValue: TypedValue;
    thirdValue: TypedValue;
    values: TypedValue[];
}
Internal
For internal use only.
Parameters
- bundle: UntypedOutcomeBundle
- endpoint: {
  output: IParameterDefinition[];
  }
  - output: IParameterDefinition[]
Returns {
    firstValue: TypedValue;
    lastValue: TypedValue;
    returnCode: ReturnCode;
    returnMessage: string;
    secondValue: TypedValue;
    thirdValue: TypedValue;
    values: TypedValue[];
}
- firstValue: TypedValue
- lastValue: TypedValue
- returnCode: ReturnCode
- returnMessage: string
- secondValue: TypedValue
- thirdValue: TypedValue
- values: TypedValue[]
- Defined in src/smartcontracts/resultsParser.ts:123

parseQueryResponse

parseQueryResponse(queryResponse, endpoint): TypedOutcomeBundle
Legacy method, use "SmartContractQueriesController.parseQueryResponse()" instead.
Parameters
- queryResponse: IContractQueryResponse
- endpoint: {
  output: IParameterDefinition[];
  }
  - output: IParameterDefinition[]
Returns TypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:81

`Private` parseTransactionMetadata

parseTransactionMetadata(transaction): TransactionMetadata
Parameters
- transaction: ITransactionOnNetwork
Returns TransactionMetadata
- Defined in src/smartcontracts/resultsParser.ts:196

parseUntypedOutcome

parseUntypedOutcome(transaction): UntypedOutcomeBundle
Legacy method, use "SmartContractTransactionsOutcomeParser.parseExecute()" instead.
Parameters
- transaction: ITransactionOnNetwork
Returns UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:140

parseUntypedQueryResponse

parseUntypedQueryResponse(queryResponse): UntypedOutcomeBundle
Legacy method, use "SmartContractQueriesController.parseQueryResponse()" instead.
Parameters
- queryResponse: IContractQueryResponse
Returns UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:100

`Protected` sliceDataFieldInParts

sliceDataFieldInParts(data): {
returnCode: ReturnCode;
returnDataParts: Buffer[];
}
Parameters
- data: string
Returns {
returnCode: ReturnCode;
returnDataParts: Buffer[];
}
- returnCode: ReturnCode
- returnDataParts: Buffer[]
- Defined in src/smartcontracts/resultsParser.ts:345

Class ResultsParser

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ResultsParser

Properties

Private Readonly argsSerializer

Methods

Private createBundleOnEasilyFoundResultWithReturnData

Parameters

Returns null | UntypedOutcomeBundle

Private createBundleOnInvalidTransaction

Parameters

Returns null | UntypedOutcomeBundle

Private createBundleOnSignalError

Parameters

Returns null | UntypedOutcomeBundle

Private createBundleOnSimpleMoveBalance

Parameters

Returns null | UntypedOutcomeBundle

Private createBundleOnTooMuchGasWarning

Parameters

Returns null | UntypedOutcomeBundle

Private createBundleOnWriteLogWhereFirstTopicEqualsAddress

Parameters

Returns null | UntypedOutcomeBundle

Protected createBundleWithCustomHeuristics

Parameters

Returns null | UntypedOutcomeBundle

Private createBundleWithFallbackHeuristics

Parameters

Returns null | UntypedOutcomeBundle

doParseEvent

Parameters

dataItems: Buffer[]

eventDefinition: { inputs: IEventInputDefinition[]; }

inputs: IEventInputDefinition[]

topics: Buffer[]

Returns any

parseEvent

Parameters

inputs: IEventInputDefinition[]

Returns any

parseOutcome

Parameters

output: IParameterDefinition[]

Returns TypedOutcomeBundle

parseOutcomeFromUntypedBundle

Parameters

output: IParameterDefinition[]

Returns { firstValue: TypedValue; lastValue: TypedValue; returnCode: ReturnCode; returnMessage: string; secondValue: TypedValue; thirdValue: TypedValue; values: TypedValue[]; }

firstValue: TypedValue

lastValue: TypedValue

returnCode: ReturnCode

returnMessage: string

secondValue: TypedValue

thirdValue: TypedValue

values: TypedValue[]

parseQueryResponse

Parameters

output: IParameterDefinition[]

Returns TypedOutcomeBundle

Private parseTransactionMetadata

Parameters

Returns TransactionMetadata

parseUntypedOutcome

Parameters

Returns UntypedOutcomeBundle

parseUntypedQueryResponse

Parameters

Returns UntypedOutcomeBundle

Protected sliceDataFieldInParts

Parameters

Returns { returnCode: ReturnCode; returnDataParts: Buffer[]; }

returnCode: ReturnCode

returnDataParts: Buffer[]

`Private` `Readonly` argsSerializer

`Private` createBundleOnEasilyFoundResultWithReturnData

`Private` createBundleOnInvalidTransaction

`Private` createBundleOnSignalError

`Private` createBundleOnSimpleMoveBalance

`Private` createBundleOnTooMuchGasWarning

`Private` createBundleOnWriteLogWhereFirstTopicEqualsAddress

`Protected` createBundleWithCustomHeuristics

`Private` createBundleWithFallbackHeuristics

eventDefinition: {
inputs: IEventInputDefinition[];
}

Returns {
firstValue: TypedValue;
lastValue: TypedValue;
returnCode: ReturnCode;
returnMessage: string;
secondValue: TypedValue;
thirdValue: TypedValue;
values: TypedValue[];
}

`Private` parseTransactionMetadata

`Protected` sliceDataFieldInParts

Returns {
returnCode: ReturnCode;
returnDataParts: Buffer[];
}