aboutsummaryrefslogtreecommitdiffstats
path: root/consensus/clique/api.go
blob: 6bcf987af55eb983a1dad6c6f9da8909eea7054b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
// 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 (
    "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.ChainReader
    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)
}