defmodule MyspaceIPFS.Dht do
  @moduledoc """
  MyspaceIPFS.Dht is where the dht commands of the IPFS API reside.
  """
  import MyspaceIPFS.Api
  import MyspaceIPFS.Utils

  @typep peer_id :: MyspaceIPFS.peer_id()
  @typep okresult :: MyspaceIPFS.okresult()

  @doc """
  Find the closest peers to a given key.

  ## Parameters
  `peer_id` - The peer ID to find the closest peers to.

  ## Options
  https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-dht-query
  ```
  [
    `verbose` - <bool>, # Print extra information.
  ]
  ```
  """
  @spec query(peer_id) :: okresult
  def query(peer_id) do
    post_query("/dht/query?arg=" <> peer_id)
    |> handle_plain_response()
  end
end