123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207 |
- // Copyright 2017 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 clique
- import (
- "errors"
- "fmt"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/consensus"
- "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/rpc"
- )
- // API is a user facing RPC API to allow controlling the signer and voting
- // mechanisms of the proof-of-authority scheme.
- type API struct {
- chain consensus.ChainHeaderReader
- clique *Clique
- }
- // GetSnapshot retrieves the state snapshot at a given block.
- func (api *API) GetSnapshot(number *rpc.BlockNumber) (*Snapshot, error) {
- // Retrieve the requested block number (or current if none requested)
- var header *types.Header
- if number == nil || *number == rpc.LatestBlockNumber {
- header = api.chain.CurrentHeader()
- } else {
- header = api.chain.GetHeaderByNumber(uint64(number.Int64()))
- }
- // Ensure we have an actually valid block and return its snapshot
- if header == nil {
- return nil, errUnknownBlock
- }
- return api.clique.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
- }
- // GetSnapshotAtHash retrieves the state snapshot at a given block.
- func (api *API) GetSnapshotAtHash(hash common.Hash) (*Snapshot, error) {
- header := api.chain.GetHeaderByHash(hash)
- if header == nil {
- return nil, errUnknownBlock
- }
- return api.clique.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
- }
- // GetSigners retrieves the list of authorized signers at the specified block.
- func (api *API) GetSigners(number *rpc.BlockNumber) ([]common.Address, error) {
- // Retrieve the requested block number (or current if none requested)
- var header *types.Header
- if number == nil || *number == rpc.LatestBlockNumber {
- header = api.chain.CurrentHeader()
- } else {
- header = api.chain.GetHeaderByNumber(uint64(number.Int64()))
- }
- // Ensure we have an actually valid block and return the signers from its snapshot
- if header == nil {
- return nil, errUnknownBlock
- }
- snap, err := api.clique.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
- if err != nil {
- return nil, err
- }
- return snap.signers(), nil
- }
- // GetSignersAtHash retrieves the list of authorized signers at the specified block.
- func (api *API) GetSignersAtHash(hash common.Hash) ([]common.Address, error) {
- header := api.chain.GetHeaderByHash(hash)
- if header == nil {
- return nil, errUnknownBlock
- }
- snap, err := api.clique.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
- if err != nil {
- return nil, err
- }
- return snap.signers(), nil
- }
- // Proposals returns the current proposals the node tries to uphold and vote on.
- func (api *API) Proposals() map[common.Address]bool {
- api.clique.lock.RLock()
- defer api.clique.lock.RUnlock()
- proposals := make(map[common.Address]bool)
- for address, auth := range api.clique.proposals {
- proposals[address] = auth
- }
- return proposals
- }
- // Propose injects a new authorization proposal that the signer will attempt to
- // push through.
- func (api *API) Propose(address common.Address, auth bool) {
- api.clique.lock.Lock()
- defer api.clique.lock.Unlock()
- api.clique.proposals[address] = auth
- }
- // Discard drops a currently running proposal, stopping the signer from casting
- // further votes (either for or against).
- func (api *API) Discard(address common.Address) {
- api.clique.lock.Lock()
- defer api.clique.lock.Unlock()
- delete(api.clique.proposals, address)
- }
- type Status struct {
- InturnPercent float64 `json:"inturnPercent"`
- SigningStatus map[common.Address]int `json:"sealerActivity"`
- NumBlocks uint64 `json:"numBlocks"`
- }
- // Status returns the status of the last N blocks,
- // - the number of active signers,
- // - the number of signers,
- // - the percentage of in-turn blocks
- func (api *API) Status(startBlockNum *rpc.BlockNumber, endBlockNum *rpc.BlockNumber) (*Status, error) {
- var (
- numBlocks uint64
- header *types.Header
- diff = uint64(0)
- optimals = 0
- start uint64
- end uint64
- )
- if startBlockNum != nil && endBlockNum == nil {
- return nil, errors.New("pass the end block number")
- }
- if startBlockNum == nil && endBlockNum != nil {
- return nil, errors.New("pass the start block number")
- }
- if startBlockNum == nil && endBlockNum == nil {
- numBlocks = uint64(64)
- header = api.chain.CurrentHeader()
- end = header.Number.Uint64()
- start = end - numBlocks
- } else {
- end = uint64(*endBlockNum)
- start = uint64(*startBlockNum)
- if start > end {
- return nil, errors.New("start block number should be less than end block number")
- }
- if end > api.chain.CurrentHeader().Number.Uint64() {
- return nil, errors.New("end block number should be less than or equal to current block height")
- }
- numBlocks = end - start
- header = api.chain.GetHeaderByNumber(end)
- }
- snap, err := api.clique.snapshot(api.chain, end, header.Hash(), nil)
- if err != nil {
- return nil, err
- }
- var (
- signers = snap.signers()
- )
- if numBlocks > end {
- start = 1
- numBlocks = end - start
- }
- signStatus := make(map[common.Address]int)
- for _, s := range signers {
- signStatus[s] = 0
- }
- for n := start; n < end; n++ {
- h := api.chain.GetHeaderByNumber(n)
- if h == nil {
- return nil, fmt.Errorf("missing block %d", n)
- }
- if h.Difficulty.Cmp(diffInTurn) == 0 {
- optimals++
- }
- diff += h.Difficulty.Uint64()
- sealer, err := api.clique.Author(h)
- if err != nil {
- return nil, err
- }
- signStatus[sealer]++
- }
- return &Status{
- InturnPercent: float64(100*optimals) / float64(numBlocks),
- SigningStatus: signStatus,
- NumBlocks: numBlocks,
- }, nil
- }
|