Documentation
¶
Overview ¶
Package core implements the IpfsNode object and related methods.
Packages underneath core/ provide a (relatively) stable, low-level API to carry out most IPFS-related tasks. For more details on the other interfaces and how core/... fits into the bigger IPFS picture, see:
$ godoc github.com/ipfs/go-ipfs
Index ¶
- Constants
- Variables
- func Bootstrap(n *IpfsNode, cfg BootstrapConfig) (io.Closer, error)
- func Resolve(ctx context.Context, n *IpfsNode, p path.Path) (*merkledag.Node, error)
- func ResolveToKey(ctx context.Context, n *IpfsNode, p path.Path) (key.Key, error)
- type BootstrapConfig
- type BuildCfg
- type DiscoveryOption
- type HostOption
- type IpfsNode
- func (n *IpfsNode) Bootstrap(cfg BootstrapConfig) error
- func (n *IpfsNode) Close() error
- func (n *IpfsNode) Context() context.Context
- func (n *IpfsNode) HandlePeerFound(p pstore.PeerInfo)
- func (n *IpfsNode) LoadPrivateKey() error
- func (n *IpfsNode) OnlineMode() bool
- func (n *IpfsNode) Process() goprocess.Process
- func (n *IpfsNode) SetupOfflineRouting() error
- type Mounts
- type RoutingOption
Constants ¶
const IpnsValidatorTag = "ipns"
Variables ¶
var DefaultBootstrapConfig = BootstrapConfig{ MinPeerThreshold: 4, Period: 30 * time.Second, ConnectionTimeout: (30 * time.Second) / 3, }
DefaultBootstrapConfig specifies default sane parameters for bootstrapping.
var ErrNoNamesys = errors.New(
"core/resolve: no Namesys on IpfsNode - can't resolve ipns entry")
ErrNoNamesys is an explicit error for when an IPFS node doesn't (yet) have a name system
var ErrNotEnoughBootstrapPeers = errors.New("not enough bootstrap peers to bootstrap")
ErrNotEnoughBootstrapPeers signals that we do not have enough bootstrap peers to bootstrap correctly.
Functions ¶
func Bootstrap ¶
func Bootstrap(n *IpfsNode, cfg BootstrapConfig) (io.Closer, error)
Bootstrap kicks off IpfsNode bootstrapping. This function will periodically check the number of open connections and -- if there are too few -- initiate connections to well-known bootstrap peers. It also kicks off subsystem bootstrapping (i.e. routing).
func Resolve ¶
Resolve resolves the given path by parsing out protocol-specific entries (e.g. /ipns/<node-key>) and then going through the /ipfs/ entries and returning the final merkledag node.
func ResolveToKey ¶ added in v0.4.0
ResolveToKey resolves a path to a key.
It first checks if the path is already in the form of just a key (<key> or /ipfs/<key>) and returns immediately if so. Otherwise, it falls back onto Resolve to perform resolution of the dagnode being referenced.
Types ¶
type BootstrapConfig ¶
type BootstrapConfig struct { // MinPeerThreshold governs whether to bootstrap more connections. If the // node has less open connections than this number, it will open connections // to the bootstrap nodes. From there, the routing system should be able // to use the connections to the bootstrap nodes to connect to even more // peers. Routing systems like the IpfsDHT do so in their own Bootstrap // process, which issues random queries to find more peers. MinPeerThreshold int // Period governs the periodic interval at which the node will // attempt to bootstrap. The bootstrap process is not very expensive, so // this threshold can afford to be small (<=30s). Period time.Duration // ConnectionTimeout determines how long to wait for a bootstrap // connection attempt before cancelling it. ConnectionTimeout time.Duration // BootstrapPeers is a function that returns a set of bootstrap peers // for the bootstrap process to use. This makes it possible for clients // to control the peers the process uses at any moment. BootstrapPeers func() []pstore.PeerInfo }
BootstrapConfig specifies parameters used in an IpfsNode's network bootstrapping process.
func BootstrapConfigWithPeers ¶
func BootstrapConfigWithPeers(pis []pstore.PeerInfo) BootstrapConfig
type BuildCfg ¶
type BuildCfg struct { // If online is set, the node will have networking enabled Online bool // If permament then node should run more expensive processes // that will improve performance in long run Permament bool // If NilRepo is set, a repo backed by a nil datastore will be constructed NilRepo bool Routing RoutingOption Host HostOption Repo repo.Repo }
type HostOption ¶
type HostOption func(ctx context.Context, id peer.ID, ps pstore.Peerstore, bwr metrics.Reporter, fs []*net.IPNet) (p2phost.Host, error)
var DefaultHostOption HostOption = constructPeerHost
type IpfsNode ¶
type IpfsNode struct { // Self Identity peer.ID // the local node's identity Repo repo.Repo // Local node Pinning pin.Pinner // the pinning manager Mounts Mounts // current mount state, if any. PrivateKey ic.PrivKey // the local node's private Key // Services Peerstore pstore.Peerstore // storage for other Peer instances Blockstore bstore.GCBlockstore // the block store (lower level) Blocks *bserv.BlockService // the block service, get/add blocks. DAG merkledag.DAGService // the merkle dag service, get/add objects. Resolver *path.Resolver // the path resolution system Reporter metrics.Reporter Discovery discovery.Service FilesRoot *mfs.Root // Online PeerHost p2phost.Host // the network host (server+client) Bootstrapper io.Closer // the periodic bootstrapper Routing routing.IpfsRouting // the routing system. recommend ipfs-dht Exchange exchange.Interface // the block exchange + strategy (bitswap) Namesys namesys.NameSystem // the name system, resolves paths to hashes Diagnostics *diag.Diagnostics // the diagnostics service Ping *ping.PingService Reprovider *rp.Reprovider // the value reprovider system IpnsRepub *ipnsrp.Republisher // contains filtered or unexported fields }
IpfsNode is IPFS Core module. It represents an IPFS instance.
func (*IpfsNode) Bootstrap ¶
func (n *IpfsNode) Bootstrap(cfg BootstrapConfig) error
func (*IpfsNode) HandlePeerFound ¶
func (*IpfsNode) LoadPrivateKey ¶ added in v0.2.2
func (*IpfsNode) OnlineMode ¶ added in v0.2.2
func (*IpfsNode) SetupOfflineRouting ¶ added in v0.2.2
SetupOfflineRouting loads the local nodes private key and uses it to instantiate a routing system in offline mode. This is primarily used for offline ipns modifications.
type Mounts ¶
Mounts defines what the node's mount state is. This should perhaps be moved to the daemon or mount. It's here because it needs to be accessible across daemon requests.
type RoutingOption ¶
var DHTOption RoutingOption = constructDHTRouting
var NilRouterOption RoutingOption = nilrouting.ConstructNilRouting
Directories
¶
Path | Synopsis |
---|---|
Package commands implements the IPFS command interface Using github.com/ipfs/go-ipfs/commands to define the command line and HTTP APIs.
|
Package commands implements the IPFS command interface Using github.com/ipfs/go-ipfs/commands to define the command line and HTTP APIs. |
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS.
|
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS. |
Package corerepo provides pinning and garbage collection for local IPFS block services.
|
Package corerepo provides pinning and garbage collection for local IPFS block services. |