import "github.com/ethereum/go-ethereum/light"
Package light implements on-demand retrieval capable state and chain objects for the Ethereum Light Client.
lightchain.go nodeset.go odr.go odr_util.go postprocess.go trie.go txpool.go
var (
// DefaultServerIndexerConfig wraps a set of configs as a default indexer config for server side.
DefaultServerIndexerConfig = &IndexerConfig{
ChtSize: params.CHTFrequency,
ChtConfirms: params.HelperTrieProcessConfirmations,
BloomSize: params.BloomBitsBlocks,
BloomConfirms: params.BloomConfirms,
BloomTrieSize: params.BloomTrieFrequency,
BloomTrieConfirms: params.HelperTrieProcessConfirmations,
}
// DefaultClientIndexerConfig wraps a set of configs as a default indexer config for client side.
DefaultClientIndexerConfig = &IndexerConfig{
ChtSize: params.CHTFrequency,
ChtConfirms: params.HelperTrieConfirmations,
BloomSize: params.BloomBitsBlocksClient,
BloomConfirms: params.HelperTrieConfirmations,
BloomTrieSize: params.BloomTrieFrequency,
BloomTrieConfirms: params.HelperTrieConfirmations,
}
// TestServerIndexerConfig wraps a set of configs as a test indexer config for server side.
TestServerIndexerConfig = &IndexerConfig{
ChtSize: 128,
ChtConfirms: 1,
BloomSize: 16,
BloomConfirms: 1,
BloomTrieSize: 128,
BloomTrieConfirms: 1,
}
// TestClientIndexerConfig wraps a set of configs as a test indexer config for client side.
TestClientIndexerConfig = &IndexerConfig{
ChtSize: 128,
ChtConfirms: 8,
BloomSize: 128,
BloomConfirms: 8,
BloomTrieSize: 128,
BloomTrieConfirms: 8,
}
)var (
BloomTrieTablePrefix = "blt-"
)var (
ChtTablePrefix = "cht-"
)ErrNoPeers is returned if no peers capable of serving a queued request are available
var NoOdr = context.Background()
NoOdr is the default context passed to an ODR capable function when the ODR service is not required.
func GetBlock(ctx context.Context, odr OdrBackend, hash common.Hash, number uint64) (*types.Block, error)
GetBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body.
func GetBlockLogs(ctx context.Context, odr OdrBackend, hash common.Hash, number uint64) ([][]*types.Log, error)
GetBlockLogs retrieves the logs generated by the transactions included in a block given by its hash.
func GetBlockReceipts(ctx context.Context, odr OdrBackend, hash common.Hash, number uint64) (types.Receipts, error)
GetBlockReceipts retrieves the receipts generated by the transactions included in a block given by its hash.
func GetBloomBits(ctx context.Context, odr OdrBackend, bit uint, sections []uint64) ([][]byte, error)
GetBloomBits retrieves a batch of compressed bloomBits vectors belonging to the given bit index and section indexes.
GetBloomTrieRoot reads the BloomTrie root assoctiated to the given section from the database
func GetBody(ctx context.Context, odr OdrBackend, hash common.Hash, number uint64) (*types.Body, error)
GetBody retrieves the block body (transactions, uncles) corresponding to the hash.
func GetBodyRLP(ctx context.Context, odr OdrBackend, hash common.Hash, number uint64) (rlp.RawValue, error)
GetBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
GetCanonicalHash retrieves the canonical block hash corresponding to the number.
GetChtRoot reads the CHT root associated to the given section from the database
GetHeaderByNumber retrieves the canonical block header corresponding to the given number. The returned header is proven by local CHT.
GetTd retrieves the total difficulty corresponding to the number and hash.
func GetTransaction(ctx context.Context, odr OdrBackend, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)
GetTransaction retrieves a canonical transaction by hash and also returns its position in the chain
func GetUntrustedBlockLogs(ctx context.Context, odr OdrBackend, header *types.Header) ([][]*types.Log, error)
GetUntrustedBlockLogs retrieves the logs generated by the transactions included in a block. The retrieved logs are regarded as untrusted and will not be stored in the database. This function should only be used in light client checkpoint syncing.
func NewBloomTrieIndexer(db ethdb.Database, odr OdrBackend, parentSize, size uint64, disablePruning bool) *core.ChainIndexer
NewBloomTrieIndexer creates a BloomTrie chain indexer
func NewChtIndexer(db ethdb.Database, odr OdrBackend, size, confirms uint64, disablePruning bool) *core.ChainIndexer
NewChtIndexer creates a Cht chain indexer
StoreBloomTrieRoot writes the BloomTrie root assoctiated to the given section into the database
StoreChtRoot writes the CHT root associated to the given section into the database
BlockRequest is the ODR request type for retrieving block bodies
func (req *BlockRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
type BloomRequest struct {
OdrRequest
Config *IndexerConfig
BloomTrieNum uint64
BitIdx uint
SectionIndexList []uint64
BloomTrieRoot common.Hash
BloomBits [][]byte
Proofs *NodeSet
}BloomRequest is the ODR request type for retrieving bloom filters from a CHT structure
func (req *BloomRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
type BloomTrieIndexerBackend struct {
// contains filtered or unexported fields
}BloomTrieIndexerBackend implements core.ChainIndexerBackend
func (b *BloomTrieIndexerBackend) Commit() error
Commit implements core.ChainIndexerBackend
Process implements core.ChainIndexerBackend
func (b *BloomTrieIndexerBackend) Prune(threshold uint64) error
Prune implements core.ChainIndexerBackend which deletes all bloombits which older than the specified threshold.
func (b *BloomTrieIndexerBackend) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error
Reset implements core.ChainIndexerBackend
type ChtIndexerBackend struct {
// contains filtered or unexported fields
}ChtIndexerBackend implements core.ChainIndexerBackend.
func (c *ChtIndexerBackend) Commit() error
Commit implements core.ChainIndexerBackend
Process implements core.ChainIndexerBackend
func (c *ChtIndexerBackend) Prune(threshold uint64) error
PruneSections implements core.ChainIndexerBackend which deletes all chain data(except hash<->number mappings) older than the specified threshold.
func (c *ChtIndexerBackend) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error
Reset implements core.ChainIndexerBackend
ChtNode structures are stored in the Canonical Hash Trie in an RLP encoded format
type ChtRequest struct {
Config *IndexerConfig
ChtNum, BlockNum uint64
ChtRoot common.Hash
Header *types.Header
Td *big.Int
Proof *NodeSet
}ChtRequest is the ODR request type for retrieving header by Canonical Hash Trie
func (req *ChtRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
type CodeRequest struct {
Id *TrieID // references storage trie of the account
Hash common.Hash
Data []byte
}CodeRequest is the ODR request type for retrieving contract code
func (req *CodeRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
type IndexerConfig struct {
// The block frequency for creating CHTs.
ChtSize uint64
// The number of confirmations needed to generate/accept a canonical hash help trie.
ChtConfirms uint64
// The block frequency for creating new bloom bits.
BloomSize uint64
// The number of confirmation needed before a bloom section is considered probably final and its rotated bits
// are calculated.
BloomConfirms uint64
// The block frequency for creating BloomTrie.
BloomTrieSize uint64
// The number of confirmations needed to generate/accept a bloom trie.
BloomTrieConfirms uint64
}IndexerConfig includes a set of configs for chain indexers.
type LightChain struct {
// contains filtered or unexported fields
}LightChain represents a canonical chain that by default only handles block headers, downloading block bodies and receipts on demand through an ODR interface. It only does header validation during chain insertion.
func NewLightChain(odr OdrBackend, config *params.ChainConfig, engine consensus.Engine, checkpoint *params.TrustedCheckpoint) (*LightChain, error)
NewLightChain returns a fully initialised light chain using information available in the database. It initialises the default Ethereum header validator.
func (lc *LightChain) AddTrustedCheckpoint(cp *params.TrustedCheckpoint)
AddTrustedCheckpoint adds a trusted checkpoint to the blockchain
func (lc *LightChain) Config() *params.ChainConfig
Config retrieves the header chain's chain configuration.
func (lc *LightChain) CurrentHeader() *types.Header
CurrentHeader retrieves the current head header of the canonical chain. The header is retrieved from the HeaderChain's internal cache.
func (lc *LightChain) DisableCheckFreq()
DisableCheckFreq disables header validation. This is used for ultralight mode.
func (lc *LightChain) EnableCheckFreq()
EnableCheckFreq enables header validation.
func (lc *LightChain) Engine() consensus.Engine
Engine retrieves the light chain's consensus engine.
func (lc *LightChain) GasLimit() uint64
GasLimit returns the gas limit of the current HEAD block.
func (lc *LightChain) Genesis() *types.Block
Genesis returns the genesis block
func (lc *LightChain) GetAncestor(hash common.Hash, number, ancestor uint64, maxNonCanonical *uint64) (common.Hash, uint64)
GetAncestor retrieves the Nth ancestor of a given block. It assumes that either the given block or a close ancestor of it is canonical. maxNonCanonical points to a downwards counter limiting the number of blocks to be individually checked before we reach the canonical chain.
Note: ancestor == 0 returns the same block, 1 returns its parent and so on.
func (lc *LightChain) GetBlock(ctx context.Context, hash common.Hash, number uint64) (*types.Block, error)
GetBlock retrieves a block from the database or ODR service by hash and number, caching it if found.
GetBlockByHash retrieves a block from the database or ODR service by hash, caching it if found.
GetBlockByNumber retrieves a block from the database or ODR service by number, caching it (associated with its hash) if found.
GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.
GetBody retrieves a block body (transactions and uncles) from the database or ODR service by hash, caching it if found.
GetBodyRLP retrieves a block body in RLP encoding from the database or ODR service by hash, caching it if found.
func (bc *LightChain) GetCanonicalHash(number uint64) common.Hash
GetCanonicalHash returns the canonical hash for a given block number
GetHeader retrieves a block header from the database by hash and number, caching it if found.
GetHeaderByHash retrieves a block header from the database by hash, caching it if found.
func (lc *LightChain) GetHeaderByNumber(number uint64) *types.Header
GetHeaderByNumber retrieves a block header from the database by number, caching it (associated with its hash) if found.
func (lc *LightChain) GetHeaderByNumberOdr(ctx context.Context, number uint64) (*types.Header, error)
GetHeaderByNumberOdr retrieves a block header from the database or network by number, caching it (associated with its hash) if found.
GetTd retrieves a block's total difficulty in the canonical chain from the database by hash and number, caching it if found.
GetTdByHash retrieves a block's total difficulty in the canonical chain from the database by hash, caching it if found.
GetHeaderByNumberOdr retrieves the total difficult from the database or network by hash and number, caching it (associated with its hash) if found.
HasBlock checks if a block is fully present in the database or not, caching it if present.
HasHeader checks if a block header is present in the database or not, caching it if present.
func (lc *LightChain) HeaderChain() *core.HeaderChain
HeaderChain returns the underlying header chain.
InsertHeaderChain attempts to insert the given header chain in to the local chain, possibly creating a reorg. If an error is returned, it will return the index number of the failing header as well an error describing what went wrong.
The verify parameter can be used to fine tune whether nonce verification should be done or not. The reason behind the optional check is because some of the header retrieval mechanisms already need to verfy nonces, as well as because nonces can be verified sparsely, not needing to check each.
In the case of a light chain, InsertHeaderChain also creates and posts light chain events when necessary.
func (lc *LightChain) LockChain()
LockChain locks the chain mutex for reading so that multiple canonical hashes can be retrieved while it is guaranteed that they belong to the same version of the chain
func (lc *LightChain) Odr() OdrBackend
Odr returns the ODR backend of the chain
func (lc *LightChain) Reset()
Reset purges the entire blockchain, restoring it to its genesis state.
func (lc *LightChain) ResetWithGenesisBlock(genesis *types.Block)
ResetWithGenesisBlock purges the entire blockchain, restoring it to the specified genesis state.
func (lc *LightChain) Rollback(chain []common.Hash)
Rollback is designed to remove a chain of links from the database that aren't certain enough to be valid.
func (lc *LightChain) SetHead(head uint64) error
SetHead rewinds the local chain to a new head. Everything above the new head will be deleted and the new one set.
func (lc *LightChain) StateCache() state.Database
func (lc *LightChain) Stop()
Stop stops the blockchain service. If any imports are currently in progress it will abort them using the procInterrupt.
func (lc *LightChain) StopInsert()
StopInsert interrupts all insertion methods, causing them to return errInsertionInterrupted as soon as possible. Insertion is permanently disabled after calling this method.
func (lc *LightChain) SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
SubscribeChainEvent registers a subscription of ChainEvent.
func (lc *LightChain) SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
SubscribeChainHeadEvent registers a subscription of ChainHeadEvent.
func (lc *LightChain) SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
SubscribeChainSideEvent registers a subscription of ChainSideEvent.
func (lc *LightChain) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
SubscribeLogsEvent implements the interface of filters.Backend LightChain does not send logs events, so return an empty subscription.
func (lc *LightChain) SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription
SubscribeRemovedLogsEvent implements the interface of filters.Backend LightChain does not send core.RemovedLogsEvent, so return an empty subscription.
func (lc *LightChain) SyncCheckpoint(ctx context.Context, checkpoint *params.TrustedCheckpoint) bool
SyncCheckpoint fetches the checkpoint point block header according to the checkpoint provided by the remote peer.
Note if we are running the clique, fetches the last epoch snapshot header which covered by checkpoint.
func (lc *LightChain) UnlockChain()
UnlockChain unlocks the chain mutex
NodeList stores an ordered list of trie nodes. It implements ethdb.KeyValueWriter.
DataSize returns the aggregated data size of nodes in the list
Delete panics as there's no reason to remove a node from the list.
NodeSet converts the node list to a NodeSet
Put stores a new node at the end of the list
func (n NodeList) Store(db ethdb.KeyValueWriter)
Store writes the contents of the list to the given database
type NodeSet struct {
// contains filtered or unexported fields
}NodeSet stores a set of trie nodes. It implements trie.Database and can also act as a cache for another trie.Database.
NewNodeSet creates an empty node set
DataSize returns the aggregated data size of nodes in the set
Delete removes a node from the set
Get returns a stored node
Has returns true if the node set contains the given key
KeyCount returns the number of nodes in the set
NodeList converts the node set to a NodeList
Put stores a new node in the set
func (db *NodeSet) Store(target ethdb.KeyValueWriter)
Store writes the contents of the set to the given database
type OdrBackend interface {
Database() ethdb.Database
ChtIndexer() *core.ChainIndexer
BloomTrieIndexer() *core.ChainIndexer
BloomIndexer() *core.ChainIndexer
Retrieve(ctx context.Context, req OdrRequest) error
IndexerConfig() *IndexerConfig
}OdrBackend is an interface to a backend service that handles ODR retrievals type
OdrRequest is an interface for retrieval requests
type ReceiptsRequest struct {
Untrusted bool // Indicator whether the result retrieved is trusted or not
Hash common.Hash
Number uint64
Header *types.Header
Receipts types.Receipts
}ReceiptsRequest is the ODR request type for retrieving receipts.
func (req *ReceiptsRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
TrieID identifies a state or account storage trie
StateTrieID returns a TrieID for a state trie belonging to a certain block header.
StorageTrieID returns a TrieID for a contract storage trie at a given account of a given state trie. It also requires the root hash of the trie for checking Merkle proofs.
TrieRequest is the ODR request type for state/storage trie entries
func (req *TrieRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
type TxPool struct {
// contains filtered or unexported fields
}TxPool implements the transaction pool for light clients, which keeps track of the status of locally created transactions, detecting if they are included in a block (mined) or rolled back. There are no queued transactions since we always receive all locally signed transactions in the same order as they are created.
func NewTxPool(config *params.ChainConfig, chain *LightChain, relay TxRelayBackend) *TxPool
NewTxPool creates a new light transaction pool
Add adds a transaction to the pool if valid and passes it to the tx relay backend
AddTransactions adds all valid transactions to the pool and passes them to the tx relay backend
func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
Content retrieves the data content of the transaction pool, returning all the pending as well as queued transactions, grouped by account and nonce.
GetNonce returns the "pending" nonce of a given address. It always queries the nonce belonging to the latest header too in order to detect if another client using the same key sent a transaction.
GetTransaction returns a transaction if it is contained in the pool and nil otherwise.
func (pool *TxPool) GetTransactions() (txs types.Transactions, err error)
GetTransactions returns all currently processable transactions. The returned slice may be modified by the caller.
func (pool *TxPool) RemoveTransactions(txs types.Transactions)
RemoveTransactions removes all given transactions from the pool.
RemoveTx removes the transaction with the given hash from the pool.
Stats returns the number of currently pending (locally created) transactions
Stop stops the light transaction pool
func (pool *TxPool) SubscribeNewTxsEvent(ch chan<- core.NewTxsEvent) event.Subscription
SubscribeNewTxsEvent registers a subscription of core.NewTxsEvent and starts sending event to the given channel.
type TxRelayBackend interface {
Send(txs types.Transactions)
NewHead(head common.Hash, mined []common.Hash, rollback []common.Hash)
Discard(hashes []common.Hash)
}TxRelayBackend provides an interface to the mechanism that forwards transacions to the ETH network. The implementations of the functions should be non-blocking.
Send instructs backend to forward new transactions NewHead notifies backend about a new head after processed by the tx pool,
including mined and rolled back transactions since the last event
Discard notifies backend about transactions that should be discarded either
because they have been replaced by a re-send or because they have been mined long ago and no rollback is expected
type TxStatus struct {
Status core.TxStatus
Lookup *rawdb.LegacyTxLookupEntry `rlp:"nil"`
Error string
}TxStatus describes the status of a transaction
TxStatusRequest is the ODR request type for retrieving transaction status
func (req *TxStatusRequest) StoreResult(db ethdb.Database)
StoreResult stores the retrieved data in local database
Package light imports 25 packages (graph) and is imported by 176 packages. Updated 2020-12-11. Refresh now. Tools for package owners.