ipfs

package

v0.0.0-...-d2b7839 Latest Latest Go to latest Published: Apr 28, 2024 License: MIT Imports: 11 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

This section is empty.

This section is empty.

func BestGatewayNodeFrom(ipfsURL string, isFxHash bool) string

BestGatewayNodeFrom rewrites an IPFS URL to a gateway URL using the appropriate gateway

func DefaultGatewayFrom(ipfsURL string) string

DefaultGatewayFrom rewrites an IPFS URL to a gateway URL using the default gateway

func GetHeader(ctx context.Context, path string) (http.Header, error)

func GetResponse(ctx context.Context, path string) (io.ReadCloser, error)

func IsIpfsGatewayURL(ipfsURL string) bool

func IsIpfsProtoURL(ipfsURL string) bool

func IsIpfsURL(ipfsURL string) bool

func NewShell() *shell.Shell

NewShell returns an IPFS shell with default configuration

func PathGatewayFrom(gatewayHost, ipfsURL string) string

PathGatewayFrom is a helper function that rewrites an IPFS URI to an IPFS gateway URL

type ErrInfuraQuotaExceeded struct {
	Err error
}

func (r ErrInfuraQuotaExceeded) Error() string

func (r ErrInfuraQuotaExceeded) Unwrap() error

type HTTPReader struct {
	Host   string
	Client *http.Client
}

HTTPReader is a reader that uses a HTTP gateway to read from

func (r HTTPReader) Do(ctx context.Context, path string) (io.ReadCloser, error)

func (r HTTPReader) Head(ctx context.Context, path string) (http.Header, error)

type IPFSReader struct {
	Client *shell.Shell
}

IPFSReader is a reader that uses an IPFS shell to read from IPFS

func (r IPFSReader) Do(ctx context.Context, path string) (io.ReadCloser, error)