wrapper

Documentation

Index

• func AsContainerSource(w *Wrapper) core.Source
• func Delete(w *Wrapper, witness core.RemovalWitness) error
• func Get(w *Wrapper, cid *cid.ID) (*container.Container, error)
• func Put(w *Wrapper, cnr *container.Container) (*cid.ID, error)
• func PutEACL(w *Wrapper, table *eacl.Table) error
• type Estimation
• type EstimationID
• type Estimations
• type Option
  • func AsAlphabet() Option
  • func TryNotary() Option
• type Wrapper
  • func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Wrapper, error)
  • func (w *Wrapper) AnnounceLoad(a container.UsedSpaceAnnouncement, key []byte) error
  • func (w *Wrapper) Delete(cid, signature, token []byte) error
  • func (w *Wrapper) Get(cid []byte) (*container.Container, error)
  • func (w *Wrapper) GetEACL(cid *cid.ID) (*eacl.Table, error)
  • func (w *Wrapper) GetUsedSpaceEstimations(id EstimationID) (*Estimations, error)
  • func (w *Wrapper) List(ownerID *owner.ID) ([]*cid.ID, error)
  • func (w *Wrapper) ListLoadEstimationsByEpoch(epoch uint64) ([]EstimationID, error)
  • func (w Wrapper) Morph() *client.Client
  • func (w *Wrapper) Put(cnr, key, sig, token []byte, name, zone string) error
  • func (w *Wrapper) PutEACL(table, key, sig, token []byte) error
  • func (w *Wrapper) StartEstimation(epoch uint64) error
  • func (w *Wrapper) StopEstimation(epoch uint64) error

Functions

func AsContainerSource

func AsContainerSource(w *Wrapper) core.Source

AsContainerSource provides container Source interface from Wrapper instance.

func Delete

func Delete(w *Wrapper, witness core.RemovalWitness) error

Delete marshals container ID, and passes it to Wrapper's Delete method along with signature and session token.

Returns error if container ID is nil.

func Get

func Get(w *Wrapper, cid *cid.ID) (*container.Container, error)

Get marshals container ID, and passes it to Wrapper's Get method.

Returns error if cid is nil.

func Put

func Put(w *Wrapper, cnr *container.Container) (*cid.ID, error)

Put marshals container, and passes it to Wrapper's Put method along with sig.Key() and sig.Sign().

Returns error if container is nil.

func PutEACL

func PutEACL(w *Wrapper, table *eacl.Table) error

PutEACL marshals table, and passes it to Wrapper's PutEACLBinary method along with sig.Key() and sig.Sign().

Returns error if table is nil.

If TryNotary is provided, calls notary contract.

Types

type Estimation

type Estimation struct {
	Size uint64

	Reporter []byte
}

Estimation is a structure of single container load estimation reported by storage node.

type EstimationID

type EstimationID []byte

EstimationID is an identity of container load estimation inside Container contract.

type Estimations

type Estimations struct {
	ContainerID *cid.ID

	Values []Estimation
}

Estimations is a structure of grouped container load estimation inside Container contract.

type Option

type Option func(*opts)

Option allows to set an optional parameter of Wrapper.

func AsAlphabet

func AsAlphabet() Option

AsAlphabet returns option to sign main TX of notary requests with client's private key.

Considered to be used by IR nodes only.

func TryNotary

func TryNotary() Option

TryNotary returns option to enable notary invocation tries.

type Wrapper

type Wrapper struct {
	internal.StaticClient
	// contains filtered or unexported fields
}

Wrapper is a wrapper over container contract client which implements container storage and eACL storage methods.

Working wrapper must be created via constructor New. Using the Wrapper that has been created with new(Wrapper) expression (or just declaring a Wrapper variable) is unsafe and can lead to panic.

func NewFromMorph

func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Wrapper, error)

NewFromMorph returns the wrapper instance from the raw morph client.

func (*Wrapper) AnnounceLoad

func (w *Wrapper) AnnounceLoad(a container.UsedSpaceAnnouncement, key []byte) error

AnnounceLoad saves container size estimation calculated by storage node with key in NeoFS system through Container contract call.

Returns any error encountered that caused the saving to interrupt.

func (*Wrapper) Delete

func (w *Wrapper) Delete(cid, signature, token []byte) error

Delete removes the container from NeoFS system through Container contract call.

Returns any error encountered that caused the removal to interrupt.

If TryNotary is provided, calls notary contract.

func (*Wrapper) Get

func (w *Wrapper) Get(cid []byte) (*container.Container, error)

Get reads the container from NeoFS system by binary identifier through Container contract call.

If an empty slice is returned for the requested identifier, storage.ErrNotFound error is returned.

func (*Wrapper) GetEACL

func (w *Wrapper) GetEACL(cid *cid.ID) (*eacl.Table, error)

GetEACL reads the extended ACL table from NeoFS system through Container contract call.

func (*Wrapper) GetUsedSpaceEstimations

func (w *Wrapper) GetUsedSpaceEstimations(id EstimationID) (*Estimations, error)

GetUsedSpaceEstimations returns a list of container load estimations by ID. The list is composed through Container contract call.

func (*Wrapper) List

func (w *Wrapper) List(ownerID *owner.ID) ([]*cid.ID, error)

List returns a list of container identifiers belonging to the specified owner of NeoFS system. The list is composed through Container contract call.

Returns the identifiers of all NeoFS containers if pointer to owner identifier is nil.

func (*Wrapper) ListLoadEstimationsByEpoch

func (w *Wrapper) ListLoadEstimationsByEpoch(epoch uint64) ([]EstimationID, error)

ListLoadEstimationsByEpoch returns a list of container load estimations for to the specified epoch. The list is composed through Container contract call.

func (Wrapper) Morph

func (w Wrapper) Morph() *client.Client

Morph returns raw morph client.

func (*Wrapper) Put

func (w *Wrapper) Put(cnr, key, sig, token []byte, name, zone string) error

Put saves binary container with its session token, key and signature in NeoFS system through Container contract call.

Returns calculated container identifier and any error encountered that caused the saving to interrupt.

If TryNotary is provided, calls notary contract.

func (*Wrapper) PutEACL

func (w *Wrapper) PutEACL(table, key, sig, token []byte) error

PutEACL saves binary eACL table with its session token, key and signature in NeoFS system through Container contract call.

Returns any error encountered that caused the saving to interrupt.

func (*Wrapper) StartEstimation

func (w *Wrapper) StartEstimation(epoch uint64) error

StartEstimation votes to produce start estimation notification.

func (*Wrapper) StopEstimation

func (w *Wrapper) StopEstimation(epoch uint64) error

StopEstimation votes to produce stop estimation notification.