Implement ChainflipFacet [ChainflipFacet v1.0.0,IChainflip v1.0.0,ReceiverChainflip v1.0.0]

config/chainflip.json

@@ -0,0 +1,6 @@
+{
+  "chainflipVault": {
+    "mainnet": "0xF5e10380213880111522dd0efD3dbb45b9f62Bcc",
+    "arbitrum": "0x79001a5e762f3bEFC8e5871b42F6734e00498920"
+  }
+}

deployments/_deployments_log_file.json

@@ -28928,5 +28928,37 @@
         ]
       }
     }
+  },
+  "ChainflipFacet": {
+    "arbitrum": {
+      "staging": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0xDd661337B48BEA5194F6d26F2C59fF0855E15289",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2025-02-17 17:00:59",
+            "CONSTRUCTOR_ARGS": "0x00000000000000000000000079001a5e762f3befc8e5871b42f6734e00498920",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      }
+    }
+  },
+  "ReceiverChainflip": {
+    "mainnet": {
+      "staging": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0xf0CfD9A8Fb7954C9F9948b94AD6f1Cc27Faff54c",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2025-02-18 12:28:25",
+            "CONSTRUCTOR_ARGS": "0x000000000000000000000000156cebba59deb2cb23742f70dcb0a11cc775591f000000000000000000000000be27f03c8e6a61e2a4b1ee7940dbcb9204744d1c000000000000000000000000f5e10380213880111522dd0efd3dbb45b9f62bcc",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      }
+    }
   }
 }

deployments/arbitrum.diamond.staging.json

@@ -138,12 +138,20 @@
         "Version": "1.0.0"
       },
       "0xE15C7585636e62b88bA47A40621287086E0c2E33": {
-        "Name": "",
-        "Version": ""
+        "Name": "DeBridgeDlnFacet",
+        "Version": "1.0.0"
       },
       "0x08BfAc22A3B41637edB8A7920754fDb30B18f740": {
         "Name": "AcrossFacetV3",
         "Version": "1.1.0"
+      },
+      "0x3aF0c2dB91f75f05493E51cFcF92eC5276bc85F8": {
+        "Name": "",
+        "Version": ""
+      },
+      "0xDd661337B48BEA5194F6d26F2C59fF0855E15289": {
+        "Name": "ChainflipFacet",
+        "Version": "1.0.0"
       }
     },
     "Periphery": {
@@ -153,8 +161,9 @@
       "GasZipPeriphery": "",
       "LiFiDEXAggregator": "",
       "LiFuelFeeCollector": "0x94EA56D8049e93E0308B9c7d1418Baf6A7C68280",
-      "Permit2Proxy": "0x6FC01BC9Ff6Cdab694Ec8Ca41B21a2F04C8c37E5",
+      "Permit2Proxy": "0xb33Fe241BEd9bf5F694101D7498F63a0d060F999",
       "ReceiverAcrossV3": "0xe4F3DEF14D61e47c696374453CD64d438FD277F8",
+      "ReceiverChainflip": "",
       "Receiver": "0x36E9B2E8A627474683eF3b1E9Df26D2bF04396f3",
       "ReceiverStargateV2": "",
       "RelayerCelerIM": "0xa1Ed8783AC96385482092b82eb952153998e9b70",

deployments/arbitrum.staging.json

@@ -35,7 +35,6 @@
   "DeBridgeDlnFacet": "0xE15C7585636e62b88bA47A40621287086E0c2E33",
   "MayanFacet": "0xd596C903d78870786c5DB0E448ce7F87A65A0daD",
   "StandardizedCallFacet": "0xA7ffe57ee70Ac4998e9E9fC6f17341173E081A8f",
-  "MayanFacet": "0xd596C903d78870786c5DB0E448ce7F87A65A0daD",
   "GenericSwapFacetV3": "0xFf6Fa203573Baaaa4AE375EB7ac2819d539e16FF",
   "CalldataVerificationFacet": "0x90B5b319cA20D9E466cB5b843952363C34d1b54E",
   "AcrossFacetPacked": "0x7A3770a9504924d99D38BBba4F0116B756393Eb3",
@@ -51,5 +50,6 @@
   "AcrossFacetV3": "0x08BfAc22A3B41637edB8A7920754fDb30B18f740",
   "ReceiverAcrossV3": "0xe4F3DEF14D61e47c696374453CD64d438FD277F8",
   "AcrossFacetPackedV3": "0x21767081Ff52CE5563A29f27149D01C7127775A2",
-  "RelayFacet": "0x3cf7dE0e31e13C93c8Aada774ADF1C7eD58157f5"
+  "RelayFacet": "0x3cf7dE0e31e13C93c8Aada774ADF1C7eD58157f5",
+  "ChainflipFacet": "0xDd661337B48BEA5194F6d26F2C59fF0855E15289"
 }

deployments/mainnet.diamond.staging.json

@@ -108,7 +108,10 @@
       "ReceiverAcrossV3": "",
       "ReceiverStargateV2": "",
       "RelayerCelerIM": "",
-      "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d"
+      "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d",
+      "GasZipPeriphery": "",
+      "Permit2Proxy": "",
+      "ReceiverChainflip": "0x5DFcEbB675F3cA2049d4b6791Ce2284EA940204a"
     }
   }
 }

deployments/mainnet.staging.json

@@ -29,5 +29,6 @@
   "SquidFacet": "0x933A3AfE2087FB8F5c9EE9A033477C42CC14c18E",
   "SynapseBridgeFacet": "0x57F98A94AC66e197AF6776D5c094FF0da2C0B198",
   "ThorSwapFacet": "0xa696287F37d21D566B9A80AC29b2640FF910C176",
-  "StandardizedCallFacet": "0x637Ac9AddC9C38b3F52878E11620a9060DC71d8B"
+  "StandardizedCallFacet": "0x637Ac9AddC9C38b3F52878E11620a9060DC71d8B",
+  "ReceiverChainflip": "0xf0CfD9A8Fb7954C9F9948b94AD6f1Cc27Faff54c"
 }

docs/ChainflipFacet.md

@@ -0,0 +1,108 @@
+# Chainflip Facet
+
+## How it works
+
+The Chainflip Facet enables cross-chain token transfers using Chainflip's protocol. It supports both EVM chains (Ethereum, Arbitrum) and non-EVM chains (Solana, Bitcoin) as destinations.
+
+```mermaid
+graph LR;
+    D{LiFiDiamond}-- DELEGATECALL -->ChainflipFacet;
+    ChainflipFacet -- CALL --> ChainflipVault[Chainflip Vault]
+```
+
+## Public Methods
+
+- `function startBridgeTokensViaChainflip(BridgeData calldata _bridgeData, ChainflipData calldata _chainflipData)`
+  - Bridges tokens using Chainflip without performing any swaps
+- `swapAndStartBridgeTokensViaChainflip(BridgeData memory _bridgeData, LibSwap.SwapData[] calldata _swapData, ChainflipData memory _chainflipData)`
+  - Performs swap(s) before bridging tokens using Chainflip
+
+## Chainflip Specific Parameters
+
+The methods listed above take a variable labeled `_chainflipData`. This data is specific to Chainflip and is represented as the following struct type:
+
+```solidity
+struct ChainflipData {
+  bytes32 nonEVMReceiver; // Destination address for non-EVM chains (Solana, Bitcoin)
+  uint32 dstToken; // Token identifier on the destination chain
+  bytes message; // Message that is passed to the destination address for cross-chain messaging
+  uint256 gasAmount; // Gas budget for the call on the destination chain
+  bytes cfParameters; // Additional parameters for future features
+}
+```
+
+For non-EVM destinations (Solana, Bitcoin), set the `receiver` in `BridgeData` to `LibAsset.NON_EVM_ADDRESS` and provide the destination address in `nonEVMReceiver`.
+
+## Supported Chains
+
+The facet supports the following chains with their respective IDs:
+
+- Ethereum (1)
+- Arbitrum (42161)
+- Solana (1151111081099710)
+- Bitcoin (20000000000001)
+
+[Reference](https://docs.chainflip.io/swapping/integrations/advanced/vault-swaps#supported-chains)
+
+## Swap Data
+
+Some methods accept a `SwapData _swapData` parameter.
+
+Swapping is performed by a swap specific library that expects an array of calldata that can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action.
+
+The swap library can be found [here](../src/Libraries/LibSwap.sol).
+
+## LiFi Data
+
+Some methods accept a `BridgeData _bridgeData` parameter.
+
+This parameter is strictly for analytics purposes. It's used to emit events that we can later track and index in our subgraphs and provide data on how our contracts are being used. `BridgeData` and the events we can emit can be found [here](../src/Interfaces/ILiFi.sol).
+
+## Getting Sample Calls to interact with the Facet
+
+In the following some sample calls are shown that allow you to retrieve a populated transaction that can be sent to our contract via your wallet.
+
+All examples use our [/quote endpoint](https://apidocs.li.fi/reference/get_quote) to retrieve a quote which contains a `transactionRequest`. This request can directly be sent to your wallet to trigger the transaction.
+
+The quote result looks like the following:
+
+```javascript
+const quoteResult = {
+  id: '0x...', // quote id
+  type: 'lifi', // the type of the quote (all lifi contract calls have the type "lifi")
+  tool: 'chainflip', // the bridge tool used for the transaction
+  action: {}, // information about what is going to happen
+  estimate: {}, // information about the estimated outcome of the call
+  includedSteps: [], // steps that are executed by the contract as part of this transaction, e.g. a swap step and a cross step
+  transactionRequest: {
+    // the transaction that can be sent using a wallet
+    data: '0x...',
+    to: '0x...',
+    value: '0x00',
+    from: '{YOUR_WALLET_ADDRESS}',
+    chainId: 100,
+    gasLimit: '0x...',
+    gasPrice: '0x...',
+  },
+}
+```
+
+A detailed explanation on how to use the /quote endpoint and how to trigger the transaction can be found [here](https://docs.li.fi/products/more-integration-options/li.fi-api/transferring-tokens-example).
+
+**Hint**: Don't forget to replace `{YOUR_WALLET_ADDRESS}` with your real wallet address in the examples.
+
+### Cross Only
+
+To get a transaction for a transfer from USDC on Ethereum to USDC on Arbitrum you can execute the following request:
+
+```shell
+curl 'https://li.quest/v1/quote?fromChain=ETH&fromAmount=1000000&fromToken=USDC&toChain=ARB&toToken=USDC&slippage=0.03&allowBridges=chainflip&fromAddress={YOUR_WALLET_ADDRESS}'
+```
+
+### Swap & Cross
+
+To get a transaction for a transfer from USDT on Ethereum to USDC on Arbitrum you can execute the following request:
+
+```shell
+curl 'https://li.quest/v1/quote?fromChain=ETH&fromAmount=1000000&fromToken=USDT&toChain=ARB&toToken=USDC&slippage=0.03&allowBridges=chainflip&fromAddress={YOUR_WALLET_ADDRESS}'
+```