feat: add web3onboard example (#449)

MetaMask · Nov 2, 2023 · 0367eca · 0367eca
1 parent e32b7f0
commit 0367eca
Show file tree

Hide file tree

Showing 16 changed files with 6,413 additions and 0 deletions.
diff --git a/packages/examples/with-web3onboard/.eslintrc.cjs b/packages/examples/with-web3onboard/.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/packages/examples/with-web3onboard/.gitignore b/packages/examples/with-web3onboard/.gitignore
@@ -0,0 +1,24 @@
+# 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?
diff --git a/packages/examples/with-web3onboard/README.md b/packages/examples/with-web3onboard/README.md
@@ -0,0 +1,27 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+   parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+   },
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
diff --git a/packages/examples/with-web3onboard/index.html b/packages/examples/with-web3onboard/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/packages/examples/with-web3onboard/package.json b/packages/examples/with-web3onboard/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "with-web3onboard",
+  "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",
+    "allow-scripts": ""
+  },
+  "dependencies": {
+    "@web3-onboard/core": "^2.21.2",
+    "@web3-onboard/injected-wallets": "^2.10.8",
+    "@web3-onboard/metamask": "2.0.1-alpha.3",
+    "@web3-onboard/react": "^2.8.13",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@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.0.2",
+    "vite": "^4.4.5"
+  }
+}
diff --git a/packages/examples/with-web3onboard/public/vite.svg b/packages/examples/with-web3onboard/public/vite.svg
diff --git a/packages/examples/with-web3onboard/src/App.css b/packages/examples/with-web3onboard/src/App.css
@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
diff --git a/packages/examples/with-web3onboard/src/App.tsx b/packages/examples/with-web3onboard/src/App.tsx
@@ -0,0 +1,144 @@
+import metamaskSDK from '@web3-onboard/metamask';
+import { init, useConnectWallet } from '@web3-onboard/react';
+
+import './App.css';
+
+const chains = [
+  {
+    id: '0x1',
+    token: 'ETH',
+    label: 'Ethereum Mainnet',
+    rpcUrl: `https://rpc.ankr.com/eth`,
+  },
+  {
+    id: '0xa',
+    token: 'ETH',
+    label: 'Optimism',
+    rpcUrl: 'https://rpc.ankr.com/optimism',
+  },
+  {
+    id: '0x2105',
+    token: 'ETH',
+    label: 'Base',
+    rpcUrl: 'https://mainnet.base.org',
+  },
+  {
+    id: '0xa4b1',
+    token: 'ETH',
+    label: 'Arbitrum One',
+    rpcUrl: 'https://arb1.arbitrum.io/rpc',
+  },
+  {
+    id: '0xfa',
+    token: 'FTM',
+    label: 'Fantom',
+    rpcUrl: 'https://rpc.fantom.network',
+  },
+  {
+    id: '0x38',
+    token: 'BNB',
+    label: 'Binance Smart Chain',
+    rpcUrl: `https://bsc-dataseed.binance.org`,
+  },
+  {
+    id: '0x89',
+    token: 'MATIC',
+    label: 'Matic Mainnet',
+    rpcUrl: 'https://matic-mainnet.chainstacklabs.com',
+  },
+  {
+    id: '0xa86a',
+    token: 'AVAX',
+    label: 'Avalanche Mainnet',
+    rpcUrl: 'https://api.avax.network/ext/bc/C/rpc',
+  },
+  {
+    id: '0xa4ec',
+    token: 'CELO',
+    label: 'Celo Mainnet',
+    rpcUrl: 'https://rpc.ankr.com/celo',
+  },
+  {
+    id: '0x64',
+    token: 'XDAI',
+    label: 'Gnosis Chain',
+    rpcUrl: 'https://rpc.gnosischain.com/',
+  },
+  {
+    id: '0x44d',
+    token: 'ETH',
+    label: 'Polygon zkEVM',
+    rpcUrl: 'https://zkevm-rpc.com',
+  },
+  {
+    id: '0xe708',
+    token: 'ETH',
+    label: 'Linea',
+    rpcUrl: 'https://linea.drpc.org',
+  },
+  {
+    id: '0x1388',
+    token: 'MNT',
+    label: 'Mantle',
+    rpcUrl: 'https://rpc.mantle.xyz',
+  },
+];
+
+// initialize the module with options
+const metamaskSDKWallet = metamaskSDK({options: {
+  extensionOnly: false,
+  logging: {
+    developerMode: true,
+  },
+  dappMetadata: {
+    name: 'Demo Web3Onboard'
+  }
+}})
+
+init({
+  // ... other Onboard options
+  wallets: [
+    metamaskSDKWallet
+    //... other wallets
+  ],
+  chains
+});
+
+function App() {
+  const [{ wallet, connecting }, connect, disconnect] = useConnectWallet()
+
+  const handleTestSign = async () => {
+    console.log(`TODO: test sign`)
+    if(!wallet) {
+      console.error(`ethersProvider is undefined`)
+      return
+    }
+
+    try {
+      const result = await wallet.provider.request({method: 'personal_sign', params: ['hello world', wallet.accounts?.[0].address]})
+      console.log(`result: `, result)
+    } catch (error) {
+      console.error(`error: `, error)
+    }
+  }
+
+  return (
+    <>
+    <div>
+      accounts: {JSON.stringify(wallet?.accounts)}
+    </div>
+    <div>
+      chains: {JSON.stringify(wallet?.chains)}
+    </div>
+     <button
+        disabled={connecting}
+        onClick={() => (wallet ? disconnect(wallet) : connect())}
+      >
+        {connecting ? 'connecting' : wallet ? 'disconnect' : 'connect'}
+      </button>
+      <button  title='test sign' onClick={handleTestSign}>Test Sign</button>
+    </>
+  )
+}
+
+export default App
diff --git a/packages/examples/with-web3onboard/src/assets/react.svg b/packages/examples/with-web3onboard/src/assets/react.svg
diff --git a/packages/examples/with-web3onboard/src/index.css b/packages/examples/with-web3onboard/src/index.css
@@ -0,0 +1,69 @@
+:root {
+  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-text-size-adjust: 100%;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
diff --git a/packages/examples/with-web3onboard/src/main.tsx b/packages/examples/with-web3onboard/src/main.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import App from './App.tsx'
+import './index.css'
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+)
diff --git a/packages/examples/with-web3onboard/src/vite-env.d.ts b/packages/examples/with-web3onboard/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />