fix #57 .Env + Readme fixes

.gitignore

@@ -1 +1,2 @@
 .idea
+.env

Makefile

@@ -24,6 +24,35 @@ ethereum-test: ethereum-clean
 ethereum-deploy: ethereum-clean
 	@./contracts/solidity/deploy.sh
 
+
+Command := $(firstword $(MAKECMDGOALS))
+PARAM := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+ethereum-set-escrow:
+ifneq ($(PARAM),)
+	@./contracts/solidity/set_escrow.sh $(PARAM)
+else
+	@echo "Error: New Escrow address nedded"
+	@echo "Example of usage:"
+	@echo "make ethereum-set-escrow 0x01234..."
+endif
+%::
+	@true
+
+
+Command := $(firstword $(MAKECMDGOALS))
+PARAM := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+ethereum-set-withdraw-selector:
+ifneq ($(PARAM),)
+	@./contracts/solidity/set_withdraw_selector.sh $(PARAM)
+else
+	@echo "Error: New withdraw selector nedded"
+	@echo "Example of usage:"
+	@echo "make ethereum-set-withdraw-selector 0x01234..."
+endif
+%::
+	@true
+
+
 starknet-clean:
 	@cd ./contracts/cairo/ && scarb clean
 

README.md

@@ -101,47 +101,75 @@ Follow the steps below to set up a testnet smart wallet using `starkli`:
 
 ## Declare and Deploy Contracts in Testnet
 
+### Ethereum smart contract
+First, the Ethereum smart contracts must be deployed. For Ethereum the deployment process you will need to:
+
+1. Create your `.env` file: you need to configure the following variables in your own .env file on the contracts/solidity/ folder. You can use the env.example file as a template for creating your .env file, paying special attention to the formats provided
+
+   ```bash
+   ETH_RPC_URL = Infura or Alchemy RPC URL
+   ETH_PRIVATE_KEY = private key of your ETH wallet
+   ETHERSCAN_API_KEY = API Key to use etherscan to read the Ethereum blockchain
+   ```
+   **NOTE**:
+
+   - You can generate ETHERSCAN_API_KEY [following this steps](https://docs.etherscan.io/getting-started/creating-an-account).
+   - For the deploy, you will need some GoerliETH that you can get from this [faucet](https://goerlifaucet.com/).
+
+
+2. Deploy Solidity contract
+
+   ```bash
+      make ethereum-deploy
+   ```
+
+### Starknet smart contracts
+
+After the Ethereum smart contract is deployed, the Starknet smart contracts must be declared and deployed.
 On Starknet, the deployment process is in two steps:
 
 - Declaring the class of your contract, or sending your contract’s code to the
   network
 - Deploying a contract or creating an instance of the previously declared code
   with the necessary parameters
 
-1. Updated `.env` file: Please modify the variables with your Testnet account and your RPC provider.
+For this, you will need to:
+
+1. Create your `.env` file: you need to configure the following variables in your own .env file on the contracts/solidity folder. You can use the env.example file as a template for creating your .env file, paying special attention to the formats provided
 
    ```bash
-   // For the deploy, you just need to configure the following variables in the .env file on the mm-bot folder
-   ..
-   SN_RPC_URL=<STARKNET_RPC_HTTPS_URL> // Infura or Alchemy RPC URL 
-   ETH_CONTRACT_ADDR=0xdd69db25f6d620a7bad3023c5d32761d353d3de9 // GoerliETH 
-   SN_CONTRACT_ADDR=<STARKNET_MM_CONTRACT_ADDR>
-   ..
+   STARKNET_ACCOUNT = location of your starknet testnet account, created at the start of this README
+   STARKNET_KEYSTORE = location of your starknet testnet keystore, created at the start of this README
+   SN_RPC_URL = Infura or Alchemy RPC URL
+   ETH_CONTRACT_ADDR = newly created ETH contract address
+   MM_SN_WALLET_ADDR = Starknet wallet of the MarketMaker
+
    ```
+
 2. Declare and Deploy: We sequentially declare and deploy the contracts.
 
    ```bash
       make starknet-deploy
    ```
 
-For Ethereum the deployment process you will need:
+### Finalize connection between both chains
 
-3. Updated `.env` file: Please modify the variables with your Testnet account and your RPC provider.
+After the Starknet smart contracts are declared and deployed, the variable _EscrowAddress_ from the Ethereum smart contract must be updated with the newly created Starknet smart contract address.
 
-   ```bash
-   // For the deploy, you just need to configure the following variables in the .env file on the contracts/solidity/ folder
-   ..
-   ETH_RPC_URL=<ETH_RPC_URL> // Infura or Alchemy RPC URL
-   ETH_PRIVATE_KEY=<ETH_PRIVATE_KEY>
-   ETHERSCAN_API_KEY=<ETHERSCAN_API_KEY>
-   ..
-   ```
+To do this, you can use
+```
+make ethereum-set-escrow <new_escrow_address>
+```
+
+Also, Ethereum's smart contract has a variable, _EscrowWithdrawSelector_, which is for specifying the _withdraw_ function's name in the Starknet Escrow smart contract.
+You can set and change Ethereum's _EscrowWithdrawSelector_ variable, doing the following:
+```
+make ethereum-set-withdraw-selector <new_withdraw_selector>
+```
    **NOTE**:
+   - In able to get a formated selector name, you can type the function's name (for example, _withdraw_) in https://www.stark-utils.xyz/converter , change the _selector_ row to hex, and copy its value
 
-   - You can generate ETHERSCAN_API_KEY [following this steps](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics).
-   - For the deploy, you will need some GoerliETH that you can get from this [faucet](https://goerlifaucet.com/).
-4. Deploy Solidity contract
 
-   ```bash
-      make ethereum-deploy
-   ```
+
+## Recap
+After following this complete README, we should have an ETH smart contract as well as a Starknet smart contract, both connected to act as a bridge between these two chains.

contracts/cairo/.env.example

@@ -0,0 +1,5 @@
+STARKNET_ACCOUNT=<starkli_account_path>
+STARKNET_KEYSTORE=<starkli_keystore_path>
+SN_RPC_URL=<starknet_rpc_url>
+ETH_CONTRACT_ADDR=<ethereum_contract_address> #in lowercase hexa with the 0x prefix
+MM_SN_WALLET_ADDR=<marketmaker_starknet_contract_address> #in lowercase hexa with the 0x prefix

contracts/cairo/deploy.sh

@@ -15,28 +15,37 @@ cd "$(dirname "$0")"
 load_env() {
     unamestr=$(uname)
     if [ "$unamestr" = 'Linux' ]; then
-      export $(grep -v '^#' ../../mm-bot/.env | xargs -d '\n')
+      export $(grep -v '^#' .env | xargs -d '\n')
     elif [ "$unamestr" = 'FreeBSD' ] || [ "$unamestr" = 'Darwin' ]; then
-      export $(grep -v '^#' ../../mm-bot/.env | xargs -0)
+      export $(grep -v '^#' .env | xargs -0)
     fi
 }
 load_env
 
 echo -e "${GREEN}\n=> [SN] Declare Escrow${COLOR_RESET}"
-ESCROW_CLASS_HASH=$(starkli declare --watch --rpc $SN_RPC_URL target/dev/yab_Escrow.contract_class.json)
+ESCROW_CLASS_HASH=$(starkli declare \
+  --account $STARKNET_ACCOUNT --keystore $STARKNET_KEYSTORE \
+  --watch target/dev/yab_Escrow.contract_class.json)
 
 echo -e "- ${PURPLE}[SN] Escrow ClassHash: $ESCROW_CLASS_HASH${COLOR_RESET}"
 echo -e "- ${PURPLE}[SN] Herodotus Facts Registry: $HERODOTUS_FACTS_REGISTRY${COLOR_RESET}"
-echo -e "- ${PURPLE}[SN] Market Maker: $SN_WALLET_ADDR${COLOR_RESET}"
+echo -e "- ${PURPLE}[SN] Market Maker: $MM_SN_WALLET_ADDR${COLOR_RESET}"
 echo -e "- ${PURPLE}[SN] Ethereum ContractAddress $NATIVE_TOKEN_ETH_STARKNET${COLOR_RESET}"
 echo -e "- ${PINK}[ETH] Ethereum ContractAddress: $ETH_CONTRACT_ADDR${COLOR_RESET}"
 echo -e "- ${PINK}[ETH] Market Maker: $MM_ETHEREUM_WALLET${COLOR_RESET}"
 
 echo -e "${GREEN}\n=> [SN] Deploy Escrow${COLOR_RESET}"
-ESCROW_CONTRACT_ADDRESS=$(starkli deploy --watch --rpc $SN_RPC_URL $ESCROW_CLASS_HASH \
+ESCROW_CONTRACT_ADDRESS=$(starkli deploy \
+  --account $STARKNET_ACCOUNT --keystore $STARKNET_KEYSTORE \
+  --watch $ESCROW_CLASS_HASH \
     $HERODOTUS_FACTS_REGISTRY \
     $ETH_CONTRACT_ADDR \
     $MM_ETHEREUM_WALLET \
-    $SN_WALLET_ADDR \
+    $MM_SN_WALLET_ADDR \
     $NATIVE_TOKEN_ETH_STARKNET)
 echo -e "- ${PURPLE}[SN] Escrow ContractAddress: $ESCROW_CONTRACT_ADDRESS${COLOR_RESET}"
+
+cd ../..
+contracts/solidity/set_escrow.sh $ESCROW_CONTRACT_ADDRESS
+
+

contracts/solidity/.env.example

@@ -1,3 +1,3 @@
-GOERLI_RPC_URL=
-PRIVATE_KEY=
-ETHERSCAN_API_KEY=
+ETH_RPC_URL=<ethereum_rpc_url>
+ETH_PRIVATE_KEY=<eth_private_key> #in lowercase hexa with the 0x prefix
+ETHERSCAN_API_KEY=<etherscan_api_key>

contracts/solidity/deploy.sh

@@ -9,12 +9,12 @@ cd "$(dirname "$0")"
 load_env() {
     unamestr=$(uname)
     if [ "$unamestr" = 'Linux' ]; then
-      export $(grep -v '^#' ./.env | xargs -d '\n')
+      export $(grep -v '^#' .env | xargs -d '\n')
     elif [ "$unamestr" = 'FreeBSD' ] || [ "$unamestr" = 'Darwin' ]; then
-      export $(grep -v '^#' ./.env | xargs -0)
+      export $(grep -v '^#' .env | xargs -0)
     fi
 }
 load_env
 
 echo -e "${GREEN}\n=> [ETH] Deploy Escrow${COLOR_RESET}"
-forge script ./script/Deploy.s.sol --fork-url $GOERLI_RPC_URL --broadcast --verify -vvvv
+forge script ./script/Deploy.s.sol --fork-url $ETH_RPC_URL --broadcast --verify -vvvv

contracts/solidity/script/Deploy.s.sol

@@ -11,7 +11,10 @@ contract Deploy is Script {
 
         address snMessagingAddress = 0xde29d060D45901Fb19ED6C6e959EB22d8626708e;
         uint256 snEscrowAddress = 0x0;
-        uint256 snEscrowWithdrawSelector = 0x0;
+            //this is always the same value as long as starknet's function's name is "withdraw"
+            //this being the case, the function to overwrite this value should be deprecated
+        uint256 snEscrowWithdrawSelector = 0x15511cc3694f64379908437d6d64458dc76d02482052bfb8a5b33a72c054c77;
+
 
         new YABTransfer(
             snMessagingAddress,

contracts/solidity/set_escrow.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# ANSI format
+GREEN='\e[32m'
+COLOR_RESET='\033[0m'
+
+cd "$(dirname "$0")"
+
+echo -e "${GREEN}\n=> [ETH] Setting Starknet Escrow Address on ETH Smart Contract${COLOR_RESET}"
+
+if [ -f ./contracts/solidity/.env ]; then
+    echo "Sourcing .env file..."
+    source ./contracts/solidity/.env
+else
+    echo "Error: .env file not found!"
+    exit 1
+fi
+if [ -f ./contracts/cairo/.env ]; then
+    echo "Sourcing .env file..."
+    source ./contracts/cairo/.env
+else
+    echo "Error: .env file not found!"
+    exit 1
+fi
+
+echo "Smart contract being modified:" $ETH_CONTRACT_ADDR
+echo "New Escrow address:" $1
+
+cast send --rpc-url $ETH_RPC_URL --private-key $ETH_PRIVATE_KEY $ETH_CONTRACT_ADDR "setEscrowAddress(uint256)" $1
+# example param: 0x067393d445cfd2c1f5285d4624708ea0dd61aaf8c6aa99004a561577e490d36f

contracts/solidity/set_withdraw_selector.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+if [ -f ./contracts/solidity/.env ]; then
+    echo "Sourcing .env file..."
+    source ./contracts/solidity/.env
+else
+    echo "Error: .env file not found!"
+    exit 1
+fi
+if [ -f ./contracts/cairo/.env ]; then
+    echo "Sourcing .env file..."
+    source ./contracts/cairo/.env
+else
+    echo "Error: .env file not found!"
+    exit 1
+fi
+
+# ANSI format
+GREEN='\e[32m'
+COLOR_RESET='\033[0m'
+
+cd "$(dirname "$0")"
+
+echo -e "${GREEN}\n=> [ETH] Setting Starknet Withdraw Selector on ETH Smart Contract${COLOR_RESET}"
+echo "Smart contract being modified:" $ETH_CONTRACT_ADDR
+echo "New Withdraw Selector:" $1
+cast send --rpc-url $ETH_RPC_URL --private-key $ETH_PRIVATE_KEY $ETH_CONTRACT_ADDR "setEscrowWithdrawSelector(uint256)" $1
+# example param: 0x15511cc3694f64379908437d6d64458dc76d02482052bfb8a5b33a72c054c77

contracts/solidity/test/Transfer.sol

@@ -10,7 +10,7 @@ contract TransferTest is Test {
     function setUp() public {
         address snMessagingAddress = 0xde29d060D45901Fb19ED6C6e959EB22d8626708e;
         uint256 snEscrowAddress = 0x0;
-        uint256 snEscrowWithdrawSelector = 0x0;
+        uint256 snEscrowWithdrawSelector = 0x15511cc3694f64379908437d6d64458dc76d02482052bfb8a5b33a72c054c77;
         yab = new YABTransfer(snMessagingAddress, snEscrowAddress, snEscrowWithdrawSelector);
     }