defmodule Elisk.Delegates do
    @moduledoc """
    Functions for retrieving information from Delegates.

    The responses for each API request have a common basic structure:
        "data": {}, //Contains the requested data
        "meta": {}, //Contains additional metadata, e.g. the values of `limit` and `offset`
        "links": {} //Will contain links to connected API calls from here, e.g. pagination links
    """

    @doc """
    Get Lisk Delegates.

    **Method**: GET

    Elisk.Delegates.get_delegates()
    # => { data, meta, links }
    """
    def get_delegates do
        Elisk.handle_get_request('/delegates', %{})
    end

    @doc """
    Get Lisk forgers.

    **Method**: GET

    Elisk.Delegates.get_forgers()
    # => { data, meta, links }
    """
    def get_forgers do
        Elisk.handle_get_request('/delegates/forgers', %{})
    end

    @doc """
    Get Lisk forging statistics.

    **Method**: GET

    Elisk.Delegates.get_forging_statistics("309766985700168161L")
    # => { data, meta, links }
    """
    def get_forging_statistics(address) do
        Elisk.handle_get_request('/delegates/#{address}/forging_statistics', %{})
    end
end