ipfs

Documentation

Index

• func BestGatewayNodeFrom(ipfsURL string, isFxHash bool) string
• func DefaultGatewayFrom(ipfsURL string) string
• 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
• func PathGatewayFrom(gatewayHost, ipfsURL string) string
• type ErrInfuraQuotaExceeded
  • func (r ErrInfuraQuotaExceeded) Error() string
  • func (r ErrInfuraQuotaExceeded) Unwrap() error
• type HTTPReader
  • 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
  • func (r IPFSReader) Do(ctx context.Context, path string) (io.ReadCloser, error)

Functions

func BestGatewayNodeFrom

func BestGatewayNodeFrom(ipfsURL string, isFxHash bool) string

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

func DefaultGatewayFrom

func DefaultGatewayFrom(ipfsURL string) string

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

func GetHeader

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

func GetResponse

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

func IsIpfsGatewayURL

func IsIpfsGatewayURL(ipfsURL string) bool

func IsIpfsProtoURL

func IsIpfsProtoURL(ipfsURL string) bool

func IsIpfsURL

func IsIpfsURL(ipfsURL string) bool

func NewShell

func NewShell() *shell.Shell

NewShell returns an IPFS shell with default configuration

func PathGatewayFrom

func PathGatewayFrom(gatewayHost, ipfsURL string) string

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

Types

type ErrInfuraQuotaExceeded

type ErrInfuraQuotaExceeded struct {
	Err error
}

func (ErrInfuraQuotaExceeded) Error

func (r ErrInfuraQuotaExceeded) Error() string

func (ErrInfuraQuotaExceeded) Unwrap

func (r ErrInfuraQuotaExceeded) Unwrap() error

type HTTPReader

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

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

func (HTTPReader) Do

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

func (HTTPReader) Head

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

type IPFSReader

type IPFSReader struct {
	Client *shell.Shell
}

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

func (IPFSReader) Do

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