Big picture: DH is used to establish a shared secret, and then HKDF is used to derive multiple keys from that secret for encryption HKDFSecretsAndChal

Hash() creates a hash representative of the dex batch

IsPacemakerMessage() determines if the message should describe the View of a Validator for the Pacemaker logic

LoadBlock() loads an indexed block at a specific height

New() creates a new instance of a StateMachine

NewETHSECP256K1PrivateKey() generates a new ETHSECP256K1 private key

NewFromFile() creates a new polls object from a file

NewSECP256K1PrivateKey() generates a new SECP256K1 private key

NewSMT() creates a new abstraction of the SMT object

NewStoreWithDB() returns a Store object given a DB and a logger NOTE: to read the state commit store i.e. for merkle proofs, use NewReadOnly()

SelfIsPropose() returns true if this node is the Leader

SelfSend() executes an internal pipe send to self

SendToReplicas() is a P2P call to directly send a Consensus message to all Replicas

SetBitmap() loads the values of a bitmap into the MultiPublicKey

SetCommitteeMember() sets the address as a 'member' of the committee in the state

HELPERS BELOW SetDexBatch() sets a sell batch in the state store

SetParamsCons() sets Consensus params into state

SetValidatorPaused() updates a Validator as 'paused' with a MaxPausedHeight (height at which the Validator is force-unstaked for being paused too long

https://cr.yp.to/ecdh.html Big picture: DH is used to establish a shared secret, and then HKDF is used to derive multiple keys from that secret for en

StateRead() executes a 'read request' to the state store

StateWrite() executes a 'write request' to the state store

Stop gracefully terminates the CLI process

StringToBLS12381PrivateKey() creates a new PrivateKeyI interface from a BLS Private Key hex string

TimeToReset() returns the channel that signals when the limiter may be reset This channel is called by the time.Ticker() set in NewLimiter

Unmarshal() deserializes a byte slice into a proto.Message

UpdateMustConnects() updates the list of peers that 'must be connected to' Ex. the peers needed to complete committee consensus

UpscaleTo18Decimals converts a 6-decimal unit (Canopy native) to 18-decimal (Ethereum RPC)

CheckMessageSend statelessly validates a 'send' message.

bytesFromArgs() extracts a hash from the first argument

Convert bytes to hex string.

cleanHex() strips the 0x prefix from a hex string

colorStringWithFormat() returns a formatted string with color applied

txn() returns a copy of the current transaction txn

copy() returns a shallow copy of the node

greatestCommonPrefix() calculates the greatest common prefix (GCP) between the current key and another key. - Starts at a given bit position (`bitPos`

heightPaginated is a helper function to abstract common workflows around a callback requiring a state machine and page parameters

intFromArgs() extracts an integer from the first argument

keystoreHandler is a helper function that abstracts common workflows of keystore operations

makeVersionedKey() creates a versioned key with inverted version encoding k = [length-prefixed-key][InvertedVersion]

NewClassGroupFromABDiscriminant() calculates c using D = b^2 - 4ac and returns a class group object

NODE CODE BELOW newNode() is a constructor for the node object

newTestDoubleSignEvidence() fabricates double sign evidence for the testing suite

sendToPluginSync() sends to the plugin and waits for a response, tracking FSM context

simPrecommitPhase() simulates the PRECOMMIT phase of the BFT lifecycle

traverse: navigates the tree downward to locate the target or its closest position

update() modifies or adds an operation to the txn

* - Prefixes are used to allow 'grouping' and organization in a schemaless key-value database environment - Segments are used to allow 'sub-groupings

AddPeer() takes an ephemeral tcp connection and an incomplete peerInfo and attempts to create a E2E encrypted channel with a fully authenticated peer

BlockTimeMS() returns the expected block time in milliseconds

Bytes() returns the byte representation of the Public Key

Bytes() casts the address value back to a byte slice

BytesToEthSECP256K1Public() returns ETHSECP256K1PublicKey from bytes

CheckCache() is a convenience function that checks the signature cache for a combination and returns a callback for the caller to easily add the signa

CheckMempool() Checks each transaction in the mempool and caches a block proposal

retrieve value

CommitteeIsRetired checks if a committee is marked as 'retired' which prevents it from being subsidized for eternity

DefaultMempoolConfig() returns the developer created Mempool options

DefaultStateMachineConfig returns FSM defaults

insert new unconfirmed transaction

DeleteValidator() completely removes a validator from the state

Finish() signals the service to complete and returns the output - already running signals a stop in the running thread and returns - not running retur

gracefully stop the database

FormatInputIntoSeed() returns the 'seed data' for the VRF function `seed = lastProposerAddresses + height + round`

get Events for an event type

GetDexBatches() retrieves the lists for all dex batches

GetMajorityVote() returns the Message and AggregateSignature with a VoteSet with a +2/3 majority from the Replicas NOTE: Votes for a specific Height-R

GetOrderBook() retrieves the order book for a committee from the state db

GetRetiredCommittees() returns a list of the retired chainIds

GetSubsidizedCommittees() returns a list of chainIds that receive a portion of the 'block reward' Think of these committees as 'automatically subsidiz

GetValidatorExists() checks if the Validator already exists in the state

HandleBatchDeposit() handles local/remote liquidity deposits. local=true: x=local pool (actual token movement), y=counter mirror. local=false: x=count

HandleMessageChangeParameter() is the proper handler for an `Change-Parameter` message