client

Documentation

Index

• Variables
• func AssertKeyResponseCallback(expectedKey []byte) func(client.ResponseMetaInfo) error
• func NodeInfoFromNetmapElement(dst *NodeInfo, info interface{ ... })
• func NodeInfoFromRawNetmapElement(dst *NodeInfo, info interface{ ... }) error
• type Client
• type NodeInfo
  • func (x NodeInfo) AddressGroup() network.AddressGroup
  • func (x *NodeInfo) PublicKey() []byte
  • func (x *NodeInfo) SetAddressGroup(v network.AddressGroup)
  • func (x *NodeInfo) SetPublicKey(v []byte)

Variables

var ErrWrongPublicKey = errors.New("public key is different from the key in the network map")

ErrWrongPublicKey is returned when the client's response is signed with a key different from the one declared in the network map.

Functions

func AssertKeyResponseCallback

func AssertKeyResponseCallback(expectedKey []byte) func(client.ResponseMetaInfo) error

AssertKeyResponseCallback returns client response callback which checks if the response was signed by expected key. Returns ErrWrongPublicKey in case of key mismatch.

func NodeInfoFromNetmapElement

func NodeInfoFromNetmapElement(dst *NodeInfo, info interface {
	PublicKey() []byte
	Addresses() network.AddressGroup
})

NodeInfoFromNetmapElement fills NodeInfo structure from the interface of parsed netmap member's descriptor.

Args must not be nil.

func NodeInfoFromRawNetmapElement

func NodeInfoFromRawNetmapElement(dst *NodeInfo, info interface {
	PublicKey() []byte
	IterateAddresses(func(string) bool)
	NumberOfAddresses() int
}) error

NodeInfoFromRawNetmapElement fills NodeInfo structure from the interface of raw netmap member's descriptor.

Args must not be nil.

Types

type Client

type Client interface {
	client.Client

	// RawForAddress must return rawclient.Client
	// for the passed network.Address.
	RawForAddress(network.Address) *rawclient.Client
}

Client is an interface of NeoFS storage node's client.

type NodeInfo

type NodeInfo struct {
	// contains filtered or unexported fields
}

NodeInfo groups information about NeoFS storage node needed for Client construction.

func (NodeInfo) AddressGroup

func (x NodeInfo) AddressGroup() network.AddressGroup

AddressGroup returns group of network addresses.

func (*NodeInfo) PublicKey

func (x *NodeInfo) PublicKey() []byte

PublicKey returns public key in a binary format.

Result must not be mutated.

func (*NodeInfo) SetAddressGroup

func (x *NodeInfo) SetAddressGroup(v network.AddressGroup)

SetAddressGroup sets group of network addresses.

func (*NodeInfo) SetPublicKey

func (x *NodeInfo) SetPublicKey(v []byte)

SetPublicKey sets public key in a binary format.

Argument must not be mutated.