feat: add Ledger module and Ledger Transaction schema

apps/champions/lib/champions/battle.ex

@@ -5,6 +5,7 @@ defmodule Champions.Battle do
 
   require Logger
 
+  alias GameBackend.Ledger
   alias Ecto.Multi
   alias GameBackend.Users.Currencies
   alias Champions.Battle.Simulator
@@ -36,9 +37,7 @@ defmodule Champions.Battle do
 
       {:ok, response} =
         Multi.new()
-        |> Multi.run(:substract_currencies, fn _repo, _changes ->
-          Currencies.substract_currencies(user_id, level.attempt_cost)
-        end)
+        |> Ledger.register_currencies_spent(user_id, level.attempt_cost, "Fighting Level")
         |> Multi.run(:run_battle, fn _repo, _changes -> run_battle(user_id, level, units) end)
         |> Repo.transaction()
 

apps/champions/lib/champions/campaigns.ex

@@ -3,12 +3,12 @@ defmodule Champions.Campaigns do
   Campaigns logic for Champions of Mirra.
   """
 
+  alias GameBackend.Ledger
   alias GameBackend.Campaigns
   alias GameBackend.Campaigns.SuperCampaignProgress
   alias GameBackend.Items.Item
   alias GameBackend.Repo
   alias GameBackend.Units.Unit
-  alias GameBackend.Users.Currencies
   alias Ecto.Multi
 
   @doc """
@@ -117,10 +117,6 @@ defmodule Champions.Campaigns do
   end
 
   defp apply_currency_rewards(multi, user_id, currency_rewards) do
-    Enum.reduce(currency_rewards, multi, fn currency_reward, multi ->
-      Multi.run(multi, {:add_currency, currency_reward.currency_id}, fn _, _ ->
-        Currencies.add_currency(user_id, currency_reward.currency_id, currency_reward.amount)
-      end)
-    end)
+    Ledger.register_currency_earned(multi, user_id, currency_rewards, "Campaign Rewards")
   end
 end

apps/champions/lib/champions/gacha.ex

@@ -3,6 +3,7 @@ defmodule Champions.Gacha do
   Gacha logic for Champions of Mirra.
   """
 
+  alias GameBackend.Ledger
   alias GameBackend.Gacha
   alias GameBackend.Transaction
   alias GameBackend.Users
@@ -44,9 +45,7 @@ defmodule Champions.Gacha do
       result =
         Multi.new()
         |> Multi.run(:unit, fn _, _ -> Units.insert_unit(params) end)
-        |> Multi.run(:substract_currencies, fn _, _ ->
-          Currencies.substract_currencies(user_id, box.cost)
-        end)
+        |> Ledger.register_currencies_spent(user_id, box.cost, "Summoned Box Cost")
         |> Transaction.run()
 
       case result do

apps/champions/lib/champions/items.ex

@@ -3,6 +3,7 @@ defmodule Champions.Items do
   Items logic for Champions of Mirra.
   """
 
+  alias GameBackend.Ledger
   alias Ecto.Multi
   alias GameBackend.Items
   alias GameBackend.Transaction
@@ -55,9 +56,7 @@ defmodule Champions.Items do
         Multi.new()
         |> Multi.run(:item, fn _, _ -> Items.insert_item(%{user_id: user_id, template_id: new_template.id}) end)
         |> Multi.run(:deleted_items, fn _, _ -> delete_consumed_items(consumed_items_ids) end)
-        |> Multi.run(:currency_deduction, fn _, _ ->
-          Currencies.substract_currencies(user_id, new_template.upgrade_costs)
-        end)
+        |> Ledger.register_currencies_spent(user_id, new_template.upgrade_costs, "Fuse item")
         |> Transaction.run()
 
       case result do

apps/champions/lib/champions/units.ex

@@ -7,6 +7,7 @@ defmodule Champions.Units do
   - Tier ups cost an amount of gold that depends on the unit level, plus a set number of gems.
   """
 
+  alias GameBackend.Ledger
   alias GameBackend.Utils
   alias Ecto.Multi
   alias GameBackend.Transaction
@@ -89,9 +90,7 @@ defmodule Champions.Units do
       result =
         Multi.new()
         |> Multi.run(:unit, fn _, _ -> Units.add_level(unit) end)
-        |> Multi.run(:user_currency, fn _, _ ->
-          Currencies.substract_currencies(user_id, costs)
-        end)
+        |> Ledger.register_currencies_spent(user_id, costs, "Level Up Unit")
         |> Transaction.run()
 
       case result do
@@ -165,9 +164,7 @@ defmodule Champions.Units do
       result =
         Multi.new()
         |> Multi.run(:unit, fn _, _ -> Units.add_tier(unit) end)
-        |> Multi.run(:user_currency, fn _, _ ->
-          Currencies.substract_currencies(user_id, costs)
-        end)
+        |> Ledger.register_currencies_spent(user_id, costs, "Tier up")
         |> GameBackend.Transaction.run()
 
       case result do

apps/champions/lib/champions/users.ex

@@ -3,6 +3,7 @@ defmodule Champions.Users do
   Users logic for Champions Of Mirra.
   """
 
+  alias GameBackend.Ledger
   alias Ecto.{Changeset, Multi}
   alias Champions.Users
   alias GameBackend.Items
@@ -91,52 +92,45 @@ defmodule Champions.Users do
   end
 
   defp add_sample_currencies(user) do
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Gold", Utils.get_game_id(:champions_of_mirra)).id,
-      100
-    )
-
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Gems", Utils.get_game_id(:champions_of_mirra)).id,
-      500
-    )
-
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Summon Scrolls", Utils.get_game_id(:champions_of_mirra)).id,
-      100
-    )
-
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Fertilizer", Utils.get_game_id(:champions_of_mirra)).id,
-      100
-    )
-
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Arcane Crystals", Utils.get_game_id(:champions_of_mirra)).id,
-      100
-    )
-
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Hero Souls", Utils.get_game_id(:champions_of_mirra)).id,
-      100
-    )
-
-    Currencies.add_currency(
-      user.id,
-      Currencies.get_currency_by_name_and_game!("Blueprints", Utils.get_game_id(:champions_of_mirra)).id,
-      50
-    )
+    game_id = Utils.get_game_id(:champions_of_mirra)
 
-    Currencies.add_currency(
+    Ledger.register_currency_earned(
       user.id,
-      Currencies.get_currency_by_name_and_game!("Supplies", Utils.get_game_id(:champions_of_mirra)).id,
-      5
+      [
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Gold", game_id).id,
+          amount: 100
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Gems", game_id).id,
+          amount: 500
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Summon Scrolls", game_id).id,
+          amount: 100
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Fertilizer", game_id).id,
+          amount: 100
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Arcane Crystals", game_id).id,
+          amount: 100
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Hero Souls", game_id).id,
+          amount: 100
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Blueprints", game_id).id,
+          amount: 50
+        },
+        %{
+          currency_id: Currencies.get_currency_by_name_and_game!("Supplies", game_id).id,
+          amount: 5
+        }
+      ],
+      "Sample Currencies"
     )
   end
 
@@ -247,18 +241,13 @@ defmodule Champions.Users do
 
   defp claim_afk_rewards(user_id, afk_rewards, type) do
     Multi.new()
-    |> Multi.run(:add_currencies, fn _, _ ->
-      results =
-        Enum.map(afk_rewards, fn afk_reward ->
-          Currencies.add_currency(user_id, afk_reward.currency.id, trunc(afk_reward.amount))
-        end)
-
-      if Enum.all?(results, fn {result, _} -> result == :ok end) do
-        {:ok, Enum.map(results, fn {_ok, currency} -> currency end)}
-      else
-        {:error, "failed"}
-      end
-    end)
+    |> Ledger.register_currency_earned(
+      user_id,
+      Enum.map(afk_rewards, fn afk_reward ->
+        %{currency_id: afk_reward.currency.id, amount: trunc(afk_reward.amount)}
+      end),
+      "AFK Reward Claimed"
+    )
     |> Multi.run(:reset_afk_claim, fn _, _ ->
       Users.reset_afk_rewards_claim(user_id, type)
     end)

apps/game_backend/lib/game_backend/curse_of_mirra/matches.ex

@@ -2,6 +2,7 @@ defmodule GameBackend.CurseOfMirra.Matches do
   @moduledoc """
   Matches
   """
+  alias GameBackend.Ledger
   alias GameBackend.Users.Currencies
   alias GameBackend.Units
   alias GameBackend.Units.Unit
@@ -96,7 +97,11 @@ defmodule GameBackend.CurseOfMirra.Matches do
         if Map.has_key?(@gold_rewards_per_position, resulting_position) do
           gold_reward_amount = Map.get(@gold_rewards_per_position, resulting_position)
 
-          Currencies.add_currency(user.id, gold_currency.id, gold_reward_amount)
+          Ledger.register_currency_earned(
+            user.id,
+            [%{currency_id: gold_currency.id, amount: gold_reward_amount}],
+            "Match Reward"
+          )
         else
           {:ok, nil}
         end

apps/game_backend/lib/game_backend/curse_of_mirra/quests.ex

@@ -2,6 +2,7 @@ defmodule GameBackend.CurseOfMirra.Quests do
   @moduledoc """
     Module to work with quest logic
   """
+  alias GameBackend.Ledger
   alias GameBackend.Users
   alias GameBackend.CurseOfMirra.Quests
   alias GameBackend.Utils
@@ -256,9 +257,7 @@ defmodule GameBackend.CurseOfMirra.Quests do
 
           true ->
             Multi.new()
-            |> Multi.run(:deduct_currencies, fn _, _ ->
-              Currencies.substract_currencies(daily_quest.user_id, reroll_costs)
-            end)
+            |> Ledger.register_currencies_spent(daily_quest.user_id, reroll_costs, "Reroll Quest")
             |> Multi.update(:change_previous_quest, finish_previous_quest_changeset)
             |> Multi.insert(:insert_quest, new_quest_changeset)
             |> Repo.transaction()
@@ -282,16 +281,15 @@ defmodule GameBackend.CurseOfMirra.Quests do
         quest_id: quest_id
       })
 
+    currency = Currencies.get_currency_by_name_and_game(quest.reward["currency"], Utils.get_game_id(:curse_of_mirra))
+
     Multi.new()
     |> Multi.insert(:insert_completed_quest, user_quest_changeset)
-    |> Multi.run(:add_currency_to_user, fn _, _ ->
-      Currencies.add_currency_by_name_and_game(
-        user_id,
-        quest.reward["currency"],
-        Utils.get_game_id(:curse_of_mirra),
-        quest.reward["amount"]
-      )
-    end)
+    |> Ledger.register_currency_earned(
+      user_id,
+      [%{currency_id: currency.id, amount: quest.reward["amount"]}],
+      "Completed Quest Reward"
+    )
     |> Repo.transaction()
   end
 
@@ -340,6 +338,9 @@ defmodule GameBackend.CurseOfMirra.Quests do
         status: "completed"
       })
 
+    currency =
+      Currencies.get_currency_by_name_and_game(user_quest.reward["currency"], Utils.get_game_id(:curse_of_mirra))
+
     Multi.new()
     |> Multi.run(:check_quest_completed, fn _, _ ->
       if user_quest.status == "available" and Quests.completed_quest?(user_quest, user) do
@@ -363,14 +364,11 @@ defmodule GameBackend.CurseOfMirra.Quests do
           |> GameBackend.Repo.update()
       end
     end)
-    |> Multi.run(:add_currency, fn _, _ ->
-      Currencies.add_currency_by_name_and_game(
-        user.id,
-        user_quest.quest.reward["currency"],
-        Utils.get_game_id(:curse_of_mirra),
-        user_quest.quest.reward["amount"]
-      )
-    end)
+    |> Ledger.register_currency_earned(
+      user.id,
+      [%{currency_id: currency.id, amount: user_quest.reward["amount"]}],
+      "Completed Quest Reward"
+    )
     |> Multi.run(:updated_user, fn _, _ ->
       Users.get_user_by_id_and_game_id(user.id, user.game_id)
     end)

apps/game_backend/lib/game_backend/items.ex

@@ -8,11 +8,11 @@ defmodule GameBackend.Items do
   Items are created by instantiating copies of ItemTemplates. This way, many users can have their own copy of the "Epic Sword" item. Likewise, this allows for a user to have many copies of it, each equipped to a different unit.
   """
 
+  alias GameBackend.Ledger
   alias Ecto.Multi
   alias GameBackend.Items.Item
   alias GameBackend.Items.ItemTemplate
   alias GameBackend.Items.ConsumableItem
-  alias GameBackend.Users.Currencies
   alias GameBackend.Repo
   alias GameBackend.Units
 
@@ -272,7 +272,7 @@ defmodule GameBackend.Items do
   def buy_item(user_id, template_id, purchase_costs_list) do
     Multi.new()
     |> Multi.run(:item, fn _, _ -> insert_item(%{user_id: user_id, template_id: template_id}) end)
-    |> Multi.run(:currencies, fn _, _ -> Currencies.substract_currencies(user_id, purchase_costs_list) end)
+    |> Ledger.register_currencies_spent(user_id, purchase_costs_list, "Item Bought")
     |> Repo.transaction()
   end