ipfshttp

Documentation

Overview

Package ipfshttp implements an IPFS Cluster IPFSConnector component. It uses the IPFS HTTP API to communicate to IPFS.

Index

• Constants
• type Config
  • func (cfg *Config) ConfigKey() string
  • func (cfg *Config) Default() error
  • func (cfg *Config) LoadJSON(raw []byte) error
  • func (cfg *Config) ToJSON() (raw []byte, err error)
  • func (cfg *Config) Validate() error
• type Connector
  • func NewConnector(cfg *Config) (*Connector, error)
  • func (ipfs *Connector) ConfigKey(keypath string) (interface{}, error)
  • func (ipfs *Connector) ConnectSwarms() error
  • func (ipfs *Connector) FreeSpace() (uint64, error)
  • func (ipfs *Connector) ID() (api.IPFSID, error)
  • func (ipfs *Connector) Pin(hash *cid.Cid) error
  • func (ipfs *Connector) PinLs(typeFilter string) (map[string]api.IPFSPinStatus, error)
  • func (ipfs *Connector) PinLsCid(hash *cid.Cid) (api.IPFSPinStatus, error)
  • func (ipfs *Connector) RepoSize() (uint64, error)
  • func (ipfs *Connector) SetClient(c *rpc.Client)
  • func (ipfs *Connector) Shutdown() error
  • func (ipfs *Connector) Unpin(hash *cid.Cid) error

Constants

const (
	DefaultProxyAddr              = "/ip4/127.0.0.1/tcp/9095"
	DefaultNodeAddr               = "/ip4/127.0.0.1/tcp/5001"
	DefaultConnectSwarmsDelay     = 30 * time.Second
	DefaultProxyReadTimeout       = 10 * time.Minute
	DefaultProxyReadHeaderTimeout = 5 * time.Second
	DefaultProxyWriteTimeout      = 10 * time.Minute
	DefaultProxyIdleTimeout       = 60 * time.Second
)

Default values for Config.

Types

type Config

type Config struct {
	config.Saver

	// Listen parameters for the IPFS Proxy. Used by the IPFS
	// connector component.
	ProxyAddr ma.Multiaddr

	// Host/Port for the IPFS daemon.
	NodeAddr ma.Multiaddr

	// ConnectSwarmsDelay specifies how long to wait after startup before
	// attempting to open connections from this peer's IPFS daemon to the
	// IPFS daemons of other peers.
	ConnectSwarmsDelay time.Duration

	// Maximum duration before timing out reading a full request
	ProxyReadTimeout time.Duration
	// Maximum duration before timing out reading the headers of a request
	ProxyReadHeaderTimeout time.Duration

	// Maximum duration before timing out write of the response
	ProxyWriteTimeout time.Duration

	// Server-side amount of time a Keep-Alive connection will be
	// kept idle before being reused
	ProxyIdleTimeout time.Duration
}

Config is used to initialize a Connector and allows to customize its behaviour. It implements the config.ComponentConfig interface.

func (*Config) ConfigKey

func (cfg *Config) ConfigKey() string

ConfigKey provides a human-friendly identifier for this type of Config.

func (*Config) Default

func (cfg *Config) Default() error

Default sets the fields of this Config to sensible default values.

func (*Config) LoadJSON

func (cfg *Config) LoadJSON(raw []byte) error

LoadJSON parses a JSON representation of this Config as generated by ToJSON.

func (*Config) ToJSON

func (cfg *Config) ToJSON() (raw []byte, err error)

ToJSON generates a human-friendly JSON representation of this Config.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks that the fields of this Config have sensible values, at least in appearance.

type Connector

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

Connector implements the IPFSConnector interface and provides a component which does two tasks:

On one side, it proxies HTTP requests to the configured IPFS daemon. It is able to intercept these requests though, and perform extra operations on them.

On the other side, it is used to perform on-demand requests against the configured IPFS daemom (such as a pin request).

func NewConnector

func NewConnector(cfg *Config) (*Connector, error)

NewConnector creates the component and leaves it ready to be started

func (*Connector) ConfigKey

func (ipfs *Connector) ConfigKey(keypath string) (interface{}, error)

ConfigKey fetches the IPFS daemon configuration and retrieves the value for a given configuration key. For example, "Datastore/StorageMax" will return the value for StorageMax in the Datastore configuration object.

func (*Connector) ConnectSwarms

func (ipfs *Connector) ConnectSwarms() error

ConnectSwarms requests the ipfs addresses of other peers and triggers ipfs swarm connect requests

func (*Connector) FreeSpace

func (ipfs *Connector) FreeSpace() (uint64, error)

FreeSpace returns the amount of unused space in the ipfs repository. This value is derived from the RepoSize and StorageMax values given by "repo stats". The value is in bytes.

func (*Connector) ID

func (ipfs *Connector) ID() (api.IPFSID, error)

ID performs an ID request against the configured IPFS daemon. It returns the fetched information. If the request fails, or the parsing fails, it returns an error and an empty IPFSID which also contains the error message.

func (*Connector) Pin

func (ipfs *Connector) Pin(hash *cid.Cid) error

Pin performs a pin request against the configured IPFS daemon.

func (*Connector) PinLs

func (ipfs *Connector) PinLs(typeFilter string) (map[string]api.IPFSPinStatus, error)

PinLs performs a "pin ls --type typeFilter" request against the configured IPFS daemon and returns a map of cid strings and their status.

func (*Connector) PinLsCid

func (ipfs *Connector) PinLsCid(hash *cid.Cid) (api.IPFSPinStatus, error)

PinLsCid performs a "pin ls --type=recursive <hash> "request and returns an api.IPFSPinStatus for that hash.

func (*Connector) RepoSize

func (ipfs *Connector) RepoSize() (uint64, error)

RepoSize returns the current repository size of the ipfs daemon as provided by "repo stats". The value is in bytes.

func (*Connector) SetClient

func (ipfs *Connector) SetClient(c *rpc.Client)

SetClient makes the component ready to perform RPC requests.

func (*Connector) Shutdown

func (ipfs *Connector) Shutdown() error

Shutdown stops any listeners and stops the component from taking any requests.

func (*Connector) Unpin

func (ipfs *Connector) Unpin(hash *cid.Cid) error

Unpin performs an unpin request against the configured IPFS daemon.