From c5cd71580bcb518bdd48b779f7e71491ebc87435 Mon Sep 17 00:00:00 2001
From: Andrew Fleming <fleming-andrew@protonmail.com>
Date: Tue, 8 Oct 2024 16:48:50 -0400
Subject: [PATCH] Add declare script for presets (#1118)

* start declare script

* fix fmt

* fix fmt

* update Scarb

* finish declare script

* fix fmt

* update scarb

* move max_fee to const

* fix const

* add readme to declare script

* tidy up

* bump version

* move scripts to root

* add foundry items to gitignore

* Apply suggestions from code review

Co-authored-by: immrsd <103599616+immrsd@users.noreply.github.com>

* fix var

* change to v0.1

* remove dir

* update scarb.lock

---------

Co-authored-by: immrsd <103599616+immrsd@users.noreply.github.com>
---
 .gitignore                               |   2 +
 sncast_scripts/README.md                 |  32 +++++++
 sncast_scripts/Scarb.lock                | 104 +++++++++++++++++++++++
 sncast_scripts/Scarb.toml                |  25 ++++++
 sncast_scripts/src/declare_presets.cairo |  47 ++++++++++
 sncast_scripts/src/lib.cairo             |   1 +
 6 files changed, 211 insertions(+)
 create mode 100644 sncast_scripts/README.md
 create mode 100644 sncast_scripts/Scarb.lock
 create mode 100644 sncast_scripts/Scarb.toml
 create mode 100644 sncast_scripts/src/declare_presets.cairo
 create mode 100644 sncast_scripts/src/lib.cairo

diff --git a/.gitignore b/.gitignore
index 2956e1b18..7c5877656 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,6 +8,8 @@ target/
 
 # Starknet Foundry
 .snfoundry_cache/
+*-sepolia_state.json
+snfoundry.toml
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
diff --git a/sncast_scripts/README.md b/sncast_scripts/README.md
new file mode 100644
index 000000000..5c8b496b2
--- /dev/null
+++ b/sncast_scripts/README.md
@@ -0,0 +1,32 @@
+# Starknet Foundry Cast Scripts
+
+This crate provides scripts using Starknet Foundry's Cast package.
+
+## Prerequisites
+
+Running these scripts will likely require an already-deployed account with funds to execute.
+This crate can also be tested with [starknet-devnet](https://github.com/0xSpaceShard/starknet-devnet-rs).
+
+## Usage
+
+`cd` into the `sncast_scripts/` directory.
+Run the command:
+
+```bash
+sncast script run <SCRIPT> --url <URL>
+```
+
+## Scripts
+
+### `declare_presets`
+
+Declares the preset contracts.
+Here's the command using a starkli-style account:
+
+```bash
+sncast \
+--account path/to/account.json \
+--keystore path/to/key.json \
+script run declare_presets \
+--url http://127.0.0.1:5050
+```
diff --git a/sncast_scripts/Scarb.lock b/sncast_scripts/Scarb.lock
new file mode 100644
index 000000000..323d8226c
--- /dev/null
+++ b/sncast_scripts/Scarb.lock
@@ -0,0 +1,104 @@
+# Code generated by scarb DO NOT EDIT.
+version = 1
+
+[[package]]
+name = "openzeppelin_access"
+version = "0.17.0"
+dependencies = [
+ "openzeppelin_introspection",
+ "openzeppelin_utils",
+]
+
+[[package]]
+name = "openzeppelin_account"
+version = "0.17.0"
+dependencies = [
+ "openzeppelin_introspection",
+ "openzeppelin_utils",
+]
+
+[[package]]
+name = "openzeppelin_finance"
+version = "0.17.0"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_token",
+]
+
+[[package]]
+name = "openzeppelin_governance"
+version = "0.17.0"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_introspection",
+]
+
+[[package]]
+name = "openzeppelin_introspection"
+version = "0.17.0"
+
+[[package]]
+name = "openzeppelin_presets"
+version = "0.17.0"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_account",
+ "openzeppelin_finance",
+ "openzeppelin_introspection",
+ "openzeppelin_token",
+ "openzeppelin_upgrades",
+]
+
+[[package]]
+name = "openzeppelin_testing"
+version = "0.17.0"
+dependencies = [
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_token"
+version = "0.17.0"
+dependencies = [
+ "openzeppelin_account",
+ "openzeppelin_governance",
+ "openzeppelin_introspection",
+]
+
+[[package]]
+name = "openzeppelin_upgrades"
+version = "0.17.0"
+
+[[package]]
+name = "openzeppelin_utils"
+version = "0.17.0"
+
+[[package]]
+name = "sncast_scripts"
+version = "0.1.0"
+dependencies = [
+ "openzeppelin_presets",
+ "openzeppelin_testing",
+ "sncast_std",
+]
+
+[[package]]
+name = "sncast_std"
+version = "0.30.0"
+source = "registry+https://scarbs.xyz/"
+checksum = "sha256:cfd7c73a6f9984880249babfa8664b69c5f7209c737b1081156a284061ccd41a"
+
+[[package]]
+name = "snforge_scarb_plugin"
+version = "0.2.0"
+source = "registry+https://scarbs.xyz/"
+checksum = "sha256:2e4ce3ebe3f49548bd26908391b5d78537a765d827df0d96c32aeb88941d0d67"
+
+[[package]]
+name = "snforge_std"
+version = "0.30.0"
+source = "registry+https://scarbs.xyz/"
+checksum = "sha256:2f3c4846881813ac0f5d1460981249c9f5e2a6831e752beedf9b70975495b4ec"
+dependencies = [
+ "snforge_scarb_plugin",
+]
diff --git a/sncast_scripts/Scarb.toml b/sncast_scripts/Scarb.toml
new file mode 100644
index 000000000..c95571b12
--- /dev/null
+++ b/sncast_scripts/Scarb.toml
@@ -0,0 +1,25 @@
+[package]
+name = "sncast_scripts"
+version = "0.1.0"
+
+[dependencies]
+starknet = "2.8.2"
+sncast_std = "0.30.0"
+openzeppelin_presets = { path = "../" }
+openzeppelin_testing = { path = "../" }
+
+[lib]
+sierra = true
+casm = true
+
+[[target.starknet-contract]]
+sierra = true
+casm = true
+build-external-contracts = [
+    "openzeppelin_presets::account::AccountUpgradeable",
+    "openzeppelin_presets::erc20::ERC20Upgradeable",
+    "openzeppelin_presets::erc721::ERC721Upgradeable",
+    "openzeppelin_presets::erc1155::ERC1155Upgradeable",
+    "openzeppelin_presets::eth_account::EthAccountUpgradeable",
+    "openzeppelin_presets::vesting::VestingWallet",
+]
diff --git a/sncast_scripts/src/declare_presets.cairo b/sncast_scripts/src/declare_presets.cairo
new file mode 100644
index 000000000..f10355ec2
--- /dev/null
+++ b/sncast_scripts/src/declare_presets.cairo
@@ -0,0 +1,47 @@
+use openzeppelin_testing::common::IntoBase16String;
+use sncast_std::{declare, get_nonce, FeeSettings, EthFeeSettings};
+
+const MAX_FEE: felt252 = 99_999_999_999_999_999;
+
+fn main() {
+    let contracts = array![
+        "AccountUpgradeable",
+        "ERC20Upgradeable",
+        "ERC721Upgradeable",
+        "ERC1155Upgradeable",
+        "EthAccountUpgradeable",
+        "VestingWallet"
+    ];
+
+    let mut consumed_latest_nonce = false;
+    let mut nonce = get_nonce('latest');
+
+    for contract in contracts {
+        if (!consumed_latest_nonce) {
+            consumed_latest_nonce = true;
+        } else {
+            nonce = get_nonce('pending');
+        }
+
+        declare_preset(contract, nonce);
+    };
+
+    println!("");
+}
+
+fn declare_preset(contract: ByteArray, nonce: felt252) {
+    println!("\nDeclaring {contract}:");
+
+    let declare_result = declare(
+        contract,
+        FeeSettings::Eth(EthFeeSettings { max_fee: Option::Some(MAX_FEE) }),
+        Option::Some(nonce)
+    );
+
+    // Print output
+    // Note that the tx hash will already display from the declaration
+    match declare_result {
+        Result::Ok(r) => println!("Class hash = {}", r.class_hash.into_base_16_string()),
+        Result::Err(r) => println!("{:?}", r)
+    }
+}
diff --git a/sncast_scripts/src/lib.cairo b/sncast_scripts/src/lib.cairo
new file mode 100644
index 000000000..b62967d68
--- /dev/null
+++ b/sncast_scripts/src/lib.cairo
@@ -0,0 +1 @@
+mod declare_presets;