Merge branch 'main' into dependabot/npm_and_yarn/npm_and_yarn-675ef9a19c

Author: natanasow

.github/workflows/npm-publish.yml

@@ -2,30 +2,43 @@ name: NPM Publish
 
 on:
   workflow_dispatch:
+    inputs:
+      dry-run-enabled:
+        description: 'Enable dry run for publishing (does not publish to npmjs)'
+        required: false
+        default: false
+        type: boolean
 
 permissions:
+  id-token: write
   contents: read
 
 jobs:
-  publish:
-    name: Publish NPM package
+  build-npm-package:
+    name: Build NPM package
     runs-on: smart-contracts-linux-medium
+    outputs:
+      npm-artifact-name: ${{ steps.set-publish-data.outputs.artifact-name }}
     steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
         with:
           egress-policy: audit
 
-      - name: Checkout Code
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Prepare Runner
+        uses: pandaswhocode/initialize-github-job@ed4a98646fe0235e6ecf3af5414b355d2abe3bf3 # v1.0.3
         with:
-          submodules: recursive
+          checkout: 'true'
+          checkout-ref: '${{ github.ref }}'
+          checkout-token: '${{ secrets.GITHUB_TOKEN }}'
+          checkout-fetch-depth: '1'
+          setup-node: 'true'
+          node-version: '20'
 
-      - name: Set up Node.js
-        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+      - name: Setup JQ
+        uses: dcarbone/install-jq-action@b7ef57d46ece78760b4019dbc4080a1ba2a40b45 # v3.2.0
         with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org'
+          version: 1.7
 
       - name: Install Foundry
         uses: step-security/foundry-toolchain@01e2d127ea061e2ce8fa34340de71ca8518f093e # v1.2.1
@@ -41,7 +54,60 @@ jobs:
       - name: Run Unit Tests
         run: npm run test
 
-      - name: Publish NPM package
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Set Publish Data
+        id: set-publish-data
+        run: |
+          VERSION=$(jq -r '.version' './package.json')
+          NPM_PACKAGE_NAME="hashgraph-system-contracts-forking-${VERSION}.tgz"
+          echo "artifact-name=${NPM_PACKAGE_NAME}" >> "${GITHUB_OUTPUT}"
+
+      - name: Build NPM package
+        run: npm pack
+
+      - name: Upload Hedera Custodians Library Package Artifact
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          name: npm-package
+          path: ./${{ steps.set-publish-data.outputs.artifact-name }}
+          if-no-files-found: error
+
+  publish-npm-package:
+    runs-on: ubuntu-latest
+    needs:
+      - build-npm-package
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
+        with:
+          egress-policy: audit
+
+      - name: Prepare Runner
+        uses: pandaswhocode/initialize-github-job@ed4a98646fe0235e6ecf3af5414b355d2abe3bf3 # v1.0.3
+        with:
+          checkout: 'true'
+          checkout-ref: '${{ github.ref }}'
+          checkout-fetch-depth: '1'
+          checkout-token: '${{ secrets.GITHUB_TOKEN }}'
+          setup-node: 'true'
+          node-version: '20'
+          node-registry: 'https://registry.npmjs.org'
+
+      - name: Install NPM latest
+        run: npm install -g npm@11.7.0
+
+      - name: Download Hedera Custodians Library NPM Package
+        uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
+        with:
+          name: npm-package
+
+      - name: Publish NPM Package
+        run: |
+          args="--access=public"
+          if [[ "${{ inputs.dry-run-enabled || 'false' }}" == "true" ]]; then
+            args="${args} --dry-run"
+          fi
+
+          package="${{ needs.build-npm-package.outputs.npm-artifact-name }}"
+          echo "::group::Publishing package: ${package} with args: ${args}"
+          npm publish ${package} ${args}
+          echo "::endgroup::"

.github/workflows/test.yml

@@ -284,7 +284,35 @@ jobs:
           slug: hashgraph/hedera-forking
 
   foundry-example-tests:
-    name: 'Foundry example tests w/mainnet'
+    name: 'Foundry example tests'
+    strategy:
+      fail-fast: false
+      matrix:
+        solc: [
+          # Ensures we use the `override` specifier
+          # https://soliditylang.org/blog/2021/09/27/solidity-0.8.8-release-announcement/
+          '0.8.7', 
+
+          # Ensures we do not use `string.concat`
+          # > General: string.concat now properly takes strings as arguments and returns string memory.
+          # > It was accidentally introduced as a copy of bytes.concat before.
+          # https://soliditylang.org/blog/2022/02/16/solidity-0.8.12-release-announcement/
+          '0.8.11', 
+
+          # Ensures we do not overload/use free functions
+          # https://soliditylang.org/blog/2022/03/16/solidity-0.8.13-release-announcement/
+          '0.8.12',
+
+          # Ensures we do not use "named parameters in mapping types"
+          # See _Language Features_ https://soliditylang.org/blog/2023/02/01/solidity-0.8.18-release-announcement/
+          '0.8.17',
+
+          # Ensures we do not use "qualified access to events from other contracts"
+          # See _Qualified access to foreign events_ https://soliditylang.org/blog/2023/07/19/solidity-0.8.21-release-announcement/
+          '0.8.19',
+
+          '0.8.24',
+          ]
     runs-on: smart-contracts-linux-medium
     steps:
       - name: Harden Runner
@@ -302,14 +330,16 @@ jobs:
         with:
           version: stable
 
-      - name: Patch Foundry's config file to run only Foundry HTS examples
-        run: echo 'test="examples/foundry-hts"' >> foundry.toml
-
-      - name: Run Forge build with custom remappings
-        run: forge build --remappings hedera-forking=.
+      - name: Run Forge build on Foundry HTS example
+        run: forge build
+        working-directory: examples/foundry-hts
+        env:
+          # https://book.getfoundry.sh/reference/config/solidity-compiler#solc_version
+          FOUNDRY_SOLC_VERSION: ${{ matrix.solc }}
 
-      - name: Run Forge example tests using remote network with a pinned block number
-        run: forge test --remappings hedera-forking=. -vv --fork-url https://mainnet.hashio.io/api --fork-block-number 72433403
+      - name: Run Forge HTS example tests using remote network with a pinned block number
+        run: forge test -vv --fork-url mainnet --fork-block-number 72433403
+        working-directory: examples/foundry-hts
 
   hardhat-example-tests:
     name: 'Hardhat example tests w/mainnet'
@@ -349,6 +379,68 @@ jobs:
         run: npm run test
         working-directory: examples/hardhat-hts
 
+  foundry-example-scripts:
+    name: Foundry example scripts w/local node
+    runs-on: smart-contracts-linux-medium
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        with:
+          egress-policy: audit
+
+      - name: Checkout Code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          submodules: recursive
+
+      - name: Set up Node.js
+        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version: 20
+
+      - name: Install Foundry
+        uses: step-security/foundry-toolchain@01e2d127ea061e2ce8fa34340de71ca8518f093e # v1.2.1
+        with:
+          version: stable
+
+      - name: Run Forge build
+        run: forge build
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Start the local node
+        run: npx hedera start --detach --verbose=trace
+        timeout-minutes: 5
+
+      - name: Run Forge build on Foundry HTS example
+        run: forge build
+        working-directory: examples/foundry-hts
+
+      # Uses a local node's account private key
+      # https://github.com/hiero-ledger/hiero-local-node?tab=readme-ov-file#hedera-start-options
+      - name: Set up Local Node's account Private Key
+        run: echo "PRIVATE_KEY=0x105d050185ccb907fba04dd92d8de9e32c18305e097ab41dadda21489a211524" > .env
+        working-directory: examples/foundry-hts
+
+      - name: Run Foundry script on local node
+        run: forge script script/CreateToken.s.sol -vvv --rpc-url localnode --skip-simulation --broadcast
+        working-directory: examples/foundry-hts
+
+      # https://book.getfoundry.sh/guides/scripting-with-solidity
+      - name: Verify the token was created
+        run: |
+          TOKEN_ADDR=`cat broadcast/CreateToken.s.sol/298/run-latest.json | jq '.receipts[0].contractAddress' --raw-output`
+          echo "Token Address: $TOKEN_ADDR"
+          TOKEN_CODE=`cast code --rpc-url localnode $TOKEN_ADDR`
+          echo "Token Code: $TOKEN_CODE"
+          test $TOKEN_CODE != "0x"
+        working-directory: examples/foundry-hts
+
+      - name: Stop the local node
+        if: ${{ !cancelled() }}
+        run: npx hedera stop
+
   e2e-test:
     name: 'NPM e2e validation tests'
     runs-on: smart-contracts-linux-medium

.gitignore

@@ -18,3 +18,7 @@
 # `reports-dir`: directory where coverage reports will be output to	
 # https://github.com/bcoe/c8?tab=readme-ov-file#cli-options--configuration
 /coverage/
+
+# IDEA
+**/.DS_Store
+**/.idea/

FAQ.md

@@ -26,6 +26,26 @@ That is why when trying to get the code, for example using `cast code --rpc-url
 address of the HTS System Contract, you get `0xfe`.
 That leads to the error `EvmError: InvalidFEOpcode` mentioned in the question.
 
+### Why am I getting error "`Member "keyExistsJson" not found or not visible`" when compiling my project?
+
+If you get the following error when compiling your project
+
+```console
+$ forge build
+[...]
+Error: Compiler run failed:
+Error (9582): Member "keyExistsJson" not found or not visible after argument-dependent lookup in contract Vm.
+```
+
+it is because your `forge-std` dependency is outdated.
+You can [update](https://book.getfoundry.sh/reference/forge/forge-update) `forge-std` with
+
+```sh
+forge update lib/forge-std
+```
+
+See [_§ Requirements_](./README.md#requirements) for the full list of requirements needed to compile your project.
+
 ## Hardhat
 
 ### What causes the error `ProviderError: No known hardfork for execution`