Package org.xrpl.xrpl4j.model.ledger
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().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableXChainCreateAccountProofSig. -
Method Summary
Modifier and TypeMethodDescriptionamount()The amount committed by theXChainAccountCreateCommittransaction on the source chain.The account that should receive this signer's share of thesignatureReward().The account on the door account's signer list that is signing the transaction.builder()Creates a builder forImmutableXChainCreateAccountProofSig.copyOf(XChainCreateAccountProofSig instance) Creates an immutable copy of aXChainCreateAccountProofSigvalue.The destination account for the funds on the destination chain.booleanThis instance is equal to all instances ofImmutableXChainCreateAccountProofSigthat have equal attribute values.inthashCode()Computes a hash code from attributes:amount,signatureReward,attestationRewardAccount,attestationSignerAccount,destination,publicKey,wasLockingChainSend.The public key used to verify the signature.The total amount, in XRP, to be rewarded for providing a signature for cross-chain transfer or for signing for the cross-chain reward.toString()Prints the immutable valueXChainCreateAccountProofSigwith attribute values.booleanA boolean representing the chain where the event occurred.withAmount(CurrencyAmount value) Copy the current immutable object by setting a value for theamountattribute.Copy the current immutable object by setting a value for theattestationRewardAccountattribute.Copy the current immutable object by setting a value for theattestationSignerAccountattribute.withDestination(Address value) Copy the current immutable object by setting a value for thedestinationattribute.withPublicKey(PublicKey value) Copy the current immutable object by setting a value for thepublicKeyattribute.Copy the current immutable object by setting a value for thesignatureRewardattribute.withWasLockingChainSend(boolean value) Copy the current immutable object by setting a value for thewasLockingChainSendattribute.
-
Method Details
-
amount
The amount committed by theXChainAccountCreateCommittransaction on the source chain.- Specified by:
amountin interfaceXChainCreateAccountProofSig- Returns:
- A
CurrencyAmount.
-
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:
signatureRewardin interfaceXChainCreateAccountProofSig- Returns:
- An
XrpCurrencyAmount.
-
attestationRewardAccount
The account that should receive this signer's share of thesignatureReward().- Specified by:
attestationRewardAccountin interfaceXChainCreateAccountProofSig- Returns:
- An
Address.
-
attestationSignerAccount
The account on the door account's signer list that is signing the transaction.- Specified by:
attestationSignerAccountin interfaceXChainCreateAccountProofSig- Returns:
- An
Address.
-
destination
The destination account for the funds on the destination chain.- Specified by:
destinationin interfaceXChainCreateAccountProofSig- Returns:
- An
Address.
-
publicKey
The public key used to verify the signature.- Specified by:
publicKeyin interfaceXChainCreateAccountProofSig- Returns:
- A
PublicKey.
-
wasLockingChainSend
public boolean wasLockingChainSend()A boolean representing the chain where the event occurred.- Specified by:
wasLockingChainSendin interfaceXChainCreateAccountProofSig- Returns:
trueif the event occurred on the locking chain, otherwisefalse.
-
withAmount
Copy the current immutable object by setting a value for theamountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for amount- Returns:
- A modified copy of the
thisobject
-
withSignatureReward
Copy the current immutable object by setting a value for thesignatureRewardattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signatureReward- Returns:
- A modified copy of the
thisobject
-
withAttestationRewardAccount
Copy the current immutable object by setting a value for theattestationRewardAccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for attestationRewardAccount- Returns:
- A modified copy of the
thisobject
-
withAttestationSignerAccount
Copy the current immutable object by setting a value for theattestationSignerAccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for attestationSignerAccount- Returns:
- A modified copy of the
thisobject
-
withDestination
Copy the current immutable object by setting a value for thedestinationattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for destination- Returns:
- A modified copy of the
thisobject
-
withPublicKey
Copy the current immutable object by setting a value for thepublicKeyattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for publicKey- Returns:
- A modified copy of the
thisobject
-
withWasLockingChainSend
Copy the current immutable object by setting a value for thewasLockingChainSendattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for wasLockingChainSend- Returns:
- A modified copy of the
thisobject
-
equals
This instance is equal to all instances ofImmutableXChainCreateAccountProofSigthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:amount,signatureReward,attestationRewardAccount,attestationSignerAccount,destination,publicKey,wasLockingChainSend. -
toString
Prints the immutable valueXChainCreateAccountProofSigwith attribute values. -
copyOf
Creates an immutable copy of aXChainCreateAccountProofSigvalue. 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 forImmutableXChainCreateAccountProofSig.ImmutableXChainCreateAccountProofSig.builder() .amount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // requiredamount.signatureReward(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredsignatureReward.attestationRewardAccount(org.xrpl.xrpl4j.model.transactions.Address) // requiredattestationRewardAccount.attestationSignerAccount(org.xrpl.xrpl4j.model.transactions.Address) // requiredattestationSignerAccount.destination(org.xrpl.xrpl4j.model.transactions.Address) // requireddestination.publicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // requiredpublicKey.wasLockingChainSend(boolean) // requiredwasLockingChainSend.build();- Returns:
- A new ImmutableXChainCreateAccountProofSig builder
-