chore: use event definitions from library to expand version compatibility (#285)

Signed-off-by: Luis Mastrangelo <luis@swirldslabs.com>

Author: acuarica

.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
@@ -305,6 +333,9 @@ jobs:
       - 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 HTS example tests using remote network with a pinned block number
         run: forge test -vv --fork-url mainnet --fork-block-number 72433403
@@ -393,7 +424,7 @@ jobs:
         working-directory: examples/foundry-hts
 
       - name: Run Foundry script on local node
-        run: forge script scripts/CreateToken.s.sol -vvv --rpc-url localnode --skip-simulation --broadcast
+        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

README.md

@@ -70,17 +70,17 @@ This is necessary because
 > - On Windows, it uses `Invoke-WebRequest` and `Start-Process` in PowerShell for a similar effect.
 
 To activate HTS emulation in your tests, you need to add the following setup code in your test files.
-Import our wrapper function to deploy HTS emulation and enable cheat codes for it.
+Import our System Contracts `library` to deploy HTS emulation and enable cheat codes for it.
 
 ```solidity
-import {htsSetup} from "hedera-forking/contracts/htsSetup.sol";
+import {Hsc} from "hedera-forking/Hsc.sol";
 ```
 
 and then invoke it in your [test setup](https://book.getfoundry.sh/forge/writing-tests)
 
 ```solidity
     function setUp() public {
-        htsSetup();
+        Hsc.htsSetup();
     }
 ```
 
@@ -89,12 +89,12 @@ and then invoke it in your [test setup](https://book.getfoundry.sh/forge/writing
 Now you can use Hedera Token Services and remote tokens as if they were deployed locally when fork testing.
 For example
 
-```solidity examples/foundry-hts/src/USDC.t.sol
+```solidity examples/foundry-hts/test/USDC.t.sol
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import {Test} from "forge-std/Test.sol";
-import {htsSetup} from "hedera-forking/htsSetup.sol";
+import {Hsc} from "hedera-forking/Hsc.sol";
 import {IERC20} from "hedera-forking/IERC20.sol";
 import {IHederaTokenService} from "hedera-forking/IHederaTokenService.sol";
 import {HederaResponseCodes} from "hedera-forking/HederaResponseCodes.sol";
@@ -106,7 +106,7 @@ contract USDCExampleTest is Test {
     address private user1;
 
     function setUp() external {
-        htsSetup();
+        Hsc.htsSetup();
 
         user1 = makeAddr("user1");
         deal(USDC_mainnet, user1, 1000 * 10e8);
@@ -148,17 +148,17 @@ forge test --fork-url https://mainnet.hashio.io/api --fork-block-number 72433403
 
 You can use all the tools and cheatcodes Foundry provides, _e.g._, `console.log`
 
-```solidity examples/foundry-hts/src/USDCConsole.t.sol
+```solidity examples/foundry-hts/test/USDCConsole.t.sol
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import {Test, console} from "forge-std/Test.sol";
-import {htsSetup} from "hedera-forking/htsSetup.sol";
+import {Hsc} from "hedera-forking/Hsc.sol";
 import {IERC20} from "hedera-forking/IERC20.sol";
 
 contract USDCConsoleExampleTest is Test {
     function setUp() external {
-        htsSetup();
+        Hsc.htsSetup();
     }
 
     function test_using_console_log() view external {
@@ -186,29 +186,27 @@ To enable Foundry Scripts to work with HTS, you can use `htsSetup()` as describe
 You can include
 For example
 
-````solidity examples/foundry-hts/scripts/CreateToken.s.sol
+```solidity examples/foundry-hts/script/CreateToken.s.sol
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import {Script, console} from "forge-std/Script.sol";
 import {HTS_ADDRESS} from "hedera-forking/HtsSystemContract.sol";
 import {IHederaTokenService} from "hedera-forking/IHederaTokenService.sol";
 import {HederaResponseCodes} from "hedera-forking/HederaResponseCodes.sol";
-import {htsSetup} from "hedera-forking/htsSetup.sol";
+import {Hsc} from "hedera-forking/Hsc.sol";
 
 /**
  * Given how Foundry script works, the flag `--skip-simulation` is necessary.
  * For example
  *
- * ```
  * forge script scripts/CreateToken.s.sol -vvv --rpc-url testnet --skip-simulation --broadcast
- * ```
  */
 contract CreateTokenScript is Script {
     uint256 PRIVATE_KEY = vm.envUint("PRIVATE_KEY");
 
     function run() public {
-        htsSetup();
+        Hsc.htsSetup();
 
         address signer = vm.addr(PRIVATE_KEY);
         console.log("Signer address %s", signer);
@@ -241,7 +239,7 @@ contract CreateTokenScript is Script {
         vm.stopBroadcast();
     }
 }
-````
+```
 
 where `testnet` is an [RPC endpoint](https://book.getfoundry.sh/reference/config/testing#rpc_endpoints) declared in `foundry.toml`.
 For example
@@ -604,7 +602,7 @@ This allow us to ensure that all examples and tables are never outdated (if we c
 Code fences that contains a file name after the language definition, _e.g._,
 
 ````markdown
-  ```solidity examples/foundry-hts/src/USDC.t.sol
+  ```solidity examples/foundry-hts/test/USDC.t.sol
   ```
 ````
 

contracts/Hsc.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import {Vm} from "forge-std/Vm.sol";
+
+import {HtsSystemContractJson, HTS_ADDRESS} from "./HtsSystemContractJson.sol";
+import {MirrorNode} from "./MirrorNode.sol";
+import {MirrorNodeFFI} from "./MirrorNodeFFI.sol";
+
+/**
+ * Library to deploy and setup System Contracts.
+ */
+library Hsc {
+    Vm private constant vm = Vm(address(uint160(uint256(keccak256("hevm cheat code")))));
+
+    /**
+     * @notice Sets up the HTS emulation contract.
+     * The HTS emulation contract will be deployed at `0x167` address using `vm.etch`.
+     *
+     * Remember to enable [`ffi`](https://book.getfoundry.sh/cheatcodes/ffi)
+     * in your Foundry project to use HTS contract in your tests.
+     * You can do this by adding the following lines to your `.toml` file
+     *
+     * ```toml
+     * [profile.default]
+     * ffi = true
+     * ```
+     *
+     * Alternatively, you can include the `--ffi` flag when running `forge`.
+     *
+     * This is necessary because our library uses `ffi` to fetch remote state from the Mirror Node.
+     * 
+     * > DISCLAIMER
+     * > The HTS emulation contract **SHOULD BE ONLY** used to ease development workflow when working with Hedera Tokens.
+     * > The HTS emulation contract **DOES NOT** replicate Hedera Token Services fully.
+     * > That is, behavior might differ when switching from local development to a real Hedera network.
+     * > **Always test your contracts against a real Hedera network before launching your contracts.**
+     */
+    function htsSetup() internal {
+        htsSetup(new MirrorNodeFFI());
+    }
+
+    function htsSetup(MirrorNode mirrorNode) internal {
+        _deployCodeTo("HtsSystemContractJson.sol", HTS_ADDRESS);
+        HtsSystemContractJson(HTS_ADDRESS).setMirrorNodeProvider(mirrorNode);
+        vm.allowCheatcodes(HTS_ADDRESS);
+    }
+
+    /**
+     * @dev Taken from `StdCheats.sol:deployCodeTo`.
+     * This is to avoid inheriting from `StdCheats`, and such simplifying usage.
+     */
+    function _deployCodeTo(string memory what, address where) private {
+        bytes memory creationCode = vm.getCode(what);
+        vm.etch(where, creationCode);
+        (bool success, bytes memory runtimeBytecode) = where.call("");
+        require(success, "__deployCodeTo(string,address): Failed to create runtime bytecode.");
+        vm.etch(where, runtimeBytecode);
+    }
+}