github.com/yinchengtsinghua/golang-Eos-dpos-Ethereum@v0.0.0-20190121132951-92cc4225ed8e/internal/ethapi/backend.go (about)

     1  
     2  //此源码被清华学神尹成大魔王专业翻译分析并修改
     3  //尹成QQ77025077
     4  //尹成微信18510341407
     5  //尹成所在QQ群721929980
     6  //尹成邮箱 yinc13@mails.tsinghua.edu.cn
     7  //尹成毕业于清华大学,微软区块链领域全球最有价值专家
     8  //https://mvp.microsoft.com/zh-cn/PublicProfile/4033620
     9  //版权所有2015 Go Ethereum作者
    10  //此文件是Go以太坊库的一部分。
    11  //
    12  //Go-Ethereum库是免费软件：您可以重新分发它和/或修改
    13  //根据GNU发布的较低通用公共许可证的条款
    14  //自由软件基金会，或者许可证的第3版，或者
    15  //（由您选择）任何更高版本。
    16  //
    17  //Go以太坊图书馆的发行目的是希望它会有用，
    18  //但没有任何保证；甚至没有
    19  //适销性或特定用途的适用性。见
    20  //GNU较低的通用公共许可证，了解更多详细信息。
    21  //
    22  //你应该收到一份GNU较低级别的公共许可证副本
    23  //以及Go以太坊图书馆。如果没有，请参见<http://www.gnu.org/licenses/>。
    24  
    25  //包ethapi实现一般的以太坊API功能。
    26  package ethapi
    27  
    28  import (
    29  	"context"
    30  	"math/big"
    31  
    32  	"github.com/ethereum/go-ethereum/accounts"
    33  	"github.com/ethereum/go-ethereum/common"
    34  	"github.com/ethereum/go-ethereum/core"
    35  	"github.com/ethereum/go-ethereum/core/state"
    36  	"github.com/ethereum/go-ethereum/core/types"
    37  	"github.com/ethereum/go-ethereum/core/vm"
    38  	"github.com/ethereum/go-ethereum/eth/downloader"
    39  	"github.com/ethereum/go-ethereum/ethdb"
    40  	"github.com/ethereum/go-ethereum/event"
    41  	"github.com/ethereum/go-ethereum/params"
    42  	"github.com/ethereum/go-ethereum/rpc"
    43  )
    44  
    45  //后端接口提供公共API服务（由
    46  //全功能和轻功能客户机）。
    47  type Backend interface {
    48  //通用以太坊API
    49  	Downloader() *downloader.Downloader
    50  	ProtocolVersion() int
    51  	SuggestPrice(ctx context.Context) (*big.Int, error)
    52  	ChainDb() ethdb.Database
    53  	EventMux() *event.TypeMux
    54  	AccountManager() *accounts.Manager
    55  
    56  //块链API
    57  	SetHead(number uint64)
    58  	HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Header, error)
    59  	BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
    60  	StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*state.StateDB, *types.Header, error)
    61  	GetBlock(ctx context.Context, blockHash common.Hash) (*types.Block, error)
    62  	GetReceipts(ctx context.Context, blockHash common.Hash) (types.Receipts, error)
    63  	GetTd(blockHash common.Hash) *big.Int
    64  	GetEVM(ctx context.Context, msg core.Message, state *state.StateDB, header *types.Header, vmCfg vm.Config) (*vm.EVM, func() error, error)
    65  	SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
    66  	SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
    67  //subscribeChainsideEvent（ch chan<-core.chainsideEvent）事件。订阅
    68  
    69  //TXPL API
    70  	SendTx(ctx context.Context, signedTx *types.Transaction) error
    71  	GetPoolTransactions() (types.Transactions, error)
    72  	GetPoolTransaction(txHash common.Hash) *types.Transaction
    73  	GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
    74  	Stats() (pending int, queued int)
    75  	TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
    76  	SubscribeNewTxsEvent(chan<- core.NewTxsEvent) event.Subscription
    77  
    78  	ChainConfig() *params.ChainConfig
    79  	CurrentBlock() *types.Block
    80  }
    81  
    82  func GetAPIs(apiBackend Backend) []rpc.API {
    83  	nonceLock := new(AddrLocker)
    84  	return []rpc.API{
    85  		{
    86  			Namespace: "eth",
    87  			Version:   "1.0",
    88  			Service:   NewPublicEthereumAPI(apiBackend),
    89  			Public:    true,
    90  		}, {
    91  			Namespace: "eth",
    92  			Version:   "1.0",
    93  			Service:   NewPublicBlockChainAPI(apiBackend),
    94  			Public:    true,
    95  		}, {
    96  			Namespace: "eth",
    97  			Version:   "1.0",
    98  			Service:   NewPublicTransactionPoolAPI(apiBackend, nonceLock),
    99  			Public:    true,
   100  		}, {
   101  			Namespace: "txpool",
   102  			Version:   "1.0",
   103  			Service:   NewPublicTxPoolAPI(apiBackend),
   104  			Public:    true,
   105  		}, {
   106  			Namespace: "debug",
   107  			Version:   "1.0",
   108  			Service:   NewPublicDebugAPI(apiBackend),
   109  			Public:    true,
   110  		}, {
   111  			Namespace: "debug",
   112  			Version:   "1.0",
   113  			Service:   NewPrivateDebugAPI(apiBackend),
   114  		}, {
   115  			Namespace: "eth",
   116  			Version:   "1.0",
   117  			Service:   NewPublicAccountAPI(apiBackend.AccountManager()),
   118  			Public:    true,
   119  		}, {
   120  			Namespace: "personal",
   121  			Version:   "1.0",
   122  			Service:   NewPrivateAccountAPI(apiBackend, nonceLock),
   123  			Public:    false,
   124  		},
   125  	}
   126  }