Merge pull request #306 from holographxyz/feature/release-develop-to-…

…testnet-2024-05-14

Feature/release develop to testnet 2024 05 14

.gas-snapshot

@@ -0,0 +1,47 @@
+DropsMetadataRendererTest:test_SetupInitializes() (gas: 95302)
+DropsMetadataRendererTest:test_UninitalizesReverts() (gas: 26715)
+DropsMetadataRendererTest:test_UpdateURIsFromAdmin() (gas: 283425)
+DropsMetadataRendererTest:test_UpdateURIsFromContract() (gas: 141559)
+EditionsMetadataRendererTest:testAdmin():(address) (gas: 2302)
+EditionsMetadataRendererTest:test_AllowMetadataURIUpdates() (gas: 161024)
+EditionsMetadataRendererTest:test_ContractURI() (gas: 472863)
+EditionsMetadataRendererTest:test_EditionMetadataInits() (gas: 137382)
+EditionsMetadataRendererTest:test_MetadatURIUpdateNotAllowed() (gas: 252470)
+EditionsMetadataRendererTest:test_MetadataRenderAdminCheckGetterFailure() (gas: 16179)
+EditionsMetadataRendererTest:test_MetadataRenderAdminCheckSender() (gas: 9072)
+EditionsMetadataRendererTest:test_MetadataRenderAdminCheckSuccess() (gas: 37577)
+EditionsMetadataRendererTest:test_MetadataRenderingURI() (gas: 461061)
+EditionsMetadataRendererTest:test_OpenEdition() (gas: 459758)
+EditionsMetadataRendererTest:test_UpdateDescriptionAllowed() (gas: 142478)
+EditionsMetadataRendererTest:test_UpdateDescriptionNotAllowed() (gas: 251505)
+HolographDropERC721Test:testSetSalesConfiguration() (gas: 2682040)
+HolographDropERC721Test:test_AdminMint() (gas: 3038188)
+HolographDropERC721Test:test_AdminMintAirdrop() (gas: 3378807)
+HolographDropERC721Test:test_AdminMintAirdropFails() (gas: 2641992)
+HolographDropERC721Test:test_AdminMintBatch() (gas: 16679206)
+HolographDropERC721Test:test_AdminMintBatchFails() (gas: 2640724)
+HolographDropERC721Test:test_Burn() (gas: 2758268)
+HolographDropERC721Test:test_BurnNonOwner() (gas: 2847801)
+HolographDropERC721Test:test_DeployHolographDrop() (gas: 2408005)
+HolographDropERC721Test:test_EIP165() (gas: 2680178)
+HolographDropERC721Test:test_EditionSizeZero() (gas: 3468967)
+HolographDropERC721Test:test_Fallback() (gas: 2642550)
+HolographDropERC721Test:test_GlobalLimit(uint16) (runs: 256, μ: 3068550, ~: 2986743)
+HolographDropERC721Test:test_HolographMintFeeCanBeSet(uint256) (runs: 256, μ: 45925, ~: 46188)
+HolographDropERC721Test:test_HolographMintFeeCannotBeSetByNonAdmin(uint256) (runs: 256, μ: 42744, ~: 42744)
+HolographDropERC721Test:test_Init() (gas: 2666687)
+HolographDropERC721Test:test_InvalidFinalizeOpenEdition() (gas: 3555551)
+HolographDropERC721Test:test_MintAdmin() (gas: 2866385)
+HolographDropERC721Test:test_MintLimit(uint8) (runs: 256, μ: 4460836, ~: 3368789)
+HolographDropERC721Test:test_MintMulticall() (gas: 3871188)
+HolographDropERC721Test:test_MintWrongValue() (gas: 2758236)
+HolographDropERC721Test:test_OnlyAdminCanWithdrawFromTreasury() (gas: 36426)
+HolographDropERC721Test:test_Purchase(uint64) (runs: 256, μ: 3204319, ~: 3172137)
+HolographDropERC721Test:test_PurchaseFree(uint64) (runs: 256, μ: 3154511, ~: 3128874)
+HolographDropERC721Test:test_PurchaseTime() (gas: 3096825)
+HolographDropERC721Test:test_SoldOut() (gas: 2868312)
+HolographDropERC721Test:test_UpdatePriceMulticall() (gas: 4050106)
+HolographDropERC721Test:test_ValidFinalizeOpenEdition() (gas: 3591522)
+HolographDropERC721Test:test_Withdraw(uint128) (runs: 256, μ: 2647933, ~: 2647933)
+HolographDropERC721Test:test_WithdrawNotAllowed() (gas: 2640599)
+MyContractTest:testSetup() (gas: 60936)

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,3 +10,4 @@ I made this more better by doing ...
 - [ ] I have performed a self-review of my code
 - [ ] Code styles have been enforced
 - [ ] All Hardhat tests are passing
+- [ ] All Foundry tests are passing

.github/workflows/enforce_eslint.yml

@@ -25,8 +25,12 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '18.4.0'
+          node-version: '20.12.2'
+      - uses: pnpm/action-setup@v3
+        name: Install pnpm
+        with:
+          version: 8
       - name: Install dependencies
-        run: yarn install
+        run: pnpm install
       - name: Lint Check
-        run: yarn lint
+        run: pnpm lint

.github/workflows/foudry_tests.yml

@@ -0,0 +1,51 @@
+name: Foundry tests
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+env:
+  FOUNDRY_PROFILE: ci
+  SKIP_DEPLOY_CONFIRMATION: true
+  HOLOGRAPH_ENVIRONMENT: develop
+  LOCALHOST_DEPLOYER_SECRET: something
+  DEPLOYER: ff22437ccbedfffafa93a9f1da2e8c19c1711052799acf3b58ae5bebb5c6bd7b
+  HARDWARE_WALLET_DEPLOYER: 0x0
+  LOCALHOST_RPC_URL: http://localhost:8545
+  LOCALHOST2_RPC_URL: http://localhost:9545
+  MAINNET_DEPLOYMENT_SALT: 0
+  TESTNET_DEPLOYMENT_SALT: 0
+  DEVELOP_DEPLOYMENT_SALT: 1000
+  EXPERIMENTAL_DEPLOYMENT_SALT: 1000000
+  TENDERLY_ENABLED: false
+  DRY_RUN: false
+  MNEMONIC: "deputy annual debris outer baby prefer mammal scene insect obtain parrot length zero detail average nation address depart stem tuition fork rocket topple kidney"
+
+jobs:
+  run-foundry-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install tools from asdf config
+        uses: ai/asdf-cache-action@v1
+
+      - name: Install deps
+        run: pnpm install && forge install
+
+      - name: Run the protocol
+        run: bash scripts/start-protocol.sh
+
+      - name: Run tests
+        run: forge test -vv --no-match-test "(FFI|Fork)" --no-match-contract Fork
+
+      - name: Kill the anvil nodes
+        run: bash scripts/stop-protocol.sh

.gitignore

@@ -240,3 +240,7 @@ cache
 ganache
 artifacts
 typechain-types
+
+## pnpm
+.pnpm-store
+.pnpm-debug.log*

.husky/pre-commit

@@ -0,0 +1,53 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# ---------------------------------------------------------------------------- #
+#                                 Code updates                                 #
+# ---------------------------------------------------------------------------- #
+
+# -------------------------- Foundry code formatting ------------------------- #
+
+# TODO: uncomment when the project as been migrate to foundry
+# echo "👉 Formatting code with Foundry..."
+# forge fmt
+# echo "✅ Code formatted with Foundry.\n\n"
+
+# ------------------------ Precompute Solidity Hashes ------------------------ #
+echo "👉 Precomputing Solidity hashes..."
+npx ts-node scripts/precompute-solidity-hashes.ts
+echo "✅ Solidity hashes precomputed.\n\n"
+
+# --------------------------- Add any changes made --------------------------- #
+# temporary comments will be made until it is defined which files have to be add.
+# git add .
+
+# ---------------------------------------------------------------------------- #
+#                                    Checks                                    #
+# ---------------------------------------------------------------------------- #
+
+# ------------------------------ Natspec smells ------------------------------ #
+## check for env feature flag for natspec-smells. Default to true
+# if [ "$SKIP_NATSPEC_SMELLS" = "true" ]; then
+#   echo "👉 Skipping natspec-smells check..."
+#   echo "⛔️ WARNING: natspec-smells check has been skipped. THIS IS NOT THE RECOMMENDED PRACTICE."
+
+#   exit 0
+# else
+#   echo "👉 Checking for missing natspecs..."
+#   natspecSmellsOutput=$(npx @defi-wonderland/natspec-smells 2>&1)
+
+#   # Compare the trimmed output to "No issues found"
+#   if [ "$natspecSmellsOutput" != "No issues found" ]; then
+#     echo "⛔️ Missing documentation or errors have been found:"
+#     echo "$natspecSmellsOutput"
+#     exit 1
+#   else
+#     echo "✅ No missing natspecs detected.\n"
+#   fi
+# fi
+# # ------------------------------- Gas snapshot ------------------------------- #
+
+# echo "👉 Checking gas snapshots..."
+# npm run snapshot:check
+# echo "✅ Gas snapshots are up to date.\n\n"
+

.husky/pre-push

@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint
-yarn prettier:check
+pnpm lint
+pnpm prettier:check

.nvmrc

@@ -0,0 +1 @@
+v20

.tool-versions

@@ -1,2 +1,2 @@
-nodejs 20.0.0
-yarn 1.22.18
+nodejs 20.12.2
+pnpm 8.15.6