Feat(stargate): Stargate bridge

packages/stargate/README.md

@@ -0,0 +1,25 @@
+
+## ETH/BASE TOKEN
+Other than the token address retrieval this is a pretty trivial to implement plugin.
+Unfortunatly in order to get the token address we need to do some direct chain reads but nothing too heavy.
+
+
+### Deposit ETH
+Deposit to Arbitrum Layer Zero
+https://etherscan.io/tx/0xe3a54ddf9a09ee9df6abe87af38cc418c516fb198fc635972615418f5254812a
+
+### Withdraw ETH
+Withdraw ETH to Optimism
+https://arbiscan.io/tx/0xc6fa0deba78d6228d3cb343a908390162955dcb3d6d5a8e952ef24c54f7c453f
+
+## ERC20
+
+### Deposit ERC20
+https://etherscan.io/tx/0x28901f729bd89400b5c046eb73abf0656ab82cb02463e47562d7ce24737d263f
+### Withdraw ERC20 
+USDT
+https://arbiscan.io/tx/0xb983d41651ccad84a70600564376975a3a3385dae53de35259486f20dd2d8d4d
+
+
+You can use the following example code to pull down test transactions in the correct format easily:
+https://viem.sh/docs/actions/public/getTransaction.html#example

packages/stargate/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@rabbitholegg/questdk-plugin-stargate",
+  "private": true,
+  "version": "1.0.0-alpha.3",
+  "type": "module",
+  "exports": {
+    "require": "./dist/cjs/index.js",
+    "import": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "packageManager": "[email protected]",
+  "description": "",
+  "scripts": {
+    "bench": "vitest bench",
+    "bench:ci": "CI=true vitest bench",
+    "build": "pnpm run clean && pnpm run build:cjs && pnpm run build:esm && pnpm run build:types",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm": "tsc --project tsconfig.build.json --module es2015 --outDir ./dist/esm && echo > ./dist/esm/package.json '{\"type\":\"module\",\"sideEffects\":false}'",
+    "build:types": "tsc --project tsconfig.build.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
+    "clean": "rimraf dist",
+    "format": "rome format . --write",
+    "lint": "rome check .",
+    "lint:fix": "pnpm lint --apply",
+    "preinstall": "npx only-allow pnpm",
+    "test": "vitest dev",
+    "test:cov": "vitest dev --coverage",
+    "test:ci": "CI=true vitest --coverage",
+    "test:ui": "vitest dev --ui"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "devDependencies": {
+    "@types/node": "^20.4.5",
+    "@vitest/coverage-v8": "^0.33.0",
+    "rimraf": "^5.0.1",
+    "rome": "^12.1.3",
+    "ts-node": "^10.9.1",
+    "tsconfig": "workspace:*",
+    "typescript": "^5.1.6",
+    "vitest": "^0.33.0"
+  },
+  "dependencies": {
+    "@rabbitholegg/questdk": "1.0.1-alpha.8",
+    "viem": "^1.6.7"
+  }
+}

packages/stargate/src/Stargate.test.ts

@@ -0,0 +1,160 @@
+import { GreaterThanOrEqual, apply } from '@rabbitholegg/questdk/filter'
+import { describe, expect, test } from 'vitest'
+import { bridge } from './Stargate.js'
+import {
+  DEPOSIT_ETH,
+  DEPOSIT_ERC20,
+  WITHDRAW_ETH,
+  WITHDRAW_ERC20,
+} from './test-transactions.js'
+import {
+  ARBITRUM_LAYER_ZERO_CHAIN_ID,
+  POLYGON_LAYER_ZERO_CHAIN_ID,
+  ETH_LAYER_ZERO_CHAIN_ID,
+  OPTIMISM_LAYER_ZERO_CHAIN_ID,
+  LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID,
+} from './chain-ids.js'
+import { STARGATE_BRIDGE_ABI } from './abi.js'
+import { parseEther } from 'viem'
+import {
+  CHAIN_AND_POOL_TO_TOKEN_ADDRESS,
+  CHAIN_ID_TO_ROUTER_ADDRESS,
+  CHAIN_ID_TO_ETH_ROUTER_ADDRESS,
+} from './contract-addresses.js'
+
+const ARBITRUM_USDC_ADDRESS = '0x892785f33CdeE22A30AEF750F285E18c18040c3e'
+const ARBITRUM_USDT_ADDRESS = '0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9'
+const ETHEREUM_USDC_ADDRESS = '0xdf0770dF86a8034b3EFEf0A1Bb3c889B8332FF56'
+const ETHEREUM_SGETH_ADDRESS = '0x101816545F6bd2b1076434B54383a1E633390A2E'
+const ARBITRUM_SGETH_ADDRESS = '0x82CbeCF39bEe528B5476FE6d1550af59a9dB6Fc0'
+const TEST_USER = '0x7c3bd1a09d7d86920451def20ae503322c8d0412'
+// Replace *project* with the name of the project
+describe('Given the Across plugin', () => {
+  describe('When generating the filter', () => {
+    test('should return a valid bridge action filter for L2 token tx', async () => {
+      const filter = await bridge({
+        sourceChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: ETH_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ARBITRUM_USDC_ADDRESS,
+        amount: GreaterThanOrEqual(100000n),
+        recipient: TEST_USER,
+      })
+      const sourcePool =
+        CHAIN_AND_POOL_TO_TOKEN_ADDRESS[ARBITRUM_LAYER_ZERO_CHAIN_ID][
+          ARBITRUM_USDC_ADDRESS
+        ]
+
+      expect(filter).to.deep.equal({
+        chainId: LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID[ARBITRUM_LAYER_ZERO_CHAIN_ID],
+        to: CHAIN_ID_TO_ROUTER_ADDRESS[ARBITRUM_LAYER_ZERO_CHAIN_ID],
+        input: {
+          $abi: STARGATE_BRIDGE_ABI,
+          _srcPoolId: sourcePool,
+          _amountLD: {
+            $gte: '100000',
+          },
+          _to: TEST_USER,
+          _dstChainId: ETH_LAYER_ZERO_CHAIN_ID,
+        },
+      })
+    })
+
+    test('should return a valid bridge action filter for L1 token tx', async () => {
+      const filter = await bridge({
+        sourceChainId: ETH_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ETHEREUM_USDC_ADDRESS,
+        amount: GreaterThanOrEqual(100000n),
+        recipient: TEST_USER,
+      })
+      const sourcePool =
+        CHAIN_AND_POOL_TO_TOKEN_ADDRESS[ETH_LAYER_ZERO_CHAIN_ID][
+          ETHEREUM_USDC_ADDRESS
+        ]
+
+      expect(filter).to.deep.equal({
+        chainId: LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID[ETH_LAYER_ZERO_CHAIN_ID],
+        to: CHAIN_ID_TO_ROUTER_ADDRESS[ETH_LAYER_ZERO_CHAIN_ID],
+        input: {
+          $abi: STARGATE_BRIDGE_ABI,
+          _srcPoolId: sourcePool,
+          _amountLD: {
+            $gte: '100000',
+          },
+          _to: TEST_USER,
+          _dstChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        },
+      })
+    })
+
+    test('should return a valid bridge action filter for L1 ETH tx', async () => {
+      const filter = await bridge({
+        sourceChainId: ETH_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ETHEREUM_SGETH_ADDRESS,
+        amount: GreaterThanOrEqual(100000n),
+        recipient: TEST_USER,
+      })
+      expect(filter).to.deep.equal({
+        chainId: LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID[ETH_LAYER_ZERO_CHAIN_ID],
+        to: CHAIN_ID_TO_ETH_ROUTER_ADDRESS[ETH_LAYER_ZERO_CHAIN_ID],
+        input: {
+          $abi: STARGATE_BRIDGE_ABI,
+          _amountLD: {
+            $gte: '100000',
+          },
+          _toAddress: TEST_USER,
+          _dstChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        },
+      })
+    })
+  })
+  describe('When applying the filter', () => {
+    test('should pass filter with valid L1 ETH tx', async () => {
+      const transaction = DEPOSIT_ETH
+      const filter = await bridge({
+        sourceChainId: ETH_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ETHEREUM_SGETH_ADDRESS,
+        amount: GreaterThanOrEqual(parseEther('.04')),
+        recipient: '0x7c3bd1a09d7d86920451def20ae503322c8d0412',
+      })
+      expect(apply(transaction, filter)).to.be.true
+    })
+    test('should pass filter with valid L2 ETH tx', async () => {
+      const transaction = WITHDRAW_ETH
+      const filter = await bridge({
+        sourceChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: OPTIMISM_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ARBITRUM_SGETH_ADDRESS,
+        amount: GreaterThanOrEqual(parseEther('.6')),
+        recipient: '0x08bfa4ef61a457792c45240829529b43b019d941',
+      })
+      expect(apply(transaction, filter)).to.be.true
+    })
+    test('should pass filter with valid L1 Token tx', async () => {
+      const transaction = DEPOSIT_ERC20
+      const filter = await bridge({
+        sourceChainId: ETH_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ETHEREUM_USDC_ADDRESS,
+        amount: GreaterThanOrEqual('48500000'), // $250 USDC,
+        recipient: '0x0318ccfbfae5e2c06b2f533a35acecea13b9909f',
+      })
+      expect(apply(transaction, filter)).to.be.true
+    })
+    test('should pass filter with valid L2 token tx', async () => {
+      const transaction = WITHDRAW_ERC20
+      const filter = await bridge({
+        sourceChainId: ARBITRUM_LAYER_ZERO_CHAIN_ID,
+        destinationChainId: POLYGON_LAYER_ZERO_CHAIN_ID,
+        tokenAddress: ARBITRUM_USDT_ADDRESS,
+        amount: GreaterThanOrEqual('1200000000'),
+        recipient: '0x5ee8496532d3dcb8bc726d66d8cb4c45d979e71d',
+      })
+      expect(apply(transaction, filter)).to.be.true
+    })
+  })
+
+  test('should not pass filter with invalid transactions', () => {})
+})

packages/stargate/src/Stargate.ts

@@ -0,0 +1,67 @@
+import { type BridgeActionParams, compressJson } from '@rabbitholegg/questdk'
+import { type Address } from 'viem'
+import { STARGATE_BRIDGE_ABI } from './abi.js'
+import {
+  CHAIN_ID_ARRAY,
+  LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID,
+} from './chain-ids.js'
+import {
+  CHAIN_AND_POOL_TO_TOKEN_ADDRESS,
+  CHAIN_ID_TO_ROUTER_ADDRESS,
+  CHAIN_ID_TO_ETH_ROUTER_ADDRESS,
+} from './contract-addresses.js'
+
+// If you're implementing swap or mint, simply duplicate this function and change the name
+export const bridge = async (bridge: BridgeActionParams) => {
+  // This is the information we'll use to compose the Transaction object
+  const {
+    sourceChainId,
+    destinationChainId,
+    contractAddress,
+    tokenAddress,
+    amount,
+    recipient,
+  } = bridge
+  const layerOneChainId = LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID[sourceChainId]
+  const sourcePool = tokenAddress
+    ? CHAIN_AND_POOL_TO_TOKEN_ADDRESS[sourceChainId][tokenAddress]
+    : 0
+
+  if (sourcePool === 13) {
+    const targetContractAddress = CHAIN_ID_TO_ETH_ROUTER_ADDRESS[sourceChainId]
+    return compressJson({
+      chainId: layerOneChainId, // The chainId of the source chain
+      to: contractAddress || targetContractAddress, // The contract address of the bridge
+      input: {
+        $abi: STARGATE_BRIDGE_ABI, // The ABI of the bridge contract
+        _amountLD: amount, // The amount of tokens to send
+        _toAddress: recipient, // The recipient of the tokens
+        _dstChainId: destinationChainId, // The chainId of the destination chain
+      }, // The input object is where we'll put the ABI and the parameters
+    })
+  }
+  const targetContractAddress = CHAIN_ID_TO_ROUTER_ADDRESS[sourceChainId]
+
+  // We always want to return a compressed JSON object which we'll transform into a TransactionFilter
+  return compressJson({
+    chainId: layerOneChainId, // The chainId of the source chain
+    to: contractAddress || targetContractAddress, // The contract address of the bridge
+    input: {
+      $abi: STARGATE_BRIDGE_ABI, // The ABI of the bridge contract
+      _srcPoolId: sourcePool, // The source poolId
+      _amountLD: amount, // The amount of tokens to send
+      _to: recipient, // The recipient of the tokens
+      _dstChainId: destinationChainId, // The chainId of the destination chain
+    }, // The input object is where we'll put the ABI and the parameters
+  })
+}
+
+export const getSupportedTokenAddresses = async (
+  _chainId: number,
+): Promise<Address[]> => {
+  // Given a specific chain we would expect this function to return a list of supported token addresses
+}
+
+export const getSupportedChainIds = async () => {
+  return CHAIN_ID_ARRAY
+}

packages/stargate/src/abi.ts

@@ -0,0 +1,49 @@
+export const STARGATE_BRIDGE_ABI = [
+  {
+    inputs: [
+      { internalType: 'uint16', name: '_dstChainId', type: 'uint16' },
+      {
+        internalType: 'address payable',
+        name: '_refundAddress',
+        type: 'address',
+      },
+      { internalType: 'bytes', name: '_toAddress', type: 'bytes' },
+      { internalType: 'uint256', name: '_amountLD', type: 'uint256' },
+      { internalType: 'uint256', name: '_minAmountLD', type: 'uint256' },
+    ],
+    name: 'swapETH',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint16', name: '_dstChainId', type: 'uint16' },
+      { internalType: 'uint256', name: '_srcPoolId', type: 'uint256' },
+      { internalType: 'uint256', name: '_dstPoolId', type: 'uint256' },
+      {
+        internalType: 'address payable',
+        name: '_refundAddress',
+        type: 'address',
+      },
+      { internalType: 'uint256', name: '_amountLD', type: 'uint256' },
+      { internalType: 'uint256', name: '_minAmountLD', type: 'uint256' },
+      {
+        components: [
+          { internalType: 'uint256', name: 'dstGasForCall', type: 'uint256' },
+          { internalType: 'uint256', name: 'dstNativeAmount', type: 'uint256' },
+          { internalType: 'bytes', name: 'dstNativeAddr', type: 'bytes' },
+        ],
+        internalType: 'struct IStargateRouter.lzTxObj',
+        name: '_lzTxParams',
+        type: 'tuple',
+      },
+      { internalType: 'bytes', name: '_to', type: 'bytes' },
+      { internalType: 'bytes', name: '_payload', type: 'bytes' },
+    ],
+    name: 'swap',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+]

packages/stargate/src/chain-ids.ts

@@ -0,0 +1,39 @@
+export const ETH_LAYER_ZERO_CHAIN_ID: number = 101
+export const BNB_LAYER_ZERO_CHAIN_ID: number = 102
+export const AVALANCHE_LAYER_ZERO_CHAIN_ID: number = 106
+export const POLYGON_LAYER_ZERO_CHAIN_ID: number = 109
+export const ARBITRUM_LAYER_ZERO_CHAIN_ID: number = 110
+export const OPTIMISM_LAYER_ZERO_CHAIN_ID: number = 111
+export const FANTOM_LAYER_ZERO_CHAIN_ID: number = 112
+export const METIS_LAYER_ZERO_CHAIN_ID: number = 151
+export const KAVA_LAYER_ZERO_CHAIN_ID: number = 177
+export const LINEA_LAYER_ZERO_CHAIN_ID: number = 183
+export const BASE_LAYER_ZERO_CHAIN_ID: number = 184
+
+export const LAYER_ZERO_TO_LAYER_ONE_CHAIN_ID: Record<number, number> = {
+  [ETH_LAYER_ZERO_CHAIN_ID]: 1,
+  [BNB_LAYER_ZERO_CHAIN_ID]: 56,
+  [AVALANCHE_LAYER_ZERO_CHAIN_ID]: 43114,
+  [POLYGON_LAYER_ZERO_CHAIN_ID]: 137,
+  [ARBITRUM_LAYER_ZERO_CHAIN_ID]: 42161,
+  [OPTIMISM_LAYER_ZERO_CHAIN_ID]: 10,
+  [FANTOM_LAYER_ZERO_CHAIN_ID]: 250,
+  [METIS_LAYER_ZERO_CHAIN_ID]: 1088,
+  [KAVA_LAYER_ZERO_CHAIN_ID]: 2222,
+  [LINEA_LAYER_ZERO_CHAIN_ID]: 59144,
+  [BASE_LAYER_ZERO_CHAIN_ID]: 8453,
+}
+
+export const CHAIN_ID_ARRAY = [
+  ETH_LAYER_ZERO_CHAIN_ID,
+  BNB_LAYER_ZERO_CHAIN_ID,
+  AVALANCHE_LAYER_ZERO_CHAIN_ID,
+  POLYGON_LAYER_ZERO_CHAIN_ID,
+  ARBITRUM_LAYER_ZERO_CHAIN_ID,
+  OPTIMISM_LAYER_ZERO_CHAIN_ID,
+  FANTOM_LAYER_ZERO_CHAIN_ID,
+  METIS_LAYER_ZERO_CHAIN_ID,
+  KAVA_LAYER_ZERO_CHAIN_ID,
+  LINEA_LAYER_ZERO_CHAIN_ID,
+  BASE_LAYER_ZERO_CHAIN_ID,
+] as const