console

Documentation

Index

• Variables
• type Member
• type Members
• type Node
• type Nodes

Variables

var ErrNoMember = errs.Class("no such member")

ErrNoMember is a special error type that indicates about absence of member in MembersDB.

Types

type Member

type Member struct {
	ID           uuid.UUID
	Email        string
	Name         string
	PasswordHash []byte
}

Member represents some person that is invited to the MND by node owner. Member will have configurable access privileges that will define which functions and which nodes are available for him.

type Members

type Members interface {
	// Invite will create empty row in membersDB.
	Invite(ctx context.Context, member Member) error
	// Update updates all updatable fields of member.
	Update(ctx context.Context, member Member) error
	// Remove deletes member from membersDB.
	Remove(ctx context.Context, id uuid.UUID) error
	// GetByEmail will return member with specified email.
	GetByEmail(ctx context.Context, email string) (Member, error)
	// GetByID will return member with specified id.
	GetByID(ctx context.Context, id uuid.UUID) (Member, error)
}

Members exposes needed by MND MembersDB functionality.

architecture: Database

type Node

type Node struct {
	ID storj.NodeID
	// APISecret is a secret issued by storagenode, that will be main auth mechanism in MND <-> SNO api. is a secret issued by storagenode, that will be main auth mechanism in MND <-> SNO api.
	APISecret     []byte
	PublicAddress string

	// Logo is a configurable icon.
	Logo []byte
	// Tag is configured by used and could be used to group nodes. // TODO: should node have multiple tags?
	Tag string // TODO: create enum or type in future.
}

Node is a representation of storeganode, that SNO could add to the Multinode Dashboard.

type Nodes

type Nodes interface {
	// Add creates new node in NodesDB.
	Add(ctx context.Context, id storj.NodeID, apiSecret []byte, publicAddress string) error
	// GetByID return node from NodesDB by its id.
	GetByID(ctx context.Context, id storj.NodeID) (Node, error)
	// Remove removed node from NodesDB.
	Remove(ctx context.Context, id storj.NodeID) error
}

Nodes exposes needed by MND NodesDB functionality.

architecture: Database