BREAKING_CHANGE: adapt soldeer, enhance script runtime, extra features

.github/workflows/test.yml

@@ -3,10 +3,10 @@ name: test
 on:
   push:
     branches:
-      - mainnet
-      - testnet
       - 'feature/*'
       - 'features/*'
+      - 'implement-feature/**'
+      - 'implement-feature/**/**'
   pull_request:
     branches:
       - mainnet
@@ -30,14 +30,17 @@ jobs:
           submodules: recursive
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
+        uses: foundry-rs/foundry-toolchain@v1 
         with:
-          version: nightly
+          version: nightly-2b1f8d6dd90f9790faf0528e05e60e573a7569ce
+
+      - name: Install soldeer
+        run: forge soldeer install
 
       - name: Run Forge build
         run: |
           forge --version
-          forge build --sizes
+          forge build
         id: build
 
       - name: Run Forge tests

.gitignore

@@ -16,7 +16,8 @@ docs/
 *.env
 .vscode
 
-node_modules/
-yarn-error.log
-.yarn
-.yarnrc.yml
+deployments/**/exported_address
+dependencies
+deployments
+logs/deployed-contracts
+broadcast

foundry.toml

@@ -1,24 +1,55 @@
 [profile.default]
 src = "src"
 out = "out"
-libs = ["lib"]
+libs = ["dependencies"]
+test = "test"
 ffi = true
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
 
-solc = '0.8.23'
 extra_output = ["devdoc", "userdoc", "storagelayout"]
-evm_version = 'istanbul'
+evm_version = 'london'
 use_literal_content = true
 fs_permissions = [{ access = "read-write", path = "./" }]
 
 [fmt]
 line_length = 120
 tab_width = 2
 bracket_spacing = true
+multiline_func_header = 'params_first'
+single_line_statement_blocks = 'single'
+sort_imports = true
+number_underscore = "thousands"
+wrap_comments = true
 
 [rpc_endpoints]
 ethereum = "https://eth.llamarpc.com"
 goerli = "https://ethereum-goerli.publicnode.com"
 ronin-mainnet = "https://api-partner.roninchain.com/rpc"
 ronin-testnet = "https://saigon-archive.roninchain.com/rpc"
-localhost = "http://localhost:8545"
+localhost = "http://localhost:8545"
+
+[dependencies]
+"forge-std" = { version = "1.9.3", url = "https://github.com/foundry-rs/forge-std/archive/refs/tags/v1.9.3.zip" }
+"solady" = { version = "0.0.228", url = "https://github.com/Vectorized/solady/archive/refs/tags/v0.0.228.zip" }
+"openzeppelin" = { version = "5.0.2", url = "https://github.com/OpenZeppelin/openzeppelin-contracts/archive/refs/tags/v5.0.2.zip" }
+"openzeppelin-v4" = { version = "4.9.5", url = "https://github.com/OpenZeppelin/openzeppelin-contracts/archive/refs/tags/v4.9.5.zip" }
+
+[soldeer]
+# whether soldeer manages remappings
+remappings_generate = false
+
+# whether soldeer re-generates all remappings when installing, updating or uninstalling deps
+remappings_regenerate = false
+
+# whether to suffix the remapping with the version: `name-a.b.c`
+remappings_version = true
+
+# a prefix to add to the remappings ("@" would give `@name`)
+remappings_prefix = ""
+
+# where to store the remappings ("txt" for `remappings.txt` or "config" for `foundry.toml`)
+# ignored when `soldeer.toml` is used as config (uses `remappings.txt`)
+remappings_location = "txt"
+
+# whether to install sub-dependencies or not. If true this wil install the dependencies of dependencies 1 level down.
+recursive_deps = true

generate-artifact.sh

@@ -0,0 +1,120 @@
+#!/bin/bash
+
+# Parse the command-line arguments
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+    --name)
+        name="$2"
+        shift
+        ;;
+    --args)
+        args="$2"
+        shift
+        ;;
+    --value)
+        value="$2"
+        shift
+        ;;
+    --nonce)
+        nonce="$2"
+        shift
+        ;;
+    --address)
+        address="$2"
+        shift
+        ;;
+    --deployer)
+        deployer="$2"
+        shift
+        ;;
+    --chainid)
+        chainid="$2"
+        shift
+        ;;
+    --block-number)
+        block_number="$2"
+        shift
+        ;;
+    --timestamp)
+        timestamp="$2"
+        shift
+        ;;
+    --absolute-path)
+        absolute_path="$2"
+        shift
+        ;;
+    --path)
+        path="$2"
+        shift
+        ;;
+    --artifact-name)
+        artifact_name="$2"
+        shift
+        ;;
+    *)
+        echo "Unknown parameter passed: $1"
+        exit 1
+        ;;
+    esac
+    shift
+done
+
+if [[ -z "$name" || -z "$args" || -z "$value" || -z "$nonce" || -z "$deployer" || -z "$chainid" || -z "$block-number" || -z "$timestamp" || -z "$absolute_path" || -z "$path" ]]; then
+    echo "Error: Missing required arguments."
+    echo "Usage: ./generate-artifact.sh --name <name> --value <value> --nonce <nonce> --address <address> --deployer <deployer> --chainid <chainid> --block-number <block_number> --timestamp <timestamp> --absolute-path <absolute_path> --args <args> --path <path> --artifact-name <artifact_name>"
+    exit 1
+fi
+
+# Generate the artifact
+abi=$(forge inspect $name abi)
+devdoc=$(forge inspect $name devdoc)
+userdoc=$(forge inspect $name userdoc)
+metadata=$(forge inspect $name metadata)
+storage_layout=$(forge inspect $name storageLayout)
+bytecode=$(forge inspect $name bytecode)
+deployed_bytecode=$(forge inspect $name deployedBytecode)
+
+# Create the JSON object
+json_content=$(
+    jq -n \
+        --arg name "$name" \
+        --arg address "$address" \
+        --arg args "$args" \
+        --arg value "$value" \
+        --arg nonce "$nonce" \
+        --arg deployer "$deployer" \
+        --arg chainid "$chainid" \
+        --arg block_number "$block_number" \
+        --arg timestamp "$timestamp" \
+        --argjson abi "$abi" \
+        --argjson devdoc "$devdoc" \
+        --argjson userdoc "$userdoc" \
+        --argjson metadata "$metadata" \
+        --argjson storage_layout "$storage_layout" \
+        --arg bytecode "$bytecode" \
+        --arg deployed_bytecode "$deployed_bytecode" \
+        '{
+        name: $name,
+        address: $address,
+        args: $args,
+        value: $value,
+        nonce: $nonce,
+        deployer: $deployer,
+        chainid: $chainid,
+        block_number: $block_number,
+        timestamp: $timestamp,
+        abi: $abi,
+        devdoc: $devdoc,
+        userdoc: $userdoc,
+        metadata: $metadata,
+        storage_layout: $storage_layout,
+        bytecode: $bytecode,
+        deployed_bytecode: $deployed_bytecode
+    }'
+)
+
+# Write the JSON object to the specified path
+echo "$json_content" >"$path/$artifact_name.json"
+
+# Write the JSON object to the specified path
+echo "$json_content" >"$path/$artifact_name.json"

install.sh

@@ -0,0 +1,28 @@
+# Check if foundry is installed
+if ! command -v $HOME/.foundry/bin/forge &>/dev/null; then
+    # Install foundryup
+    curl -L https://foundry.paradigm.xyz | bash
+    # Install foundry
+    $HOME/.foundry/bin/foundryup -v nightly-de33b6af53005037b463318d2628b5cfcaf39916 # Stable version
+fi
+
+# Check if rustup is installed
+if ! command -v rustup &>/dev/null; then
+    # Install rustup
+    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+fi
+
+# Update rustup
+$HOME/.cargo/bin/rustup update stable
+# Install soldeer
+$HOME/.cargo/bin/cargo install soldeer
+# Update dependencies with soldeer
+$HOME/.cargo/bin/soldeer update
+# Run forge build
+$HOME/.foundry/bin/forge build
+
+# Check if rustup is installed
+if ! command -v jq &>/dev/null; then
+    # Install jq
+    brew install jq
+fi

remappings.txt

@@ -1 +1,4 @@
-foundry-deployment-kit/=script/
+@fdk/=script/
+forge-std=dependencies/forge-std-1.9.3/src/
+@solady-0.0.228=dependencies/solady-0.0.228
+@openzeppelin=dependencies/openzeppelin-5.0.2