spaceclientgo

README

spaceclientgo

This is a Go implementation of a S P A C E client - secure, private, storage.

About

spaceclientgo provides utilities and a command line interface to explore and interact with S P A C E.

Build

go build -tags release

Install

Install the binary (or download from https://github.com/AletheiaWareLLC/spaceclientgo/releases/latest)

go install -tags release aletheiaware.com/spaceclientgo/cmd/space

Usage

$ space
Space Usage:
    space - display usage
    space init - initializes environment, generates key pair, and registers alias

    space add [name] [type] - read stdin and mine a new record into blockchain
    space add [name] [type] [file] - read file and mine a new record into blockchain

    space list - prints all files created by this key
    space list [type] - display metadata of all files with given MIME type
    space show [hash] - display metadata of file with given hash
    space get [hash] - write file with given hash to stdout
    space get [hash] [file] - write file with given hash to file
    space get-all [directory] - write all files to given directory

    space tag [hash] [tag...] - tags file with given hash with given tags
    space search [tag...] - search files for given tags

    space registration [merchant] - display registration information between this alias and the given merchant
    space subscription [merchant] - display subscription information between this alias and the given merchant

    space registrars - display registration and subscription information of this alias' registrars

Documentation

Index

• type SpaceClient
  • func NewSpaceClient(peers ...string) *SpaceClient
  • func (c *SpaceClient) Add(node *bcgo.Node, listener bcgo.MiningListener, name, mime string, ...) (*bcgo.Reference, error)
  • func (c *SpaceClient) AddTag(node *bcgo.Node, listener bcgo.MiningListener, metaId []byte, tag []string) ([]*bcgo.Reference, error)
  • func (c *SpaceClient) Append(node *bcgo.Node, listener bcgo.MiningListener, deltas *bcgo.Channel, ...) error
  • func (c *SpaceClient) GetMeta(node *bcgo.Node, recordHash []byte, callback spacego.MetaCallback) error
  • func (c *SpaceClient) GetRegistration(merchant string, callback financego.RegistrationCallback) error
  • func (c *SpaceClient) GetSubscription(merchant string, callback financego.SubscriptionCallback) error
  • func (c *SpaceClient) GetTag(node *bcgo.Node, metaId []byte, ...) error
  • func (c *SpaceClient) Init(listener bcgo.MiningListener) (*bcgo.Node, error)
  • func (c *SpaceClient) List(node *bcgo.Node, callback spacego.MetaCallback) error
  • func (c *SpaceClient) ReadFile(node *bcgo.Node, metaId []byte) (io.Reader, error)
  • func (c *SpaceClient) Search(node *bcgo.Node, terms []string, callback spacego.MetaCallback) error

Types

type SpaceClient

type SpaceClient struct {
	bcclientgo.BCClient
}

func NewSpaceClient

func NewSpaceClient(peers ...string) *SpaceClient

func (*SpaceClient) Add

func (c *SpaceClient) Add(node *bcgo.Node, listener bcgo.MiningListener, name, mime string, reader io.Reader) (*bcgo.Reference, error)

Adds file

func (*SpaceClient) AddTag

func (c *SpaceClient) AddTag(node *bcgo.Node, listener bcgo.MiningListener, metaId []byte, tag []string) ([]*bcgo.Reference, error)

AddTag adds the given tag for the file with the given hash

func (*SpaceClient) Append

func (c *SpaceClient) Append(node *bcgo.Node, listener bcgo.MiningListener, deltas *bcgo.Channel, acl map[string]*rsa.PublicKey, delta *spacego.Delta) error

Append adds the given delta to the file

func (*SpaceClient) GetMeta

func (c *SpaceClient) GetMeta(node *bcgo.Node, recordHash []byte, callback spacego.MetaCallback) error

GetMeta owned by key with given hash

func (*SpaceClient) GetRegistration

func (c *SpaceClient) GetRegistration(merchant string, callback financego.RegistrationCallback) error

GetRegistration triggers the given callback for the most recent registration with the given merchant.

func (*SpaceClient) GetSubscription

func (c *SpaceClient) GetSubscription(merchant string, callback financego.SubscriptionCallback) error

GetSubscription triggers the given callback for the most recent subscription with the given merchant.

func (*SpaceClient) GetTag

func (c *SpaceClient) GetTag(node *bcgo.Node, metaId []byte, callback func(entry *bcgo.BlockEntry, tag *spacego.Tag)) error

GetTag returns all tags for the file with the given hash

func (*SpaceClient) Init

func (c *SpaceClient) Init(listener bcgo.MiningListener) (*bcgo.Node, error)

func (*SpaceClient) List

func (c *SpaceClient) List(node *bcgo.Node, callback spacego.MetaCallback) error

List files owned by key

func (*SpaceClient) ReadFile

func (c *SpaceClient) ReadFile(node *bcgo.Node, metaId []byte) (io.Reader, error)

ReadFile with the given hash

func (*SpaceClient) Search

func (c *SpaceClient) Search(node *bcgo.Node, terms []string, callback spacego.MetaCallback) error

Search files owned by key