types

package
v0.1.8-alpha.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2019 License: GPL-3.0 Imports: 6 Imported by: 15

Documentation

Index

Constants

View Source 
const (
	// ErrCodeListAccountFailed for failure to list account
	ErrCodeListAccountFailed = 30000
	// ErrCodeAccountNotFound for missing account
	ErrCodeAccountNotFound = 30001
)

Account package error codes

View Source 
const (
	// ErrCodeInvalidAuthParams for invalid authorization parameter
	ErrCodeInvalidAuthParams = 40000
	// ErrCodeInvalidAuthCredentials for invalid authorization credentials
	ErrCodeInvalidAuthCredentials = 40001
)

RPC package error codes

View Source 
const (
	// ErrCodeQueryFailed for when a query fails
	ErrCodeQueryFailed = 50000
	// ErrCodeBlockNotFound for when a block is not found
	ErrCodeBlockNotFound = 50001
	// ErrCodeTransactionNotFound for when a transaction is not found
	ErrCodeTransactionNotFound = 50001
	// ErrCodeBlockQuery for non-specific block query errors
	ErrCodeBlockQuery = 50002
)

Blockchain package error codes

View Source 
const (
	// ErrCodeUnexpectedArgType for when an argument type is invalid
	ErrCodeUnexpectedArgType = 60000
	// ErrCodeQueryParamError for when a query parameter is invalid
	ErrCodeQueryParamError = 60001
	// ErrValueDecodeFailed for when decoding a value failed
	ErrValueDecodeFailed = 60002
	// ErrCodeUnexpected for when an unexpected error occurs
	ErrCodeUnexpected = 60003
)

General error codes

View Source 
const (
	// ErrCodeAddress for when the is an issue with an address
	ErrCodeAddress = 70000
	// ErrCodeNodeConnectFailure for when there is an issue connecting to a node
	ErrCodeNodeConnectFailure = 70001
	// ErrCodeTxFailed when transaction failed
	ErrCodeTxFailed = 70002
)

Engine package error codes

View Source 
const (
	// NamespaceState is the namespace
	// for RPC methods that access the database
	NamespaceState = "state"

	// NamespaceEll is the namespace for RPC methods
	// that interact with the native currency
	NamespaceEll = "ell"

	// NamespaceNode is the namespace for RPC methods
	// that interact and access the node/client properties
	NamespaceNode = "node"

	// NamespacePool is the namespace for RPC methods
	// that access the transaction pool
	NamespacePool = "pool"

	// NamespaceMiner is the namespace for RPC methods
	// that interact with the miner
	NamespaceMiner = "miner"

	// NamespacePersonal is the namespace for RPC methods
	// that interact with private and sensitive data of the
	// client
	NamespacePersonal = "personal"

	// NamespaceAdmin is the namespace for RPC methods
	// that perform administrative actions
	NamespaceAdmin = "admin"

	// NamespaceNet is the namespace for RPC methods
	// that perform network actions
	NamespaceNet = "net"

	// NamespaceRPC is the namespace for RPC methods
	// that perform rpc actions
	NamespaceRPC = "rpc"

	// NamespaceLogger is the namespace for RPC methods
	// for configuring the logger
	NamespaceLogger = "logger"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account interface {
	GetAddress() util.String
	GetBalance() util.String
	SetBalance(util.String)
	GetNonce() uint64
	IncrNonce()
}

Account defines an interface for an account

type Block 

type Block interface {
	ComputeHash() util.Hash
	GetBytes() []byte
	GetHeader() Header
	SetHeader(h Header)
	ReplaceHeader(header Header) Block
	GetNumber() uint64
	GetHash() util.Hash
	SetHash(util.Hash)
	GetTransactions() []Transaction
	GetSignature() []byte
	SetSignature(sig []byte)
	GetHashAsHex() string
	GetBytesNoHashSig() []byte
	GetSize() int64
	GetSizeNoTxs() int64
	GetBytesNoTxs() []byte
	GetValidationContexts() []ValidationContext
	SetValidationContexts(...ValidationContext)
	SetSig([]byte)
}

Block defines a block

type BlockMaker 

type BlockMaker interface {

	// Generate creates a new block for a target chain.
	// The Chain is specified by passing to OpChain.
	Generate(*GenerateBlockParams, ...CallOp) (Block, error)

	// ChainReader gets a Reader for reading the main chain
	ChainReader() ChainReaderFactory

	// ProcessBlock attempts to process and append a block to the main or side chains
	ProcessBlock(Block, ...CallOp) (ChainReaderFactory, error)

	// IsMainChain checks whether a chain is the main chain
	IsMainChain(ChainReaderFactory) bool
}

BlockMaker defines an interface providing the necessary functions to create new blocks

type Blockchain 

type Blockchain interface {

	// Up initializes and loads the blockchain manager
	Up() error

	// SetCoinbase sets the coinbase key that is used to
	// identify the current blockchain instance
	SetCoinbase(coinbase *crypto.Key)

	// GetBestChain gets the chain that is currently considered the main chain
	GetBestChain() Chainer

	// OrphanBlocks gets a reader for the orphan cache
	OrphanBlocks() CacheReader

	// GetEventEmitter gets the event emitter
	GetEventEmitter() *emitter.Emitter

	// HaveBlock checks whether we have a block matching the hash in any of the known chains
	HaveBlock(hash util.Hash) (bool, error)

	// GetTransaction finds and returns a transaction on the main chain
	GetTransaction(util.Hash, ...CallOp) (Transaction, error)

	// ProcessBlock attempts to process and append a block to the main or side chains
	ProcessBlock(Block, ...CallOp) (ChainReaderFactory, error)

	// Generate creates a new block for a target chain.
	// The Chain is specified by passing to OpChain.
	Generate(*GenerateBlockParams, ...CallOp) (Block, error)

	// GetTxPool gets the transaction pool
	GetTxPool() TxPool

	// ChainReader gets a Reader for reading the main chain
	ChainReader() ChainReaderFactory

	// GetChainsReader gets chain reader for all known chains
	GetChainsReader() (readers []ChainReaderFactory)

	// SetDB sets the database
	SetDB(elldb.DB)

	// GetBlock finds a block in any chain with a matching
	// block number and hash.
	GetBlock(number uint64, hash util.Hash) (Block, error)

	// GetBlockByHash finds a block in any chain with a matching hash.
	GetBlockByHash(hash util.Hash, opts ...CallOp) (Block, error)

	// GetChainReaderByHash returns a chain reader to a chain
	// where a block with the given hash exists
	GetChainReaderByHash(hash util.Hash) ChainReaderFactory

	// SetGenesisBlock sets the genesis block
	SetGenesisBlock(block Block)

	// CreateAccount creates an account that is associated with
	// the given block number and chain.
	CreateAccount(blockNo uint64, chain Chainer, account Account) error

	// GetAccount gets an account
	GetAccount(address util.String, opts ...CallOp) (Account, error)

	// GetAccountNonce gets the nonce of an account
	GetAccountNonce(address util.String, opts ...CallOp) (uint64, error)

	// GetLocators fetches a list of blockhashes used to
	// compare and sync the local chain with a remote chain.
	GetLocators() ([]util.Hash, error)
}

Blockchain defines an interface for a blockchain manager

type CacheReader 

type CacheReader interface {

	// Len gets the number of orphans
	Len() int

	// Hash checks whether an item exists in the cache
	Has(key interface{}) bool

	// Get gets an item from the cache
	Get(key interface{}) interface{}
}

CacheReader provides an interface for reading the orphan cache

type CallOp 

type CallOp interface {
	GetName() string
}

CallOp describes an interface to be used to define store method options

type ChainInfo 

type ChainInfo interface {
	GetID() util.String
	GetParentChainID() util.String
	GetParentBlockNumber() uint64
	GetTimestamp() int64
}

ChainInfo represents a chain's metadata

type ChainReaderFactory 

type ChainReaderFactory interface {

	// GetID gets the chain ID
	GetID() util.String

	// GetBlock finds and returns a block associated with chainID.
	// When 0 is passed, it should return the block with the highest number
	GetBlock(number uint64, opts ...CallOp) (Block, error)

	// GetBlockByHash finds and returns a block associated with chainID.
	GetBlockByHash(hash util.Hash, opts ...CallOp) (Block, error)

	// GetHeader gets the header of a block.
	// When 0 is passed, it should return the header of the block with the highest number
	GetHeader(number uint64, opts ...CallOp) (Header, error)

	// GetHeaderByHash finds and returns the header of a block matching hash
	GetHeaderByHash(hash util.Hash, opts ...CallOp) (Header, error)

	// Current gets the current block at the tip of the chain
	Current(opts ...CallOp) (Block, error)

	// GetAccount gets an account
	GetAccount(address util.String, opts ...CallOp) (Account, error)

	// GetParent returns a chain reader to the parent chain.
	// Returns nil if chain has no parent.
	GetParent() ChainReaderFactory

	// GetParentBlock returns the parent block
	GetParentBlock() Block

	// GetRoot fetches the root block of this chain. If the chain
	// has more than one parents/ancestors, it will traverse
	// the parents to return the root parent block.
	GetRoot() Block
}

ChainReaderFactory defines an interface for reading a chain

type ChainStorer 

type ChainStorer interface {

	// PutBlock adds a block to the store
	PutBlock(block Block, opts ...CallOp) error

	// GetBlock finds and returns a block in the chain.
	// When 0 is passed, it should return the block with the highest number
	GetBlock(number uint64, opts ...CallOp) (Block, error)

	// GetBlockByHash finds a block by its hash
	GetBlockByHash(hash util.Hash, opts ...CallOp) (Block, error)

	// GetBlockByNumberAndHash finds by number and hash
	GetBlockByNumberAndHash(number uint64, hash util.Hash, opts ...CallOp) (Block, error)

	// GetHeader gets the header of a block.
	// When 0 is passed, it should return the header of the block with the highest number
	GetHeader(number uint64, opts ...CallOp) (Header, error)

	// GetHeaderByHash finds and returns the header of a block matching hash
	GetHeaderByHash(hash util.Hash, opts ...CallOp) (Header, error)

	// GetTransaction gets a transaction (by hash) belonging to the chain
	GetTransaction(hash util.Hash, opts ...CallOp) (Transaction, error)

	// CreateAccount creates an account on a target block
	CreateAccount(targetBlockNum uint64, account Account, opts ...CallOp) error

	// GetAccount gets an account
	GetAccount(address util.String, opts ...CallOp) (Account, error)

	// GetAccounts gets an account
	GetAccounts(opts ...CallOp) ([]Account, error)

	// PutTransactions stores a collection of transactions
	PutTransactions(txs []Transaction, blockNumber uint64, opts ...CallOp) error

	// PutMinedBlock stores a brief information about a
	// block that was created by the blockchain's coinbase key
	PutMinedBlock(block Block, opts ...CallOp) error

	// Current gets the current block at the tip of the chain
	Current(opts ...CallOp) (Block, error)

	// Delete deletes objects
	Delete(key []byte, opts ...CallOp) error

	// NewTx creates and returns a transaction
	NewTx() (elldb.Tx, error)

	// DB gets the database
	DB() elldb.DB
}

ChainStorer defines an interface that provides every functionality need to mutate or query a chain.

type Chainer 

type Chainer interface {

	// GetStore returns the store
	GetStore() ChainStorer

	// NewStateTree returns a new tree
	NewStateTree(opts ...CallOp) (Tree, error)

	// Current gets the header of the tip block
	Current(opts ...CallOp) (Header, error)

	// GetID gets the chain ID
	GetID() util.String

	// GetBlock gets a block in the chain
	GetBlock(uint64, ...CallOp) (Block, error)

	// GetParentBlock gets the chain's parent block if it has one
	GetParentBlock() Block

	// GetInfo gets the chain's parent information
	GetInfo() ChainInfo

	// CreateAccount creates an account on a target block
	CreateAccount(targetBlockNum uint64, account Account, opts ...CallOp) error

	// GetAccount gets an account
	GetAccount(address util.String, opts ...CallOp) (Account, error)

	// PutTransactions stores a collection of transactions
	PutTransactions(txs []Transaction, blockNumber uint64, opts ...CallOp) error

	// GetTransaction gets a transaction by hash
	GetTransaction(hash util.Hash, opts ...CallOp) (Transaction, error)

	// ChainReader gets a chain reader for this chain
	ChainReader() ChainReaderFactory

	// GetRoot fetches the root block of this chain. If the chain
	// has more than one parents/ancestors, it will traverse
	// the parents to return the root parent block.
	GetRoot() Block
}

Chainer (a.k.a Chains) defines an interface for accessing mutating and managing a collection of blocks

type ConnectError 

type ConnectError string

ConnectError represents a connection error

func (ConnectError) Error 

func (c ConnectError) Error() string

type GenerateBlockParams 

type GenerateBlockParams struct {

	// OverrideParentHash explicitly sets the parent hash
	OverrideParentHash util.Hash

	// Transactions sets the block transaction.
	// If not provided, transactions are selected from
	// the transaction pool
	Transactions []Transaction

	// Creator sets the key of the block creator.
	// Required for setting the creator public key
	// and signing the block
	Creator *crypto.Key

	// Nonce is the special number that
	// indicates the completion of PoW
	Nonce util.BlockNonce

	// Difficulty represents the target
	// difficulty that the nonce satisfied
	Difficulty *big.Int

	// OverrideTotalDifficulty explicitly sets
	// the total difficulty.
	OverrideTotalDifficulty *big.Int

	// StateRoot sets the state root
	OverrideStateRoot util.Hash

	// Timestamp sets the time of block creation
	OverrideTimestamp int64

	// ChainTip explicitly sets the chain tip number.
	// This is used to alter what the tip of a chain is.
	// It is used in tests.
	OverrideChainTip uint64

	// AddFeeAlloc if set to true, will calculate the
	// miner fee reward and add an Alloc transaction
	AddFeeAlloc bool

	// NoPoolAdditionInTest prevents the transactions
	// from automatically added to the pool. Only used
	// during block generation in tests
	NoPoolAdditionInTest bool
}

GenerateBlockParams represents parameters required for block generation. 

type Header interface {
	GetNumber() uint64
	SetNumber(uint64)
	GetHashNoNonce() util.Hash
	GetBytes() []byte
	ComputeHash() util.Hash
	GetExtra() []byte
	GetTimestamp() int64
	SetTimestamp(int64)
	GetDifficulty() *big.Int
	SetDifficulty(*big.Int)
	GetNonce() util.BlockNonce
	SetNonce(nonce util.BlockNonce)
	GetParentHash() util.Hash
	SetParentHash(util.Hash)
	SetCreatorPubKey(util.String)
	GetCreatorPubKey() util.String
	Copy() Header
	SetStateRoot(util.Hash)
	GetStateRoot() util.Hash
	SetTransactionsRoot(txRoot util.Hash)
	GetTransactionsRoot() util.Hash
	GetTotalDifficulty() *big.Int
	SetTotalDifficulty(*big.Int)
}

Header defines a block header containing metadata about the block

type SyncPeerChainInfo 

type SyncPeerChainInfo struct {

	// PeerID is the sync peer ID
	PeerID string

	// PeerIDShort is the short loggable
	// version of PeerID
	PeerIDShort string

	// PeerChainHeight is the height of the
	// sync peer main chain
	PeerChainHeight uint64

	// PeerChainTD is the total difficulty
	// of the sync peer's main chain
	PeerChainTD *big.Int

	// LastBlockSent is the last block
	// received from the sync peer and
	// was processed by the local peer.
	LastBlockSent util.Hash
}

SyncPeerChainInfo holds information about a peer that is a potential sync peer

type Transaction 

type Transaction interface {
	GetHash() util.Hash
	SetHash(util.Hash)
	GetBytesNoHashAndSig() []byte
	GetSizeNoFee() int64
	ComputeHash() util.Hash
	GetID() string
	Sign(privKey string) ([]byte, error)
	GetType() int64
	GetFrom() util.String
	SetFrom(util.String)
	GetTo() util.String
	GetValue() util.String
	SetValue(util.String)
	GetFee() util.String
	GetNonce() uint64
	GetTimestamp() int64
	SetTimestamp(int64)
	GetSenderPubKey() util.String
	SetSenderPubKey(util.String)
	GetSignature() []byte
	SetSignature(sig []byte)
}

Transaction represents a transaction

type Tree 

type Tree interface {
	Add(item merkletree.Content)
	GetItems() []merkletree.Content
	Build() error
	Root() util.Hash
}

Tree defines a merkle tree

type TxContainer 

type TxContainer interface {
	ByteSize() int64
	Add(tx Transaction) bool
	Has(tx Transaction) bool
	Size() int64
	First() Transaction
	Last() Transaction
	Sort()
	IFind(predicate func(Transaction) bool) Transaction
	Remove(txs ...Transaction)
}

TxContainer represents a container a container responsible for holding and sorting transactions

type TxPool 

type TxPool interface {
	Put(tx Transaction) error
	Has(tx Transaction) bool
	HasByHash(hash string) bool
	Remove(txs ...Transaction)
	ByteSize() int64
	Size() int64
	Container() TxContainer
	GetByHash(hash string) Transaction
	GetByFrom(address util.String) []Transaction
}

TxPool represents a transactions pool

type ValidationContext 

type ValidationContext int

ValidationContext is used to represent a validation behaviour 

const (
	// ContextBlock represents validation
	// context of which the intent is to validate
	// a block that needs to be appended to a chain
	ContextBlock ValidationContext = iota + 1

	// ContextBranch represents validation
	// context of which the intent is to validate
	// a block that needs to be appended to a branch chain
	ContextBranch

	// ContextTxPool represents validation context
	// in which the intent is to validate a
	// transaction that needs to be included in
	// the transaction pool.
	ContextTxPool
)

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.