ipfs

README

ipfs-tools

Tools for IPFS

Documentation

Index

• Constants
• Variables
• func FindAllLinks(data []byte) []string
• func Hash(link string) (string, error)
• func Is(link string) bool
• func Link(gateway, hash string) string
• func Path(link string) string
• func ShuffleGateways(gateways []string) []string
• type Data
• type Node
  • func NewNode(ctx context.Context, dir string, limit int64, blacklist []string, ...) (*Node, error)
  • func (n *Node) Close() error
  • func (n *Node) Get(ctx context.Context, cid string) (Data, error)
  • func (n *Node) Start(ctx context.Context, bootstrap ...string) error
• type Pool
  • func NewPool(gateways []string, limit int64) (*Pool, error)
  • func (pool *Pool) Get(ctx context.Context, link string) (Data, error)
  • func (pool *Pool) GetFromNode(ctx context.Context, link, node string) (Data, error)
  • func (pool *Pool) GetFromRandomGateway(ctx context.Context, link string) (Data, error)
• type Provider

Constants

const (
	IpfsLinkPrefix = "ipfs://"
)

prefix

Variables

var (
	ErrInvalidURI           = errors.New("invalid URI")
	ErrEmptyIPFSGatewayList = errors.New("empty IPFS gateway list")
	ErrHTTPRequest          = errors.New("HTTP request error")
	ErrJSONDecoding         = errors.New("JSON decoding error")
	ErrNoIPFSResponse       = errors.New("can't load document from IPFS")
	ErrInvalidCID           = errors.New("invalid CID")
)

Errors

Functions

func FindAllLinks

func FindAllLinks(data []byte) []string

FindAllLinks -

func Hash

func Hash(link string) (string, error)

Hash - separate IPFS hash from link

func Is

func Is(link string) bool

Is -

func Link

func Link(gateway, hash string) string

Link - get gateway link

func Path

func Path(link string) string

Path - get path without protocol

func ShuffleGateways

func ShuffleGateways(gateways []string) []string

ShuffleGateways - shuffle gateways for different request order for different files

Types

type Data

type Data struct {
	Raw          []byte
	Node         string
	ResponseTime int64
}

Data -

type Node

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

Node -

func NewNode

func NewNode(ctx context.Context, dir string, limit int64, blacklist []string, providers []Provider) (*Node, error)

NewNode -

func (*Node) Close

func (n *Node) Close() error

Close -

func (*Node) Get

func (n *Node) Get(ctx context.Context, cid string) (Data, error)

Get -

func (*Node) Start

func (n *Node) Start(ctx context.Context, bootstrap ...string) error

Start -

type Pool

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

Pool -

func NewPool

func NewPool(gateways []string, limit int64) (*Pool, error)

NewPool -

func (*Pool) Get

func (pool *Pool) Get(ctx context.Context, link string) (Data, error)

Get - returns result if one of node returns it

func (*Pool) GetFromNode

func (pool *Pool) GetFromNode(ctx context.Context, link, node string) (Data, error)

GetFromNode - returns result if `node` returns it

func (*Pool) GetFromRandomGateway

func (pool *Pool) GetFromRandomGateway(ctx context.Context, link string) (Data, error)

GetFromRandomGateway - returns result if random node returns it

type Provider

type Provider struct {
	ID      string `yaml:"id" validate:"required"`
	Address string `yaml:"addr" validate:"required"`
}

Provider -