From dacc483d006e9bae927eca10998c10dfb9e52060 Mon Sep 17 00:00:00 2001 From: Stanislav Bogatyrev Date: Sun, 5 Feb 2023 18:59:38 +0300 Subject: [PATCH] [#1] Fix comments and error messages Signed-off-by: Stanislav Bogatyrev --- pkg/core/client/client.go | 4 ++-- pkg/core/container/storage.go | 6 +++--- pkg/core/netmap/state.go | 2 +- pkg/core/object/address.go | 2 +- pkg/core/object/fmt.go | 2 +- pkg/core/version/version.go | 2 +- pkg/innerring/config/fee.go | 2 +- pkg/innerring/internal/client/client.go | 8 ++++---- pkg/innerring/internal/client/doc.go | 6 +++--- .../processors/container/processor.go | 2 +- .../processors/governance/process_update.go | 2 +- .../netmap/nodevalidation/locode/deps.go | 4 ++-- .../netmap/nodevalidation/locode/validator.go | 2 +- .../netmap/nodevalidation/state/validator.go | 4 ++-- .../processors/settlement/audit/prm.go | 2 +- .../processors/settlement/common/types.go | 4 ++-- pkg/innerring/processors/subnet/put.go | 4 ++-- pkg/innerring/subnet.go | 6 +++--- .../blobovnicza/blobovnicza.go | 2 +- pkg/local_object_storage/blobstor/blobstor.go | 2 +- pkg/local_object_storage/engine/engine.go | 2 +- pkg/local_object_storage/metabase/inhume.go | 2 +- pkg/local_object_storage/shard/gc.go | 4 ++-- pkg/local_object_storage/shard/shard.go | 2 +- pkg/morph/client/audit/client.go | 2 +- pkg/morph/client/audit/put_result.go | 2 +- pkg/morph/client/balance/client.go | 2 +- pkg/morph/client/container/client.go | 2 +- pkg/morph/client/container/delete.go | 2 +- pkg/morph/client/container/eacl.go | 2 +- pkg/morph/client/container/eacl_set.go | 2 +- pkg/morph/client/container/get.go | 2 +- pkg/morph/client/container/list.go | 4 ++-- pkg/morph/client/container/load.go | 2 +- pkg/morph/client/container/put.go | 2 +- pkg/morph/client/frostfs/bind.go | 6 +++--- pkg/morph/client/frostfs/cheque.go | 2 +- pkg/morph/client/frostfs/client.go | 4 ++-- pkg/morph/client/frostfsid/addrm_keys.go | 8 ++++---- pkg/morph/client/frostfsid/client.go | 8 ++++---- pkg/morph/client/frostfsid/keys.go | 2 +- pkg/morph/client/netmap/add_peer.go | 2 +- pkg/morph/client/netmap/client.go | 2 +- pkg/morph/client/netmap/config.go | 20 +++++++++---------- pkg/morph/client/netmap/epoch.go | 4 ++-- pkg/morph/client/netmap/new_epoch.go | 2 +- pkg/morph/client/nns.go | 6 +++--- pkg/morph/client/notary.go | 8 ++++---- pkg/morph/client/reputation/client.go | 2 +- pkg/morph/client/subnet/admin.go | 6 +++--- pkg/morph/client/subnet/client.go | 2 +- pkg/morph/client/subnet/clients.go | 12 +++++------ pkg/morph/client/subnet/delete.go | 2 +- pkg/morph/client/subnet/get.go | 4 ++-- pkg/morph/client/subnet/node.go | 2 +- pkg/morph/client/subnet/put.go | 6 +++--- pkg/morph/event/container/eacl.go | 4 ++-- pkg/morph/event/container/put.go | 2 +- pkg/morph/event/subnet/put.go | 4 ++-- pkg/morph/subscriber/subscriber.go | 2 +- pkg/network/address.go | 2 +- .../transport/accounting/grpc/service.go | 2 +- .../transport/container/grpc/service.go | 2 +- pkg/network/transport/netmap/grpc/service.go | 2 +- pkg/network/transport/object/grpc/service.go | 2 +- .../transport/reputation/grpc/service.go | 2 +- pkg/network/transport/session/grpc/service.go | 2 +- pkg/services/accounting/server.go | 2 +- .../announcement/load/route/placement/deps.go | 2 +- pkg/services/container/morph/executor.go | 4 ++-- pkg/services/container/server.go | 2 +- pkg/services/netmap/executor.go | 6 +++--- pkg/services/netmap/server.go | 2 +- pkg/services/object/acl/acl.go | 2 +- pkg/services/object/acl/v2/util.go | 4 ++-- pkg/services/object/delete/service.go | 2 +- pkg/services/object/get/v2/service.go | 2 +- pkg/services/object/internal/client/client.go | 4 ++-- pkg/services/object/internal/client/doc.go | 6 +++--- pkg/services/object/server.go | 8 ++++---- pkg/services/object/util/key.go | 2 +- .../object_manager/tombstone/checker.go | 2 +- .../object_manager/tombstone/source/source.go | 2 +- pkg/services/policer/check.go | 4 ++-- pkg/services/policer/policer.go | 2 +- pkg/services/reputation/rpc/server.go | 2 +- pkg/services/session/server.go | 2 +- pkg/services/tree/options.go | 2 +- pkg/services/tree/signature.go | 2 +- pkg/services/tree/types.proto | 2 +- pkg/services/util/sign.go | 2 +- pkg/util/locode/db/boltdb/db.go | 4 ++-- pkg/util/locode/db/country.go | 2 +- pkg/util/locode/db/db.go | 14 ++++++------- pkg/util/locode/db/location.go | 2 +- pkg/util/locode/db/record.go | 4 ++-- 96 files changed, 167 insertions(+), 167 deletions(-) diff --git a/pkg/core/client/client.go b/pkg/core/client/client.go index b325516ad..0f6697882 100644 --- a/pkg/core/client/client.go +++ b/pkg/core/client/client.go @@ -8,7 +8,7 @@ import ( "github.com/TrueCloudLab/frostfs-sdk-go/client" ) -// Client is an interface of NeoFS storage +// Client is an interface of FrostFS storage // node's client. type Client interface { ContainerAnnounceUsedSpace(context.Context, client.PrmAnnounceSpace) (*client.ResAnnounceSpace, error) @@ -35,7 +35,7 @@ type MultiAddressClient interface { RawForAddress(network.Address, func(cli *rawclient.Client) error) error } -// NodeInfo groups information about a NeoFS storage node needed for Client construction. +// NodeInfo groups information about a FrostFS storage node needed for Client construction. type NodeInfo struct { addrGroup network.AddressGroup diff --git a/pkg/core/container/storage.go b/pkg/core/container/storage.go index de88f89fd..73f79de42 100644 --- a/pkg/core/container/storage.go +++ b/pkg/core/container/storage.go @@ -11,7 +11,7 @@ import ( "github.com/TrueCloudLab/frostfs-sdk-go/session" ) -// Container groups information about the NeoFS container stored in the NeoFS network. +// Container groups information about the FrostFS container stored in the FrostFS network. type Container struct { // Container structure. Value container.Container @@ -43,8 +43,8 @@ func IsErrNotFound(err error) bool { return errors.As(err, new(apistatus.ContainerNotFound)) } -// EACL groups information about the NeoFS container's extended ACL stored in -// the NeoFS network. +// EACL groups information about the FrostFS container's extended ACL stored in +// the FrostFS network. type EACL struct { // Extended ACL structure. Value *eacl.Table diff --git a/pkg/core/netmap/state.go b/pkg/core/netmap/state.go index 9b5b441a1..1b057d6d7 100644 --- a/pkg/core/netmap/state.go +++ b/pkg/core/netmap/state.go @@ -2,6 +2,6 @@ package netmap // State groups the current system state parameters. type State interface { - // CurrentEpoch returns the number of the current NeoFS epoch. + // CurrentEpoch returns the number of the current FrostFS epoch. CurrentEpoch() uint64 } diff --git a/pkg/core/object/address.go b/pkg/core/object/address.go index 2f5883e89..800fe316f 100644 --- a/pkg/core/object/address.go +++ b/pkg/core/object/address.go @@ -5,7 +5,7 @@ import ( oid "github.com/TrueCloudLab/frostfs-sdk-go/object/id" ) -// AddressWithType groups object address with its NeoFS +// AddressWithType groups object address with its FrostFS // object type. type AddressWithType struct { Address oid.Address diff --git a/pkg/core/object/fmt.go b/pkg/core/object/fmt.go index edcdb1141..6157661fe 100644 --- a/pkg/core/object/fmt.go +++ b/pkg/core/object/fmt.go @@ -169,7 +169,7 @@ func (v *FormatValidator) checkOwnerKey(id user.ID, key frostfsecdsa.PublicKey) return nil } -// ContentMeta describes NeoFS meta information that brings object's payload if the object +// ContentMeta describes FrostFS meta information that brings object's payload if the object // is one of: // - object.TypeTombstone; // - object.TypeStorageGroup; diff --git a/pkg/core/version/version.go b/pkg/core/version/version.go index 616d04967..e84ad30ff 100644 --- a/pkg/core/version/version.go +++ b/pkg/core/version/version.go @@ -4,7 +4,7 @@ import ( "github.com/TrueCloudLab/frostfs-sdk-go/version" ) -// IsValid checks if Version is not earlier than the genesis version of the NeoFS. +// IsValid checks if Version is not earlier than the genesis version of the FrostFS. func IsValid(v version.Version) bool { const ( startMajor = 2 diff --git a/pkg/innerring/config/fee.go b/pkg/innerring/config/fee.go index 54eeb6abc..d77685643 100644 --- a/pkg/innerring/config/fee.go +++ b/pkg/innerring/config/fee.go @@ -32,7 +32,7 @@ func (f FeeConfig) SideChainFee() fixedn.Fixed8 { return f.sidechain } -// NamedContainerRegistrationFee returns additional GAS fee for named container registration in NeoFS network. +// NamedContainerRegistrationFee returns additional GAS fee for named container registration in FrostFS network. func (f FeeConfig) NamedContainerRegistrationFee() fixedn.Fixed8 { return f.registerNamedCnr } diff --git a/pkg/innerring/internal/client/client.go b/pkg/innerring/internal/client/client.go index 480835f2a..668af543e 100644 --- a/pkg/innerring/internal/client/client.go +++ b/pkg/innerring/internal/client/client.go @@ -16,14 +16,14 @@ import ( oid "github.com/TrueCloudLab/frostfs-sdk-go/object/id" ) -// Client represents NeoFS API client cut down to the needs of a purely IR application. +// Client represents FrostFS API client cut down to the needs of a purely IR application. type Client struct { key *ecdsa.PrivateKey c clientcore.Client } -// WrapBasicClient wraps a client.Client instance to use it for NeoFS API RPC. +// WrapBasicClient wraps a client.Client instance to use it for FrostFS API RPC. func (x *Client) WrapBasicClient(c clientcore.Client) { x.c = c } @@ -211,7 +211,7 @@ func (x Client) HeadObject(prm HeadObjectPrm) (*HeadObjectRes, error) { } if err != nil { - return nil, fmt.Errorf("read object header from NeoFS: %w", err) + return nil, fmt.Errorf("read object header from FrostFS: %w", err) } var hdr object.Object @@ -225,7 +225,7 @@ func (x Client) HeadObject(prm HeadObjectPrm) (*HeadObjectRes, error) { }, nil } -// GetObjectPayload reads an object by address from NeoFS via Client and returns its payload. +// GetObjectPayload reads an object by address from FrostFS via Client and returns its payload. // // Returns any error which prevented the operation from completing correctly in error return. func GetObjectPayload(ctx context.Context, c Client, addr oid.Address) ([]byte, error) { diff --git a/pkg/innerring/internal/client/doc.go b/pkg/innerring/internal/client/doc.go index 0a0e8ea3e..a04b0627b 100644 --- a/pkg/innerring/internal/client/doc.go +++ b/pkg/innerring/internal/client/doc.go @@ -1,6 +1,6 @@ -// Package frostfsapiclient provides functionality for IR application communication with NeoFS network. +// Package frostfsapiclient provides functionality for IR application communication with FrostFS network. // -// The basic client for accessing remote nodes via NeoFS API is a NeoFS SDK Go API client. +// The basic client for accessing remote nodes via FrostFS API is a FrostFS SDK Go API client. // However, although it encapsulates a useful piece of business logic (e.g. the signature mechanism), // the IR application does not fully use the client's flexible interface. // @@ -8,5 +8,5 @@ // The type provides the minimum interface necessary for the application and also allows you to concentrate // the entire spectrum of the client's use in one place (this will be convenient both when updating the base client // and for evaluating the UX of SDK library). So, it is expected that all application packages will be limited -// to this package for the development of functionality requiring NeoFS API communication. +// to this package for the development of functionality requiring FrostFS API communication. package frostfsapiclient diff --git a/pkg/innerring/processors/container/processor.go b/pkg/innerring/processors/container/processor.go index a916cc034..d12f7f211 100644 --- a/pkg/innerring/processors/container/processor.go +++ b/pkg/innerring/processors/container/processor.go @@ -81,7 +81,7 @@ func New(p *Params) (*Processor, error) { case p.ContainerClient == nil: return nil, errors.New("ir/container: Container client is not set") case p.FrostFSIDClient == nil: - return nil, errors.New("ir/container: NeoFS ID client is not set") + return nil, errors.New("ir/container: FrostFS ID client is not set") case p.NetworkState == nil: return nil, errors.New("ir/container: network state is not set") case p.SubnetClient == nil: diff --git a/pkg/innerring/processors/governance/process_update.go b/pkg/innerring/processors/governance/process_update.go index 587e57533..705165d40 100644 --- a/pkg/innerring/processors/governance/process_update.go +++ b/pkg/innerring/processors/governance/process_update.go @@ -123,7 +123,7 @@ func (gp *Processor) processAlphabetSync(txHash util.Uint256) { } } - // 4. Update NeoFS contract in the mainnet. + // 4. Update FrostFS contract in the mainnet. epoch := gp.epochState.EpochCounter() buf := make([]byte, 8) diff --git a/pkg/innerring/processors/netmap/nodevalidation/locode/deps.go b/pkg/innerring/processors/netmap/nodevalidation/locode/deps.go index a99705d02..0a6b00853 100644 --- a/pkg/innerring/processors/netmap/nodevalidation/locode/deps.go +++ b/pkg/innerring/processors/netmap/nodevalidation/locode/deps.go @@ -6,7 +6,7 @@ import ( ) // Record is an interface of read-only -// NeoFS LOCODE database single entry. +// FrostFS LOCODE database single entry. type Record interface { // Must return ISO 3166-1 alpha-2 // country code. @@ -47,7 +47,7 @@ type Record interface { } // DB is an interface of read-only -// NeoFS LOCODE database. +// FrostFS LOCODE database. type DB interface { // Must find the record that corresponds to // LOCODE and provides the Record interface. diff --git a/pkg/innerring/processors/netmap/nodevalidation/locode/validator.go b/pkg/innerring/processors/netmap/nodevalidation/locode/validator.go index 639eb1651..47183423d 100644 --- a/pkg/innerring/processors/netmap/nodevalidation/locode/validator.go +++ b/pkg/innerring/processors/netmap/nodevalidation/locode/validator.go @@ -6,7 +6,7 @@ package locode // Passing incorrect parameter values will result in constructor // failure (error or panic depending on the implementation). type Prm struct { - // NeoFS LOCODE database interface. + // FrostFS LOCODE database interface. // // Must not be nil. DB DB diff --git a/pkg/innerring/processors/netmap/nodevalidation/state/validator.go b/pkg/innerring/processors/netmap/nodevalidation/state/validator.go index 39ff25b3f..7db7e518b 100644 --- a/pkg/innerring/processors/netmap/nodevalidation/state/validator.go +++ b/pkg/innerring/processors/netmap/nodevalidation/state/validator.go @@ -15,7 +15,7 @@ import ( // ErrMaintenanceModeDisallowed is returned when maintenance mode is disallowed. var ErrMaintenanceModeDisallowed = errors.New("maintenance mode is disallowed") -// NetworkSettings encapsulates current settings of the NeoFS network and +// NetworkSettings encapsulates current settings of the FrostFS network and // provides interface used for processing the network map candidates. type NetworkSettings interface { // MaintenanceModeAllowed checks if maintenance state of the storage nodes @@ -27,7 +27,7 @@ type NetworkSettings interface { } // NetMapCandidateValidator represents tool which checks state of nodes which -// are going to register in the NeoFS network (enter the network map). +// are going to register in the FrostFS network (enter the network map). // // NetMapCandidateValidator can be instantiated using built-in var declaration // and currently doesn't require any additional initialization. diff --git a/pkg/innerring/processors/settlement/audit/prm.go b/pkg/innerring/processors/settlement/audit/prm.go index f68e93dee..ebd8be5d4 100644 --- a/pkg/innerring/processors/settlement/audit/prm.go +++ b/pkg/innerring/processors/settlement/audit/prm.go @@ -29,7 +29,7 @@ type ResultStorage interface { AuditResultsForEpoch(epoch uint64) ([]*audit.Result, error) } -// SGInfo groups the data about NeoFS storage group +// SGInfo groups the data about FrostFS storage group // necessary for calculating audit fee. type SGInfo interface { // Must return sum size of the all group members. diff --git a/pkg/innerring/processors/settlement/common/types.go b/pkg/innerring/processors/settlement/common/types.go index 3e0bac172..ee4ae59cd 100644 --- a/pkg/innerring/processors/settlement/common/types.go +++ b/pkg/innerring/processors/settlement/common/types.go @@ -17,7 +17,7 @@ type NodeInfo interface { PublicKey() []byte } -// ContainerInfo groups the data about NeoFS container +// ContainerInfo groups the data about FrostFS container // necessary for calculating audit fee. type ContainerInfo interface { // Must return identifier of the container owner. @@ -25,7 +25,7 @@ type ContainerInfo interface { } // ContainerStorage is an interface of -// storage of the NeoFS containers. +// storage of the FrostFS containers. type ContainerStorage interface { // Must return information about the container by ID. ContainerInfo(cid.ID) (ContainerInfo, error) diff --git a/pkg/innerring/processors/subnet/put.go b/pkg/innerring/processors/subnet/put.go index a9f2705d5..338eeab09 100644 --- a/pkg/innerring/processors/subnet/put.go +++ b/pkg/innerring/processors/subnet/put.go @@ -9,7 +9,7 @@ import ( "github.com/TrueCloudLab/frostfs-sdk-go/user" ) -// Put represents a notification about NeoFS subnet creation. +// Put represents a notification about FrostFS subnet creation. // Generated by a contract when intending to create a subnet. type Put interface { // Contains the ID of the subnet to be created. @@ -56,7 +56,7 @@ func (x PutValidator) Assert(event Put) error { } } - // read creator's user ID in NeoFS system + // read creator's user ID in FrostFS system var creator user.ID if err = event.ReadCreator(&creator); err != nil { return fmt.Errorf("read creator: %w", err) diff --git a/pkg/innerring/subnet.go b/pkg/innerring/subnet.go index 3ff2e86f5..c6f9da5f6 100644 --- a/pkg/innerring/subnet.go +++ b/pkg/innerring/subnet.go @@ -184,14 +184,14 @@ type putSubnetEvent struct { ev subnetevents.Put } -// ReadID unmarshals the subnet ID from a binary NeoFS API protocol's format. +// ReadID unmarshals the subnet ID from a binary FrostFS API protocol's format. func (x putSubnetEvent) ReadID(id *subnetid.ID) error { return id.Unmarshal(x.ev.ID()) } var errMissingSubnetOwner = errors.New("missing subnet owner") -// ReadCreator unmarshals the subnet creator from a binary NeoFS API protocol's format. +// ReadCreator unmarshals the subnet creator from a binary FrostFS API protocol's format. // Returns an error if the byte array is empty. func (x putSubnetEvent) ReadCreator(id *user.ID) error { data := x.ev.Owner() @@ -210,7 +210,7 @@ func (x putSubnetEvent) ReadCreator(id *user.ID) error { return nil } -// ReadInfo unmarshal the subnet info from a binary NeoFS API protocol's format. +// ReadInfo unmarshal the subnet info from a binary FrostFS API protocol's format. func (x putSubnetEvent) ReadInfo(info *subnet.Info) error { return info.Unmarshal(x.ev.Info()) } diff --git a/pkg/local_object_storage/blobovnicza/blobovnicza.go b/pkg/local_object_storage/blobovnicza/blobovnicza.go index 18d711b09..8cc0581c0 100644 --- a/pkg/local_object_storage/blobovnicza/blobovnicza.go +++ b/pkg/local_object_storage/blobovnicza/blobovnicza.go @@ -11,7 +11,7 @@ import ( "go.uber.org/zap" ) -// Blobovnicza represents the implementation of NeoFS Blobovnicza. +// Blobovnicza represents the implementation of FrostFS Blobovnicza. type Blobovnicza struct { cfg diff --git a/pkg/local_object_storage/blobstor/blobstor.go b/pkg/local_object_storage/blobstor/blobstor.go index 99e0f350e..3f8344c57 100644 --- a/pkg/local_object_storage/blobstor/blobstor.go +++ b/pkg/local_object_storage/blobstor/blobstor.go @@ -17,7 +17,7 @@ type SubStorage struct { Policy func(*objectSDK.Object, []byte) bool } -// BlobStor represents NeoFS local BLOB storage. +// BlobStor represents FrostFS local BLOB storage. type BlobStor struct { cfg diff --git a/pkg/local_object_storage/engine/engine.go b/pkg/local_object_storage/engine/engine.go index d5265e0ed..f34d5c0bd 100644 --- a/pkg/local_object_storage/engine/engine.go +++ b/pkg/local_object_storage/engine/engine.go @@ -13,7 +13,7 @@ import ( "go.uber.org/zap" ) -// StorageEngine represents NeoFS local storage engine. +// StorageEngine represents FrostFS local storage engine. type StorageEngine struct { *cfg diff --git a/pkg/local_object_storage/metabase/inhume.go b/pkg/local_object_storage/metabase/inhume.go index cff88f4fd..22e8e52b0 100644 --- a/pkg/local_object_storage/metabase/inhume.go +++ b/pkg/local_object_storage/metabase/inhume.go @@ -122,7 +122,7 @@ func (db *DB) Inhume(prm InhumePrm) (res InhumeRes, err error) { bkt = graveyardBKT tombKey := addressKey(*prm.tomb, make([]byte, addressKeySize)) - // it is forbidden to have a tomb-on-tomb in NeoFS, + // it is forbidden to have a tomb-on-tomb in FrostFS, // so graveyard keys must not be addresses of tombstones data := bkt.Get(tombKey) if data != nil { diff --git a/pkg/local_object_storage/shard/gc.go b/pkg/local_object_storage/shard/gc.go index e527d779c..fdfb7818e 100644 --- a/pkg/local_object_storage/shard/gc.go +++ b/pkg/local_object_storage/shard/gc.go @@ -15,10 +15,10 @@ import ( ) // TombstoneSource is an interface that checks -// tombstone status in the NeoFS network. +// tombstone status in the FrostFS network. type TombstoneSource interface { // IsTombstoneAvailable must return boolean value that means - // provided tombstone's presence in the NeoFS network at the + // provided tombstone's presence in the FrostFS network at the // time of the passed epoch. IsTombstoneAvailable(ctx context.Context, addr oid.Address, epoch uint64) bool } diff --git a/pkg/local_object_storage/shard/shard.go b/pkg/local_object_storage/shard/shard.go index 0e5845b4c..ad87d28d8 100644 --- a/pkg/local_object_storage/shard/shard.go +++ b/pkg/local_object_storage/shard/shard.go @@ -16,7 +16,7 @@ import ( "go.uber.org/zap" ) -// Shard represents single shard of NeoFS Local Storage Engine. +// Shard represents single shard of FrostFS Local Storage Engine. type Shard struct { *cfg diff --git a/pkg/morph/client/audit/client.go b/pkg/morph/client/audit/client.go index 5bb41791c..bd673f17d 100644 --- a/pkg/morph/client/audit/client.go +++ b/pkg/morph/client/audit/client.go @@ -10,7 +10,7 @@ import ( // Client is a wrapper over StaticClient // which makes calls with the names and arguments -// of the NeoFS Audit contract. +// of the FrostFS Audit contract. // // Working client must be created via constructor New. // Using the Client that has been created with new(Client) diff --git a/pkg/morph/client/audit/put_result.go b/pkg/morph/client/audit/put_result.go index fe99635dc..e75422d12 100644 --- a/pkg/morph/client/audit/put_result.go +++ b/pkg/morph/client/audit/put_result.go @@ -22,7 +22,7 @@ func (p *PutPrm) SetResult(result *auditAPI.Result) { p.result = result } -// PutAuditResult saves passed audit result structure in NeoFS system +// PutAuditResult saves passed audit result structure in FrostFS system // through Audit contract call. // // Returns encountered error that caused the saving to interrupt. diff --git a/pkg/morph/client/balance/client.go b/pkg/morph/client/balance/client.go index 1fe8e5fb1..b56684d41 100644 --- a/pkg/morph/client/balance/client.go +++ b/pkg/morph/client/balance/client.go @@ -10,7 +10,7 @@ import ( // Client is a wrapper over StaticClient // which makes calls with the names and arguments -// of the NeoFS Balance contract. +// of the FrostFS Balance contract. // // Working client must be created via constructor New. // Using the Client that has been created with new(Client) diff --git a/pkg/morph/client/container/client.go b/pkg/morph/client/container/client.go index 117fdd176..46c33fc2e 100644 --- a/pkg/morph/client/container/client.go +++ b/pkg/morph/client/container/client.go @@ -11,7 +11,7 @@ import ( // Client is a wrapper over StaticClient // which makes calls with the names and arguments -// of the NeoFS Container contract. +// of the FrostFS Container contract. // // Working client must be created via constructor New. // Using the Client that has been created with new(Client) diff --git a/pkg/morph/client/container/delete.go b/pkg/morph/client/container/delete.go index 67fc2dd26..d2a8fed87 100644 --- a/pkg/morph/client/container/delete.go +++ b/pkg/morph/client/container/delete.go @@ -52,7 +52,7 @@ func (d *DeletePrm) SetToken(token []byte) { d.token = token } -// Delete removes the container from NeoFS system +// Delete removes the container from FrostFS system // through Container contract call. // // Returns any error encountered that caused diff --git a/pkg/morph/client/container/eacl.go b/pkg/morph/client/container/eacl.go index b5853d040..f418d634e 100644 --- a/pkg/morph/client/container/eacl.go +++ b/pkg/morph/client/container/eacl.go @@ -13,7 +13,7 @@ import ( "github.com/TrueCloudLab/frostfs-sdk-go/session" ) -// GetEACL reads the extended ACL table from NeoFS system +// GetEACL reads the extended ACL table from FrostFS system // through Container contract call. // // Returns apistatus.EACLNotFound if eACL table is missing in the contract. diff --git a/pkg/morph/client/container/eacl_set.go b/pkg/morph/client/container/eacl_set.go index 19e31ace8..d62fb0186 100644 --- a/pkg/morph/client/container/eacl_set.go +++ b/pkg/morph/client/container/eacl_set.go @@ -72,7 +72,7 @@ func (p *PutEACLPrm) SetToken(token []byte) { } // PutEACL saves binary eACL table with its session token, key and signature -// in NeoFS system through Container contract call. +// in FrostFS system through Container contract call. // // Returns any error encountered that caused the saving to interrupt. func (c *Client) PutEACL(p PutEACLPrm) error { diff --git a/pkg/morph/client/container/get.go b/pkg/morph/client/container/get.go index 2c99daeda..a5c6ac242 100644 --- a/pkg/morph/client/container/get.go +++ b/pkg/morph/client/container/get.go @@ -35,7 +35,7 @@ func Get(c *Client, cnr cid.ID) (*containercore.Container, error) { return c.Get(binCnr) } -// Get reads the container from NeoFS system by binary identifier +// Get reads the container from FrostFS system by binary identifier // through Container contract call. // // If an empty slice is returned for the requested identifier, diff --git a/pkg/morph/client/container/list.go b/pkg/morph/client/container/list.go index a7afca519..d79e2a588 100644 --- a/pkg/morph/client/container/list.go +++ b/pkg/morph/client/container/list.go @@ -9,10 +9,10 @@ import ( ) // List returns a list of container identifiers belonging -// to the specified user of NeoFS system. The list is composed +// to the specified user of FrostFS system. The list is composed // through Container contract call. // -// Returns the identifiers of all NeoFS containers if pointer +// Returns the identifiers of all FrostFS containers if pointer // to user identifier is nil. func (c *Client) List(idUser *user.ID) ([]cid.ID, error) { var rawID []byte diff --git a/pkg/morph/client/container/load.go b/pkg/morph/client/container/load.go index 2de75f31f..b9876d1b5 100644 --- a/pkg/morph/client/container/load.go +++ b/pkg/morph/client/container/load.go @@ -29,7 +29,7 @@ func (a2 *AnnounceLoadPrm) SetReporter(key []byte) { } // AnnounceLoad saves container size estimation calculated by storage node -// with key in NeoFS system through Container contract call. +// with key in FrostFS system through Container contract call. // // Returns any error encountered that caused the saving to interrupt. func (c *Client) AnnounceLoad(p AnnounceLoadPrm) error { diff --git a/pkg/morph/client/container/put.go b/pkg/morph/client/container/put.go index f9acd2f7c..f4f48832e 100644 --- a/pkg/morph/client/container/put.go +++ b/pkg/morph/client/container/put.go @@ -89,7 +89,7 @@ func (p *PutPrm) SetZone(zone string) { } // Put saves binary container with its session token, key and signature -// in NeoFS system through Container contract call. +// in FrostFS system through Container contract call. // // Returns calculated container identifier and any error // encountered that caused the saving to interrupt. diff --git a/pkg/morph/client/frostfs/bind.go b/pkg/morph/client/frostfs/bind.go index 4b13d26bd..937b14062 100644 --- a/pkg/morph/client/frostfs/bind.go +++ b/pkg/morph/client/frostfs/bind.go @@ -19,7 +19,7 @@ func (x *commonBindArgs) SetOptionalPrm(op client.InvokePrmOptional) { x.InvokePrmOptional = op } -// SetScriptHash sets script hash of the NeoFS account identifier. +// SetScriptHash sets script hash of the FrostFS account identifier. func (x *commonBindArgs) SetScriptHash(v []byte) { x.scriptHash = v } @@ -34,7 +34,7 @@ type BindKeysPrm struct { commonBindArgs } -// BindKeys binds list of public keys from NeoFS account by script hash. +// BindKeys binds list of public keys from FrostFS account by script hash. func (x *Client) BindKeys(p BindKeysPrm) error { prm := client.InvokePrm{} prm.SetMethod(bindKeysMethod) @@ -55,7 +55,7 @@ type UnbindKeysPrm struct { } // UnbindKeys invokes the call of key unbinding method -// of NeoFS contract. +// of FrostFS contract. func (x *Client) UnbindKeys(args UnbindKeysPrm) error { prm := client.InvokePrm{} prm.SetMethod(unbindKeysMethod) diff --git a/pkg/morph/client/frostfs/cheque.go b/pkg/morph/client/frostfs/cheque.go index fd045751c..072b306de 100644 --- a/pkg/morph/client/frostfs/cheque.go +++ b/pkg/morph/client/frostfs/cheque.go @@ -36,7 +36,7 @@ func (c *ChequePrm) SetLock(lock util.Uint160) { c.lock = lock } -// Cheque invokes `cheque` method of NeoFS contract. +// Cheque invokes `cheque` method of FrostFS contract. func (x *Client) Cheque(p ChequePrm) error { prm := client.InvokePrm{} prm.SetMethod(chequeMethod) diff --git a/pkg/morph/client/frostfs/client.go b/pkg/morph/client/frostfs/client.go index 1db7594b5..b7f9315a5 100644 --- a/pkg/morph/client/frostfs/client.go +++ b/pkg/morph/client/frostfs/client.go @@ -27,7 +27,7 @@ const ( chequeMethod = "cheque" ) -// NewFromMorph wraps client to work with NeoFS contract. +// NewFromMorph wraps client to work with FrostFS contract. func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Client, error) { o := defaultOpts() @@ -37,7 +37,7 @@ func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, sc, err := client.NewStatic(cli, contract, fee, ([]client.StaticClientOption)(*o)...) if err != nil { - return nil, fmt.Errorf("could not create client of NeoFS contract: %w", err) + return nil, fmt.Errorf("could not create client of FrostFS contract: %w", err) } return &Client{client: sc}, nil diff --git a/pkg/morph/client/frostfsid/addrm_keys.go b/pkg/morph/client/frostfsid/addrm_keys.go index 3bfa7c645..7680e65c6 100644 --- a/pkg/morph/client/frostfsid/addrm_keys.go +++ b/pkg/morph/client/frostfsid/addrm_keys.go @@ -7,7 +7,7 @@ import ( ) type CommonBindPrm struct { - ownerID []byte // NeoFS account identifier + ownerID []byte // FrostFS account identifier keys [][]byte // list of serialized public keys @@ -18,7 +18,7 @@ func (x *CommonBindPrm) SetOptionalPrm(prm client.InvokePrmOptional) { x.InvokePrmOptional = prm } -// SetOwnerID sets NeoFS account identifier. +// SetOwnerID sets FrostFS account identifier. func (x *CommonBindPrm) SetOwnerID(v []byte) { x.ownerID = v } @@ -28,7 +28,7 @@ func (x *CommonBindPrm) SetKeys(v [][]byte) { x.keys = v } -// AddKeys adds a list of public keys to/from NeoFS account. +// AddKeys adds a list of public keys to/from FrostFS account. func (x *Client) AddKeys(p CommonBindPrm) error { prm := client.InvokePrm{} @@ -44,7 +44,7 @@ func (x *Client) AddKeys(p CommonBindPrm) error { return nil } -// RemoveKeys removes a list of public keys to/from NeoFS account. +// RemoveKeys removes a list of public keys to/from FrostFS account. func (x *Client) RemoveKeys(args CommonBindPrm) error { prm := client.InvokePrm{} diff --git a/pkg/morph/client/frostfsid/client.go b/pkg/morph/client/frostfsid/client.go index c388834bd..c8f56af6b 100644 --- a/pkg/morph/client/frostfsid/client.go +++ b/pkg/morph/client/frostfsid/client.go @@ -10,14 +10,14 @@ import ( // Client is a wrapper over StaticClient // which makes calls with the names and arguments -// of the NeoFS ID contract. +// of the FrostFS ID 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 NeoFS ID contract client + client *client.StaticClient // static FrostFS ID contract client } const ( @@ -26,7 +26,7 @@ const ( removeKeysMethod = "removeKey" ) -// NewFromMorph wraps client to work with NeoFS ID contract. +// NewFromMorph wraps client to work with FrostFS ID contract. func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Client, error) { o := defaultOpts() @@ -36,7 +36,7 @@ func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, sc, err := client.NewStatic(cli, contract, fee, ([]client.StaticClientOption)(*o)...) if err != nil { - return nil, fmt.Errorf("could not create client of NeoFS ID contract: %w", err) + return nil, fmt.Errorf("could not create client of FrostFS ID contract: %w", err) } return &Client{client: sc}, nil diff --git a/pkg/morph/client/frostfsid/keys.go b/pkg/morph/client/frostfsid/keys.go index f7d725ee5..9c1255d4d 100644 --- a/pkg/morph/client/frostfsid/keys.go +++ b/pkg/morph/client/frostfsid/keys.go @@ -19,7 +19,7 @@ func (a *AccountKeysPrm) SetID(id user.ID) { a.id = id } -// AccountKeys requests public keys of NeoFS account from NeoFS ID contract. +// AccountKeys requests public keys of FrostFS account from FrostFS ID contract. func (x *Client) AccountKeys(p AccountKeysPrm) (keys.PublicKeys, error) { prm := client.TestInvokePrm{} prm.SetMethod(keyListingMethod) diff --git a/pkg/morph/client/netmap/add_peer.go b/pkg/morph/client/netmap/add_peer.go index 5473ff50b..9b26bf45a 100644 --- a/pkg/morph/client/netmap/add_peer.go +++ b/pkg/morph/client/netmap/add_peer.go @@ -19,7 +19,7 @@ func (a *AddPeerPrm) SetNodeInfo(nodeInfo netmap.NodeInfo) { a.nodeInfo = nodeInfo } -// AddPeer registers peer in NeoFS network through +// AddPeer registers peer in FrostFS network through // Netmap contract call. func (c *Client) AddPeer(p AddPeerPrm) error { var method = addPeerMethod diff --git a/pkg/morph/client/netmap/client.go b/pkg/morph/client/netmap/client.go index 6e27896f0..6e24e6b16 100644 --- a/pkg/morph/client/netmap/client.go +++ b/pkg/morph/client/netmap/client.go @@ -13,7 +13,7 @@ type NodeInfo = netmap.NodeInfo // Client is a wrapper over StaticClient // which makes calls with the names and arguments -// of the NeoFS Netmap contract. +// of the FrostFS Netmap contract. // // Working client must be created via constructor New. // Using the Client that has been created with new(Client) diff --git a/pkg/morph/client/netmap/config.go b/pkg/morph/client/netmap/config.go index 2795555bf..c75f147a6 100644 --- a/pkg/morph/client/netmap/config.go +++ b/pkg/morph/client/netmap/config.go @@ -58,7 +58,7 @@ func (c *Client) AuditFee() (uint64, error) { return fee, nil } -// EpochDuration returns number of sidechain blocks per one NeoFS epoch. +// EpochDuration returns number of sidechain blocks per one FrostFS epoch. func (c *Client) EpochDuration() (uint64, error) { epochDuration, err := c.readUInt64Config(epochDurationConfig) if err != nil { @@ -132,7 +132,7 @@ func (c *Client) InnerRingCandidateFee() (uint64, error) { } // WithdrawFee returns global configuration value of fee paid by user to -// withdraw assets from NeoFS contract. +// withdraw assets from FrostFS contract. func (c *Client) WithdrawFee() (uint64, error) { fee, err := c.readUInt64Config(withdrawFeeConfig) if err != nil { @@ -143,7 +143,7 @@ func (c *Client) WithdrawFee() (uint64, error) { } // MaintenanceModeAllowed reads admission of "maintenance" state from the -// NeoFS network configuration stored in the Sidechain. The admission means +// FrostFS network configuration stored in the Sidechain. The admission means // that storage nodes are allowed to switch their state to "maintenance". // // By default, maintenance state is disallowed. @@ -171,7 +171,7 @@ func (c *Client) readStringConfig(key string) (string, error) { return v.(string), nil } -// reads boolean value by the given key from the NeoFS network configuration +// reads boolean value by the given key from the FrostFS network configuration // stored in the Sidechain. Returns false if key is not presented. func (c *Client) readBoolConfig(key string) (bool, error) { v, err := c.config([]byte(key), BoolAssert) @@ -221,8 +221,8 @@ func (c *Client) SetConfig(p SetConfigPrm) error { return c.client.Invoke(prm) } -// RawNetworkParameter is a NeoFS network parameter which is transmitted but -// not interpreted by the NeoFS API protocol. +// RawNetworkParameter is a FrostFS network parameter which is transmitted but +// not interpreted by the FrostFS API protocol. type RawNetworkParameter struct { // Name of the parameter. Name string @@ -231,8 +231,8 @@ type RawNetworkParameter struct { Value []byte } -// NetworkConfiguration represents NeoFS network configuration stored -// in the NeoFS Sidechain. +// NetworkConfiguration represents FrostFS network configuration stored +// in the FrostFS Sidechain. type NetworkConfiguration struct { MaxObjectSize uint64 @@ -261,7 +261,7 @@ type NetworkConfiguration struct { Raw []RawNetworkParameter } -// ReadNetworkConfiguration reads NetworkConfiguration from the NeoFS Sidechain. +// ReadNetworkConfiguration reads NetworkConfiguration from the FrostFS Sidechain. func (c *Client) ReadNetworkConfiguration() (NetworkConfiguration, error) { var res NetworkConfiguration prm := client.TestInvokePrm{} @@ -356,7 +356,7 @@ func bytesToBool(val []byte) bool { var ErrConfigNotFound = errors.New("config value not found") // config performs the test invoke of get config value -// method of NeoFS Netmap contract. +// method of FrostFS Netmap contract. // // Returns ErrConfigNotFound if config key is not found in the contract. func (c *Client) config(key []byte, assert func(stackitem.Item) (interface{}, error)) (interface{}, error) { diff --git a/pkg/morph/client/netmap/epoch.go b/pkg/morph/client/netmap/epoch.go index 1e52d750f..222ece45d 100644 --- a/pkg/morph/client/netmap/epoch.go +++ b/pkg/morph/client/netmap/epoch.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-node/pkg/morph/client" ) -// Epoch receives number of current NeoFS epoch +// Epoch receives number of current FrostFS epoch // through the Netmap contract call. func (c *Client) Epoch() (uint64, error) { prm := client.TestInvokePrm{} @@ -30,7 +30,7 @@ func (c *Client) Epoch() (uint64, error) { return uint64(num), nil } -// LastEpochBlock receives block number of current NeoFS epoch +// LastEpochBlock receives block number of current FrostFS epoch // through the Netmap contract call. func (c *Client) LastEpochBlock() (uint32, error) { prm := client.TestInvokePrm{} diff --git a/pkg/morph/client/netmap/new_epoch.go b/pkg/morph/client/netmap/new_epoch.go index df8c5f5f3..cd57c4621 100644 --- a/pkg/morph/client/netmap/new_epoch.go +++ b/pkg/morph/client/netmap/new_epoch.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-node/pkg/morph/client" ) -// NewEpoch updates NeoFS epoch number through +// NewEpoch updates FrostFS epoch number through // Netmap contract call. func (c *Client) NewEpoch(epoch uint64) error { prm := client.InvokePrm{} diff --git a/pkg/morph/client/nns.go b/pkg/morph/client/nns.go index cc3412f96..68696a5c0 100644 --- a/pkg/morph/client/nns.go +++ b/pkg/morph/client/nns.go @@ -36,7 +36,7 @@ const ( NNSReputationContractName = "reputation.frostfs" // NNSSubnetworkContractName is a name of the subnet contract in NNS. NNSSubnetworkContractName = "subnet.frostfs" - // NNSGroupKeyName is a name for the NeoFS group key record in NNS. + // NNSGroupKeyName is a name for the FrostFS group key record in NNS. NNSGroupKeyName = "group.frostfs" ) @@ -193,7 +193,7 @@ func exists(c *rpcclient.WSClient, nnsHash util.Uint160, domain string) (bool, e return !available, nil } -// SetGroupSignerScope makes the default signer scope include all NeoFS contracts. +// SetGroupSignerScope makes the default signer scope include all FrostFS contracts. // Should be called for side-chain client only. func (c *Client) SetGroupSignerScope() error { c.switchLock.RLock() @@ -213,7 +213,7 @@ func (c *Client) SetGroupSignerScope() error { return nil } -// contractGroupKey returns public key designating NeoFS contract group. +// contractGroupKey returns public key designating FrostFS contract group. func (c *Client) contractGroupKey() (*keys.PublicKey, error) { if gKey := c.cache.groupKey(); gKey != nil { return gKey, nil diff --git a/pkg/morph/client/notary.go b/pkg/morph/client/notary.go index c879e6ea4..4331a3bb4 100644 --- a/pkg/morph/client/notary.go +++ b/pkg/morph/client/notary.go @@ -569,7 +569,7 @@ func (c *Client) notaryCosigners(invokedByAlpha bool, ir []*keys.PublicKey, comm multisigScript, err := sc.CreateMultiSigRedeemScript(m, ir) if err != nil { - // wrap error as NeoFS-specific since the call is not related to any client + // wrap error as FrostFS-specific since the call is not related to any client return nil, wrapFrostFSError(fmt.Errorf("can't create ir multisig redeem script: %w", err)) } @@ -703,7 +703,7 @@ func (c *Client) notaryMultisigAccount(ir []*keys.PublicKey, committee, invokedB multisigAccount = wallet.NewAccountFromPrivateKey(c.acc.PrivateKey()) err := multisigAccount.ConvertMultisig(m, ir) if err != nil { - // wrap error as NeoFS-specific since the call is not related to any client + // wrap error as FrostFS-specific since the call is not related to any client return nil, wrapFrostFSError(fmt.Errorf("can't convert account to inner ring multisig wallet: %w", err)) } } else { @@ -712,7 +712,7 @@ func (c *Client) notaryMultisigAccount(ir []*keys.PublicKey, committee, invokedB // inner ring multiaddress witness multisigAccount, err = notary.FakeMultisigAccount(m, ir) if err != nil { - // wrap error as NeoFS-specific since the call is not related to any client + // wrap error as FrostFS-specific since the call is not related to any client return nil, wrapFrostFSError(fmt.Errorf("can't make inner ring multisig wallet: %w", err)) } } @@ -766,7 +766,7 @@ func invocationParams(args ...interface{}) ([]sc.Parameter, error) { } // sigCount returns the number of required signature. -// For NeoFS Alphabet M is a 2/3+1 of it (like in dBFT). +// For FrostFS Alphabet M is a 2/3+1 of it (like in dBFT). // If committee is true, returns M as N/2+1. func sigCount(ir []*keys.PublicKey, committee bool) int { if committee { diff --git a/pkg/morph/client/reputation/client.go b/pkg/morph/client/reputation/client.go index b0a39bbfd..2cd86ebd7 100644 --- a/pkg/morph/client/reputation/client.go +++ b/pkg/morph/client/reputation/client.go @@ -10,7 +10,7 @@ import ( // Client is a wrapper over StaticClient // which makes calls with the names and arguments -// of the NeoFS reputation contract. +// of the FrostFS reputation contract. // // Working client must be created via constructor New. // Using the Client that has been created with new(Client) diff --git a/pkg/morph/client/subnet/admin.go b/pkg/morph/client/subnet/admin.go index 4c913b2aa..72806d4a8 100644 --- a/pkg/morph/client/subnet/admin.go +++ b/pkg/morph/client/subnet/admin.go @@ -29,7 +29,7 @@ func (x *ManageAdminsPrm) SetClient() { x.client = true } -// SetSubnet sets identifier of the subnet in a binary NeoFS API protocol format. +// SetSubnet sets identifier of the subnet in a binary FrostFS API protocol format. func (x *ManageAdminsPrm) SetSubnet(id []byte) { x.subnet = id } @@ -39,7 +39,7 @@ func (x *ManageAdminsPrm) SetAdmin(key []byte) { x.admin = key } -// SetGroup sets identifier of the client group in a binary NeoFS API protocol format. +// SetGroup sets identifier of the client group in a binary FrostFS API protocol format. // Makes sense only for client admins (see ManageAdminsPrm.SetClient). func (x *ManageAdminsPrm) SetGroup(id []byte) { x.group = id @@ -48,7 +48,7 @@ func (x *ManageAdminsPrm) SetGroup(id []byte) { // ManageAdminsRes groups the resulting values of node administer methods of Subnet contract. type ManageAdminsRes struct{} -// ManageAdmins manages admin list of the NeoFS subnet through Subnet contract calls. +// ManageAdmins manages admin list of the FrostFS subnet through Subnet contract calls. func (x Client) ManageAdmins(prm ManageAdminsPrm) (*ManageAdminsPrm, error) { var method string diff --git a/pkg/morph/client/subnet/client.go b/pkg/morph/client/subnet/client.go index deecf93b4..bc3c51fac 100644 --- a/pkg/morph/client/subnet/client.go +++ b/pkg/morph/client/subnet/client.go @@ -48,7 +48,7 @@ func (x *InitPrm) SetBaseClient(base *client.Client) { x.base = base } -// SetContractAddress sets address of Subnet contract in NeoFS sidechain. +// SetContractAddress sets address of Subnet contract in FrostFS sidechain. func (x *InitPrm) SetContractAddress(addr util.Uint160) { x.addr = addr } diff --git a/pkg/morph/client/subnet/clients.go b/pkg/morph/client/subnet/clients.go index 0d4179b44..2855c0c8a 100644 --- a/pkg/morph/client/subnet/clients.go +++ b/pkg/morph/client/subnet/clients.go @@ -11,12 +11,12 @@ type UserAllowedPrm struct { args [2]interface{} } -// SetID sets identifier of the subnet in a binary NeoFS API protocol format. +// SetID sets identifier of the subnet in a binary FrostFS API protocol format. func (x *UserAllowedPrm) SetID(id []byte) { x.args[0] = id } -// SetClient sets owner ID of the client that is being checked in a binary NeoFS API protocol format. +// SetClient sets owner ID of the client that is being checked in a binary FrostFS API protocol format. func (x *UserAllowedPrm) SetClient(id []byte) { x.args[1] = id } @@ -72,17 +72,17 @@ func (x *ManageClientsPrm) SetRemove() { x.rm = true } -// SetSubnet sets identifier of the subnet in a binary NeoFS API protocol format. +// SetSubnet sets identifier of the subnet in a binary FrostFS API protocol format. func (x *ManageClientsPrm) SetSubnet(id []byte) { x.args[0] = id } -// SetGroup sets identifier of the client group in a binary NeoFS API protocol format. +// SetGroup sets identifier of the client group in a binary FrostFS API protocol format. func (x *ManageClientsPrm) SetGroup(id []byte) { x.args[1] = id } -// SetClient sets client's user ID in a binary NeoFS API protocol format. +// SetClient sets client's user ID in a binary FrostFS API protocol format. func (x *ManageClientsPrm) SetClient(id []byte) { x.args[2] = id } @@ -90,7 +90,7 @@ func (x *ManageClientsPrm) SetClient(id []byte) { // ManageClientsRes groups the resulting values of client management methods of Subnet contract. type ManageClientsRes struct{} -// ManageClients manages client list of the NeoFS subnet through Subnet contract calls. +// ManageClients manages client list of the FrostFS subnet through Subnet contract calls. func (x Client) ManageClients(prm ManageClientsPrm) (*ManageClientsRes, error) { var method string diff --git a/pkg/morph/client/subnet/delete.go b/pkg/morph/client/subnet/delete.go index 9bb5a99ab..50dca9f54 100644 --- a/pkg/morph/client/subnet/delete.go +++ b/pkg/morph/client/subnet/delete.go @@ -18,7 +18,7 @@ func (x *DeletePrm) SetTxHash(hash util.Uint256) { x.cliPrm.SetHash(hash) } -// SetID sets identifier of the subnet to be removed in a binary NeoFS API protocol format. +// SetID sets identifier of the subnet to be removed in a binary FrostFS API protocol format. func (x *DeletePrm) SetID(id []byte) { x.args[0] = id } diff --git a/pkg/morph/client/subnet/get.go b/pkg/morph/client/subnet/get.go index a7b0b57a9..cf3cc5119 100644 --- a/pkg/morph/client/subnet/get.go +++ b/pkg/morph/client/subnet/get.go @@ -11,7 +11,7 @@ type GetPrm struct { args [1]interface{} } -// SetID sets identifier of the subnet to be read in a binary NeoFS API protocol format. +// SetID sets identifier of the subnet to be read in a binary FrostFS API protocol format. func (x *GetPrm) SetID(id []byte) { x.args[0] = id } @@ -21,7 +21,7 @@ type GetRes struct { info []byte } -// Info returns information about the subnet in a binary format of NeoFS API protocol. +// Info returns information about the subnet in a binary format of FrostFS API protocol. func (x GetRes) Info() []byte { return x.info } diff --git a/pkg/morph/client/subnet/node.go b/pkg/morph/client/subnet/node.go index aa38d61c5..bdba593f7 100644 --- a/pkg/morph/client/subnet/node.go +++ b/pkg/morph/client/subnet/node.go @@ -13,7 +13,7 @@ type NodeAllowedPrm struct { args [2]interface{} } -// SetID sets identifier of the subnet of the node in a binary NeoFS API protocol format. +// SetID sets identifier of the subnet of the node in a binary FrostFS API protocol format. func (x *NodeAllowedPrm) SetID(id []byte) { x.args[0] = id } diff --git a/pkg/morph/client/subnet/put.go b/pkg/morph/client/subnet/put.go index a8ce44c99..ce0babcb5 100644 --- a/pkg/morph/client/subnet/put.go +++ b/pkg/morph/client/subnet/put.go @@ -18,17 +18,17 @@ func (x *PutPrm) SetTxHash(hash util.Uint256) { x.cliPrm.SetHash(hash) } -// SetID sets identifier of the created subnet in a binary NeoFS API protocol format. +// SetID sets identifier of the created subnet in a binary FrostFS API protocol format. func (x *PutPrm) SetID(id []byte) { x.args[0] = id } -// SetOwner sets identifier of the subnet owner in a binary NeoFS API protocol format. +// SetOwner sets identifier of the subnet owner in a binary FrostFS API protocol format. func (x *PutPrm) SetOwner(id []byte) { x.args[1] = id } -// SetInfo sets information about the created subnet in a binary NeoFS API protocol format. +// SetInfo sets information about the created subnet in a binary FrostFS API protocol format. func (x *PutPrm) SetInfo(id []byte) { x.args[2] = id } diff --git a/pkg/morph/event/container/eacl.go b/pkg/morph/event/container/eacl.go index 86e68ad7b..a852f426f 100644 --- a/pkg/morph/event/container/eacl.go +++ b/pkg/morph/event/container/eacl.go @@ -10,7 +10,7 @@ import ( ) // SetEACL represents structure of notification about -// modified eACL table coming from NeoFS Container contract. +// modified eACL table coming from FrostFS Container contract. type SetEACL struct { table []byte signature []byte @@ -25,7 +25,7 @@ type SetEACL struct { // MorphEvent implements Neo:Morph Event interface. func (SetEACL) MorphEvent() {} -// Table returns returns eACL table in a binary NeoFS API format. +// Table returns returns eACL table in a binary FrostFS API format. func (x SetEACL) Table() []byte { return x.table } diff --git a/pkg/morph/event/container/put.go b/pkg/morph/event/container/put.go index 80cab9005..596e2b68d 100644 --- a/pkg/morph/event/container/put.go +++ b/pkg/morph/event/container/put.go @@ -48,7 +48,7 @@ func (p Put) NotaryRequest() *payload.P2PNotaryRequest { return p.notaryRequest } -// PutNamed represents notification event spawned by PutNamed method from Container contract of NeoFS Morph chain. +// PutNamed represents notification event spawned by PutNamed method from Container contract of FrostFS Morph chain. type PutNamed struct { Put diff --git a/pkg/morph/event/subnet/put.go b/pkg/morph/event/subnet/put.go index 81293b6ac..f31575899 100644 --- a/pkg/morph/event/subnet/put.go +++ b/pkg/morph/event/subnet/put.go @@ -27,7 +27,7 @@ type Put struct { // MorphEvent implements Neo:Morph Event interface. func (Put) MorphEvent() {} -// ID returns identifier of the creating subnet in a binary format of NeoFS API protocol. +// ID returns identifier of the creating subnet in a binary format of FrostFS API protocol. func (x Put) ID() []byte { return x.id } @@ -37,7 +37,7 @@ func (x Put) Owner() []byte { return x.owner } -// Info returns information about the subnet in a binary format of NeoFS API protocol. +// Info returns information about the subnet in a binary format of FrostFS API protocol. func (x Put) Info() []byte { return x.info } diff --git a/pkg/morph/subscriber/subscriber.go b/pkg/morph/subscriber/subscriber.go index d4e424f1c..6be890006 100644 --- a/pkg/morph/subscriber/subscriber.go +++ b/pkg/morph/subscriber/subscriber.go @@ -205,7 +205,7 @@ func New(ctx context.Context, p *Params) (Subscriber, error) { // returns error if it is not reached that height after timeout duration. // This function is required to avoid connections to unsynced RPC nodes, because // they can produce events from the past that should not be processed by -// NeoFS nodes. +// FrostFS nodes. func awaitHeight(cli *client.Client, startFrom uint32) error { if startFrom == 0 { return nil diff --git a/pkg/network/address.go b/pkg/network/address.go index 22ea16faf..aaac8c3a0 100644 --- a/pkg/network/address.go +++ b/pkg/network/address.go @@ -18,7 +18,7 @@ import ( URIAddr strings: "127.0.0.1:8080" */ -// Address represents the NeoFS node +// Address represents the FrostFS node // network address. type Address struct { ma multiaddr.Multiaddr diff --git a/pkg/network/transport/accounting/grpc/service.go b/pkg/network/transport/accounting/grpc/service.go index 0919a1f0e..98b92f065 100644 --- a/pkg/network/transport/accounting/grpc/service.go +++ b/pkg/network/transport/accounting/grpc/service.go @@ -8,7 +8,7 @@ import ( accountingsvc "github.com/TrueCloudLab/frostfs-node/pkg/services/accounting" ) -// Server wraps NeoFS API Accounting service and +// Server wraps FrostFS API Accounting service and // provides gRPC Accounting service server interface. type Server struct { srv accountingsvc.Server diff --git a/pkg/network/transport/container/grpc/service.go b/pkg/network/transport/container/grpc/service.go index db1dbe9a1..4cb86cdf6 100644 --- a/pkg/network/transport/container/grpc/service.go +++ b/pkg/network/transport/container/grpc/service.go @@ -8,7 +8,7 @@ import ( containersvc "github.com/TrueCloudLab/frostfs-node/pkg/services/container" ) -// Server wraps NeoFS API Container service and +// Server wraps FrostFS API Container service and // provides gRPC Container service server interface. type Server struct { srv containersvc.Server diff --git a/pkg/network/transport/netmap/grpc/service.go b/pkg/network/transport/netmap/grpc/service.go index f942cd13b..de99f456b 100644 --- a/pkg/network/transport/netmap/grpc/service.go +++ b/pkg/network/transport/netmap/grpc/service.go @@ -8,7 +8,7 @@ import ( netmapsvc "github.com/TrueCloudLab/frostfs-node/pkg/services/netmap" ) -// Server wraps NeoFS API Netmap service and +// Server wraps FrostFS API Netmap service and // provides gRPC Netmap service server interface. type Server struct { srv netmapsvc.Server diff --git a/pkg/network/transport/object/grpc/service.go b/pkg/network/transport/object/grpc/service.go index 0ddfcde0d..e8e9812e2 100644 --- a/pkg/network/transport/object/grpc/service.go +++ b/pkg/network/transport/object/grpc/service.go @@ -11,7 +11,7 @@ import ( "github.com/TrueCloudLab/frostfs-node/pkg/services/util" ) -// Server wraps NeoFS API Object service and +// Server wraps FrostFS API Object service and // provides gRPC Object service server interface. type Server struct { srv objectSvc.ServiceServer diff --git a/pkg/network/transport/reputation/grpc/service.go b/pkg/network/transport/reputation/grpc/service.go index 45a03392f..05e55b41e 100644 --- a/pkg/network/transport/reputation/grpc/service.go +++ b/pkg/network/transport/reputation/grpc/service.go @@ -8,7 +8,7 @@ import ( reputationrpc "github.com/TrueCloudLab/frostfs-node/pkg/services/reputation/rpc" ) -// Server wraps NeoFS API v2 Reputation service server +// Server wraps FrostFS API v2 Reputation service server // and provides gRPC Reputation service server interface. type Server struct { srv reputationrpc.Server diff --git a/pkg/network/transport/session/grpc/service.go b/pkg/network/transport/session/grpc/service.go index e1f7e4134..595dcd2d5 100644 --- a/pkg/network/transport/session/grpc/service.go +++ b/pkg/network/transport/session/grpc/service.go @@ -8,7 +8,7 @@ import ( sessionsvc "github.com/TrueCloudLab/frostfs-node/pkg/services/session" ) -// Server wraps NeoFS API Session service and +// Server wraps FrostFS API Session service and // provides gRPC Session service server interface. type Server struct { srv sessionsvc.Server diff --git a/pkg/services/accounting/server.go b/pkg/services/accounting/server.go index b3127faba..89b6a3f3a 100644 --- a/pkg/services/accounting/server.go +++ b/pkg/services/accounting/server.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-api-go/v2/accounting" ) -// Server is an interface of the NeoFS API Accounting service server. +// Server is an interface of the FrostFS API Accounting service server. type Server interface { Balance(context.Context, *accounting.BalanceRequest) (*accounting.BalanceResponse, error) } diff --git a/pkg/services/container/announcement/load/route/placement/deps.go b/pkg/services/container/announcement/load/route/placement/deps.go index 3f3b7a94a..3aa2586d3 100644 --- a/pkg/services/container/announcement/load/route/placement/deps.go +++ b/pkg/services/container/announcement/load/route/placement/deps.go @@ -5,7 +5,7 @@ import ( "github.com/TrueCloudLab/frostfs-sdk-go/netmap" ) -// PlacementBuilder describes interface of NeoFS placement calculator. +// PlacementBuilder describes interface of FrostFS placement calculator. type PlacementBuilder interface { // BuildPlacement must compose and sort (according to a specific algorithm) // storage nodes from the container by its identifier using network map diff --git a/pkg/services/container/morph/executor.go b/pkg/services/container/morph/executor.go index de35f4686..0702ddad6 100644 --- a/pkg/services/container/morph/executor.go +++ b/pkg/services/container/morph/executor.go @@ -27,8 +27,8 @@ type Reader interface { containercore.EACLSource // List returns a list of container identifiers belonging - // to the specified user of NeoFS system. Returns the identifiers - // of all NeoFS containers if pointer to owner identifier is nil. + // to the specified user of FrostFS system. Returns the identifiers + // of all FrostFS containers if pointer to owner identifier is nil. List(*user.ID) ([]cid.ID, error) } diff --git a/pkg/services/container/server.go b/pkg/services/container/server.go index 60610f9e7..301b0bce6 100644 --- a/pkg/services/container/server.go +++ b/pkg/services/container/server.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-api-go/v2/container" ) -// Server is an interface of the NeoFS API Container service server. +// Server is an interface of the FrostFS API Container service server. type Server interface { Put(context.Context, *container.PutRequest) (*container.PutResponse, error) Get(context.Context, *container.GetRequest) (*container.GetResponse, error) diff --git a/pkg/services/netmap/executor.go b/pkg/services/netmap/executor.go index c5cead069..159645db0 100644 --- a/pkg/services/netmap/executor.go +++ b/pkg/services/netmap/executor.go @@ -24,7 +24,7 @@ type executorSvc struct { // about current node state. type NodeState interface { // Must return current node state - // in NeoFS API v2 NodeInfo structure. + // in FrostFS API v2 NodeInfo structure. LocalNodeInfo() (*netmap.NodeInfo, error) // ReadCurrentNetMap reads current local network map of the storage node @@ -34,9 +34,9 @@ type NodeState interface { } // NetworkInfo encapsulates source of the -// recent information about the NeoFS network. +// recent information about the FrostFS network. type NetworkInfo interface { - // Must return recent network information in NeoFS API v2 NetworkInfo structure. + // Must return recent network information in FrostFS API v2 NetworkInfo structure. // // If protocol version is <=2.9, MillisecondsPerBlock and network config should be unset. Dump(versionsdk.Version) (*netmapSDK.NetworkInfo, error) diff --git a/pkg/services/netmap/server.go b/pkg/services/netmap/server.go index e7dc9520b..593c2a3d1 100644 --- a/pkg/services/netmap/server.go +++ b/pkg/services/netmap/server.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-api-go/v2/netmap" ) -// Server is an interface of the NeoFS API Netmap service server. +// Server is an interface of the FrostFS API Netmap service server. type Server interface { LocalNodeInfo(context.Context, *netmap.LocalNodeInfoRequest) (*netmap.LocalNodeInfoResponse, error) NetworkInfo(context.Context, *netmap.NetworkInfoRequest) (*netmap.NetworkInfoResponse, error) diff --git a/pkg/services/object/acl/acl.go b/pkg/services/object/acl/acl.go index 2aeca4fde..78e972eae 100644 --- a/pkg/services/object/acl/acl.go +++ b/pkg/services/object/acl/acl.go @@ -98,7 +98,7 @@ func (c *Checker) CheckBasicACL(info v2.RequestInfo) bool { // StickyBitCheck validates owner field in the request if sticky bit is enabled. func (c *Checker) StickyBitCheck(info v2.RequestInfo, owner user.ID) bool { - // According to NeoFS specification sticky bit has no effect on system nodes + // According to FrostFS specification sticky bit has no effect on system nodes // for correct intra-container work with objects (in particular, replication). if info.RequestRole() == acl.RoleContainer { return true diff --git a/pkg/services/object/acl/v2/util.go b/pkg/services/object/acl/v2/util.go index de9fd1a26..a7f1b63cf 100644 --- a/pkg/services/object/acl/v2/util.go +++ b/pkg/services/object/acl/v2/util.go @@ -192,9 +192,9 @@ func assertVerb(tok sessionSDK.Object, op acl.Op) bool { return false } -// assertSessionRelation checks if given token describing the NeoFS session +// assertSessionRelation checks if given token describing the FrostFS session // relates to the given container and optional object. Missing object -// means that the context isn't bound to any NeoFS object in the container. +// means that the context isn't bound to any FrostFS object in the container. // Returns no error iff relation is correct. Criteria: // // session is bound to the given container diff --git a/pkg/services/object/delete/service.go b/pkg/services/object/delete/service.go index 4756941d2..76024a173 100644 --- a/pkg/services/object/delete/service.go +++ b/pkg/services/object/delete/service.go @@ -26,7 +26,7 @@ type NetworkInfo interface { netmap.State // Must return the lifespan of the tombstones - // in the NeoFS epochs. + // in the FrostFS epochs. TombstoneLifetime() (uint64, error) // Returns user ID of the local storage node. Result must not be nil. diff --git a/pkg/services/object/get/v2/service.go b/pkg/services/object/get/v2/service.go index 3849e2cd3..029671813 100644 --- a/pkg/services/object/get/v2/service.go +++ b/pkg/services/object/get/v2/service.go @@ -91,7 +91,7 @@ func (s *Service) GetRangeHash(ctx context.Context, req *objectV2.GetRangeHashRe return toHashResponse(req.GetBody().GetType(), res), nil } -// Head serves NeoFS API v2 compatible HEAD requests. +// Head serves ForstFS API v2 compatible HEAD requests. func (s *Service) Head(ctx context.Context, req *objectV2.HeadRequest) (*objectV2.HeadResponse, error) { resp := new(objectV2.HeadResponse) resp.SetBody(new(objectV2.HeadResponseBody)) diff --git a/pkg/services/object/internal/client/client.go b/pkg/services/object/internal/client/client.go index ff4053ff0..0ed9a8355 100644 --- a/pkg/services/object/internal/client/client.go +++ b/pkg/services/object/internal/client/client.go @@ -34,7 +34,7 @@ type commonPrm struct { xHeaders []string } -// SetClient sets base client for NeoFS API communication. +// SetClient sets base client for ForstFS API communication. // // Required parameter. func (x *commonPrm) SetClient(cli coreclient.Client) { @@ -260,7 +260,7 @@ func HeadObject(prm HeadObjectPrm) (*HeadObjectRes, error) { } if err != nil { - return nil, fmt.Errorf("read object header from NeoFS: %w", err) + return nil, fmt.Errorf("read object header from FrostFS: %w", err) } var hdr object.Object diff --git a/pkg/services/object/internal/client/doc.go b/pkg/services/object/internal/client/doc.go index f7871771d..8d7203573 100644 --- a/pkg/services/object/internal/client/doc.go +++ b/pkg/services/object/internal/client/doc.go @@ -1,5 +1,5 @@ -// Package internal provides functionality for NeoFS Node Object service communication with NeoFS network. -// The base client for accessing remote nodes via NeoFS API is a NeoFS SDK Go API client. +// Package internal provides functionality for FrostFS Node Object service communication with FrostFS network. +// The base client for accessing remote nodes via FrostFS API is a FrostFS SDK Go API client. // However, although it encapsulates a useful piece of business logic (e.g. the signature mechanism), // the Object service does not fully use the client's flexible interface. // @@ -7,5 +7,5 @@ // This allows you to concentrate the entire spectrum of the client's use in one place (this will be convenient // both when updating the base client and for evaluating the UX of SDK library). So it is expected that all // Object service packages will be limited to this package for the development of functionality requiring -// NeoFS API communication. +// FrostFS API communication. package internal diff --git a/pkg/services/object/server.go b/pkg/services/object/server.go index ac96a5ca7..cd5e81ecf 100644 --- a/pkg/services/object/server.go +++ b/pkg/services/object/server.go @@ -7,25 +7,25 @@ import ( "github.com/TrueCloudLab/frostfs-node/pkg/services/util" ) -// GetObjectStream is an interface of NeoFS API v2 compatible object streamer. +// GetObjectStream is an interface of FrostFS API v2 compatible object streamer. type GetObjectStream interface { util.ServerStream Send(*object.GetResponse) error } -// GetObjectRangeStream is an interface of NeoFS API v2 compatible payload range streamer. +// GetObjectRangeStream is an interface of FrostFS API v2 compatible payload range streamer. type GetObjectRangeStream interface { util.ServerStream Send(*object.GetRangeResponse) error } -// SearchStream is an interface of NeoFS API v2 compatible search streamer. +// SearchStream is an interface of FrostFS API v2 compatible search streamer. type SearchStream interface { util.ServerStream Send(*object.SearchResponse) error } -// PutObjectStream is an interface of NeoFS API v2 compatible client's object streamer. +// PutObjectStream is an interface of FrostFS API v2 compatible client's object streamer. type PutObjectStream interface { Send(*object.PutRequest) error CloseAndRecv() (*object.PutResponse, error) diff --git a/pkg/services/object/util/key.go b/pkg/services/object/util/key.go index 313678bb3..dfac5e553 100644 --- a/pkg/services/object/util/key.go +++ b/pkg/services/object/util/key.go @@ -41,7 +41,7 @@ func NewKeyStorage(localKey *ecdsa.PrivateKey, tokenStore SessionSource, net net } } -// SessionInfo groups information about NeoFS Object session +// SessionInfo groups information about FrostFS Object session // which is reflected in KeyStorage. type SessionInfo struct { // Session unique identifier. diff --git a/pkg/services/object_manager/tombstone/checker.go b/pkg/services/object_manager/tombstone/checker.go index f062f0c3c..d03f5ae4e 100644 --- a/pkg/services/object_manager/tombstone/checker.go +++ b/pkg/services/object_manager/tombstone/checker.go @@ -67,7 +67,7 @@ func (g *ExpirationChecker) IsTombstoneAvailable(ctx context.Context, a oid.Addr } // requested tombstone not - // found in the NeoFS network + // found in the FrostFS network return false } diff --git a/pkg/services/object_manager/tombstone/source/source.go b/pkg/services/object_manager/tombstone/source/source.go index 0debc412f..2b6796c35 100644 --- a/pkg/services/object_manager/tombstone/source/source.go +++ b/pkg/services/object_manager/tombstone/source/source.go @@ -14,7 +14,7 @@ import ( ) // Source represents wrapper over the object service that -// allows checking if a tombstone is available in NeoFS +// allows checking if a tombstone is available in FrostFS // network. // // Must be created via NewSource function. `var` and `Source{}` diff --git a/pkg/services/policer/check.go b/pkg/services/policer/check.go index 295e58d9b..e683f7776 100644 --- a/pkg/services/policer/check.go +++ b/pkg/services/policer/check.go @@ -248,11 +248,11 @@ func (p *Policer) processNodes(ctx *processPlacementContext, addrWithType object } } -// isClientErrMaintenance checks if err corresponds to NeoFS status return +// isClientErrMaintenance checks if err corresponds to FrostFS status return // which tells that node is currently under maintenance. Supports wrapped // errors. // -// Similar to client.IsErr___ errors, consider replacing to NeoFS SDK. +// Similar to client.IsErr___ errors, consider replacing to FrostFS SDK. func isClientErrMaintenance(err error) bool { switch unwrapErr(err).(type) { default: diff --git a/pkg/services/policer/policer.go b/pkg/services/policer/policer.go index e556e7959..20c3d00f8 100644 --- a/pkg/services/policer/policer.go +++ b/pkg/services/policer/policer.go @@ -210,7 +210,7 @@ func WithPool(p *ants.Pool) Option { } } -// WithNodeLoader returns option to set NeoFS node load source. +// WithNodeLoader returns option to set FrostFS node load source. func WithNodeLoader(l nodeLoader) Option { return func(c *cfg) { c.loader = l diff --git a/pkg/services/reputation/rpc/server.go b/pkg/services/reputation/rpc/server.go index af31292c7..5f81ad62b 100644 --- a/pkg/services/reputation/rpc/server.go +++ b/pkg/services/reputation/rpc/server.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-api-go/v2/reputation" ) -// Server is an interface of the NeoFS API v2 Reputation service server. +// Server is an interface of the FrostFS API v2 Reputation service server. type Server interface { AnnounceLocalTrust(context.Context, *reputation.AnnounceLocalTrustRequest) (*reputation.AnnounceLocalTrustResponse, error) AnnounceIntermediateResult(context.Context, *reputation.AnnounceIntermediateResultRequest) (*reputation.AnnounceIntermediateResultResponse, error) diff --git a/pkg/services/session/server.go b/pkg/services/session/server.go index 5942b674e..5f623b597 100644 --- a/pkg/services/session/server.go +++ b/pkg/services/session/server.go @@ -6,7 +6,7 @@ import ( "github.com/TrueCloudLab/frostfs-api-go/v2/session" ) -// Server is an interface of the NeoFS API Session service server. +// Server is an interface of the FrostFS API Session service server. type Server interface { Create(context.Context, *session.CreateRequest) (*session.CreateResponse, error) } diff --git a/pkg/services/tree/options.go b/pkg/services/tree/options.go index 3653da50c..8a3fd6fda 100644 --- a/pkg/services/tree/options.go +++ b/pkg/services/tree/options.go @@ -14,7 +14,7 @@ import ( type ContainerSource interface { container.Source - // List must return list of all the containers in the NeoFS network + // List must return list of all the containers in the FrostFS network // at the moment of a call and any error that does not allow fetching // container information. List() ([]cid.ID, error) diff --git a/pkg/services/tree/signature.go b/pkg/services/tree/signature.go index 40446226e..880e1b1ca 100644 --- a/pkg/services/tree/signature.go +++ b/pkg/services/tree/signature.go @@ -213,7 +213,7 @@ var errDENY = errors.New("DENY eACL rule") var errNoAllowRules = errors.New("not found allowing rules for the request") // checkEACL searches for the eACL rules that could be applied to the request -// (a tuple of a signer key, his NeoFS role and a request operation). +// (a tuple of a signer key, his FrostFS role and a request operation). // It does not filter the request by the filters of the eACL table since tree // requests do not contain any "object" information that could be filtered and, // therefore, filtering leads to unexpected results. diff --git a/pkg/services/tree/types.proto b/pkg/services/tree/types.proto index 2a1800a1f..590fbf3ef 100644 --- a/pkg/services/tree/types.proto +++ b/pkg/services/tree/types.proto @@ -27,7 +27,7 @@ message LogMove { // Signature of a message. message Signature { - // Serialized public key as defined in NeoFS API. + // Serialized public key as defined in FrostFS API. bytes key = 1 [json_name = "key"]; // Signature of a message body. bytes sign = 2 [json_name = "signature"]; diff --git a/pkg/services/util/sign.go b/pkg/services/util/sign.go index 7035edbd7..aebe025c0 100644 --- a/pkg/services/util/sign.go +++ b/pkg/services/util/sign.go @@ -15,7 +15,7 @@ type RequestMessage interface { GetMetaHeader() *session.RequestMetaHeader } -// ResponseMessage is an interface of NeoFS response message. +// ResponseMessage is an interface of FrostFS response message. type ResponseMessage interface { GetMetaHeader() *session.ResponseMetaHeader SetMetaHeader(*session.ResponseMetaHeader) diff --git a/pkg/util/locode/db/boltdb/db.go b/pkg/util/locode/db/boltdb/db.go index 56655841a..6a503e7ed 100644 --- a/pkg/util/locode/db/boltdb/db.go +++ b/pkg/util/locode/db/boltdb/db.go @@ -13,13 +13,13 @@ import ( // Passing incorrect parameter values will result in constructor // failure (error or panic depending on the implementation). type Prm struct { - // Path to BoltDB file with NeoFS location database. + // Path to BoltDB file with FrostFS location database. // // Must not be empty. Path string } -// DB is a descriptor of the NeoFS BoltDB location database. +// DB is a descriptor of the FrostFS BoltDB location database. // // For correct operation, DB must be created // using the constructor (New) based on the required parameters diff --git a/pkg/util/locode/db/country.go b/pkg/util/locode/db/country.go index 75adcfb6b..ccc108c17 100644 --- a/pkg/util/locode/db/country.go +++ b/pkg/util/locode/db/country.go @@ -7,7 +7,7 @@ import ( ) // CountryCode represents a country code for -// the storage in the NeoFS location database. +// the storage in the FrostFS location database. type CountryCode locodecolumn.CountryCode // CountryCodeFromString parses a string UN/LOCODE country code diff --git a/pkg/util/locode/db/db.go b/pkg/util/locode/db/db.go index 866b7536d..27bf5fc24 100644 --- a/pkg/util/locode/db/db.go +++ b/pkg/util/locode/db/db.go @@ -16,7 +16,7 @@ type SourceTable interface { IterateAll(func(locode.Record) error) error } -// DB is an interface of NeoFS location database. +// DB is an interface of FrostFS location database. type DB interface { // Must save the record by key in the database. Put(Key, Record) error @@ -25,7 +25,7 @@ type DB interface { Get(Key) (*Record, error) } -// AirportRecord represents the entry in NeoFS airport database. +// AirportRecord represents the entry in FrostFS airport database. type AirportRecord struct { // Name of the country where airport is located. CountryName string @@ -38,7 +38,7 @@ type AirportRecord struct { // when the required airport is not found. var ErrAirportNotFound = errors.New("airport not found") -// AirportDB is an interface of NeoFS airport database. +// AirportDB is an interface of FrostFS airport database. type AirportDB interface { // Must return the record by UN/LOCODE table record. // @@ -47,7 +47,7 @@ type AirportDB interface { Get(locode.Record) (*AirportRecord, error) } -// ContinentsDB is an interface of NeoFS continent database. +// ContinentsDB is an interface of FrostFS continent database. type ContinentsDB interface { // Must return continent of the geo point. PointContinent(*Point) (*Continent, error) @@ -57,7 +57,7 @@ var ErrSubDivNotFound = errors.New("subdivision not found") var ErrCountryNotFound = errors.New("country not found") -// NamesDB is an interface of the NeoFS location namespace. +// NamesDB is an interface of the FrostFS location namespace. type NamesDB interface { // Must resolve a country code to a country name. // @@ -73,7 +73,7 @@ type NamesDB interface { SubDivName(*CountryCode, string) (string, error) } -// FillDatabase generates the NeoFS location database based on the UN/LOCODE table. +// FillDatabase generates the FrostFS location database based on the UN/LOCODE table. func FillDatabase(table SourceTable, airports AirportDB, continents ContinentsDB, names NamesDB, db DB) error { return table.IterateAll(func(tableRecord locode.Record) error { if tableRecord.LOCODE.LocationCode() == "" { @@ -152,7 +152,7 @@ func FillDatabase(table SourceTable, airports AirportDB, continents ContinentsDB }) } -// LocodeRecord returns the record from the NeoFS location database +// LocodeRecord returns the record from the FrostFS location database // corresponding to the string representation of UN/LOCODE. func LocodeRecord(db DB, sLocode string) (*Record, error) { lc, err := locode.FromString(sLocode) diff --git a/pkg/util/locode/db/location.go b/pkg/util/locode/db/location.go index 8af7fabf4..9b6d6252f 100644 --- a/pkg/util/locode/db/location.go +++ b/pkg/util/locode/db/location.go @@ -7,7 +7,7 @@ import ( ) // LocationCode represents a location code for -// the storage in the NeoFS location database. +// the storage in the FrostFS location database. type LocationCode locodecolumn.LocationCode // LocationCodeFromString parses a string UN/LOCODE location code diff --git a/pkg/util/locode/db/record.go b/pkg/util/locode/db/record.go index 0898d3f34..37c0812d6 100644 --- a/pkg/util/locode/db/record.go +++ b/pkg/util/locode/db/record.go @@ -8,7 +8,7 @@ import ( locodecolumn "github.com/TrueCloudLab/frostfs-node/pkg/util/locode/column" ) -// Key represents the key in NeoFS location database. +// Key represents the key in FrostFS location database. type Key struct { cc *CountryCode @@ -43,7 +43,7 @@ func (k *Key) LocationCode() *LocationCode { return k.lc } -// Record represents the entry in NeoFS location database. +// Record represents the entry in FrostFS location database. type Record struct { countryName string