// Copyright 2015 The go-ethereum Authors // This file is part of the go-ethereum library. // // The go-ethereum library is free software: you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // The go-ethereum library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License // along with the go-ethereum library. If not, see . package eth import ( "compress/gzip" "context" "errors" "fmt" "io" "math/big" "os" "strings" "github.com/XinFinOrg/XDPoSChain/common" "github.com/XinFinOrg/XDPoSChain/common/hexutil" "github.com/XinFinOrg/XDPoSChain/core" "github.com/XinFinOrg/XDPoSChain/core/rawdb" "github.com/XinFinOrg/XDPoSChain/core/state" "github.com/XinFinOrg/XDPoSChain/core/types" "github.com/XinFinOrg/XDPoSChain/log" "github.com/XinFinOrg/XDPoSChain/miner" "github.com/XinFinOrg/XDPoSChain/params" "github.com/XinFinOrg/XDPoSChain/rlp" "github.com/XinFinOrg/XDPoSChain/rpc" "github.com/XinFinOrg/XDPoSChain/trie" ) // EthereumAPI provides an API to access Ethereum full node-related information. type EthereumAPI struct { e *Ethereum } // NewPublicEthereumAPI creates a new Ethereum protocol API for full nodes. func NewEthereumAPI(e *Ethereum) *EthereumAPI { return &EthereumAPI{e} } // Etherbase is the address that mining rewards will be send to func (api *EthereumAPI) Etherbase() (common.Address, error) { return api.e.Etherbase() } // Coinbase is the address that mining rewards will be send to (alias for Etherbase) func (api *EthereumAPI) Coinbase() (common.Address, error) { return api.Etherbase() } // Hashrate returns the POW hashrate func (api *EthereumAPI) Hashrate() hexutil.Uint64 { return hexutil.Uint64(api.e.Miner().HashRate()) } // Mining returns an indication if this node is currently mining. func (api *EthereumAPI) Mining() bool { return api.e.IsStaking() } // SubmitWork can be used by external miner to submit their POW solution. It returns an indication if the work was // accepted. Note, this is not an indication if the provided work was valid! func (api *MinerAPI) SubmitWork(nonce types.BlockNonce, solution, digest common.Hash) bool { return api.agent.SubmitWork(nonce, digest, solution) } // GetWork returns a work package for external miner. The work package consists of 3 strings // result[0], 32 bytes hex encoded current block header pow-hash // result[1], 32 bytes hex encoded seed hash used for DAG // result[2], 32 bytes hex encoded boundary condition ("target"), 2^256/difficulty func (api *MinerAPI) GetWork() ([3]string, error) { if !api.e.IsStaking() { if err := api.e.StartStaking(false); err != nil { return [3]string{}, err } } work, err := api.agent.GetWork() if err != nil { return work, fmt.Errorf("mining not ready: %v", err) } return work, nil } // SubmitHashrate can be used for remote miners to submit their hash rate. This enables the node to report the combined // hash rate of all miners which submit work through this node. It accepts the miner hash rate and an identifier which // must be unique between nodes. func (api *MinerAPI) SubmitHashrate(hashrate hexutil.Uint64, id common.Hash) bool { api.agent.SubmitHashrate(id, uint64(hashrate)) return true } // MinerAPI provides an API to control the miner. type MinerAPI struct { e *Ethereum agent *miner.RemoteAgent } // NewMinerAPI create a new RPC service which controls the miner of this node. func NewMinerAPI(e *Ethereum) *MinerAPI { agent := miner.NewRemoteAgent(e.BlockChain(), e.Engine()) e.Miner().Register(agent) return &MinerAPI{e, agent} } // Start 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. func (api *MinerAPI) Start(threads *int) error { // Set the number of threads if the seal engine supports it if threads == nil { threads = new(int) } else if *threads == 0 { *threads = -1 // Disable the miner from within } type threaded interface { SetThreads(threads int) } if th, ok := api.e.engine.(threaded); ok { log.Info("Updated mining threads", "threads", *threads) th.SetThreads(*threads) } // Start the miner and return if !api.e.IsStaking() { // Propagate the initial price point to the transaction pool api.e.lock.RLock() price := api.e.gasPrice api.e.lock.RUnlock() api.e.txPool.SetGasPrice(price) return api.e.StartStaking(true) } return nil } // Stop the miner func (api *MinerAPI) Stop() bool { type threaded interface { SetThreads(threads int) } if th, ok := api.e.engine.(threaded); ok { th.SetThreads(-1) } api.e.StopStaking() return true } // SetExtra sets the extra data string that is included when this miner mines a block. func (api *MinerAPI) SetExtra(extra string) (bool, error) { if err := api.e.Miner().SetExtra([]byte(extra)); err != nil { return false, err } return true, nil } // SetGasPrice sets the minimum accepted gas price for the miner. func (api *MinerAPI) SetGasPrice(gasPrice hexutil.Big) bool { api.e.lock.Lock() api.e.gasPrice = (*big.Int)(&gasPrice) api.e.lock.Unlock() api.e.txPool.SetGasPrice((*big.Int)(&gasPrice)) return true } // SetEtherbase sets the etherbase of the miner func (api *MinerAPI) SetEtherbase(etherbase common.Address) bool { log.Info("[MinerAPI] SetEtherbase", "addr", etherbase) api.e.SetEtherbase(etherbase) return true } // GetHashrate returns the current hashrate of the miner. func (api *MinerAPI) GetHashrate() uint64 { return uint64(api.e.miner.HashRate()) } // AdminAPI is the collection of Ethereum full node related APIs for node // administration. type AdminAPI struct { eth *Ethereum } // NewAdminAPI creates a new instance of AdminAPI. func NewAdminAPI(eth *Ethereum) *AdminAPI { return &AdminAPI{eth: eth} } // ExportChain exports the current blockchain into a local file. func (api *AdminAPI) ExportChain(file string) (bool, error) { // Make sure we can create the file to export into out, err := os.OpenFile(file, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, os.ModePerm) if err != nil { return false, err } defer out.Close() var writer io.Writer = out if strings.HasSuffix(file, ".gz") { writer = gzip.NewWriter(writer) defer writer.(*gzip.Writer).Close() } // Export the blockchain if err := api.eth.BlockChain().Export(writer); err != nil { return false, err } return true, nil } func hasAllBlocks(chain *core.BlockChain, bs []*types.Block) bool { for _, b := range bs { if !chain.HasBlock(b.Hash(), b.NumberU64()) { return false } } return true } // ImportChain imports a blockchain from a local file. func (api *AdminAPI) ImportChain(file string) (bool, error) { // Make sure the can access the file to import in, err := os.Open(file) if err != nil { return false, err } defer in.Close() var reader io.Reader = in if strings.HasSuffix(file, ".gz") { if reader, err = gzip.NewReader(reader); err != nil { return false, err } } // Run actual the import in pre-configured batches stream := rlp.NewStream(reader, 0) blocks, index := make([]*types.Block, 0, 2500), 0 for batch := 0; ; batch++ { // Load a batch of blocks from the input file for len(blocks) < cap(blocks) { block := new(types.Block) if err := stream.Decode(block); err == io.EOF { break } else if err != nil { return false, fmt.Errorf("block %d: failed to parse: %v", index, err) } blocks = append(blocks, block) index++ } if len(blocks) == 0 { break } if hasAllBlocks(api.eth.BlockChain(), blocks) { blocks = blocks[:0] continue } // Import the batch and reset the buffer if _, err := api.eth.BlockChain().InsertChain(blocks); err != nil { return false, fmt.Errorf("batch %d: failed to insert: %v", batch, err) } blocks = blocks[:0] } return true, nil } // DumpBlock retrieves the entire state of the database at a given block. func (api *DebugAPI) DumpBlock(blockNr rpc.BlockNumber) (state.Dump, error) { if blockNr == rpc.PendingBlockNumber { blockNr = rpc.LatestBlockNumber } var block *types.Block if blockNr == rpc.LatestBlockNumber { block = api.eth.blockchain.CurrentBlock() } else { block = api.eth.blockchain.GetBlockByNumber(uint64(blockNr)) } if block == nil { return state.Dump{}, fmt.Errorf("block #%d not found", blockNr) } stateDb, err := api.eth.BlockChain().StateAt(block.Root()) if err != nil { return state.Dump{}, err } return stateDb.RawDump(), nil } // DebugAPI is the collection of Ethereum full node APIs exposed over // the private debugging endpoint. type DebugAPI struct { config *params.ChainConfig eth *Ethereum } // NewDebugAPI creates a new API definition for the full node-related // private debug methods of the Ethereum service. func NewDebugAPI(config *params.ChainConfig, eth *Ethereum) *DebugAPI { return &DebugAPI{config: config, eth: eth} } // Preimage is a debug API function that returns the preimage for a sha3 hash, if known. func (api *DebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) { if preimage := rawdb.ReadPreimage(api.eth.ChainDb(), hash); preimage != nil { return preimage, nil } return nil, errors.New("unknown preimage") } // 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 (api *DebugAPI) GetBadBlocks(ctx context.Context) ([]core.BadBlockArgs, error) { return api.eth.BlockChain().BadBlocks() } // StorageRangeResult is the result of a debug_storageRangeAt API call. type StorageRangeResult struct { Storage storageMap `json:"storage"` NextKey *common.Hash `json:"nextKey"` // nil if Storage includes the last key in the trie. } type storageMap map[common.Hash]storageEntry type storageEntry struct { Key *common.Hash `json:"key"` Value common.Hash `json:"value"` } // StorageRangeAt returns the storage at the given block height and transaction index. func (api *DebugAPI) StorageRangeAt(ctx context.Context, blockHash common.Hash, txIndex int, contractAddress common.Address, keyStart hexutil.Bytes, maxResult int) (StorageRangeResult, error) { _, _, statedb, err := api.computeTxEnv(blockHash, txIndex, 0) if err != nil { return StorageRangeResult{}, err } st := statedb.StorageTrie(contractAddress) if st == nil { return StorageRangeResult{}, fmt.Errorf("account %x doesn't exist", contractAddress) } return storageRangeAt(st, keyStart, maxResult) } func storageRangeAt(st state.Trie, start []byte, maxResult int) (StorageRangeResult, error) { it := trie.NewIterator(st.NodeIterator(start)) result := StorageRangeResult{Storage: storageMap{}} for i := 0; i < maxResult && it.Next(); i++ { _, content, _, err := rlp.Split(it.Value) if err != nil { return StorageRangeResult{}, err } e := storageEntry{Value: common.BytesToHash(content)} if preimage := st.GetKey(it.Key); preimage != nil { preimage := common.BytesToHash(preimage) e.Key = &preimage } result.Storage[common.BytesToHash(it.Key)] = e } // Add the 'next key' so clients can continue downloading. if it.Next() { next := common.BytesToHash(it.Key) result.NextKey = &next } return result, nil } // GetModifiedAccountsByumber 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 (api *DebugAPI) GetModifiedAccountsByNumber(startNum uint64, endNum *uint64) ([]common.Address, error) { var startBlock, endBlock *types.Block startBlock = api.eth.blockchain.GetBlockByNumber(startNum) if startBlock == nil { return nil, fmt.Errorf("start block %x not found", startNum) } if endNum == nil { endBlock = startBlock startBlock = api.eth.blockchain.GetBlockByHash(startBlock.ParentHash()) if startBlock == nil { return nil, fmt.Errorf("block %x has no parent", endBlock.Number()) } } else { endBlock = api.eth.blockchain.GetBlockByNumber(*endNum) if endBlock == nil { return nil, fmt.Errorf("end block %d not found", *endNum) } } return api.getModifiedAccounts(startBlock, endBlock) } // 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 (api *DebugAPI) GetModifiedAccountsByHash(startHash common.Hash, endHash *common.Hash) ([]common.Address, error) { var startBlock, endBlock *types.Block startBlock = api.eth.blockchain.GetBlockByHash(startHash) if startBlock == nil { return nil, fmt.Errorf("start block %x not found", startHash) } if endHash == nil { endBlock = startBlock startBlock = api.eth.blockchain.GetBlockByHash(startBlock.ParentHash()) if startBlock == nil { return nil, fmt.Errorf("block %x has no parent", endBlock.Number()) } } else { endBlock = api.eth.blockchain.GetBlockByHash(*endHash) if endBlock == nil { return nil, fmt.Errorf("end block %x not found", *endHash) } } return api.getModifiedAccounts(startBlock, endBlock) } func (api *DebugAPI) getModifiedAccounts(startBlock, endBlock *types.Block) ([]common.Address, error) { if startBlock.Number().Uint64() >= endBlock.Number().Uint64() { return nil, fmt.Errorf("start block height (%d) must be less than end block height (%d)", startBlock.Number().Uint64(), endBlock.Number().Uint64()) } triedb := api.eth.BlockChain().StateCache().TrieDB() oldTrie, err := trie.NewSecure(startBlock.Root(), triedb) if err != nil { return nil, err } newTrie, err := trie.NewSecure(endBlock.Root(), triedb) if err != nil { return nil, err } diff, _ := trie.NewDifferenceIterator(oldTrie.NodeIterator([]byte{}), newTrie.NodeIterator([]byte{})) iter := trie.NewIterator(diff) var dirty []common.Address for iter.Next() { key := newTrie.GetKey(iter.Key) if key == nil { return nil, fmt.Errorf("no preimage found for hash %x", iter.Key) } dirty = append(dirty, common.BytesToAddress(key)) } return dirty, nil } func (api *EthereumAPI) ChainId() hexutil.Uint64 { chainID := new(big.Int) if config := api.e.chainConfig; config.IsEIP155(api.e.blockchain.CurrentBlock().Number()) { chainID = config.ChainId } return (hexutil.Uint64)(chainID.Uint64()) } // GetOwner return masternode owner of the given coinbase address func (api *EthereumAPI) GetOwnerByCoinbase(ctx context.Context, coinbase common.Address, blockNr rpc.BlockNumber) (common.Address, error) { statedb, _, err := api.e.ApiBackend.StateAndHeaderByNumber(ctx, blockNr) if err != nil { return common.Address{}, err } return statedb.GetOwner(coinbase), nil }