-
Notifications
You must be signed in to change notification settings - Fork 107
/
seed.go
457 lines (378 loc) · 14.5 KB
/
seed.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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
package seed
import (
"context"
"fmt"
"path/filepath"
"strings"
"sync"
"time"
flag "github.com/spf13/pflag"
"github.com/spf13/viper"
"github.com/tendermint/tendermint/config"
"github.com/tendermint/tendermint/p2p"
"github.com/tendermint/tendermint/p2p/pex"
"github.com/tendermint/tendermint/types"
tmversion "github.com/tendermint/tendermint/version"
beacon "github.com/oasisprotocol/oasis-core/go/beacon/api"
"github.com/oasisprotocol/oasis-core/go/common/crypto/signature"
"github.com/oasisprotocol/oasis-core/go/common/identity"
"github.com/oasisprotocol/oasis-core/go/common/logging"
"github.com/oasisprotocol/oasis-core/go/common/node"
"github.com/oasisprotocol/oasis-core/go/common/pubsub"
"github.com/oasisprotocol/oasis-core/go/common/version"
consensus "github.com/oasisprotocol/oasis-core/go/consensus/api"
"github.com/oasisprotocol/oasis-core/go/consensus/api/transaction"
"github.com/oasisprotocol/oasis-core/go/consensus/tendermint/api"
tmcommon "github.com/oasisprotocol/oasis-core/go/consensus/tendermint/common"
"github.com/oasisprotocol/oasis-core/go/consensus/tendermint/crypto"
genesis "github.com/oasisprotocol/oasis-core/go/genesis/api"
governance "github.com/oasisprotocol/oasis-core/go/governance/api"
keymanager "github.com/oasisprotocol/oasis-core/go/keymanager/api"
cmflags "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common/flags"
registry "github.com/oasisprotocol/oasis-core/go/registry/api"
roothash "github.com/oasisprotocol/oasis-core/go/roothash/api"
scheduler "github.com/oasisprotocol/oasis-core/go/scheduler/api"
staking "github.com/oasisprotocol/oasis-core/go/staking/api"
"github.com/oasisprotocol/oasis-core/go/storage/mkvs/checkpoint"
"github.com/oasisprotocol/oasis-core/go/storage/mkvs/syncer"
)
const (
// This should ideally be dynamically configured internally by tendermint:
// https://github.com/tendermint/tendermint/issues/3523
// This is set to the same value as in tendermint.
tendermintSeedDisconnectWaitPeriod = 28 * time.Hour
// CfgDebugDisableAddrBookFromGenesis disables populating seed node address book from genesis.
// This flag is used to disable initial addr book population from genesis in some E2E tests to
// test the seed node functionality.
CfgDebugDisableAddrBookFromGenesis = "consensus.tendermint.seed.debug.disable_addr_book_from_genesis"
)
// Flags has the configuration flags.
var Flags = flag.NewFlagSet("", flag.ContinueOnError)
type seedService struct {
identity *identity.Identity
doc *genesis.Document
addr *p2p.NetAddress
transport *p2p.MultiplexTransport
addrBook pex.AddrBook
p2pSwitch *p2p.Switch
stopOnce sync.Once
quitCh chan struct{}
}
// Name returns the service name.
func (srv *seedService) Name() string {
return "tendermint/seed"
}
// Start starts the service.
func (srv *seedService) Start() error {
if err := srv.transport.Listen(*srv.addr); err != nil {
return fmt.Errorf("tendermint/seed: failed to listen on transport: %w", err)
}
// Start switch.
if err := srv.p2pSwitch.Start(); err != nil {
return fmt.Errorf("tendermint/seed: failed to start P2P switch: %w", err)
}
return nil
}
// Stop halts the service.
func (srv *seedService) Stop() {
srv.stopOnce.Do(func() {
close(srv.quitCh)
// Save the address book.
if srv.addrBook != nil {
srv.addrBook.Save()
}
// Stop the switch.
if srv.p2pSwitch != nil {
_ = srv.p2pSwitch.Stop()
srv.p2pSwitch.Wait()
}
})
}
// Quit returns a channel that will be closed when the service terminates.
func (srv *seedService) Quit() <-chan struct{} {
return srv.quitCh
}
// Cleanup performs the service specific post-termination cleanup.
func (srv *seedService) Cleanup() {
// No cleanup in particular.
}
// Implements Backend.
func (srv *seedService) Synced() <-chan struct{} {
// Seed is always considered synced.
ch := make(chan struct{})
close(ch)
return ch
}
// Implements Backend.
func (srv *seedService) SupportedFeatures() consensus.FeatureMask {
return consensus.FeatureMask(0)
}
// Implements Backend.
func (srv *seedService) GetStatus(ctx context.Context) (*consensus.Status, error) {
status := &consensus.Status{
Version: version.ConsensusProtocol,
Backend: api.BackendName,
Features: srv.SupportedFeatures(),
}
// List of consensus peers.
tmpeers := srv.p2pSwitch.Peers().List()
peers := make([]string, 0, len(tmpeers))
for _, tmpeer := range tmpeers {
p := string(tmpeer.ID()) + "@" + tmpeer.RemoteAddr().String()
peers = append(peers, p)
}
status.NodePeers = peers
return status, nil
}
// Implements Backend.
func (srv *seedService) GetNextBlockState(ctx context.Context) (*consensus.NextBlockState, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetGenesisDocument(ctx context.Context) (*genesis.Document, error) {
return srv.doc, nil
}
// Implements Backend.
func (srv *seedService) GetChainContext(ctx context.Context) (string, error) {
return srv.doc.ChainContext(), nil
}
// Implements Backend.
func (srv *seedService) GetAddresses() ([]node.ConsensusAddress, error) {
u, err := tmcommon.GetExternalAddress()
if err != nil {
return nil, err
}
var addr node.ConsensusAddress
if err = addr.Address.UnmarshalText([]byte(u.Host)); err != nil {
return nil, fmt.Errorf("tendermint: failed to parse external address host: %w", err)
}
addr.ID = srv.identity.P2PSigner.Public()
return []node.ConsensusAddress{addr}, nil
}
// Implements Backend.
func (srv *seedService) Checkpointer() checkpoint.Checkpointer {
return nil
}
// Implements Backend.
func (srv *seedService) SubmitEvidence(ctx context.Context, evidence *consensus.Evidence) error {
return consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) SubmitTx(ctx context.Context, tx *transaction.SignedTransaction) error {
return consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) StateToGenesis(ctx context.Context, height int64) (*genesis.Document, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) EstimateGas(ctx context.Context, req *consensus.EstimateGasRequest) (transaction.Gas, error) {
return 0, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetBlock(ctx context.Context, height int64) (*consensus.Block, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetTransactions(ctx context.Context, height int64) ([][]byte, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetTransactionsWithResults(ctx context.Context, height int64) (*consensus.TransactionsWithResults, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetUnconfirmedTransactions(ctx context.Context) ([][]byte, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) WatchBlocks(ctx context.Context) (<-chan *consensus.Block, pubsub.ClosableSubscription, error) {
return nil, nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetSignerNonce(ctx context.Context, req *consensus.GetSignerNonceRequest) (uint64, error) {
return 0, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetLightBlock(ctx context.Context, height int64) (*consensus.LightBlock, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) GetParameters(ctx context.Context, height int64) (*consensus.Parameters, error) {
return nil, consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) State() syncer.ReadSyncer {
return syncer.NopReadSyncer
}
// Implements Backend.
func (srv *seedService) ConsensusKey() signature.PublicKey {
return srv.identity.ConsensusSigner.Public()
}
// Implements Backend.
func (srv *seedService) SubmitTxNoWait(ctx context.Context, tx *transaction.SignedTransaction) error {
return consensus.ErrUnsupported
}
// Implements Backend.
func (srv *seedService) RegisterHaltHook(consensus.HaltHook) {
panic(consensus.ErrUnsupported)
}
// Note: SupportedFeatures() indicates that the backend does not support
// consensus services so the caller is at fault for not adhering to the
// SupportedFeatures flag, in case any of the following methods is called.
// Implements Backend.
func (srv *seedService) Beacon() beacon.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) KeyManager() keymanager.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) Registry() registry.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) RootHash() roothash.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) Staking() staking.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) Scheduler() scheduler.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) Governance() governance.Backend {
panic(consensus.ErrUnsupported)
}
// Implements Backend.
func (srv *seedService) SubmissionManager() consensus.SubmissionManager {
panic(consensus.ErrUnsupported)
}
// New creates a new seed-only consensus service.
func New(dataDir string, identity *identity.Identity, genesisProvider genesis.Provider) (consensus.Backend, error) {
var err error
// This is heavily inspired by https://gitlab.com/polychainlabs/tenderseed
// and reaches into tendermint to spin up the minimum components required
// to get the PEX reactor to operate in seed mode.
srv := &seedService{
quitCh: make(chan struct{}),
identity: identity,
}
seedDataDir := filepath.Join(dataDir, "tendermint-seed")
if err = tmcommon.InitDataDir(seedDataDir); err != nil {
return nil, fmt.Errorf("tendermint/seed: failed to initialize data dir: %w", err)
}
p2pCfg := config.DefaultP2PConfig()
p2pCfg.SeedMode = true
p2pCfg.Seeds = strings.ToLower(strings.Join(viper.GetStringSlice(tmcommon.CfgP2PSeed), ","))
p2pCfg.ExternalAddress = viper.GetString(tmcommon.CfgCoreExternalAddress)
p2pCfg.MaxNumInboundPeers = viper.GetInt(tmcommon.CfgP2PMaxNumInboundPeers)
p2pCfg.MaxNumOutboundPeers = viper.GetInt(tmcommon.CfgP2PMaxNumOutboundPeers)
p2pCfg.SendRate = viper.GetInt64(tmcommon.CfgP2PSendRate)
p2pCfg.RecvRate = viper.GetInt64(tmcommon.CfgP2PRecvRate)
p2pCfg.AddrBookStrict = !(viper.GetBool(tmcommon.CfgDebugP2PAddrBookLenient) && cmflags.DebugDontBlameOasis())
p2pCfg.AllowDuplicateIP = viper.GetBool(tmcommon.CfgDebugP2PAllowDuplicateIP) && cmflags.DebugDontBlameOasis()
nodeKey := &p2p.NodeKey{PrivKey: crypto.SignerToTendermint(identity.P2PSigner)}
doc, err := genesisProvider.GetGenesisDocument()
if err != nil {
return nil, fmt.Errorf("tendermint/seed: failed to get genesis document: %w", err)
}
srv.doc = doc
nodeInfo := p2p.DefaultNodeInfo{
ProtocolVersion: p2p.NewProtocolVersion(
tmversion.P2PProtocol,
tmversion.BlockProtocol,
version.TendermintAppVersion,
),
DefaultNodeID: nodeKey.ID(),
ListenAddr: viper.GetString(tmcommon.CfgCoreListenAddress),
Network: doc.ChainContext()[:types.MaxChainIDLen],
Version: tmversion.TMCoreSemVer,
Channels: []byte{pex.PexChannel},
Moniker: "oasis-seed-" + identity.P2PSigner.Public().String(),
}
// Carve out all of the services.
logger := tmcommon.NewLogAdapter(!viper.GetBool(tmcommon.CfgLogDebug))
if srv.addr, err = p2p.NewNetAddressString(p2p.IDAddressString(nodeInfo.DefaultNodeID, nodeInfo.ListenAddr)); err != nil {
return nil, fmt.Errorf("tendermint/seed: failed to create seed address: %w", err)
}
srv.transport = p2p.NewMultiplexTransport(nodeInfo, *nodeKey, p2p.MConnConfig(p2pCfg))
addrBookPath := filepath.Join(seedDataDir, tmcommon.ConfigDir, "addrbook.json")
srv.addrBook = pex.NewAddrBook(addrBookPath, p2pCfg.AddrBookStrict)
srv.addrBook.SetLogger(logger.With("module", "book"))
if err = srv.addrBook.Start(); err != nil {
return nil, fmt.Errorf("tendermint/seed: failed to start address book: %w", err)
}
if !(viper.GetBool(CfgDebugDisableAddrBookFromGenesis) && cmflags.DebugDontBlameOasis()) {
if err = populateAddrBookFromGenesis(srv.addrBook, doc, srv.addr); err != nil {
return nil, fmt.Errorf("tendermint/seed: failed to populate address book from genesis: %w", err)
}
}
// Use p2pCfg.Seeds since there the IDs are already lowercased.
// Use FieldsFunc so that empty string is handled correctly.
seeds := strings.FieldsFunc(
p2pCfg.Seeds,
func(c rune) bool {
return c == ','
},
)
pexReactor := pex.NewReactor(srv.addrBook, &pex.ReactorConfig{
SeedMode: p2pCfg.SeedMode,
Seeds: seeds,
SeedDisconnectWaitPeriod: tendermintSeedDisconnectWaitPeriod,
})
pexReactor.SetLogger(logger.With("module", "pex"))
srv.p2pSwitch = p2p.NewSwitch(p2pCfg, srv.transport)
srv.p2pSwitch.SetLogger(logger.With("module", "switch"))
srv.p2pSwitch.SetNodeKey(nodeKey)
srv.p2pSwitch.SetAddrBook(srv.addrBook)
srv.p2pSwitch.AddReactor("pex", pexReactor)
srv.p2pSwitch.SetNodeInfo(nodeInfo)
return srv, nil
}
func populateAddrBookFromGenesis(addrBook p2p.AddrBook, doc *genesis.Document, ourAddr *p2p.NetAddress) error {
logger := logging.GetLogger("consensus/tendermint/seed")
// Convert to a representation suitable for address book population.
var addrs []*p2p.NetAddress
for _, v := range doc.Registry.Nodes {
var openedNode node.Node
if err := v.Open(registry.RegisterGenesisNodeSignatureContext, &openedNode); err != nil {
return fmt.Errorf("tendermint/seed: failed to verify validator: %w", err)
}
// TODO: This should cross check that the entity is valid.
if !openedNode.HasRoles(node.RoleValidator) {
continue
}
var tmvAddr *p2p.NetAddress
tmvAddr, err := api.NodeToP2PAddr(&openedNode)
if err != nil {
logger.Error("failed to reformat genesis validator address",
"err", err,
)
continue
}
addrs = append(addrs, tmvAddr)
}
// Populate the address book with the genesis validators.
addrBook.AddOurAddress(ourAddr) // Required or AddrBook.AddAddress will fail.
for _, v := range addrs {
// Remove the address first as otherwise Tendermint's address book
// may not actually add the new address.
addrBook.RemoveAddress(v)
if err := addrBook.AddAddress(v, ourAddr); err != nil {
logger.Error("failed to add genesis validator to address book",
"err", err,
)
}
}
return nil
}
func init() {
Flags.Bool(CfgDebugDisableAddrBookFromGenesis, false, "disable populating address book with genesis validators")
_ = Flags.MarkHidden(CfgDebugDisableAddrBookFromGenesis)
_ = viper.BindPFlags(Flags)
}