ipfs

Documentation

Index

• Constants
• func AddData(node *core.IpfsNode, reader io.Reader, pin bool) (*cid.Cid, error)
• func AddDataToDirectory(node *core.IpfsNode, dir uio.Directory, fname string, reader io.Reader) (*cid.Cid, error)
• func AddLinkToDirectory(node *core.IpfsNode, dir uio.Directory, fname string, pth string) error
• func AddObject(node *core.IpfsNode, reader io.Reader, pin bool) (*cid.Cid, error)
• func DataAtPath(node *core.IpfsNode, pth string) ([]byte, error)
• func GetObjectAtPath(node *core.IpfsNode, pth string) ([]byte, error)
• func IdentityConfig(sk libp2pc.PrivKey) (config.Identity, error)
• func IpnsSubs(node *core.IpfsNode) ([]string, error)
• func LinksAtPath(node *core.IpfsNode, pth string) ([]*ipld.Link, error)
• func NodeAtCid(node *core.IpfsNode, id cid.Cid) (ipld.Node, error)
• func NodeAtLink(node *core.IpfsNode, link *ipld.Link) (ipld.Node, error)
• func NodeAtPath(node *core.IpfsNode, pth string) (ipld.Node, error)
• func PinNode(node *core.IpfsNode, nd ipld.Node, recursive bool) error
• func PrintSwarmAddrs(node *core.IpfsNode) error
• func PublicIPv4Addr(node *core.IpfsNode) (string, error)
• func Publish(node *core.IpfsNode, topic string, data []byte, connectTimeout time.Duration) error
• func PublishIPNS(node *core.IpfsNode, id string) (iface.IpnsEntry, error)
• func ResolveIPNS(node *core.IpfsNode, name peer.ID) (iface.Path, error)
• func ShortenID(id string) string
• func StatObjectAtPath(node *core.IpfsNode, pth string) (*iface.ObjectStat, error)
• func Subscribe(node *core.IpfsNode, ctx context.Context, topic string, discover bool, ...) error
• func SwarmConnect(node *core.IpfsNode, addrs []string) ([]string, error)
• func SwarmConnected(node *core.IpfsNode, pid peer.ID) (bool, error)
• func UnmarshalPrivateKey(data []byte) (libp2pc.PrivKey, error)
• func UnmarshalPrivateKeyFromString(key string) (libp2pc.PrivKey, error)
• func UnmarshalPublicKeyFromString(key string) (libp2pc.PubKey, error)
• func UnpinCid(node *core.IpfsNode, id cid.Cid, recursive bool) error
• func UnpinNode(node *core.IpfsNode, nd ipld.Node, recursive bool) error
• type ConnInfos
  • func SwarmPeers(node *core.IpfsNode, verbose bool, latency bool, streams bool, direction bool) (*ConnInfos, error)
  • func (ci ConnInfos) Len() int
  • func (ci ConnInfos) Less(i, j int) bool
  • func (ci ConnInfos) Swap(i, j int)
• type Link
• type Node

Constants

const PublishTimeout = time.Second * 5

Functions

func AddData

func AddData(node *core.IpfsNode, reader io.Reader, pin bool) (*cid.Cid, error)

AddData takes a reader and adds it, optionally pins it

func AddDataToDirectory

func AddDataToDirectory(node *core.IpfsNode, dir uio.Directory, fname string, reader io.Reader) (*cid.Cid, error)

AddDataToDirectory adds reader bytes to a virtual dir

func AddLinkToDirectory

func AddLinkToDirectory(node *core.IpfsNode, dir uio.Directory, fname string, pth string) error

AddLinkToDirectory adds a link to a virtual dir

func AddObject

func AddObject(node *core.IpfsNode, reader io.Reader, pin bool) (*cid.Cid, error)

AddObject takes a reader and adds it as a DAG node, optionally pins it

func DataAtPath

func DataAtPath(node *core.IpfsNode, pth string) ([]byte, error)

DataAtPath return bytes under an ipfs path

func GetObjectAtPath

func GetObjectAtPath(node *core.IpfsNode, pth string) ([]byte, error)

GetObjectAtPath returns the DAG object at the given path

func IdentityConfig

func IdentityConfig(sk libp2pc.PrivKey) (config.Identity, error)

IdentityConfig initializes a new identity.

func IpnsSubs

func IpnsSubs(node *core.IpfsNode) ([]string, error)

IpnsSubs shows current name subscriptions

func LinksAtPath

func LinksAtPath(node *core.IpfsNode, pth string) ([]*ipld.Link, error)

LinksAtPath return ipld links under a path

func NodeAtCid

func NodeAtCid(node *core.IpfsNode, id cid.Cid) (ipld.Node, error)

NodeAtCid returns the node behind a cid

func NodeAtLink

func NodeAtLink(node *core.IpfsNode, link *ipld.Link) (ipld.Node, error)

NodeAtLink returns the node behind an ipld link

func NodeAtPath

func NodeAtPath(node *core.IpfsNode, pth string) (ipld.Node, error)

NodeAtPath returns the last node under path

func PinNode

func PinNode(node *core.IpfsNode, nd ipld.Node, recursive bool) error

PinNode pins an ipld node

func PrintSwarmAddrs

func PrintSwarmAddrs(node *core.IpfsNode) error

PrintSwarmAddrs prints the addresses of the host

func PublicIPv4Addr

func PublicIPv4Addr(node *core.IpfsNode) (string, error)

PublicIPv4Addr uses the ipfs NAT traveral result to locate a (possibly) public ipv4 address. this method is used to inform cafe clients of the http api address

func Publish

func Publish(node *core.IpfsNode, topic string, data []byte, connectTimeout time.Duration) error

Publish publishes data to a topic

func PublishIPNS

func PublishIPNS(node *core.IpfsNode, id string) (iface.IpnsEntry, error)

PublishIPNS publishes a content id to ipns

func ResolveIPNS

func ResolveIPNS(node *core.IpfsNode, name peer.ID) (iface.Path, error)

ResolveIPNS resolves an ipns path to an ipfs path

func ShortenID

func ShortenID(id string) string

ShortenID returns the last 7 chars of a string

func StatObjectAtPath

func StatObjectAtPath(node *core.IpfsNode, pth string) (*iface.ObjectStat, error)

StatObjectAtPath returns info about an object

func Subscribe

func Subscribe(node *core.IpfsNode, ctx context.Context, topic string, discover bool, msgs chan iface.PubSubMessage) error

Subscribe subscribes to a topic

func SwarmConnect

func SwarmConnect(node *core.IpfsNode, addrs []string) ([]string, error)

SwarmConnect opens a direct connection to a list of peer multi addresses

func SwarmConnected

func SwarmConnected(node *core.IpfsNode, pid peer.ID) (bool, error)

SwarmConnected returns whether or not the node has the peer in its current swarm

func UnmarshalPrivateKey

func UnmarshalPrivateKey(data []byte) (libp2pc.PrivKey, error)

UnmarshalPrivateKey converts a protobuf serialized private key into its representative object

func UnmarshalPrivateKeyFromString

func UnmarshalPrivateKeyFromString(key string) (libp2pc.PrivKey, error)

UnmarshalPrivateKeyFromString attempts to create a private key from a base64 encoded string

func UnmarshalPublicKeyFromString

func UnmarshalPublicKeyFromString(key string) (libp2pc.PubKey, error)

UnmarshalPublicKeyFromString attempts to create a public key from a base64 encoded string

func UnpinCid

func UnpinCid(node *core.IpfsNode, id cid.Cid, recursive bool) error

UnpinCid unpins a cid

func UnpinNode

func UnpinNode(node *core.IpfsNode, nd ipld.Node, recursive bool) error

UnpinNode unpins an ipld node

Types

type ConnInfos

type ConnInfos struct {
	Peers []connInfo
}

func SwarmPeers

func SwarmPeers(node *core.IpfsNode, verbose bool, latency bool, streams bool, direction bool) (*ConnInfos, error)

SwarmPeers lists the set of peers this node is connected to

func (ConnInfos) Len

func (ci ConnInfos) Len() int

func (ConnInfos) Less

func (ci ConnInfos) Less(i, j int) bool

func (ConnInfos) Swap

func (ci ConnInfos) Swap(i, j int)

type Link

type Link struct {
	Name, Hash string
	Size       uint64
}

type Node

type Node struct {
	Links []Link
	Data  string
}