Package convex.core.transactions

Class Transfer

java.lang.Object
convex.core.data.AObject
convex.core.data.ACell
convex.core.transactions.ATransaction
convex.core.transactions.Transfer
All Implemented Interfaces:
IValidated, IWriteable
public class Transfer extends ATransaction
Transaction class representing a coin Transfer from one account to another

  • Field Details

    • TRANSFER_JUICE

      public static final long TRANSFER_JUICE
      See Also:
      Constant Field Values

    • target

      protected final Address target

    • amount

      protected final long amount

  • Constructor Details

    • Transfer

      protected Transfer​(Address address, long nonce, Address target, long amount)

  • Method Details

    • create

      public static Transfer create​(Address address, long nonce, Address target, long amount)

    • encode

      public int encode​(byte[] bs, int pos)
      Description copied from class: ATransaction
      Writes this transaction to a byte array, including the message tag
      Specified by:
      encode in interface IWriteable
      Specified by:
      encode in class ATransaction
      Parameters:
      bs - A byte array to which to write the encoding
      pos - The offset into the byte array
      Returns:
      New position after writing

    • encodeRaw

      public int encodeRaw​(byte[] bs, int pos)
      Description copied from class: ACell
      Writes this Cell's encoding to a byte array, excluding the tag byte
      Overrides:
      encodeRaw in class ATransaction
      Parameters:
      bs - A byte array to which to write the encoding
      pos - The offset into the byte array
      Returns:
      New position after writing

    • read

      public static Transfer read​(ByteBuffer bb) throws BadFormatException
      Read a Transfer transaction from a ByteBuffer
      Parameters:
      bb - ByteBuffer containing the transaction
      Returns:
      The Transfer object
      Throws:
      BadFormatException - if the data is invalid

    • apply

      public <T extends ACell> Context<T> apply​(Context<?> ctx)
      Description copied from class: ATransaction
      Applies the functional effect of this transaction to the current state. Important points:
      • Assumes all relevant accounting preparation already complete, including juice reservation
      • Performs complete state update (including any rollbacks from errors)
      • Produces result, which may be exceptional
      • Does not finalise memory/juice accounting (will be completed afterwards)
      Specified by:
      apply in class ATransaction
      Parameters:
      ctx - Context for which to apply this Transaction
      Returns:
      The updated chain state

    • estimatedEncodingSize

      public int estimatedEncodingSize()
      Description copied from interface: IWriteable
      Estimate the encoded data size for this Cell. Used for quickly sizing buffers. Implementations should try to return a size that is likely to contain the entire object when represented in binary format, including the tag byte.
      Specified by:
      estimatedEncodingSize in interface IWriteable
      Specified by:
      estimatedEncodingSize in class ATransaction
      Returns:
      The estimated size for the binary representation of this object.

    • isCanonical

      public boolean isCanonical()
      Description copied from class: ACell
      Returns true if this Cell is in a canonical format for message writing. Reading or writing a non-canonical value should be considered illegal, but non-canonical objects may be used on a temporary internal basis.
      Overrides:
      isCanonical in class ATransaction
      Returns:
      true if the object is in canonical format, false otherwise

    • print

      public void print​(StringBuilder sb)
      Description copied from class: AObject
      Prints this Object to a readable String Representation
      Specified by:
      print in class AObject
      Parameters:
      sb - StringBuilder to append to

    • validateCell

      public void validateCell() throws InvalidDataException
      Description copied from class: ACell
      Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.
      Specified by:
      validateCell in class ACell
      Throws:
      InvalidDataException - If the Cell is invalid

    • getTarget

      public Address getTarget()
      Gets the target address for this transfer
      Returns:
      Address of the destination for this transfer.

    • getAmount

      public long getAmount()
      Gets the transfer amount for this transaction.
      Returns:
      Amount of transfer, as a long

    • getMaxJuice

      public Long getMaxJuice()
      Description copied from class: ATransaction
      Gets the max juice allowed for this transaction
      Specified by:
      getMaxJuice in class ATransaction
      Returns:
      Juice limit

    • getRefCount

      public int getRefCount()
      Description copied from class: ACell
      Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance. Contained Refs may be either external or embedded.
      Specified by:
      getRefCount in class ACell
      Returns:
      The number of Refs in this Cell

    • withSequence

      public Transfer withSequence​(long newSequence)
      Description copied from class: ATransaction
      Updates this transaction with the specified sequence number
      Specified by:
      withSequence in class ATransaction
      Parameters:
      newSequence - New sequence number
      Returns:
      Updated transaction, or this transaction if the sequence number is unchanged.

    • withAddress

      public Transfer withAddress​(Address newAddress)
      Description copied from class: ATransaction
      Updates this transaction with the specified address
      Specified by:
      withAddress in class ATransaction
      Parameters:
      newAddress - New address
      Returns:
      Updated transaction, or this transaction if unchanged.

    • getTag

      public byte getTag()
      Description copied from class: ACell
      Gets the tag byte for this cell. The tag byte is always written as the first byte of the Cell's Encoding
      Specified by:
      getTag in class ACell
      Returns:
      Tag byte for this Cell