-
Notifications
You must be signed in to change notification settings - Fork 22
/
snapshot.go
227 lines (194 loc) · 5.32 KB
/
snapshot.go
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
// Copyright (c) 2022 Gobalsky Labs Limited
//
// Use of this software is governed by the Business Source License included
// in the LICENSE.VEGA file and at https://www.mariadb.com/bsl11.
//
// Change Date: 18 months from the later of the date of the first publicly
// available Distribution of this version of the repository, and 25 June 2022.
//
// On the date above, in accordance with the Business Source License, use
// of this software will be governed by version 3 or later of the GNU General
// Public License.
package notary
import (
"context"
"encoding/hex"
"sort"
"strings"
"code.vegaprotocol.io/vega/core/types"
"code.vegaprotocol.io/vega/logging"
v1 "code.vegaprotocol.io/vega/protos/vega/commands/v1"
"code.vegaprotocol.io/vega/libs/proto"
)
var (
allKey = (&types.PayloadNotary{}).Key()
hashKeys = []string{
allKey,
}
)
// NewWithSnapshot returns an "extended" Notary type which contains the ability to take engine snapshots.
func NewWithSnapshot(
log *logging.Logger,
cfg Config,
top ValidatorTopology,
broker Broker,
cmd Commander,
) *SnapshotNotary {
log = log.Named(namedLogger)
return &SnapshotNotary{
Notary: New(log, cfg, top, broker, cmd),
}
}
type SnapshotNotary struct {
*Notary
// snapshot bits
serialised []byte
}
// StartAggregate is a wrapper to Notary's StartAggregate which also manages the snapshot state.
func (n *SnapshotNotary) StartAggregate(
resource string,
kind v1.NodeSignatureKind,
signature []byte,
) {
n.Notary.StartAggregate(resource, kind, signature)
}
// RegisterSignature is a wrapper to Notary's RegisterSignature which also manages the snapshot state.
func (n *SnapshotNotary) RegisterSignature(
ctx context.Context,
pubKey string,
ns v1.NodeSignature,
) error {
err := n.Notary.RegisterSignature(ctx, pubKey, ns)
return err
}
// get the serialised form of the given key.
func (n *SnapshotNotary) serialise(k string) ([]byte, error) {
if k != allKey {
return nil, types.ErrSnapshotKeyDoesNotExist
}
data, err := n.serialiseNotary()
if err != nil {
return nil, err
}
n.serialised = data
return data, nil
}
func (n *SnapshotNotary) Namespace() types.SnapshotNamespace {
return types.NotarySnapshot
}
func (n *SnapshotNotary) Keys() []string {
return hashKeys
}
func (n *SnapshotNotary) Stopped() bool {
return false
}
func (n *SnapshotNotary) GetState(k string) ([]byte, []types.StateProvider, error) {
data, err := n.serialise(k)
return data, nil, err
}
func (n *SnapshotNotary) LoadState(ctx context.Context, payload *types.Payload) ([]types.StateProvider, error) {
if n.Namespace() != payload.Data.Namespace() {
return nil, types.ErrInvalidSnapshotNamespace
}
switch pl := payload.Data.(type) {
case *types.PayloadNotary:
return nil, n.restoreNotary(pl.Notary, payload)
default:
return nil, types.ErrUnknownSnapshotType
}
}
func (n *SnapshotNotary) OfferSignatures(
kind types.NodeSignatureKind,
// a callback taking a list of resource that a signature is required
// for, returning a map of signature for given resources
f func(resource string) []byte,
) {
for k, v := range n.retries.txs {
if k.kind != kind {
continue
}
if signature := f(k.id); signature != nil {
v.signature = signature
}
}
}
// serialiseLimits returns the engine's limit data as marshalled bytes.
func (n *SnapshotNotary) serialiseNotary() ([]byte, error) {
sigs := make([]*types.NotarySigs, 0, len(n.sigs)) // it will likely be longer than this but we don't know yet
for ik, ns := range n.sigs {
for n := range ns {
sigs = append(sigs,
&types.NotarySigs{
ID: ik.id,
Kind: int32(ik.kind),
Node: n.node,
Sig: hex.EncodeToString([]byte(n.sig)),
},
)
}
// the case where aggregate has started but we have no node sigs
if len(ns) == 0 {
sigs = append(sigs, &types.NotarySigs{ID: ik.id, Kind: int32(ik.kind)})
}
}
sort.SliceStable(sigs, func(i, j int) bool {
// sigs could be "" so we need to sort on ID as well
switch strings.Compare(sigs[i].ID, sigs[j].ID) {
case -1:
return true
case 1:
return false
}
return sigs[i].Sig < sigs[j].Sig
})
pl := types.Payload{
Data: &types.PayloadNotary{
Notary: &types.Notary{
Sigs: sigs,
},
},
}
return proto.Marshal(pl.IntoProto())
}
func (n *SnapshotNotary) restoreNotary(notary *types.Notary, p *types.Payload) error {
var (
sigs = map[idKind]map[nodeSig]struct{}{}
retries = &txTracker{
txs: map[idKind]*signatureTime{},
}
isValidator = n.Notary.top.IsValidator()
selfSigned = map[idKind]bool{}
self = n.Notary.top.SelfVegaPubKey()
)
for _, s := range notary.Sigs {
idK := idKind{id: s.ID, kind: v1.NodeSignatureKind(s.Kind)}
sig, err := hex.DecodeString(s.Sig)
if err != nil {
n.log.Panic("invalid signature from snapshot", logging.Error(err))
}
ns := nodeSig{node: s.Node, sig: string(sig)}
if isValidator {
signed := selfSigned[idK]
if !signed {
selfSigned[idK] = strings.EqualFold(s.Node, self)
}
}
if _, ok := sigs[idK]; !ok {
sigs[idK] = map[nodeSig]struct{}{}
}
if len(ns.node) != 0 && len(ns.sig) != 0 {
sigs[idK][ns] = struct{}{}
}
}
for resource, ok := range selfSigned {
if !ok {
// this is not signed, just add it to the retries list
retries.Add(resource, nil)
}
}
n.sigs = sigs
n.retries = retries
var err error
n.serialised, err = proto.Marshal(p.IntoProto())
return err
}