package client import ( "context" "errors" "fmt" "sync" "time" lru "github.com/hashicorp/golang-lru" "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/rpc/client" "github.com/nspcc-dev/neo-go/pkg/util" "github.com/nspcc-dev/neo-go/pkg/wallet" "github.com/nspcc-dev/neofs-node/pkg/util/logger" "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 *logger.Logger // logging component waitInterval time.Duration signer *transaction.Signer endpoints []Endpoint singleCli *client.WSClient // neo-go client for single client mode inactiveModeCb Callback } 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.Global, }, } } // 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 global scope; // * wait interval: 500ms; // * 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") } // build default configuration cfg := defaultConfig() // apply options for _, opt := range opts { opt(cfg) } if len(cfg.endpoints) == 0 { return nil, errors.New("no endpoints were provided") } cli := &Client{ cache: newClientCache(), logger: cfg.logger, acc: wallet.NewAccountFromPrivateKey(key), signer: cfg.signer, cfg: *cfg, switchLock: &sync.RWMutex{}, notifications: make(chan client.Notification), subscribedEvents: make(map[util.Uint160]string), subscribedNotaryEvents: make(map[util.Uint160]string), closeChan: make(chan struct{}), } 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 } else { ws, err := newWSClient(*cfg, cfg.endpoints[0].Address) if err != nil { return nil, fmt.Errorf("could not create morph client: %w", err) } err = ws.Init() if err != nil { return nil, fmt.Errorf("could not init morph client: %w", err) } cli.client = ws } cli.endpoints.init(cfg.endpoints) go cli.notificationLoop() return cli, nil } func newWSClient(cfg cfg, endpoint string) (*client.WSClient, error) { return client.NewWS( cfg.ctx, endpoint, client.Options{DialTimeout: cfg.dialTimeout}, ) } func newClientCache() cache { c, _ := lru.New(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.L() is used. func WithLogger(logger *logger.Logger) Option { return func(c *cfg) { if logger != nil { c.logger = logger } } } // WithSigner returns a client constructor option // that specifies the signer and the scope of the transaction. // // Ignores nil value. // // If option not provided, signer with global scope is used. func WithSigner(signer *transaction.Signer) Option { return func(c *cfg) { if signer != nil { c.signer = signer } } } // WithEndpoints returns a client constructor option // that specifies additional Neo rpc endpoints. func WithEndpoints(endpoints ...Endpoint) 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 *client.WSClient) Option { return func(c *cfg) { c.singleCli = cli } } // 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 } }