ctxc

package
v1.10.61 Latest Latest
Warning

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

 Go to latest Published: Nov 22, 2024 License: GPL-3.0, GPL-3.0 Imports: 61 Imported by: 2

Documentation

Overview

Package ctxc implements the Cortex protocol.

Index

Constants

View Source 
const (
	ErrMsgTooLarge = iota
	ErrDecode
	ErrInvalidMsgCode
	ErrProtocolVersionMismatch
	ErrNetworkIDMismatch
	ErrGenesisMismatch
	ErrForkIDRejected
	ErrNoStatusMsg
	ErrExtraStatusMsg
)

Variables

View Source 
var DefaultConfig = Config{
	SyncMode:                downloader.FullSync,
	Cuckoo:                  cuckoo.Config{},
	NetworkId:               0,
	DatabaseCache:           512,
	TrieCleanCache:          154,
	TrieCleanCacheJournal:   "triecache",
	TrieCleanCacheRejournal: 60 * time.Minute,
	TrieDirtyCache:          256,
	TrieTimeout:             60 * time.Minute,
	SnapshotCache:           102,
	Miner:                   miner.DefaultConfig,

	TxPool:      txpool.DefaultConfig,
	RPCGasCap:   50000000,
	GPO:         DefaultFullGPOConfig,
	RPCTxFeeCap: 1,

	Viper: false,
}

DefaultConfig contains default settings for use on the Cortex main net.

View Source 
var DefaultFullGPOConfig = gasprice.Config{
	Blocks:     20,
	Percentile: 60,
	MaxPrice:   gasprice.DefaultMaxPrice,
}

DefaultFullGPOConfig contains default gasprice oracle settings for full node.

View Source 
var DefaultLightGPOConfig = gasprice.Config{
	Blocks:     2,
	Percentile: 60,
	MaxPrice:   gasprice.DefaultMaxPrice,
}

DefaultLightGPOConfig contains default gasprice oracle settings for light client.

View Source 
var ProtocolVersions = []uint{ctxc65, ctxc64} //, ctxc63} //, ctxc62}

ProtocolVersions are the upported versions of the ctxc protocol (first is primary).

Functions

func CreateConsensusEngine 

func CreateConsensusEngine(ctx *node.Node, chainConfig *params.ChainConfig, config *cuckoo.Config, notify []string, noverify bool, db ctxcdb.Database) consensus.Engine

CreateConsensusEngine creates the required type of consensus engine instance for an Cortex service func CreateConsensusEngine(ctx *node.ServiceContext, chainConfig *params.ChainConfig, config *cuckoo.Config, notify []string, db ctxcdb.Database) consensus.Engine {

func NewBloomIndexer 

func NewBloomIndexer(db ctxcdb.Database, size, confirms uint64) *core.ChainIndexer

NewBloomIndexer returns a chain indexer that generates bloom bits data for the canonical chain for fast logs filtering.

func NewNodeFilter added in v1.10.59 

func NewNodeFilter(chain *core.BlockChain) func(*enode.Node) bool

NewNodeFilter returns a filtering function that returns whether the provided enode advertises a forkid compatible with the current chain.

func ServiceGetBlockHeadersQuery added in v1.10.59 

func ServiceGetBlockHeadersQuery(chain *core.BlockChain, query *getBlockHeadersData, peer *peer) []rlp.RawValue

ServiceGetBlockHeadersQuery assembles the response to a header query. It is exposed to allow external packages to test protocol behavior.

Types

type BadBlockArgs 

type BadBlockArgs struct {
	Hash  common.Hash    `json:"hash"`
	Block map[string]any `json:"block"`
	RLP   string         `json:"rlp"`
}

BadBlockArgs represents the entries in the list returned when bad blocks are queried.

type BloomIndexer 

type BloomIndexer struct {
	// contains filtered or unexported fields
}

BloomIndexer implements a core.ChainIndexer, building up a rotated bloom bits index for the Cortex header bloom filters, permitting blazing fast filtering.

func (*BloomIndexer) Commit 

func (b *BloomIndexer) Commit() error

Commit implements core.ChainIndexerBackend, finalizing the bloom section and writing it out into the database.

func (*BloomIndexer) Process 

func (b *BloomIndexer) Process(ctx context.Context, header *types.Header) error

Process implements core.ChainIndexerBackend, adding a new header's bloom into the index.

func (*BloomIndexer) Reset 

func (b *BloomIndexer) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error

Reset implements core.ChainIndexerBackend, starting a new bloombits index section.

type Config 

type Config struct {
	// The genesis block, which is inserted if the database is empty.
	// If nil, the Cortex main net block is used.
	Genesis *core.Genesis `toml:",omitempty"`

	// Protocol options
	NetworkId     uint64 // Network ID to use for selecting peers to connect to
	SyncMode      downloader.SyncMode
	DiscoveryURLs []string
	NoPruning     bool
	NoPrefetch    bool   // Whether to disable prefetching and only load state on demand
	TxLookupLimit uint64 `toml:",omitempty"` // The maximum number of blocks from head whose tx indices are reserved.

	Whitelist map[uint64]common.Hash `toml:"-"`

	// Database options
	SkipBcVersionCheck      bool `toml:"-"`
	DatabaseHandles         int  `toml:"-"`
	DatabaseCache           int
	DatabaseFreezer         string
	TrieCleanCache          int
	TrieCleanCacheJournal   string        `toml:",omitempty"` // Disk journal directory for trie cache to survive node restarts
	TrieCleanCacheRejournal time.Duration `toml:",omitempty"` // Time interval to regenerate the journal for clean cache
	TrieDirtyCache          int
	TrieTimeout             time.Duration
	SnapshotCache           int
	Preimages               bool

	// Mining options
	Miner miner.Config

	// Mining-related options
	Coinbase         common.Address `toml:",omitempty"`
	InferDeviceType  string
	InferDeviceId    int
	SynapseTimeout   int
	InferMemoryUsage int64

	Cuckoo cuckoo.Config

	// Transaction pool options
	TxPool txpool.Config

	// Gas Price Oracle options
	GPO gasprice.Config

	EnablePreimageRecording bool
	// Enables prefetching trie nodes for read operations too
	EnableWitnessCollection bool `toml:"-"`

	InferURI   string
	StorageDir string

	// Miscellaneous options
	DocRoot   string `toml:"-"`
	RPCGasCap uint64 `toml:",omitempty"`
	// RPCTxFeeCap is the global transaction fee(price * gaslimit) cap for
	// send-transction variants. The unit is ctxc.
	RPCTxFeeCap float64                   `toml:",omitempty"`
	Checkpoint  *params.TrustedCheckpoint `toml:",omitempty"`
	// CheckpointOracle is the configuration for checkpoint oracle.
	CheckpointOracle *params.CheckpointOracleConfig `toml:",omitempty"`

	Viper bool
}

func (Config) MarshalTOML 

func (c Config) MarshalTOML() (interface{}, error)

MarshalTOML marshals as TOML.

func (*Config) UnmarshalTOML 

func (c *Config) UnmarshalTOML(unmarshal func(interface{}) error) error

UnmarshalTOML unmarshals from TOML.

type Cortex 

type Cortex struct {
	APIBackend *CortexAPIBackend
	// contains filtered or unexported fields
}

Cortex implements the Cortex full node service.

func New 

func New(stack *node.Node, config *Config) (*Cortex, error)

New creates a new Cortex object (including the initialisation of the common Cortex object)

func (*Cortex) APIs 

func (s *Cortex) APIs() []rpc.API

APIs return the collection of RPC services the cortex package offers. NOTE, some of these services probably need to be moved to somewhere else.

func (*Cortex) AccountManager 

func (s *Cortex) AccountManager() *accounts.Manager

func (*Cortex) ArchiveMode added in v1.9.54 

func (s *Cortex) ArchiveMode() bool

func (*Cortex) BlockChain 

func (s *Cortex) BlockChain() *core.BlockChain

func (*Cortex) ChainDb 

func (s *Cortex) ChainDb() ctxcdb.Database

func (*Cortex) CheckPoint added in v1.10.3 

func (s *Cortex) CheckPoint() uint64

func (*Cortex) CheckPointName added in v1.10.11 

func (s *Cortex) CheckPointName() string

func (*Cortex) Coinbase 

func (s *Cortex) Coinbase() (eb common.Address, err error)

func (*Cortex) CortexVersion 

func (s *Cortex) CortexVersion() int

func (*Cortex) Downloader 

func (s *Cortex) Downloader() *downloader.Downloader

func (*Cortex) Engine 

func (s *Cortex) Engine() consensus.Engine

func (*Cortex) EventMux 

func (s *Cortex) EventMux() *event.TypeMux

func (*Cortex) IsListening 

func (s *Cortex) IsListening() bool

func (*Cortex) IsMining 

func (s *Cortex) IsMining() bool

func (*Cortex) Miner 

func (s *Cortex) Miner() *miner.Miner

func (*Cortex) NetVersion 

func (s *Cortex) NetVersion() uint64

func (*Cortex) Protocols 

func (s *Cortex) Protocols() []p2p.Protocol

Protocols implements node.Service, returning all the currently configured network protocols to start.

func (*Cortex) ResetWithGenesisBlock 

func (s *Cortex) ResetWithGenesisBlock(gb *types.Block)

func (*Cortex) SetCoinbase 

func (s *Cortex) SetCoinbase(coinbase common.Address)

SetCoinbase sets the mining reward address.

func (*Cortex) Start 

func (s *Cortex) Start(srvr *p2p.Server) error

Start implements node.Service, starting all internal goroutines needed by the Cortex protocol implementation.

func (*Cortex) StartMining 

func (s *Cortex) StartMining(threads int) error

StartMining starts the miner with the given number of CPU threads. If mining is already running, this method adjust the number of threads allowed to use and updates the minimum price required by the transaction pool.

func (*Cortex) StateAtBlock added in v1.10.34 

func (ctxc *Cortex) StateAtBlock(block *types.Block, reexec uint64, base *state.StateDB, readOnly bool, preferDisk bool) (statedb *state.StateDB, release tracers.StateReleaseFunc, err error)

StateAtBlock retrieves the state database associated with a certain block. If no state is locally available for the given block, a number of blocks are attempted to be reexecuted to generate the desired state. The optional base layer statedb can be provided which is regarded as the statedb of the parent block.

An additional release function will be returned if the requested state is available. Release is expected to be invoked when the returned state is no longer needed. Its purpose is to prevent resource leaking. Though it can be noop in some cases.

Parameters:

  • block: The block for which we want the state(state = block.Root)
  • reexec: The maximum number of blocks to reprocess trying to obtain the desired state
  • base: If the caller is tracing multiple blocks, the caller can provide the parent state continuously from the callsite.
  • readOnly: If true, then the live 'blockchain' state database is used. No mutation should be made from caller, e.g. perform Commit or other 'save-to-disk' changes. Otherwise, the trash generated by caller may be persisted permanently.
  • preferDisk: this arg can be used by the caller to signal that even though the 'base' is provided, it would be preferable to start from a fresh state, if we have it on disk.

func (*Cortex) Stop 

func (s *Cortex) Stop() error

Stop implements node.Service, terminating all internal goroutines used by the Cortex protocol.

func (*Cortex) StopMining 

func (s *Cortex) StopMining()

StopMining terminates the miner, both at the consensus engine level as well as at the block creation level.

func (*Cortex) Synced added in v1.9.54 

func (s *Cortex) Synced() bool

func (*Cortex) TxPool 

func (s *Cortex) TxPool() *txpool.TxPool

type CortexAPIBackend 

type CortexAPIBackend struct {
	// contains filtered or unexported fields
}

CortexAPIBackend implements ctxcapi.Backend for full nodes

func (*CortexAPIBackend) AccountManager 

func (b *CortexAPIBackend) AccountManager() *accounts.Manager

func (*CortexAPIBackend) BlockByHash added in v1.9.51 

func (b *CortexAPIBackend) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)

func (*CortexAPIBackend) BlockByNumber 

func (b *CortexAPIBackend) BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)

func (*CortexAPIBackend) BlockByNumberOrHash added in v1.9.51 

func (b *CortexAPIBackend) BlockByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Block, error)

func (*CortexAPIBackend) BloomStatus 

func (b *CortexAPIBackend) BloomStatus() (uint64, uint64)

func (*CortexAPIBackend) ChainConfig 

func (b *CortexAPIBackend) ChainConfig() *params.ChainConfig

ChainConfig returns the active chain configuration.

func (*CortexAPIBackend) ChainDb 

func (b *CortexAPIBackend) ChainDb() ctxcdb.Database

func (*CortexAPIBackend) CurrentBlock 

func (b *CortexAPIBackend) CurrentBlock() *types.Block

func (*CortexAPIBackend) CurrentHeader added in v1.10.25 

func (b *CortexAPIBackend) CurrentHeader() *types.Header

func (*CortexAPIBackend) Download added in v1.10.30 

func (b *CortexAPIBackend) Download(ih string) error

func (*CortexAPIBackend) Engine added in v1.10.27 

func (b *CortexAPIBackend) Engine() consensus.Engine

func (*CortexAPIBackend) EventMux 

func (b *CortexAPIBackend) EventMux() *event.TypeMux

func (*CortexAPIBackend) GetBlock 

func (b *CortexAPIBackend) GetBlock(ctx context.Context, hash common.Hash) (*types.Block, error)

func (*CortexAPIBackend) GetCVM 

func (b *CortexAPIBackend) GetCVM(ctx context.Context, msg *core.Message, state *state.StateDB, header *types.Header, vmCfg vm.Config) *vm.CVM

func (*CortexAPIBackend) GetLogs 

func (b *CortexAPIBackend) GetLogs(ctx context.Context, hash common.Hash, number uint64) ([][]*types.Log, error)

func (*CortexAPIBackend) GetPoolNonce 

func (b *CortexAPIBackend) GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)

func (*CortexAPIBackend) GetPoolTransaction 

func (b *CortexAPIBackend) GetPoolTransaction(hash common.Hash) *types.Transaction

func (*CortexAPIBackend) GetPoolTransactions 

func (b *CortexAPIBackend) GetPoolTransactions() (types.Transactions, error)

func (*CortexAPIBackend) GetReceipts 

func (b *CortexAPIBackend) GetReceipts(ctx context.Context, hash common.Hash) (types.Receipts, error)

func (*CortexAPIBackend) GetTd 

func (b *CortexAPIBackend) GetTd(ctx context.Context, blockHash common.Hash) *big.Int

func (*CortexAPIBackend) GetTransaction added in v1.10.0 

func (b *CortexAPIBackend) GetTransaction(ctx context.Context, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)

func (*CortexAPIBackend) HeaderByHash 

func (b *CortexAPIBackend) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)

func (*CortexAPIBackend) HeaderByNumber 

func (b *CortexAPIBackend) HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)

func (*CortexAPIBackend) ListAllTorrents added in v1.10.30 

func (b *CortexAPIBackend) ListAllTorrents() map[string]map[string]int

func (*CortexAPIBackend) PauseLocalSeed added in v1.10.30 

func (b *CortexAPIBackend) PauseLocalSeed(ih string) error

func (*CortexAPIBackend) PendingBlockAndReceipts added in v1.10.34 

func (b *CortexAPIBackend) PendingBlockAndReceipts() (*types.Block, types.Receipts)

func (*CortexAPIBackend) ProtocolVersion 

func (b *CortexAPIBackend) ProtocolVersion() int

func (*CortexAPIBackend) RPCGasCap added in v1.10.2 

func (b *CortexAPIBackend) RPCGasCap() uint64

func (*CortexAPIBackend) RPCTxFeeCap added in v1.10.2 

func (b *CortexAPIBackend) RPCTxFeeCap() float64

func (*CortexAPIBackend) ResumeLocalSeed added in v1.10.30 

func (b *CortexAPIBackend) ResumeLocalSeed(ih string) error

func (*CortexAPIBackend) SeedingLocal added in v1.10.28 

func (b *CortexAPIBackend) SeedingLocal(filePath string, isLinkMode bool) (string, error)

func (*CortexAPIBackend) SendTx 

func (b *CortexAPIBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error

func (*CortexAPIBackend) ServiceFilter 

func (b *CortexAPIBackend) ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)

func (*CortexAPIBackend) SetHead 

func (b *CortexAPIBackend) SetHead(number uint64)

func (*CortexAPIBackend) StateAndHeaderByNumber 

func (b *CortexAPIBackend) StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*state.StateDB, *types.Header, error)

func (*CortexAPIBackend) StateAndHeaderByNumberOrHash added in v1.10.25 

func (b *CortexAPIBackend) StateAndHeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*state.StateDB, *types.Header, error)

func (*CortexAPIBackend) StateAtBlock added in v1.10.34 

func (b *CortexAPIBackend) StateAtBlock(ctx context.Context, block *types.Block, reexec uint64, base *state.StateDB, readOnly bool, preferDisk bool) (*state.StateDB, tracers.StateReleaseFunc, error)

func (*CortexAPIBackend) StateAtTransaction added in v1.10.34 

func (b *CortexAPIBackend) StateAtTransaction(ctx context.Context, block *types.Block, txIndex int, reexec uint64) (*core.Message, vm.BlockContext, *state.StateDB, tracers.StateReleaseFunc, error)

func (*CortexAPIBackend) Stats 

func (b *CortexAPIBackend) Stats() (pending int, queued int)

func (*CortexAPIBackend) SubscribeChainEvent 

func (b *CortexAPIBackend) SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription

func (*CortexAPIBackend) SubscribeChainHeadEvent 

func (b *CortexAPIBackend) SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription

func (*CortexAPIBackend) SubscribeChainSideEvent 

func (b *CortexAPIBackend) SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription

func (*CortexAPIBackend) SubscribeLogsEvent 

func (b *CortexAPIBackend) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription

func (*CortexAPIBackend) SubscribeNewTxsEvent 

func (b *CortexAPIBackend) SubscribeNewTxsEvent(ch chan<- core.NewTxsEvent) event.Subscription

func (*CortexAPIBackend) SubscribePendingLogsEvent added in v1.10.3 

func (b *CortexAPIBackend) SubscribePendingLogsEvent(ch chan<- []*types.Log) event.Subscription

func (*CortexAPIBackend) SubscribeRemovedLogsEvent 

func (b *CortexAPIBackend) SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription

func (*CortexAPIBackend) SuggestPrice 

func (b *CortexAPIBackend) SuggestPrice(ctx context.Context) (*big.Int, error)

func (*CortexAPIBackend) SyncProgress added in v1.10.28 

func (b *CortexAPIBackend) SyncProgress() cortex.SyncProgress

func (*CortexAPIBackend) TxPool added in v1.10.25 

func (b *CortexAPIBackend) TxPool() *txpool.TxPool

func (*CortexAPIBackend) TxPoolContent 

func (b *CortexAPIBackend) TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)

func (*CortexAPIBackend) TxPoolContentFrom added in v1.10.25 

func (b *CortexAPIBackend) TxPoolContentFrom(addr common.Address) (types.Transactions, types.Transactions)

func (*CortexAPIBackend) UnprotectedAllowed added in v1.10.20 

func (b *CortexAPIBackend) UnprotectedAllowed() bool

func (*CortexAPIBackend) Upload added in v1.10.56 

func (b *CortexAPIBackend) Upload(filePath string) (string, error)

type NodeInfo 

type NodeInfo struct {
	Network    uint64              `json:"network"`    // Cortex network ID
	Difficulty *big.Int            `json:"difficulty"` // Total difficulty of the host's blockchain
	Genesis    common.Hash         `json:"genesis"`    // SHA3 hash of the host's genesis block
	Config     *params.ChainConfig `json:"config"`     // Chain configuration for the fork rules
	Head       common.Hash         `json:"head"`       // SHA3 hash of the host's best owned block
}

NodeInfo represents a short summary of the Cortex sub-protocol metadata known about the host peer.

type PeerInfo 

type PeerInfo struct {
	Version    uint     `json:"version"`    // Cortex protocol version negotiated
	Difficulty *big.Int `json:"difficulty"` // Total difficulty of the peer's blockchain
	Head       string   `json:"head"`       // SHA3 hash of the peer's best owned block
}

PeerInfo represents a short summary of the Cortex sub-protocol metadata known about a connected peer.

type PrivateAdminAPI 

type PrivateAdminAPI struct {
	// contains filtered or unexported fields
}

PrivateAdminAPI is the collection of Cortex full node-related APIs exposed over the private admin endpoint.

func NewPrivateAdminAPI 

func NewPrivateAdminAPI(ctxc *Cortex) *PrivateAdminAPI

NewPrivateAdminAPI creates a new API definition for the full node private admin methods of the Cortex service.

func (*PrivateAdminAPI) ExportChain 

func (api *PrivateAdminAPI) ExportChain(file string) (bool, error)

ExportChain exports the current blockchain into a local file.

func (*PrivateAdminAPI) ImportChain 

func (api *PrivateAdminAPI) ImportChain(file string) (bool, error)

ImportChain imports a blockchain from a local file.

type PrivateDebugAPI 

type PrivateDebugAPI struct {
	// contains filtered or unexported fields
}

PrivateDebugAPI is the collection of Cortex full node APIs exposed over the private debugging endpoint.

func NewPrivateDebugAPI 

func NewPrivateDebugAPI(config *params.ChainConfig, ctxc *Cortex) *PrivateDebugAPI

NewPrivateDebugAPI creates a new API definition for the full node-related private debug methods of the Cortex service.

func (*PrivateDebugAPI) GetBadBlocks 

func (api *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]*BadBlockArgs, error)

GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network and returns them as a JSON list of block-hashes GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network and returns them as a JSON list of block hashes.

func (*PrivateDebugAPI) GetModifiedAccountsByHash 

func (api *PrivateDebugAPI) GetModifiedAccountsByHash(startHash common.Hash, endHash *common.Hash) ([]common.Address, error)

GetModifiedAccountsByHash returns all accounts that have changed between the two blocks specified. A change is defined as a difference in nonce, balance, code hash, or storage hash.

With one parameter, returns the list of accounts modified in the specified block.

func (*PrivateDebugAPI) GetModifiedAccountsByNumber 

func (api *PrivateDebugAPI) GetModifiedAccountsByNumber(startNum uint64, endNum *uint64) ([]common.Address, error)

GetModifiedAccountsByNumber returns all accounts that have changed between the two blocks specified. A change is defined as a difference in nonce, balance, code hash, or storage hash.

With one parameter, returns the list of accounts modified in the specified block.

func (*PrivateDebugAPI) Preimage 

func (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error)

Preimage is a debug API function that returns the preimage for a sha3 hash, if known.

func (*PrivateDebugAPI) StorageRangeAt 

func (api *PrivateDebugAPI) StorageRangeAt(ctx context.Context, blockHash common.Hash, txIndex int, contractAddress common.Address, keyStart hexutil.Bytes, maxResult int) (StorageRangeResult, error)

StorageRangeAt returns the storage at the given block height and transaction index.

type PrivateMinerAPI 

type PrivateMinerAPI struct {
	// contains filtered or unexported fields
}

PrivateMinerAPI provides private RPC methods to control the miner. These methods can be abused by external users and must be considered insecure for use by untrusted users.

func NewPrivateMinerAPI 

func NewPrivateMinerAPI(e *Cortex) *PrivateMinerAPI

NewPrivateMinerAPI create a new RPC service which controls the miner of this node.

func (*PrivateMinerAPI) GetHashrate 

func (api *PrivateMinerAPI) GetHashrate() uint64

GetHashrate returns the current hashrate of the miner.

func (*PrivateMinerAPI) SetCoinbase 

func (api *PrivateMinerAPI) SetCoinbase(coinbase common.Address) bool

SetCoinbase sets the coinbase of the miner

func (*PrivateMinerAPI) SetExtra 

func (api *PrivateMinerAPI) SetExtra(extra string) (bool, error)

SetExtra sets the extra data string that is included when this miner mines a block.

func (*PrivateMinerAPI) SetGasLimit added in v1.10.25 

func (api *PrivateMinerAPI) SetGasLimit(gasLimit hexutil.Uint64) bool

SetGasLimit sets the gaslimit to target towards during mining.

func (*PrivateMinerAPI) SetGasPrice 

func (api *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool

SetGasPrice sets the minimum accepted gas price for the miner.

func (*PrivateMinerAPI) SetRecommitInterval 

func (api *PrivateMinerAPI) SetRecommitInterval(interval int)

SetRecommitInterval updates the interval for miner sealing work recommitting.

func (*PrivateMinerAPI) Start 

func (api *PrivateMinerAPI) Start(threads *int) error

Start starts the miner with the given number of threads. If threads is nil, the number of workers started is equal to the number of logical CPUs that are usable by this process. If mining is already running, this method adjust the number of threads allowed to use and updates the minimum price required by the transaction pool.

func (*PrivateMinerAPI) Stop 

func (api *PrivateMinerAPI) Stop()

Stop terminates the miner, both at the consensus engine level as well as at the block creation level.

type ProtocolManager 

type ProtocolManager struct {
	// contains filtered or unexported fields
}

func NewProtocolManager 

func NewProtocolManager(config *handlerConfig) (*ProtocolManager, error)

NewProtocolManager returns a new Cortex sub protocol manager. The Cortex sub protocol manages peers capable with the Cortex network.

func (*ProtocolManager) BroadcastBlock 

func (pm *ProtocolManager) BroadcastBlock(block *types.Block, propagate bool)

BroadcastBlock will either propagate a block to a subset of it's peers, or will only announce it's availability (depending what's requested).

func (*ProtocolManager) BroadcastTransactions added in v1.9.51 

func (pm *ProtocolManager) BroadcastTransactions(txs types.Transactions)

BroadcastTxs will propagate a batch of transactions to all peers which are not known to already have the given transaction.

func (*ProtocolManager) NodeInfo 

func (pm *ProtocolManager) NodeInfo() *NodeInfo

NodeInfo retrieves some protocol metadata about the running host node.

func (*ProtocolManager) Start 

func (pm *ProtocolManager) Start(maxPeers int)

func (*ProtocolManager) Stop 

func (pm *ProtocolManager) Stop()

type PublicCortexAPI 

type PublicCortexAPI struct {
	// contains filtered or unexported fields
}

PublicCortexAPI provides an API to access Cortex full node-related information.

func NewPublicCortexAPI 

func NewPublicCortexAPI(e *Cortex) *PublicCortexAPI

NewPublicCortexAPI creates a new Cortex protocol API for full nodes.

func (*PublicCortexAPI) ChainId added in v1.9.51 

func (api *PublicCortexAPI) ChainId() hexutil.Uint64

ChainId is the EIP-155 replay-protection chain id for the current cortex chain config.

func (*PublicCortexAPI) Coinbase 

func (api *PublicCortexAPI) Coinbase() (common.Address, error)

Coinbase is the address that mining rewards will be send to

func (*PublicCortexAPI) Hashrate 

func (api *PublicCortexAPI) Hashrate() hexutil.Uint64

Hashrate returns the POW hashrate

type PublicDebugAPI 

type PublicDebugAPI struct {
	// contains filtered or unexported fields
}

PublicDebugAPI is the collection of Cortex full node APIs exposed over the public debugging endpoint.

func NewPublicDebugAPI 

func NewPublicDebugAPI(ctxc *Cortex) *PublicDebugAPI

NewPublicDebugAPI creates a new API definition for the full node- related public debug methods of the Cortex service.

func (*PublicDebugAPI) DumpBlock 

func (api *PublicDebugAPI) DumpBlock(blockNr rpc.BlockNumber) (state.Dump, error)

DumpBlock retrieves the entire state of the database at a given block.

type PublicMinerAPI 

type PublicMinerAPI struct {
	// contains filtered or unexported fields
}

PublicMinerAPI provides an API to control the miner. It offers only methods that operate on data that pose no security risk when it is publicly accessible.

func NewPublicMinerAPI 

func NewPublicMinerAPI(e *Cortex) *PublicMinerAPI

NewPublicMinerAPI create a new PublicMinerAPI instance.

func (*PublicMinerAPI) Mining 

func (api *PublicMinerAPI) Mining() bool

Mining returns an indication if this node is currently mining.

type Request added in v1.10.39 

type Request struct {
	Peer string    // Demultiplexer if cross-peer requests are batched together
	Sent time.Time // Timestamp when the request was sent
	// contains filtered or unexported fields
}

Request is a pending request to allow tracking it and delivering a response back to the requester on their chosen channel.

func (*Request) Close added in v1.10.39 

func (r *Request) Close() error

Close aborts an in-flight request. Although there's no way to notify the remote peer about the cancellation, this method notifies the dispatcher to discard any late responses.

type Response added in v1.10.39 

type Response struct {
	Req  *Request      // Original request to cross-reference with
	Res  any           // Remote response for the request query
	Meta any           // Metadata generated locally on the receiver thread
	Time time.Duration // Time it took for the request to be served
	Done chan error    // Channel to signal message handling to the reader
	// contains filtered or unexported fields
}

Response is a reply packet to a previously created request. It is delivered on the channel assigned by the requester subsystem and contains the original request embedded to allow uniquely matching it caller side.

type StorageRangeResult 

type StorageRangeResult struct {
	Storage storageMap   `json:"storage"`
	NextKey *common.Hash `json:"nextKey"` // nil if Storage includes the last key in the trie.
}

StorageRangeResult is the result of a debug_storageRangeAt API call.

Source Files

View all Source files

Directories

Path Synopsis
Package downloader contains the manual full chain synchronisation.
 Package downloader contains the manual full chain synchronisation.
Package fetcher contains the block announcement based synchronisation.
 Package fetcher contains the block announcement based synchronisation.
Package filters implements an cortex filtering system for block, transactions and log events.
 Package filters implements an cortex filtering system for block, transactions and log events.
protocols
ctxc
Package tracers is a manager for transaction tracing engines.
 Package tracers is a manager for transaction tracing engines.
js
js/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
logger
native
Package native is a collection of tracers written in go.
 Package native is a collection of tracers written in go.

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.