From e6731a013a58bdf7d41b61eac4e22c486450491c Mon Sep 17 00:00:00 2001
From: Evan Schwartz <3262610+emschwartz@users.noreply.github.com>
Date: Fri, 21 Jun 2024 16:51:06 -0400
Subject: [PATCH] feat: add balancing transfers exercise

---
 README.md                             |  1 +
 exercises/027_balancing_transfers.sh  | 46 +++++++++++++++++++++++++++
 patches/027_balancing_transfers.patch | 13 ++++++++
 3 files changed, 60 insertions(+)
 create mode 100755 exercises/027_balancing_transfers.sh
 create mode 100644 patches/027_balancing_transfers.patch

diff --git a/README.md b/README.md
index cba2e1b..113214c 100644
--- a/README.md
+++ b/README.md
@@ -56,3 +56,4 @@ You might also be interested in reading more in the [TigerBeetle docs](https://d
 - Multi-debit, multi-credit transfers
 - Currency exchange
 - Two-phase transfers (pending, posting, voiding, timeouts, and partial amounts)
+- Balancing transfers (used when closing accounts)
diff --git a/exercises/027_balancing_transfers.sh b/exercises/027_balancing_transfers.sh
new file mode 100755
index 0000000..f144f7e
--- /dev/null
+++ b/exercises/027_balancing_transfers.sh
@@ -0,0 +1,46 @@
+#!/bin/bash
+source ./tools/tb_function.sh
+
+# When closing an account, you may want to calculate the account's net debit or net credit balance
+# to zero that balance and transfer it to another account. This is a balancing transfer.
+
+# Note that TigerBeetle does not yet support marking accounts as closed or frozen
+# (though one or both of these will likely be added in the future).
+# For now, you can zero out the account balance and use application logic to
+# prevent transfers to or from the account.
+
+# Let's create three accounts.
+# The first is our operator account,
+# the second has a credit balance,
+# and the third has a debit balance.
+tb "create_accounts id=2700 code=10 ledger=270,
+                    id=2701 code=10 ledger=270 flags=debits_must_not_exceed_credits,
+                    id=2702 code=10 ledger=270 flags=credits_must_not_exceed_debits;"
+
+# We'll make sure the accounts have a positive credit and debit balance, respectively:
+tb "create_transfers id=27000 debit_account_id=2700 credit_account_id=2701 amount=100 ledger=270 code=10,
+                     id=27001 debit_account_id=2702 credit_account_id=2700 amount=200 ledger=270 code=10;"
+
+# Now we're going to zero out the balance of one of the accounts:
+(tb "create_transfers id=27002 debit_account_id=2701 credit_account_id=2700 amount=0 ledger=270 code=10 flags=balancing_debit;" || true)
+# Notice that the amount is 0. TigerBeetle will calculate the account's net balance
+# (in this case the net credit balance because we're using a balancing_debit) and transfer it to the other account.
+# Also, we are ignoring the result of this command because if we run it a second time, it will return the
+# error `tigerbeetle.CreateTransferResult.exists_with_different_amount` because the amount will be 100 rather than 0.
+
+# Can you zero out the balance of the other account?
+# (Remember, we don't want a `balancing_debit` in this case...)
+tb "create_transfers id=27003 debit_account_id=2700 credit_account_id=2702 amount=??? ledger=270 code=10 flags=???;"
+
+# Let's check that both accounts have a net balance of 0:
+account_one=$(tb "lookup_accounts id=2701;")
+if [[ $account_one != *"\"debits_posted\": \"100\""* && $account_one != *"\"credits_posted\": \"100\""* ]]; then
+    echo "Account 2701 should have a net balance of 0."
+    exit 1
+fi
+
+account_two=$(tb "lookup_accounts id=2702;")
+if [[ $account_two != *"\"debits_posted\": \"200\""* && $account_two != *"\"credits_posted\": \"200\""* ]]; then
+    echo "Account 2702 should have a net balance of 0."
+    exit 1
+fi
diff --git a/patches/027_balancing_transfers.patch b/patches/027_balancing_transfers.patch
new file mode 100644
index 0000000..2e006de
--- /dev/null
+++ b/patches/027_balancing_transfers.patch
@@ -0,0 +1,13 @@
+diff --git a/exercises/027_balancing_transfers.sh b/exercises/027_balancing_transfers.sh
+index f144f7e..3f1ebb8 100755
+--- a/exercises/027_balancing_transfers.sh
++++ b/exercises/027_balancing_transfers.sh
+@@ -30,7 +30,7 @@ tb "create_transfers id=27000 debit_account_id=2700 credit_account_id=2701 amoun
+ 
+ # Can you zero out the balance of the other account?
+ # (Remember, we don't want a `balancing_debit` in this case...)
+-tb "create_transfers id=27003 debit_account_id=2700 credit_account_id=2702 amount=??? ledger=270 code=10 flags=???;"
++tb "create_transfers id=27003 debit_account_id=2700 credit_account_id=2702 amount=0 ledger=270 code=10 flags=balancing_credit;"
+ 
+ # Let's check that both accounts have a net balance of 0:
+ account_one=$(tb "lookup_accounts id=2701;")