README
¶
go-ipfs-routing
go-ipfs-routing provides go-libp2p-routing implementations used in go-ipfs.
❗ This repo is no longer maintained.
👉 We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/routing. 🏎️ Good news! There is tooling and documentation to expedite a switch in your repo.
⚠️ If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).
📚 Learn more, including how to take the maintainership mantle or ask questions, here.
Table of Contents
Install
go-ipfs-routing works like a set of regular Go packages:
> go get github.com/ipfs/go-ipfs-routing/...
This module uses Gx to manage
dependencies. You can use make all to build it with the gx dependencies.
Usage
This repo contains 3 different packages.
Mock
import "github.com/ipfs/go-ipfs-routing/mock"
Mock is a fake router useful for tests. It provides a mock client that
implements the IpfsRouting interface and a mock server from which the client
retrieves routing records.
Offline
import "github.com/ipfs/go-ipfs-routing/offline"
Offline is an offline router that can put and get records to and from a local
Datastore but can't retrieve them from the network.
None
import "github.com/ipfs/go-ipfs-routing/none"
None is a router no-op router that doesn't do anything. Puts always succeed and lookups always fail.
License
MIT © Protocol Labs, Inc.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package mockrouting provides a virtual routing server.
|
Package mockrouting provides a virtual routing server. |
|
Package nilrouting implements a routing client that does nothing.
|
Package nilrouting implements a routing client that does nothing. |
|
Package offline implements Routing with a client which is only able to perform offline operations.
|
Package offline implements Routing with a client which is only able to perform offline operations. |