[#1] Fix comments and error messages

Signed-off-by: Stanislav Bogatyrev <s.bogatyrev@yadro.com>
This commit is contained in:
Stanislav Bogatyrev 2023-02-05 18:59:38 +03:00 committed by Stanislav Bogatyrev
parent c761a95eef
commit cb016d53a6
96 changed files with 167 additions and 167 deletions

View file

@ -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:

View file

@ -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)

View file

@ -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.

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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)

View file

@ -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)