ipfs

Documentation

Index

• Variables
• type Config
• type Endpoint
  • func NewEndpoint(log *zap.Logger, service *Service) *Endpoint
  • func (endpoint *Endpoint) Peers(w http.ResponseWriter, r *http.Request)
  • func (endpoint *Endpoint) Pinned(writer http.ResponseWriter, request *http.Request)
  • func (endpoint *Endpoint) Register(router *mux.Router)
  • func (endpoint *Endpoint) Upload(writer http.ResponseWriter, r *http.Request)
• type Peer
• type Pinned
• type Service
  • func NewService(log *zap.Logger, address string) (*Service, error)
  • func (s *Service) GetPeers(ctx context.Context) ([]Peer, error)
  • func (s *Service) IsPinned(ctx context.Context, CID string) (res bool, err error)
  • func (s *Service) Pin(ctx context.Context, CID string) (res Pinned, err error)
  • func (s *Service) Upload(ctx context.Context, reader io.Reader) (string, error)

Variables

var ErrEndpoint = errs.Class("ipfs endpoint")

ErrEndpoint - ipfs endpoint error class.

Types

type Config

type Config struct {
	Address string `help:"IPFS multiaddress of the IPFS node" releaseDefault:"" devDefault:""`
}

type Endpoint

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

architecture: Endpoint

func NewEndpoint

func NewEndpoint(log *zap.Logger, service *Service) *Endpoint

NewEndpoint creates new ipfs endpoint instance.

func (*Endpoint) Peers

func (endpoint *Endpoint) Peers(w http.ResponseWriter, r *http.Request)

Peers endpoint retrieves all the active Peers

func (*Endpoint) Pinned

func (endpoint *Endpoint) Pinned(writer http.ResponseWriter, request *http.Request)

func (*Endpoint) Register

func (endpoint *Endpoint) Register(router *mux.Router)

Register registers endpoint methods on API server subroute.

func (*Endpoint) Upload

func (endpoint *Endpoint) Upload(writer http.ResponseWriter, r *http.Request)

type Peer

type Peer struct {
	ID      string
	Address string
}

type Pinned

type Pinned struct {
	CID  string
	Size uint64
}

type Service

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

Service for IPFS related operations.

architecture: Service

func NewService

func NewService(log *zap.Logger, address string) (*Service, error)

func (*Service) GetPeers

func (s *Service) GetPeers(ctx context.Context) ([]Peer, error)

func (*Service) IsPinned

func (s *Service) IsPinned(ctx context.Context, CID string) (res bool, err error)

func (*Service) Pin

func (s *Service) Pin(ctx context.Context, CID string) (res Pinned, err error)

func (*Service) Upload

func (s *Service) Upload(ctx context.Context, reader io.Reader) (string, error)