bee

Documentation

Index

• type Client
  • func NewBeeClient(apiUrl, postageBlockId string, shouldPin bool, logger logging.Logger) *Client
  • func (s *Client) CheckConnection() bool
  • func (s *Client) CreateTag(address []byte) (uint32, error)
  • func (*Client) DeleteReference(address []byte) error
  • func (s *Client) DownloadBlob(address []byte) ([]byte, int, error)
  • func (s *Client) DownloadBzz(address []byte) ([]byte, int, error)
  • func (s *Client) DownloadChunk(ctx context.Context, address []byte) (data []byte, err error)
  • func (s *Client) GetTag(tag uint32) (int64, int64, int64, error)
  • func (s *Client) UploadBlob(data []byte, tag uint32, encrypt bool) (address []byte, err error)
  • func (s *Client) UploadBzz(data []byte, fileName string) (address []byte, err error)
  • func (s *Client) UploadChunk(ch swarm.Chunk) (address []byte, err error)
  • func (s *Client) UploadSOC(owner, id, signature string, data []byte) (address []byte, err error)

Types

type Client

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

Client is a bee http client that satisfies blockstore.Client

func NewBeeClient

func NewBeeClient(apiUrl, postageBlockId string, shouldPin bool, logger logging.Logger) *Client

NewBeeClient creates a new client which connects to the Swarm bee node to access the Swarm network.

func (*Client) CheckConnection

func (s *Client) CheckConnection() bool

CheckConnection is used to check if the bee client is up and running.

func (*Client) CreateTag

func (s *Client) CreateTag(address []byte) (uint32, error)

CreateTag creates a tag for given address

func (*Client) DeleteReference

func (*Client) DeleteReference(address []byte) error

DeleteReference unpins a reference so that it will be garbage collected by the Swarm network.

func (*Client) DownloadBlob

func (s *Client) DownloadBlob(address []byte) ([]byte, int, error)

DownloadBlob downloads a blob of binary data from the Swarm network.

func (*Client) DownloadBzz

func (s *Client) DownloadBzz(address []byte) ([]byte, int, error)

DownloadBzz downloads bzz data from the Swarm network.

func (*Client) DownloadChunk

func (s *Client) DownloadChunk(ctx context.Context, address []byte) (data []byte, err error)

DownloadChunk downloads a chunk with given address from the Swarm network

func (*Client) GetTag

func (s *Client) GetTag(tag uint32) (int64, int64, int64, error)

GetTag gets sync status of a given tag

func (*Client) UploadBlob

func (s *Client) UploadBlob(data []byte, tag uint32, encrypt bool) (address []byte, err error)

UploadBlob uploads a binary blob of data to Swarm network. It also optionally pins and encrypts the data.

func (*Client) UploadBzz

func (s *Client) UploadBzz(data []byte, fileName string) (address []byte, err error)

UploadBzz uploads a file through bzz api

func (*Client) UploadChunk

func (s *Client) UploadChunk(ch swarm.Chunk) (address []byte, err error)

UploadChunk uploads a chunk to Swarm network.

func (*Client) UploadSOC

func (s *Client) UploadSOC(owner, id, signature string, data []byte) (address []byte, err error)

UploadSOC is used construct and send a Single Owner Chunk to the Swarm bee client.