Cover Explorer.Chain.Log

apps/explorer/lib/explorer/chain/log.ex

@@ -62,6 +62,41 @@ defmodule Explorer.Chain.Log do
 
   # Functions
 
+  @doc """
+  `address_hash` and `transaction_hash` are converted to `t:Explorer.Chain.Hash.t/0`.  The allowed values for `type`
+  are currently unknown, so it is left as a `t:String.t/0`.
+
+      iex> changeset = Explorer.Chain.Log.changeset(
+      ...>   %Explorer.Chain.Log{},
+      ...>   %{
+      ...>     address_hash: "0x8bf38d4764929064f2d4d3a56520a76ab3df415b",
+      ...>     data: "0x000000000000000000000000862d67cb0773ee3f8ce7ea89b328ffea861ab3ef",
+      ...>     first_topic: "0x600bcf04a13e752d1e3670a5a9f1c21177ca2a93c6f5391d4f1298d098097c22",
+      ...>     fourth_topic: nil,
+      ...>     index: 0,
+      ...>     second_topic: nil,
+      ...>     third_topic: nil,
+      ...>     transaction_hash: "0x53bd884872de3e488692881baeec262e7b95234d3965248c39fe992fffd433e5",
+      ...>     type: "mined"
+      ...>   }
+      ...> )
+      iex> changeset.valid?
+      true
+      iex> changeset.changes.address_hash
+      %Explorer.Chain.Hash{
+        byte_count: 20,
+        bytes: <<139, 243, 141, 71, 100, 146, 144, 100, 242, 212, 211, 165, 101, 32, 167, 106, 179, 223, 65, 91>>
+      }
+      iex> changeset.changes.transaction_hash
+      %Explorer.Chain.Hash{
+        byte_count: 32,
+        bytes: <<83, 189, 136, 72, 114, 222, 62, 72, 134, 146, 136, 27, 174, 236, 38, 46, 123, 149, 35, 77, 57, 101, 36,
+                 140, 57, 254, 153, 47, 255, 212, 51, 229>>
+      }
+      iex> changeset.changes.type
+      "mined"
+
+  """
   def changeset(%__MODULE__{} = log, attrs \\ %{}) do
     log
     |> cast(attrs, @required_attrs)
@@ -71,6 +106,28 @@ defmodule Explorer.Chain.Log do
     |> validate_required(@required_attrs)
   end
 
+  @doc """
+  `address_hash` is always present, so it is always returned in the set.
+
+      iex> %Ecto.Changeset{changes: changes, valid?: true} = Explorer.Chain.Log.changeset(
+      ...>   %Explorer.Chain.Log{},
+      ...>   %{
+      ...>     address_hash: "0x8bf38d4764929064f2d4d3a56520a76ab3df415b",
+      ...>     data: "0x000000000000000000000000862d67cb0773ee3f8ce7ea89b328ffea861ab3ef",
+      ...>     first_topic: "0x600bcf04a13e752d1e3670a5a9f1c21177ca2a93c6f5391d4f1298d098097c22",
+      ...>     fourth_topic: nil,
+      ...>     index: 0,
+      ...>     second_topic: nil,
+      ...>     third_topic: nil,
+      ...>     transaction_hash: "0x53bd884872de3e488692881baeec262e7b95234d3965248c39fe992fffd433e5",
+      ...>     type: "mined"
+      ...>   }
+      ...> )
+      iex> address_hash_set = Explorer.Chain.Log.changes_to_address_hash_set(changes)
+      iex> changes.address_hash in address_hash_set
+      true
+
+  """
   def changes_to_address_hash_set(%{address_hash: address_hash}) do
     MapSet.new([address_hash])
   end

apps/explorer/test/explorer/chain/log_test.exs

@@ -4,6 +4,8 @@ defmodule Explorer.Chain.LogTest do
   alias Ecto.Changeset
   alias Explorer.Chain.Log
 
+  doctest Log
+
   describe "changeset/2" do
     test "accepts valid attributes" do
       params = params_for(:log)