pinata

Documentation

Index

• Constants
• type Client
  • func New(opts ...NewOpt) (*Client, error)
  • func (cl *Client) Equal(other *Client) bool
  • func (cl *Client) IsPresent(ctx context.Context, c cid.Cid) (bool, error)
  • func (cl *Client) Pin(ctx context.Context, c cid.Cid, k string) error
  • func (cl *Client) Unpin(ctx context.Context, c cid.Cid) error
  • func (cl *Client) Upload(ctx context.Context, fi fs.File, pro *progress.Tracker) (cid.Cid, error)
• type NewOpt
  • func WithEndpoint(e string) NewOpt
  • func WithHTTPClient(c *http.Client) NewOpt
  • func WithPSAEndpoint(e string) NewOpt
  • func WithToken(tok string) NewOpt

Constants

const DefaultEndpoint = "https://api.pinata.cloud"

DefaultEndpoint is the default base URL for the Pinata API. It can be overridden with the WithEndpoint option.

const DefaultPSAEndpoint = "https://api.pinata.cloud/psa"

DefaultPSAEndpoint is the default base URL for the Pinata Pinning Service API. It can be overridden with the WithPSAEndpoint option.

const MaxFileSize = 1024 * 1024 * 1024 * 25

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...NewOpt) (*Client, error)

New creates a new Client with the given options. The only mandatory option is WithToken; the others have sensible defaults.

func (*Client) Equal

func (cl *Client) Equal(other *Client) bool

func (*Client) IsPresent

func (cl *Client) IsPresent(ctx context.Context, c cid.Cid) (bool, error)

func (*Client) Pin

func (cl *Client) Pin(ctx context.Context, c cid.Cid, k string) error

func (*Client) Unpin

func (cl *Client) Unpin(ctx context.Context, c cid.Cid) error

func (*Client) Upload

func (cl *Client) Upload(ctx context.Context, fi fs.File, pro *progress.Tracker) (cid.Cid, error)

type NewOpt

type NewOpt func(options *config) error

NewOpt is an option for the New() function.

func WithEndpoint

func WithEndpoint(e string) NewOpt

WithEndpoint is an option for the New() function which sets the URL of the pinata.cloud endpoint. By default, DefaultEndpoint is used.

func WithHTTPClient

func WithHTTPClient(c *http.Client) NewOpt

WithHTTPClient is an option for the New() function which sets the http.Client with which to access the endpoint. By default, a new retryablehttp.Client is used.

func WithPSAEndpoint

func WithPSAEndpoint(e string) NewOpt

WithPSAEndpoint is an option for the New() function which sets the URL of the pinata.cloud Pinning Service API endpoint. By default, DefaultPSAEndpoint is used.

func WithToken

func WithToken(tok string) NewOpt

WithToken is an option for the New() function which sets the JSON Web Token to authenticate with the endpoint.