Add Inner Ring code

pkg/morph/client/container/client.go

@@ -0,0 +1,174 @@
+package container
+
+import (
+	"errors"
+
+	"github.com/nspcc-dev/neofs-node/pkg/morph/client"
+)
+
+// Client is a wrapper over StaticClient
+// which makes calls with the names and arguments
+// of the NeoFS Container contract.
+//
+// Working client must be created via constructor New.
+// Using the Client that has been created with new(Client)
+// expression (or just declaring a Client variable) is unsafe
+// and can lead to panic.
+type Client struct {
+	client *client.StaticClient // static Container contract client
+
+	*cfg // contract method names
+}
+
+// ErrNilClient is returned by functions that expect
+// a non-nil Client pointer, but received nil.
+var ErrNilClient = errors.New("container contract client is nil")
+
+// Option is a client configuration change function.
+type Option func(*cfg)
+
+type cfg struct {
+	putMethod, // put container method name for invocation
+	deleteMethod, // delete container method name for invocation
+	getMethod, // get container method name for invocation
+	listMethod, // list container method name for invocation
+	setEACLMethod, // set eACL method name for invocation
+	eaclMethod string // get eACL method name for invocation
+}
+
+const (
+	defaultPutMethod     = "Put"     // default put container method name
+	defaultDeleteMethod  = "Delete"  // default delete container method name
+	defaultGetMethod     = "Get"     // default get container method name
+	defaultListMethod    = "List"    // default list containers method name
+	defaultEACLMethod    = "EACL"    // default get eACL method name
+	defaultSetEACLMethod = "SetEACL" // default set eACL method name
+)
+
+func defaultConfig() *cfg {
+	return &cfg{
+		putMethod:     defaultPutMethod,
+		deleteMethod:  defaultDeleteMethod,
+		getMethod:     defaultGetMethod,
+		listMethod:    defaultListMethod,
+		setEACLMethod: defaultSetEACLMethod,
+		eaclMethod:    defaultEACLMethod,
+	}
+}
+
+// New creates, initializes and returns the Client instance.
+//
+// If StaticClient is nil, client.ErrNilStaticClient is returned.
+//
+// Other values are set according to provided options, or by default:
+//  * put container method name: Put;
+//  * delete container method name: Delete;
+//  * get container method name: Get;
+//  * list containers method name: List;
+//  * set eACL method name: SetEACL;
+//  * get eACL method name: EACL.
+//
+// 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(c *client.StaticClient, opts ...Option) (*Client, error) {
+	if c == nil {
+		return nil, client.ErrNilStaticClient
+	}
+
+	res := &Client{
+		client: c,
+		cfg:    defaultConfig(), // build default configuration
+	}
+
+	// apply options
+	for _, opt := range opts {
+		opt(res.cfg)
+	}
+
+	return res, nil
+}
+
+// WithPutMethod returns a client constructor option that
+// specifies the method name of container storing operation.
+//
+// Ignores empty value.
+//
+// If option not provided, "Put" is used.
+func WithPutMethod(n string) Option {
+	return func(c *cfg) {
+		if n != "" {
+			c.putMethod = n
+		}
+	}
+}
+
+// WithDeleteMethod returns a client constructor option that
+// specifies the method name of container removal operation.
+//
+// Ignores empty value.
+//
+// If option not provided, "Delete" is used.
+func WithDeleteMethod(n string) Option {
+	return func(c *cfg) {
+		if n != "" {
+			c.deleteMethod = n
+		}
+	}
+}
+
+// WithGetMethod returns a client constructor option that
+// specifies the method name of container receiving operation.
+//
+// Ignores empty value.
+//
+// If option not provided, "Get" is used.
+func WithGetMethod(n string) Option {
+	return func(c *cfg) {
+		if n != "" {
+			c.getMethod = n
+		}
+	}
+}
+
+// WithListMethod returns a client constructor option that
+// specifies the method name of container listing operation.
+//
+// Ignores empty value.
+//
+// If option not provided, "List" is used.
+func WithListMethod(n string) Option {
+	return func(c *cfg) {
+		if n != "" {
+			c.listMethod = n
+		}
+	}
+}
+
+// WithSetEACLMethod returns a client constructor option that
+// specifies the method name of eACL storing operation.
+//
+// Ignores empty value.
+//
+// If option not provided, "SetEACL" is used.
+func WithSetEACLMethod(n string) Option {
+	return func(c *cfg) {
+		if n != "" {
+			c.setEACLMethod = n
+		}
+	}
+}
+
+// WithEACLMethod returns a client constructor option that
+// specifies the method name of eACL receiving operation.
+//
+// Ignores empty value.
+//
+// If option not provided, "EACL" is used.
+func WithEACLMethod(n string) Option {
+	return func(c *cfg) {
+		if n != "" {
+			c.eaclMethod = n
+		}
+	}
+}