[#39] Makefile: Add fmt target

Signed-off-by: Evgenii Stratonikov <e.stratonikov@yadro.com>

Makefile

@@ -19,3 +19,9 @@ doc:
 			--proto_path=.:/usr/local/include \
 			--doc_out=proto-docs/ $${f}/*.proto; \
 	done
+
+fmt:
+	@for f in `ls **/*.proto`; do \
+		echo "⇒ Formatting $$f"; \
+		clang-format -i $$f; \
+	done

accounting/service.proto

@@ -51,7 +51,8 @@ message BalanceRequest {
 // BalanceResponse message
 message BalanceResponse {
   // The amount of funds in GAS token for the `OwnerID`'s account requested.
-  // Balance is given in the `Decimal` format to avoid precision issues with rounding.
+  // Balance is given in the `Decimal` format to avoid precision issues with
+  // rounding.
   message Body {
     // Amount of funds in GAS token for the requested account.
     Decimal balance = 1;

acl/types.proto

@@ -19,7 +19,8 @@ enum Role {
   // container or an inner ring node
   SYSTEM = 2;
 
-  // Others target rule is applied if sender is neither a user nor a system target
+  // Others target rule is applied if sender is neither a user nor a system
+  // target
   OTHERS = 3;
 }
 
@@ -183,16 +184,16 @@ message EACLTable {
 // used in the similar use cases, like providing authorisation to externally
 // authenticated party.
 //
-// BearerToken can be issued only by the container's owner and must be signed using
+// BearerToken can be issued only by the container's owner and must be signed
-// the key associated with the container's `OwnerID`.
+// using the key associated with the container's `OwnerID`.
 message BearerToken {
-  // Bearer Token body structure contains Extended ACL table issued by the container
+  // Bearer Token body structure contains Extended ACL table issued by the
-  // owner with additional information preventing token abuse.
+  // container owner with additional information preventing token abuse.
   message Body {
     // Table of Extended ACL rules to use instead of the ones attached to the
     // container. If it contains `container_id` field, bearer token is only
-    // valid for this specific container. Otherwise, any container of the same owner
+    // valid for this specific container. Otherwise, any container of the same
-    // is allowed.
+    // owner is allowed.
     EACLTable eacl_table = 1 [ json_name = "eaclTable" ];
 
     // `OwnerID` defines to whom the token was issued. It must match the request

audit/types.proto

@@ -38,13 +38,13 @@ message DataAuditResult {
   // List of Storage Groups that failed audit PoR stage
   repeated neo.fs.v2.refs.ObjectID fail_sg = 9 [ json_name = "failSG" ];
 
-  // Number of sampled objects under the audit placed in an optimal way according to
+  // Number of sampled objects under the audit placed in an optimal way
-  // the containers placement policy when checking PoP
+  // according to the containers placement policy when checking PoP
   uint32 hit = 10 [ json_name = "hit" ];
 
-  // Number of sampled objects under the audit placed in suboptimal way according to
+  // Number of sampled objects under the audit placed in suboptimal way
-  // the containers placement policy, but still at a satisfactory level when
+  // according to the containers placement policy, but still at a satisfactory
-  // checking PoP
+  // level when checking PoP
   uint32 miss = 11 [ json_name = "miss" ];
 
   // Number of sampled objects under the audit stored inconsistently with the

container/service.proto

@@ -17,8 +17,8 @@ import "session/types.proto";
 service ContainerService {
   // `Put` invokes `Container` smart contract's `Put` method and returns
   // response immediately. After a new block is issued in sidechain, request is
-  // verified by Inner Ring nodes. After one more block in sidechain, the container
+  // verified by Inner Ring nodes. After one more block in sidechain, the
-  // is added into smart contract storage.
+  // container is added into smart contract storage.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
@@ -28,8 +28,8 @@ service ContainerService {
 
   // `Delete` invokes `Container` smart contract's `Delete` method and returns
   // response immediately. After a new block is issued in sidechain, request is
-  // verified by Inner Ring nodes. After one more block in sidechain, the container
+  // verified by Inner Ring nodes. After one more block in sidechain, the
-  // is added into smart contract storage.
+  // container is added into smart contract storage.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
@@ -56,8 +56,8 @@ service ContainerService {
   rpc List(ListRequest) returns (ListResponse);
 
   // Invokes 'SetEACL' method of 'Container` smart contract and returns response
-  // immediately. After one more block in sidechain, changes in an Extended ACL are
+  // immediately. After one more block in sidechain, changes in an Extended ACL
-  // added into smart contract storage.
+  // are added into smart contract storage.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
@@ -84,7 +84,8 @@ service ContainerService {
   // - **OK** (0, SECTION_SUCCESS): \
   //   estimation of used space has been successfully announced;
   // - Common failures (SECTION_FAILURE_COMMON).
-  rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest) returns (AnnounceUsedSpaceResponse);
+  rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest)
+      returns (AnnounceUsedSpaceResponse);
 }
 
 // New NeoFS Container creation request
@@ -146,7 +147,8 @@ message DeleteRequest {
     // Identifier of the container to delete from NeoFS
     neo.fs.v2.refs.ContainerID container_id = 1;
 
-    // `ContainerID` signed with the container owner's key according to RFC-6979.
+    // `ContainerID` signed with the container owner's key according to
+    // RFC-6979.
     neo.fs.v2.refs.SignatureRFC6979 signature = 2;
   }
   // Body of container delete request message.
@@ -296,8 +298,8 @@ message SetExtendedACLRequest {
 // Set Extended ACL
 message SetExtendedACLResponse {
   // `SetExtendedACLResponse` has an empty body because the operation is
-  // asynchronous and the update should be reflected in `Container` smart contract's
+  // asynchronous and the update should be reflected in `Container` smart
-  // storage after next block is issued in sidechain.
+  // contract's storage after next block is issued in sidechain.
   message Body {}
 
   // Body of set extended acl response message.
@@ -337,8 +339,8 @@ message GetExtendedACLRequest {
 // Get Extended ACL
 message GetExtendedACLResponse {
   // Get Extended ACL Response body can be empty if the requested container does
-  // not have Extended ACL Table attached or Extended ACL has not been allowed at
+  // not have Extended ACL Table attached or Extended ACL has not been allowed
-  // the time of container creation.
+  // at the time of container creation.
   message Body {
     // Extended ACL requested, if available
     neo.fs.v2.acl.EACLTable eacl = 1;

container/types.proto

@@ -10,8 +10,8 @@ import "refs/types.proto";
 
 // Container is a structure that defines object placement behaviour. Objects can
 // be stored only within containers. They define placement rule, attributes and
-// access control information. An ID of a container is a 32 byte long SHA256 hash
+// access control information. An ID of a container is a 32 byte long SHA256
-// of stable-marshalled container message.
+// hash of stable-marshalled container message.
 message Container {
   // Container format version. Effectively, the version of API library used to
   // create the container.
@@ -23,13 +23,13 @@ message Container {
   // Nonce is a 16 byte UUIDv4, used to avoid collisions of `ContainerID`s
   bytes nonce = 3 [ json_name = "nonce" ];
 
-  // `BasicACL` contains access control rules for the owner, system and others groups,
+  // `BasicACL` contains access control rules for the owner, system and others
-  // as well as permission bits for `BearerToken` and `Extended ACL`
+  // groups, as well as permission bits for `BearerToken` and `Extended ACL`
   uint32 basic_acl = 4 [ json_name = "basicACL" ];
 
   // `Attribute` is a user-defined Key-Value metadata pair attached to the
-  // container. Container attributes are immutable. They are set at the moment of
+  // container. Container attributes are immutable. They are set at the moment
-  // container creation and can never be added or updated.
+  // of container creation and can never be added or updated.
   //
   // Key name must be a container-unique valid UTF-8 string. Value can't be
   // empty. Containers with duplicated attribute names or attributes with empty
@@ -43,15 +43,16 @@ message Container {
   //   NNS contract.
   // * [ __SYSTEM__ZONE ]  \
   //   (`__NEOFS__ZONE` is deprecated) \
-  //   String of a zone for `__SYSTEM__NAME` (`__NEOFS__NAME` is deprecated). Used as a TLD of a domain name in NNS
+  //   String of a zone for `__SYSTEM__NAME` (`__NEOFS__NAME` is deprecated).
-  //   contract. If no zone is specified, use default zone: `container`.
+  //   Used as a TLD of a domain name in NNS contract. If no zone is specified,
+  //   use default zone: `container`.
   // * [ __SYSTEM__DISABLE_HOMOMORPHIC_HASHING ] \
   //   (`__NEOFS__DISABLE_HOMOMORPHIC_HASHING` is deprecated) \
-  //   Disables homomorphic hashing for the container if the value equals "true" string.
+  //   Disables homomorphic hashing for the container if the value equals "true"
-  //   Any other values are interpreted as missing attribute. Container could be
+  //   string. Any other values are interpreted as missing attribute. Container
-  //   accepted in a NeoFS network only if the global network hashing configuration
+  //   could be accepted in a NeoFS network only if the global network hashing
-  //   value corresponds with that attribute's value. After container inclusion, network
+  //   configuration value corresponds with that attribute's value. After
-  //   setting is ignored.
+  //   container inclusion, network setting is ignored.
   //
   // And some well-known attributes used by applications only:
   //
@@ -70,5 +71,6 @@ message Container {
   repeated Attribute attributes = 5 [ json_name = "attributes" ];
 
   // Placement policy for the object inside the container
-  neo.fs.v2.netmap.PlacementPolicy placement_policy = 6 [json_name = "placementPolicy"];
+  neo.fs.v2.netmap.PlacementPolicy placement_policy = 6
+      [ json_name = "placementPolicy" ];
 }

lock/types.proto

@@ -9,8 +9,9 @@ import "refs/types.proto";
 
 // Lock objects protects a list of objects from being deleted. The lifetime of a
 // lock object is limited similar to regular objects in
-// `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated) attribute. Lock object MUST have expiration epoch.
+// `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated)
-// It is impossible to delete a lock object via ObjectService.Delete RPC call.
+// attribute. Lock object MUST have expiration epoch. It is impossible to delete
+// a lock object via ObjectService.Delete RPC call.
 message Lock {
   // List of objects to lock. Must not be empty or carry empty IDs.
   // All members must be of the `REGULAR` type.

netmap/service.proto

@@ -9,16 +9,17 @@ import "netmap/types.proto";
 import "refs/types.proto";
 import "session/types.proto";
 
-// `NetmapService` provides methods to work with `Network Map` and the information
+// `NetmapService` provides methods to work with `Network Map` and the
-// required to build it. The resulting `Network Map` is stored in sidechain
+// information required to build it. The resulting `Network Map` is stored in
-// `Netmap` smart contract, while related information can be obtained from other
+// sidechain `Netmap` smart contract, while related information can be obtained
-// NeoFS nodes.
+// from other NeoFS nodes.
 service NetmapService {
   // Get NodeInfo structure from the particular node directly.
-  // Node information can be taken from `Netmap` smart contract. In some cases, though,
+  // Node information can be taken from `Netmap` smart contract. In some cases,
-  // one may want to get recent information directly or to talk to the node not yet
+  // though, one may want to get recent information directly or to talk to the
-  // present in the `Network Map` to find out what API version can be used for
+  // node not yet present in the `Network Map` to find out what API version can
-  // further communication. This can be also used to check if a node is up and running.
+  // be used for further communication. This can be also used to check if a node
+  // is up and running.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS):
@@ -46,8 +47,7 @@ service NetmapService {
 // Get NodeInfo structure directly from a particular node
 message LocalNodeInfoRequest {
   // LocalNodeInfo request body is empty.
-  message Body {
+  message Body {}
-  }
   // Body of the LocalNodeInfo request message
   Body body = 1;
 
@@ -87,8 +87,7 @@ message LocalNodeInfoResponse {
 // Get NetworkInfo structure with the network view from a particular node.
 message NetworkInfoRequest {
   // NetworkInfo request body is empty.
-    message Body {
+  message Body {}
-    }
   // Body of the NetworkInfo request message
   Body body = 1;
 
@@ -126,8 +125,7 @@ message NetworkInfoResponse {
 // Get netmap snapshot request
 message NetmapSnapshotRequest {
   // Get netmap snapshot request body.
-    message Body {
+  message Body {}
-    }
 
   // Body of get netmap snapshot request message.
   Body body = 1;
@@ -140,7 +138,6 @@ message NetmapSnapshotRequest {
   // authenticate the nodes of the message route and check the correctness of
   // transmission.
   neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
-
 }
 
 // Response with current netmap snapshot
@@ -162,5 +159,4 @@ message NetmapSnapshotResponse {
   // authenticate the nodes of the message route and check the correctness of
   // transmission.
   neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
-
 }

netmap/types.proto

@@ -52,8 +52,8 @@ enum Clause {
   DISTINCT = 2;
 }
 
-// This filter will return the subset of nodes from `NetworkMap` or another filter's
+// This filter will return the subset of nodes from `NetworkMap` or another
-// results that will satisfy filter's conditions.
+// filter's results that will satisfy filter's conditions.
 message Filter {
   // Name of the filter or a reference to a named filter. '*' means
   // application to the whole unfiltered NetworkMap. At top level it's used as a
@@ -141,15 +141,15 @@ message NodeInfo {
   // 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
+  // have a parent attribute and a child attribute (except the first and the
-  // one). A string representation of the chain of attributes in NeoFS Storage
+  // last one). A string representation of the chain of attributes in NeoFS
-  // Node configuration uses ":" and "/" symbols, e.g.:
+  // Storage Node configuration uses ":" and "/" symbols, e.g.:
   //
   //        `NEOFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
   //
-  // Therefore the string attribute representation in the Node configuration must
+  // Therefore the string attribute representation in the Node configuration
-  // use "\:", "\/" and "\\" escaped symbols if any of them appears in an attribute's
+  // must use "\:", "\/" and "\\" escaped symbols if any of them appears in an
-  // key or value.
+  // attribute's key or value.
   //
   // Node's attributes are mostly used during Storage Policy evaluation to
   // calculate object's placement and find a set of nodes satisfying policy
@@ -302,7 +302,8 @@ message NetworkInfo {
   // Magic number of the sidechain of the NeoFS network
   uint64 magic_number = 2 [ json_name = "magicNumber" ];
 
-    // MillisecondsPerBlock network parameter of the sidechain of the NeoFS network
+  // MillisecondsPerBlock network parameter of the sidechain of the NeoFS
+  // network
   int64 ms_per_block = 3 [ json_name = "msPerBlock" ];
 
   // NeoFS network configuration

refs/types.proto

@@ -21,8 +21,8 @@ message Address {
 //
 // `ObjectID` is a 32 byte long
 // [SHA256](https://csrc.nist.gov/publications/detail/fips/180/4/final) hash of
-// the object's `header` field, which, in it's turn, contains the hash of the object's
+// the object's `header` field, which, in it's turn, contains the hash of the
-// payload.
+// object's payload.
 //
 // String presentation is a
 // [base58](https://tools.ietf.org/html/draft-msporny-base58-02) encoded string.
@@ -80,7 +80,8 @@ message OwnerID {
 // API version used by a node.
 //
 // String presentation is a Semantic Versioning 2.0.0 compatible version string
-// with 'v' prefix. i.e. `vX.Y`, where `X` is the major number, `Y` is the minor number.
+// with 'v' prefix. i.e. `vX.Y`, where `X` is the major number, `Y` is the minor
+// number.
 message Version {
   // Major API version
   uint32 major = 1 [ json_name = "major" ];
@@ -99,7 +100,8 @@ message Signature {
   SignatureScheme scheme = 3 [ json_name = "scheme" ];
 }
 
-// Signature scheme describes digital signing scheme used for (key, signature) pair.
+// Signature scheme describes digital signing scheme used for (key, signature)
+// pair.
 enum SignatureScheme {
   // ECDSA with SHA-512 hashing (FIPS 186-3)
   ECDSA_SHA512 = 0;

session/types.proto

@@ -130,15 +130,15 @@ message SessionToken {
   neo.fs.v2.refs.Signature signature = 2 [ json_name = "signature" ];
 }
 
-// Extended headers for Request/Response. They may contain any user-defined headers
+// Extended headers for Request/Response. They may contain any user-defined
-// to be interpreted on application level.
+// headers to be interpreted on application level.
 //
-// Key name must be a unique valid UTF-8 string. Value can't be empty. Requests or
+// Key name must be a unique valid UTF-8 string. Value can't be empty. Requests
-// Responses with duplicated header names or headers with empty values will be
+// or Responses with duplicated header names or headers with empty values will
-// considered invalid.
+// be considered invalid.
 //
-// There are some "well-known" headers starting with `__SYSTEM__` (`__NEOFS__` is deprecated) prefix that
+// There are some "well-known" headers starting with `__SYSTEM__` (`__NEOFS__`
-// affect system behaviour:
+// is deprecated) prefix that affect system behaviour:
 //
 // * [ __SYSTEM__NETMAP_EPOCH ] \
 //   (`__NEOFS__NETMAP_EPOCH` is deprecated) \
@@ -149,8 +149,8 @@ message SessionToken {
 //   (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
 //   If object can't be found using current epoch's netmap, this header limits
 //   how many past epochs the node can look up through. The `value` is string
-//   encoded `uint64` in decimal presentation. If set to '0' or not set, only the
+//   encoded `uint64` in decimal presentation. If set to '0' or not set, only
-//   current epoch will be used.
+//   the current epoch will be used.
 message XHeader {
   // Key of the X-Header
   string key = 1 [ json_name = "key" ];
@@ -216,7 +216,8 @@ message RequestVerificationHeader {
   // Request Meta signature is added and signed by each intermediate node
   neo.fs.v2.refs.Signature meta_signature = 2 [ json_name = "metaSignature" ];
   // Signature of previous hops
-  neo.fs.v2.refs.Signature origin_signature = 3 [json_name = "originSignature"];
+  neo.fs.v2.refs.Signature origin_signature = 3
+      [ json_name = "originSignature" ];
 
   // Chain of previous hops signatures
   RequestVerificationHeader origin = 4 [ json_name = "origin" ];
@@ -229,7 +230,8 @@ message ResponseVerificationHeader {
   // Response Meta signature is added and signed by each intermediate node
   neo.fs.v2.refs.Signature meta_signature = 2 [ json_name = "metaSignature" ];
   // Signature of previous hops
-  neo.fs.v2.refs.Signature origin_signature = 3 [json_name = "originSignature"];
+  neo.fs.v2.refs.Signature origin_signature = 3
+      [ json_name = "originSignature" ];
 
   // Chain of previous hops signatures
   ResponseVerificationHeader origin = 4 [ json_name = "origin" ];

tombstone/types.proto

@@ -10,9 +10,10 @@ import "refs/types.proto";
 // Tombstone keeps record of deleted objects for a few epochs until they are
 // purged from the NeoFS network.
 message Tombstone {
-  // Last NeoFS epoch number of the tombstone lifetime. It's set by the tombstone
+  // Last NeoFS epoch number of the tombstone lifetime. It's set by the
-  // creator depending on the current NeoFS network settings. A tombstone object
+  // tombstone creator depending on the current NeoFS network settings. A
-  // must have the same expiration epoch value in `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated)
+  // 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.
   uint64 expiration_epoch = 1 [ json_name = "expirationEpoch" ];