ipfs

package

v0.0.0-...-a092f05 Latest Latest Go to latest Published: Mar 18, 2022 License: AGPL-3.0 Imports: 14 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.

View Source

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

ErrEndpoint - ipfs endpoint error class.

This section is empty.

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

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

architecture: Endpoint

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

NewEndpoint creates new ipfs endpoint instance.

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

Peers endpoint retrieves all the active Peers

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

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

Register registers endpoint methods on API server subroute.

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

type Peer struct {
	ID      string
	Address string
}

type Pinned struct {
	CID  string
	Size uint64
}

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

Service for IPFS related operations.

architecture: 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)