Package convex.core

Class Peer

java.lang.Object

convex.core.Peer

public class Peer
extends Object

Immutable class representing the encapsulated state of a Peer

SECURITY:

• Needs to contain the Peer's unlocked private key for online signing.
• Manages Peer state transitions given external events. Must do so correctly.

Must have at least one state, the initial state. New states will be added as consensus updates happen.

"Don't worry about what anybody else is going to do. The best way to predict the future is to invent it." - Alan Kay

Method Summary

Modifier and Type	Method	Description
static Peer	create(AKeyPair peerKP, State genesis)	Creates a Peer
static Peer	create(AKeyPair peerKP, State genesisState, Belief remoteBelief)	Create a Peer instance from a remotely acquired Belief
static Peer	createGenesisPeer(AKeyPair keyPair, State genesisState)	Creates a new Peer instance at server startup using the provided configuration.
ResultContext	executeDetached(ATransaction transaction)	Executes a "detached" transaction on the current consensus state of this Peer, but without any effect on current CVM state.
ResultContext	executeQuery(ACell form)	Executes a query in this Peer's current Consensus State, using a default address
ResultContext	executeQuery(ACell form, Address address)	Compiles and executes a query on the current consensus state of this Peer.
static Peer	fromData(AKeyPair keyPair, AMap<Keyword,ACell> peerData)	Constructs a Peer instance from persisted PEer Data
Belief	getBelief()	Get the current Belief of this Peer
BlockResult	getBlockResult(long i)	Gets the BlockResult of a specific block index
State	getConsensusState()	Gets the current consensus state for this Peer
Address	getController()	Gets the controller Address for this Peer
long	getFinalityPoint()	Gets the Final Point for this Peer
State	getGenesisState()	Gets the genesis State of this Peer
AKeyPair	getKeyPair()	Gets the Peer Key of this Peer.
Hash	getNetworkID()	Get the Network ID for this PEer
Order	getOrder(AccountKey peerKey)	Gets the current chain this Peer sees for a given peer address
static AMap<Keyword,ACell>	getPeerData(AStore store)	Like getPeerData(AStore, ACell) but uses a null root key.
static AMap<Keyword,ACell>	getPeerData(AStore store, ACell rootKey)	Gets Peer Data from a Store.
AccountKey	getPeerKey()	Gets the Peer Public Key of this Peer.
Order	getPeerOrder()	Gets the current Order for this Peer
Result	getResult(long blockIndex, long txIndex)	Gets the Result of a specific transaction
long	getStatePosition()	Gets the state position of this Peer, which is equal to the number of state transitions executed.
long	getTimestamp()	Gets the timestamp of this Peer
Peer	mergeBeliefs(Belief... beliefs)	Merges a set of new Beliefs into this Peer's belief.
Peer	proposeBlock(Block block)	Propose a new Block.
Peer	pruneHistory(long ts)	Prunes History before the given timestamp
static Peer	restorePeer(AStore store, AKeyPair keyPair)	Like restorePeer(AStore, AKeyPair, ACell) but uses a null root key.
static Peer	restorePeer(AStore store, AKeyPair keyPair, ACell rootKey)	Restores a Peer from the Etch database specified in Config
<T extends ACell> SignedData<T>	sign(T value)	Signs a value with the keypair of this Peer
AMap<Keyword,ACell>	toData()	Gets the Peer Data map for this Peer
Peer	updateBelief(Belief newBelief)	Update this Peer with a new consensus Belief
Peer	updateState()	Updates the state of the Peer based on latest consensus Belief
Peer	updateTimestamp(long newTimestamp)	Updates the timestamp to the specified time, going forwards only

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fromData

public static Peer fromData(AKeyPair keyPair,
 AMap<Keyword,ACell> peerData)

Constructs a Peer instance from persisted PEer Data

Parameters:

keyPair - Key Pair for Peer

peerData - Peer data map

Returns:

New Peer instance

toData

public AMap<Keyword,ACell> toData()

Gets the Peer Data map for this Peer

Returns:

Peer data

create

public static Peer create(AKeyPair peerKP,
 State genesis)

Creates a Peer

Parameters:

peerKP - Key Pair

genesis - Genesis State

Returns:

New Peer instance

create

public static Peer create(AKeyPair peerKP,
 State genesisState,
 Belief remoteBelief)

Create a Peer instance from a remotely acquired Belief

Parameters:

peerKP - Peer KeyPair

genesisState - Initial genesis State of the Network

remoteBelief - Remote belief to sync with

Returns:

New Peer instance

restorePeer

public static Peer restorePeer(AStore store,
 AKeyPair keyPair)
                        throws IOException

Like restorePeer(AStore, AKeyPair, ACell) but uses a null root key.

Parameters:

store - Store to restore from

keyPair - Key Pair to use for restored Peer

Returns:

Restored Peer instance

Throws:

IOException - In case of IO error

restorePeer

public static Peer restorePeer(AStore store,
 AKeyPair keyPair,
 ACell rootKey)
                        throws IOException

Restores a Peer from the Etch database specified in Config

Parameters:

store - Store to restore from

keyPair - Key Pair to use for restored Peer

rootKey - When not null, assumes the root data is a map and peer data is under that key

Returns:

Peer instance, or null if root hash was not found

Throws:

IOException - If store reading failed

getPeerData

public static AMap<Keyword,ACell> getPeerData(AStore store)
                                       throws IOException

Like getPeerData(AStore, ACell) but uses a null root key.

Parameters:

store - store from which to load Peer data

Returns:

Peer data map

Throws:

IOException - In case of IOException

getPeerData

public static AMap<Keyword,ACell> getPeerData(AStore store,
 ACell rootKey)
                                       throws IOException

Gets Peer Data from a Store.

Parameters:

store - Store to retrieve Peer Data from

rootKey - When not null, assumes the root data is a map and peer data is under that key

Returns:

Peer data map, or null if not available

Throws:

IOException - If a store IO error occurs

createGenesisPeer

public static Peer createGenesisPeer(AKeyPair keyPair,
 State genesisState)

Creates a new Peer instance at server startup using the provided configuration. Current store must be set to store for server.

Parameters:

keyPair - Key pair for genesis peer

genesisState - Genesis state, or null to generate fresh state

Returns:

A new Peer instance

updateTimestamp

public Peer updateTimestamp(long newTimestamp)

Updates the timestamp to the specified time, going forwards only

Parameters:

newTimestamp - New Peer timestamp

Returns:

This peer updated with the given timestamp

executeQuery

public ResultContext executeQuery(ACell form,
 Address address)

Compiles and executes a query on the current consensus state of this Peer.

Parameters:

form - Form to compile and execute.

address - Address to use for query execution. If null, core address will be used

Returns:

The Context containing the query results. Will be NOBODY error if address / account does not exist

executeDetached

public ResultContext executeDetached(ATransaction transaction)

Executes a "detached" transaction on the current consensus state of this Peer, but without any effect on current CVM state. This can be used for query, estimating potential fees etc.

Parameters:

transaction - Transaction to execute

Returns:

The Context containing the transaction results.

executeQuery

public ResultContext executeQuery(ACell form)

Executes a query in this Peer's current Consensus State, using a default address

Parameters:

form - Form to execute as a Query

Returns:

Context after executing query

getTimestamp

public long getTimestamp()

Gets the timestamp of this Peer

Returns:

Timestamp

getPeerKey

public AccountKey getPeerKey()

Gets the Peer Public Key of this Peer.

Returns:

Peer Key of Peer.

getController

public Address getController()

Gets the controller Address for this Peer

Returns:

Address of Peer controller Account, or null if does not exist

getKeyPair

public AKeyPair getKeyPair()

Gets the Peer Key of this Peer.

Returns:

Address of Peer.

getBelief

public Belief getBelief()

Get the current Belief of this Peer

Returns:

Belief

sign

public <T extends ACell> SignedData<T> sign(T value)

Signs a value with the keypair of this Peer

Type Parameters:

T - Type of value to sign

Parameters:

value - Value to sign

Returns:

Signed data value

getConsensusState

public State getConsensusState()

Gets the current consensus state for this Peer

Returns:

Consensus state for this chain (genesis state if no block consensus)

mergeBeliefs

public Peer mergeBeliefs(Belief... beliefs)
                  throws InvalidDataException

Merges a set of new Beliefs into this Peer's belief. Beliefs may be null, in which case they are ignored. Should call updateState() at some point after this to update the global consensus state

Parameters:

beliefs - An array of Beliefs. May contain nulls, which will be ignored.

Returns:

Updated Peer after Belief Merge

Throws:

InvalidDataException - if

pruneHistory

public Peer pruneHistory(long ts)

Prunes History before the given timestamp

Parameters:

ts - Timestamp from which to to keep History

Returns:

Updated Peer with pruned History

updateBelief

public Peer updateBelief(Belief newBelief)

Update this Peer with a new consensus Belief

Parameters:

newBelief - Belief to apply

Returns:

Updated Peer

updateState

public Peer updateState()

Updates the state of the Peer based on latest consensus Belief

Returns:

Updated Peer

getResult

public Result getResult(long blockIndex,
 long txIndex)

Gets the Result of a specific transaction

Parameters:

blockIndex - Index of Block in Order

txIndex - Index of transaction in block

Returns:

Result from transaction, or null if the transaction does not exist or is no longer stored

getBlockResult

public BlockResult getBlockResult(long i)

Gets the BlockResult of a specific block index

Parameters:

i - Index of Block

Returns:

BlockResult, or null if the BlockResult is not stired

proposeBlock

public Peer proposeBlock(Block block)

Propose a new Block. Adds the Block to the current proposed Order for this Peer. Also increments Peer timestamp if necessary for new Block

Parameters:

block - Block to publish

Returns:

Peer after proposing new Block in Peer's own Order

getFinalityPoint

public long getFinalityPoint()

Gets the Final Point for this Peer

Returns:

Consensus Point value

getPeerOrder

public Order getPeerOrder()

Gets the current Order for this Peer

Returns:

The Order for this peer in its current Belief. Will return null if the Peer is not a peer in the current consensus state

getOrder

public Order getOrder(AccountKey peerKey)

Gets the current chain this Peer sees for a given peer address

Parameters:

peerKey - Peer Key

Returns:

The current Order for the specified peer

getNetworkID

public Hash getNetworkID()

Get the Network ID for this PEer

Returns:

Network ID

getStatePosition

public long getStatePosition()

Gets the state position of this Peer, which is equal to the number of state transitions executed.

Returns:

Position

getGenesisState

public State getGenesisState()

Gets the genesis State of this Peer

Returns:

Genesis State