frostfs-sdk-go/reputation/doc.go
Evgenii Stratonikov 84888854ab [#322] *: Go fmt -s
go1.19 rewrites comments to proper render them in docs.

Signed-off-by: Evgenii Stratonikov <evgeniy@nspcc.ru>
2022-08-24 18:58:59 +03:00

35 lines
997 B
Go

/*
Package reputation collects functionality related to the NeoFS reputation system.
The functionality is based on the system described in the NeoFS specification.
Trust type represents simple instances of trust values. PeerToPeerTrust extends
Trust to support the direction of trust, i.e. from whom to whom. GlobalTrust
is designed as a global measure of trust in a network member. See the docs
for each type for details.
Instances can be also used to process NeoFS API V2 protocol messages
(see neo.fs.v2.reputation package in https://github.com/nspcc-dev/neofs-api).
On client side:
import "github.com/nspcc-dev/neofs-api-go/v2/reputation"
var msg reputation.GlobalTrust
trust.WriteToV2(&msg)
// send trust
On server side:
// recv msg
var trust reputation.GlobalTrust
trust.ReadFromV2(msg)
// process trust
Using package types in an application is recommended to potentially work with
different protocol versions with which these types are compatible.
*/
package reputation