frostfs-node/pkg/morph/client/netmap/client.go
Stanislav Bogatyrev cb016d53a6 [#1] Fix comments and error messages
Signed-off-by: Stanislav Bogatyrev <s.bogatyrev@yadro.com>
2023-02-06 17:41:14 +03:00

98 lines
2.5 KiB
Go

package netmap
import (
"fmt"
"github.com/TrueCloudLab/frostfs-node/pkg/morph/client"
"github.com/TrueCloudLab/frostfs-sdk-go/netmap"
"github.com/nspcc-dev/neo-go/pkg/encoding/fixedn"
"github.com/nspcc-dev/neo-go/pkg/util"
)
type NodeInfo = netmap.NodeInfo
// Client is a wrapper over StaticClient
// which makes calls with the names and arguments
// of the FrostFS Netmap 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 Netmap contract client
}
const (
addPeerMethod = "addPeer"
configMethod = "config"
epochMethod = "epoch"
lastEpochBlockMethod = "lastEpochBlock"
innerRingListMethod = "innerRingList"
netMapCandidatesMethod = "netmapCandidates"
netMapMethod = "netmap"
newEpochMethod = "newEpoch"
setConfigMethod = "setConfig"
updateInnerRingMethod = "updateInnerRing"
snapshotMethod = "snapshot"
updateStateMethod = "updateState"
epochSnapshotMethod = "snapshotByEpoch"
configListMethod = "listConfig"
)
// NewFromMorph returns the wrapper instance from the raw morph client.
func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Client, error) {
o := defaultOpts()
for i := range opts {
opts[i](o)
}
sc, err := client.NewStatic(cli, contract, fee, ([]client.StaticClientOption)(*o)...)
if err != nil {
return nil, fmt.Errorf("can't create netmap static client: %w", err)
}
return &Client{client: sc}, nil
}
// Option allows to set an optional
// parameter of Wrapper.
type Option func(*opts)
type opts []client.StaticClientOption
func defaultOpts() *opts {
return new(opts)
}
// TryNotary returns option to enable
// notary invocation tries.
func TryNotary() Option {
return func(o *opts) {
*o = append(*o, client.TryNotary())
}
}
// AsAlphabet returns option to sign main TX
// of notary requests with client's private
// key.
//
// Considered to be used by IR nodes only.
func AsAlphabet() Option {
return func(o *opts) {
*o = append(*o, client.AsAlphabet())
}
}
// ContractAddress returns the address of the associated contract.
func (c Client) ContractAddress() util.Uint160 {
return c.client.ContractAddress()
}
// Morph returns raw morph client.
func (c Client) Morph() *client.Client {
return c.client.Morph()
}