Package convex.core

Class State

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<MapEntry<Keyword,ACell>>

convex.core.data.ADataStructure<MapEntry<Keyword,ACell>>

convex.core.data.AMap<Keyword,ACell>

convex.core.data.ARecord

convex.core.State

All Implemented Interfaces:

IAssociative<Keyword,ACell>, IValidated, IWriteable, Map<Keyword,ACell>

public class State
extends ARecord

Class representing the immutable state of the CVM State transitions are represented by blocks of transactions, according to the logic: s[n+1] = s[n].applyBlock(b[n]) State contains the following elements - Map of AccountStatus for every Address - Map of PeerStatus for every Peer Address - Global values - Schedule data structure "State. You're doing it wrong" - Rich Hickey

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final State	EMPTY	An empty State
static final Index<AccountKey,PeerStatus>	EMPTY_PEERS
static final Index<ABlob,AVector<ACell>>	EMPTY_SCHEDULE
static final int	GLOBAL_FEES
static final int	GLOBAL_JUICE_PRICE
static final int	GLOBAL_MEMORY_CVX
static final int	GLOBAL_MEMORY_MEM
static final int	GLOBAL_PROTOCOL
static final AVector<Symbol>	GLOBAL_SYMBOLS	Symbols for global values in :globals Vector
static final int	GLOBAL_TIMESTAMP

Fields inherited from class convex.core.data.ARecord

DEFAULT_VALUE

Fields inherited from class convex.core.data.ADataStructure

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Method Summary

Modifier and Type	Method	Description
State	addActor()	Adds a new Actor Account.
BlockResult	applyBlock(SignedData<Block> signedBlock)	Applies a signed Block to the current state, i.e.
State	applyScheduledTransactions()
State	applyTimeUpdate(long newTimestamp)	Updates the State based on passage of time.
ResultContext	applyTransaction(SignedData<? extends ATransaction> signedTransaction)	Applies a signed transaction to the State.
ResultContext	applyTransaction(ATransaction t)	Applies a transaction to the State.
BlockResult	checkBlock(SignedData<Block> signedBlock)	Checks if a block is valid for application to the current state
HashMap<AccountKey,Double>	computeStakes()	Computes the weighted stake for each peer.
long	computeTotalFunds()	Compute the total funds existing within this state.
long	computeTotalMemory()	Compute the total memory allowance, including the memory pool.
static State	create(AVector<AccountStatus> accounts, Index<AccountKey,PeerStatus> peers, AVector<ACell> globals, Index<ABlob,AVector<ACell>> schedule)	Create a State
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
int	encodeRaw(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, excluding the tag byte.
boolean	equals(ACell a)	Checks for equality with another Cell.
boolean	equals(State a)	Tests if this State is equal to another
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
ACell	get(Keyword k)	Gets the record field content for a given key, or null if not found.
AccountStatus	getAccount(Address target)	Gets the AccountStatus for a given account, or null if not found.
AVector<AccountStatus>	getAccounts()	Get all Accounts in this State
Long	getBalance(Address address)	Gets the balance of a specific address, or null if the Address does not exist
int	getEncodingLength()	Method to calculate the encoding length of a Cell.
AMap<Symbol,ACell>	getEnvironment(Address addr)	Gets the environment for a given account, or null if not found.
RecordFormat	getFormat()	Gets the RecordFormat instance that describes this Record's layout
CVMLong	getGlobalFees()	Gets the Global Fees accumulated in the State
CVMLong	getGlobalMemoryPool()
CVMLong	getGlobalMemoryValue()
AVector<ACell>	getGlobals()	Gets globals.
CVMLong	getJuicePrice()	Gets the current Juice price
double	getMemoryPrice()
PeerStatus	getPeer(AccountKey peerAddress)	Gets the PeerStatus record for the given Address, or null if it does not exist
Index<AccountKey,PeerStatus>	getPeers()	Gets the map of Peers for this State
<R extends ACell> Ref<R>	getRef(int i)	Gets a numbered child Ref from within this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
Index<ABlob,AVector<ACell>>	getSchedule()	Gets the current schedule data structure for this state
byte	getTag()	Gets the tag byte for this record type.
CVMLong	getTimestamp()	Gets the current global timestamp from this state.
boolean	hasAccount(Address address)
boolean	isCanonical()	Returns true if this Cell is in a canonical representation.
Address	lookupCNS(String name)	Look up an Address from CNS
Address	nextAddress()	Gets the next available address for allocation, i.e.
State	putAccount(Address address, AccountStatus accountStatus)	Returns this state after updating the given account
static State	read(Blob b, int pos)	Reads a State from an encoding.
State	scheduleOp(long time, Address address, AOp<?> op)	Schedules an operation with the given timestamp and Op in this state
static State	stateAsOf(AVector<State> states, CVMLong timestamp)
static AVector<State>	statesAsOfRange(AVector<State> states, CVMLong timestamp, long interval, int count)
State	updateMemoryPool(long cvx, long mem)
State	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.
void	validate()	Validates the complete structure of this object.
void	validateCell()	Validates the local structure and invariants of this cell.
State	withAccounts(AVector<AccountStatus> newAccounts)	Updates the Accounts in this State
State	withBalance(Address address, long newBalance)
State	withGlobalFees(CVMLong newFees)	Update Global Fees
State	withPeer(AccountKey peerKey, PeerStatus updatedPeer)	Updates the specified peer status
State	withPeers(Index<AccountKey,PeerStatus> newPeers)	Updates the Peers in this State
State	withTimestamp(long timestamp)	Updates the State with a new timestamp

Methods inherited from class convex.core.data.ARecord

accumulateEntrySet, accumulateKeySet, accumulateValues, assoc, assocEntry, containsKey, containsValue, dissoc, dissoc, empty, entryAt, entrySet, forEach, get, getEntry, getEntryByHash, getKeyRefEntry, getKeys, getType, getValuesArray, isCVMValue, keySet, reduceEntries, reduceValues, toCanonical, toHashMap, values

Methods inherited from class convex.core.data.AMap

clear, conj, containsKey, containsKeyRef, containsValue, entryVector, filterValues, get, get, get, getElementRef, merge, print, put, putAll, remove, slice, slice

Methods inherited from class convex.core.data.ADataStructure

checkIndex, conjAll, count, isDataValue, isEmpty, size, toCVMString

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getHash, getMemorySize, getMemorySize, getRef, hashCode, isEmbedded, toString

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Field Details

EMPTY_SCHEDULE

public static final Index<ABlob,AVector<ACell>> EMPTY_SCHEDULE

EMPTY_PEERS

public static final Index<AccountKey,PeerStatus> EMPTY_PEERS

GLOBAL_SYMBOLS

public static final AVector<Symbol> GLOBAL_SYMBOLS

Symbols for global values in :globals Vector

GLOBAL_TIMESTAMP

public static final int GLOBAL_TIMESTAMP

See Also:

• Constant Field Values

GLOBAL_FEES

public static final int GLOBAL_FEES

See Also:

• Constant Field Values

GLOBAL_JUICE_PRICE

public static final int GLOBAL_JUICE_PRICE

See Also:

• Constant Field Values

GLOBAL_MEMORY_MEM

public static final int GLOBAL_MEMORY_MEM

See Also:

• Constant Field Values

GLOBAL_MEMORY_CVX

public static final int GLOBAL_MEMORY_CVX

See Also:

• Constant Field Values

GLOBAL_PROTOCOL

public static final int GLOBAL_PROTOCOL

See Also:

• Constant Field Values

EMPTY

public static final State EMPTY

An empty State

Method Details

get

public ACell get(Keyword k)

Description copied from class: ARecord

Gets the record field content for a given key, or null if not found.

Specified by:

get in class ARecord

Parameters:

k - Key to look up in this record

Returns:

Field value for the given key

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 and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Overrides:

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. WARNING: May need to convert to a canonical instance

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 State 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. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing 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

create

public static State create(AVector<AccountStatus> accounts,
 Index<AccountKey,PeerStatus> peers,
 AVector<ACell> globals,
 Index<ABlob,AVector<ACell>> schedule)

Create a State

Parameters:

accounts - Accounts

peers - Peers

globals - Globals

schedule - Schedule (may be null)

Returns:

New State 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. Cell must be canonical, or else an error may occur.

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

getEncodingLength

public int getEncodingLength()

Description copied from class: ACell

Method to calculate the encoding length of a Cell. May be overridden to avoid creating encodings during memory size calculations. This reduces hashing!

Overrides:

getEncodingLength in class ACell

Returns:

Exact encoding length of this Cell

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 highly likely to contain the entire object when encoded, including the tag byte. Should not traverse soft Refs, i.e. must be usable on arbitrary partial data structures

Specified by:

estimatedEncodingSize in interface IWriteable

Overrides:

estimatedEncodingSize in class ARecord

Returns:

The estimated size for the binary representation of this object.

read

public static State read(Blob b,
 int pos)
                  throws BadFormatException

Reads a State from an encoding. Assumes tag byte already read.

Parameters:

b - Blob to read from

pos - start position in Blob

Returns:

Decoded State

Throws:

BadFormatException - If a State could not be read

getAccounts

public AVector<AccountStatus> getAccounts()

Get all Accounts in this State

Returns:

Vector of Accounts

getPeers

public Index<AccountKey,PeerStatus> getPeers()

Gets the map of Peers for this State

Returns:

A map of addresses to PeerStatus records

getBalance

public Long getBalance(Address address)

Gets the balance of a specific address, or null if the Address does not exist

Parameters:

address - Address to check

Returns:

Long balance, or null if Account does not exist

withBalance

public State withBalance(Address address,
 long newBalance)

applyBlock

public BlockResult applyBlock(SignedData<Block> signedBlock)

Applies a signed Block to the current state, i.e. the State Transition function

Parameters:

signedBlock - Signed Block to apply

Returns:

The BlockResult from applying the given Block to this State

checkBlock

public BlockResult checkBlock(SignedData<Block> signedBlock)

Checks if a block is valid for application to the current state

Parameters:

signedBlock - Signed Block

Returns:

BlockResult instance if an error occurred, or nil if checks pass

applyTimeUpdate

public State applyTimeUpdate(long newTimestamp)

Updates the State based on passage of time. Note: while this can be applied independently, normal correct State updates should go via `applyBlock`

Parameters:

newTimestamp - New timestamp to apply

Returns:

Updates State

applyScheduledTransactions

public State applyScheduledTransactions()

applyTransaction

public ResultContext applyTransaction(SignedData<? extends ATransaction> signedTransaction)
                               throws BadSignatureException

Applies a signed transaction to the State. SECURITY: Checks digital signature and correctness of account key

Returns:

ResultContext containing the result of the transaction

Throws:

BadSignatureException

applyTransaction

public ResultContext applyTransaction(ATransaction t)

Applies a transaction to the State. There are three phases in application of a transaction:

1. Preparation for accounting, with prepareTransaction
2. Functional application of the transaction with ATransaction.apply(....)
3. Completion of accounting, with completeTransaction

SECURITY: Assumes digital signature and sequence number already checked.

Parameters:

t - Transaction to apply

Returns:

Context containing the updated chain State (may be exceptional)

isCanonical

public boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical representation. Non-canonical objects may be used on a temporary internal basis, they should be converted to canonical representations for general purpose use.

Overrides:

isCanonical in class ARecord

Returns:

true if the object is in canonical format, false otherwise

computeStakes

public HashMap<AccountKey,Double> computeStakes()

Computes the weighted stake for each peer. Adds a single entry for the null key, containing the total stake

Returns:

Map of Stakes

withAccounts

public State withAccounts(AVector<AccountStatus> newAccounts)

Updates the Accounts in this State

Parameters:

newAccounts - New Accounts vector

Returns:

Updated State

putAccount

public State putAccount(Address address,
 AccountStatus accountStatus)

Returns this state after updating the given account

Parameters:

address - Address of Account to update

accountStatus - New Account Status

Returns:

Updates State, or this state if Account was unchanged

Throws:

IndexOutOfBoundsException - if Address represents an illegal account position

getAccount

public AccountStatus getAccount(Address target)

Gets the AccountStatus for a given account, or null if not found.

Parameters:

target - Address to look up. Must not be null

Returns:

The AccountStatus for the given account, or null.

getEnvironment

public AMap<Symbol,ACell> getEnvironment(Address addr)

Gets the environment for a given account, or null if not found.

Parameters:

addr - Address of account to obtain

Returns:

The environment of the given account, or null if not found.

withPeers

public State withPeers(Index<AccountKey,PeerStatus> newPeers)

Updates the Peers in this State

Parameters:

newPeers - New Peer Map

Returns:

Updated State

getTag

public byte getTag()

Description copied from class: ARecord

Gets the tag byte for this record type. The Tag is the byte used to identify the record in the binary encoding.

Specified by:

getTag in class ARecord

Returns:

Record tag byte

addActor

public State addActor()

Adds a new Actor Account. The actor will be the last Account in the resulting State, and will have a default empty Actor environment.

Returns:

The updated state with the Actor Account added.

computeTotalFunds

public long computeTotalFunds()

Compute the total funds existing within this state. Should be constant! 1,000,000,000,000,000,000 in full deployment mode

Returns:

The total value of all funds

computeTotalMemory

public long computeTotalMemory()

Compute the total memory allowance, including the memory pool.

Returns:

The total amount of CVM memory available

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 Value 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

getTimestamp

public CVMLong getTimestamp()

Gets the current global timestamp from this state.

Returns:

The timestamp from this state.

getJuicePrice

public CVMLong getJuicePrice()

Gets the current Juice price

Returns:

Juice Price

scheduleOp

public State scheduleOp(long time,
 Address address,
 AOp<?> op)

Schedules an operation with the given timestamp and Op in this state

Parameters:

time - Timestamp at which to execute the scheduled op

address - AccountAddress to schedule op for

op - Op to execute in schedule

Returns:

The updated State

getSchedule

public Index<ABlob,AVector<ACell>> getSchedule()

Gets the current schedule data structure for this state

Returns:

The schedule data structure.

getGlobalFees

public CVMLong getGlobalFees()

Gets the Global Fees accumulated in the State

Returns:

Global Fees

withGlobalFees

public State withGlobalFees(CVMLong newFees)

Update Global Fees

Parameters:

newFees - New Fees

Returns:

Updated State

getPeer

public PeerStatus getPeer(AccountKey peerAddress)

Gets the PeerStatus record for the given Address, or null if it does not exist

Parameters:

peerAddress - Address of Peer to check

Returns:

PeerStatus

withPeer

public State withPeer(AccountKey peerKey,
 PeerStatus updatedPeer)

Updates the specified peer status

Parameters:

peerKey - Peer Key

updatedPeer - New Peer Status

Returns:

Updated state

nextAddress

public Address nextAddress()

Gets the next available address for allocation, i.e. the lowest Address that does not yet exist in this State.

Returns:

Next address available

lookupCNS

public Address lookupCNS(String name)

Look up an Address from CNS

Parameters:

name - CNS name String

Returns:

Address from CNS, or null if not found

getGlobals

public AVector<ACell> getGlobals()

Gets globals.

Returns:

Vector of global values

withTimestamp

public State withTimestamp(long timestamp)

Updates the State with a new timestamp

Parameters:

timestamp - New timestamp

Returns:

Updated State

equals

public boolean equals(ACell a)

Description copied from class: ACell

Checks for equality with another Cell. In general, Cells are considered equal if they have the same canonical representation, i.e. an identical encoding with the same hash value. Subclasses SHOULD override this if they have a more efficient equals implementation. MUST NOT require reads from Store.

Specified by:

equals in class ACell

Parameters:

a - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object

equals

public boolean equals(State a)

Tests if this State is equal to another

Parameters:

a - State to compare with

Returns:

true if equal, false otherwise

getFormat

public RecordFormat getFormat()

Description copied from class: ARecord

Gets the RecordFormat instance that describes this Record's layout

Specified by:

getFormat in class ARecord

Returns:

RecordFormat instance

getGlobalMemoryValue

public CVMLong getGlobalMemoryValue()

getGlobalMemoryPool

public CVMLong getGlobalMemoryPool()

getMemoryPrice

public double getMemoryPrice()

updateMemoryPool

public State updateMemoryPool(long cvx,
 long mem)

hasAccount

public boolean hasAccount(Address address)

statesAsOfRange

public static AVector<State> statesAsOfRange(AVector<State> states,
 CVMLong timestamp,
 long interval,
 int count)

stateAsOf

public static State stateAsOf(AVector<State> states,
 CVMLong timestamp)