coreth

package module
v0.3.20-rc.4 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2021 License: LGPL-3.0 Imports: 21 Imported by: 0

README

coreth

Documentation

Overview

Package ethereum defines interfaces for interacting with Ethereum.

Index

Constants

This section is empty.

Variables

View Source 
var (
	BlackholeAddr = common.Address{
		1, 0, 0, 0, 0, 0, 0, 0, 0, 0,
		0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
	}
)
View Source 
var NotFound = errors.New("not found")

NotFound is returned by API methods if the requested item does not exist.

Functions

This section is empty.

Types

type Block 

type Block = types.Block

type CallMsg added in v0.3.15 

type CallMsg struct {
	From     common.Address  // the sender of the 'transaction'
	To       *common.Address // the destination contract (nil for contract creation)
	Gas      uint64          // if 0, the call executes with near-infinite gas
	GasPrice *big.Int        // wei <-> gas exchange ratio
	Value    *big.Int        // amount of wei sent along with the call
	Data     []byte          // input data, usually an ABI-encoded contract method invocation
}

CallMsg contains parameters for contract calls.

type ChainReader added in v0.3.15 

type ChainReader interface {
	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
	TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)
	TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

	// This method subscribes to notifications about changes of the head block of
	// the canonical chain.
	SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error)
}

ChainReader provides access to the blockchain. The methods in this interface access raw data from either the canonical chain (when requesting by block number) or any blockchain fork that was previously downloaded and processed by the node. The block number argument can be nil to select the latest canonical block. Reading block headers should be preferred over full blocks whenever possible.

The returned error is NotFound if the requested item does not exist.

type ChainStateReader added in v0.3.15 

type ChainStateReader interface {
	BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)
	StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
	CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
}

ChainStateReader wraps access to the state trie of the canonical blockchain. Note that implementations of the interface may be unable to return state values for old blocks. In many cases, using CallContract can be preferable to reading raw contract storage.

type ChainSyncReader added in v0.3.15 

type ChainSyncReader interface {
	SyncProgress(ctx context.Context) (*SyncProgress, error)
}

ChainSyncReader wraps access to the node's current sync status. If there's no sync currently running, it returns nil.

type ContractCaller added in v0.3.15 

type ContractCaller interface {
	CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error)
}

A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain. ContractCall is a low-level method to execute such calls. For applications which are structured around specific contracts, the abigen tool provides a nicer, properly typed way to perform calls.

type ETHChain 

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

func NewETHChain 

func NewETHChain(config *eth.Config, nodecfg *node.Config, etherBase *common.Address, chainDB ethdb.Database) *ETHChain

NewETHChain creates an Ethereum blockchain with the given configs.

func (*ETHChain) AddLocalTxs 

func (self *ETHChain) AddLocalTxs(txs []*types.Transaction) []error

func (*ETHChain) AddRemoteTxs 

func (self *ETHChain) AddRemoteTxs(txs []*types.Transaction) []error

func (*ETHChain) AttachEthService 

func (self *ETHChain) AttachEthService(handler *rpc.Server, namespaces []string)

func (*ETHChain) BlockChain added in v0.3.4 

func (self *ETHChain) BlockChain() *core.BlockChain

func (*ETHChain) BlockState 

func (self *ETHChain) BlockState(block *types.Block) (*state.StateDB, error)

Returns a new mutable state based on the given block.

func (*ETHChain) CurrentState 

func (self *ETHChain) CurrentState() (*state.StateDB, error)

Returns a new mutable state based on the current HEAD block.

func (*ETHChain) GenBlock 

func (self *ETHChain) GenBlock()

func (*ETHChain) GetBlockByHash 

func (self *ETHChain) GetBlockByHash(hash common.Hash) *types.Block

Retrives a block from the database by hash.

func (*ETHChain) GetBlockByNumber added in v0.3.20 

func (self *ETHChain) GetBlockByNumber(num uint64) *types.Block

Retrives a block from the database by number.

func (*ETHChain) GetGenesisBlock 

func (self *ETHChain) GetGenesisBlock() *types.Block

func (*ETHChain) GetReceiptsByHash 

func (self *ETHChain) GetReceiptsByHash(hash common.Hash) types.Receipts

func (*ETHChain) GetTxPool 

func (self *ETHChain) GetTxPool() *core.TxPool

func (*ETHChain) GetTxSubmitCh 

func (self *ETHChain) GetTxSubmitCh() <-chan struct{}

TODO: use SubscribeNewTxsEvent()

func (*ETHChain) InsertChain 

func (self *ETHChain) InsertChain(chain []*types.Block) (int, error)

func (*ETHChain) NewRPCHandler 

func (self *ETHChain) NewRPCHandler() *rpc.Server

func (*ETHChain) PendingSize 

func (self *ETHChain) PendingSize() (int, error)

func (*ETHChain) SetOnAPIs 

func (self *ETHChain) SetOnAPIs(cb dummy.OnAPIsCallbackType)

func (*ETHChain) SetOnExtraStateChange added in v0.2.12 

func (self *ETHChain) SetOnExtraStateChange(cb dummy.OnExtraStateChangeType)

func (*ETHChain) SetOnFinalize 

func (self *ETHChain) SetOnFinalize(cb dummy.OnFinalizeCallbackType)

func (*ETHChain) SetOnFinalizeAndAssemble 

func (self *ETHChain) SetOnFinalizeAndAssemble(cb dummy.OnFinalizeAndAssembleCallbackType)

func (*ETHChain) SetOnHeaderNew 

func (self *ETHChain) SetOnHeaderNew(cb func(*types.Header))

func (*ETHChain) SetOnQueryAcceptedBlock 

func (self *ETHChain) SetOnQueryAcceptedBlock(cb func() *types.Block)

func (*ETHChain) SetOnSeal 

func (self *ETHChain) SetOnSeal(cb func(*types.Block) error)

func (*ETHChain) SetOnSealDrop 

func (self *ETHChain) SetOnSealDrop(cb func(*types.Block))

func (*ETHChain) SetOnSealFinish 

func (self *ETHChain) SetOnSealFinish(cb func(*types.Block) error)

func (*ETHChain) SetOnSealHash 

func (self *ETHChain) SetOnSealHash(cb func(*types.Header))

func (*ETHChain) SetPreference added in v0.3.20 

func (self *ETHChain) SetPreference(block *types.Block)

SetPreference sets the block we should treat as the parent when building future blocks. [block] may not yet be finalized when this function is called.

func (*ETHChain) SetTail 

func (self *ETHChain) SetTail(hash common.Hash) error

SetTail sets the current head block to the one defined by the hash irrelevant what the chain contents were prior.

func (*ETHChain) Start 

func (self *ETHChain) Start()

func (*ETHChain) Stop 

func (self *ETHChain) Stop()

func (*ETHChain) SubscribeNewMinedBlockEvent added in v0.3.1 

func (self *ETHChain) SubscribeNewMinedBlockEvent() *event.TypeMuxSubscription

func (*ETHChain) ValidateCanonicalChain added in v0.3.20 

func (self *ETHChain) ValidateCanonicalChain() error

Validate the canonical chain from current block to the genesis. This should only be called as a convenience method in tests, not in production as it traverses the entire chain.

func (*ETHChain) VerifyBlock added in v0.2.8 

func (self *ETHChain) VerifyBlock(block *types.Block) bool

func (*ETHChain) WriteCanonicalFromCurrentBlock added in v0.3.20 

func (self *ETHChain) WriteCanonicalFromCurrentBlock() error

WriteCanonicalFromCurrentBlock writes the canonical chain from the current block to the genesis.

type FilterQuery added in v0.3.15 

type FilterQuery struct {
	BlockHash *common.Hash     // used by eth_getLogs, return logs only from block with this hash
	FromBlock *big.Int         // beginning of the queried range, nil means genesis block
	ToBlock   *big.Int         // end of the range, nil means latest block
	Addresses []common.Address // restricts matches to events created by specific contracts

	// The Topic list restricts matches to particular event topics. Each event has a list
	// of topics. Topics matches a prefix of that list. An empty element slice matches any
	// topic. Non-empty elements represent an alternative that matches any of the
	// contained topics.
	//
	// Examples:
	// {} or nil          matches any topic list
	// {{A}}              matches topic A in first position
	// {{}, {B}}          matches any topic in first position AND B in second position
	// {{A}, {B}}         matches topic A in first position AND B in second position
	// {{A, B}, {C, D}}   matches topic (A OR B) in first position AND (C OR D) in second position
	Topics [][]common.Hash
}

FilterQuery contains options for contract log filtering.

type GasEstimator added in v0.3.15 

type GasEstimator interface {
	EstimateGas(ctx context.Context, call CallMsg) (uint64, error)
}

GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

type GasPricer added in v0.3.15 

type GasPricer interface {
	SuggestGasPrice(ctx context.Context) (*big.Int, error)
}

GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.

type Hash 

type Hash = common.Hash

type Key 

type Key struct {
	Address    common.Address
	PrivateKey *ecdsa.PrivateKey
}

func NewKey 

func NewKey(rand io.Reader) (*Key, error)

func NewKeyFromECDSA 

func NewKeyFromECDSA(privateKeyECDSA *ecdsa.PrivateKey) *Key

type LogFilterer added in v0.3.15 

type LogFilterer interface {
	FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error)
	SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error)
}

LogFilterer provides access to contract log events using a one-off query or continuous event subscription.

Logs received through a streaming query subscription may have Removed set to true, indicating that the log was reverted due to a chain reorganisation.

type PendingContractCaller added in v0.3.15 

type PendingContractCaller interface {
	PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error)
}

PendingContractCaller can be used to perform calls against the pending state.

type PendingStateEventer added in v0.3.15 

type PendingStateEventer interface {
	SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error)
}

A PendingStateEventer provides access to real time notifications about changes to the pending state.

type PendingStateReader added in v0.3.15 

type PendingStateReader interface {
	PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error)
	PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error)
	PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
	PendingTransactionCount(ctx context.Context) (uint, error)
}

A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain. It is commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value transfers) initiated by the user. The PendingNonceAt operation is a good way to retrieve the next available transaction nonce for a specific account.

type Subscription added in v0.3.15 

type Subscription interface {
	// Unsubscribe cancels the sending of events to the data channel
	// and closes the error channel.
	Unsubscribe()
	// Err returns the subscription error channel. The error channel receives
	// a value if there is an issue with the subscription (e.g. the network connection
	// delivering the events has been closed). Only one value will ever be sent.
	// The error channel is closed by Unsubscribe.
	Err() <-chan error
}

Subscription represents an event subscription where events are delivered on a data channel.

type SyncProgress added in v0.3.15 

type SyncProgress struct {
	StartingBlock uint64 // Block number where sync began
	CurrentBlock  uint64 // Current block number where sync is at
	HighestBlock  uint64 // Highest alleged block number in the chain
	PulledStates  uint64 // Number of state trie entries already downloaded
	KnownStates   uint64 // Total number of state trie entries known about
}

SyncProgress gives progress indications when the node is synchronising with the Ethereum network.

type TransactionReader added in v0.3.15 

type TransactionReader interface {
	// TransactionByHash checks the pool of pending transactions in addition to the
	// blockchain. The isPending return value indicates whether the transaction has been
	// mined yet. Note that the transaction may not be part of the canonical chain even if
	// it's not pending.
	TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
	// TransactionReceipt returns the receipt of a mined transaction. Note that the
	// transaction may not be included in the current canonical chain even if a receipt
	// exists.
	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
}

TransactionReader provides access to past transactions and their receipts. Implementations may impose arbitrary restrictions on the transactions and receipts that can be retrieved. Historic transactions may not be available.

Avoid relying on this interface if possible. Contract logs (through the LogFilterer interface) are more reliable and usually safer in the presence of chain reorganisations.

The returned error is NotFound if the requested item does not exist.

type TransactionSender added in v0.3.15 

type TransactionSender interface {
	SendTransaction(ctx context.Context, tx *types.Transaction) error
}

TransactionSender wraps transaction sending. The SendTransaction method injects a signed transaction into the pending transaction pool for execution. If the transaction was a contract creation, the TransactionReceipt method can be used to retrieve the contract address after the transaction has been mined.

The transaction must be signed and have a valid nonce to be included. Consumers of the API can use package accounts to maintain local private keys and need can retrieve the next available nonce using PendingNonceAt.

type Tx 

type Tx = types.Transaction

Source Files

View all Source files

Directories

Path Synopsis
Package accounts implements high level Ethereum account management.
 Package accounts implements high level Ethereum account management.
external
keystore
Package keystore implements encrypted storage of secp256k1 private keys.
 Package keystore implements encrypted storage of secp256k1 private keys.
scwallet
Package consensus implements different Ethereum consensus engines.
 Package consensus implements different Ethereum consensus engines.
clique
Package clique implements the proof-of-authority consensus engine.
 Package clique implements the proof-of-authority consensus engine.
dummy
ethash
Package ethash implements the ethash proof-of-work consensus engine.
 Package ethash implements the ethash proof-of-work consensus engine.
misc
Package core implements the Ethereum consensus protocol.
 Package core implements the Ethereum consensus protocol.
bloombits
Package bloombits implements bloom filtering on batches of data.
 Package bloombits implements bloom filtering on batches of data.
forkid
Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
 Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
rawdb
Package rawdb contains a collection of low level database accessors.
 Package rawdb contains a collection of low level database accessors.
state
Package state provides a caching layer atop the Ethereum state trie.
 Package state provides a caching layer atop the Ethereum state trie.
state/snapshot
Package snapshot implements a journalled, dynamic state dump.
 Package snapshot implements a journalled, dynamic state dump.
types
Package types contains data types related to Ethereum consensus.
 Package types contains data types related to Ethereum consensus.
vm
Package vm implements the Ethereum Virtual Machine.
 Package vm implements the Ethereum Virtual Machine.
eth
Package eth implements the Ethereum protocol.
 Package eth implements the Ethereum protocol.
filters
Package filters implements an ethereum filtering system for block, transactions and log events.
 Package filters implements an ethereum filtering system for block, transactions and log events.
gasprice
tracers
Package tracers is a collection of JavaScript transaction tracers.
 Package tracers is a collection of JavaScript transaction tracers.
tracers/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
Package ethclient provides a client for the Ethereum RPC API.
 Package ethclient provides a client for the Ethereum RPC API.
examples
block
chain
client
counter
mctx_gen
multicoin
payments
internal
debug
Package debug interfaces Go runtime debugging facilities.
 Package debug interfaces Go runtime debugging facilities.
ethapi
Package ethapi implements the general Ethereum API functions.
 Package ethapi implements the general Ethereum API functions.
Package miner implements Ethereum block creation and mining.
 Package miner implements Ethereum block creation and mining.
evm
Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
 Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports.

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.