ipfs

Documentation

Index

• type Client
  • func New(url string, opts ...extendedcasclient.CIDFormatOption) *Client
  • func (m *Client) Read(cid string) ([]byte, error)
  • func (m *Client) Write(content []byte) (string, error)
  • func (m *Client) WriteWithCIDFormat(content []byte, opts ...extendedcasclient.CIDFormatOption) (string, error)

Types

type Client

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

Client will write new documents to IPFS and read existing documents from IPFS based on CID. It implements Sidetree CAS interface.

func New

func New(url string, opts ...extendedcasclient.CIDFormatOption) *Client

New creates cas client. If no CID version is specified, then v1 will be used by default.

func (*Client) Read

func (m *Client) Read(cid string) ([]byte, error)

Read reads the content for the given CID from CAS. returns the contents of CID.

func (*Client) Write

func (m *Client) Write(content []byte) (string, error)

Write writes the given content to IPFS. Returns the address (CID) of the content.

func (*Client) WriteWithCIDFormat

func (m *Client) WriteWithCIDFormat(content []byte, opts ...extendedcasclient.CIDFormatOption) (string, error)

WriteWithCIDFormat writes the given content to IPFS using the provided CID format options. Returns the address (CID) of the content. TODO (#443): Support v1 CID formats (different multibases and multicodecs) other than just the IPFS default.