ipfs

package

v1.0.0 Latest Latest Go to latest Published: Jul 14, 2023 License: Apache-2.0 Imports: 14 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/trustbloc/orb

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func New(url string, timeout time.Duration, cacheSize int, metrics metricsProvider, ...) *Client

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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, timeout time.Duration, cacheSize int, metrics metricsProvider, opts ...extendedcasclient.CIDFormatOption) *Client

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

func (*Client) GetPrimaryWriterType ¶ added in v0.1.3

func (m *Client) GetPrimaryWriterType() string

GetPrimaryWriterType returns primary writer type.

func (*Client) Read ¶

func (m *Client) Read(cidOrHash 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 ¶ added in v0.1.2

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.

Source Files ¶

View all Source files

ipfs.go

Directories ¶

Path	Synopsis
mocks Code generated by counterfeiter.	Code generated by counterfeiter.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL