Hardhat test with brc20 contract (#2927)

* feat: P-886 integrate hardhat into dynamic assertions, wrap contract in proxy contract so as to get the return value in unit test, added test for BRC20 TokenHoldingAmount.
    Fixed openzipline import with @ import working with remix too

* fix: formatted all contracts

* fix: update ci install script for Dynamic-contract step

* fix: prevent lockfile update because it may cause check-format fail

* fix: remove frozen-lockfile option from pnpm install, ignore pnpm-lock.yaml for prettier

* fix: use hardhat instead of foundry to compile contracts

* fix: use Strings.equal to simplify string compare, add remixd install step to README

* add remix config file to .gitignore

---------

Co-authored-by: higherordertech <higherordertech>

Author: wli-pro

.github/workflows/ci.yml

@@ -197,6 +197,14 @@ jobs:
       - name: Tee-worker check ts code format
         working-directory: ./tee-worker/ts-tests
         run: pnpm run check-format
+      
+      - name: Dynamic-contract install npm deps
+        working-directory: ./tee-worker/litentry/core/assertion-build/src/dynamic
+        run: pnpm install
+
+      - name: Dynamic-contract check code format
+        working-directory: ./tee-worker/litentry/core/assertion-build/src/dynamic
+        run: pnpm run check-format
 
       - name: Fail early
         if: failure()

Makefile

@@ -186,8 +186,8 @@ update-ts-dep:
 
 # format
 
-.PHONY: fmt ## (cargo, taplo, ts) fmt
-fmt: fmt-cargo fmt-taplo fmt-ts
+.PHONY: fmt ## (cargo, taplo, ts, solidity) fmt
+fmt: fmt-cargo fmt-taplo fmt-ts fmt-contract
 
 .PHONY: fmt-cargo ## cargo fmt
 fmt-cargo:
@@ -208,6 +208,10 @@ fmt-ts:
 	@cd ts-tests && pnpm install && pnpm run format
 	@cd tee-worker/ts-tests && pnpm install && pnpm run format
 
+.PHONY: fmt-contract ## contract fmt
+fmt-contract:
+	@cd tee-worker/litentry/core/assertion-build/src/dynamic && pnpm install && pnpm run format
+
 .PHONY: githooks ## install the githooks
 githooks:
 	git config core.hooksPath .githooks

tee-worker/cli/lit_ts_integration_test.sh

@@ -68,23 +68,14 @@ pnpm install
 pnpm run build
 
 if [ "$TEST" = "assertion_contracts.test.ts" ]; then
-    cd /
-    ls assertion-contracts/
-    cp -r assertion-contracts /ts-tests/integration-tests/contracts
-
-    cd /ts-tests
-    curl -L https://foundry.paradigm.xyz | bash
-    source /root/.bashrc
-    apt install -y git
-    foundryup
-
-    pnpm install
-    pnpm --filter integration-tests run compile-contracts
-
-else
-    cd /ts-tests
+    cd /assertion-contracts
     pnpm install
-
+    # compile contracts
+    pnpm compile
+    ln -s /assertion-contracts/artifacts/contracts /ts-tests/integration-tests/contracts
 fi
 
+cd /ts-tests
+pnpm install
+
 NODE_ENV=staging pnpm --filter integration-tests run test $TEST

tee-worker/docker/lit-assertion-contracts-test.yml

@@ -6,7 +6,7 @@ services:
             - ../ts-tests:/ts-tests
             - ../client-api:/client-api
             - ../cli:/usr/local/worker-cli
-            - ../litentry/core/assertion-build/src/dynamic/contracts:/assertion-contracts
+            - ../litentry/core/assertion-build/src/dynamic:/assertion-contracts
 
         build:
             context: ..

tee-worker/litentry/core/assertion-build/src/dynamic/.gitignore

@@ -1,4 +1,24 @@
-.deps
+node_modules
+.env
+
+# Hardhat files
+cache
 artifacts
-.prettierrc.json
+
+# TypeChain files
+typechain
+typechain-types
+
+# solidity-coverage files
+coverage
+coverage.json
+
+# Hardhat Ignition default folder for deployments against a local node
+ignition/deployments/chain-31337
+
+.deps
 !*.sol
+
+# Remix
+compiler_config.json
+remix-compiler.config.js

tee-worker/litentry/core/assertion-build/src/dynamic/.prettierignore

@@ -0,0 +1,8 @@
+artifacts
+cache
+node_modules
+.env
+.idea
+typechain-types
+coverage
+pnpm-lock.yaml

tee-worker/litentry/core/assertion-build/src/dynamic/.prettierrc

@@ -0,0 +1,22 @@
+{
+    "plugins": ["prettier-plugin-solidity"],
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": true,
+    "useTabs": false,
+    "printWidth": 80,
+    "overrides": [
+        {
+            "files": "*.sol",
+            "options": {
+                "parser": "solidity-parse",
+                "printWidth": 80,
+                "tabWidth": 4,
+                "useTabs": false,
+                "singleQuote": false,
+                "bracketSpacing": true
+            }
+        }
+    ]
+}

tee-worker/litentry/core/assertion-build/src/dynamic/.prettierrc.json

@@ -0,0 +1,59 @@
+## Description
+
+Dynamic VC assertion contract written by solidity, using [Hardhat](https://hardhat.org) for compile and test.
+
+## Environment setup
+
+-   Install [nvm](https://github.com/nvm-sh/nvm)
+-   Inside the repository, run `nvm use` to set the correct Node version.
+    -   If the version is not installed, run `nvm install`.
+
+## Installation
+
+```shell
+nvm use
+corepack enable pnpm
+pnpm install
+```
+
+## Usage
+
+### Compile
+
+1. Using hardhat.
+
+```shell
+pnpm compile
+```
+
+After compiled, the contract bytecode will generate in file `artifacts/contracts/**/{contractName}.sol/{contractName}.json`, e.g. the bytecode of A1 is in the file `artifacts/contracts/A1.sol/A1.json`.
+
+2. Using [Remix IDE](https://remix.ethereum.org).
+
+Should use the `dynamic` as your project root path in Remix IDE as below:
+
+```shell
+remixd -s your_repo_path/tee-worker/litentry/core/assertion-build/src/dynamic --remix-ide https://remix.ethereum.org
+```
+
+If you have not install remixd before, rub below script to install it.
+
+```shell
+npm install -g @remix-project/remixd
+```
+
+### Testing
+
+-   Test all: `pnpm test`.
+
+```shell
+pnpm test
+```
+
+-   Test single file: `pnpm test {testFilePath}`.
+
+Example:
+
+```shell
+pnpm test tests/token-holding-amount.ts
+```

tee-worker/litentry/core/assertion-build/src/dynamic/README.md

@@ -18,7 +18,7 @@
 
 pragma solidity ^0.8.8;
 
-import "./openzeppelin/Strings.sol";
+import "@openzeppelin/contracts/utils/Strings.sol";
 import "./libraries/AssertionLogic.sol";
 import "./libraries/Http.sol";
 import "./libraries/Identities.sol";
@@ -123,22 +123,18 @@ contract A6 is DynamicAssertion {
         return (description, assertion_type, assertions, schema_url, result);
     }
 
-    function prepareHeaders(string memory apiKey)
-        private
-        pure
-        returns (HttpHeader[] memory)
-    {
+    function prepareHeaders(
+        string memory apiKey
+    ) private pure returns (HttpHeader[] memory) {
         HttpHeader[] memory headers = new HttpHeader[](1);
         // we expect first secret to be twitter api key
         headers[0] = HttpHeader("authorization", prepareAuthHeader(apiKey));
         return headers;
     }
 
-    function prepareAuthHeader(string memory apiKey)
-        private
-        pure
-        returns (string memory)
-    {
+    function prepareAuthHeader(
+        string memory apiKey
+    ) private pure returns (string memory) {
         return string(abi.encodePacked("Bearer ", apiKey));
     }
 }