ipfs

Documentation

Index

• Constants
• Variables
• func FetchGateways(ctx context.Context, gatewayList string) ([]string, error)
• func ParseURL(contentURL string) (endpoint, path string, err error)
• type FetchMode
• type HTTPClient
  • func NewHTTPClient(options ...HTTPClientOption) (HTTPClient, error)
• type HTTPClientOption
  • func WithAttempts(attempts uint) HTTPClientOption
  • func WithGateways(gateways []string) HTTPClientOption
  • func WithTimeout(timeout time.Duration) HTTPClientOption

Constants

const (
	FetchModeQuick  FetchMode = "quick"
	FetchModeStable FetchMode = "stable"

	DefaultTimeout  = 3 * time.Second
	DefaultAttempts = 3
)

const (
	DefaultGatewayRSS3       = "https://ipfs.rss3.page/"
	DefaultGatewayIPFS       = "https://ipfs.io/"
	DefaultGatewayCloudflare = "https://cloudflare-ipfs.com/"
	DefaultGateway4EVERLAND  = "https://4everland.io/"
)

const (
	DefaultGatewayList = "https://raw.githubusercontent.com/ipfs/public-gateway-checker/master/gateways.txt"
)

Variables

var (
	ErrorUnsupportedMode = errors.New("unsupported mode")
	ErrorNoResults       = errors.New("no results")
)

var DefaultGateways = []string{
	DefaultGatewayRSS3,
	DefaultGatewayIPFS,
	DefaultGatewayCloudflare,
	DefaultGateway4EVERLAND,
}

Functions

func FetchGateways

func FetchGateways(ctx context.Context, gatewayList string) ([]string, error)

func ParseURL

func ParseURL(contentURL string) (endpoint, path string, err error)

Types

type FetchMode

type FetchMode string

FetchMode is the mode of fetching data from IPFS gateways.

type HTTPClient

type HTTPClient interface {
	Fetch(ctx context.Context, path string, fetchMode FetchMode) (io.ReadCloser, error)
}

func NewHTTPClient

func NewHTTPClient(options ...HTTPClientOption) (HTTPClient, error)

type HTTPClientOption

type HTTPClientOption func(*httpClient) error

func WithAttempts

func WithAttempts(attempts uint) HTTPClientOption

func WithGateways

func WithGateways(gateways []string) HTTPClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) HTTPClientOption