Class ImmutableMpTokenIssuanceCreate

java.lang.Object
org.xrpl.xrpl4j.model.transactions.ImmutableMpTokenIssuanceCreate
All Implemented Interfaces:
MpTokenIssuanceCreate, Transaction

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

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

  • Method Details

    • account

      public Address account()
      The unique Address of the account that initiated this transaction.
      Specified by:
      account in interface Transaction
      Returns:
      The Address of the account submitting this transaction.
    • transactionType

      public TransactionType transactionType()
      The type of transaction.
      Specified by:
      transactionType in interface Transaction
      Returns:
      A TransactionType.
    • fee

      public XrpCurrencyAmount fee()
      The String representation 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:
      fee in interface Transaction
      Returns:
      An XrpCurrencyAmount representing the transaction cost.
      See Also:
      • "https://xrpl.org/transaction-common-fields.html#auto-fillable-fields"
    • sequence

      public com.google.common.primitives.UnsignedInteger sequence()
      The sequence number of the account submitting the Transaction. A Transaction is 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:
      sequence in interface Transaction
      Returns:
      An UnsignedInteger representing the sequence of the transaction.
      See Also:
      • "https://xrpl.org/transaction-common-fields.html#auto-fillable-fields"
    • ticketSequence

      public Optional<com.google.common.primitives.UnsignedInteger> ticketSequence()
      The sequence number of the TicketObject to use in place of a sequence() number. If this is provided, sequence() must be 0. Cannot be used with accountTransactionId().
      Specified by:
      ticketSequence in interface Transaction
      Returns:
      An UnsignedInteger representing the ticket sequence of the transaction.
    • accountTransactionId

      public Optional<Hash256> accountTransactionId()
      Hash value identifying another transaction. If provided, this Transaction is only valid if the sending account's previously-sent transaction matches the provided hash.
      Specified by:
      accountTransactionId in interface Transaction
      Returns:
      An Optional of type Hash256 containing the account transaction ID.
    • lastLedgerSequence

      public Optional<com.google.common.primitives.UnsignedInteger> 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:
      lastLedgerSequence in interface Transaction
      Returns:
      An Optional of type UnsignedInteger representing the last ledger sequence.
    • memos

      public com.google.common.collect.ImmutableList<MemoWrapper> memos()
      Additional arbitrary information used to identify this Transaction.
      Specified by:
      memos in interface Transaction
      Returns:
      A List of MemoWrappers.
    • signers

      public com.google.common.collect.ImmutableList<SignerWrapper> signers()
      Array of SignerWrappers that represent a multi-signature which authorizes this Transaction.
      Specified by:
      signers in interface Transaction
      Returns:
      A List of SignerWrappers.
    • sourceTag

      public Optional<com.google.common.primitives.UnsignedInteger> sourceTag()
      Arbitrary UnsignedInteger used to identify the reason for this Transaction, or a sender on whose behalf this Transaction is made.
      Specified by:
      sourceTag in interface Transaction
      Returns:
      An Optional UnsignedInteger representing the source account's tag.
    • signingPublicKey

      public PublicKey signingPublicKey()
      The PublicKey that corresponds to the private key used to sign this transaction. If an empty string, ie PublicKey.MULTI_SIGN_PUBLIC_KEY, indicates a multi-signature is present in the Transaction.signers() field instead.
      Specified by:
      signingPublicKey in interface Transaction
      Returns:
      A PublicKey containing the public key of the account submitting the transaction, or PublicKey.MULTI_SIGN_PUBLIC_KEY if the transaction is multi-signed.
    • transactionSignature

      public Optional<Signature> 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:
      transactionSignature in interface Transaction
      Returns:
      An Optional String containing the transaction signature.
    • networkId

      public Optional<NetworkId> networkId()
      Specified by:
      networkId in interface Transaction
      Returns:
      The value of the networkId attribute
    • delegate

      public Optional<Address> delegate()
      The delegate account that is sending the transaction on behalf of the account().

      The way the Delegate field works is somewhat akin to RegularKey. The account() field is the delegating account, the Delegate field is the delegate, and the signingPublicKey() and transactionSignature() are based on the delegate's keys.

      If a Delegate has 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 the Delegate's.

      This field is part of the Permission Delegation feature (XLS-75).

      Specified by:
      delegate in interface Transaction
      Returns:
      An Optional Address of the delegate account.
      See Also:
      • "https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0075-permission-delegation"
    • unknownFields

      public com.google.common.collect.ImmutableMap<String,Object> unknownFields()
      Specified by:
      unknownFields in interface Transaction
      Returns:
      The value of the unknownFields attribute
    • flags

      Specified by:
      flags in interface MpTokenIssuanceCreate
      Returns:
      The MpTokenIssuanceCreateFlags for this transaction.
    • assetScale

      public Optional<AssetScale> 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:
      assetScale in interface MpTokenIssuanceCreate
      Returns:
      An optionally present AssetScale.
    • transferFee

      public Optional<TransferFee> 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:
      transferFee in interface MpTokenIssuanceCreate
      Returns:
      An optionally present TransferFee.
    • maximumAmount

      public Optional<MpTokenNumericAmount> 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:
      maximumAmount in interface MpTokenIssuanceCreate
      Returns:
      An optionally present MpTokenNumericAmount.
    • mpTokenMetadata

      public Optional<MpTokenMetadata> mpTokenMetadata()
      Arbitrary metadata about this issuance, in hex format. The limit for this field is 1024 bytes.
      Specified by:
      mpTokenMetadata in interface MpTokenIssuanceCreate
      Returns:
      An optionally present MpTokenMetadata.
    • withAccount

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

      public final ImmutableMpTokenIssuanceCreate withTransactionType(TransactionType value)
      Copy the current immutable object by setting a value for the transactionType attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for transactionType
      Returns:
      A modified copy of the this object
    • withFee

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

      public final ImmutableMpTokenIssuanceCreate withSequence(com.google.common.primitives.UnsignedInteger value)
      Copy the current immutable object by setting a value for the sequence attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for sequence
      Returns:
      A modified copy of the this object
    • withTicketSequence

      public final ImmutableMpTokenIssuanceCreate withTicketSequence(com.google.common.primitives.UnsignedInteger value)
      Copy the current immutable object by setting a present value for the optional ticketSequence attribute.
      Parameters:
      value - The value for ticketSequence
      Returns:
      A modified copy of this object
    • withTicketSequence

      public final ImmutableMpTokenIssuanceCreate withTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
      Copy the current immutable object by setting an optional value for the ticketSequence attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for ticketSequence
      Returns:
      A modified copy of this object
    • withAccountTransactionId

      public final ImmutableMpTokenIssuanceCreate withAccountTransactionId(Hash256 value)
      Copy the current immutable object by setting a present value for the optional accountTransactionId attribute.
      Parameters:
      value - The value for accountTransactionId
      Returns:
      A modified copy of this object
    • withAccountTransactionId

      public final ImmutableMpTokenIssuanceCreate withAccountTransactionId(Optional<? extends Hash256> optional)
      Copy the current immutable object by setting an optional value for the accountTransactionId 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 accountTransactionId
      Returns:
      A modified copy of this object
    • withLastLedgerSequence

      public final ImmutableMpTokenIssuanceCreate withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value)
      Copy the current immutable object by setting a present value for the optional lastLedgerSequence attribute.
      Parameters:
      value - The value for lastLedgerSequence
      Returns:
      A modified copy of this object
    • withLastLedgerSequence

      public final ImmutableMpTokenIssuanceCreate withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
      Copy the current immutable object by setting an optional value for the lastLedgerSequence attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for lastLedgerSequence
      Returns:
      A modified copy of this object
    • withMemos

      public final ImmutableMpTokenIssuanceCreate withMemos(MemoWrapper... elements)
      Copy the current immutable object with elements that replace the content of memos.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object
    • withMemos

      public final ImmutableMpTokenIssuanceCreate withMemos(Iterable<? extends MemoWrapper> elements)
      Copy the current immutable object with elements that replace the content of memos. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of memos elements to set
      Returns:
      A modified copy of this object
    • withSigners

      public final ImmutableMpTokenIssuanceCreate withSigners(SignerWrapper... elements)
      Copy the current immutable object with elements that replace the content of signers.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object
    • withSigners

      public final ImmutableMpTokenIssuanceCreate withSigners(Iterable<? extends SignerWrapper> elements)
      Copy the current immutable object with elements that replace the content of signers. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of signers elements to set
      Returns:
      A modified copy of this object
    • withSourceTag

      public final ImmutableMpTokenIssuanceCreate withSourceTag(com.google.common.primitives.UnsignedInteger value)
      Copy the current immutable object by setting a present value for the optional sourceTag attribute.
      Parameters:
      value - The value for sourceTag
      Returns:
      A modified copy of this object
    • withSourceTag

      public final ImmutableMpTokenIssuanceCreate withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
      Copy the current immutable object by setting an optional value for the sourceTag attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for sourceTag
      Returns:
      A modified copy of this object
    • withSigningPublicKey

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

      public final ImmutableMpTokenIssuanceCreate withTransactionSignature(Signature value)
      Copy the current immutable object by setting a present value for the optional transactionSignature attribute.
      Parameters:
      value - The value for transactionSignature
      Returns:
      A modified copy of this object
    • withTransactionSignature

      public final ImmutableMpTokenIssuanceCreate withTransactionSignature(Optional<? extends Signature> optional)
      Copy the current immutable object by setting an optional value for the transactionSignature 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 transactionSignature
      Returns:
      A modified copy of this object
    • withNetworkId

      public final ImmutableMpTokenIssuanceCreate withNetworkId(NetworkId value)
      Copy the current immutable object by setting a present value for the optional networkId attribute.
      Parameters:
      value - The value for networkId
      Returns:
      A modified copy of this object
    • withNetworkId

      public final ImmutableMpTokenIssuanceCreate withNetworkId(Optional<? extends NetworkId> optional)
      Copy the current immutable object by setting an optional value for the networkId 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 networkId
      Returns:
      A modified copy of this object
    • withDelegate

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

      public final ImmutableMpTokenIssuanceCreate withDelegate(Optional<? extends Address> optional)
      Copy the current immutable object by setting an optional value for the delegate 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 delegate
      Returns:
      A modified copy of this object
    • withUnknownFields

      public final ImmutableMpTokenIssuanceCreate withUnknownFields(Map<String,? extends Object> entries)
      Copy the current immutable object by replacing the unknownFields map 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 returning this.
      Parameters:
      entries - The entries to be added to the unknownFields map
      Returns:
      A modified copy of this object
    • withFlags

      Copy the current immutable object by setting a value for the flags attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for flags
      Returns:
      A modified copy of the this object
    • withAssetScale

      public final ImmutableMpTokenIssuanceCreate withAssetScale(AssetScale value)
      Copy the current immutable object by setting a present value for the optional assetScale attribute.
      Parameters:
      value - The value for assetScale
      Returns:
      A modified copy of this object
    • withAssetScale

      public final ImmutableMpTokenIssuanceCreate withAssetScale(Optional<? extends AssetScale> optional)
      Copy the current immutable object by setting an optional value for the assetScale 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 assetScale
      Returns:
      A modified copy of this object
    • withTransferFee

      public final ImmutableMpTokenIssuanceCreate withTransferFee(TransferFee value)
      Copy the current immutable object by setting a present value for the optional transferFee attribute.
      Parameters:
      value - The value for transferFee
      Returns:
      A modified copy of this object
    • withTransferFee

      public final ImmutableMpTokenIssuanceCreate withTransferFee(Optional<? extends TransferFee> optional)
      Copy the current immutable object by setting an optional value for the transferFee 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 transferFee
      Returns:
      A modified copy of this object
    • withMaximumAmount

      public final ImmutableMpTokenIssuanceCreate withMaximumAmount(MpTokenNumericAmount value)
      Copy the current immutable object by setting a present value for the optional maximumAmount attribute.
      Parameters:
      value - The value for maximumAmount
      Returns:
      A modified copy of this object
    • withMaximumAmount

      public final ImmutableMpTokenIssuanceCreate withMaximumAmount(Optional<? extends MpTokenNumericAmount> optional)
      Copy the current immutable object by setting an optional value for the maximumAmount 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 maximumAmount
      Returns:
      A modified copy of this object
    • withMpTokenMetadata

      public final ImmutableMpTokenIssuanceCreate withMpTokenMetadata(MpTokenMetadata value)
      Copy the current immutable object by setting a present value for the optional mpTokenMetadata attribute.
      Parameters:
      value - The value for mpTokenMetadata
      Returns:
      A modified copy of this object
    • withMpTokenMetadata

      public final ImmutableMpTokenIssuanceCreate withMpTokenMetadata(Optional<? extends MpTokenMetadata> optional)
      Copy the current immutable object by setting an optional value for the mpTokenMetadata 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 mpTokenMetadata
      Returns:
      A modified copy of this object
    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableMpTokenIssuanceCreate 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: account, transactionType, fee, sequence, ticketSequence, accountTransactionId, lastLedgerSequence, memos, signers, sourceTag, signingPublicKey, transactionSignature, networkId, delegate, unknownFields, flags, assetScale, transferFee, maximumAmount, mpTokenMetadata.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value
    • toString

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

      public static ImmutableMpTokenIssuanceCreate copyOf(MpTokenIssuanceCreate instance)
      Creates an immutable copy of a MpTokenIssuanceCreate 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 MpTokenIssuanceCreate instance
    • builder

      public static ImmutableMpTokenIssuanceCreate.Builder builder()
      Creates a builder for ImmutableMpTokenIssuanceCreate.
       ImmutableMpTokenIssuanceCreate.builder()
          .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
          .transactionType(org.xrpl.xrpl4j.model.transactions.TransactionType) // optional transactionType
          .fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // required fee
          .sequence(com.google.common.primitives.UnsignedInteger) // optional sequence
          .ticketSequence(com.google.common.primitives.UnsignedInteger) // optional ticketSequence
          .accountTransactionId(Hash256) // optional accountTransactionId
          .lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optional lastLedgerSequence
          .addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) // memos elements
          .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) // signers elements
          .sourceTag(com.google.common.primitives.UnsignedInteger) // optional sourceTag
          .signingPublicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // optional signingPublicKey
          .transactionSignature(org.xrpl.xrpl4j.crypto.signing.Signature) // optional transactionSignature
          .networkId(NetworkId) // optional networkId
          .delegate(Address) // optional delegate
          .putUnknownFields|putAllUnknownFields(String => Object) // unknownFields mappings
          .flags(org.xrpl.xrpl4j.model.flags.MpTokenIssuanceCreateFlags) // optional flags
          .assetScale(AssetScale) // optional assetScale
          .transferFee(TransferFee) // optional transferFee
          .maximumAmount(MpTokenNumericAmount) // optional maximumAmount
          .mpTokenMetadata(MpTokenMetadata) // optional mpTokenMetadata
          .build();
       
      Returns:
      A new ImmutableMpTokenIssuanceCreate builder