ConstructionPreprocessRequest class

Passed to the /construction/preprocess endpoint so that a Rosetta implementation can determine which metadata it needs to request for construction. metadata provided in this object should NEVER be a product of live data (i.e. the caller must follow some network-specific data fetching strategy outside of the Construction API to populate required metadata).

If live data is required for construction, it MUST be fetched in the call to /construction/metadata. The caller can provide a max fee they are willing to pay for a transaction. This is an array in the case fees must be paid in multiple currencies. The caller can also provide a suggested fee multiplier to indicate that the suggested fee should be scaled.

This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency. It is assumed that providing a very low multiplier (like 0.0001) will never lead to a transaction being created with a fee less than the minimum network fee (if applicable). In the case that the caller provides both a max fee and a suggested fee multiplier, the max fee will set an upper bound on the suggested fee (regardless of the multiplier provided).

Annotations

Constructors

ConstructionPreprocessRequest(NetworkIdentifier networkIdentifier, List<Operation> operations, Map<String, dynamic>? metadata, List<Amount>? maxFee, int? suggestedFeeMultiplier)
const
ConstructionPreprocessRequest.fromJson(Map<String, dynamic> map)
factory

Properties

hashCode int
The hash code for this object.
no setterinherited
maxFee List<Amount>?
final
metadata Map<String, dynamic>?
final
networkIdentifier NetworkIdentifier
final
operations List<Operation>
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
suggestedFeeMultiplier int?
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited