feat(smart-wallet): Initial commit (#319)

Co-authored-by: Daniel Gretzke <daniel@gretzke.de>

Author: zhongeric

sdks/smart-wallet-sdk/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:eslint-comments/recommended',
+    'plugin:import/typescript',
+    'prettier',
+  ],
+  plugins: ['@typescript-eslint', 'import'],
+  rules: {
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+    'import/order': ['error', { 'newlines-between': 'always', alphabetize: { order: 'asc' } }],
+  },
+}

sdks/smart-wallet-sdk/.gitignore

@@ -0,0 +1,29 @@
+# Dependencies
+node_modules/
+
+# Build output
+dist/
+build/
+
+# Generated files
+src/contracts/
+
+# Coverage
+coverage/
+
+# Cache
+.cache/
+.turbo/
+
+# IDE
+.idea/
+.vscode/
+
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# OS
+.DS_Store

sdks/smart-wallet-sdk/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Uniswap Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdks/smart-wallet-sdk/README.md

@@ -0,0 +1,25 @@
+# Smart Wallet SDK
+
+⚒️ An SDK for building applications with smart wallets on Uniswap
+
+This SDK provides utilities for interacting with Uniswap protocols using smart wallets.
+
+## Installation
+
+```bash
+npm install @uniswap/smart-wallet-sdk
+```
+
+or
+
+```bash
+yarn add @uniswap/smart-wallet-sdk
+```
+
+## Documentation
+
+Coming soon...
+
+## License
+
+MIT

sdks/smart-wallet-sdk/abis/MinimalDelegation.json

@@ -0,0 +1,11 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  rootDir: 'src',
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.base.json',
+    },
+  },
+}

sdks/smart-wallet-sdk/jest.config.js

@@ -0,0 +1,94 @@
+{
+  "name": "@uniswap/smart-wallet-sdk",
+  "description": "⚒️ An SDK for building applications with smart wallets on Uniswap",
+  "repository": "https://github.com/Uniswap/sdks.git",
+  "keywords": [
+    "uniswap",
+    "ethereum",
+    "smart-wallet"
+  ],
+  "license": "MIT",
+  "main": "./dist/cjs/src/index.js",
+  "module": "./dist/esm/src/index.js",
+  "types": "./dist/types/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "clean": "rm -rf dist src/contracts",
+    "build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "lint": "eslint src --ext .ts",
+    "test": "jest"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@uniswap/sdk-core": "^7.6.0",
+    "viem": "^2.23.5"
+  },
+  "devDependencies": {
+    "@types/jest": "^24.0.25",
+    "@types/node": "^18.7.16",
+    "eslint": "^7.8.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-functional": "^3.0.2",
+    "eslint-plugin-import": "^2.22.0",
+    "jest": "25.5.0",
+    "prettier": "^2.4.1",
+    "ts-jest": "^25.5.1",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.3.0",
+    "typescript": "npm:typescript@^5.6.2"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "semi": false,
+    "singleQuote": true
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "release": {
+    "extends": "semantic-release-monorepo",
+    "branches": [
+      {
+        "name": "main",
+        "prerelease": false
+      }
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "angular",
+          "releaseRules": "../../publishing/release-rules.cjs"
+        }
+      ],
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "@semantic-release/exec",
+        {
+          "successCmd": "git restore yarn.lock && yarn",
+          "failCmd": "git restore yarn.lock && yarn",
+          "execCwd": "../.."
+        }
+      ]
+    ]
+  }
+}

sdks/smart-wallet-sdk/package.json

@@ -0,0 +1,59 @@
+import { ChainId } from '@uniswap/sdk-core'
+
+/**
+ * The target address for self-calls is address(0)
+ */
+export const SELF_CALL_TARGET = "0x0000000000000000000000000000000000000000"
+
+/**
+ * Call types for smart wallet calls
+ * Follows ERC-7579
+ */
+export enum ModeType {
+  BATCHED_CALL = '0x0100000000000000000000000000000000000000000000000000000000000000',
+  BATCHED_CALL_CAN_REVERT = '0x0101000000000000000000000000000000000000000000000000000000000000',
+  BATCHED_CALL_SUPPORTS_OPDATA = '0x0100000000007821000100000000000000000000000000000000000000000000',
+  BATCHED_CALL_SUPPORTS_OPDATA_AND_CAN_REVERT = '0x0101000000007821000100000000000000000000000000000000000000000000'
+}
+
+const BATCHED_CALL_EXECUTION_DATA_ABI = [
+  {
+    type: 'tuple[]',
+    components: [
+      { type: 'address', name: 'to' },
+      { type: 'uint256', name: 'value' },
+      { type: 'bytes', name: 'data' }
+    ]
+  }
+]
+
+const BATCHED_CALL_SUPPORTS_OPDATA_EXECUTION_DATA_ABI = [
+  ...BATCHED_CALL_EXECUTION_DATA_ABI,
+  { type: 'bytes', name: 'opData' }
+]
+
+/**
+ * ABI encoding for each mode type
+ */
+export const MODE_TYPE_ABI_PARAMETERS = {
+  [ModeType.BATCHED_CALL]: BATCHED_CALL_EXECUTION_DATA_ABI,
+  [ModeType.BATCHED_CALL_CAN_REVERT]: BATCHED_CALL_EXECUTION_DATA_ABI,
+  [ModeType.BATCHED_CALL_SUPPORTS_OPDATA]: BATCHED_CALL_SUPPORTS_OPDATA_EXECUTION_DATA_ABI,
+  [ModeType.BATCHED_CALL_SUPPORTS_OPDATA_AND_CAN_REVERT]: BATCHED_CALL_SUPPORTS_OPDATA_EXECUTION_DATA_ABI
+} as const
+
+/**
+ * Mapping of chainId to Smart Wallet contract addresses
+ */
+export const SMART_WALLET_ADDRESSES: { [chainId in ChainId]?: `0x${string}` } = {
+  // Mainnet
+  [ChainId.MAINNET]: '0x0000000000000000000000000000000000000000', // Placeholder - to be replaced
+  // Optimism
+  [ChainId.OPTIMISM]: '0x0000000000000000000000000000000000000000', // Placeholder - to be replaced
+  // Polygon
+  [ChainId.POLYGON]: '0x0000000000000000000000000000000000000000', // Placeholder - to be replaced
+  // Arbitrum
+  [ChainId.ARBITRUM_ONE]: '0x0000000000000000000000000000000000000000', // Placeholder - to be replaced
+  // Base
+  [ChainId.BASE]: '0x0000000000000000000000000000000000000000', // Placeholder - to be replaced
+}

sdks/smart-wallet-sdk/src/constants.ts

@@ -0,0 +1,17 @@
+// Smart Wallet SDK entry point
+export const VERSION = '0.1.0'
+
+// Export all types
+export * from './types'
+
+// Export constants
+export * from './constants'
+
+// Export utilities
+export * from './utils'
+
+// Export main class
+export * from './smartWallet'
+
+// Export generated contracts (will be available after running typechain)
+// export * from './contracts'

sdks/smart-wallet-sdk/src/index.ts

@@ -0,0 +1,90 @@
+import { ChainId } from '@uniswap/sdk-core'
+
+import { ModeType, SMART_WALLET_ADDRESSES } from './constants';
+import { SmartWallet } from './smartWallet'
+import { Call } from './types'
+
+const EXECUTE_SELECTOR = "0xe9ae5c53" as `0x${string}`
+
+describe('SmartWallet', () => {
+  describe('encodeExecute', () => {
+    it('encodes batch calls correctly', () => {
+      const calls: Call[] = [
+        {
+          to: '0x1111111111111111111111111111111111111111',
+          data: '0x1234',
+          value: 0n
+        },
+        {
+          to: '0x2222222222222222222222222222222222222222',
+          data: '0x5678',
+          value: 1n
+        }
+      ]
+
+      const result = SmartWallet.encodeCalls(calls)
+      expect(result).toBeDefined()
+      expect(result.calldata).toBeDefined()
+      expect(result.value).toBeDefined()
+    })
+
+    it('encodes batch calls with revertOnFailure option', () => {
+      const calls: Call[] = [
+        {
+          to: '0x1111111111111111111111111111111111111111',
+          data: '0x1234',
+          value: 0n
+        }
+      ]
+      
+      const result = SmartWallet.encodeCalls(calls, { revertOnFailure: true })
+      expect(result).toBeDefined()
+      expect(result.calldata).toBeDefined()
+      expect(result.value).toBeDefined()
+    })
+
+    it('throws an error if the mode is not supported', () => {
+      // mock getModeFromOptions
+      jest.spyOn(SmartWallet, 'getModeFromOptions').mockReturnValue(ModeType.BATCHED_CALL_SUPPORTS_OPDATA)
+      const calls: Call[] = [
+        {
+          to: '0x1111111111111111111111111111111111111111',
+          data: '0x1234',
+          value: 0n
+        }
+      ]
+      expect(() => SmartWallet.encodeCalls(calls)).toThrow()
+
+      jest.restoreAllMocks()
+    })
+  })
+
+  describe('createExecute', () => {
+    it('creates an execute call for specific chain', () => {
+      const methodParams = {
+        calldata: EXECUTE_SELECTOR,
+        value: 0n
+      }
+      
+      const call = SmartWallet.createExecute(methodParams, ChainId.MAINNET)
+      
+      // Verify the result
+      expect(call).toBeDefined()
+      expect(call.to).toBe(SMART_WALLET_ADDRESSES[ChainId.MAINNET])
+      expect(call.data).toBe(EXECUTE_SELECTOR)
+      expect(call.value).toBe(0n)
+    })
+  })
+
+  describe('getModeFromOptions', () => {
+    for(const canRevert of [true, false]) {
+      it(`returns the correct mode type for canRevert: ${canRevert}`, () => {
+        if(canRevert) {
+          expect(SmartWallet.getModeFromOptions({ revertOnFailure: canRevert })).toBe(ModeType.BATCHED_CALL_CAN_REVERT)
+        } else {
+          expect(SmartWallet.getModeFromOptions({ revertOnFailure: canRevert })).toBe(ModeType.BATCHED_CALL)
+        }
+      })
+    }
+  })
+})