XRP Ledger Apex is back in Amsterdam

Register Now
Documentation
/
References
/
XRP Ledger Protocol Reference
/
Transaction Reference
/
Transaction Types
/
XChainClaim
Last updated
Edit

XChainClaim

[Source]

(Requires the XChainBridge amendment )

The XChainClaim transaction completes a cross-chain transfer of value. It allows a user to claim the value on the destination chain - the equivalent of the value locked on the source chain. A user can only claim the value if they own the cross-chain claim ID associated with the value locked on the source chain (the Account field). The user can send the funds to anyone (the Destination field). This transaction is only needed if an OtherChainDestination isn't specified in the XChainCommit transaction, or if something goes wrong with the automatic transfer of funds.

If the transaction succeeds in moving funds, the referenced XChainOwnedClaimID ledger object will be destroyed. This prevents transaction replay. If the transaction fails, the XChainOwnedClaimID won't be destroyed and the transaction can be re-run with different parameters.

Example XChainClaim JSON

{
  "Account": "rahDmoXrtPdh7sUdrPjini3gcnTVYjbjjw",
  "Amount": "10000",
  "TransactionType": "XChainClaim",
  "XChainClaimID": "13f",
  "Destination": "rahDmoXrtPdh7sUdrPjini3gcnTVYjbjjw",
  "XChainBridge": {
    "LockingChainDoor": "rMAXACCrp3Y8PpswXcg3bKggHX76V3F8M4",
    "LockingChainIssue": {
      "currency": "XRP"
    },
    "IssuingChainDoor": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "IssuingChainIssue": {
      "currency": "XRP"
    }
  }
}

XChainClaim Fields

FieldJSON TypeInternal TypeRequired?Description
AmountCurrency AmountAmountYesThe amount to claim on the destination chain. This must match the amount attested to on the attestations associated with this XChainClaimID.
DestinationStringAccountYesThe destination account on the destination chain. It must exist or the transaction will fail. However, if the transaction fails in this case, the sequence number and collected signatures won't be destroyed, and the transaction can be rerun with a different destination.
DestinationTagNumberUInt32NoAn integer destination tag.
XChainBridgeXChainBridgeXChain_BridgeYesThe bridge to use for the transfer.
XChainClaimIDStringUInt64YesThe unique integer ID for the cross-chain transfer that was referenced in the corresponding XChainCommit transaction.

XChainBridge Fields

FieldJSON TypeInternal TypeRequired?Description
IssuingChainDoorStringAccountYesThe door account on the issuing chain. For an XRP-XRP bridge, this must be the genesis account (the account that is created when the network is first started, which contains all of the XRP).
IssuingChainIssueIssueIssueYesThe asset that is minted and burned on the issuing chain. For an IOU-IOU bridge, the issuer of the asset must be the door account on the issuing chain, to avoid supply issues.
LockingChainDoorStringAccountYesThe door account on the locking chain.
LockingChainIssueIssueIssueYesThe asset that is locked and unlocked on the locking chain.