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

Types

type SpaceClient

type SpaceClient interface {
	bcclientgo.BCClient

	Add(bcgo.Node, bcgo.MiningListener, string, string, io.Reader) (*bcgo.Reference, error)
	Amend(bcgo.Node, bcgo.MiningListener, bcgo.Channel, ...*spacego.Delta) error
	MetaForHash(bcgo.Node, []byte, spacego.MetaCallback) error
	AllMetas(bcgo.Node, spacego.MetaCallback) error
	ReadFile(bcgo.Node, []byte) (io.Reader, error)
	WriteFile(bcgo.Node, bcgo.MiningListener, []byte) (io.WriteCloser, error)
	WatchFile(context.Context, bcgo.Node, []byte, func())

	AddTag(bcgo.Node, bcgo.MiningListener, []byte, []string) ([]*bcgo.Reference, error)
	AllTagsForHash(bcgo.Node, []byte, spacego.TagCallback) error

	SearchMeta(bcgo.Node, spacego.MetaFilter, spacego.MetaCallback) error
	SearchTag(bcgo.Node, spacego.TagFilter, spacego.MetaCallback) error

	Registration(string, financego.RegistrationCallback) error
	Subscription(string, financego.SubscriptionCallback) error
}

func NewSpaceClient

func NewSpaceClient(peers ...string) SpaceClient