View Source MyspaceIPFS (Myspace IPFS v0.1.0)

MyspaceIPFS is where the main commands of the IPFS API reside. Alias this library and you can run the commands via Api.<cmd_name>.

  ## Examples

  iex> alias MyspaceIPFS, as: Ipfs
  iex> Ipfs.cat(QmZ4tDuvesekSs4qM5ZBKpXiZGun7S2CYtEZRB3DYXkjGx")
  <<0, 19, 148, 0, ... >>

Link to this section Summary

Types

The name of the file or data to be sent to the node. Sometimes you cant't use paths, but have to use a cid. This is because prefixes like /ipfs/ or /ipns/ are not allowed. FIXME: create a type for cid

The structure of a normal error response from the node.

The file system path to the file to be sent to the node. Because <cid>, /ipfs/<cid> or /ipns/<cid> are all allowed it looks like a path.

A simple :ok or :error response from the node.

The structure of a normal response from the node.

The structure of a JSON response from the node with :ok or :error.

The options to be sent to the node. These are dependent on the endpoint. it's because prefixes like /ipfs/ or /ipns/ are not allowed.

The path to the endpoint to be hit. For example, /add or /cat. It's called path because sometimes the MultiHash is not enough to identify the resource, and a path is needed, eg. /ipns/myspace.bahner.com

B58 encoded peer ID.

The structure of a JSON response from the node.

Functions

Add a file to IPFS.

Get the contents of a file from ipfs. Easy way to get the contents of a text file for instance.

Get a file or directory from IPFS.

Show the id of the IPFS node.

List the files in an IPFS object.

Mount an IPFS read-only mountpoint.

Ping a peer.

Resolve the value of names to IPFS.

Shutdown the IPFS daemon.

Link to this section Types

@type cid() :: atom() | String.t()

The name of the file or data to be sent to the node. Sometimes you cant't use paths, but have to use a cid. This is because prefixes like /ipfs/ or /ipns/ are not allowed. FIXME: create a type for cid

@type error() ::
  {:error, Tesla.Env.t()}
  | {:eserver, Tesla.Env.t()}
  | {:eclient, Tesla.Env.t()}
  | {:eaccess, Tesla.Env.t()}
  | {:emissing, Tesla.Env.t()}
  | {:enoallow, Tesla.Env.t()}

The structure of a normal error response from the node.

@type fspath() :: Path.t()

The file system path to the file to be sent to the node. Because <cid>, /ipfs/<cid> or /ipns/<cid> are all allowed it looks like a path.

@type ok() :: {:ok} | {:error, Tesla.Env.t()}

A simple :ok or :error response from the node.

@type okmapped() :: {:ok, list()} | {:error, Tesla.Env.t()}

The structure of a normal response from the node.

@type okresult() :: {:ok, any()} | {:error, Tesla.Env.t()}

The structure of a JSON response from the node with :ok or :error.

@type opts() :: list()

The options to be sent to the node. These are dependent on the endpoint. it's because prefixes like /ipfs/ or /ipns/ are not allowed.

@type path() :: Path.t()

The path to the endpoint to be hit. For example, /add or /cat. It's called path because sometimes the MultiHash is not enough to identify the resource, and a path is needed, eg. /ipns/myspace.bahner.com

@type peer_id() :: <<_::48, _::_*8>>

B58 encoded peer ID.

@type result() :: any() | {:error, Tesla.Env.t()}

The structure of a JSON response from the node.

Link to this section Functions

@spec add(fspath(), opts()) :: result()

Add a file to IPFS.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-add

@spec cat(path(), opts()) :: result()

Get the contents of a file from ipfs. Easy way to get the contents of a text file for instance.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-cat

[
  offset: <int64>,
  length: <int64>,
  progress: <bool>
]
Link to this function

daemon(start? \\ true, signal \\ :normal, opts \\ [])

View Source
@spec daemon(boolean(), atom(), opts()) :: pid()

Start the IPFS daemon.

You should run this before any other command, but it's probably easier to do outside of the library.

The flag is the signal to send to the daemon process when shutting it down, ie. when start? is false. The default is :normal.

options

Options

https://docs.ipfs.tech/reference/kubo/cli/#ipfs-daemon

[
  "--init", # <bool> Initialize IPFS with default settings, if not already initialized
  "--migrate", # <bool> If answer yes to migration prompt
  "--init-config <string>", # Path to the configuration file to use
  "--init-profile <string>", # Apply profile settings to config
  "--routing <string>", # Override the routing system
  "--mount", # <bool> Mount IPFS to the filesystem (experimental)
  "--writable", # <bool> Enable writing objects (with POST, PUT, DELETE)
  "--mount-ipfs <string>", # Path to the mountpoint for IPFS (if using --mount)
  "--mount-ipns <string>", # Path to the mountpoint for IPNS (if using --mount)
  "--unrestricted-api", # <bool> Allow API access to unlisted hashes
  "--disable-transport-encryption", # <bool> Disable transport encryption (for debugging)
  "--enable-gc", # <bool> Enable automatic repo garbage collection
  "--enable-pubsub-experiment", # <bool> Enable experimental pubsub
  "--enable-namesys-pubsub", # <bool> Enable experimental namesys pubsub
  "--agent-version-suffix <string>", # Suffix to append to the AgentVersion string for id()
]
@spec get(path(), opts()) :: okresult()

Get a file or directory from IPFS.

NB! Unsafe (relative symlinks) will raise an error. This is a limitation of the underlying library.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-get

[
  output: <string>, # Output to file or directory name. Optional, default: <cid-ipfs-or-ipns-path>
  archive: <bool>, # Output as a tarball. Optional, default: false
]

Compression is not implemented.

@spec id() :: okresult()

Show the id of the IPFS node.

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-id Returns a map with the following keys:

  • ID: the id of the node.
  • PublicKey: the public key of the node.
  • Addresses: the addresses of the node.
  • AgentVersion: the version of the node.
  • ProtocolVersion: the protocol version of the node.
  • Protocols: the protocols of the node.
@spec ls(path(), opts()) :: okresult()

List the files in an IPFS object.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-ls

[
  headers: <bool>,
  resolve-type: <bool>,
  stream: <bool>,
  size: <bool>,
]

response

Response

{
  Objects: [
    {
      "Name": "string",
      "Hash": "string",
      "Size": 0,
      "Type": 0,
      "Links": [
        {
          "Name": "string",
          "Hash": "string",
          "Size": 0,
          "Type": 0
        }
      ]
    }
  ]
}
@spec mount(opts()) :: okresult()

Mount an IPFS read-only mountpoint.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-mount

[
  ipfs-path: <string>, # default: /ipfs
  ipns-path: <string>, # default: /ipns
]
@spec ping(cid(), opts()) :: okresult()

Ping a peer.

parameters

Parameters

  • peer: the peer to ping.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-ping

[
  n|count: <int>,
]
Link to this function

resolve(path, opts \\ [])

View Source
@spec resolve(path(), opts()) :: okresult()

Resolve the value of names to IPFS.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-resolve

[
  recursive: true,
  nocache: true,
  dht-record-count: 10,
  dht-timeout: 10
]
@spec shutdown() :: ok()

Shutdown the IPFS daemon.