[#50] *: Replace NeoFS with FrostFS in doc comments

Signed-off-by: Aleksey Savchuk <a.savchuk@yadro.com>

accounting/service.proto

@@ -9,13 +9,13 @@ import "accounting/types.proto";
 import "refs/types.proto";
 import "session/types.proto";
 
-// Accounting service provides methods for interaction with NeoFS sidechain via
+// Accounting service provides methods for interaction with FrostFS sidechain
-// other NeoFS nodes to get information about the account balance. Deposit and
+// via other FrostFS nodes to get information about the account balance. Deposit
-// Withdraw operations can't be implemented here, as they require Mainnet NeoFS
+// and Withdraw operations can't be implemented here, as they require Mainnet
-// smart contract invocation. Transfer operations between internal NeoFS
+// FrostFS smart contract invocation. Transfer operations between internal
-// accounts are possible if both use the same token type.
+// FrostFS accounts are possible if both use the same token type.
 service AccountingService {
-  // Returns the amount of funds in GAS token for the requested NeoFS account.
+  // Returns the amount of funds in GAS token for the requested FrostFS account.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS):
@@ -27,9 +27,9 @@ service AccountingService {
 // BalanceRequest message
 message BalanceRequest {
   // To indicate the account for which the balance is requested, its identifier
-  // is used. It can be any existing account in NeoFS sidechain `Balance` smart
+  // is used. It can be any existing account in FrostFS sidechain `Balance`
-  // contract. If omitted, client implementation MUST set it to the request's
+  // smart contract. If omitted, client implementation MUST set it to the
-  // signer `OwnerID`.
+  // request's signer `OwnerID`.
   message Body {
     // Valid user identifier in `OwnerID` format for which the balance is
     // requested. Required field.

accounting/types.proto

@@ -5,7 +5,7 @@ package neo.fs.v2.accounting;
 option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/accounting/grpc;accounting";
 option csharp_namespace = "Neo.FileStorage.API.Accounting";
 
-// Standard floating point data type can't be used in NeoFS due to inexactness
+// Standard floating point data type can't be used in FrostFS due to inexactness
 // of the result when doing lots of small number operations. To solve the lost
 // precision issue, special `Decimal` format is used for monetary computations.
 //

acl/types.proto

@@ -89,14 +89,14 @@ enum HeaderType {
   // Filter object headers
   OBJECT = 2;
 
-  // Filter service headers. These are not processed by NeoFS nodes and
+  // Filter service headers. These are not processed by FrostFS nodes and
   // exist for service use only.
   SERVICE = 3;
 }
 
 // Describes a single eACL rule.
 message EACLRecord {
-  // NeoFS request Verb to match
+  // FrostFS request Verb to match
   Operation operation = 1 [ json_name = "operation" ];
 
   // Rule execution result. Either allows or denies access if filters match.
@@ -165,7 +165,7 @@ message EACLRecord {
 // Extended ACL rules table. A list of ACL rules defined additionally to Basic
 // ACL. Extended ACL rules can be attached to a container and can be updated
 // or may be defined in `BearerToken` structure. Please see the corresponding
-// NeoFS Technical Specification section for detailed description.
+// FrostFS Technical Specification section for detailed description.
 message EACLTable {
   // eACL format version. Effectively, the version of API library used to create
   // eACL Table.

container/service.proto

@@ -11,8 +11,8 @@ import "refs/types.proto";
 import "session/types.proto";
 
 // `ContainerService` provides API to interact with `Container` smart contract
-// in NeoFS sidechain via other NeoFS nodes. All of those actions can be done
+// in FrostFS sidechain via other FrostFS nodes. All of those actions can be
-// equivalently by directly issuing transactions and RPC calls to sidechain
+// done equivalently by directly issuing transactions and RPC calls to sidechain
 // nodes.
 service ContainerService {
   // `Put` invokes `Container` smart contract's `Put` method and returns
@@ -64,7 +64,7 @@ service ContainerService {
   rpc List(ListRequest) returns (ListResponse);
 }
 
-// New NeoFS Container creation request
+// New FrostFS Container creation request
 message PutRequest {
   // Container creation request has container structure's signature as a
   // separate field. It's not stored in sidechain, just verified on container
@@ -72,7 +72,7 @@ message PutRequest {
   // the stable-marshalled container strucutre, hence there is no need for
   // additional signature checks.
   message Body {
-    // Container structure to register in NeoFS
+    // Container structure to register in FrostFS
     container.Container container = 1;
 
     // Signature of a stable-marshalled container according to RFC-6979.
@@ -91,7 +91,7 @@ message PutRequest {
   neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
 }
 
-// New NeoFS Container creation response
+// New FrostFS Container creation response
 message PutResponse {
   // Container put response body contains information about the newly registered
   // container as seen by `Container` smart contract. `ContainerID` can be
@@ -120,7 +120,7 @@ message DeleteRequest {
   // the container owner's intent. The signature will be verified by `Container`
   // smart contract, so signing algorithm must be supported by NeoVM.
   message Body {
-    // Identifier of the container to delete from NeoFS
+    // Identifier of the container to delete from FrostFS
     neo.fs.v2.refs.ContainerID container_id = 1;
 
     // `ContainerID` signed with the container owner's key according to

container/types.proto

@@ -50,7 +50,7 @@ message Container {
   //   (`__NEOFS__DISABLE_HOMOMORPHIC_HASHING` is deprecated) \
   //   Disables homomorphic hashing for the container if the value equals "true"
   //   string. Any other values are interpreted as missing attribute. Container
-  //   could be accepted in a NeoFS network only if the global network hashing
+  //   could be accepted in a FrostFS network only if the global network hashing
   //   configuration value corresponds with that attribute's value. After
   //   container inclusion, network setting is ignored.
   //

netmap/service.proto

@@ -12,7 +12,7 @@ import "session/types.proto";
 // `NetmapService` provides methods to work with `Network Map` and the
 // information required to build it. The resulting `Network Map` is stored in
 // sidechain `Netmap` smart contract, while related information can be obtained
-// from other NeoFS nodes.
+// from other FrostFS nodes.
 service NetmapService {
   // Get NodeInfo structure from the particular node directly.
   // Node information can be taken from `Netmap` smart contract. In some cases,
@@ -27,7 +27,7 @@ service NetmapService {
   // - Common failures (SECTION_FAILURE_COMMON).
   rpc LocalNodeInfo(LocalNodeInfoRequest) returns (LocalNodeInfoResponse);
 
-  // Read recent information about the NeoFS network.
+  // Read recent information about the FrostFS network.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS):
@@ -35,7 +35,7 @@ service NetmapService {
   // - Common failures (SECTION_FAILURE_COMMON).
   rpc NetworkInfo(NetworkInfoRequest) returns (NetworkInfoResponse);
 
-  // Returns network map snapshot of the current NeoFS epoch.
+  // Returns network map snapshot of the current FrostFS epoch.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS):
@@ -65,7 +65,7 @@ message LocalNodeInfoRequest {
 message LocalNodeInfoResponse {
   // Local Node Info, including API Version in use.
   message Body {
-    // Latest NeoFS API version in use
+    // Latest FrostFS API version in use
     neo.fs.v2.refs.Version version = 1;
 
     // NodeInfo structure with recent information from node itself

netmap/types.proto

@@ -122,7 +122,7 @@ message PlacementPolicy {
   // bucket
   repeated Replica replicas = 1 [ json_name = "replicas" ];
 
-  // Container backup factor controls how deep NeoFS will search for nodes
+  // Container backup factor controls how deep FrostFS will search for nodes
   // alternatives to include into container's nodes subset
   uint32 container_backup_factor = 2 [ json_name = "containerBackupFactor" ];
 
@@ -136,25 +136,25 @@ message PlacementPolicy {
   bool unique = 5 [ json_name = "unique" ];
 }
 
-// NeoFS node description
+// FrostFS node description
 message NodeInfo {
-  // Public key of the NeoFS node in a binary format
+  // Public key of the FrostFS node in a binary format
   bytes public_key = 1 [ json_name = "publicKey" ];
 
   // Ways to connect to a node
   repeated string addresses = 2 [ json_name = "addresses" ];
 
-  // Administrator-defined Attributes of the NeoFS Storage Node.
+  // Administrator-defined Attributes of the FrostFS Storage Node.
   //
   // `Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8
   // string. Value can't be empty.
   //
   // Attributes can be constructed into a chain of attributes: any attribute can
   // have a parent attribute and a child attribute (except the first and the
-  // last one). A string representation of the chain of attributes in NeoFS
+  // last one). A string representation of the chain of attributes in FrostFS
   // Storage Node configuration uses ":" and "/" symbols, e.g.:
   //
-  //        `NEOFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
+  //        `FrostFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
   //
   // Therefore the string attribute representation in the Node configuration
   // must use "\:", "\/" and "\\" escaped symbols if any of them appears in an
@@ -210,7 +210,7 @@ message NodeInfo {
   //   Must contain a comma-separated list of multi-addresses.
   //
   // For detailed description of each well-known attribute please see the
-  // corresponding section in NeoFS Technical Specification.
+  // corresponding section in FrostFS Technical Specification.
   message Attribute {
     // Key of the node attribute
     string key = 1 [ json_name = "key" ];
@@ -222,13 +222,13 @@ message NodeInfo {
     // `Country`.
     repeated string parents = 3 [ json_name = "parents" ];
   }
-  // Carries list of the NeoFS node attributes in a key-value form. Key name
+  // Carries list of the FrostFS node attributes in a key-value form. Key name
   // must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo
   // structures with duplicated attribute names or attributes with empty values
   // will be considered invalid.
   repeated Attribute attributes = 3 [ json_name = "attributes" ];
 
-  // Represents the enumeration of various states of the NeoFS node.
+  // Represents the enumeration of various states of the FrostFS node.
   enum State {
     // Unknown state
     UNSPECIFIED = 0;
@@ -243,7 +243,7 @@ message NodeInfo {
     MAINTENANCE = 3;
   }
 
-  // Carries state of the NeoFS node
+  // Carries state of the FrostFS node
   State state = 4 [ json_name = "state" ];
 }
 
@@ -256,7 +256,7 @@ message Netmap {
   repeated NodeInfo nodes = 2 [ json_name = "nodes" ];
 }
 
-// NeoFS network configuration
+// FrostFS network configuration
 message NetworkConfig {
   // Single configuration parameter. Key MUST be network-unique.
   //
@@ -275,7 +275,7 @@ message NetworkConfig {
   //   Fee paid for container creation by the container owner.
   //   Value: little-endian integer. Default: 0.
   // - **EpochDuration** \
-  //   NeoFS epoch duration measured in Sidechain blocks.
+  //   FrostFS epoch duration measured in Sidechain blocks.
   //   Value: little-endian integer. Default: 0.
   // - **HomomorphicHashingDisabled** \
   //   Flag of disabling the homomorphic hashing of objects' payload.
@@ -287,11 +287,11 @@ message NetworkConfig {
   //   Flag allowing setting the MAINTENANCE state to storage nodes.
   //   Value: true if any byte != 0. Default: false.
   // - **MaxObjectSize** \
-  //   Maximum size of physically stored NeoFS object measured in bytes.
+  //   Maximum size of physically stored FrostFS object measured in bytes.
   //   Value: little-endian integer. Default: 0.
   //
   //   This value refers to the maximum size of a **physically** stored object
-  //   in NeoFS. However, from a user's perspective, the **logical** size of a
+  //   in FrostFS. However, from a user's perspective, the **logical** size of a
   //   stored object can be significantly larger. The relationship between the
   //   physical and logical object sizes is governed by the following formula
   //
@@ -340,18 +340,18 @@ message NetworkConfig {
   repeated Parameter parameters = 1 [ json_name = "parameters" ];
 }
 
-// Information about NeoFS network
+// Information about FrostFS network
 message NetworkInfo {
-  // Number of the current epoch in the NeoFS network
+  // Number of the current epoch in the FrostFS network
   uint64 current_epoch = 1 [ json_name = "currentEpoch" ];
 
-  // Magic number of the sidechain of the NeoFS network
+  // Magic number of the sidechain of the FrostFS network
   uint64 magic_number = 2 [ json_name = "magicNumber" ];
 
-  // MillisecondsPerBlock network parameter of the sidechain of the NeoFS
+  // MillisecondsPerBlock network parameter of the sidechain of the FrostFS
   // network
   int64 ms_per_block = 3 [ json_name = "msPerBlock" ];
 
-  // NeoFS network configuration
+  // FrostFS network configuration
   NetworkConfig network_config = 4 [ json_name = "networkConfig" ];
 }

object/service.proto

@@ -151,7 +151,7 @@ service ObjectService {
   rpc Head(HeadRequest) returns (HeadResponse);
 
   // Search objects in container. Search query allows to match by Object
-  // Header's filed values. Please see the corresponding NeoFS Technical
+  // Header's filed values. Please see the corresponding FrostFS Technical
   // Specification section for more details.
   //
   // Extended headers can change `Search` behaviour:

object/types.proto

@@ -155,7 +155,7 @@ message Header {
   //   MIME Content Type of object's payload
   //
   // For detailed description of each well-known attribute please see the
-  // corresponding section in NeoFS Technical Specification.
+  // corresponding section in FrostFS Technical Specification.
   message Attribute {
     // string key to the object attribute
     string key = 1 [ json_name = "key" ];

refs/types.proto

@@ -5,7 +5,7 @@ package neo.fs.v2.refs;
 option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/refs/grpc;refs";
 option csharp_namespace = "Neo.FileStorage.API.Refs";
 
-// Objects in NeoFS are addressed by their ContainerID and ObjectID.
+// Objects in FrostFS are addressed by their ContainerID and ObjectID.
 //
 // String presentation of `Address` is a concatenation of string encoded
 // `ContainerID` and `ObjectID` delimited by '/' character.
@@ -16,8 +16,9 @@ message Address {
   ObjectID object_id = 2 [ json_name = "objectID" ];
 }
 
-// NeoFS Object unique identifier. Objects are immutable and content-addressed.
+// FrostFS Object unique identifier. Objects are immutable and
-// It means `ObjectID` will change if the `header` or the `payload` changes.
+// content-addressed. It means `ObjectID` will change if the `header` or the
+// `payload` changes.
 //
 // `ObjectID` is a 32 byte long
 // [SHA256](https://csrc.nist.gov/publications/detail/fips/180/4/final) hash of
@@ -37,7 +38,7 @@ message ObjectID {
   bytes value = 1 [ json_name = "value" ];
 }
 
-// NeoFS container identifier. Container structures are immutable and
+// FrostFS container identifier. Container structures are immutable and
 // content-addressed.
 //
 // `ContainerID` is a 32 byte long
@@ -90,7 +91,7 @@ message Version {
   uint32 minor = 2 [ json_name = "minor" ];
 }
 
-// Signature of something in NeoFS.
+// Signature of something in FrostFS.
 message Signature {
   // Public key used for signing
   bytes key = 1 [ json_name = "key" ];

session/service.proto

@@ -11,7 +11,7 @@ import "session/types.proto";
 // `SessionService` allows to establish a temporary trust relationship between
 // two peer nodes and generate a `SessionToken` as the proof of trust to be
 // attached in requests for further verification. Please see corresponding
-// section of NeoFS Technical Specification for details.
+// section of FrostFS Technical Specification for details.
 service SessionService {
   // Open a new session between two peers.
   //

session/types.proto

@@ -50,7 +50,7 @@ message ObjectSessionContext {
     refs.ContainerID container = 1 [ json_name = "container" ];
 
     // Indicates which objects the session is spread to. Objects are expected
-    // to be stored in the NeoFS container referenced by `container` field.
+    // to be stored in the FrostFS container referenced by `container` field.
     // Each element MUST have correct format.
     repeated refs.ObjectID objects = 2 [ json_name = "objects" ];
   }
@@ -88,7 +88,7 @@ message ContainerSessionContext {
   refs.ContainerID container_id = 3 [ json_name = "containerID" ];
 }
 
-// NeoFS Session Token.
+// FrostFS Session Token.
 message SessionToken {
   // Session Token body
   message Body {
@@ -126,7 +126,7 @@ message SessionToken {
   }
   // Session Token contains the proof of trust between peers to be attached in
   // requests for further verification. Please see corresponding section of
-  // NeoFS Technical Specification for details.
+  // FrostFS Technical Specification for details.
   Body body = 1 [ json_name = "body" ];
 
   // Signature of `SessionToken` information
@@ -186,7 +186,7 @@ message RequestMetaHeader {
   // `RequestMetaHeader` of the origin request
   RequestMetaHeader origin = 7 [ json_name = "origin" ];
 
-  // NeoFS network magic. Must match the value for the network
+  // FrostFS network magic. Must match the value for the network
   // that the server belongs to.
   uint64 magic_number = 8 [ json_name = "magicNumber" ];
 }

status/types.proto

@@ -5,12 +5,12 @@ package neo.fs.v2.status;
 option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/status/grpc;status";
 option csharp_namespace = "Neo.FileStorage.API.Status";
 
-// Declares the general format of the status returns of the NeoFS RPC protocol.
+// Declares the general format of the status returns of the FrostFS RPC
-// Status is present in all response messages. Each RPC of NeoFS protocol
+// protocol. Status is present in all response messages. Each RPC of FrostFS
-// describes the possible outcomes and details of the operation.
+// protocol describes the possible outcomes and details of the operation.
 //
 // Each status is assigned a one-to-one numeric code. Any unique result of an
-// operation in NeoFS is unambiguously associated with the code value.
+// operation in FrostFS is unambiguously associated with the code value.
 //
 // Numerical set of codes is split into 1024-element sections. An enumeration
 // is defined for each section. Values can be referred to in the following ways:
@@ -78,7 +78,7 @@ enum Section {
   SECTION_APE_MANAGER = 5;
 }
 
-// Section of NeoFS successful return codes.
+// Section of FrostFS successful return codes.
 enum Success {
   // [**0**] Default success. Not detailed.
   // If the server cannot match successful outcome to the code, it should
@@ -93,9 +93,9 @@ enum CommonFail {
   // use this code.
   INTERNAL = 0;
 
-  // [**1025**] Wrong magic of the NeoFS network.
+  // [**1025**] Wrong magic of the FrostFS network.
   // Details:
-  //  - [**0**] Magic number of the served NeoFS network (big-endian 64-bit
+  //  - [**0**] Magic number of the served FrostFS network (big-endian 64-bit
   //  unsigned integer).
   WRONG_MAGIC_NUMBER = 1;
 

tombstone/types.proto

@@ -8,10 +8,10 @@ option csharp_namespace = "Neo.FileStorage.API.Tombstone";
 import "refs/types.proto";
 
 // Tombstone keeps record of deleted objects for a few epochs until they are
-// purged from the NeoFS network.
+// purged from the FrostFS network.
 message Tombstone {
-  // Last NeoFS epoch number of the tombstone lifetime. It's set by the
+  // Last FrostFS epoch number of the tombstone lifetime. It's set by the
-  // tombstone creator depending on the current NeoFS network settings. A
+  // tombstone creator depending on the current FrostFS network settings. A
   // tombstone object must have the same expiration epoch value in
   // `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated)
   // attribute. Otherwise, the tombstone will be rejected by a storage node.