Merge pull request #95 from oasisprotocol/matevz/feature/sapphire-localnet-tests

solidity: Add sapphire-localnet tests

Author: matevz

.github/workflows/ci.yml

@@ -39,6 +39,18 @@ jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
+    services:
+      sapphire-localnet-ci:
+        image: ghcr.io/oasisprotocol/sapphire-localnet
+        ports:
+          - 8545:8545
+        env:
+          OASIS_DOCKER_START_EXPLORER: no
+          TO: "chimney theory present latin find behave ankle clock shadow earn suit reflect"
+        options: >-
+          --rm
+          --health-cmd="test -f /CONTAINER_READY"
+          --health-start-period=90s
     steps:
       - uses: actions/checkout@v4
 
@@ -77,8 +89,6 @@ jobs:
 
       - name: Run Solidity tests
         run: make solidity-test
-        env:
-          BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
 
       - name: Install dependencies
         run: make dev

solidity/bun.lock

@@ -10,9 +10,9 @@ import {ChainType, HistoryKind, UnsupportedTokenType} from "../Types.sol";
  * @dev Overrides the keypair generation to avoid calling Sapphire precompiles.
  */
 contract MockAccounting is Accounting {
-    // Address matching the test transaction on Base Sepolia (block 32680090, tx 45)
-    address private constant TEST_ADDRESS = 0x284a3Fe2939a4e4859e6321537d4264533E3D549;
-    bytes32 private constant TEST_SECRET = bytes32(uint256(1));
+    // Test keypair: #4 of "chimney theory present latin find behave ankle clock shadow earn suit reflect"
+    address private constant TEST_ADDRESS = 0xe6F321Fb3D912Db48DE460560B8bB99B57AeAcA2;
+    bytes32 private constant TEST_SECRET = bytes32(0x9147e5178b1ee427d704dcdb699f1adf9c8a3b58480a6118635a3486ad3a35ce);
 
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor(address siweAuthAddress) Accounting(siweAuthAddress) {}
@@ -21,16 +21,6 @@ contract MockAccounting is Accounting {
         __Accounting_init(_roflAppID, _owner);
     }
 
-    function _deriveDepositKeypair(
-        address beneficiary,
-        ChainType /* chainType */,
-        uint256 /* version */
-    ) internal pure override returns (address depositAddr, bytes32 depositSecret) {
-        // Deterministic mock: derive from beneficiary address
-        depositSecret = keccak256(abi.encode(TEST_SECRET, beneficiary));
-        depositAddr = address(uint160(uint256(depositSecret)));
-    }
-
     function _generateKeypair() internal pure override returns (address, bytes32) {
         return (TEST_ADDRESS, TEST_SECRET);
     }
@@ -74,18 +64,6 @@ contract MockAccounting is Accounting {
         emit Deposit(tokenId, amount, depositId);
     }
 
-    /**
-     * @notice Test helper: get deposit address for a beneficiary.
-     * @dev Bypasses EIP-712 sig verification for testing.
-     */
-    function mockGetDepositAddress(
-        address beneficiary,
-        ChainType chainType,
-        uint256 version
-    ) external pure returns (address depositAddr) {
-        (depositAddr, ) = _deriveDepositKeypair(beneficiary, chainType, version);
-    }
-
     /**
      * @notice Test helper: set roflSignerAddress without onlyROFL check.
      * @dev Bypasses ROFL auth for Hardhat testing; onlyROFL calls the Sapphire

solidity/contracts/test/MockAccounting.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+import {MockAccounting} from "./MockAccounting.sol";
+
+/**
+ * @title MockAccountingHelper
+ * @notice Helpers that should have been part of MockAccounting contract, but would exceed the contract code size limitation (EIP-170).
+ */
+contract MockAccountingHelper {
+    MockAccounting public mockAccounting;
+
+    constructor(MockAccounting _mockAccounting) {
+        mockAccounting = _mockAccounting;
+    }
+
+    /**
+     * @notice Calls creditDeposit n times from solidity to speed up the sapphire-localnet tests.
+     */
+    function mockCreditDepositNTimes(
+        address beneficiary,
+        bytes32 tokenId,
+        uint256 amount,
+        bytes32 depositId,
+        uint256 n
+    ) external {
+        for (uint256 i=0; i<n; i++) {
+            mockAccounting.mockCreditDeposit(beneficiary, tokenId, i+amount, keccak256(abi.encodePacked(depositId, i)));
+        }
+    }
+}

solidity/contracts/test/MockAccountingHelper.sol

@@ -6,9 +6,9 @@ import {EVMSignerAndVerifier} from "../EVMSignerAndVerifier.sol";
 import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 
 contract MockEVMSignerAndVerifier is EVMSignerAndVerifier, UUPSUpgradeable {
-    // Test keypair - NOT for production use
-    address private constant TEST_ADDRESS = 0x1234567890123456789012345678901234567890;
-    bytes32 private constant TEST_SECRET = bytes32(uint256(1));
+    // Test keypair: #4 of "chimney theory present latin find behave ankle clock shadow earn suit reflect"
+    address private constant TEST_ADDRESS = 0xe6F321Fb3D912Db48DE460560B8bB99B57AeAcA2;
+    bytes32 private constant TEST_SECRET = bytes32(0x9147e5178b1ee427d704dcdb699f1adf9c8a3b58480a6118635a3486ad3a35ce);
 
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {

solidity/contracts/test/MockEVMSignerAndVerifier.sol

@@ -6,12 +6,13 @@ import {
 } from '@oasisprotocol/sapphire-hardhat';
 import '@nomicfoundation/hardhat-ignition-ethers';
 import '@nomicfoundation/hardhat-toolbox';
-import '@openzeppelin/hardhat-upgrades';
 import { HardhatUserConfig } from 'hardhat/config';
 import { HDAccountsUserConfig } from 'hardhat/types';
 import 'solidity-coverage';
 import './tasks';
 
+import '@openzeppelin/hardhat-upgrades'; // NB: Must be imported after hardhat packages to preserve network configuration!
+
 dotenvConfig();
 
 const TEST_HDWALLET = {

solidity/hardhat.config.ts

@@ -14,7 +14,9 @@
     "format": "npm-run-all format:**",
     "build": "hardhat compile",
     "check:size": "hardhat run scripts/check-bytecode-size.ts --no-compile",
-    "test": "hardhat test",
+    "test:hardhat": "hardhat test",
+    "test:sapphire-localnet": "hardhat test --network sapphire-localnet",
+    "test": "npm-run-all test:**",
     "coverage": "hardhat coverage"
   },
   "devDependencies": {