forked from TrueCloudLab/frostfs-node
44 lines
1.1 KiB
Go
44 lines
1.1 KiB
Go
|
package wrapper
|
||
|
|
|
||
|
|
import (
|
||
|
|
"errors"
|
||
|
|
|
||
|
|
"github.com/nspcc-dev/neofs-node/pkg/morph/client/netmap"
|
||
|
|
)
|
||
|
|
|
||
|
|
// Client represents the Netmap contract client.
|
||
|
|
//
|
||
|
|
// It is a type alias of
|
||
|
|
// github.com/nspcc-dev/neofs-node/pkg/morph/client/netmap.Client.
|
||
|
|
type Client = netmap.Client
|
||
|
|
|
||
|
|
// Wrapper is a wrapper over netmap contract
|
||
|
|
// client which implements:
|
||
|
|
// * network map storage;
|
||
|
|
// * tool for peer state updating.
|
||
|
|
//
|
||
|
|
// Working wrapper must be created via constructor New.
|
||
|
|
// Using the Wrapper that has been created with new(Wrapper)
|
||
|
|
// expression (or just declaring a Wrapper variable) is unsafe
|
||
|
|
// and can lead to panic.
|
||
|
|
type Wrapper struct {
|
||
|
|
client *Client
|
||
|
|
}
|
||
|
|
|
||
|
|
// ErrNilWrapper is returned by functions that expect
|
||
|
|
// a non-nil Wrapper pointer, but received nil.
|
||
|
|
var ErrNilWrapper = errors.New("netmap contract client wrapper is nil")
|
||
|
|
|
||
|
|
// New creates, initializes and returns the Wrapper instance.
|
||
|
|
//
|
||
|
|
// If Client is nil, netmap.ErrNilClient is returned.
|
||
|
|
func New(c *Client) (*Wrapper, error) {
|
||
|
|
if c == nil {
|
||
|
|
return nil, netmap.ErrNilClient
|
||
|
|
}
|
||
|
|
|
||
|
|
return &Wrapper{
|
||
|
|
client: c,
|
||
|
|
}, nil
|
||
|
|
}
|