Documentation
¶
Index ¶
- Constants
- func AddData(node *core.IpfsNode, reader io.Reader, pin bool, hashOnly bool) (*icid.Cid, error)
- func AddDataToDirectory(node *core.IpfsNode, dir uio.Directory, fname string, reader io.Reader) (*icid.Cid, error)
- func AddFolder(node *core.IpfsNode, path string, pin bool) (*icid.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) (*icid.Cid, error)
- func ComparePath(node *core.IpfsNode, pth1 string, pth2 string) (int, int, int, int, int, error)
- func ConnectToTopicReceiver(node *core.IpfsNode, ctx context.Context, topic string) error
- func DataAtPath(node *core.IpfsNode, pth string) ([]byte, error)
- func FilePathAtIpfsPath(node *core.IpfsNode, pth string, repoPath string) (string, error)
- func FolderAtPath(node *core.IpfsNode, pth string, repoPath string) (string, error)
- func GetBlock(node *core.IpfsNode, p path.Path) (io.Reader, error)
- func GetIPv6Addr(node *core.IpfsNode) (string, error)
- func GetLANIPv4Addr(node *core.IpfsNode) (string, error)
- func GetPublicIPv4Addr(node *core.IpfsNode) (string, 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 ListCids(node *core.IpfsNode, cid string) ([]string, error)
- func ListSortCids(node *core.IpfsNode, cid string) ([]string, error)
- func NodeAtCid(node *core.IpfsNode, id icid.Cid) (ipld.Node, error)
- func NodeAtLink(node *core.IpfsNode, link *ipld.Link) (ipld.Node, error)
- func NodeAtPath(node *core.IpfsNode, pth string, timeout time.Duration) (ipld.Node, error)
- func NotPinned(node *core.IpfsNode, cids []string) ([]icid.Cid, error)
- func ObjectAtPath(node *core.IpfsNode, pth string) ([]byte, error)
- func PinNode(node *core.IpfsNode, nd ipld.Node, recursive bool) error
- func Pinned(node *core.IpfsNode, cids []string) ([]icid.Cid, error)
- func PrintSwarmAddrs(node *core.IpfsNode) error
- func Publish(node *core.IpfsNode, topic string, data []byte) error
- func PublishIPNS(node *core.IpfsNode, id string, key string, timeout time.Duration) (iface.IpnsEntry, error)
- func PutBlock(node *core.IpfsNode, src io.Reader) (iface.BlockStat, error)
- func ResolveIPNS(node *core.IpfsNode, name peer.ID, timeout time.Duration) (path.Path, error)
- func ResolveLinkByNames(nd ipld.Node, names []string) (*ipld.Link, 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, peerId string) (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 icid.Cid, recursive bool) error
- func UnpinNode(node *core.IpfsNode, nd ipld.Node, recursive bool) error
- type ConnInfos
- type Link
- type Node
Constants ¶
const CatTimeout = 20 * time.Minute
const ConnectTimeout = time.Second * 5 //from 10 to 5 2019.11.27
const DefaultTimeout = time.Second * 2 //from 5 to 2 2019.11.27
const PinTimeout = 5 * time.Minute
const PublishTimeout = time.Second * 5
Variables ¶
This section is empty.
Functions ¶
func AddDataToDirectory ¶
func AddDataToDirectory(node *core.IpfsNode, dir uio.Directory, fname string, reader io.Reader) (*icid.Cid, error)
AddDataToDirectory adds reader bytes to a virtual dir
func AddLinkToDirectory ¶
AddLinkToDirectory adds a link to a virtual dir
func ComparePath ¶
Note that ComparePath would not fetch or pin the cid. return
- number of cids in first path
- number of cids in second path
- number of same cids
- number of A minus B
- number of B minus A
- error
func ConnectToTopicReceiver ¶
func DataAtPath ¶
DataAtPath return bytes under an ipfs path
func FilePathAtIpfsPath ¶
func FolderAtPath ¶
func GetIPv6Addr ¶
GetIPv6Addr returns the ipv6 address of the host machine, if available
func GetLANIPv4Addr ¶
GetLANIPv4Addr looks for a LAN IP in the host addresses (192.168.x.x)
func GetPublicIPv4Addr ¶
GetPublicIPv4Addr uses the host addresses to return the public ipv4 address of the host machine, if available
func IdentityConfig ¶
IdentityConfig initializes a new identity.
func LinksAtPath ¶
LinksAtPath return ipld links under a path
func NodeAtLink ¶
NodeAtLink returns the node behind an ipld link
func NodeAtPath ¶
NodeAtPath returns the last node under path
func ObjectAtPath ¶
ObjectAtPath returns the DAG object at the given path
func PrintSwarmAddrs ¶
PrintSwarmAddrs prints the addresses of the host
func PublishIPNS ¶
func PublishIPNS(node *core.IpfsNode, id string, key string, timeout time.Duration) (iface.IpnsEntry, error)
PublishIPNS publishes a content id to ipns
func ResolveIPNS ¶
ResolveIPNS resolves an ipns path to an ipfs path
func ResolveLinkByNames ¶
ResolveLinkByNames resolves a link in a node from a list of valid names Note: This exists for b/c w/ the "f" -> "meta" and "d" -> content migration
func StatObjectAtPath ¶
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 ¶
SwarmConnect opens a direct connection to a list of peer multi addresses
func SwarmConnected ¶
SwarmConnected returns whether or not the node has the peer in its current swarm
func UnmarshalPrivateKey ¶
UnmarshalPrivateKey converts a protobuf serialized private key into its representative object
func UnmarshalPrivateKeyFromString ¶
UnmarshalPrivateKeyFromString attempts to create a private key from a base64 encoded string
func UnmarshalPublicKeyFromString ¶
UnmarshalPublicKeyFromString attempts to create a public key from a base64 encoded string