github.com/Cleverse/go-ethereum@v0.0.0-20220927095127-45113064e7f2/interfaces.go (about) 1 // Copyright 2016 The go-ethereum Authors 2 // This file is part of the go-ethereum library. 3 // 4 // The go-ethereum library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The go-ethereum library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 16 17 // Package ethereum defines interfaces for interacting with Ethereum. 18 package ethereum 19 20 import ( 21 "context" 22 "errors" 23 "math/big" 24 25 "github.com/ethereum/go-ethereum/common" 26 "github.com/ethereum/go-ethereum/common/hexutil" 27 "github.com/ethereum/go-ethereum/core/types" 28 ) 29 30 // NotFound is returned by API methods if the requested item does not exist. 31 var NotFound = errors.New("not found") 32 33 // TODO: move subscription to package event 34 35 // Subscription represents an event subscription where events are 36 // delivered on a data channel. 37 type Subscription interface { 38 // Unsubscribe cancels the sending of events to the data channel 39 // and closes the error channel. 40 Unsubscribe() 41 // Err returns the subscription error channel. The error channel receives 42 // a value if there is an issue with the subscription (e.g. the network connection 43 // delivering the events has been closed). Only one value will ever be sent. 44 // The error channel is closed by Unsubscribe. 45 Err() <-chan error 46 } 47 48 // ChainReader provides access to the blockchain. The methods in this interface access raw 49 // data from either the canonical chain (when requesting by block number) or any 50 // blockchain fork that was previously downloaded and processed by the node. The block 51 // number argument can be nil to select the latest canonical block. Reading block headers 52 // should be preferred over full blocks whenever possible. 53 // 54 // The returned error is NotFound if the requested item does not exist. 55 type ChainReader interface { 56 BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) 57 BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) 58 HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error) 59 HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error) 60 TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error) 61 TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error) 62 63 // This method subscribes to notifications about changes of the head block of 64 // the canonical chain. 65 SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error) 66 } 67 68 // TransactionReader provides access to past transactions and their receipts. 69 // Implementations may impose arbitrary restrictions on the transactions and receipts that 70 // can be retrieved. Historic transactions may not be available. 71 // 72 // Avoid relying on this interface if possible. Contract logs (through the LogFilterer 73 // interface) are more reliable and usually safer in the presence of chain 74 // reorganisations. 75 // 76 // The returned error is NotFound if the requested item does not exist. 77 type TransactionReader interface { 78 // TransactionByHash checks the pool of pending transactions in addition to the 79 // blockchain. The isPending return value indicates whether the transaction has been 80 // mined yet. Note that the transaction may not be part of the canonical chain even if 81 // it's not pending. 82 TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error) 83 // TransactionReceipt returns the receipt of a mined transaction. Note that the 84 // transaction may not be included in the current canonical chain even if a receipt 85 // exists. 86 TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error) 87 } 88 89 // ChainStateReader wraps access to the state trie of the canonical blockchain. Note that 90 // implementations of the interface may be unable to return state values for old blocks. 91 // In many cases, using CallContract can be preferable to reading raw contract storage. 92 type ChainStateReader interface { 93 BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error) 94 StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error) 95 CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error) 96 NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error) 97 } 98 99 // SyncProgress gives progress indications when the node is synchronising with 100 // the Ethereum network. 101 type SyncProgress struct { 102 StartingBlock uint64 // Block number where sync began 103 CurrentBlock uint64 // Current block number where sync is at 104 HighestBlock uint64 // Highest alleged block number in the chain 105 106 // "fast sync" fields. These used to be sent by geth, but are no longer used 107 // since version v1.10. 108 PulledStates uint64 // Number of state trie entries already downloaded 109 KnownStates uint64 // Total number of state trie entries known about 110 111 // "snap sync" fields. 112 SyncedAccounts uint64 // Number of accounts downloaded 113 SyncedAccountBytes uint64 // Number of account trie bytes persisted to disk 114 SyncedBytecodes uint64 // Number of bytecodes downloaded 115 SyncedBytecodeBytes uint64 // Number of bytecode bytes downloaded 116 SyncedStorage uint64 // Number of storage slots downloaded 117 SyncedStorageBytes uint64 // Number of storage trie bytes persisted to disk 118 119 HealedTrienodes uint64 // Number of state trie nodes downloaded 120 HealedTrienodeBytes uint64 // Number of state trie bytes persisted to disk 121 HealedBytecodes uint64 // Number of bytecodes downloaded 122 HealedBytecodeBytes uint64 // Number of bytecodes persisted to disk 123 124 HealingTrienodes uint64 // Number of state trie nodes pending 125 HealingBytecode uint64 // Number of bytecodes pending 126 } 127 128 func (progress SyncProgress) ToMap() map[string]interface{} { 129 if progress.CurrentBlock >= progress.HighestBlock { 130 return nil 131 } 132 // Otherwise gather the block sync stats 133 return map[string]interface{}{ 134 "startingBlock": hexutil.Uint64(progress.StartingBlock), 135 "currentBlock": hexutil.Uint64(progress.CurrentBlock), 136 "highestBlock": hexutil.Uint64(progress.HighestBlock), 137 "syncedAccounts": hexutil.Uint64(progress.SyncedAccounts), 138 "syncedAccountBytes": hexutil.Uint64(progress.SyncedAccountBytes), 139 "syncedBytecodes": hexutil.Uint64(progress.SyncedBytecodes), 140 "syncedBytecodeBytes": hexutil.Uint64(progress.SyncedBytecodeBytes), 141 "syncedStorage": hexutil.Uint64(progress.SyncedStorage), 142 "syncedStorageBytes": hexutil.Uint64(progress.SyncedStorageBytes), 143 "healedTrienodes": hexutil.Uint64(progress.HealedTrienodes), 144 "healedTrienodeBytes": hexutil.Uint64(progress.HealedTrienodeBytes), 145 "healedBytecodes": hexutil.Uint64(progress.HealedBytecodes), 146 "healedBytecodeBytes": hexutil.Uint64(progress.HealedBytecodeBytes), 147 "healingTrienodes": hexutil.Uint64(progress.HealingTrienodes), 148 "healingBytecode": hexutil.Uint64(progress.HealingBytecode), 149 } 150 } 151 152 // ChainSyncReader wraps access to the node's current sync status. If there's no 153 // sync currently running, it returns nil. 154 type ChainSyncReader interface { 155 SyncProgress(ctx context.Context) (*SyncProgress, error) 156 } 157 158 // CallMsg contains parameters for contract calls. 159 type CallMsg struct { 160 From common.Address // the sender of the 'transaction' 161 To *common.Address // the destination contract (nil for contract creation) 162 Gas uint64 // if 0, the call executes with near-infinite gas 163 GasPrice *big.Int // wei <-> gas exchange ratio 164 GasFeeCap *big.Int // EIP-1559 fee cap per gas. 165 GasTipCap *big.Int // EIP-1559 tip per gas. 166 Value *big.Int // amount of wei sent along with the call 167 Data []byte // input data, usually an ABI-encoded contract method invocation 168 169 AccessList types.AccessList // EIP-2930 access list. 170 } 171 172 // A ContractCaller provides contract calls, essentially transactions that are executed by 173 // the EVM but not mined into the blockchain. ContractCall is a low-level method to 174 // execute such calls. For applications which are structured around specific contracts, 175 // the abigen tool provides a nicer, properly typed way to perform calls. 176 type ContractCaller interface { 177 CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error) 178 } 179 180 // FilterQuery contains options for contract log filtering. 181 type FilterQuery struct { 182 BlockHash *common.Hash // used by eth_getLogs, return logs only from block with this hash 183 FromBlock *big.Int // beginning of the queried range, nil means genesis block 184 ToBlock *big.Int // end of the range, nil means latest block 185 Addresses []common.Address // restricts matches to events created by specific contracts 186 187 // The Topic list restricts matches to particular event topics. Each event has a list 188 // of topics. Topics matches a prefix of that list. An empty element slice matches any 189 // topic. Non-empty elements represent an alternative that matches any of the 190 // contained topics. 191 // 192 // Examples: 193 // {} or nil matches any topic list 194 // {{A}} matches topic A in first position 195 // {{}, {B}} matches any topic in first position AND B in second position 196 // {{A}, {B}} matches topic A in first position AND B in second position 197 // {{A, B}, {C, D}} matches topic (A OR B) in first position AND (C OR D) in second position 198 Topics [][]common.Hash 199 } 200 201 // LogFilterer provides access to contract log events using a one-off query or continuous 202 // event subscription. 203 // 204 // Logs received through a streaming query subscription may have Removed set to true, 205 // indicating that the log was reverted due to a chain reorganisation. 206 type LogFilterer interface { 207 FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error) 208 SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error) 209 } 210 211 // TransactionSender wraps transaction sending. The SendTransaction method injects a 212 // signed transaction into the pending transaction pool for execution. If the transaction 213 // was a contract creation, the TransactionReceipt method can be used to retrieve the 214 // contract address after the transaction has been mined. 215 // 216 // The transaction must be signed and have a valid nonce to be included. Consumers of the 217 // API can use package accounts to maintain local private keys and need can retrieve the 218 // next available nonce using PendingNonceAt. 219 type TransactionSender interface { 220 SendTransaction(ctx context.Context, tx *types.Transaction) error 221 } 222 223 // GasPricer wraps the gas price oracle, which monitors the blockchain to determine the 224 // optimal gas price given current fee market conditions. 225 type GasPricer interface { 226 SuggestGasPrice(ctx context.Context) (*big.Int, error) 227 } 228 229 // A PendingStateReader provides access to the pending state, which is the result of all 230 // known executable transactions which have not yet been included in the blockchain. It is 231 // commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value 232 // transfers) initiated by the user. The PendingNonceAt operation is a good way to 233 // retrieve the next available transaction nonce for a specific account. 234 type PendingStateReader interface { 235 PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error) 236 PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error) 237 PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error) 238 PendingNonceAt(ctx context.Context, account common.Address) (uint64, error) 239 PendingTransactionCount(ctx context.Context) (uint, error) 240 } 241 242 // PendingContractCaller can be used to perform calls against the pending state. 243 type PendingContractCaller interface { 244 PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error) 245 } 246 247 // GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a 248 // specific transaction based on the pending state. There is no guarantee that this is the 249 // true gas limit requirement as other transactions may be added or removed by miners, but 250 // it should provide a basis for setting a reasonable default. 251 type GasEstimator interface { 252 EstimateGas(ctx context.Context, call CallMsg) (uint64, error) 253 } 254 255 // A PendingStateEventer provides access to real time notifications about changes to the 256 // pending state. 257 type PendingStateEventer interface { 258 SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error) 259 }