View Source MyspaceIPFS.Api (Myspace IPFS v0.0.1)

MyspaceIPFS.Api 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.API, as: Api
  iex> Api.get("Multihash_key")
  <<0, 19, 148, 0, ... >>

Link to this section Summary

Functions

Link to this section Functions

@spec add(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Basic.add/1.

@spec bitswap_ledger(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bitswap.ledger/1.

@spec bitswap_reprovide() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bitswap.reprovide/0.

Link to this function

bitswap_stat(verbose, human)

View Source
@spec bitswap_stat(boolean(), boolean()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bitswap.stat/2.

@spec bitswap_wantlist(any()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bitswap.wantlist/1.

@spec block_get(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Block.get/1.

@spec block_put(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Block.put/1.

@spec block_rm(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Block.rm/1.

@spec block_stat(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Block.stat/1.

@spec bootstrap_add_default() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bootstrap.add_default/0.

@spec bootstrap_list() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bootstrap.list/0.

@spec bootstrap_rm_all() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Bootstrap.rm_all/0.

@spec cat(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Basic.cat/1.

@spec commands() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Commands.commands/0.

Link to this function

commands_completion(shell)

View Source
@spec commands_completion(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Commands.completion/1.

@spec dag_get(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Dag.get/1.

@spec dag_put(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Dag.put/1.

@spec dht_query(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Dht.query/1.

@spec diag_cmds() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Diag.cmds/0.

@spec diag_cmds_clear() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Diag.cmds_clear/0.

Link to this function

diag_cmds_set_time(time)

View Source
@spec diag_cmds_set_time(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Diag.cmds_set_time/1.

@spec diag_sys() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Diag.sys/0.

@spec files_cp(binary(), binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.cp/2.

@spec files_flush() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.flush/0.

@spec files_ls() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.ls/0.

@spec files_mkdir(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.mkdir/1.

@spec files_mv(binary(), binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.mv/2.

@spec files_read(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.read/1.

@spec files_rm(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.rm/1.

@spec files_stat(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.stat/1.

@spec files_write(binary(), binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Data.Files.write/2.

@spec filestore_dups() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Filestore.dups/0.

@spec filestore_ls() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Filestore.ls/0.

@spec filestore_verify() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Filestore.verify/0.

@spec get(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Basic.get/1.

@spec id() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.id/0.

@spec key_gen(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Key.gen/1.

@spec key_list() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Key.list/0.

Link to this function

log_level(subsystem, level)

View Source
@spec log_level(binary(), binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Log.level/2.

@spec log_ls() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Log.ls/0.

@spec log_tail() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.Log.tail/0.

@spec ls(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Basic.ls/1.

@spec mount() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.mount/0.

@spec name_publish(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Name.publish/1.

@spec name_resolve() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Name.resolve/0.

@spec pin_add(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Pin.add/1.

@spec pin_ls(any()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Pin.ls/1.

@spec pin_rm(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Pin.rm/1.

@spec ping(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.ping/1.

@spec pubsub_ls() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.PubSub.ls/0.

@spec pubsub_peers() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.PubSub.peers/0.

@spec pubsub_pub(binary(), binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.PubSub.pub/2.

@spec pubsub_sub(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.PubSub.sub/1.

@spec refs(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Basic.Refs.refs/1.

@spec refs_local() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Basic.Refs.local/0.

@spec repo_gc() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Repo.gc/0.

@spec repo_stat() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Repo.stat/0.

@spec repo_verify() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Repo.verify/0.

@spec repo_version() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Repo.version/0.

@spec resolve(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.resolve/1.

@spec shutdown() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.shutdown/0.

Link to this function

start_shell(start? \\ true, flag \\ [])

View Source
@spec start_shell(any(), any()) :: true | pid()
@spec stats_bitswap() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Stats.bitswap/0.

@spec stats_bw() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Stats.bw/0.

@spec stats_dht() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Stats.dht/0.

@spec stats_provide() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Stats.provide/0.

@spec stats_repo() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Advanced.Stats.repo/0.

@spec swarm_addrs() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.addrs/0.

@spec swarm_addrs_listen() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.addrs_listen/0.

@spec swarm_addrs_local() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.addrs_local/0.

@spec swarm_connect(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.connect/1.

Link to this function

swarm_disconnect(peer_id)

View Source
@spec swarm_disconnect(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.disconnect/1.

@spec swarm_filters() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.filters/0.

@spec swarm_filters_add(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.filters_add/1.

@spec swarm_filters_rm(binary()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.filters_rm/1.

@spec swarm_peers() ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Network.Swarm.peers/0.

@spec update(binary()) :: binary()

See MyspaceIPFS.Api.Tools.update/1.

Link to this function

version(num, comm, repo, all)

View Source
@spec version(any(), any(), any(), any()) ::
  {:client_error | :forbidden | :missing | :not_allowed | :ok | :server_error,
   any()}

See MyspaceIPFS.Api.Tools.version/4.