Improve local deployment (#1662)

Co-authored-by: Javier Rodríguez Chatruc <[email protected]>

Author: ilitteri

claim_contracts/Makefile

@@ -7,14 +7,14 @@ help: ## 📚 Show help for each of the Makefile recipes
 # Deployments
 
 RPC_URL?=http://localhost:8545
-PRIVATE_KEY?=0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a
+DEPLOYER_PRIVATE_KEY?=0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a
 CONFIG?=example
 deploy-token: ## 🚀 Deploy the token contract
 	cd script && \
 	forge script DeployAlignedToken.s.sol \
 	--sig "run(string)" \
 	$(CONFIG) \
-	--private-key $(PRIVATE_KEY) \
+	--private-key $(DEPLOYER_PRIVATE_KEY) \
 	--rpc-url $(RPC_URL) \
 	--broadcast \
 	--verbosity 3
@@ -23,7 +23,7 @@ deploy-token-testnet: ## 🚀 Deploy the token contract
 	cd script && \
 	forge script DeployAlignedToken.s.sol \
 	--sig "run(string)" sepolia
-	--private-key $(PRIVATE_KEY) \
+	--private-key $(DEPLOYER_PRIVATE_KEY) \
 	--rpc-url $(RPC_URL) \
 	--broadcast \
 	--verbosity 3
@@ -42,15 +42,15 @@ deploy-claimable-local: ## 🚀 Deploy the airdrop contract in localnet
 	cd script && \
 	forge script DeployClaimableAirdrop.s.sol \
 	--sig "run(string)" example \
-	--private-key $(PRIVATE_KEY) \
+	--private-key $(DEPLOYER_PRIVATE_KEY) \
 	--rpc-url http://localhost:8545 \
 	--broadcast
 
 deploy-claimable-testnet: ## 🚀 Deploy the airdrop contract in Sepolia
 	cd script && \
 	forge script DeployClaimableAirdrop.s.sol \
 	--sig "run(string)" sepolia \
-	--private-key $(PRIVATE_KEY) \
+	--private-key $(DEPLOYER_PRIVATE_KEY) \
 	--rpc-url $(RPC_URL) \
 	--broadcast \
 	--verify \
@@ -85,6 +85,9 @@ upgrade-token: ## 🚀 Upgrade the token contract
 # Miscellaneous
 
 DISTRIBUTOR_PRIVATE_KEY?=0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
+OWNER_PRIVATE_KEY=0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a
+AIRDROP=0xBC9129Dc0487fc2E169941C75aABC539f208fb01
+TOKEN=0x2E983A1Ba5e8b38AAAeC4B440B9dDcFBf72E15d1
 
 approve-claimable: ## 🚀 Approve the ClaimableAirdrop contract to spend the token
 	cast send \
@@ -96,7 +99,7 @@ approve-claimable: ## 🚀 Approve the ClaimableAirdrop contract to spend the to
 claimable-update-root: ## 🚀 Update the merkle root of the ClaimableAirdrop contract
 	cast send \
 		--rpc-url $(RPC_URL) \
-		--private-key $(PRIVATE_KEY) \
+		--private-key $(OWNER_PRIVATE_KEY) \
 		$(AIRDROP) \
 		'updateMerkleRoot(bytes32)' $(MERKLE_ROOT)
 
@@ -109,7 +112,7 @@ claimable-get-root: ## 🚀 Get the merkle root of the ClaimableAirdrop contract
 claimable-update-timestamp: ## 🚀 Update the limit timestamp of the ClaimableAirdrop contract
 	cast send \
 		--rpc-url $(RPC_URL) \
-		--private-key $(PRIVATE_KEY) \
+		--private-key $(OWNER_PRIVATE_KEY) \
 		$(AIRDROP) \
 		'extendClaimPeriod(uint256)' $(TIMESTAMP)
 
@@ -119,16 +122,16 @@ claimable-get-timestamp: ## 🚀 Get the limit timestamp of the ClaimableAirdrop
 		$(AIRDROP) \
 		"limitTimestampToClaim()(uint256)"
 
-pause:
+claimable-pause:
 	cast send \
 		--rpc-url $(RPC_URL) \
-		--private-key $(PRIVATE_KEY) \
+		--private-key $(OWNER_PRIVATE_KEY) \
 		$(AIRDROP) "pause()"
 
-unpause:
+claimable-unpause:
 	cast send \
 		--rpc-url $(RPC_URL) \
-		--private-key $(PRIVATE_KEY) \
+		--private-key $(OWNER_PRIVATE_KEY) \
 		$(AIRDROP) "unpause()"
 
 # Upgrades
@@ -164,3 +167,6 @@ OWNER_PRIVATE_KEY?=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f
 test-airdrop:
 	cast call $(AIRDROP) "paused()(bool)" --rpc-url $(RPC_URL)
 	cast call $(AIRDROP) "owner()(address)" --rpc-url $(RPC_URL)
+
+# Requires MERKLE_ROOT, TIMESTAMP
+deploy-example: deploy-token deploy-claimable-local claimable-update-root claimable-update-timestamp approve-claimable claimable-unpause

claim_contracts/README.md

@@ -22,10 +22,6 @@
    make deploy-claimable-local
    ```
 5. Write down the claimable contract proxy address that is printed in the console output.
-6. Approve the claimable contract to spend the token from the distributor
-   ```
-   make approve-claimable TOKEN=<token-proxy-address> AIRDROP=<claimable-proxy-address> PRIVATE_KEY=0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
-   ```
 
 ## Testnet (Sepolia)
 
@@ -44,10 +40,34 @@
 3. Write down the `token-proxy-address` that is printed in the console output. Do this in the `config.sepolia.json` file, under the `tokenProxy` key.
 4. Deploy the claimable contract
    ```
-   make deploy-claimable-testnet RPC_URL=<sepolia-rpc-url> PRIVATE_KEY=<sepolia-funded-account-private-key> ETHERSCAN_API_KEY=<etherscan-api-key>
+   make deploy-claimable-testnet RPC_URL=<sepolia-rpc-url> DEPLOYER_PRIVATE_KEY=<sepolia-funded-account-private-key> ETHERSCAN_API_KEY=<etherscan-api-key>
    ```
 5. Write down the `claimable-proxy-address` that is printed in the console output.
-6. Approve the claimable contract to spend the token from the distributor
+
+## Enabling Claimability
+
+### Local
+
+1. Deploy the claimable contract as explained above.
+2. Set the correct merkle root
+   ```
+   make claimable-update-root MERKLE_ROOT=<claims-merkle-root>
+   ```
+3. Set the correct claim time limit
    ```
-   make approve-claimable TOKEN=<token-proxy-address> AIRDROP=<claimable-proxy-address> PRIVATE_KEY=<sepolia-funded-distributor-private-key>
+   make claimable-update-timestamp TIMESTAMP=2733427549
    ```
+4. Approve the claimable contract to spend the token from the distributor
+   ```
+   make approve-claimable
+   ```
+5. Unpause the claimable contract
+   ```
+   make claimable-unpause
+   ```
+
+or
+
+```
+make deploy-example MERKLE_ROOT=<claims-merkle-root> TIMESTAMP=2733427549
+```