github.com/theQRL/go-zond@v0.2.1/internal/zondapi/backend.go (about)

     1  // Copyright 2015 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 ethapi implements the general Zond API functions.
    18  package zondapi
    19  
    20  import (
    21  	"context"
    22  	"math/big"
    23  	"time"
    24  
    25  	"github.com/theQRL/go-zond"
    26  	"github.com/theQRL/go-zond/accounts"
    27  	"github.com/theQRL/go-zond/common"
    28  	"github.com/theQRL/go-zond/consensus"
    29  	"github.com/theQRL/go-zond/core"
    30  	"github.com/theQRL/go-zond/core/bloombits"
    31  	"github.com/theQRL/go-zond/core/state"
    32  	"github.com/theQRL/go-zond/core/types"
    33  	"github.com/theQRL/go-zond/core/vm"
    34  	"github.com/theQRL/go-zond/event"
    35  	"github.com/theQRL/go-zond/params"
    36  	"github.com/theQRL/go-zond/rpc"
    37  	"github.com/theQRL/go-zond/zonddb"
    38  )
    39  
    40  // Backend interface provides the common API services (that are provided by
    41  // full clients) with access to necessary functions.
    42  type Backend interface {
    43  	// General Zond API
    44  	SyncProgress() zond.SyncProgress
    45  
    46  	SuggestGasTipCap(ctx context.Context) (*big.Int, error)
    47  	FeeHistory(ctx context.Context, blockCount uint64, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (*big.Int, [][]*big.Int, []*big.Int, []float64, error)
    48  	ChainDb() zonddb.Database
    49  	AccountManager() *accounts.Manager
    50  	ExtRPCEnabled() bool
    51  	RPCGasCap() uint64            // global gas cap for zond_call over rpc: DoS protection
    52  	RPCZVMTimeout() time.Duration // global timeout for zond_call over rpc: DoS protection
    53  	RPCTxFeeCap() float64         // global tx fee cap for all transaction related APIs
    54  
    55  	// Blockchain API
    56  	SetHead(number uint64)
    57  	HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
    58  	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
    59  	HeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Header, error)
    60  	CurrentHeader() *types.Header
    61  	CurrentBlock() *types.Header
    62  	BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
    63  	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
    64  	BlockByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Block, error)
    65  	StateAndHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*state.StateDB, *types.Header, error)
    66  	StateAndHeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*state.StateDB, *types.Header, error)
    67  	Pending() (*types.Block, types.Receipts, *state.StateDB)
    68  	GetReceipts(ctx context.Context, hash common.Hash) (types.Receipts, error)
    69  	GetZVM(ctx context.Context, msg *core.Message, state *state.StateDB, header *types.Header, vmConfig *vm.Config, blockCtx *vm.BlockContext) *vm.ZVM
    70  	SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
    71  	SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
    72  	SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
    73  
    74  	// Transaction pool API
    75  	SendTx(ctx context.Context, signedTx *types.Transaction) error
    76  	GetTransaction(ctx context.Context, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)
    77  	GetPoolTransactions() (types.Transactions, error)
    78  	GetPoolTransaction(txHash common.Hash) *types.Transaction
    79  	GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
    80  	Stats() (pending int, queued int)
    81  	TxPoolContent() (map[common.Address][]*types.Transaction, map[common.Address][]*types.Transaction)
    82  	TxPoolContentFrom(addr common.Address) ([]*types.Transaction, []*types.Transaction)
    83  	SubscribeNewTxsEvent(chan<- core.NewTxsEvent) event.Subscription
    84  
    85  	ChainConfig() *params.ChainConfig
    86  	Engine() consensus.Engine
    87  
    88  	// This is copied from filters.Backend
    89  	// zond/filters needs to be initialized from this backend type, so methods needed by
    90  	// it must also be included here.
    91  	GetBody(ctx context.Context, hash common.Hash, number rpc.BlockNumber) (*types.Body, error)
    92  	GetLogs(ctx context.Context, blockHash common.Hash, number uint64) ([][]*types.Log, error)
    93  	SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription
    94  	SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
    95  	BloomStatus() (uint64, uint64)
    96  	ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)
    97  }
    98  
    99  func GetAPIs(apiBackend Backend) []rpc.API {
   100  	nonceLock := new(AddrLocker)
   101  	return []rpc.API{
   102  		{
   103  			Namespace: "zond",
   104  			Service:   NewZondAPI(apiBackend),
   105  		}, {
   106  			Namespace: "zond",
   107  			Service:   NewBlockChainAPI(apiBackend),
   108  		}, {
   109  			Namespace: "zond",
   110  			Service:   NewTransactionAPI(apiBackend, nonceLock),
   111  		}, {
   112  			Namespace: "txpool",
   113  			Service:   NewTxPoolAPI(apiBackend),
   114  		}, {
   115  			Namespace: "debug",
   116  			Service:   NewDebugAPI(apiBackend),
   117  		}, {
   118  			Namespace: "zond",
   119  			Service:   NewEthereumAccountAPI(apiBackend.AccountManager()),
   120  		},
   121  	}
   122  }