ipfs

package

v0.4.16 Latest Latest Go to latest Published: Apr 30, 2024 License: MIT Imports: 14 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/rss3-network/node

Links

Open Source Insights

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

Constants ¶

View Source

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

	DefaultTimeout  = 3 * time.Second
	DefaultAttempts = 3
)

View Source

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

View Source

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

Variables ¶

View Source

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

View Source

var DefaultGateways = []string{
	DrfaultGatewayRSS3,
	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

Source Files ¶

View all Source files

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