path: root/dex/api.go

// 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 <http://www.gnu.org/licenses/>.

package dex

import (
    "compress/gzip"
    "context"
    "errors"
    "fmt"
    "io"
    "os"
    "strings"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/common/hexutil"
    "github.com/dexon-foundation/dexon/core"
    "github.com/dexon-foundation/dexon/core/rawdb"
    "github.com/dexon-foundation/dexon/core/state"
    "github.com/dexon-foundation/dexon/core/types"
    "github.com/dexon-foundation/dexon/internal/ethapi"
    "github.com/dexon-foundation/dexon/params"
    "github.com/dexon-foundation/dexon/rlp"
    "github.com/dexon-foundation/dexon/rpc"
    "github.com/dexon-foundation/dexon/trie"
)

// PrivateAdminAPI is the collection of Ethereum full node-related APIs
// exposed over the private admin endpoint.
type PrivateAdminAPI struct {
    dex *Dexon
}

// NewPrivateAdminAPI creates a new API definition for the full node private
// admin methods of the Ethereum service.
func NewPrivateAdminAPI(dex *Dexon) *PrivateAdminAPI {
    return &PrivateAdminAPI{dex: dex}
}

// ExportChain exports the current blockchain into a local file.
func (api *PrivateAdminAPI) 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.dex.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 *PrivateAdminAPI) 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.dex.BlockChain(), blocks) {
            blocks = blocks[:0]
            continue
        }
        // Import the batch and reset the buffer
        if _, err := api.dex.BlockChain().InsertChain(blocks); err != nil {
            return false, fmt.Errorf("batch %d: failed to insert: %v", batch, err)
        }
        blocks = blocks[:0]
    }
    return true, nil
}

func (api *PrivateAdminAPI) IsCoreSyncing() bool {
    return api.dex.IsCoreSyncing()
}

func (api *PrivateAdminAPI) IsProposing() bool {
    return api.dex.IsProposing()
}

// PublicDebugAPI is the collection of Ethereum full node APIs exposed
// over the public debugging endpoint.
type PublicDebugAPI struct {
    dex *Dexon
}

// NewPublicDebugAPI creates a new API definition for the full node-
// related public debug methods of the Ethereum service.
func NewPublicDebugAPI(dex *Dexon) *PublicDebugAPI {
    return &PublicDebugAPI{dex: dex}
}

// DumpBlock retrieves the entire state of the database at a given block.
func (api *PublicDebugAPI) DumpBlock(blockNr rpc.BlockNumber) (state.Dump, error) {
    var block *types.Block
    if blockNr == rpc.LatestBlockNumber {
        block = api.dex.blockchain.CurrentBlock()
    } else {
        block = api.dex.blockchain.GetBlockByNumber(uint64(blockNr))
    }
    if block == nil {
        return state.Dump{}, fmt.Errorf("block #%d not found", blockNr)
    }
    stateDb, err := api.dex.BlockChain().StateAt(block.Root())
    if err != nil {
        return state.Dump{}, err
    }
    return stateDb.RawDump(), nil
}

// PrivateDebugAPI is the collection of Ethereum full node APIs exposed over
// the private debugging endpoint.
type PrivateDebugAPI struct {
    config *params.ChainConfig
    dex    *Dexon
}

// NewPrivateDebugAPI creates a new API definition for the full node-related
// private debug methods of the Ethereum service.
func NewPrivateDebugAPI(config *params.ChainConfig, dex *Dexon) *PrivateDebugAPI {
    return &PrivateDebugAPI{config: config, dex: dex}
}

// Preimage is a debug API function that returns the preimage for a sha3 hash, if known.
func (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
    if preimage := rawdb.ReadPreimage(api.dex.ChainDb(), hash); preimage != nil {
        return preimage, nil
    }
    return nil, errors.New("unknown preimage")
}

// BadBlockArgs represents the entries in the list returned when bad blocks are queried.
type BadBlockArgs struct {
    Hash  common.Hash            `json:"hash"`
    Block map[string]interface{} `json:"block"`
    RLP   string                 `json:"rlp"`
}

// 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 *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]*BadBlockArgs, error) {
    blocks := api.dex.BlockChain().BadBlocks()
    results := make([]*BadBlockArgs, len(blocks))

    var err error
    for i, block := range blocks {
        results[i] = &BadBlockArgs{
            Hash: block.Hash(),
        }
        if rlpBytes, err := rlp.EncodeToBytes(block); err != nil {
            results[i].RLP = err.Error() // Hacky, but hey, it works
        } else {
            results[i].RLP = fmt.Sprintf("0x%x", rlpBytes)
        }
        if results[i].Block, err = ethapi.RPCMarshalBlock(block, true, true); err != nil {
            results[i].Block = map[string]interface{}{"error": err.Error()}
        }
    }
    return results, nil
}

// 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 *PrivateDebugAPI) 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
}

// 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 (api *PrivateDebugAPI) GetModifiedAccountsByNumber(startNum uint64, endNum *uint64) ([]common.Address, error) {
    var startBlock, endBlock *types.Block

    startBlock = api.dex.blockchain.GetBlockByNumber(startNum)
    if startBlock == nil {
        return nil, fmt.Errorf("start block %x not found", startNum)
    }

    if endNum == nil {
        endBlock = startBlock
        startBlock = api.dex.blockchain.GetBlockByHash(startBlock.ParentHash())
        if startBlock == nil {
            return nil, fmt.Errorf("block %x has no parent", endBlock.Number())
        }
    } else {
        endBlock = api.dex.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 *PrivateDebugAPI) GetModifiedAccountsByHash(startHash common.Hash, endHash *common.Hash) ([]common.Address, error) {
    var startBlock, endBlock *types.Block
    startBlock = api.dex.blockchain.GetBlockByHash(startHash)
    if startBlock == nil {
        return nil, fmt.Errorf("start block %x not found", startHash)
    }

    if endHash == nil {
        endBlock = startBlock
        startBlock = api.dex.blockchain.GetBlockByHash(startBlock.ParentHash())
        if startBlock == nil {
            return nil, fmt.Errorf("block %x has no parent", endBlock.Number())
        }
    } else {
        endBlock = api.dex.blockchain.GetBlockByHash(*endHash)
        if endBlock == nil {
            return nil, fmt.Errorf("end block %x not found", *endHash)
        }
    }
    return api.getModifiedAccounts(startBlock, endBlock)
}

func (api *PrivateDebugAPI) 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())
    }

    oldTrie, err := trie.NewSecure(startBlock.Root(), trie.NewDatabase(api.dex.chainDb), 0)
    if err != nil {
        return nil, err
    }
    newTrie, err := trie.NewSecure(endBlock.Root(), trie.NewDatabase(api.dex.chainDb), 0)
    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
}