chore: add account abstraction example

bob-collective · Oct 26, 2023 · 08e0cf2 · 08e0cf2
1 parent a731847
commit 08e0cf2
Show file tree

Hide file tree

Showing 35 changed files with 10,057 additions and 0 deletions.
diff --git a/examples/account-abstraction/web3auth/.env.example b/examples/account-abstraction/web3auth/.env.example
@@ -0,0 +1 @@
+VITE_WALLET_CONNECT_PROJECT_ID=
diff --git a/examples/account-abstraction/web3auth/.eslintrc.cjs b/examples/account-abstraction/web3auth/.eslintrc.cjs
@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/examples/account-abstraction/web3auth/.gitignore b/examples/account-abstraction/web3auth/.gitignore
@@ -0,0 +1,26 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.env
diff --git a/examples/account-abstraction/web3auth/.prettierignore b/examples/account-abstraction/web3auth/.prettierignore
@@ -0,0 +1,5 @@
+dist
+node_modules
+coverage
+build
+pnpm-lock.yaml
diff --git a/examples/account-abstraction/web3auth/.prettierrc.json b/examples/account-abstraction/web3auth/.prettierrc.json
@@ -0,0 +1,8 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": true
+}
diff --git a/examples/account-abstraction/web3auth/README.md b/examples/account-abstraction/web3auth/README.md
@@ -0,0 +1,45 @@
+## Local development
+
+### Installing the project
+
+1. Install [pnpm](https://pnpm.io/installation)
+2. Run `pnpm install`
+
+### Connecting Metamask
+
+1. Go to [Conduit](https://app.conduit.xyz/published/view/fluffy-bob-7mjgi9pmtg)
+2. Click the 'Add to wallet button.'
+
+### Funding your account
+
+#### Native token
+
+1. Create a new account in your wallet
+2. From the L2 Faucet section in [Conduit](https://app.conduit.xyz/published/view/fluffy-bob-7mjgi9pmtg), enter your address and click the 'Claim' button.
+
+Note: we have seen instances of this failing. If this happens, the api can be called from a terminal:
+`curl -XPOST -i https://faucetl2-fluffy-bob-7mjgi9pmtg.t.conduit.xyz/drip/0x4062e44077b1e58C3D630a0e4e632fF81868e448`
+
+#### Other supported tokens
+
+1. This can be done either by using the faucet button in the UI or by interacting with the smart contract in [Conduit](https://explorerl2-fluffy-bob-7mjgi9pmtg.t.conduit.xyz/address/[address])
+
+### Starting the project
+
+1. Run `pnpm dev`
+
+### Browser support
+
+This application is tested using:
+
+- Chrome
+- Brave
+- Firefox
+
+In the following environments:
+
+- Linux
+- MacOS
+- Windows
+
+It does not currently support any mobile wallets.
diff --git a/examples/account-abstraction/web3auth/index.html b/examples/account-abstraction/web3auth/index.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <!-- TODO: Use local image rather than pulling in from website -->
+    <link
+      href="https://uploads-ssl.webflow.com/64e85c2f3609488b3ed725f4/64ecae53ef4b561482f1c49f_bob1.jpg"
+      rel="shortcut icon"
+      type="image/x-icon"
+    />
+    <link
+      href="https://uploads-ssl.webflow.com/64e85c2f3609488b3ed725f4/64ecae715f5d3632aa4b6905_bob256.jpg"
+      rel="apple-touch-icon"
+    />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>BOB: Peer to Peer Swap</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/examples/account-abstraction/web3auth/package.json b/examples/account-abstraction/web3auth/package.json
@@ -0,0 +1,54 @@
+{
+  "name": "bob-ui-poc",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview",
+    "format:check": "prettier --check src/** --cache",
+    "format:write": "prettier --write src/** --cache"
+  },
+  "dependencies": {
+    "@gobob/bob-sdk": "^1.0.3",
+    "@interlay/hooks": "^0.0.7",
+    "@interlay/system": "^0.0.1",
+    "@interlay/theme": "^0.0.6",
+    "@interlay/ui": "0.0.6",
+    "@metamask/providers": "^12.0.0",
+    "@react-aria/utils": "^3.21.0",
+    "@tanstack/react-query": "^4.36.1",
+    "@wagmi/core": "^1.4.5",
+    "@web3auth/base": "^7.0.4",
+    "@web3auth/ethereum-provider": "^7.0.4",
+    "@web3auth/modal": "^7.0.5",
+    "@web3auth/openlogin-adapter": "^7.0.4",
+    "@web3modal/wagmi": "^3.1.0",
+    "big.js": "^6.2.1",
+    "hardhat": "^2.18.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-jazzicon": "^1.0.4",
+    "styled-components": "^6.0.8",
+    "truncate-eth-address": "^1.0.2",
+    "viem": "^1.10.9",
+    "vite-plugin-node-polyfills": "^0.15.0",
+    "wagmi": "^1.4.1"
+  },
+  "devDependencies": {
+    "@typechain/ethers-v6": "^0.5.0",
+    "@types/big.js": "^6.2.0",
+    "@types/react": "^18.2.15",
+    "@types/react-dom": "^18.2.7",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "@vitejs/plugin-react": "^4.0.3",
+    "eslint": "^8.45.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.3",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.5"
+  }
+}