Fully updated to v0.4.0

Author: 0xOmarA

1-exchanges/RaDEX/README.md

@@ -186,30 +186,34 @@ The first thing that we need to do now is to create four different accounts to u
 
 ```sh
 OP1=$(resim new-account)
+export PRIV_KEY1=$(echo "$OP1" | sed -nr "s/Private key: ([[:alnum:]_]+)/\1/p")
 export PUB_KEY1=$(echo "$OP1" | sed -nr "s/Public key: ([[:alnum:]_]+)/\1/p")
-export ACC_ADDRESS1=$(echo "$OP1" | sed -nr "s/Account address: ([[:alnum:]_]+)/\1/p")
+export ACC_ADDRESS1=$(echo "$OP1" | sed -nr "s/Account component address: ([[:alnum:]_]+)/\1/p")
 OP2=$(resim new-account)
+export PRIV_KEY2=$(echo "$OP2" | sed -nr "s/Private key: ([[:alnum:]_]+)/\1/p")
 export PUB_KEY2=$(echo "$OP2" | sed -nr "s/Public key: ([[:alnum:]_]+)/\1/p")
-export ACC_ADDRESS2=$(echo "$OP2" | sed -nr "s/Account address: ([[:alnum:]_]+)/\1/p")
+export ACC_ADDRESS2=$(echo "$OP2" | sed -nr "s/Account component address: ([[:alnum:]_]+)/\1/p")
 OP3=$(resim new-account)
+export PRIV_KEY3=$(echo "$OP3" | sed -nr "s/Private key: ([[:alnum:]_]+)/\1/p")
 export PUB_KEY3=$(echo "$OP3" | sed -nr "s/Public key: ([[:alnum:]_]+)/\1/p")
-export ACC_ADDRESS3=$(echo "$OP3" | sed -nr "s/Account address: ([[:alnum:]_]+)/\1/p")
+export ACC_ADDRESS3=$(echo "$OP3" | sed -nr "s/Account component address: ([[:alnum:]_]+)/\1/p")
 OP4=$(resim new-account)
+export PRIV_KEY4=$(echo "$OP4" | sed -nr "s/Private key: ([[:alnum:]_]+)/\1/p")
 export PUB_KEY4=$(echo "$OP4" | sed -nr "s/Public key: ([[:alnum:]_]+)/\1/p")
-export ACC_ADDRESS4=$(echo "$OP4" | sed -nr "s/Account address: ([[:alnum:]_]+)/\1/p")
+export ACC_ADDRESS4=$(echo "$OP4" | sed -nr "s/Account component address: ([[:alnum:]_]+)/\1/p")
 ```
 
 With the four accounts created, let's give some context as to what we will be doing next. The first thing that we wish to do is to create a number of test tokens that we can use to test out the functionality of the DEX. We would like Account 1 to be the creator of these test tokens and for it to then send some of these tokens to the other accounts so that they can test the DEX. Since Account 1 is the account that will be used for hte creation of the tokens, we need to set it as the default account:
 
 ```sh
-$ resim set-default-account $ACC_ADDRESS1 $PUB_KEY1
+$ resim set-default-account $ACC_ADDRESS1 $PUB_KEY1 $PRIV_KEY1
 Default account updated!
 ```
 
-The file [`token_creation_and_funding.rtm`](./transactions/token_creation_and_funding.rtm) contains the instructions needed for account 1 to create 8 different tokens (we will have a total of 9 tokens after this transaction as we do not need to create XRD) and then fund the 3 other accounts created before depositing all of the remaining tokens back into account 1. All of this will be done in one single neat atomically composed transaction that creates the tokens and deposits them into the accounts. To run the transaction file, run the following command:
+The files [`token_creation.rtm`](./transactions/token_creation.rtm), and [`token_funding.rtm`](./transactions/token_funding.rtm) contain the instructions needed for account 1 to create 8 different tokens (we will have a total of 9 tokens after this transaction as we do not need to create XRD) and then fund the 3 other accounts created before depositing all of the remaining tokens back into account 1. To run the transaction file, run the following command:
 
 ```sh
-resim run transactions/token_creation_and_funding.rtm
+resim run transactions/token_creation.rtm && resim run transactions/token_funding.rtm
 ```
 
 When this transaction runs, all of the accounts that we had created would now have 100,000 of some of the tokens that we will be using for the testing of the DEX. We can now publish the RaDEX package and also instantiate a new RaDEX component by running the following commands:
@@ -250,7 +254,7 @@ The [`creating_initial_liquidity_pools.rtm`](./transactions/creating_initial_liq
 Now that the process that we will be following is somewhat clear, let's get into running this transaction using Lynn's account. First things first, let's make sure that Lynn's account (Account 1) is set the default account in resim:
 
 ```sh
-$ resim set-default-account $ACC_ADDRESS1 $PUB_KEY1
+$ resim set-default-account $ACC_ADDRESS1 $PUB_KEY1 $PRIV_KEY1
 Default account updated!
 ```
 
@@ -293,7 +297,7 @@ Josh has decided to use RaDEX to perform the swap of BTC for USDT as RaDEX has t
 Let's now run the needed transaction manifest file for Josh to perform his swap of BTC for USDT. We first need to switch the default account in resim to Josh's account by doing the following:
 
 ```sh
-$ resim set-default-account $ACC_ADDRESS2 $PUB_KEY2
+$ resim set-default-account $ACC_ADDRESS2 $PUB_KEY2 $PRIV_KEY2
 Default account updated!
 ```
 
@@ -368,7 +372,7 @@ As can be seen in the diagram above, the first step in the transaction is the wi
 Let's now to get to work and try out this transaction. Let's begin by switching to Tim's account:
 
 ```sh
-$ resim set-default-account $ACC_ADDRESS3 $PUB_KEY3
+$ resim set-default-account $ACC_ADDRESS3 $PUB_KEY3 $PRIV_KEY3
 Default account updated!
 ```
 
@@ -405,7 +409,7 @@ Alfred has decided that he wants to sell some of the Bitcoin that he owns for US
 Now that we understand what will be done, we can go ahead and perform this transaction. Let's begin by switching over to Alfred's account:
 
 ```sh
-$ resim set-default-account $ACC_ADDRESS4 $PUB_KEY4
+$ resim set-default-account $ACC_ADDRESS4 $PUB_KEY4 $PRIV_KEY4
 Default account updated!
 ```
 
@@ -435,7 +439,7 @@ With the last example we are going back to Lynn (Account 1). After providing liq
 Let's begin by switching the default account in resim to be Lynn's account:
 
 ```sh
-$ resim set-default-account $ACC_ADDRESS1 $PUB_KEY1
+$ resim set-default-account $ACC_ADDRESS1 $PUB_KEY1 $PRIV_KEY1
 Default account updated!
 ```
 

1-exchanges/RaDEX/raw_transactions/component_creation.rtm

@@ -0,0 +1,4 @@
+# Creating a new RaDEX component from the package address by calling the `new` function on the blueprint. This `new`
+# function is a function which does not take any arguments nor does it return anything. Meaning that to create a new
+# RaDEX all that we need to do is to call the function.
+CALL_FUNCTION PackageAddress("<<<package_address>>>") "RaDEX" "new";

1-exchanges/RaDEX/raw_transactions/creating_initial_liquidity_pools.rtm

@@ -0,0 +1,61 @@
+# In order for the trading on the DEX to begin, we first need to have liquidity in the DEX so that users can swap their
+# tokens for another tokens. In this RTM file, we are adding liquidity to the DEX from the account that created the 
+# test tokens.
+
+# Withdrawing the total amount of tokens from the account and into the transaction worktop.
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("030000000000000000000000000000000000000000000000000004"); #Withdrawing XRD
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<tether_resource_address>>>"); #Withdrawing USDT
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<quant_resource_address>>>"); #Withdrawing QNT
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<cardano_resource_address>>>"); #Withdrawing ADA
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<bitcoin_resource_address>>>"); #Withdrawing BTC
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<litecoin_resource_address>>>"); #Withdrawing LTC
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<bnb_resource_address>>>"); #Withdrawing BNB
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw" ResourceAddress("<<<doge_resource_address>>>"); #Withdrawing DOGE
+
+# Creating an XRD-USDT pool with: 14,000 USDT and 100,000 XRD.
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("100000.00") ResourceAddress("030000000000000000000000000000000000000000000000000004") Bucket("XRD_USDT_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("14000.00") ResourceAddress("<<<tether_resource_address>>>") Bucket("USDT_XRD_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("USDT_XRD_bucket") Bucket("XRD_USDT_bucket");
+
+# Creating a QNT-USDT pool with: 100,000 USDT and 865.276 QNT.
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("865.276") ResourceAddress("<<<quant_resource_address>>>") Bucket("QNT_USDT_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("100000.00") ResourceAddress("<<<tether_resource_address>>>") Bucket("USDT_QNT_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("USDT_QNT_bucket") Bucket("QNT_USDT_bucket");
+
+# Creating a ADA-USDT pool with: 100,000 USDT and 105263.1578 ADA
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("105263.1578") ResourceAddress("<<<cardano_resource_address>>>") Bucket("ADA_USDT_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("100000.00") ResourceAddress("<<<tether_resource_address>>>") Bucket("USDT_ADA_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("USDT_ADA_bucket") Bucket("ADA_USDT_bucket");
+
+# Creating a BTC-USDT pool with: 10,000,000 USDT tokens and 232.558 BTC
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("232.558") ResourceAddress("<<<bitcoin_resource_address>>>") Bucket("BTC_USDT_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("10000000.00") ResourceAddress("<<<tether_resource_address>>>") Bucket("USDT_BTC_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("USDT_BTC_bucket") Bucket("BTC_USDT_bucket");
+
+# Creating an LTC-BTC pool with: 23.1835 BTC and 8720.6767 LTC
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("8720.6767") ResourceAddress("<<<litecoin_resource_address>>>") Bucket("LTC_BTC_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("23.1835") ResourceAddress("<<<bitcoin_resource_address>>>") Bucket("BTC_LTC_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("LTC_BTC_bucket") Bucket("BTC_LTC_bucket");
+
+# Creating an ADA-XRD pool with: 19526.357 ADA and 67485 XRD.
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("67485") ResourceAddress("030000000000000000000000000000000000000000000000000004") Bucket("XRD_ADA_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("19526.357") ResourceAddress("<<<cardano_resource_address>>>") Bucket("ADA_XRD_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("XRD_ADA_bucket") Bucket("ADA_XRD_bucket");
+
+# Creating an LTC-XRD pool with: 88.67 LTC and 67485 XRD
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("67485") ResourceAddress("030000000000000000000000000000000000000000000000000004") Bucket("XRD_LTC_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("88.67") ResourceAddress("<<<litecoin_resource_address>>>") Bucket("LTC_XRD_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("XRD_LTC_bucket") Bucket("LTC_XRD_bucket");
+
+# Creating an LTC-BNB pool with: 88.67 LTC and 24.2187 BNB
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("24.2187") ResourceAddress("<<<bnb_resource_address>>>") Bucket("BNB_LTC_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("88.67") ResourceAddress("<<<litecoin_resource_address>>>") Bucket("LTC_BNB_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("BNB_LTC_bucket") Bucket("LTC_BNB_bucket");
+
+# Creating an BNB-DOGE pool with: 2481.57 BNB and 7692307.692 DOGE
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("2481.57") ResourceAddress("<<<bnb_resource_address>>>") Bucket("BNB_DOGE_bucket");
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("7692307.692") ResourceAddress("<<<doge_resource_address>>>") Bucket("DOGE_BNB_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("BNB_DOGE_bucket") Bucket("DOGE_BNB_bucket");
+
+# Deposit the tracking tokens back into the account
+CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress("<<<account1_address>>>") "deposit_batch";

1-exchanges/RaDEX/raw_transactions/remove_BTC_USDT_liquidity.rtm

@@ -0,0 +1,12 @@
+# The owner of account 1 had created a number of liquidity pools and now wishes to withdraw the liquidity that they
+# had provided to RaDEX so that they can get their portion of the swap fees into their wallet.
+
+# Withdrawing all of the tracking tokens of the BTC/USDT pool from account 1 and creating a bucket of them
+CALL_METHOD ComponentAddress("<<<account1_address>>>") "withdraw_by_amount" Decimal("100") ResourceAddress("<<<btc_usdt_resource_address>>>");
+TAKE_FROM_WORKTOP ResourceAddress("<<<btc_usdt_resource_address>>>") Bucket("tracking_tokens_bucket");
+
+# Calling the `remove_liquidity` on the RaDEX component with the tracking tokens
+CALL_METHOD ComponentAddress("<<<component_address>>>") "remove_liquidity" Bucket("tracking_tokens_bucket");
+
+# Depositing all of the tokens on the worktop into the account
+CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress("<<<account1_address>>>") "deposit_batch";

1-exchanges/RaDEX/raw_transactions/swap_ADA_for_DOGE.rtm

@@ -0,0 +1,38 @@
+# The owner of account 3 wants to exchange some of the ADA that they own for some DOGE and wants to use RaDEX for this
+# swap. However, they can't find a direct pair for the swapping of ADA to DOGE.
+# 
+# Luckily, even though there does not exist a liquidity pool for ADA/DOGE, there does exist a path that can be taken to
+# swap ADA for DOGE tokens by going through a number of liquidity pools that connect these two tokens. The path of 
+# liquidity pools that will be taken to swap ADA for DOGE is as follows:
+# 
+# ADA -> ADA/XRD -> XRD/LTC -> LTC/BNB -> BNB/DOGE -> DOGE
+#
+# The swap can be even done in a single transaction using the RTM files to perform everything neatly and cleanly in a 
+# single transaction. In fact, performing the swap in a single transaction gives security to the owner of account 3 that
+# this swapping between different liquidity pools won't hinder on the amount of DOGE that they get at the end. If it 
+# affected it in a deeply negative way, then the assertion check at the end of the transaction file fails and everything
+# goes back to normal almost as if nothing had happened.
+
+# The owner of account 3 wishes to exchange 100 ADA for whatever amount of DOGE they can get. So, we withdraw 100 ADA 
+# into the transaction worktop and then into a bucket.
+CALL_METHOD ComponentAddress("<<<account3_address>>>") "withdraw_by_amount" Decimal("100.00") ResourceAddress("<<<cardano_resource_address>>>");
+TAKE_FROM_WORKTOP ResourceAddress("<<<cardano_resource_address>>>") Bucket("ADA_bucket");
+
+# Swapping ADA for XRD and then putting the XRD in a bucket
+CALL_METHOD ComponentAddress("<<<component_address>>>") "swap" Bucket("ADA_bucket") ResourceAddress("030000000000000000000000000000000000000000000000000004");
+TAKE_FROM_WORKTOP ResourceAddress("030000000000000000000000000000000000000000000000000004") Bucket("XRD_bucket");
+
+# Swapping XRD for LTC and then putting the LTC in a bucket
+CALL_METHOD ComponentAddress("<<<component_address>>>") "swap" Bucket("XRD_bucket") ResourceAddress("<<<litecoin_resource_address>>>");
+TAKE_FROM_WORKTOP ResourceAddress("<<<litecoin_resource_address>>>") Bucket("LTC_bucket");
+
+# Swapping LTC for BNB and then putting the BNB in a bucket
+CALL_METHOD ComponentAddress("<<<component_address>>>") "swap" Bucket("LTC_bucket") ResourceAddress("<<<bnb_resource_address>>>");
+TAKE_FROM_WORKTOP ResourceAddress("<<<bnb_resource_address>>>") Bucket("BNB_bucket");
+
+# Swapping BNB for DOGE and asserting that we obtained at least 300 DOGE from this long swap. If the assertion goes 
+# through then we deposit everything in the transaction worktop into the account.
+CALL_METHOD ComponentAddress("<<<component_address>>>") "swap" Bucket("BNB_bucket") ResourceAddress("<<<doge_resource_address>>>");
+ASSERT_WORKTOP_CONTAINS_BY_AMOUNT Decimal("300") ResourceAddress("<<<doge_resource_address>>>");
+
+CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress("<<<account3_address>>>") "deposit_batch";

1-exchanges/RaDEX/raw_transactions/swap_BTC_for_USDT.rtm

@@ -0,0 +1,27 @@
+# Unfortunately, the owner of account 2 is in some kind of financial trouble and needs some USDT urgently. They have 
+# found that they need about $500,000 for the financial trouble that they are in. The owner of account 2 has decided to
+# sell some of the bitcoin that they own to help them with the financial issues that they have. They're not interested 
+# in selling more than what they need and they're only willing to sell any amount of bitcoin below or equal to 20 BTC
+# to help them with their financial issues.
+#
+# The owner of account 2 have decided to use RaDEX to sell some of their BTC for exactly $500,000. This RTM file contains
+# the instructions that would be carried out in order to sell enough BTC to cover the financial needs of the owner of 
+# account 2.
+
+# Withdrawing 20 BTC into the transaction worktop to exchange them for USDT
+CALL_METHOD ComponentAddress("<<<account2_address>>>") "withdraw_by_amount" Decimal("20") ResourceAddress("<<<bitcoin_resource_address>>>");
+
+# Create a bucket from the 20 withdrawn BTC
+TAKE_FROM_WORKTOP_BY_AMOUNT Decimal("20") ResourceAddress("<<<bitcoin_resource_address>>>") Bucket("btc_bucket");
+
+# Calling the `swap_tokens_for_exact_tokens` method on the RaDEX component to attempt to swap the 20 BTC for the 
+# $500,000 that they need.
+CALL_METHOD ComponentAddress("<<<component_address>>>") "swap_tokens_for_exact_tokens" Bucket("btc_bucket") ResourceAddress("<<<tether_resource_address>>>") Decimal("500000");
+
+# Checking to ensure that after this method call, that $500,000 are present in the workop. If the 500,000 USDT tokens are
+# not present in the transaction worktop, then the transaction fails and the owner of account 2 gets back their BTC 
+# tokens. This is an extra check that's all. 
+ASSERT_WORKTOP_CONTAINS_BY_AMOUNT Decimal("500000") ResourceAddress("<<<tether_resource_address>>>");
+
+# If the above method call was successful, we deposit everything from the transaction worktop and back into the account
+CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress("<<<account2_address>>>") "deposit_batch";

1-exchanges/RaDEX/raw_transactions/swap_BTC_for_USDT_and_add_liquidity.rtm

@@ -0,0 +1,26 @@
+# The owner of account 4 (let's call him Alfred for the purposes of this example) has just heard of yield framing and how 
+# that he could make some extra income by providing liquidity to a liquidity pool and earning a percentage of the pool
+# fees that are imposed on swaps. 
+# 
+# Alfred has decided that he wants to sell some of the Bitcoin that he owns for USDT and then he wants to provide liquidity
+# to the XRD/USDT liquidity pool in RaDEX. This transaction manifest file contains the transaction instructions for the
+# selling of Bitcoin tokens for USDT and then providing liquidity to the XRD/USDT liquidity pool.
+
+# Withdrawing 500,000 XRD and 40 BTC from Alfred's account and into the transaction worktop
+CALL_METHOD ComponentAddress("<<<account4_address>>>") "withdraw_by_amount" Decimal("500000") ResourceAddress("030000000000000000000000000000000000000000000000000004");
+CALL_METHOD ComponentAddress("<<<account4_address>>>") "withdraw_by_amount" Decimal("40") ResourceAddress("<<<bitcoin_resource_address>>>");
+
+# Creating a bucket of the withdrawn Bitcoin and then swapping it for USDT
+TAKE_FROM_WORKTOP ResourceAddress("<<<bitcoin_resource_address>>>") Bucket("BTC_bucket");
+CALL_METHOD ComponentAddress("<<<component_address>>>") "swap" Bucket("BTC_bucket") ResourceAddress("<<<tether_resource_address>>>");
+
+# At this point, the transaction worktop should include USDT tokens if the swap has indeed gone through correctly, so 
+# we take the USDT tokens and put them in a bucket and we also put the XRD from the worktop into a bucket.
+TAKE_FROM_WORKTOP ResourceAddress("<<<tether_resource_address>>>") Bucket("USDT_bucket");
+TAKE_FROM_WORKTOP ResourceAddress("030000000000000000000000000000000000000000000000000004") Bucket("XRD_bucket");
+
+# Adding liquidity to the XRD/USDT liquidity pool with all of the XRD and USDT available in the transaction worktop
+CALL_METHOD ComponentAddress("<<<component_address>>>") "add_liquidity" Bucket("XRD_bucket") Bucket("USDT_bucket");
+
+# Depositing the tracking tokens we get back into Alfred's account.
+CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress("<<<account4_address>>>") "deposit_batch";