name

package

v0.0.5 Latest Latest Go to latest Published: Mar 4, 2021 License: AGPL-3.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/multiverse-vcs/go-multiverse

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func TopicForPeerID(id peer.ID) string
type Payload
type Record
- func NewRecord(value []byte) *Record
- func RecordFromCBOR(data []byte) (*Record, error)
type System
- func NewSystem(ctx context.Context, host host.Host, router routing.Routing, ...) (*System, error)
type Validator
- func (v Validator) Select(key string, vals [][]byte) (int, error)
- func (v Validator) Validate(key string, value []byte) error

Constants ¶

View Source

const Namespace = "multiverse"

Namespace is the pubsub topic namespace.

Variables ¶

This section is empty.

Functions ¶

func TopicForPeerID ¶

func TopicForPeerID(id peer.ID) string

TopicForPeerID returns the topic name for the given peer id.

Types ¶

type Payload ¶

type Payload struct {
	// Value contains the payload data.
	Value []byte
	// Sequence is a version and nonce.
	Sequence uint64
}

Payload contains record data.

type Record ¶

type Record struct {
	// Signature is a signature of the payload.
	Signature []byte

	Payload
}

Record is used for record signatures.

func NewRecord ¶

func NewRecord(value []byte) *Record

NewRecord returns a new record.

func RecordFromCBOR ¶

func RecordFromCBOR(data []byte) (*Record, error)

RecordFromCBOR decodes an envelope from cbor.

func (*Record) Bytes ¶

func (r *Record) Bytes() ([]byte, error)

Bytes returns the raw bytes of the record.

func (*Record) Sign ¶

func (r *Record) Sign(key crypto.PrivKey) error

Sign creates a signature for the record payload.

func (*Record) Verify ¶

func (r *Record) Verify(key crypto.PubKey) (bool, error)

Verify checks if the signature of the payload is valid.

type System ¶

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

System performs name resolution.

func NewSystem ¶

func NewSystem(ctx context.Context, host host.Host, router routing.Routing, dstore datastore.Datastore) (*System, error)

NewNameSystem returns a new name system.

func (*System) GetValue ¶

func (s *System) GetValue(ctx context.Context, id peer.ID) (*Record, error)

GetValue returns the latest value for the topic with the given peer id.

func (*System) Publish ¶

func (s *System) Publish(ctx context.Context, key crypto.PrivKey, id cid.Cid) error

Publish advertises the given id to the topic of the peer ID from the private key.

func (*System) PutValue ¶

func (s *System) PutValue(ctx context.Context, id peer.ID, rec *Record) error

PutValue publishes the value under the topic of the given peer id.

func (*System) Resolve ¶

func (s *System) Resolve(ctx context.Context, id peer.ID) (cid.Cid, error)

Resolve returns the latest value from the topic with the given peer ID.

func (*System) Search ¶

func (s *System) Search(ctx context.Context, id peer.ID) (cid.Cid, error)

Search searches for the the latest value from the topic with the given peer ID.

func (*System) SearchValue ¶

func (s *System) SearchValue(ctx context.Context, id peer.ID) (*Record, error)