Class ImmutableMpTokenIssuanceCreate
- All Implemented Interfaces:
MpTokenIssuanceCreate,Transaction
MpTokenIssuanceCreate.
Use the builder to create immutable instances:
ImmutableMpTokenIssuanceCreate.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableMpTokenIssuanceCreate. -
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionaccount()The uniqueAddressof the account that initiated this transaction.Hash value identifying another transaction.An asset scale is the difference, in orders of magnitude, between a standard unit and a corresponding fractional unit.builder()Creates a builder forImmutableMpTokenIssuanceCreate.copyOf(MpTokenIssuanceCreate instance) Creates an immutable copy of aMpTokenIssuanceCreatevalue.delegate()The delegate account that is sending the transaction on behalf of theaccount().booleanThis instance is equal to all instances ofImmutableMpTokenIssuanceCreatethat have equal attribute values.fee()TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.flags()Set ofMpTokenIssuanceCreateFlagss for thisMpTokenIssuanceCreate.inthashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,assetScale,transferFee,maximumAmount,mpTokenMetadata.Optional<com.google.common.primitives.UnsignedInteger> Highest ledger index this transaction can appear in.The maximum number of this token's units that should ever be issued.com.google.common.collect.ImmutableList<MemoWrapper> memos()Additional arbitrary information used to identify thisTransaction.Arbitrary metadata about this issuance, in hex format.com.google.common.primitives.UnsignedIntegersequence()The sequence number of the account submitting theTransaction.com.google.common.collect.ImmutableList<SignerWrapper> signers()Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.ThePublicKeythat corresponds to the private key used to sign this transaction.Optional<com.google.common.primitives.UnsignedInteger> ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.Optional<com.google.common.primitives.UnsignedInteger> The sequence number of theTicketObjectto use in place of asequence()number.toString()Prints the immutable valueMpTokenIssuanceCreatewith attribute values.The signature that verifies this transaction as originating from the account it says it is from.The type of transaction.The value specifies the fee to charged by the issuer for secondary sales of the Token, if such sales are allowed.withAccount(Address value) Copy the current immutable object by setting a value for theaccountattribute.withAccountTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute.withAccountTransactionId(Hash256 value) Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.withAssetScale(Optional<? extends AssetScale> optional) Copy the current immutable object by setting an optional value for theassetScaleattribute.withAssetScale(AssetScale value) Copy the current immutable object by setting a present value for the optionalassetScaleattribute.withDelegate(Optional<? extends Address> optional) Copy the current immutable object by setting an optional value for thedelegateattribute.withDelegate(Address value) Copy the current immutable object by setting a present value for the optionaldelegateattribute.withFee(XrpCurrencyAmount value) Copy the current immutable object by setting a value for thefeeattribute.Copy the current immutable object by setting a value for theflagsattribute.withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute.withMaximumAmount(Optional<? extends MpTokenNumericAmount> optional) Copy the current immutable object by setting an optional value for themaximumAmountattribute.Copy the current immutable object by setting a present value for the optionalmaximumAmountattribute.withMemos(Iterable<? extends MemoWrapper> elements) Copy the current immutable object with elements that replace the content ofmemos.withMemos(MemoWrapper... elements) Copy the current immutable object with elements that replace the content ofmemos.withMpTokenMetadata(Optional<? extends MpTokenMetadata> optional) Copy the current immutable object by setting an optional value for thempTokenMetadataattribute.Copy the current immutable object by setting a present value for the optionalmpTokenMetadataattribute.withNetworkId(Optional<? extends NetworkId> optional) Copy the current immutable object by setting an optional value for thenetworkIdattribute.withNetworkId(NetworkId value) Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.withSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesequenceattribute.withSigners(Iterable<? extends SignerWrapper> elements) Copy the current immutable object with elements that replace the content ofsigners.withSigners(SignerWrapper... elements) Copy the current immutable object with elements that replace the content ofsigners.withSigningPublicKey(PublicKey value) Copy the current immutable object by setting a value for thesigningPublicKeyattribute.withSourceTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalsourceTagattribute.withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute.withTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.withTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute.withTransactionSignature(Optional<? extends Signature> optional) Copy the current immutable object by setting an optional value for thetransactionSignatureattribute.Copy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.Copy the current immutable object by setting a value for thetransactionTypeattribute.withTransferFee(Optional<? extends TransferFee> optional) Copy the current immutable object by setting an optional value for thetransferFeeattribute.withTransferFee(TransferFee value) Copy the current immutable object by setting a present value for the optionaltransferFeeattribute.withUnknownFields(Map<String, ? extends Object> entries) Copy the current immutable object by replacing theunknownFieldsmap with the specified map.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
transactionFlags, validateDelegateNotSameAsAccount
-
Method Details
-
account
The uniqueAddressof the account that initiated this transaction.- Specified by:
accountin interfaceTransaction- Returns:
- The
Addressof the account submitting this transaction.
-
transactionType
The type of transaction.- Specified by:
transactionTypein interfaceTransaction- Returns:
- A
TransactionType.
-
fee
TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.This field is auto-fillable
- Specified by:
feein interfaceTransaction- Returns:
- An
XrpCurrencyAmountrepresenting the transaction cost. - See Also:
-
sequence
public com.google.common.primitives.UnsignedInteger sequence()The sequence number of the account submitting theTransaction. ATransactionis only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account.This field is auto-fillable
- Specified by:
sequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the sequence of the transaction. - See Also:
-
ticketSequence
The sequence number of theTicketObjectto use in place of asequence()number. If this is provided,sequence()must be 0. Cannot be used withaccountTransactionId().- Specified by:
ticketSequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the ticket sequence of the transaction.
-
accountTransactionId
Hash value identifying another transaction. If provided, thisTransactionis only valid if the sending account's previously-sent transaction matches the provided hash.- Specified by:
accountTransactionIdin interfaceTransaction- Returns:
- An
Optionalof typeHash256containing the account transaction ID.
-
lastLedgerSequence
Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.- Specified by:
lastLedgerSequencein interfaceTransaction- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the last ledger sequence.
-
memos
Additional arbitrary information used to identify thisTransaction.- Specified by:
memosin interfaceTransaction- Returns:
- A
ListofMemoWrappers.
-
signers
Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.- Specified by:
signersin interfaceTransaction- Returns:
- A
ListofSignerWrappers.
-
sourceTag
ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.- Specified by:
sourceTagin interfaceTransaction- Returns:
- An
OptionalUnsignedIntegerrepresenting the source account's tag.
-
signingPublicKey
ThePublicKeythat corresponds to the private key used to sign this transaction. If an empty string, iePublicKey.MULTI_SIGN_PUBLIC_KEY, indicates a multi-signature is present in theTransaction.signers()field instead.- Specified by:
signingPublicKeyin interfaceTransaction- Returns:
- A
PublicKeycontaining the public key of the account submitting the transaction, orPublicKey.MULTI_SIGN_PUBLIC_KEYif the transaction is multi-signed.
-
transactionSignature
The signature that verifies this transaction as originating from the account it says it is from.This field is automatically added when signing this
Transaction.- Specified by:
transactionSignaturein interfaceTransaction- Returns:
- An
OptionalStringcontaining the transaction signature.
-
networkId
- Specified by:
networkIdin interfaceTransaction- Returns:
- The value of the
networkIdattribute
-
delegate
The delegate account that is sending the transaction on behalf of theaccount().The way the
Delegatefield works is somewhat akin toRegularKey. Theaccount()field is the delegating account, theDelegatefield is the delegate, and thesigningPublicKey()andtransactionSignature()are based on the delegate's keys.If a
Delegatehas multisign enabled, they can also use that multisign setup on their delegated transactions.The delegate will pay the fees on the transaction, to prevent a delegate from draining an account's XRP via fees. Only the
account()'s sequence number is incremented, not theDelegate's.This field is part of the Permission Delegation feature (XLS-75).
- Specified by:
delegatein interfaceTransaction- Returns:
- An
OptionalAddressof the delegate account. - See Also:
-
unknownFields
- Specified by:
unknownFieldsin interfaceTransaction- Returns:
- The value of the
unknownFieldsattribute
-
flags
Set ofMpTokenIssuanceCreateFlagss for thisMpTokenIssuanceCreate.- Specified by:
flagsin interfaceMpTokenIssuanceCreate- Returns:
- The
MpTokenIssuanceCreateFlagsfor this transaction.
-
assetScale
An asset scale is the difference, in orders of magnitude, between a standard unit and a corresponding fractional unit. More formally, the asset scale is a non-negative integer (0, 1, 2, …) such that one standard unit equals 10^(-scale) of a corresponding fractional unit. If the fractional unit equals the standard unit, then the asset scale is 0. Note that this value is optional, and will default to 0 if not supplied.- Specified by:
assetScalein interfaceMpTokenIssuanceCreate- Returns:
- An optionally present
AssetScale.
-
transferFee
The value specifies the fee to charged by the issuer for secondary sales of the Token, if such sales are allowed. Valid values for this field are between 0 and 50,000 inclusive, allowing transfer rates of between 0.000% and 50.000% in increments of 0.001. The default value is 0 if this field is not specified.The field MUST NOT be present if the tfMPTCanTransfer flag is not set.
- Specified by:
transferFeein interfaceMpTokenIssuanceCreate- Returns:
- An optionally present
TransferFee.
-
maximumAmount
The maximum number of this token's units that should ever be issued. This field is optional. If omitted, the implementation will set this to an empty default field value, which will be interpreted at runtime as the current maximum allowed value (currently 0x7FFF'FFFF'FFFF'FFFF).- Specified by:
maximumAmountin interfaceMpTokenIssuanceCreate- Returns:
- An optionally present
MpTokenNumericAmount.
-
mpTokenMetadata
Arbitrary metadata about this issuance, in hex format. The limit for this field is 1024 bytes.- Specified by:
mpTokenMetadatain interfaceMpTokenIssuanceCreate- Returns:
- An optionally present
MpTokenMetadata.
-
withAccount
Copy the current immutable object by setting a value for theaccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for account- Returns:
- A modified copy of the
thisobject
-
withTransactionType
Copy the current immutable object by setting a value for thetransactionTypeattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for transactionType- Returns:
- A modified copy of the
thisobject
-
withFee
Copy the current immutable object by setting a value for thefeeattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for fee- Returns:
- A modified copy of the
thisobject
-
withSequence
public final ImmutableMpTokenIssuanceCreate withSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesequenceattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for sequence- Returns:
- A modified copy of the
thisobject
-
withTicketSequence
public final ImmutableMpTokenIssuanceCreate withTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.- Parameters:
value- The value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withTicketSequence
public final ImmutableMpTokenIssuanceCreate withTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.- Parameters:
value- The value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
public final ImmutableMpTokenIssuanceCreate withAccountTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutableMpTokenIssuanceCreate withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.- Parameters:
value- The value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutableMpTokenIssuanceCreate withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of memos elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of signers elements to set- Returns:
- A modified copy of
thisobject
-
withSourceTag
public final ImmutableMpTokenIssuanceCreate withSourceTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalsourceTagattribute.- Parameters:
value- The value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSourceTag
public final ImmutableMpTokenIssuanceCreate withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSigningPublicKey
Copy the current immutable object by setting a value for thesigningPublicKeyattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signingPublicKey- Returns:
- A modified copy of the
thisobject
-
withTransactionSignature
Copy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.- Parameters:
value- The value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withTransactionSignature
public final ImmutableMpTokenIssuanceCreate withTransactionSignature(Optional<? extends Signature> optional) Copy the current immutable object by setting an optional value for thetransactionSignatureattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.- Parameters:
value- The value for networkId- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting an optional value for thenetworkIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for networkId- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting a present value for the optionaldelegateattribute.- Parameters:
value- The value for delegate- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting an optional value for thedelegateattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for delegate- Returns:
- A modified copy of
thisobject
-
withUnknownFields
Copy the current immutable object by replacing theunknownFieldsmap with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
entries- The entries to be added to the unknownFields map- Returns:
- A modified copy of
thisobject
-
withFlags
Copy the current immutable object by setting a value for theflagsattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for flags- Returns:
- A modified copy of the
thisobject
-
withAssetScale
Copy the current immutable object by setting a present value for the optionalassetScaleattribute.- Parameters:
value- The value for assetScale- Returns:
- A modified copy of
thisobject
-
withAssetScale
Copy the current immutable object by setting an optional value for theassetScaleattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for assetScale- Returns:
- A modified copy of
thisobject
-
withTransferFee
Copy the current immutable object by setting a present value for the optionaltransferFeeattribute.- Parameters:
value- The value for transferFee- Returns:
- A modified copy of
thisobject
-
withTransferFee
public final ImmutableMpTokenIssuanceCreate withTransferFee(Optional<? extends TransferFee> optional) Copy the current immutable object by setting an optional value for thetransferFeeattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for transferFee- Returns:
- A modified copy of
thisobject
-
withMaximumAmount
Copy the current immutable object by setting a present value for the optionalmaximumAmountattribute.- Parameters:
value- The value for maximumAmount- Returns:
- A modified copy of
thisobject
-
withMaximumAmount
public final ImmutableMpTokenIssuanceCreate withMaximumAmount(Optional<? extends MpTokenNumericAmount> optional) Copy the current immutable object by setting an optional value for themaximumAmountattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for maximumAmount- Returns:
- A modified copy of
thisobject
-
withMpTokenMetadata
Copy the current immutable object by setting a present value for the optionalmpTokenMetadataattribute.- Parameters:
value- The value for mpTokenMetadata- Returns:
- A modified copy of
thisobject
-
withMpTokenMetadata
public final ImmutableMpTokenIssuanceCreate withMpTokenMetadata(Optional<? extends MpTokenMetadata> optional) Copy the current immutable object by setting an optional value for thempTokenMetadataattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for mpTokenMetadata- Returns:
- A modified copy of
thisobject
-
equals
This instance is equal to all instances ofImmutableMpTokenIssuanceCreatethat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,assetScale,transferFee,maximumAmount,mpTokenMetadata. -
toString
Prints the immutable valueMpTokenIssuanceCreatewith attribute values. -
copyOf
Creates an immutable copy of aMpTokenIssuanceCreatevalue. 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 MpTokenIssuanceCreate instance
-
builder
Creates a builder forImmutableMpTokenIssuanceCreate.ImmutableMpTokenIssuanceCreate.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // requiredaccount.transactionType(org.xrpl.xrpl4j.model.transactions.TransactionType) // optionaltransactionType.fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredfee.sequence(com.google.common.primitives.UnsignedInteger) // optionalsequence.ticketSequence(com.google.common.primitives.UnsignedInteger) // optionalticketSequence.accountTransactionId(Hash256) // optionalaccountTransactionId.lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optionallastLedgerSequence.addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) //memoselements .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) //signerselements .sourceTag(com.google.common.primitives.UnsignedInteger) // optionalsourceTag.signingPublicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // optionalsigningPublicKey.transactionSignature(org.xrpl.xrpl4j.crypto.signing.Signature) // optionaltransactionSignature.networkId(NetworkId) // optionalnetworkId.delegate(Address) // optionaldelegate.putUnknownFields|putAllUnknownFields(String => Object) //unknownFieldsmappings .flags(org.xrpl.xrpl4j.model.flags.MpTokenIssuanceCreateFlags) // optionalflags.assetScale(AssetScale) // optionalassetScale.transferFee(TransferFee) // optionaltransferFee.maximumAmount(MpTokenNumericAmount) // optionalmaximumAmount.mpTokenMetadata(MpTokenMetadata) // optionalmpTokenMetadata.build();- Returns:
- A new ImmutableMpTokenIssuanceCreate builder
-