Skip to content

Commit

Permalink
*: get rid of "sidechain"
Browse files Browse the repository at this point in the history
Use "FS chain" everywhere.

Signed-off-by: Roman Khimov <roman@nspcc.ru>
  • Loading branch information
roman-khimov committed Nov 19, 2024
1 parent d7c0333 commit 5427d4a
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 40 deletions.
4 changes: 2 additions & 2 deletions accounting/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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 FS chain via
// other NeoFS nodes to get information about the account balance. Deposit and
// Withdraw operations can't be implemented here, as they require Mainnet NeoFS
// smart contract invocation. Transfer operations between internal NeoFS
Expand All @@ -27,7 +27,7 @@ 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 FS chain `Balance` smart
// contract. If omitted, client implementation MUST set it to the request's
// signer `OwnerID`.
message Body {
Expand Down
24 changes: 12 additions & 12 deletions container/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,32 @@ 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
// equivalently by directly issuing transactions and RPC calls to sidechain
// in FS chain via other NeoFS nodes. All of those actions can be done
// equivalently by directly issuing transactions and RPC calls to FS chain
// nodes.
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
// response immediately. After a new block is issued in FS chain, request is
// verified by Inner Ring nodes. After one more block in FS chain, the container
// is added into smart contract storage.
//
// Statuses:
// - **OK** (0, SECTION_SUCCESS): \
// request to save the container has been sent to the sidechain;
// request to save the container has been sent to FS chain;
// - Common failures (SECTION_FAILURE_COMMON).
rpc Put(PutRequest) returns (PutResponse);

// `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
// response immediately. After a new block is issued in FS chain, request is
// verified by Inner Ring nodes. After one more block in FS chain, the container
// is added into smart contract storage.
// NOTE: a container deletion leads to the removal of every object in that
// container, regardless of any restrictions on the object removal (e.g. lock/locked
// object would be also removed).
//
// Statuses:
// - **OK** (0, SECTION_SUCCESS): \
// request to remove the container has been sent to the sidechain;
// request to remove the container has been sent to FS chain;
// - Common failures (SECTION_FAILURE_COMMON).
rpc Delete(DeleteRequest) returns (DeleteResponse);

Expand All @@ -59,12 +59,12 @@ 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 FS chain, changes in an Extended ACL are
// added into smart contract storage.
//
// Statuses:
// - **OK** (0, SECTION_SUCCESS): \
// request to save container eACL has been sent to the sidechain;
// request to save container eACL has been sent to FS chain;
// - Common failures (SECTION_FAILURE_COMMON).
rpc SetExtendedACL(SetExtendedACLRequest) returns (SetExtendedACLResponse);

Expand Down Expand Up @@ -93,7 +93,7 @@ service ContainerService {
// New NeoFS 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
// separate field. It's not stored in FS chain, just verified on container
// creation by `Container` smart contract. `ContainerID` is a SHA256 hash of
// the stable-marshalled container strucutre, hence there is no need for
// additional signature checks.
Expand Down Expand Up @@ -300,7 +300,7 @@ message SetExtendedACLRequest {
message SetExtendedACLResponse {
// `SetExtendedACLResponse` has an empty body because the operation is
// asynchronous and the update should be reflected in `Container` smart contract's
// storage after next block is issued in sidechain.
// storage after next block is issued in FS chain.
message Body { }

// Body of set extended acl response message.
Expand Down
4 changes: 2 additions & 2 deletions netmap/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import "refs/types.proto";
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
// required to build it. The resulting `Network Map` is stored in FS chain
// `Netmap` smart contract, while related information can be obtained from other
// NeoFS nodes.
service NetmapService {
Expand Down Expand Up @@ -103,7 +103,7 @@ message NetworkInfoRequest {
}

// Response with NetworkInfo structure including current epoch and
// sidechain magic number.
// FS chain magic number.
message NetworkInfoResponse {
// Information about the network.
message Body {
Expand Down
6 changes: 3 additions & 3 deletions netmap/types.proto
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ message NetworkConfig {
// Number of EigenTrust algorithm iterations to pass in the Reputation system.
// Value: little-endian integer. Default: 0.
// - **EpochDuration** \
// NeoFS epoch duration measured in Sidechain blocks.
// NeoFS epoch duration measured in FS chain blocks.
// Value: little-endian integer. Default: 0.
// - **HomomorphicHashingDisabled** \
// Flag of disabling the homomorphic hashing of objects' payload.
Expand Down Expand Up @@ -323,10 +323,10 @@ message NetworkInfo {
// Number of the current epoch in the NeoFS network
uint64 current_epoch = 1 [json_name = "currentEpoch"];

// Magic number of the sidechain of the NeoFS network
// Magic number of FS chain 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 FS chain of the NeoFS network
int64 ms_per_block = 3 [json_name = "msPerBlock"];

// NeoFS network configuration
Expand Down
2 changes: 1 addition & 1 deletion object/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import "session/types.proto";
import "status/types.proto";

// `ObjectService` provides API for manipulating objects. Object operations do
// not affect the sidechain and are only served by nodes in p2p style.
// not affect FS chain and are only served by nodes in P2P style.
service ObjectService {
// Receive full object structure, including Headers and payload. Response uses
// gRPC stream. First response message carries the object with the requested address.
Expand Down
4 changes: 2 additions & 2 deletions proto-docs/accounting.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<a name="neo.fs.v2.accounting.AccountingService"></a>

### Service "neo.fs.v2.accounting.AccountingService"
Accounting service provides methods for interaction with NeoFS sidechain via
Accounting service provides methods for interaction with FS chain via
other NeoFS nodes to get information about the account balance. Deposit and
Withdraw operations can't be implemented here, as they require Mainnet NeoFS
smart contract invocation. Transfer operations between internal NeoFS
Expand Down Expand Up @@ -78,7 +78,7 @@ BalanceRequest message

### Message BalanceRequest.Body
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 FS chain `Balance` smart
contract. If omitted, client implementation MUST set it to the request's
signer `OwnerID`.

Expand Down
24 changes: 12 additions & 12 deletions proto-docs/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@

### Service "neo.fs.v2.container.ContainerService"
`ContainerService` provides API to interact with `Container` smart contract
in NeoFS sidechain via other NeoFS nodes. All of those actions can be done
equivalently by directly issuing transactions and RPC calls to sidechain
in FS chain via other NeoFS nodes. All of those actions can be done
equivalently by directly issuing transactions and RPC calls to FS chain
nodes.

```
Expand All @@ -80,13 +80,13 @@ rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest) returns (AnnounceUsedSpaceRespon
#### Method Put

`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
response immediately. After a new block is issued in FS chain, request is
verified by Inner Ring nodes. After one more block in FS chain, the container
is added into smart contract storage.

Statuses:
- **OK** (0, SECTION_SUCCESS): \
request to save the container has been sent to the sidechain;
request to save the container has been sent to FS chain;
- Common failures (SECTION_FAILURE_COMMON).

| Name | Input | Output |
Expand All @@ -95,16 +95,16 @@ Statuses:
#### Method Delete

`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
response immediately. After a new block is issued in FS chain, request is
verified by Inner Ring nodes. After one more block in FS chain, the container
is added into smart contract storage.
NOTE: a container deletion leads to the removal of every object in that
container, regardless of any restrictions on the object removal (e.g. lock/locked
object would be also removed).

Statuses:
- **OK** (0, SECTION_SUCCESS): \
request to remove the container has been sent to the sidechain;
request to remove the container has been sent to FS chain;
- Common failures (SECTION_FAILURE_COMMON).

| Name | Input | Output |
Expand Down Expand Up @@ -139,12 +139,12 @@ Statuses:
#### Method SetExtendedACL

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 FS chain, changes in an Extended ACL are
added into smart contract storage.

Statuses:
- **OK** (0, SECTION_SUCCESS): \
request to save container eACL has been sent to the sidechain;
request to save container eACL has been sent to FS chain;
- Common failures (SECTION_FAILURE_COMMON).

| Name | Input | Output |
Expand Down Expand Up @@ -457,7 +457,7 @@ New NeoFS Container creation request

### Message PutRequest.Body
Container creation request has container structure's signature as a
separate field. It's not stored in sidechain, just verified on container
separate field. It's not stored in FS chain, just verified on container
creation by `Container` smart contract. `ContainerID` is a SHA256 hash of
the stable-marshalled container strucutre, hence there is no need for
additional signature checks.
Expand Down Expand Up @@ -540,7 +540,7 @@ Set Extended ACL
### Message SetExtendedACLResponse.Body
`SetExtendedACLResponse` has an empty body because the operation is
asynchronous and the update should be reflected in `Container` smart contract's
storage after next block is issued in sidechain.
storage after next block is issued in FS chain.


<!-- end messages -->
Expand Down
10 changes: 5 additions & 5 deletions proto-docs/netmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@

### Service "neo.fs.v2.netmap.NetmapService"
`NetmapService` provides methods to work with `Network Map` and the information
required to build it. The resulting `Network Map` is stored in sidechain
required to build it. The resulting `Network Map` is stored in FS chain
`Netmap` smart contract, while related information can be obtained from other
NeoFS nodes.

Expand Down Expand Up @@ -220,7 +220,7 @@ NetworkInfo request body is empty.

### Message NetworkInfoResponse
Response with NetworkInfo structure including current epoch and
sidechain magic number.
FS chain magic number.


| Field | Type | Label | Description |
Expand Down Expand Up @@ -321,7 +321,7 @@ System parameters:
Number of EigenTrust algorithm iterations to pass in the Reputation system.
Value: little-endian integer. Default: 0.
- **EpochDuration** \
NeoFS epoch duration measured in Sidechain blocks.
NeoFS epoch duration measured in FS chain blocks.
Value: little-endian integer. Default: 0.
- **HomomorphicHashingDisabled** \
Flag of disabling the homomorphic hashing of objects' payload.
Expand Down Expand Up @@ -355,8 +355,8 @@ Information about NeoFS network
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| current_epoch | [uint64](#uint64) | | Number of the current epoch in the NeoFS network |
| magic_number | [uint64](#uint64) | | Magic number of the sidechain of the NeoFS network |
| ms_per_block | [int64](#int64) | | MillisecondsPerBlock network parameter of the sidechain of the NeoFS network |
| magic_number | [uint64](#uint64) | | Magic number of FS chain of the NeoFS network |
| ms_per_block | [int64](#int64) | | MillisecondsPerBlock network parameter of FS chain of the NeoFS network |
| network_config | [NetworkConfig](#neo.fs.v2.netmap.NetworkConfig) | | NeoFS network configuration |


Expand Down
2 changes: 1 addition & 1 deletion proto-docs/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@

### Service "neo.fs.v2.object.ObjectService"
`ObjectService` provides API for manipulating objects. Object operations do
not affect the sidechain and are only served by nodes in p2p style.
not affect FS chain and are only served by nodes in P2P style.

```
rpc Get(GetRequest) returns (stream GetResponse);
Expand Down

0 comments on commit 5427d4a

Please sign in to comment.