Merge pull request #352 from rsksmart/add-union-bridge-tests

Add Union Bridge tests,  union authorizer contract, and union constants

Author: marcos-iov

contracts/UnionBridgeAuthorizer.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+interface BridgeInterface {
+    function requestUnionBridgeRbtc(uint256 amountRequested) external returns (int256);
+
+    function releaseUnionBridgeRbtc() external payable returns (int256);
+}
+
+contract UnionBridgeContract {
+    BridgeInterface public bridge = BridgeInterface(0x0000000000000000000000000000000001000006);
+
+    function requestUnionBridgeRbtc(uint256 amountToRequest) external returns (int256) {
+        return bridge.requestUnionBridgeRbtc(amountToRequest);
+    }
+
+    function releaseUnionBridgeRbtc(uint256 amountToRelease) public payable returns (int256) {
+        return bridge.releaseUnionBridgeRbtc{value: amountToRelease}();
+    }
+
+    receive() external payable { }
+
+    fallback() external payable { }
+}

contracts/UnionBridgeContract.sol

@@ -0,0 +1,68 @@
+const { btcToWeis } = require("@rsksmart/btc-eth-unit-converter");
+const { getBridgeStorageIndexFromLongKey } = require("../utils");
+
+const INITIAL_UNION_BRIDGE_ADDRESS = "0x0000000000000000000000000000000000000000";
+
+const INITIAL_UNION_LOCKING_CAP = btcToWeis(1);
+
+const UNION_LOCKING_CAP_INCREMENTS_MULTIPLIER = 2;
+
+const CHANGE_UNION_BRIDGE_CONTRACT_ADDRESS_AUTHORIZER_PK =
+  "7880a81a4591568b0e87947e5150fe8e330091678654f3bc661b516f91a5f00a";
+
+// UnionBridgeAuthorizer multisig members
+// seed: UnionBridgeAuthorizer1
+const UNION_BRIDGE_AUTHORIZER_1_PK = "a2221797b4e6655bf39e8290d6db2c75536cf9ffb7f0d2bf4a7360f0b3716e5d";
+// seed: UnionBridgeAuthorizer2
+const UNION_BRIDGE_AUTHORIZER_2_PK = "1769b8128e7eb24d632122e03d64c8cd525cf2cf3d2d00190039918666106282";
+// seed: UnionBridgeAuthorizer3
+const UNION_BRIDGE_AUTHORIZER_3_PK = "03918409b6d508f31d72879df0813a6d60d8c74eb91197572c9f3df1da9ae5a5";
+
+// seed: UnionBridgeAuthorizerDeployer
+const UNION_BRIDGE_AUTHORIZER_DEPLOYER_PK = "b00e82a2aa449171e750e9ccc945ee710d438dbaba1d6410aa781121f1f13099";
+
+const UNION_BRIDGE_EVENTS = {
+  UNION_LOCKING_CAP_INCREASED: {
+    name: "union_bridge_locking_cap_increased",
+  },
+  UNION_RBTC_REQUESTED: {
+    name: "union_rbtc_requested",
+  },
+  UNION_RBTC_RELEASED: {
+    name: "union_rbtc_released",
+  },
+  UNION_BRIDGE_TRANSFER_PERMISSIONS_UPDATED: {
+    name: "union_bridge_transfer_permissions_updated",
+  },
+};
+
+const UNION_BRIDGE_STORAGE_INDICES = {
+  UNION_BRIDGE_CONTRACT_ADDRESS: getBridgeStorageIndexFromLongKey("unionBridgeContractAddress"),
+  UNION_BRIDGE_LOCKING_CAP: getBridgeStorageIndexFromLongKey("unionBridgeLockingCap"),
+  WEIS_TRANSFERRED_TO_UNION_BRIDGE: getBridgeStorageIndexFromLongKey("weisTransferredToUnionBridge"),
+  UNION_BRIDGE_REQUEST_ENABLED: getBridgeStorageIndexFromLongKey("unionBridgeRequestEnabled"),
+  UNION_BRIDGE_RELEASE_ENABLED: getBridgeStorageIndexFromLongKey("unionBridgeReleaseEnabled"),
+};
+
+const UNION_RESPONSE_CODES = {
+  SUCCESS: "0",
+  UNAUTHORIZED_CALLER: "-1",
+  INVALID_VALUE: "-2",
+  REQUEST_DISABLED: "-3",
+  RELEASE_DISABLED: "-3",
+  GENERIC_ERROR: "-10",
+};
+
+module.exports = {
+  INITIAL_UNION_BRIDGE_ADDRESS,
+  INITIAL_UNION_LOCKING_CAP,
+  UNION_LOCKING_CAP_INCREMENTS_MULTIPLIER,
+  CHANGE_UNION_BRIDGE_CONTRACT_ADDRESS_AUTHORIZER_PK,
+  UNION_BRIDGE_AUTHORIZER_1_PK,
+  UNION_BRIDGE_AUTHORIZER_2_PK,
+  UNION_BRIDGE_AUTHORIZER_3_PK,
+  UNION_BRIDGE_AUTHORIZER_DEPLOYER_PK,
+  UNION_BRIDGE_EVENTS,
+  UNION_BRIDGE_STORAGE_INDICES,
+  UNION_RESPONSE_CODES,
+};

lib/constants/union-bridge-constants.js

@@ -1,37 +1,88 @@
-
 const fs = require('node:fs');
 const path = require('node:path');
 const solUtils = require('./sol-utils');
 const TEST_RELEASE_BTC_CONTRACT = '../contracts/CallReleaseBtcContract.sol';
 const TEST_RELEASE_BTC_CONTRACT_NAME = 'CallReleaseBtcContract';
+
+const TEST_UNION_BRIDGE_CONTRACT = '../contracts/UnionBridgeContract.sol';
+const TEST_UNION_BRIDGE_CONTRACT_NAME = 'UnionBridgeContract';
+
+const TEST_UNION_BRIDGE_AUTHORIZER_CONTRACT = '../contracts/UnionBridgeAuthorizer.sol';
+const TEST_UNION_BRIDGE_AUTHORIZER_CONTRACT_NAME = 'UnionBridgeAuthorizer';
+
 const SOLIDITY_COMPILER_VERSION = 'v0.8.26+commit.8a97fa7a';
 
 /**
  * Deploys the CallReleaseBtcContract contract.
- * @param {RskTransactionHelper} rskTxHelper 
+ * @param {RskTransactionHelper} rskTxHelper
  * @param {string} from the funded rsk address from which the contract will be deployed.
  * @returns {Promise<Contract>} the deployed contract.
  */
 const deployCallReleaseBtcContract = async (rskTxHelper, from) => {
-  
-    const fullPath = path.resolve(__dirname, TEST_RELEASE_BTC_CONTRACT);
-    const source = fs.readFileSync(fullPath).toString();
-  
-    const callReleaseBtcContract = await solUtils.compileAndDeploy(
-      SOLIDITY_COMPILER_VERSION,
-      source,
-      TEST_RELEASE_BTC_CONTRACT_NAME,
-      [],
-      rskTxHelper,
-      {
-        from
-      }
-    );
-
-    return callReleaseBtcContract;
-  
+
+  const fullPath = path.resolve(__dirname, TEST_RELEASE_BTC_CONTRACT);
+  const source = fs.readFileSync(fullPath).toString();
+
+  return await solUtils.compileAndDeploy(
+    SOLIDITY_COMPILER_VERSION,
+    source,
+    TEST_RELEASE_BTC_CONTRACT_NAME,
+    [],
+    rskTxHelper,
+    {
+      from
+    }
+  );
+
 };
 
+/**
+ * Deploys the unionBridgeContract contract.
+ * @param {RskTransactionHelper} rskTxHelper
+ * @param {string} from the funded rsk address from which the contract will be deployed.
+ * @returns {Promise<Contract>} the deployed contract.
+ */
+const deployUnionBridgeContract = async (rskTxHelper, from) => {
+  const fullPath = path.resolve(__dirname, TEST_UNION_BRIDGE_CONTRACT);
+  const source = fs.readFileSync(fullPath).toString();
+
+  return await solUtils.compileAndDeploy(
+    SOLIDITY_COMPILER_VERSION,
+    source,
+    TEST_UNION_BRIDGE_CONTRACT_NAME,
+    [],
+    rskTxHelper,
+    {
+      from
+    }
+  );
+}
+
+/**
+ * Deploys the UnionBridgeAuthorizer contract.
+ * @param {RskTransactionHelper} rskTxHelper
+ * @param {string} from the funded rsk address from which the contract will be deployed.
+ * @returns {Promise<Contract>} the deployed contract.
+ */
+const deployUnionBridgeAuthorizerContract = async (rskTxHelper, from) => {
+  const fullPath = path.resolve(__dirname, TEST_UNION_BRIDGE_AUTHORIZER_CONTRACT);
+  const source = fs.readFileSync(fullPath).toString();
+
+  return await solUtils.compileAndDeploy(
+    SOLIDITY_COMPILER_VERSION,
+    source,
+    TEST_UNION_BRIDGE_AUTHORIZER_CONTRACT_NAME,
+    [],
+    rskTxHelper,
+    {
+      from: from,
+      gas: '3000000'
+    }
+  );
+}
+
 module.exports = {
-    deployCallReleaseBtcContract,
+  deployCallReleaseBtcContract,
+  deployUnionBridgeContract,
+  deployUnionBridgeAuthorizerContract
 };

lib/contractDeployer.js

@@ -665,10 +665,87 @@ const getAddressFromUncompressedPublicKey = (uncompressedPublicKey) => {
   const uncompressedPublicKey0xPrefix = ensure0x(uncompressedPublicKeyWithoutCompressionPrefix);
   const hash = keccak256(uncompressedPublicKey0xPrefix);
   const hashWithout0xPrefix = removePrefix0x(hash);
-  const address = hashWithout0xPrefix.substring(24, hash.length); 
+  const address = hashWithout0xPrefix.substring(24, hash.length);
   return address;
 };
 
+/**
+ * Imports multiple private keys into the RSK transaction helper
+ * @param {RskTransactionHelper} rskTxHelper
+ * @param {string[]} privateKeys array of private keys to import
+ * @returns {Promise<string[]>} array of imported addresses
+ */
+const importAccounts = async (rskTxHelper, privateKeys) => {
+  const importedAddresses = [];
+  for (const privateKey of privateKeys) {
+    const address = await rskTxHelper.importAccount(privateKey);
+    importedAddresses.push(address);
+  }
+  return importedAddresses;
+};
+
+const decodeLogs = (rskClient, txReceipt, contractAbi) => {
+  const eventSignatureMap = buildEventSignatureMap(rskClient, contractAbi);
+  const events = [];
+  for (let log of txReceipt.logs) {
+    if (log.topics.length === 0) {
+      continue;
+    }
+
+    const eventSignature = log.topics[0];
+    const abiElement = eventSignatureMap[eventSignature];
+    if (!abiElement) {
+      continue;
+    }
+    const event = decodeLog(rskClient, log, abiElement);
+    events.push(event);
+  }
+  return events;
+};
+
+const buildEventSignatureMap = (rskClient, contractAbi) => {
+  return contractAbi
+    .flat()
+    .filter((element) => element.type === "event")
+    .reduce((acc, element) => {
+      const signature = rskClient.eth.abi.encodeEventSignature(element);
+      acc[signature] = element;
+      return acc;
+    }, {});
+};
+
+const decodeLog = (rskClient, log, abiElement) => {
+  const decodedLog = rskClient.eth.abi.decodeLog(abiElement.inputs, log.data, log.topics.slice(1));
+
+  const args = {};
+  for (let input of abiElement.inputs) {
+    args[input.name] = decodedLog[input.name];
+  }
+
+  return {
+    name: abiElement.name,
+    signature: log.topics[0],
+    args: args,
+  };
+};
+
+const assertContractCallFails = async (methodCall, options) => {
+  await expect(methodCall.call(options)).to.be.rejected;
+};
+
+const findEventInTx = async (rskTxHelper, txHash, eventName, contractAbi = []) => {
+  const rskClient = rskTxHelper.getClient();
+  // Fetch the transaction receipt to get all the logs (including the ones from internal txs)
+  const txReceipt = await rskTxHelper.getTxReceipt(txHash);
+  const events = decodeLogs(rskClient, txReceipt, contractAbi);
+  return events.find((event) => event.name === eventName);
+};
+
+const assertNoEventWasEmitted = async (txReceipt) => {
+  const isEmpty = Object.keys(txReceipt.events).length === 0;
+  expect(isEmpty, "No event should have been emitted").to.be.true;
+};
+
 module.exports = {
   mineAndSync,
   waitForBlock,
@@ -697,4 +774,9 @@ module.exports = {
   compressPublicKey,
   waitForRskMempoolToGetThisCountOfAddSignatureTxs,
   waitForRskMempoolToGetThisCountOfRegisterBtcTx,
+  importAccounts,
+  decodeLogs,
+  assertContractCallFails,
+  findEventInTx,
+  assertNoEventWasEmitted,
 };

lib/rsk-utils.js

@@ -75,14 +75,6 @@ const parseBtcPublicKeys = (btcPublicKeysInString) => {
     return btcPublicKeysInArrayWith0xPrefix;
 };
 
-const importAccounts = async (rskTxHelper, privateKeys) => {
-    const importedAddresses = [];
-    for (const privateKey of privateKeys) {
-        const address = await rskTxHelper.importAccount(privateKey);
-        importedAddresses.push(address);
-    }
-    return importedAddresses;
-};
 
 const execute = (description, newFederationConfig, segwitToSegwitFederationChange = false) => {
 
@@ -146,7 +138,7 @@ const execute = (description, newFederationConfig, segwitToSegwitFederationChang
 
             // Import the private keys of the federation change authorizers.
 
-            const importedFederationChangeAuthorizers = await importAccounts(rskTxHelper, [regtestFedChangeAuthorizer1PrivateKey, regtestFedChangeAuthorizer2PrivateKey, regtestFedChangeAuthorizer3PrivateKey]);
+            const importedFederationChangeAuthorizers = await rskUtils.importAccounts(rskTxHelper, [regtestFedChangeAuthorizer1PrivateKey, regtestFedChangeAuthorizer2PrivateKey, regtestFedChangeAuthorizer3PrivateKey]);
 
             fedChangeAuthorizer1Address = importedFederationChangeAuthorizers[0];
             fedChangeAuthorizer2Address = importedFederationChangeAuthorizers[1];
@@ -159,7 +151,7 @@ const execute = (description, newFederationConfig, segwitToSegwitFederationChang
 
             // Import the private keys of the not authorized addresses.
 
-            const importedNotAuthorizedAddresses = await importAccounts(rskTxHelper, [notAuthorized1PrivateKey, notAuthorized2PrivateKey, notAuthorized3PrivateKey]);
+            const importedNotAuthorizedAddresses = await rskUtils.importAccounts(rskTxHelper, [notAuthorized1PrivateKey, notAuthorized2PrivateKey, notAuthorized3PrivateKey]);
 
             notAuthorized1Address = importedNotAuthorizedAddresses[0];
             notAuthorized2Address = importedNotAuthorizedAddresses[1];
@@ -848,8 +840,8 @@ const execute = (description, newFederationConfig, segwitToSegwitFederationChang
             rskTxHelper = rskTxHelpers[0];
             bridge = await getBridge(rskTxHelper.getClient());
 
-            await importAccounts(rskTxHelper, [regtestFedChangeAuthorizer1PrivateKey, regtestFedChangeAuthorizer2PrivateKey, regtestFedChangeAuthorizer3PrivateKey]);
-            await importAccounts(rskTxHelper, [notAuthorized1PrivateKey, notAuthorized2PrivateKey, notAuthorized3PrivateKey]);
+            await rskUtils.importAccounts(rskTxHelper, [regtestFedChangeAuthorizer1PrivateKey, regtestFedChangeAuthorizer2PrivateKey, regtestFedChangeAuthorizer3PrivateKey]);
+            await rskUtils.importAccounts(rskTxHelper, [notAuthorized1PrivateKey, notAuthorized2PrivateKey, notAuthorized3PrivateKey]);
 
             const blocksToMineToRetireFederation = FUNDS_MIGRATION_AGE_SINCE_ACTIVATION_END;
             // Mining enough blocks to complete retiring the old federation.