mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-28 05:47:51 +08:00
8c2ae9cf22
Include rename from: github.com/ipfs/go-libipfs => github.com/ipfs/boxo This migration was reverted: ./blocks => github.com/ipfs/go-block-format Migrated repos: - github.com/ipfs/interface-go-ipfs-core => ./coreiface - github.com/ipfs/go-pinning-service-http-client => ./pinning/remote/client - github.com/ipfs/go-path => ./path - github.com/ipfs/go-namesys => ./namesys - github.com/ipfs/go-mfs => ./mfs - github.com/ipfs/go-ipfs-provider => ./provider - github.com/ipfs/go-ipfs-pinner => ./pinning/pinner - github.com/ipfs/go-ipfs-keystore => ./keystore - github.com/ipfs/go-filestore => ./filestore - github.com/ipfs/go-ipns => ./ipns - github.com/ipfs/go-blockservice => ./blockservice - github.com/ipfs/go-ipfs-chunker => ./chunker - github.com/ipfs/go-fetcher => ./fetcher - github.com/ipfs/go-ipfs-blockstore => ./blockstore - github.com/ipfs/go-ipfs-posinfo => ./filestore/posinfo - github.com/ipfs/go-ipfs-util => ./util - github.com/ipfs/go-ipfs-ds-help => ./datastore/dshelp - github.com/ipfs/go-verifcid => ./verifcid - github.com/ipfs/go-ipfs-exchange-offline => ./exchange/offline - github.com/ipfs/go-ipfs-routing => ./routing - github.com/ipfs/go-ipfs-exchange-interface => ./exchange - github.com/ipfs/go-unixfs => ./ipld/unixfs - github.com/ipfs/go-merkledag => ./ipld/merkledag - github.com/ipld/go-car => ./ipld/car Fixes #215 Updates #202 This commit was moved from ipfs/boxo@038bdd291d
61 lines
1.5 KiB
Go
61 lines
1.5 KiB
Go
// Package iface defines IPFS Core API which is a set of interfaces used to
|
|
// interact with IPFS nodes.
|
|
package iface
|
|
|
|
import (
|
|
"context"
|
|
|
|
path "github.com/ipfs/boxo/coreiface/path"
|
|
|
|
"github.com/ipfs/boxo/coreiface/options"
|
|
|
|
ipld "github.com/ipfs/go-ipld-format"
|
|
)
|
|
|
|
// CoreAPI defines an unified interface to IPFS for Go programs
|
|
type CoreAPI interface {
|
|
// Unixfs returns an implementation of Unixfs API
|
|
Unixfs() UnixfsAPI
|
|
|
|
// Block returns an implementation of Block API
|
|
Block() BlockAPI
|
|
|
|
// Dag returns an implementation of Dag API
|
|
Dag() APIDagService
|
|
|
|
// Name returns an implementation of Name API
|
|
Name() NameAPI
|
|
|
|
// Key returns an implementation of Key API
|
|
Key() KeyAPI
|
|
|
|
// Pin returns an implementation of Pin API
|
|
Pin() PinAPI
|
|
|
|
// Object returns an implementation of Object API
|
|
Object() ObjectAPI
|
|
|
|
// Dht returns an implementation of Dht API
|
|
Dht() DhtAPI
|
|
|
|
// Swarm returns an implementation of Swarm API
|
|
Swarm() SwarmAPI
|
|
|
|
// PubSub returns an implementation of PubSub API
|
|
PubSub() PubSubAPI
|
|
|
|
// Routing returns an implementation of Routing API
|
|
Routing() RoutingAPI
|
|
|
|
// ResolvePath resolves the path using Unixfs resolver
|
|
ResolvePath(context.Context, path.Path) (path.Resolved, error)
|
|
|
|
// ResolveNode resolves the path (if not resolved already) using Unixfs
|
|
// resolver, gets and returns the resolved Node
|
|
ResolveNode(context.Context, path.Path) (ipld.Node, error)
|
|
|
|
// WithOptions creates new instance of CoreAPI based on this instance with
|
|
// a set of options applied
|
|
WithOptions(...options.ApiOption) (CoreAPI, error)
|
|
}
|