Class ImmutableXChainClaimProofSig

java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableXChainClaimProofSig
All Implemented Interfaces:
XChainClaimProofSig

@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableXChainClaimProofSig extends Object implements XChainClaimProofSig
Immutable implementation of XChainClaimProofSig.

Use the builder to create immutable instances: ImmutableXChainClaimProofSig.builder().

  • Method Details

    • attestationSignerAccount

      public Address attestationSignerAccount()
      The account on the door account's signer list that is signing the transaction.
      Specified by:
      attestationSignerAccount in interface XChainClaimProofSig
      Returns:
      An Address.
    • publicKey

      public PublicKey publicKey()
      The public key used to verify the signature.
      Specified by:
      publicKey in interface XChainClaimProofSig
      Returns:
      A PublicKey.
    • amount

      public CurrencyAmount amount()
      The amount to claim in the XChainCommit transaction on the destination chain.
      Specified by:
      amount in interface XChainClaimProofSig
      Returns:
      A CurrencyAmount.
    • attestationRewardAccount

      public Address attestationRewardAccount()
      The account that should receive this signer's share of the SignatureReward.
      Specified by:
      attestationRewardAccount in interface XChainClaimProofSig
      Returns:
      An Address.
    • wasLockingChainSend

      public boolean wasLockingChainSend()
      A boolean representing the chain where the event occurred.
      Specified by:
      wasLockingChainSend in interface XChainClaimProofSig
      Returns:
      true if the event occurred on the locking chain, otherwise false.
    • destination

      public Optional<Address> destination()
      The destination account for the funds on the destination chain.
      Specified by:
      destination in interface XChainClaimProofSig
      Returns:
      An Address.
    • withAttestationSignerAccount

      public final ImmutableXChainClaimProofSig withAttestationSignerAccount(Address value)
      Copy the current immutable object by setting a value for the attestationSignerAccount attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for attestationSignerAccount
      Returns:
      A modified copy of the this object
    • withPublicKey

      public final ImmutableXChainClaimProofSig withPublicKey(PublicKey value)
      Copy the current immutable object by setting a value for the publicKey attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for publicKey
      Returns:
      A modified copy of the this object
    • withAmount

      public final ImmutableXChainClaimProofSig withAmount(CurrencyAmount value)
      Copy the current immutable object by setting a value for the amount attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for amount
      Returns:
      A modified copy of the this object
    • withAttestationRewardAccount

      public final ImmutableXChainClaimProofSig withAttestationRewardAccount(Address value)
      Copy the current immutable object by setting a value for the attestationRewardAccount attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for attestationRewardAccount
      Returns:
      A modified copy of the this object
    • withWasLockingChainSend

      public final ImmutableXChainClaimProofSig withWasLockingChainSend(boolean value)
      Copy the current immutable object by setting a value for the wasLockingChainSend attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for wasLockingChainSend
      Returns:
      A modified copy of the this object
    • withDestination

      public final ImmutableXChainClaimProofSig withDestination(Address value)
      Copy the current immutable object by setting a present value for the optional destination attribute.
      Parameters:
      value - The value for destination
      Returns:
      A modified copy of this object
    • withDestination

      public final ImmutableXChainClaimProofSig withDestination(Optional<? extends Address> optional)
      Copy the current immutable object by setting an optional value for the destination attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for destination
      Returns:
      A modified copy of this object
    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableXChainClaimProofSig that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance
    • hashCode

      public int hashCode()
      Computes a hash code from attributes: attestationSignerAccount, publicKey, amount, attestationRewardAccount, wasLockingChainSend, destination.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value
    • toString

      public String toString()
      Prints the immutable value XChainClaimProofSig with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value
    • copyOf

      public static ImmutableXChainClaimProofSig copyOf(XChainClaimProofSig instance)
      Creates an immutable copy of a XChainClaimProofSig value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable XChainClaimProofSig instance
    • builder

      public static ImmutableXChainClaimProofSig.Builder builder()
      Creates a builder for ImmutableXChainClaimProofSig.
       ImmutableXChainClaimProofSig.builder()
          .attestationSignerAccount(org.xrpl.xrpl4j.model.transactions.Address) // required attestationSignerAccount
          .publicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // required publicKey
          .amount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // required amount
          .attestationRewardAccount(org.xrpl.xrpl4j.model.transactions.Address) // required attestationRewardAccount
          .wasLockingChainSend(boolean) // required wasLockingChainSend
          .destination(org.xrpl.xrpl4j.model.transactions.Address) // optional destination
          .build();
       
      Returns:
      A new ImmutableXChainClaimProofSig builder