feat: use-wallet-vue

TxnLab · Dec 24, 2023 · 21b87fc · 21b87fc
1 parent d8ebcc5
commit 21b87fc
Show file tree

Hide file tree

Showing 31 changed files with 780 additions and 17 deletions.
diff --git a/examples/vue-ts/.eslintignore b/examples/vue-ts/.eslintignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+.env
diff --git a/examples/vue-ts/.gitignore b/examples/vue-ts/.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/examples/vue-ts/.prettierignore b/examples/vue-ts/.prettierignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+.env
diff --git a/examples/vue-ts/.vscode/extensions.json b/examples/vue-ts/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
+}
diff --git a/examples/vue-ts/README.md b/examples/vue-ts/README.md
@@ -0,0 +1,18 @@
+# @txnlab/use-wallet-vue example
+
+This example provides a minimal setup to get [@txnlab/use-wallet-vue](https://github.com/TxnLab/use-wallet-js/tree/main/packages/use-wallet-vue) working in a Vite Vue app with TypeScript. The example uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+
+## Recommended IDE Setup
+
+- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support For `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
diff --git a/examples/vue-ts/index.html b/examples/vue-ts/index.html
@@ -0,0 +1,16 @@
+<!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>use-wallet | Vite + Vue + TS</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      global = globalThis
+    </script>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/examples/vue-ts/package.json b/examples/vue-ts/package.json
@@ -0,0 +1,28 @@
+{
+  "name": "use-wallet-example-vue",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "preview": "vite preview",
+    "build": "vue-tsc && vite build",
+    "lint": "eslint -c '../../.eslintrc.json' '**/*.{js,ts}'",
+    "prettier": "prettier --check '**/*.{js,ts}'",
+    "typecheck": "vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@blockshake/defly-connect": "^1.1.6",
+    "@perawallet/connect": "^1.3.3",
+    "@txnlab/use-wallet-js": "workspace:*",
+    "@txnlab/use-wallet-vue": "workspace:*",
+    "@walletconnect/modal": "^2.6.2",
+    "@walletconnect/sign-client": "^2.10.2",
+    "algosdk": "^2.6.0",
+    "vue": "^3.3.11"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^4.5.2",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8",
+    "vue-tsc": "^1.8.25"
+  }
+}
diff --git a/examples/vue-ts/public/vite.svg b/examples/vue-ts/public/vite.svg
diff --git a/examples/vue-ts/src/App.vue b/examples/vue-ts/src/App.vue
@@ -0,0 +1,31 @@
+<script setup lang="ts">
+import Connect from './components/Connect.vue'
+</script>
+
+<template>
+  <div>
+    <a href="https://vitejs.dev" target="_blank">
+      <img src="/vite.svg" class="logo" alt="Vite logo" />
+    </a>
+    <a href="https://vuejs.org/" target="_blank">
+      <img src="./assets/vue.svg" class="logo vue" alt="Vue logo" />
+    </a>
+  </div>
+  <h1>@txnlab/use-wallet-vue</h1>
+  <Connect />
+</template>
+
+<style scoped>
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.vue:hover {
+  filter: drop-shadow(0 0 2em #42b883aa);
+}
+</style>
diff --git a/examples/vue-ts/src/assets/vue.svg b/examples/vue-ts/src/assets/vue.svg
diff --git a/examples/vue-ts/src/components/Connect.vue b/examples/vue-ts/src/components/Connect.vue
@@ -0,0 +1,44 @@
+<script setup lang="ts">
+import { useWallet } from '@txnlab/use-wallet-vue'
+
+const { wallets } = useWallet()
+</script>
+
+<template>
+  <div>
+    <div v-for="wallet in wallets" :key="wallet.id">
+      <h4>{{ wallet.metadata.name }} <span v-if="wallet.isActive">[active]</span></h4>
+      <div class="wallet-buttons">
+        <button @click="wallet.connect()" :disabled="wallet.isConnected">Connect</button>
+        <button @click="wallet.disconnect()" :disabled="!wallet.isConnected">Disconnect</button>
+        <button @click="wallet.setActive()" :disabled="!wallet.isConnected || wallet.isActive">
+          Set Active
+        </button>
+      </div>
+      <div v-if="wallet.isActive && wallet.accounts.length > 0">
+        <select
+          @change="(event) => wallet.setActiveAccount((event.target as HTMLSelectElement).value)"
+        >
+          <option
+            v-for="account in wallet.accounts"
+            :key="account.address"
+            :value="account.address"
+          >
+            {{ account.address }}
+          </option>
+        </select>
+      </div>
+    </div>
+  </div>
+</template>
+
+<style scoped>
+.wallet-buttons {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  gap: 0.5em;
+  margin-bottom: 2em;
+}
+</style>
diff --git a/examples/vue-ts/src/main.ts b/examples/vue-ts/src/main.ts
@@ -0,0 +1,23 @@
+import { NetworkId, WalletId } from '@txnlab/use-wallet-js'
+import { WalletManagerPlugin } from '@txnlab/use-wallet-vue'
+import { createApp } from 'vue'
+import './style.css'
+import App from './App.vue'
+
+const app = createApp(App)
+
+app.use(WalletManagerPlugin, {
+  wallets: [
+    WalletId.DEFLY,
+    WalletId.EXODUS,
+    WalletId.PERA,
+    {
+      id: WalletId.WALLETCONNECT,
+      options: { projectId: 'fcfde0713d43baa0d23be0773c80a72b' }
+    },
+    WalletId.KMD
+  ],
+  network: NetworkId.TESTNET
+})
+
+app.mount('#app')
diff --git a/examples/vue-ts/src/style.css b/examples/vue-ts/src/style.css
@@ -0,0 +1,79 @@
+: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;
+}
+
+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:not(:disabled):hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+button:disabled {
+  opacity: 0.75;
+  cursor: default;
+}
+
+#app {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
diff --git a/examples/vue-ts/src/vite-env.d.ts b/examples/vue-ts/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/examples/vue-ts/tsconfig.json b/examples/vue-ts/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "preserve",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/examples/vue-ts/tsconfig.node.json b/examples/vue-ts/tsconfig.node.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/examples/vue-ts/vite.config.ts b/examples/vue-ts/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [vue()]
+})
diff --git a/package.json b/package.json
@@ -18,8 +18,10 @@
   "workspaces": [
     "packages/use-wallet-js",
     "packages/use-wallet-react",
+    "packages/use-wallet-vue",
     "examples/use-wallet-example-vanilla-ts",
-    "examples/use-wallet-example-react"
+    "examples/use-wallet-example-react",
+    "examples/use-wallet-example-vue"
   ],
   "scripts": {
     "build": "pnpm -r build",

diff --git a/packages/use-wallet-js/src/index.ts b/packages/use-wallet-js/src/index.ts
@@ -1,3 +1,3 @@
-export { BaseWallet, WalletId, WalletManager } from './wallets'
+export { BaseWallet, WalletId, WalletManager, WalletManagerConfig } from './wallets'
 export { State, defaultState } from './store'
 export { NetworkId } from './network'
diff --git a/packages/use-wallet-js/src/wallets/manager.ts b/packages/use-wallet-js/src/wallets/manager.ts
@@ -21,7 +21,7 @@ import type {
   WalletOptions
 } from './types'
 
-interface WalletManagerConfig {
+export interface WalletManagerConfig {
   wallets: SupportedWallets
   network?: NetworkId
   algod?: NetworkConfig

diff --git a/packages/use-wallet-react/src/useWallet.ts b/packages/use-wallet-react/src/useWallet.ts
@@ -16,13 +16,12 @@ export function useWallet() {
   const activeWalletAddresses = manager.activeWalletAddresses
   const activeAccount = manager.activeAccount
   const activeAddress = manager.activeAddress
-
   const setActiveNetwork = manager.setActiveNetwork
 
   const signTransactions = (
     txnGroup: algosdk.Transaction[] | algosdk.Transaction[][] | Uint8Array[] | Uint8Array[][],
-    indexesToSign?: number[] | undefined,
-    returnGroup?: boolean | undefined
+    indexesToSign?: number[],
+    returnGroup?: boolean
   ) => {
     if (!activeWallet) {
       throw new Error('No active wallet')

diff --git a/packages/use-wallet-vue/.eslintignore b/packages/use-wallet-vue/.eslintignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+.env
diff --git a/packages/use-wallet-vue/.prettierignore b/packages/use-wallet-vue/.prettierignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+.env
diff --git a/packages/use-wallet-vue/README.md b/packages/use-wallet-vue/README.md
@@ -0,0 +1,7 @@
+# @txnlab/use-wallet-vue
+
+Vue wrapper for [@txnlab/use-wallet-js](https://github.com/TxnLab/use-wallet-js/tree/main/packages/use-wallet-js)
+
+## License
+
+MIT ©2023 [TxnLab, Inc.](https://txnlab.dev)