XChainCommit class
Represents a XChainCommit transaction. The XChainCommit transaction is the second step in a cross-chain transfer. It puts assets into trust on the locking chain so that they can be wrapped on the issuing chain, or burns wrapped assets on the issuing chain so that they can be returned on the locking chain.
- Inheritance
-
- Object
- XRPLBase
- XRPTransaction
- XChainCommit
Constructors
-
XChainCommit.new({required String account, required XChainBridge xchainBridge, required int xchainClaimId, String? otherChainDestination, required BigInt amount, List<
XRPLMemo> ? memos = const [], String signingPubKey = "", int? ticketSequance, BigInt? fee, int? lastLedgerSequence, int? sequence, List<XRPLSigners> ? signers, dynamic flags, int? sourceTag, List<String> multiSigSigners = const []}) -
XChainCommit.fromJson(Map<
String, dynamic> json)
Properties
- account → String
-
finalinherited
- accountTxId → String?
-
finalinherited
- amount → BigInt
-
The asset to commit, and the quantity. This must match the door account's
LockingChainIssue (if on the locking chain) or the door account's
IssuingChainIssue (if on the issuing chain). This field is required.
final
- fee ↔ BigInt?
-
getter/setter pairinherited
- flags → dynamic
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- lastLedgerSequence ↔ int?
-
getter/setter pairinherited
-
memos
↔ List<
XRPLMemo> ? -
getter/setter pairinherited
-
multiSigSigners
↔ List<
String> -
getter/setter pairinherited
- networkId ↔ int?
-
getter/setter pairinherited
- otherChainDestination → String?
-
The destination account on the destination chain. If this is not specified,
the account that submitted the XChainCreateClaimID transaction on the
destination chain will need to submit a XChainClaim transaction to
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sequence ↔ int?
-
getter/setter pairinherited
-
signers
↔ List<
XRPLSigners> ? -
getter/setter pairinherited
- signingPubKey ↔ String
-
getter/setter pairinherited
- sourceTag → int?
-
finalinherited
- ticketSequance → int?
-
finalinherited
- transactionType → XRPLTransactionType
-
finalinherited
- txnSignature ↔ String?
-
getter/setter pairinherited
- validate → String?
-
no setterinherited
- xchainBridge → XChainBridge
-
The bridge to use to transfer funds. This field is required.
final
- xchainClaimId → int
-
The unique integer ID for a cross-chain transfer. This must be acquired on
the destination chain (via a XChainCreateClaimID transaction) and
checked from a validated ledger before submitting this transaction. If an
incorrect sequence number is specified, the funds will be lost. This field
is required.
final
Methods
-
getHash(
) → String -
inherited
-
isSigned(
) → bool -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setFee(
BigInt? newFee) → void -
inherited
-
setLastLedgerSequence(
int? newSequance) → void -
inherited
-
setMultiSigSignature(
List< XRPLSigners> sigs) → void -
inherited
-
setNetworkId(
int? network) → void -
inherited
-
setSequence(
int? newSequance) → void -
inherited
-
setSignature(
String? sig) → void -
inherited
-
toBlob(
{bool forSigning = true}) → String -
inherited
-
toJson(
) → Map< String, dynamic> -
Converts the object to a JSON representation.
override
-
toMultisigBlob(
String address) → String -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toXrpl(
) → Map< String, dynamic> -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited