feat: introduces a killswitch for the diamond (EmergencyPauseFacet v1.0.0)

config/global.json

@@ -8,6 +8,7 @@
   "withdrawWallet": "0x08647cc950813966142A416D40C382e2c5DB73bB",
   "lifuelRebalanceWallet": "0xC71284231A726A18ac85c94D75f9fe17A185BeAF",
   "deployerWallet": "0x11F1022cA6AdEF6400e5677528a80d49a069C00c",
+  "pauserWallet": "0x29DaCdF7cCaDf4eE67c923b4C22255A4B2494eD7",
   "approvedSigsForRefundWallet": [
     {
       "sig": "0x0d19e519",

deployments/_deployments_log_file.json

@@ -762,12 +762,12 @@
       "staging": {
         "1.0.0": [
           {
-            "ADDRESS": "0x8938CEa23C3c5eAABb895765f5B0b2b07D680402",
+            "ADDRESS": "0x47a0bD7A824291040BB7bD8cdBBd7d63bA1B81C9",
             "OPTIMIZER_RUNS": "1000000",
-            "TIMESTAMP": "2023-06-27 16:56:48",
+            "TIMESTAMP": "2024-07-21 16:02:40",
             "CONSTRUCTOR_ARGS": "0x",
-            "SALT": "27062023",
-            "VERIFIED": "true"
+            "SALT": "",
+            "VERIFIED": "false"
           }
         ]
       }
@@ -20552,5 +20552,35 @@
         ]
       }
     }
+  },
+  "EmergencyPauseFacet": {
+    "polygon": {
+      "staging": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x6DCDA5EEb0eb10D61eB9AAF93C3B89704955dA42",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-07-21 15:50:57",
+            "CONSTRUCTOR_ARGS": "0x00000000000000000000000029dacdf7ccadf4ee67c923b4c22255a4b2494ed7",
+            "SALT": "",
+            "VERIFIED": "false"
+          }
+        ]
+      }
+    },
+    "bsc": {
+      "staging": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x48BF2f96E4fEdEd569595BB1e015A747c2B35EEa",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-07-22 08:34:11",
+            "CONSTRUCTOR_ARGS": "0x00000000000000000000000029dacdf7ccadf4ee67c923b4c22255a4b2494ed7",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      }
+    }
   }
 }

deployments/bsc.diamond.staging.json

@@ -69,13 +69,13 @@
         "Name": "GenericSwapFacet",
         "Version": "1.0.0"
       },
-      "0xA269cb81E6bBB86683558e449cb1bAFFdb155Bfc": {
-        "Name": "",
-        "Version": ""
-      },
       "0xE871874D8AC30E8aCD0eC67529b4a5dDD73Bf0d6": {
         "Name": "GenericSwapFacetV3",
         "Version": "1.0.1"
+      },
+      "0x48BF2f96E4fEdEd569595BB1e015A747c2B35EEa": {
+        "Name": "EmergencyPauseFacet",
+        "Version": "1.0.0"
       }
     },
     "Periphery": {

deployments/bsc.staging.json

@@ -27,5 +27,6 @@
   "AmarokFacetPacked": "0x7ac3EB2D191EBAb9E925CAbFD4F8155be066b3aa",
   "MayanBridgeFacet": "0x5Ba4FeD1DAd2fD057A9f687B399B8e4cF2368214",
   "MayanFacet": "0xd596C903d78870786c5DB0E448ce7F87A65A0daD",
-  "GenericSwapFacetV3": "0xE871874D8AC30E8aCD0eC67529b4a5dDD73Bf0d6"
+  "GenericSwapFacetV3": "0xE871874D8AC30E8aCD0eC67529b4a5dDD73Bf0d6",
+  "EmergencyPauseFacet": "0x48BF2f96E4fEdEd569595BB1e015A747c2B35EEa"
 }

deployments/polygon.diamond.staging.json

@@ -1,6 +1,10 @@
 {
   "LiFiDiamond": {
     "Facets": {
+      "0x6DCDA5EEb0eb10D61eB9AAF93C3B89704955dA42": {
+        "Name": "EmergencyPauseFacet",
+        "Version": "1.0.0"
+      },
       "0x06045F5FA6EA7c6AcEb104b55BcD6C3dE3a08831": {
         "Name": "DiamondCutFacet",
         "Version": "1.0.0"

deployments/polygon.staging.json

@@ -1,6 +1,6 @@
 {
   "DiamondCutFacet": "0x06045F5FA6EA7c6AcEb104b55BcD6C3dE3a08831",
-  "DiamondLoupeFacet": "0x8938CEa23C3c5eAABb895765f5B0b2b07D680402",
+  "DiamondLoupeFacet": "0x47a0bD7A824291040BB7bD8cdBBd7d63bA1B81C9",
   "OwnershipFacet": "0x53d4Bcd5BEa4e863376b7eA43D7465351a4d71B0",
   "DexManagerFacet": "0xB94Fd26F6b138E1bE6CfEa5Ec4F67C5573F5d6AD",
   "AccessManagerFacet": "0x1A841931913806FB7570B43bcD64A487A8E7A50c",
@@ -39,5 +39,6 @@
   "TokenWrapper": "0xfb4A1eAC23CF91043C5C8f85993ce153B863ed61",
   "GasRebateDistributor": "0x3116B8F099D7eFA6e24f39F80146Aac423365EB9",
   "GenericSwapFacetV3": "0x4b904ad5Ca7601595277575824B080e078e2E812",
-  "StargateFacetV2": "0xeb3f9490d8cbD0C34C0642a8d0495e5E0B0745AA"
+  "StargateFacetV2": "0xeb3f9490d8cbD0C34C0642a8d0495e5E0B0745AA",
+  "EmergencyPauseFacet": "0x6DCDA5EEb0eb10D61eB9AAF93C3B89704955dA42"
 }

docs/EmergencyPauseFacet.md

@@ -0,0 +1,14 @@
+# EmergencyPauseFacet
+
+## How it works
+
+The EmergencyPauseFacet is an admin-only facet. Its purpose is to provide a fast yet secure way to respond to suspicious transactions and smart contract activity by either pausing the whole diamond or by removing one specific facet. This can be done from a non-multisig account (i.e.: the 'PauserWallet') to ensure fast execution. The unpausing of the contract as well as adding any new facets is still only possible through the multisig owner wallet for added security.
+
+## Public Methods
+
+- `function removeFacet(address _facetAddress)`
+  - Removes the given facet from the diamond
+- `function pauseDiamond()`
+  - Pauses the diamond by redirecting all function selectors to EmergencyPauseFacet
+- `function unpauseDiamond(address[] calldata _blacklist)`
+  - Unpauses the diamond by reactivating all formerly registered facets except for the facets in '\_blacklist'

docs/README.md

@@ -13,7 +13,9 @@
 - [DEX Manager Facet](./DexManagerFacet.md)
 - [DiamondCut Facet](./DiamondCutFacet.md)
 - [DiamondLoupe Facet](./DiamondLoupeFacet.md)
+- [Emergency Pause Facet](./EmergencyPauseFacet.md)
 - [Generic Swap Facet](./GenericSwapFacet.md)
+- [Generic Swap FacetV3](./GenericSwapFacetV3.md)
 - [Gnosis Bridge Facet](./GnosisBridgeFacet.md)
 - [Hop Facet](./HopFacet.md)
 - [Hop Facet Packed](./HopFacetPacked.md)
@@ -30,6 +32,7 @@
 - [Squid Facet](./SquidFacet.md)
 - [Standardized Call Facet](./StandardizedCallFacet.md)
 - [Stargate Facet](./StargateFacet.md)
+- [Stargate FacetV2](./StargateFacetV2.md)
 - [Synapse Bridge Facet](./SynapseBridgeFacet.md)
 - [ThorSwap Facet](./ThorSwapFacet.md)
 - [Withdraw Facet](./WithdrawFacet.md)
@@ -54,5 +57,7 @@
 - [ERC20Proxy](./ERC20Proxy.md)
 - [Executor](./Executor.md)
 - [FeeCollector](./FeeCollector.md)
+- [LiFuelFeeCollector](./LiFuelFeeCollector.md)
 - [Receiver](./Receiver.md)
+- [ReceiverStargateV2](./ReceiverStargateV2.md)
 - [RelayerCelerIM](./RelayerCelerIM.md)

script/deploy/facets/DeployEmergencyPauseFacet.s.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.17;
+
+import { DeployScriptBase } from "./utils/DeployScriptBase.sol";
+import { stdJson } from "forge-std/Script.sol";
+import { EmergencyPauseFacet } from "lifi/Facets/EmergencyPauseFacet.sol";
+
+contract DeployScript is DeployScriptBase {
+    using stdJson for string;
+
+    constructor() DeployScriptBase("EmergencyPauseFacet") {}
+
+    function run()
+        public
+        returns (EmergencyPauseFacet deployed, bytes memory constructorArgs)
+    {
+        constructorArgs = getConstructorArgs();
+
+        deployed = EmergencyPauseFacet(
+            deploy(type(EmergencyPauseFacet).creationCode)
+        );
+    }
+
+    function getConstructorArgs() internal override returns (bytes memory) {
+        string memory path = string.concat(root, "/config/global.json");
+        string memory json = vm.readFile(path);
+
+        address pauserWallet = json.readAddress(".pauserWallet");
+
+        return abi.encode(pauserWallet);
+    }
+}

script/deploy/facets/UpdateEmergencyPauseFacet.s.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.17;
+
+import { UpdateScriptBase } from "./utils/UpdateScriptBase.sol";
+import { stdJson } from "forge-std/StdJson.sol";
+import { EmergencyPauseFacet } from "lifi/Facets/EmergencyPauseFacet.sol";
+
+contract DeployScript is UpdateScriptBase {
+    using stdJson for string;
+
+    function run()
+        public
+        returns (address[] memory facets, bytes memory cutData)
+    {
+        return update("EmergencyPauseFacet");
+    }
+}

script/helperFunctions.sh

@@ -2047,7 +2047,7 @@ function checkFailure() {
 # >>>>> output to console
 function echoDebug() {
   # read function arguments into variables
-  MESSAGE=$1
+  local MESSAGE=$1
 
   # write message to console if debug flag is set to true
   if [[ $DEBUG == "true" ]]; then
@@ -2060,6 +2060,9 @@ function error() {
 function warning() {
   printf '\033[33m[warning] %s\033[0m\n' "$1"
 }
+function success() {
+  printf '\033[0;32m[success] %s\033[0m\n' "$1"
+}
 # <<<<< output to console
 
 # >>>>> Reading and manipulation of target state JSON file
@@ -2882,7 +2885,7 @@ function getCreate3FactoryAddress() {
 
   echo $CREATE3_FACTORY
 }
-  
+
 
 function printDeploymentsStatus() {
   # read function arguments into variables
@@ -3296,6 +3299,56 @@ function compareAddresses() {
     return 1
   fi
 }
+function sendMessageToDiscordSmartContractsChannel() {
+  # read function arguments into variable
+  local MESSAGE=$1
+
+  if [ -z "$DISCORD_WARNING_WEBHOOK_URL" ]; then
+    echo ""
+    warning "Discord webhook URL for dev-smartcontracts is missing. Cannot send log message."
+    echo ""
+    return 1
+  fi
+
+  echo ""
+  echoDebug "sending the following message to Discord webhook ('dev-smartcontracts' channel):"
+  echoDebug "$MESSAGE"
+  echo ""
+
+  # Send the message
+  curl -H "Content-Type: application/json" \
+     -X POST \
+     -d "{\"content\": \"$MESSAGE\"}" \
+     $DISCORD_WARNING_WEBHOOK_URL
+
+  echoDebug "Log message sent to Discord"
+
+  return 0
+
+
+}
+
+function getUserInfo() {
+  # log local username
+  local USERNAME=$(whoami)
+
+  # log Github email address
+  EMAIL=$(git config --global user.email)
+  if [ -z "$EMAIL" ]; then
+      EMAIL=$(git config --local user.email)
+  fi
+
+  # return collected info
+  echo "Username: $USERNAME, Github email: $EMAIL"
+
+}
+function cleanupBackgroundJobs() {
+  echo "Cleaning up..."
+  # Kill all background jobs
+  pkill -P $$
+  echo "All background jobs killed. Script execution aborted."
+  exit 1
+}
 # <<<<<< miscellaneous
 
 # >>>>>> helpers to set/update deployment files/logs/etc
@@ -3642,13 +3695,14 @@ function test_tmp() {
   ENVIRONMENT="production"
   VERSION="2.0.0"
   DIAMOND_CONTRACT_NAME="LiFiDiamondImmutable"
-  ARGS="0x000000000000000000000000ce16f69375520ab01377ce7b88f5ba8c48f8d666"
-
+  ARGS="0x00000000000000000000000ce16f69375520ab01377ce7b88f5ba8c48f8d666"
+  RPC_URL=$(getRPCUrl "$NETWORK" "$ENVIRONMENT")
   #  ADDRESS=$(getContractOwner "$NETWORK" "$ENVIRONMENT" "ERC20Proxy");
   #  if [[ "$ADDRESS" != "$ZERO_ADDRESS" ]]; then
   #    error "ERC20Proxy ownership was not transferred to address(0)"
   #    exit 1
   #  fi
   #getPeripheryAddressFromDiamond "$NETWORK" "0x9b11bc9FAc17c058CAB6286b0c785bE6a65492EF" "RelayerCelerIM"
-  verifyContract "$NETWORK" "$CONTRACT" "$ADDRESS" "$ARGS"
+  # verifyContract "$NETWORK" "$CONTRACT" "$ADDRESS" "$ARGS"
 }
+# test_tmp