ipfs

Documentation

Index

• func AddFileToNodes(ctx context.Context, filePath string, clients ...Client) (string, error)
• func AddTextToNodes(ctx context.Context, fileContent []byte, clients ...Client) (string, error)
• func ParsePeersString(peers []string) ([]peer.AddrInfo, error)
• type Client
  • func NewClient(ctx context.Context, apiAddr string) (*Client, error)
  • func (cl Client) APIAddress() string
  • func (cl Client) Get(ctx context.Context, cid, outputPath string) error
  • func (cl Client) GetCidSize(ctx context.Context, cid string) (uint64, error)
  • func (cl Client) GetTreeNode(ctx context.Context, cid string) (IPLDTreeNode, error)
  • func (cl Client) HasCID(ctx context.Context, cid string) (bool, error)
  • func (cl Client) ID(ctx context.Context) (string, error)
  • func (cl Client) Put(ctx context.Context, inputPath string) (string, error)
  • func (cl Client) Stat(ctx context.Context, cid string) (*StatResult, error)
  • func (cl Client) SwarmAddresses(ctx context.Context) ([]string, error)
  • func (cl Client) SwarmConnect(ctx context.Context, peers []peer.AddrInfo)
  • func (cl Client) SwarmMultiAddresses(ctx context.Context) ([]ma.Multiaddr, error)
• type IPLDTreeNode
  • func FlattenTreeNode(ctx context.Context, rootNode IPLDTreeNode) ([]IPLDTreeNode, error)
• type IPLDType
• type StatResult

Functions

func AddFileToNodes

func AddFileToNodes(ctx context.Context, filePath string, clients ...Client) (string, error)

func AddTextToNodes

func AddTextToNodes(ctx context.Context, fileContent []byte, clients ...Client) (string, error)

func ParsePeersString

func ParsePeersString(peers []string) ([]peer.AddrInfo, error)

Types

type Client

type Client struct {
	API icore.CoreAPI
	// contains filtered or unexported fields
}

Client is a front-end for an ipfs node's API endpoints

func NewClient

func NewClient(ctx context.Context, apiAddr string) (*Client, error)

NewClient creates an API client for the given ipfs node API multiaddress.

func (Client) APIAddress

func (cl Client) APIAddress() string

APIAddress returns Api address that was used to connect to the node.

func (Client) Get

func (cl Client) Get(ctx context.Context, cid, outputPath string) error

Get fetches a file or directory from the ipfs network.

func (Client) GetCidSize

func (cl Client) GetCidSize(ctx context.Context, cid string) (uint64, error)

func (Client) GetTreeNode

func (cl Client) GetTreeNode(ctx context.Context, cid string) (IPLDTreeNode, error)

func (Client) HasCID

func (cl Client) HasCID(ctx context.Context, cid string) (bool, error)

HasCID returns true if the node has the given CID locally, whether pinned or not.

func (Client) ID

func (cl Client) ID(ctx context.Context) (string, error)

ID returns the node's ipfs ID.

func (Client) Put

func (cl Client) Put(ctx context.Context, inputPath string) (string, error)

Put uploads and pins a file or directory to the ipfs network. Timeouts and cancellation should be handled by passing an appropriate context value.

func (Client) Stat

func (cl Client) Stat(ctx context.Context, cid string) (*StatResult, error)

Stat returns information about an IPLD CID on the ipfs network.

func (Client) SwarmAddresses

func (cl Client) SwarmAddresses(ctx context.Context) ([]string, error)

SwarmAddresses returns a list of swarm addresses the node has announced.

func (Client) SwarmConnect

func (cl Client) SwarmConnect(ctx context.Context, peers []peer.AddrInfo)

SwarmConnect establishes concurrent connections to each peer from the provided `peers` list. It spawns a goroutine for each peer connection. In the event of a connection failure, a warning log containing the error and peer details is generated.

func (Client) SwarmMultiAddresses

func (cl Client) SwarmMultiAddresses(ctx context.Context) ([]ma.Multiaddr, error)

type IPLDTreeNode

type IPLDTreeNode struct {
	Cid      cid.Cid
	Path     []string
	Children []IPLDTreeNode
}

func FlattenTreeNode

func FlattenTreeNode(ctx context.Context, rootNode IPLDTreeNode) ([]IPLDTreeNode, error)

type IPLDType

type IPLDType int

const (
	IPLDUnknown IPLDType = iota
	IPLDFile
	IPLDDirectory
)

type StatResult

type StatResult struct {
	Type IPLDType
}