This repository has been archived by the owner on Jun 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 495
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
295a0bd
commit ba44d3a
Showing
3 changed files
with
177 additions
and
159 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| # Deployment Script Example | ||
|
|
||
| This tutorial explains how to set up a test and deployment environment for smart contracts. The given script initializes accounts, runs tests, and carries out multicalls. | ||
|
|
||
| Disclaimer: This is an example. Use it as a foundation for your own work, adjusting as needed. | ||
|
|
||
| ## Setup | ||
|
|
||
| ### 1. Prepare the Script File | ||
|
|
||
| - In your project's root folder, create a file named **`script.sh`**. This will house the script. | ||
| - Adjust permissions to make the file executable: | ||
|
|
||
| ```sh | ||
| chmod +x script.sh | ||
| ``` | ||
|
|
||
| ### 2. Insert the Script | ||
|
|
||
| Below is the content for `script.sh`. It adheres to best practices for clarity, error management, and long-term support. | ||
|
|
||
| **Security Note**: Using environment variables is safer than hardcoding private keys in your scripts, but they're still accessible to any process on your machine and could potentially be leaked in logs or error messages. | ||
|
|
||
| ```sh | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Ensure the script stops on first error | ||
| set -e | ||
|
|
||
| # Global variables | ||
| file_path="$HOME/.starknet_accounts/starknet_open_zeppelin_accounts.json" | ||
| CONTRACT_NAME="HelloStarknet" | ||
| PROFILE_NAME="account1" | ||
| MULTICALL_FILE="multicall.toml" | ||
| FAILED_TESTS=false | ||
|
|
||
| # Addresses and Private keys as environment variables | ||
| ACCOUNT1_ADDRESS=${ACCOUNT1_ADDRESS:-"0x7f61fa3893ad0637b2ff76fed23ebbb91835aacd4f743c2347716f856438429"} | ||
| ACCOUNT2_ADDRESS=${ACCOUNT2_ADDRESS:-"0x53c615080d35defd55569488bc48c1a91d82f2d2ce6199463e095b4a4ead551"} | ||
| ACCOUNT1_PRIVATE_KEY=${ACCOUNT1_PRIVATE_KEY:-"CHANGE_ME"} | ||
| ACCOUNT2_PRIVATE_KEY=${ACCOUNT2_PRIVATE_KEY:-"CHANGE_ME"} | ||
|
|
||
| # Utility function to log messages | ||
| function log_message() { | ||
| echo -e "\n$1" | ||
| } | ||
|
|
||
| # Step 1: Clean previous environment | ||
| if [ -e "$file_path" ]; then | ||
| log_message "Removing existing accounts file..." | ||
| rm -rf "$file_path" | ||
| fi | ||
|
|
||
| # Step 2: Define accounts for the smart contract | ||
| accounts_json=$(cat <<EOF | ||
| [ | ||
| { | ||
| "name": "account1", | ||
| "address": "$ACCOUNT1_ADDRESS", | ||
| "private_key": "$ACCOUNT1_PRIVATE_KEY" | ||
| }, | ||
| { | ||
| "name": "account2", | ||
| "address": "$ACCOUNT2_ADDRESS", | ||
| "private_key": "$ACCOUNT2_PRIVATE_KEY" | ||
| } | ||
| ] | ||
| EOF | ||
| ) | ||
|
|
||
| # Step 3: Run contract tests | ||
| echo -e "\nTesting the contract..." | ||
| testing_result=$(snforge 2>&1) | ||
| if echo "$testing_result" | grep -q "Failure"; then | ||
| echo -e "Tests failed!\n" | ||
| snforge | ||
| echo -e "\nEnsure that your tests are passing before proceeding.\n" | ||
| FAILED_TESTS=true | ||
| fi | ||
|
|
||
| if [ "$FAILED_TESTS" != "true" ]; then | ||
| echo "Tests passed successfully." | ||
|
|
||
| # Step 4: Create new account(s) | ||
| echo -e "\nCreating account(s)..." | ||
| for row in $(echo "${accounts_json}" | jq -c '.[]'); do | ||
| name=$(echo "${row}" | jq -r '.name') | ||
| address=$(echo "${row}" | jq -r '.address') | ||
| private_key=$(echo "${row}" | jq -r '.private_key') | ||
|
|
||
| account_creation_result=$(sncast --url http://localhost:5050/rpc account add --name "$name" --address "$address" --private-key "$private_key" --add-profile 2>&1) | ||
| if echo "$account_creation_result" | grep -q "error:"; then | ||
| echo "Account $name already exists." | ||
| else | ||
| echo "Account $name created successfully." | ||
| fi | ||
| done | ||
|
|
||
| # Step 5: Build, declare, and deploy the contract | ||
| echo -e "\nBuilding the contract..." | ||
| scarb build | ||
|
|
||
| echo -e "\nDeclaring the contract..." | ||
| declaration_output=$(sncast --profile "$PROFILE_NAME" --wait declare --contract-name "$CONTRACT_NAME" 2>&1) | ||
|
|
||
| if echo "$declaration_output" | grep -q "error: Class with hash"; then | ||
| echo "Class hash already declared." | ||
| CLASS_HASH=$(echo "$declaration_output" | sed -n 's/.*Class with hash \([^ ]*\).*/\1/p') | ||
| else | ||
| echo "New class hash declaration." | ||
| CLASS_HASH=$(echo "$declaration_output" | grep -o 'class_hash: 0x[^ ]*' | sed 's/class_hash: //') | ||
| fi | ||
|
|
||
| echo "Class Hash: $CLASS_HASH" | ||
|
|
||
| echo -e "\nDeploying the contract..." | ||
| deployment_result=$(sncast --profile "$PROFILE_NAME" deploy --class-hash "$CLASS_HASH") | ||
| CONTRACT_ADDRESS=$(echo "$deployment_result" | grep -o "contract_address: 0x[^ ]*" | awk '{print $2}') | ||
| echo "Contract address: $CONTRACT_ADDRESS" | ||
|
|
||
| # Step 6: Create and execute multicalls | ||
| echo -e "\nSetting up multicall..." | ||
| cat >"$MULTICALL_FILE" <<-EOM | ||
| [[call]] | ||
| call_type = 'invoke' | ||
| contract_address = '$CONTRACT_ADDRESS' | ||
| function = 'increase_balance' | ||
| inputs = ['0x1'] | ||
| [[call]] | ||
| call_type = 'invoke' | ||
| contract_address = '$CONTRACT_ADDRESS' | ||
| function = 'increase_balance' | ||
| inputs = ['0x2'] | ||
| EOM | ||
|
|
||
| echo "Executing multicall..." | ||
| sncast --profile "$PROFILE_NAME" multicall run --path "$MULTICALL_FILE" | ||
|
|
||
| # Step 7: Query the contract state | ||
| echo -e "\nChecking balance..." | ||
| sncast --profile "$PROFILE_NAME" call --contract-address "$CONTRACT_ADDRESS" --function get_balance | ||
|
|
||
| # Step 8: Clean up temporary files | ||
| echo -e "\nCleaning up..." | ||
| [ -e "$MULTICALL_FILE" ] && rm "$MULTICALL_FILE" | ||
|
|
||
| echo -e "\nScript completed successfully.\n" | ||
| fi | ||
| ``` | ||
|
|
||
| ### 3. Adjust the Bash Path | ||
|
|
||
| The line `#!/usr/bin/env bash` indicates the path to the bash interpreter. If you require a different version or location of bash, determine its path using: | ||
|
|
||
| ```sh | ||
| which bash | ||
| ``` | ||
|
|
||
| Then replace `#!/usr/bin/env` bash in the script with the resulting path, such as `#!/path/to/your/bash`. | ||
|
|
||
| ## Execution | ||
|
|
||
| When running the script, you'll need to provide the environment variables `ACCOUNT1_PRIVATE_KEY` and `ACCOUNT2_PRIVATE_KEY`. | ||
|
|
||
| Example: | ||
|
|
||
| ```sh | ||
| ACCOUNT1_PRIVATE_KEY="0x259f4329e6f4590b" ACCOUNT2_PRIVATE_KEY="0xb4862b21fb97d" ./script.sh | ||
| ``` | ||
|
|
||
| ## Considerations | ||
|
|
||
| - The **`set -e`** directive in the script ensures it exits if any command fails, enhancing the reliability of the deployment and testing process. | ||
| - Always secure private keys and sensitive information. Keep them away from logs and visible outputs. | ||
| - For greater flexibility, consider moving hardcoded values like accounts or contract names to a configuration file. This approach simplifies updates and overall management. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters