Class ImmutableXChainCreateAccountProofSig

java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableXChainCreateAccountProofSig
All Implemented Interfaces:
XChainCreateAccountProofSig

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

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

  • Method Details

    • amount

      public CurrencyAmount amount()
      The amount committed by the XChainAccountCreateCommit transaction on the source chain.
      Specified by:
      amount in interface XChainCreateAccountProofSig
      Returns:
      A CurrencyAmount.
    • signatureReward

      public XrpCurrencyAmount signatureReward()
      The total amount, in XRP, to be rewarded for providing a signature for cross-chain transfer or for signing for the cross-chain reward. This amount will be split among the signers.
      Specified by:
      signatureReward in interface XChainCreateAccountProofSig
      Returns:
      An XrpCurrencyAmount.
    • attestationRewardAccount

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

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

      public Address destination()
      The destination account for the funds on the destination chain.
      Specified by:
      destination in interface XChainCreateAccountProofSig
      Returns:
      An Address.
    • publicKey

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

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

      public final ImmutableXChainCreateAccountProofSig 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
    • withSignatureReward

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

      public final ImmutableXChainCreateAccountProofSig 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
    • withAttestationSignerAccount

      public final ImmutableXChainCreateAccountProofSig 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
    • withDestination

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

      public final ImmutableXChainCreateAccountProofSig 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
    • withWasLockingChainSend

      public final ImmutableXChainCreateAccountProofSig 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
    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableXChainCreateAccountProofSig 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: amount, signatureReward, attestationRewardAccount, attestationSignerAccount, destination, publicKey, wasLockingChainSend.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value
    • toString

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

      Creates an immutable copy of a XChainCreateAccountProofSig 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 XChainCreateAccountProofSig instance
    • builder

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