client

Documentation

Overview

Package client implement a client to the IPFS api

This client is written based on the kubo rpc api https://docs.ipfs.tech/reference/kubo/rpc/ This package can be used with a local instance of kubo running or with publicly accessible endpoint All contribution/suggestions are welcome.

Index

• type Client
  • func NewIPFSApi(Url string, timeout int) (*Client, error)
  • func NewLocalApi() (*Client, error)
  • func (client *Client) Add(pathName string) (*IPFSResponse, error)
  • func (client *Client) AddBinary(content io.Reader, fileName string) (*IPFSResponse, error)
  • func (client *Client) Cat(id string) (*http.Response, error)
• type IPFSResponse

Types

type Client

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

A client represent the connection to the RPC API endpoint

func NewIPFSApi

func NewIPFSApi(Url string, timeout int) (*Client, error)

NewIPFSApi return a Client struct based on the parameter given. The parameters are the URL of the endpoint and a timeout for the connection (default should be 4)

func NewLocalApi

func NewLocalApi() (*Client, error)

Wrapper to NewIPFSApi to use when a local node is running on localhost port 5001

func (*Client) Add

func (client *Client) Add(pathName string) (*IPFSResponse, error)

The add function upload a new file to IPFS It takes the path to the file to upload as a parameter Upon successful upload it return an IPFSResponse struct and nil In case of error the IPFSResponse is set to nil and an error is returned NOTE By default the file will be pinned.

func (*Client) AddBinary

func (client *Client) AddBinary(content io.Reader, fileName string) (*IPFSResponse, error)

func (*Client) Cat

func (client *Client) Cat(id string) (*http.Response, error)

Cat function retrieve the content of file stored in IPFS based on its CID It takes the CID of the object to retrieve as input Return the HTTP.Response upon successful execution Return nil and the error if an error occured

type IPFSResponse

type IPFSResponse struct {
	Name string `json:"Name"` // the name of the uploaded file
	Hash string `json:"Hash"` // the CID of the uploaded file
	Size string `json:"Size"` // the size of the uploaded file
}

IPFSResponse represent the response received from an IPFS node upon successful upload of a file