pinner

README

ipfs-pinner

• go client for IPFS pinning service api
• extended support for custom file upload endpoints provided by pinata & web3.storage
• car file generation and lightweight deterministic CID generation on client side (using cars).

generate go http client go bindings via openapi

• use ./generate_gobindings.sh to generate the golang bindings (for pinning services of pinata and web3.storage).
• There are some fixes you would need to do (missing braces etc.)

Documentation

Index

• type PinnerNode
  • func NewPinnerNode(req PinnerNodeCreateRequest) PinnerNode
• type PinnerNodeCreateRequest
  • func NewNodeRequest(clientRequest pinclient.ClientCreateRequest) *PinnerNodeCreateRequest
  • func (req *PinnerNodeCreateRequest) CidComputeOnly(cidComputeOnly bool) *PinnerNodeCreateRequest
  • func (req *PinnerNodeCreateRequest) CidVersion(version int) *PinnerNodeCreateRequest

Types

type PinnerNode

type PinnerNode interface {
	CarExporter() car.CarExporterAPI
	PinService() pinclient.PinServiceAPI
	UnixfsService() dag.UnixfsAPI
}

func NewPinnerNode

func NewPinnerNode(req PinnerNodeCreateRequest) PinnerNode

type PinnerNodeCreateRequest

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

func NewNodeRequest

func NewNodeRequest(clientRequest pinclient.ClientCreateRequest) *PinnerNodeCreateRequest

func (*PinnerNodeCreateRequest) CidComputeOnly

func (req *PinnerNodeCreateRequest) CidComputeOnly(cidComputeOnly bool) *PinnerNodeCreateRequest

If only cid computation is required from the node (and no persistence of the ipfs dags to filesystem)

func (*PinnerNodeCreateRequest) CidVersion

func (req *PinnerNodeCreateRequest) CidVersion(version int) *PinnerNodeCreateRequest