Show / Hide Table of Contents

Class TransactionPreview<TOutcome>

The result of running a transaction through simulate: what the node would do with it, without submitting it.

Inheritance
object
TransactionPreview<TOutcome>
Namespace: Xrpl.Sugar
Assembly: Xrpl.dll
Syntax
public sealed class TransactionPreview<TOutcome> where TOutcome : class
Type Parameters
Name Description
TOutcome

What is read from the simulated metadata.

Properties

| Edit this page View Source

EngineResult

The result code the transaction would get, for example tesSUCCESS.

Declaration
public string EngineResult { get; init; }
Property Value
Type Description
string
| Edit this page View Source

EngineResultMessage

The node's explanation of EngineResult.

Declaration
public string EngineResultMessage { get; init; }
Property Value
Type Description
string
| Edit this page View Source

Metadata

The metadata the transaction would produce; null when the node returned none.

Declaration
public ITransactionMetadata Metadata { get; init; }
Property Value
Type Description
ITransactionMetadata
| Edit this page View Source

Outcome

What the transaction would do; null unless WouldSucceed.

Declaration
public TOutcome Outcome { get; init; }
Property Value
Type Description
TOutcome
| Edit this page View Source

Transaction

The autofilled transaction that was simulated; submit this one to get the same result.

Declaration
public ITransactionRequest Transaction { get; init; }
Property Value
Type Description
ITransactionRequest
| Edit this page View Source

WouldSucceed

Whether the transaction would apply successfully.

Declaration
public bool WouldSucceed { get; }
Property Value
Type Description
bool
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX