-
Notifications
You must be signed in to change notification settings - Fork 38
/
constructor.go
390 lines (337 loc) · 10.2 KB
/
constructor.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
package client
import (
"context"
"errors"
"fmt"
"sync"
"time"
lru "github.com/hashicorp/golang-lru/v2"
"github.com/nspcc-dev/neo-go/pkg/core/block"
"github.com/nspcc-dev/neo-go/pkg/core/state"
"github.com/nspcc-dev/neo-go/pkg/core/transaction"
"github.com/nspcc-dev/neo-go/pkg/crypto/keys"
"github.com/nspcc-dev/neo-go/pkg/neorpc/result"
"github.com/nspcc-dev/neo-go/pkg/rpcclient"
"github.com/nspcc-dev/neo-go/pkg/rpcclient/actor"
"github.com/nspcc-dev/neo-go/pkg/util"
"github.com/nspcc-dev/neo-go/pkg/wallet"
"go.uber.org/zap"
)
// Option is a client configuration change function.
type Option func(*cfg)
// Callback is a function that is going to be called
// on certain Client's state.
type Callback func()
// groups the configurations with default values.
type cfg struct {
ctx context.Context // neo-go client context
dialTimeout time.Duration // client dial timeout
logger *zap.Logger // logging component
waitInterval time.Duration
autoSidechainScope bool
signer *transaction.Signer
endpoints []string
singleCli *rpcclient.WSClient // neo-go client for single client mode
inactiveModeCb Callback
rpcSwitchCb Callback
minRequiredHeight uint32
reconnectionRetries int
reconnectionDelay time.Duration
}
const (
defaultDialTimeout = 5 * time.Second
defaultWaitInterval = 500 * time.Millisecond
)
func defaultConfig() *cfg {
return &cfg{
ctx: context.Background(),
dialTimeout: defaultDialTimeout,
logger: zap.L(),
waitInterval: defaultWaitInterval,
signer: &transaction.Signer{
Scopes: transaction.CalledByEntry,
},
reconnectionDelay: 5 * time.Second,
reconnectionRetries: 5,
}
}
// ErrStaleNodes is returned from [New] when minimal required height
// requirement specified in [WithMinRequiredBlockHeight] is not
// satisfied by the given nodes.
var ErrStaleNodes = errors.New("RPC nodes are not yet up to date")
// New creates, initializes and returns the Client instance.
// Notary support should be enabled with EnableNotarySupport client
// method separately.
//
// If private key is nil, it panics.
//
// Other values are set according to provided options, or by default:
// - client context: Background;
// - dial timeout: 5s;
// - blockchain network type: netmode.PrivNet;
// - signer with the CalledByEntry scope;
// - wait interval: 500ms;
// - logger: &zap.Logger{Logger: zap.L()}.
//
// If desired option satisfies the default value, it can be omitted.
// If multiple options of the same config value are supplied,
// the option with the highest index in the arguments will be used.
func New(key *keys.PrivateKey, opts ...Option) (*Client, error) {
if key == nil {
panic("empty private key")
}
acc := wallet.NewAccountFromPrivateKey(key)
accAddr := key.GetScriptHash()
// build default configuration
cfg := defaultConfig()
// apply options
for _, opt := range opts {
opt(cfg)
}
cli := &Client{
cache: newClientCache(),
logger: cfg.logger,
acc: acc,
accAddr: accAddr,
cfg: *cfg,
switchLock: &sync.RWMutex{},
closeChan: make(chan struct{}),
subs: subscriptions{
notifyChan: make(chan *state.ContainedNotificationEvent),
blockChan: make(chan *block.Block),
notaryChan: make(chan *result.NotaryRequestEvent),
subscribedEvents: make(map[util.Uint160]struct{}),
subscribedNotaryEvents: make(map[util.Uint160]struct{}),
subscribedToNewBlocks: false,
curNotifyChan: make(chan *state.ContainedNotificationEvent),
curBlockChan: make(chan *block.Block),
curNotaryChan: make(chan *result.NotaryRequestEvent),
},
}
var err error
var act *actor.Actor
if cfg.singleCli != nil {
// return client in single RPC node mode that uses
// predefined WS client
//
// in case of the closing web socket connection:
// if extra endpoints were provided via options,
// they will be used in switch process, otherwise
// inactive mode will be enabled
cli.client = cfg.singleCli
if cfg.autoSidechainScope {
err = autoSidechainScope(cfg.singleCli, cfg)
if err != nil {
return nil, fmt.Errorf("scope setup: %w", err)
}
}
act, err = newActor(cfg.singleCli, acc, *cfg)
if err != nil {
return nil, fmt.Errorf("could not create RPC actor: %w", err)
}
} else {
if len(cfg.endpoints) == 0 {
return nil, errors.New("no endpoints were provided")
}
cli.endpoints = cfg.endpoints
cli.client, act, err = cli.newCli(cli.endpoints[0])
if err != nil {
return nil, fmt.Errorf("could not create RPC client: %w", err)
}
}
cli.setActor(act)
for attempt := 0; attempt < cfg.reconnectionRetries; attempt++ {
err = cli.reachedHeight(cfg.minRequiredHeight)
if !errors.Is(err, ErrStaleNodes) {
break
}
if !cli.switchRPC() {
return nil, fmt.Errorf("%w: could not switch to the next node", err)
}
}
if err != nil {
return nil, err
}
go cli.routeNotifications()
go cli.closeWaiter()
return cli, nil
}
func (c *Client) newCli(endpoint string) (*rpcclient.WSClient, *actor.Actor, error) {
cli, err := rpcclient.NewWS(c.cfg.ctx, endpoint, rpcclient.WSOptions{
Options: rpcclient.Options{
DialTimeout: c.cfg.dialTimeout,
},
})
if err != nil {
return nil, nil, fmt.Errorf("WS client creation: %w", err)
}
defer func() {
if err != nil {
cli.Close()
}
}()
err = cli.Init()
if err != nil {
return nil, nil, fmt.Errorf("WS client initialization: %w", err)
}
if c.cfg.autoSidechainScope {
err = autoSidechainScope(cli, &c.cfg)
if err != nil {
return nil, nil, fmt.Errorf("scope setup: %w", err)
}
}
act, err := newActor(cli, c.acc, c.cfg)
if err != nil {
return nil, nil, fmt.Errorf("RPC actor creation: %w", err)
}
return cli, act, nil
}
func newActor(ws *rpcclient.WSClient, acc *wallet.Account, cfg cfg) (*actor.Actor, error) {
return actor.New(ws, []actor.SignerAccount{{
Signer: transaction.Signer{
Account: acc.ScriptHash(),
Scopes: cfg.signer.Scopes,
AllowedContracts: cfg.signer.AllowedContracts,
AllowedGroups: cfg.signer.AllowedGroups,
Rules: cfg.signer.Rules,
},
Account: acc,
}})
}
func newClientCache() cache {
c, _ := lru.New[util.Uint256, uint32](100) // returns error only if size is negative
return cache{
m: &sync.RWMutex{},
txHeights: c,
}
}
// WithContext returns a client constructor option that
// specifies the neo-go client context.
//
// Ignores nil value. Has no effect if WithSingleClient
// is provided.
//
// If option not provided, context.Background() is used.
func WithContext(ctx context.Context) Option {
return func(c *cfg) {
if ctx != nil {
c.ctx = ctx
}
}
}
// WithDialTimeout returns a client constructor option
// that specifies neo-go client dial timeout duration.
//
// Ignores non-positive value. Has no effect if WithSingleClient
// is provided.
//
// If option not provided, 5s timeout is used.
func WithDialTimeout(dur time.Duration) Option {
return func(c *cfg) {
if dur > 0 {
c.dialTimeout = dur
}
}
}
// WithLogger returns a client constructor option
// that specifies the component for writing log messages.
//
// Ignores nil value.
//
// If option not provided, &zap.Logger{Logger: zap.L()} is used.
func WithLogger(logger *zap.Logger) Option {
return func(c *cfg) {
if logger != nil {
c.logger = logger
}
}
}
// WithEndpoints returns a client constructor option
// that specifies Neo rpc endpoints.
//
// Has no effect if WithSingleClient is provided.
func WithEndpoints(endpoints []string) Option {
return func(c *cfg) {
c.endpoints = append(c.endpoints, endpoints...)
}
}
// WithSingleClient returns a client constructor option
// that specifies single neo-go client and forces Client
// to use it for requests.
//
// Passed client must already be initialized.
func WithSingleClient(cli *rpcclient.WSClient) Option {
return func(c *cfg) {
c.singleCli = cli
}
}
// WithReconnectionRetries returns a client constructor option
// that specifies number of reconnection attempts (through the full list
// provided via [WithEndpoints]) before RPC connection is considered
// lost. Non-positive values make no retries.
func WithReconnectionRetries(r int) Option {
return func(c *cfg) {
c.reconnectionRetries = r
}
}
// WithReconnectionsDelay returns a client constructor option
// that specifies delays b/w reconnections.
func WithReconnectionsDelay(d time.Duration) Option {
return func(c *cfg) {
c.reconnectionDelay = d
}
}
// WithConnLostCallback return a client constructor option
// that specifies a callback that is called when Client
// unsuccessfully tried to connect to all the specified
// endpoints.
func WithConnLostCallback(cb Callback) Option {
return func(c *cfg) {
c.inactiveModeCb = cb
}
}
// WithConnSwitchCallback returns a client constructor option
// that specifies a callback that is called when the Client
// reconnected to a new RPC (from [WithEndpoints] list)
// successfully.
func WithConnSwitchCallback(cb Callback) Option {
return func(c *cfg) {
c.rpcSwitchCb = cb
}
}
// WithMinRequiredBlockHeight returns a client constructor
// option that specifies a minimal chain height that is
// considered as acceptable. [New] returns [ErrStaleNodes]
// if the height could not been reached.
func WithMinRequiredBlockHeight(h uint32) Option {
return func(c *cfg) {
c.minRequiredHeight = h
}
}
// WithAutoSidechainScope returns a client constructor
// option that sets automatic transaction scope detection to
// true which overrides the default CalledByEntry to a set of
// Rules made specifically for the sidechain.
func WithAutoSidechainScope() Option {
return func(c *cfg) {
c.autoSidechainScope = true
}
}
// reachedHeight checks if [Client] has least expected block height and
// returns error if it is not reached that height.
// This function is required to avoid connections to unsynced RPC nodes, because
// they can produce events from the past that should not be processed by
// NeoFS nodes.
func (c *Client) reachedHeight(startFrom uint32) error {
if startFrom == 0 {
return nil
}
height, err := c.BlockCount()
if err != nil {
return fmt.Errorf("could not get block height: %w", err)
}
if height < startFrom+1 {
return fmt.Errorf("%w: expected %d height, got %d count", ErrStaleNodes, startFrom, height)
}
return nil
}