-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
chain_set.go
298 lines (259 loc) · 7.49 KB
/
chain_set.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
package terra
import (
"context"
"database/sql"
"fmt"
"sync"
"github.com/pkg/errors"
"go.uber.org/multierr"
"github.com/smartcontractkit/chainlink-terra/pkg/terra"
"github.com/smartcontractkit/chainlink-terra/pkg/terra/db"
"github.com/smartcontractkit/sqlx"
"github.com/smartcontractkit/chainlink/core/chains/terra/types"
coreconfig "github.com/smartcontractkit/chainlink/core/config"
"github.com/smartcontractkit/chainlink/core/logger"
"github.com/smartcontractkit/chainlink/core/services/keystore"
"github.com/smartcontractkit/chainlink/core/services/pg"
"github.com/smartcontractkit/chainlink/core/utils"
)
var (
// ErrChainIDEmpty is returned when chain is required but was empty.
ErrChainIDEmpty = errors.New("chain id empty")
// ErrChainIDInvalid is returned when a chain id does not match any configured chains.
ErrChainIDInvalid = errors.New("chain id does not match any local chains")
)
// ChainSetOpts holds options for configuring a ChainSet.
type ChainSetOpts struct {
Config coreconfig.GeneralConfig
Logger logger.Logger
DB *sqlx.DB
KeyStore keystore.Terra
EventBroadcaster pg.EventBroadcaster
ORM types.ORM
}
func (o ChainSetOpts) validate() (err error) {
required := func(s string) error {
return errors.Errorf("%s is required", s)
}
if o.Config == nil {
err = multierr.Append(err, required("Config"))
}
if o.Logger == nil {
err = multierr.Append(err, required("Logger'"))
}
if o.DB == nil {
err = multierr.Append(err, required("DB"))
}
if o.KeyStore == nil {
err = multierr.Append(err, required("KeyStore"))
}
if o.EventBroadcaster == nil {
err = multierr.Append(err, required("EventBroadcaster"))
}
if o.ORM == nil {
err = multierr.Append(err, required("ORM"))
}
return
}
func (o ChainSetOpts) newChain(dbchain types.Chain) (*chain, error) {
if !dbchain.Enabled {
return nil, errors.Errorf("cannot create new chain with ID %s, the chain is disabled", dbchain.ID)
}
return NewChain(o.DB, o.KeyStore, o.Config, o.EventBroadcaster, dbchain, o.ORM, o.Logger)
}
// ChainSet extends terra.ChainSet with mutability and exposes the underlying ORM.
type ChainSet interface {
terra.ChainSet
Add(context.Context, string, db.ChainCfg) (types.Chain, error)
Remove(string) error
Configure(ctx context.Context, id string, enabled bool, config db.ChainCfg) (types.Chain, error)
ORM() types.ORM
}
//go:generate mockery --name ChainSet --srcpkg github.com/smartcontractkit/chainlink-terra/pkg/terra --output ./mocks/ --case=underscore
var _ ChainSet = (*chainSet)(nil)
type chainSet struct {
utils.StartStopOnce
opts ChainSetOpts
chainsMu sync.RWMutex
chains map[string]*chain
lggr logger.Logger
}
// NewChainSet returns a new chain set for opts.
func NewChainSet(opts ChainSetOpts) (*chainSet, error) {
if err := opts.validate(); err != nil {
return nil, err
}
dbchains, err := opts.ORM.EnabledChains()
if err != nil {
return nil, errors.Wrap(err, "error loading chains")
}
cs := chainSet{
opts: opts,
chains: make(map[string]*chain),
lggr: opts.Logger.Named("ChainSet"),
}
for _, dbc := range dbchains {
var err2 error
cs.chains[dbc.ID], err2 = opts.newChain(dbc)
if err2 != nil {
err = multierr.Combine(err, err2)
continue
}
}
return &cs, err
}
func (c *chainSet) ORM() types.ORM {
return c.opts.ORM
}
func (c *chainSet) Chain(ctx context.Context, id string) (terra.Chain, error) {
if id == "" {
return nil, ErrChainIDEmpty
}
if err := c.StartStopOnce.Ready(); err != nil {
return nil, err
}
c.chainsMu.RLock()
ch := c.chains[id]
c.chainsMu.RUnlock()
if ch != nil {
// Already known/started
return ch, nil
}
// Unknown/unstarted
c.chainsMu.Lock()
defer c.chainsMu.Unlock()
// Double check now that we have the lock, so we don't start an orphan.
if err := c.StartStopOnce.Ready(); err != nil {
return nil, err
}
ch = c.chains[id]
if ch != nil {
// Someone else beat us to it
return ch, nil
}
// Do we have nodes/config?
opts := c.opts
dbchain, err := opts.ORM.Chain(id)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, ErrChainIDInvalid
}
return nil, err
}
err = c.initializeChain(ctx, &dbchain)
if err != nil {
return nil, err
}
return c.chains[id], nil
}
func (c *chainSet) Add(ctx context.Context, id string, config db.ChainCfg) (types.Chain, error) {
c.chainsMu.Lock()
defer c.chainsMu.Unlock()
if _, exists := c.chains[id]; exists {
return types.Chain{}, errors.Errorf("chain already exists with id %s", id)
}
dbchain, err := c.opts.ORM.CreateChain(id, config)
if err != nil {
return types.Chain{}, err
}
return dbchain, c.initializeChain(ctx, &dbchain)
}
// Requires a lock on chainsMu
func (c *chainSet) initializeChain(ctx context.Context, dbchain *types.Chain) error {
// Start it
cid := dbchain.ID
chain, err := c.opts.newChain(*dbchain)
if err != nil {
return errors.Wrapf(err, "initializeChain: failed to instantiate chain %s", dbchain.ID)
}
if err = chain.Start(ctx); err != nil {
return errors.Wrapf(err, "initializeChain: failed to start chain %s", dbchain.ID)
}
c.chains[cid] = chain
return nil
}
func (c *chainSet) Remove(id string) error {
c.chainsMu.Lock()
defer c.chainsMu.Unlock()
if err := c.opts.ORM.DeleteChain(id); err != nil {
return err
}
chain, exists := c.chains[id]
if !exists {
// If a chain was removed from the DB that wasn't loaded into the memory set we're done.
return nil
}
delete(c.chains, id)
return chain.Close()
}
func (c *chainSet) Configure(ctx context.Context, id string, enabled bool, config db.ChainCfg) (types.Chain, error) {
c.chainsMu.Lock()
defer c.chainsMu.Unlock()
// Update configuration stored in the database
dbchain, err := c.opts.ORM.UpdateChain(id, enabled, config)
if err != nil {
return types.Chain{}, err
}
chain, exists := c.chains[id]
switch {
case exists && !enabled:
// Chain was toggled to disabled
delete(c.chains, id)
return types.Chain{}, chain.Close()
case !exists && enabled:
// Chain was toggled to enabled
return dbchain, c.initializeChain(ctx, &dbchain)
case exists:
// Exists in memory, no toggling: Update in-memory chain
chain.UpdateConfig(config)
}
return dbchain, nil
}
// Start starts terra ChainSet.
func (c *chainSet) Start(ctx context.Context) error {
//TODO if terra disabled, warn and return?
return c.StartOnce("ChainSet", func() error {
c.lggr.Debug("Starting")
c.chainsMu.Lock()
defer c.chainsMu.Unlock()
var started int
for _, ch := range c.chains {
if err := ch.Start(ctx); err != nil {
c.lggr.Errorw(fmt.Sprintf("Chain with ID %s failed to start. You will need to fix this issue and restart the Chainlink node before any services that use this chain will work properly. Got error: %v", ch.ID(), err), "err", err)
continue
}
started++
}
c.lggr.Info(fmt.Sprintf("Started %d/%d chains", started, len(c.chains)))
return nil
})
}
func (c *chainSet) Close() error {
return c.StopOnce("ChainSet", func() (err error) {
c.lggr.Debug("Stopping")
c.chainsMu.Lock()
defer c.chainsMu.Unlock()
for _, c := range c.chains {
err = multierr.Combine(err, c.Close())
}
return
})
}
func (c *chainSet) Ready() (err error) {
err = c.StartStopOnce.Ready()
c.chainsMu.RLock()
defer c.chainsMu.RUnlock()
for _, c := range c.chains {
err = multierr.Combine(err, c.Ready())
}
return
}
func (c *chainSet) Healthy() (err error) {
err = c.StartStopOnce.Healthy()
c.chainsMu.RLock()
defer c.chainsMu.RUnlock()
for _, c := range c.chains {
err = multierr.Combine(err, c.Healthy())
}
return
}