ipfs

package

v0.1.7 Latest Latest Go to latest Published: Oct 12, 2021 License: MIT Imports: 15 Imported by: 0

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

This section is empty.

This section is empty.

func HostGatewayURL() (string, error)

HostGatewayURL returns IPFS gateway URL that host is configured to use

func NormalizeGatewayURL(urlstr string) string

NormalizeGatewayURL normalizes IPFS gateway URL

func RunDaemon() error

RunDaemon runs the IPFS daemon

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

Client is the client structure

func NewClient() *Client

NewClient returns a new IPFS client instance

func NewRemoteClient(config *Config) *Client

NewRemoteClient returns a new IPFS shell client

func (client *Client) AddDir(dir string) (string, error)

func (client *Client) AddImage(manifest map[string][]byte, layers map[string][]byte) (string, error)

AddImage adds components of an image recursively

func (client *Client) Cat(path string) (io.ReadCloser, error)

Cat the content at the given path. Callers need to drain and close the returned reader after usage.

func (client *Client) GatewayURL() string

GatewayURL returns the gateway URL

func (client *Client) Get(hash, outdir string) error

Get fetches the contents and outputs into a directory

func (client *Client) List(path string) ([]*api.LsLink, error)

List entries at the given path

func (client *Client) Refs(hash string, recursive bool) (<-chan string, error)

Refs returns the refs of an IPFS hash

type Config struct {
	Host       string
	GatewayURL string
}

Config is the config for the client