RestorePreamble
in package
Part of the simulateTransaction response.
It can only present on successful simulation (i.e. no error) of InvokeHostFunction operations. If present, it indicates the simulation detected expired ledger entries which requires restoring with the submission of a RestoreFootprint operation before submitting the InvokeHostFunction operation. The minResourceFee and transactionData fields should be used to construct the transaction containing the RestoreFootprint operation.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- fromJson() : static
- Creates an instance from JSON-RPC response data
- getMinResourceFee() : int
- getTransactionData() : XdrSorobanTransactionData
- setMinResourceFee() : void
- setTransactionData() : void
Properties
$minResourceFee
public
int
$minResourceFee
$transactionData
public
XdrSorobanTransactionData
$transactionData
Methods
__construct()
public
__construct(XdrSorobanTransactionData $transactionData, int $minResourceFee) : mixed
Parameters
- $transactionData : XdrSorobanTransactionData
-
The recommended Soroban Transaction Data to use when submitting the RestoreFootprint operation
- $minResourceFee : int
-
Recommended minimum resource fee to add when submitting the RestoreFootprint operation (on top of the Stellar network fee)
fromJson()
Creates an instance from JSON-RPC response data
public
static fromJson(array<string, mixed> $json) : static
Parameters
- $json : array<string, mixed>
-
The JSON response data
Tags
Return values
static —The created instance
getMinResourceFee()
public
getMinResourceFee() : int
Return values
int —Recommended minimum resource fee to add when submitting the RestoreFootprint operation. This fee is to be added on top of the Stellar network fee.
getTransactionData()
public
getTransactionData() : XdrSorobanTransactionData
Return values
XdrSorobanTransactionData —The recommended Soroban Transaction Data to use when submitting the RestoreFootprint operation.
setMinResourceFee()
public
setMinResourceFee(int $minResourceFee) : void
Parameters
- $minResourceFee : int
-
Recommended minimum resource fee to add when submitting the RestoreFootprint operation. This fee is to be added on top of the Stellar network fee.
setTransactionData()
public
setTransactionData(XdrSorobanTransactionData $transactionData) : void
Parameters
- $transactionData : XdrSorobanTransactionData
-
The recommended Soroban Transaction Data to use when submitting the RestoreFootprint operation.