Interface XChainOwnedClaimIdObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableXChainOwnedClaimIdObject

@Beta @Immutable public interface XChainOwnedClaimIdObject extends LedgerObject
An XChainOwnedClaimID object represents one cross-chain transfer of value and includes information of the account on the source chain that locks or burns the funds on the source chain.

The XChainOwnedClaimID object must be acquired on the destination chain before submitting a XChainCommit on the source chain. Its purpose is to prevent transaction replay attacks and is also used as a place to collect attestations from witness servers.

An XChainCreateClaimId transaction is used to create a new XChainOwnedClaimID. The ledger object is destroyed when the funds are successfully claimed on the destination chain.

This interface will be marked Beta until the featureXChainBridge amendment is enabled on mainnet. Its API is subject to change.

  • Method Details

    • builder

      Construct a XChainOwnedClaimIdObject builder.
      Returns:
      An ImmutableXChainOwnedClaimIdObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
      The type of ledger object, which will always be "XChainOwnedClaimID" in this case.
      Returns:
      Always returns LedgerObject.LedgerEntryType.XCHAIN_OWNED_CLAIM_ID.
    • flags

      @Derived default Flags flags()
      A bit-map of boolean flags. No flags are defined for XChainOwnedClaimIdObject, so this value is always 0.
      Returns:
      Always Flags.UNSET.
    • account

      Address account()
      The account that owns this object.
      Returns:
      An Address.
    • xChainBridge

      XChainBridge xChainBridge()
      The door accounts and assets of the bridge this object correlates to.
      Returns:
      An XChainBridge.
    • xChainClaimId

      XChainClaimId xChainClaimId()
      The unique sequence number for a cross-chain transfer.
      Returns:
      An XChainClaimId.
    • otherChainSource

      Address otherChainSource()
      The account that must send the corresponding XChainCommit on the source chain. The destination may be specified in the XChainCommit transaction, which means that if the OtherChainSource isn't specified, another account can try to specify a different destination and steal the funds. This also allows tracking only a single set of signatures, since we know which account will send the XChainCommit transaction.
      Returns:
      An Address.
    • xChainClaimAttestations

      List<XChainClaimAttestation> xChainClaimAttestations()
      Attestations collected from the witness servers. This includes the parameters needed to recreate the message that was signed, including the amount, which chain (locking or issuing), optional destination, and reward account for that signature.
      Returns:
      A List of XChainClaimAttestations.
    • signatureReward

      XrpCurrencyAmount signatureReward()
      The total amount to pay the witness servers for their signatures. It must be at least the value of SignatureReward in the Bridge ledger object.
      Returns:
      An XrpCurrencyAmount.
    • ownerNode

      String ownerNode()
      A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.

      Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.

      Returns:
      A String containing the owner node hint.
    • previousTransactionId

      Hash256 previousTransactionId()
      The identifying hash of the transaction that most recently modified this object.
      Returns:
      A Hash256 containing the previous transaction hash.
    • previousTransactionLedgerSequence

      com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()
      The index of the ledger that contains the transaction that most recently modified this object.
      Returns:
      An UnsignedInteger representing the previous transaction ledger sequence.
    • index

      Hash256 index()
      The unique ID of the XChainOwnedClaimIdObject.
      Returns:
      A Hash256 containing the ID.