101 lines
4.8 KiB
Protocol Buffer
101 lines
4.8 KiB
Protocol Buffer
syntax = "proto3";
|
|
package container;
|
|
option go_package = "github.com/nspcc-dev/neofs-proto/container";
|
|
|
|
import "service/meta.proto";
|
|
import "service/verify.proto";
|
|
import "container/types.proto";
|
|
import "github.com/nspcc-dev/netmap/selector.proto";
|
|
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
|
|
|
|
option (gogoproto.stable_marshaler_all) = true;
|
|
|
|
// Container service provides API for manipulating with the container.
|
|
service Service {
|
|
// Put request proposes container to the inner ring nodes. They will
|
|
// accept new container if user has enough deposit. All containers
|
|
// are accepted by the consensus, therefore it is asynchronous process.
|
|
rpc Put(PutRequest) returns (PutResponse);
|
|
|
|
// Delete container removes it from the inner ring container storage. It
|
|
// also asynchronous process done by consensus.
|
|
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
|
|
|
// Get container returns container instance
|
|
rpc Get(GetRequest) returns (GetResponse);
|
|
|
|
// List returns all user's containers
|
|
rpc List(ListRequest) returns (ListResponse);
|
|
}
|
|
|
|
message PutRequest {
|
|
// MessageID is a nonce for uniq container id calculation
|
|
bytes MessageID = 1 [(gogoproto.customtype) = "MessageID", (gogoproto.nullable) = false];
|
|
|
|
// Capacity defines amount of data that can be stored in the container (doesn't used for now).
|
|
uint64 Capacity = 2;
|
|
|
|
// OwnerID is a wallet address
|
|
bytes OwnerID = 3 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
|
|
|
// Rules define storage policy for the object inside the container.
|
|
netmap.PlacementRule rules = 4 [(gogoproto.nullable) = false];
|
|
|
|
// Container ACL.
|
|
AccessGroup Group = 5 [(gogoproto.nullable) = false];
|
|
|
|
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
|
|
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
|
|
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
}
|
|
|
|
message PutResponse {
|
|
// CID (container id) is a SHA256 hash of the container structure
|
|
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
|
}
|
|
|
|
message DeleteRequest {
|
|
// CID (container id) is a SHA256 hash of the container structure
|
|
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
|
|
|
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
|
|
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
|
|
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
}
|
|
|
|
// DeleteResponse is empty because delete operation is asynchronous and done
|
|
// via consensus in inner ring nodes
|
|
message DeleteResponse { }
|
|
|
|
|
|
message GetRequest {
|
|
// CID (container id) is a SHA256 hash of the container structure
|
|
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
|
|
|
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
|
|
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
|
|
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
}
|
|
|
|
message GetResponse {
|
|
// Container is a structure that contains placement rules and owner id
|
|
container.Container Container = 1;
|
|
}
|
|
|
|
message ListRequest {
|
|
// OwnerID is a wallet address
|
|
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
|
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
|
|
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
|
|
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
|
|
}
|
|
|
|
message ListResponse {
|
|
// CID (container id) is list of SHA256 hashes of the container structures
|
|
repeated bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
|
}
|