github.com/theQRL/go-zond@v0.1.1/zond/api.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 zond
    18  
    19  import (
    20  	"github.com/theQRL/go-zond/common"
    21  	"github.com/theQRL/go-zond/common/hexutil"
    22  )
    23  
    24  // EthereumAPI provides an API to access Ethereum full node-related information.
    25  type EthereumAPI struct {
    26  	e *Ethereum
    27  }
    28  
    29  // NewEthereumAPI creates a new Ethereum protocol API for full nodes.
    30  func NewEthereumAPI(e *Ethereum) *EthereumAPI {
    31  	return &EthereumAPI{e}
    32  }
    33  
    34  // Etherbase is the address that mining rewards will be sent to.
    35  func (api *EthereumAPI) Etherbase() (common.Address, error) {
    36  	return api.e.Etherbase()
    37  }
    38  
    39  // Coinbase is the address that mining rewards will be sent to (alias for Etherbase).
    40  func (api *EthereumAPI) Coinbase() (common.Address, error) {
    41  	return api.Etherbase()
    42  }
    43  
    44  // Hashrate returns the POW hashrate.
    45  func (api *EthereumAPI) Hashrate() hexutil.Uint64 {
    46  	return hexutil.Uint64(api.e.Miner().Hashrate())
    47  }
    48  
    49  // Mining returns an indication if this node is currently mining.
    50  func (api *EthereumAPI) Mining() bool {
    51  	return api.e.IsMining()
    52  }