View Source MyspaceIPFS.Bootstrap (Myspace IPFS v0.2.0-alpha.1)
MyspaceIPFS.Bootstrap is where the bootstrap commands of the IPFS API reside.
When you start an IPFS node, it will not necessarily know about any other peers on the network. To find other peers, you need to connect to a bootstrap node. A bootstrap node is a node that is trusted to help you find other peers on the network. The IPFS daemon will connect to a bootstrap node automatically when it starts up.
Link to this section Summary
Functions
Add peers to the bootstrap list.
Add peer to the default bootstrap list.
List peers in bootstrap list.
Show peers in bootstrap list.
Remove peer to the bootstrap list.
Remove all peers from the bootstrap list.
Link to this section Functions
@spec add(Path.t()) :: {:ok, MyspaceIPFS.peers()} | MyspaceIPFS.Api.error_response()
Add peers to the bootstrap list.
https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-add
parameters
Parameters
peer
- The peer ID to add to the bootstrap list. The format is a multiaddr
in the form of <multiaddr>/<peerID>
OR a list of peers.
@spec add_default(Path.t()) :: {:ok, MyspaceIPFS.peers()} | MyspaceIPFS.Api.error_response()
Add peer to the default bootstrap list.
https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-add-default
parameters
Parameters
peer
- The peer ID to add to the bootstrap list. The format is a multiaddr
in the form of <multiaddr>/<peerID>
OR a list of peers.
@spec bootstrap() :: {:ok, MyspaceIPFS.peers()} | MyspaceIPFS.Api.error_response()
List peers in bootstrap list.
@spec list() :: {:ok, MyspaceIPFS.peers()} | MyspaceIPFS.Api.error_response()
Show peers in bootstrap list.
https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-list
NB! /bootstrap/list is the same as /bootstrap, but that doesn't work well with Elixir because of the same name as the module.
@spec rm(Path.t()) :: {:ok, MyspaceIPFS.peers()} | MyspaceIPFS.Api.error_response()
Remove peer to the bootstrap list.
https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-rm
parameters
Parameters
peer
- The peer ID to remove from the bootstrap list. The format is a multiaddr
in the form of <multiaddr>/<peerID>
@spec rm_all() :: {:ok, MyspaceIPFS.peers()} | MyspaceIPFS.Api.error_response()
Remove all peers from the bootstrap list.
https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-bootstrap-rm-all