ipfs

package module

v0.0.3 Latest Latest Go to latest Published: Oct 7, 2023 License: MIT Imports: 27 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

Repository

github.com/dipdup-io/ipfs-tools

Links

Open Source Insights

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)
type Pool
- func NewPool(gateways []string, limit int64) (*Pool, error)
type Provider

Constants ¶

View Source

const (
	IpfsLinkPrefix = "ipfs://"
)

prefix

Variables ¶

View Source

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 -

Source Files ¶

View all Source files

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