Update contract deployment for new RLN contract (#110)

* Run deploy scripts for new incentivized contract and mint tokens per account

* Add service to manage RLN contract token minting per nwaku service

* Add token-mint-service as tool

* revert back to sh instead of bash for contract deployer script

* Add comments and code cleanup

Author: stubbsta

deploy_rln_contract.sh

@@ -21,18 +21,15 @@ fi
 cd /waku-rlnv2-contract
 git checkout $RLN_CONTRACT_REPO_COMMIT
 
-#3. Replace the hardcoded MAX_MESSAGE_LIMIT
-sed -i "s/\b100\b/${MAX_MESSAGE_LIMIT}/g" script/Deploy.s.sol
-
-# 4. Compile
+# 3. Compile Contract Repo
 echo "forge install..."
 forge install
 echo "pnpm install..."
 pnpm install
 echo "forge build..."
 forge build
 
-# 5. Export environment variables
+# 4. Export environment variables
 export RCL_URL=$RCL_URL
 export PRIVATE_KEY=$PRIVATE_KEY
 export ETH_FROM=$ETH_FROM
@@ -41,5 +38,23 @@ export API_KEY_ETHERSCAN=123
 export API_KEY_CARDONA=123
 export API_KEY_LINEASCAN=123
 
-# 6. Deploy the contract
-forge script script/Deploy.s.sol:Deploy --rpc-url $RPC_URL --broadcast -vv --private-key $PRIVATE_KEY --sender $ETH_FROM
+# 5. Deploy the TestToken
+echo "\nDeploying TestToken (ERC20 Token Contract)...\n"
+forge script test/TestToken.sol --broadcast -vv --rpc-url http://foundry:8545 --tc TestTokenFactory --private-key $PRIVATE_KEY
+export TOKEN_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
+
+echo "\nDeploying LinearPriceCalculator Contract..."
+forge script script/Deploy.s.sol --broadcast -vv --rpc-url http://foundry:8545 --tc DeployPriceCalculator --private-key $PRIVATE_KEY
+
+echo "\nDeploying RLN contract..."
+forge script script/Deploy.s.sol --broadcast -vv --rpc-url http://foundry:8545 --tc DeployWakuRlnV2 --private-key $PRIVATE_KEY
+
+echo "\nDeploying Proxy contract..."
+forge script script/Deploy.s.sol --broadcast -vvv --rpc-url http://foundry:8545 --tc DeployProxy --private-key $PRIVATE_KEY
+export CONTRACT_ADDRESS=0x5FC8d32690cc91D4c39d9d3abcBD16989F875707
+
+# 6. Contract deployment completed
+echo "\nContract deployment completed successfully"
+echo "TOKEN_ADDRESS: $TOKEN_ADDRESS"
+echo "CONTRACT_ADDRESS: $CONTRACT_ADDRESS"
+echo "\nEach account registering a membership needs to first mint the token and approve the contract to spend it on their behalf."

docker-compose.yml

@@ -26,6 +26,8 @@ services:
         --allow-origin=*
         --block-time=12
         --chain-id=1234
+        --gas-limit=30000000
+        --gas-price=1
         --silent
         --config-out=/shared/anvil-config.txt
     volumes:
@@ -38,16 +40,17 @@ services:
     labels:
       com.centurylinklabs.watchtower.enable: '${WATCHTOWER_ENABLED:-false}'
     environment:
-      - RLN_CONTRACT_REPO_COMMIT=${RLN_CONTRACT_REPO_COMMIT:-64df4593c6a14e43b8b0e9b396d2f4772bb08b34}
+      - RLN_CONTRACT_REPO_COMMIT=${RLN_CONTRACT_REPO_COMMIT:-ad0dc9a81d892864ac2576d74e628ce93da592ef}
       - PRIVATE_KEY=${PRIVATE_KEY}
       - RPC_URL=${RPC_URL:-http://foundry:8545}
       - ETH_FROM=${ETH_FROM}
-      - MAX_MESSAGE_LIMIT=${MAX_MESSAGE_LIMIT:-20}
+      - NUM_NWAKU_NODES=${NUM_NWAKU_NODES:-5}
     entrypoint: sh
     command:
       - '/opt/deploy_rln_contract.sh'
     volumes:
       - ./deploy_rln_contract.sh:/opt/deploy_rln_contract.sh
+      - privatekeys-volume:/shared
     depends_on:
       - foundry
     networks:
@@ -82,16 +85,41 @@ services:
     entrypoint: sh
     environment:
       - RPC_URL=${RPC_URL:-http://foundry:8545}
-      - RLN_CONTRACT_ADDRESS=0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9
+      - RLN_CONTRACT_ADDRESS=0x5FC8d32690cc91D4c39d9d3abcBD16989F875707
       - RLN_CREDENTIAL_PATH=/keystore.json
       - RLN_CREDENTIAL_PASSWORD=passw123
-      - RLN_RELAY_MSG_LIMIT=${RLN_RELAY_MSG_LIMIT:-10}
-      - RLN_RELAY_EPOCH_SEC=${RLN_RELAY_EPOCH_SEC:-60}
+      - RLN_RELAY_MSG_LIMIT=${RLN_RELAY_MSG_LIMIT:-100}
+      - RLN_RELAY_EPOCH_SEC=${RLN_RELAY_EPOCH_SEC:-600}
+      - TOKEN_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
+      - PRIVATE_KEY=${PRIVATE_KEY}
     command:
       - '/opt/run_nwaku.sh'
     volumes:
       - ./run_nwaku.sh:/opt/run_nwaku.sh:Z
       - privatekeys-volume:/shared
+    init: true
+    depends_on:
+      contract-repo-deployer:
+        condition: service_completed_successfully
+      nwaku-token-init:
+        condition: service_completed_successfully
+    networks:
+      - simulation
+
+  nwaku-token-init:
+    build:
+      context: ./tools/token-mint-service
+      dockerfile: Dockerfile
+    environment:
+      - RPC_URL=${RPC_URL:-http://foundry:8545}
+      - TOKEN_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
+      - CONTRACT_ADDRESS=0x5FC8d32690cc91D4c39d9d3abcBD16989F875707
+      - PRIVATE_KEY=${PRIVATE_KEY}
+      - NUM_NWAKU_NODES=${NUM_NWAKU_NODES:-5}
+    deploy:
+      replicas: ${NUM_NWAKU_NODES:-5}
+    volumes:
+      - privatekeys-volume:/shared
     depends_on:
       contract-repo-deployer:
         condition: service_completed_successfully

run_nwaku.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
+ANVIL_CONFIG_PATH=${ANVIL_CONFIG_PATH:-/shared/anvil-config.txt}
+
 # Check Linux Distro Version - it can differ depending on the nwaku image used
 OS=$(cat /etc/os-release)
 if echo $OS | grep -q "Debian"; then
@@ -49,7 +51,7 @@ fi
 get_private_key(){
 
   # Read the JSON file
-  json_content=$(cat /shared/anvil-config.txt)
+  json_content=$(cat "$ANVIL_CONFIG_PATH")
 
   # Check if json_content has a value
   if [ -z "$json_content" ]; then

tools/token-mint-service/Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.11-alpine
+
+WORKDIR /app
+
+# Install system packages needed by the script
+RUN apk add --no-cache bind-tools jq
+
+# Install requirements
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy scripts
+COPY init_node_tokens.py .
+COPY get_account_key.sh .
+
+# Make scripts executable
+RUN chmod +x /app/init_node_tokens.py /app/get_account_key.sh
+
+# Use the account key helper as entrypoint
+ENTRYPOINT ["/bin/sh", "/app/get_account_key.sh"]

tools/token-mint-service/get_account_key.sh

@@ -0,0 +1,51 @@
+#!/bin/sh
+# Helper script to get the index of the container and use it to retrieve a unique account private key.
+# Each node uses a unique Ethereum account to register with the RLN contract.
+# The account and private key pairs are stored in anvil-config.txt on a shared volume at anvil startup in the foundry service
+
+set -e
+
+ANVIL_CONFIG_PATH=${ANVIL_CONFIG_PATH:-/shared/anvil-config.txt}
+
+# Get container IP and determine index (same method as run_nwaku.sh)
+IP=$(ip a | grep "inet " | grep -Fv 127.0.0.1 | sed 's/.*inet \([^/]*\).*/\1/')
+echo "Container IP: $IP"
+
+# Extract container name from reverse DNS lookup and get index
+CNTR=$(dig -x $IP +short | cut -d'.' -f1)
+INDEX=$(echo $CNTR | sed 's/.*[-_]\([0-9]*\)/\1/')
+
+if [ $? -ne 0 ] || [ -z "$INDEX" ]; then
+    echo "Error: Failed to determine the replica index from IP." >&2
+    exit 1
+fi
+
+echo "Determined container index: $INDEX"
+
+# Read anvil config
+json_content=$(cat "$ANVIL_CONFIG_PATH")
+if [ -z "$json_content" ]; then
+    echo "Error: Failed to read the JSON file or the file is empty." >&2
+    exit 1
+fi
+
+# Get private key and address for this index 
+ARRAY_INDEX=$((INDEX - 1))
+
+ACCOUNT_PRIVATE_KEY=$(echo "$json_content" | jq -r ".private_keys[$ARRAY_INDEX]")
+ACCOUNT_ADDRESS=$(echo "$json_content" | jq -r ".available_accounts[$ARRAY_INDEX]")
+
+if [ "$ACCOUNT_PRIVATE_KEY" = "null" ] || [ "$ACCOUNT_ADDRESS" = "null" ]; then
+    echo "Failed to get account private key or address for index $INDEX (array index $ARRAY_INDEX)" >&2
+    exit 1
+fi
+
+# Export for the Python script
+export NODE_PRIVATE_KEY="$ACCOUNT_PRIVATE_KEY"
+export NODE_ADDRESS="$ACCOUNT_ADDRESS"  
+export NODE_INDEX="$INDEX"
+
+echo "Node $INDEX using Ethereum account: $ACCOUNT_ADDRESS"
+
+# Run the Python initialization script
+exec python3 /app/init_node_tokens.py