Package convex.core

Class Order

java.lang.Object
convex.core.data.AObject
convex.core.data.ACell
convex.core.Order
All Implemented Interfaces:
IValidated, IWriteable
public class Order extends ACell
Class representing an Ordering of transactions, along with the consensus position. An Ordering contains:
  • The Vector of known verified Blocks announced by the Peer
  • The proposed consensus point (point at which the peer believes there is sufficient alignment for consensus)
  • The current consensus point (point at which the peer has observed sufficient consistent consensus proposals)
An Ordering is immutable.

  • Method Details

    • create

      public static Order create()
      Create an empty Order
      Returns:
      New Order instance

    • encode

      public int encode​(byte[] bs, int pos)
      Description copied from class: ACell
      Writes this Cell's encoding to a byte array, including a tag byte which will be written first
      Specified by:
      encode in interface IWriteable
      Specified by:
      encode in class ACell
      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
      Specified by:
      encodeRaw in class ACell
      Parameters:
      bs - A byte array to which to write the encoding
      pos - The offset into the byte array
      Returns:
      New position after writing

    • 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.
      Returns:
      The estimated size for the binary representation of this object.

    • read

      public static Order read​(ByteBuffer bb) throws BadFormatException
      Decode an Order from a ByteBuffer
      Parameters:
      bb - ByteBuffer to read from
      Returns:
      Order instance
      Throws:
      BadFormatException - If encoding format is invalid

    • 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.
      Specified by:
      isCanonical in class ACell
      Returns:
      true if the object is in canonical format, false otherwise

    • isCVMValue

      public final boolean isCVMValue()
      Description copied from class: ACell
      Returns true if this object represents a first class CVM Value. Sub-structural cells that are not themselves first class values should return false. CVM values might not be in a canonical format, e.g. temporary data structures
      Specified by:
      isCVMValue in class ACell
      Returns:
      true if the object is a CVM Value, 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

    • checkConsistent

      public boolean checkConsistent​(Order bc)
      Checks if another Order is consistent with this Order. Order is defined as consistent iff:
      • Blocks are equal up to the Consensus Point of this Order
      Parameters:
      bc - Order to compare with
      Returns:
      True if chains are consistent, false otherwise.

    • getConsensusPoint

      public long getConsensusPoint()
      Gets the Consensus Point of this Order
      Returns:
      Consensus Point

    • getProposalPoint

      public long getProposalPoint()
      Gets the Proposal Point of this Order
      Returns:
      Proposal Point

    • getBlocks

      public AVector<Block> getBlocks()
      Gets the Blocks in this Order
      Returns:
      Vector of Blocks

    • getBlock

      public Block getBlock​(long i)
      Get a specific Block in this Order
      Parameters:
      i - Index of Block
      Returns:
      Block at specified index.

    • propose

      public Order propose​(Block block)
      Propose a new block of transactions in this Order
      Parameters:
      block - Block to append
      Returns:
      The updated chain

    • withBlocks

      public Order withBlocks​(AVector<Block> newBlocks)
      Updates blocks in this Order. Returns the same Order if the blocks are identical.
      Parameters:
      newBlocks - New blocks to use
      Returns:
      Updated Order, or the same order if unchanged

    • withProposalPoint

      public Order withProposalPoint​(long newProposalPoint)
      Updates this Order with a new proposal position. It is an error to set the proposal point before the consensus point, or beyond the last block.
      Parameters:
      newProposalPoint - New Proposal Point in Order
      Returns:
      Updated Order

    • withConsenusPoint

      public Order withConsenusPoint​(long newConsensusPoint)
      Updates this Order with a new consensus position. Proposal point will be set to the max of the consensus point and the current proposal point
      Parameters:
      newConsensusPoint - New consensus point
      Returns:
      Updated chain, or this Chain instance if no change.

    • getBlockCount

      public long getBlockCount()
      Get the number of Blocks in this Order
      Returns:
      Number of Blocks

    • withoutConsenus

      public Order withoutConsenus()
      Clears the consensus and proposal point
      Returns:
      Updated order with zeroed consensus positions

    • updateBlocks

      public Order updateBlocks​(AVector<Block> newBlocks)
      Update this chain with a new list of blocks
      Parameters:
      newBlocks - New vector of blocks to use in this Chain
      Returns:
      The updated Order

    • validate

      public void validate() throws InvalidDataException
      Description copied from interface: IValidated
      Validates the complete structure of this object. It is necessary to ensure all child Refs are validated, so the general contract for validate is:
      1. Call super.validate() - which will indirectly call validateCell()
      2. Call validate() on any contained cells in this class
      Specified by:
      validate in interface IValidated
      Overrides:
      validate in class ACell
      Throws:
      InvalidDataException - If the data Valie is invalid in any way

    • 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

    • 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

    • getRef

      public <R extends ACell> Ref<R> getRef​(int i)
      Description copied from class: ACell
      Gets a numbered child Ref from within this Cell.
      Overrides:
      getRef in class ACell
      Type Parameters:
      R - Type of referenced Cell
      Parameters:
      i - Index of ref to get
      Returns:
      The Ref at the specified index

    • updateRefs

      public Order updateRefs​(IRefFunction func)
      Description copied from class: ACell
      Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.
      Overrides:
      updateRefs in class ACell
      Parameters:
      func - Ref update function
      Returns:
      Cell with updated Refs

    • 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

    • toCanonical

      public ACell toCanonical()
      Description copied from class: ACell
      Converts this Cell to its canonical version. Returns this if already canonical
      Specified by:
      toCanonical in class ACell
      Returns:
      Canonical version of Cell