Class ResultsParser

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

Properties

Methods

createBundleOnEasilyFoundResultWithReturnData createBundleOnInvalidTransaction createBundleOnSignalError createBundleOnSimpleMoveBalance createBundleOnTooMuchGasWarning createBundleOnWriteLogWhereFirstTopicEqualsAddress createBundleWithCustomHeuristics createBundleWithFallbackHeuristics parseEvent parseOutcome parseQueryResponse parseTransactionMetadata parseUntypedOutcome parseUntypedQueryResponse sliceDataFieldInParts

Constructors

constructor

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

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:202

`Private` createBundleOnInvalidTransaction

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

`Private` createBundleOnSignalError

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

`Private` createBundleOnSimpleMoveBalance

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

`Private` createBundleOnTooMuchGasWarning

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

`Private` createBundleOnWriteLogWhereFirstTopicEqualsAddress

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

`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:281

`Private` createBundleWithFallbackHeuristics

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

parseEvent

parseEvent(transactionEvent, eventDefinition): any
Parameters
- transactionEvent: ITransactionEvent
- eventDefinition: {
  inputs: IEventInputDefinition[];
  }
  - inputs: IEventInputDefinition[]
Returns any
- Defined in src/smartcontracts/resultsParser.ts:335

parseOutcome

parseOutcome(transaction, endpoint): TypedOutcomeBundle
Parameters
- transaction: ITransactionOnNetwork
- endpoint: {
  output: IParameterDefinition[];
  }
  - output: IParameterDefinition[]
Returns TypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:91

parseQueryResponse

parseQueryResponse(queryResponse, endpoint): TypedOutcomeBundle
Parameters
- queryResponse: IContractQueryResponse
- endpoint: {
  output: IParameterDefinition[];
  }
  - output: IParameterDefinition[]
Returns TypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:65

`Private` parseTransactionMetadata

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

parseUntypedOutcome

parseUntypedOutcome(transaction): UntypedOutcomeBundle
Parameters
- transaction: ITransactionOnNetwork
Returns UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:106

parseUntypedQueryResponse

parseUntypedQueryResponse(queryResponse): UntypedOutcomeBundle
Parameters
- queryResponse: IContractQueryResponse
Returns UntypedOutcomeBundle
- Defined in src/smartcontracts/resultsParser.ts:81

`Private` 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:311

Generated using TypeDoc