ipfslite

README

IPFS-Lite

IPFS-Lite is an embeddable, lightweight IPFS peer which runs the minimal setup to provide an ipld.DAGService and UnixFS-files addition and retrieval.

It can:

• Add, Get, Remove IPLD Nodes to/from the IPFS Network (remove is a local blockstore operation).
• Add single files (chunk, build the DAG and Add) from a io.Reader.
• Get single files given a their CID.

It needs:

• A libp2p Host
• A libp2p DHT
• A datastore, such as BadgerDB, go-ds-flatfs or an in-memory one.

Some helper functions are provided to initialize these quickly.

It provides:

• An ipld.DAGService.
• An AddFile method to add content from a reader.
• A GetFile method to get a file from IPFS.

The goal of IPFS-Lite is to run the bare minimal functionality for any IPLD-based application to interact with the IPFS Network by getting and putting blocks to it, rather than having to deal with the complexities of using a full IPFS daemon, and with the liberty of sharing the needed libp2p Host and DHT for other things.

License

Apache 2.0

Documentation

Overview

Package ipfslite is a lightweight IPFS peer which runs the minimal setup to provide an `ipld.DAGService`, "Add" and "Get" UnixFS files from IPFS.

Index

• Variables
• func DefaultBootstrapPeers() []peer.AddrInfo
• func NewInMemoryDatastore() datastore.Batching
• func SetupLibp2p(ctx context.Context, hostKey crypto.PrivKey, secret pnet.PSK, ...) (host.Host, *dualdht.DHT, error)
• type AddParams
• type Config
• type Peer
  • func New(ctx context.Context, datastore datastore.Batching, ...) (*Peer, error)
  • func (p *Peer) AddFile(ctx context.Context, r io.Reader, params *AddParams) (ipld.Node, error)
  • func (p *Peer) BlockService() blockservice.BlockService
  • func (p *Peer) BlockStore() blockstore.Blockstore
  • func (p *Peer) Bootstrap(peers []peer.AddrInfo)
  • func (p *Peer) Exchange() exchange.Interface
  • func (p *Peer) GetFile(ctx context.Context, c cid.Cid) (ufsio.ReadSeekCloser, error)
  • func (p *Peer) HasBlock(ctx context.Context, c cid.Cid) (bool, error)
  • func (p *Peer) Session(ctx context.Context) ipld.NodeGetter

Variables

var Libp2pOptionsExtra = []libp2p.Option{
	libp2p.NATPortMap(),
	libp2p.ConnectionManager(connMgr),

	libp2p.EnableNATService(),
}

Libp2pOptionsExtra provides some useful libp2p options to create a fully featured libp2p host. It can be used with SetupLibp2p.

Functions

func DefaultBootstrapPeers

func DefaultBootstrapPeers() []peer.AddrInfo

DefaultBootstrapPeers returns the default bootstrap peers (for use with NewLibp2pHost.

func NewInMemoryDatastore

func NewInMemoryDatastore() datastore.Batching

NewInMemoryDatastore provides a sync datastore that lives in-memory only and is not persisted.

func SetupLibp2p

func SetupLibp2p(
	ctx context.Context,
	hostKey crypto.PrivKey,
	secret pnet.PSK,
	listenAddrs []multiaddr.Multiaddr,
	ds datastore.Batching,
	opts ...libp2p.Option,
) (host.Host, *dualdht.DHT, error)

SetupLibp2p returns a routed host and DHT instances that can be used to easily create a ipfslite Peer. You may consider to use Peer.Bootstrap() after creating the IPFS-Lite Peer to connect to other peers. When the datastore parameter is nil, the DHT will use an in-memory datastore, so all provider records are lost on program shutdown.

Additional libp2p options can be passed. Note that the Identity, ListenAddrs and PrivateNetwork options will be setup automatically. Interesting options to pass: NATPortMap() EnableAutoRelay*(), libp2p.EnableNATService(), DisableRelay(), ConnectionManager(...)... see https://godoc.org/github.com/libp2p/go-libp2p#Option for more info.

The secret should be a 32-byte pre-shared-key byte slice.

Types

type AddParams

type AddParams struct {
	Layout    string
	Chunker   string
	RawLeaves bool
	Hidden    bool
	Shard     bool
	NoCopy    bool
	HashFun   string
}

AddParams contains all of the configurable parameters needed to specify the importing process of a file.

type Config

type Config struct {
	// The DAGService will not announce or retrieve blocks from the network
	Offline bool
	// ReprovideInterval sets how often to reprovide records to the DHT
	ReprovideInterval time.Duration
	// Disables wrapping the blockstore in an ARC cache + Bloomfilter. Use
	// when the given blockstore or datastore already has caching, or when
	// caching is not needed.
	UncachedBlockstore bool
}

Config wraps configuration options for the Peer.

type Peer

type Peer struct {
	ipld.DAGService // become a DAG service
	// contains filtered or unexported fields
}

Peer is an IPFS-Lite peer. It provides a DAG service that can fetch and put blocks from/to the IPFS network.

func New

func New(
	ctx context.Context,
	datastore datastore.Batching,
	blockstore blockstore.Blockstore,
	host host.Host,
	dht routing.Routing,
	cfg *Config,
) (*Peer, error)

New creates an IPFS-Lite Peer. It uses the given datastore, blockstore, libp2p Host and Routing (usuall the DHT). If the blockstore is nil, the given datastore will be wrapped to create one. The Host and the Routing may be nil if config.Offline is set to true, as they are not used in that case. Peer implements the ipld.DAGService interface.

func (*Peer) AddFile

func (p *Peer) AddFile(ctx context.Context, r io.Reader, params *AddParams) (ipld.Node, error)

AddFile chunks and adds content to the DAGService from a reader. The content is stored as a UnixFS DAG (default for IPFS). It returns the root ipld.Node.

func (*Peer) BlockService

func (p *Peer) BlockService() blockservice.BlockService

BlockService returns the underlying blockservice implementation.

func (*Peer) BlockStore

func (p *Peer) BlockStore() blockstore.Blockstore

BlockStore offers access to the blockstore underlying the Peer's DAGService.

func (*Peer) Bootstrap

func (p *Peer) Bootstrap(peers []peer.AddrInfo)

Bootstrap is an optional helper to connect to the given peers and bootstrap the Peer DHT (and Bitswap). This is a best-effort function. Errors are only logged and a warning is printed when less than half of the given peers could be contacted. It is fine to pass a list where some peers will not be reachable.

func (*Peer) Exchange

func (p *Peer) Exchange() exchange.Interface

Exchange returns the underlying exchange implementation.

func (*Peer) GetFile

func (p *Peer) GetFile(ctx context.Context, c cid.Cid) (ufsio.ReadSeekCloser, error)

GetFile returns a reader to a file as identified by its root CID. The file must have been added as a UnixFS DAG (default for IPFS).

func (*Peer) HasBlock

func (p *Peer) HasBlock(ctx context.Context, c cid.Cid) (bool, error)

HasBlock returns whether a given block is available locally. It is a shorthand for .Blockstore().Has().

func (*Peer) Session

func (p *Peer) Session(ctx context.Context) ipld.NodeGetter

Session returns a session-based NodeGetter.