mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-02-26 07:37:20 +00:00
consensus: remove clique RPC APIs (#31875)
This commit is contained in:
Ömer Faruk Irmak
GitHub
parent
a53fdf1fe6
commit
f21adaf245
6 changed files with 0 additions and 265 deletions
|
|
@ -30,7 +30,6 @@ import (
|
||||||
"github.com/ethereum/go-ethereum/core/types"
|
"github.com/ethereum/go-ethereum/core/types"
|
||||||
"github.com/ethereum/go-ethereum/core/vm"
|
"github.com/ethereum/go-ethereum/core/vm"
|
||||||
"github.com/ethereum/go-ethereum/params"
|
"github.com/ethereum/go-ethereum/params"
|
||||||
"github.com/ethereum/go-ethereum/rpc"
|
|
||||||
"github.com/ethereum/go-ethereum/trie"
|
"github.com/ethereum/go-ethereum/trie"
|
||||||
"github.com/holiman/uint256"
|
"github.com/holiman/uint256"
|
||||||
)
|
)
|
||||||
|
|
@ -445,11 +444,6 @@ func (beacon *Beacon) CalcDifficulty(chain consensus.ChainHeaderReader, time uin
|
||||||
return beaconDifficulty
|
return beaconDifficulty
|
||||||
}
|
}
|
||||||
|
|
||||||
// APIs implements consensus.Engine, returning the user facing RPC APIs.
|
|
||||||
func (beacon *Beacon) APIs(chain consensus.ChainHeaderReader) []rpc.API {
|
|
||||||
return beacon.ethone.APIs(chain)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close shutdowns the consensus engine
|
// Close shutdowns the consensus engine
|
||||||
func (beacon *Beacon) Close() error {
|
func (beacon *Beacon) Close() error {
|
||||||
return beacon.ethone.Close()
|
return beacon.ethone.Close()
|
||||||
|
|
|
||||||
|
|
@ -1,235 +0,0 @@
|
||||||
// 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 (
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/ethereum/go-ethereum/common"
|
|
||||||
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
||||||
"github.com/ethereum/go-ethereum/consensus"
|
|
||||||
"github.com/ethereum/go-ethereum/core/types"
|
|
||||||
"github.com/ethereum/go-ethereum/rlp"
|
|
||||||
"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() (*status, error) {
|
|
||||||
var (
|
|
||||||
numBlocks = uint64(64)
|
|
||||||
header = api.chain.CurrentHeader()
|
|
||||||
diff = uint64(0)
|
|
||||||
optimals = 0
|
|
||||||
)
|
|
||||||
snap, err := api.clique.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
var (
|
|
||||||
signers = snap.signers()
|
|
||||||
end = header.Number.Uint64()
|
|
||||||
start = end - numBlocks
|
|
||||||
)
|
|
||||||
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
|
|
||||||
}
|
|
||||||
|
|
||||||
type blockNumberOrHashOrRLP struct {
|
|
||||||
*rpc.BlockNumberOrHash
|
|
||||||
RLP hexutil.Bytes `json:"rlp,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sb *blockNumberOrHashOrRLP) UnmarshalJSON(data []byte) error {
|
|
||||||
bnOrHash := new(rpc.BlockNumberOrHash)
|
|
||||||
// Try to unmarshal bNrOrHash
|
|
||||||
if err := bnOrHash.UnmarshalJSON(data); err == nil {
|
|
||||||
sb.BlockNumberOrHash = bnOrHash
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// Try to unmarshal RLP
|
|
||||||
var input string
|
|
||||||
if err := json.Unmarshal(data, &input); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
blob, err := hexutil.Decode(input)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
sb.RLP = blob
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetSigner returns the signer for a specific clique block.
|
|
||||||
// Can be called with a block number, a block hash or a rlp encoded blob.
|
|
||||||
// The RLP encoded blob can either be a block or a header.
|
|
||||||
func (api *API) GetSigner(rlpOrBlockNr *blockNumberOrHashOrRLP) (common.Address, error) {
|
|
||||||
if len(rlpOrBlockNr.RLP) == 0 {
|
|
||||||
blockNrOrHash := rlpOrBlockNr.BlockNumberOrHash
|
|
||||||
var header *types.Header
|
|
||||||
if blockNrOrHash == nil {
|
|
||||||
header = api.chain.CurrentHeader()
|
|
||||||
} else if hash, ok := blockNrOrHash.Hash(); ok {
|
|
||||||
header = api.chain.GetHeaderByHash(hash)
|
|
||||||
} else if number, ok := blockNrOrHash.Number(); ok {
|
|
||||||
header = api.chain.GetHeaderByNumber(uint64(number.Int64()))
|
|
||||||
}
|
|
||||||
if header == nil {
|
|
||||||
return common.Address{}, fmt.Errorf("missing block %v", blockNrOrHash.String())
|
|
||||||
}
|
|
||||||
return api.clique.Author(header)
|
|
||||||
}
|
|
||||||
block := new(types.Block)
|
|
||||||
if err := rlp.DecodeBytes(rlpOrBlockNr.RLP, block); err == nil {
|
|
||||||
return api.clique.Author(block.Header())
|
|
||||||
}
|
|
||||||
header := new(types.Header)
|
|
||||||
if err := rlp.DecodeBytes(rlpOrBlockNr.RLP, header); err != nil {
|
|
||||||
return common.Address{}, err
|
|
||||||
}
|
|
||||||
return api.clique.Author(header)
|
|
||||||
}
|
|
||||||
|
|
@ -41,7 +41,6 @@ import (
|
||||||
"github.com/ethereum/go-ethereum/log"
|
"github.com/ethereum/go-ethereum/log"
|
||||||
"github.com/ethereum/go-ethereum/params"
|
"github.com/ethereum/go-ethereum/params"
|
||||||
"github.com/ethereum/go-ethereum/rlp"
|
"github.com/ethereum/go-ethereum/rlp"
|
||||||
"github.com/ethereum/go-ethereum/rpc"
|
|
||||||
"github.com/ethereum/go-ethereum/trie"
|
"github.com/ethereum/go-ethereum/trie"
|
||||||
"golang.org/x/crypto/sha3"
|
"golang.org/x/crypto/sha3"
|
||||||
)
|
)
|
||||||
|
|
@ -641,15 +640,6 @@ func (c *Clique) Close() error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// APIs implements consensus.Engine, returning the user facing RPC API to allow
|
|
||||||
// controlling the signer voting.
|
|
||||||
func (c *Clique) APIs(chain consensus.ChainHeaderReader) []rpc.API {
|
|
||||||
return []rpc.API{{
|
|
||||||
Namespace: "clique",
|
|
||||||
Service: &API{chain: chain, clique: c},
|
|
||||||
}}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SealHash returns the hash of a block prior to it being sealed.
|
// SealHash returns the hash of a block prior to it being sealed.
|
||||||
func SealHash(header *types.Header) (hash common.Hash) {
|
func SealHash(header *types.Header) (hash common.Hash) {
|
||||||
hasher := sha3.NewLegacyKeccak256()
|
hasher := sha3.NewLegacyKeccak256()
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,6 @@ import (
|
||||||
"github.com/ethereum/go-ethereum/core/types"
|
"github.com/ethereum/go-ethereum/core/types"
|
||||||
"github.com/ethereum/go-ethereum/core/vm"
|
"github.com/ethereum/go-ethereum/core/vm"
|
||||||
"github.com/ethereum/go-ethereum/params"
|
"github.com/ethereum/go-ethereum/params"
|
||||||
"github.com/ethereum/go-ethereum/rpc"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// ChainHeaderReader defines a small collection of methods needed to access the local
|
// ChainHeaderReader defines a small collection of methods needed to access the local
|
||||||
|
|
@ -109,9 +108,6 @@ type Engine interface {
|
||||||
// that a new block should have.
|
// that a new block should have.
|
||||||
CalcDifficulty(chain ChainHeaderReader, time uint64, parent *types.Header) *big.Int
|
CalcDifficulty(chain ChainHeaderReader, time uint64, parent *types.Header) *big.Int
|
||||||
|
|
||||||
// APIs returns the RPC APIs this consensus engine provides.
|
|
||||||
APIs(chain ChainHeaderReader) []rpc.API
|
|
||||||
|
|
||||||
// Close terminates any background threads maintained by the consensus engine.
|
// Close terminates any background threads maintained by the consensus engine.
|
||||||
Close() error
|
Close() error
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,6 @@ import (
|
||||||
|
|
||||||
"github.com/ethereum/go-ethereum/consensus"
|
"github.com/ethereum/go-ethereum/consensus"
|
||||||
"github.com/ethereum/go-ethereum/core/types"
|
"github.com/ethereum/go-ethereum/core/types"
|
||||||
"github.com/ethereum/go-ethereum/rpc"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Ethash is a consensus engine based on proof-of-work implementing the ethash
|
// Ethash is a consensus engine based on proof-of-work implementing the ethash
|
||||||
|
|
@ -71,12 +70,6 @@ func (ethash *Ethash) Close() error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// APIs implements consensus.Engine, returning no APIs as ethash is an empty
|
|
||||||
// shell in the post-merge world.
|
|
||||||
func (ethash *Ethash) APIs(chain consensus.ChainHeaderReader) []rpc.API {
|
|
||||||
return []rpc.API{}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Seal generates a new sealing request for the given input block and pushes
|
// Seal generates a new sealing request for the given input block and pushes
|
||||||
// the result into the given channel. For the ethash engine, this method will
|
// the result into the given channel. For the ethash engine, this method will
|
||||||
// just panic as sealing is not supported anymore.
|
// just panic as sealing is not supported anymore.
|
||||||
|
|
|
||||||
|
|
@ -337,9 +337,6 @@ func makeExtraData(extra []byte) []byte {
|
||||||
func (s *Ethereum) APIs() []rpc.API {
|
func (s *Ethereum) APIs() []rpc.API {
|
||||||
apis := ethapi.GetAPIs(s.APIBackend)
|
apis := ethapi.GetAPIs(s.APIBackend)
|
||||||
|
|
||||||
// Append any APIs exposed explicitly by the consensus engine
|
|
||||||
apis = append(apis, s.engine.APIs(s.BlockChain())...)
|
|
||||||
|
|
||||||
// Append all the local APIs and return
|
// Append all the local APIs and return
|
||||||
return append(apis, []rpc.API{
|
return append(apis, []rpc.API{
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue