Interface XChainClaim

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableXChainClaim

@Beta @Immutable public interface XChainClaim extends Transaction
Object mapping for the XChainClaim transaction.

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

  • Method Details

    • builder

      static ImmutableXChainClaim.Builder builder()
      Construct a XChainClaim builder.
      Returns:
      An ImmutableXChainClaim.Builder.
    • flags

      @Default default TransactionFlags flags()
      Set of TransactionFlagss for this XChainClaim, which only allows the tfFullyCanonicalSig flag, which is deprecated.
      Returns:
      A set of TransactionFlags, default is TransactionFlags.EMPTY.
    • amount

      CurrencyAmount amount()
      The amount to claim on the destination chain. This must match the amount attested to on the attestations associated with xChainClaimId().
      Returns:
      A CurrencyAmount.
    • destination

      Address destination()
      The 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.
      Returns:
      An Address.
    • destinationTag

      Optional<com.google.common.primitives.UnsignedInteger> destinationTag()
      A 32-bit unsigned integer destination tag.
      Returns:
      An optional UnsignedInteger
    • xChainBridge

      XChainBridge xChainBridge()
      The bridge to use to transfer funds.
      Returns:
      An XChainBridge.
    • xChainClaimId

      XChainClaimId xChainClaimId()
      The unique integer ID for the cross-chain transfer that was referenced in the corresponding XChainCommit transaction.
      Returns:
      An XChainClaimId.