Merge pull request #358 from Web3Auth/feat/external-wallets-auth

authenticate user function added to return id token

Author: chaitanyapotti

demo/vue-app/package-lock.json

@@ -14,22 +14,24 @@
     "@solana/web3.js": "^1.50.1",
     "@toruslabs/openlogin-ed25519": "^2.0.0",
     "@walletconnect/qrcode-modal": "~1.7.8",
-    "@web3auth/base": "^1.1.2",
-    "@web3auth/core": "^1.1.2",
-    "@web3auth/torus-wallet-connector-plugin": "^1.1.2",
+    "@web3auth/base": "file:../../packages/base",
+    "@web3auth/base-solana-adapter": "file:../../packages/base-solana-adapter",
+    "@web3auth/base-evm-adapter": "file:../../packages/base-evm-adapter",
+    "@web3auth/coinbase-adapter": "^1.1.2",
+    "@web3auth/core":  "file:../../packages/core",
+    "@web3auth/metamask-adapter": "file:../../packages/adapters/metamask-adapter",
+    "@web3auth/openlogin-adapter": "file:../../packages/adapters/openlogin-adapter",
+    "@web3auth/phantom-adapter": "file:../../packages/adapters/phantom-adapter",
+    "@web3auth/slope-adapter":  "file:../../packages/adapters/slope-adapter",
+    "@web3auth/solana-provider": "file:../../packages/providers/solana-provider",
     "@web3auth/solana-wallet-connector-plugin": "^1.1.2",
-    "@web3auth/metamask-adapter": "^1.1.2",
-    "@web3auth/openlogin-adapter": "^1.1.2",
-    "@web3auth/phantom-adapter": "^1.1.2",
-    "@web3auth/slope-adapter": "^1.1.2",
     "@web3auth/solflare-adapter": "^1.1.2",
-    "@web3auth/solana-provider": "^1.1.2",
-    "@web3auth/sollet-adapter": "^1.1.2",
-    "@web3auth/torus-evm-adapter": "^1.1.2",
-    "@web3auth/torus-solana-adapter": "^1.1.2",
-    "@web3auth/coinbase-adapter": "^1.1.2",
-    "@web3auth/wallet-connect-v1-adapter": "^1.1.2",
-    "@web3auth/web3auth": "^1.1.2",
+    "@web3auth/sollet-adapter":"file:../../packages/adapters/sollet-adapter",
+    "@web3auth/torus-evm-adapter": "^1.1.4",
+    "@web3auth/torus-solana-adapter": "file:../../packages/adapters/torus-solana-adapter",
+    "@web3auth/torus-wallet-connector-plugin": "^1.1.2",
+    "@web3auth/wallet-connect-v1-adapter": "^1.1.4",
+    "@web3auth/web3auth":  "file:../../packages/modal",
     "lodash.merge": "^4.6.2",
     "ts-custom-error": "^3.2.0",
     "vue": "^2.6.14",

demo/vue-app/package.json

@@ -11,6 +11,7 @@
       <button class="rpcBtn" v-if="!provider" @click="connect" style="cursor: pointer">Connect</button>
       <button class="rpcBtn" v-if="provider" @click="logout" style="cursor: pointer">Logout</button>
       <button class="rpcBtn" v-if="provider" @click="getUserInfo" style="cursor: pointer">Get User Info</button>
+      <button class="rpcBtn" v-if="provider" @click="authenticateUser" style="cursor: pointer">Get Auth Id token</button>
       <EthRpc :connectedAdapter="web3auth.connectedAdapterName" v-if="provider" :provider="provider" :console="console"></EthRpc>
       <span>{{ connecting }}</span>
 
@@ -205,6 +206,10 @@ export default Vue.extend({
       const userInfo = await this.web3auth.getUserInfo();
       this.console(userInfo);
     },
+    async authenticateUser() {
+      const idTokenDetails = await this.web3auth.authenticateUser();
+      this.console(idTokenDetails);
+    },
     console(...args: unknown[]): void {
       const el = document.querySelector("#console>p");
       if (el) {

demo/vue-app/src/chains/ethereum.vue

@@ -10,6 +10,7 @@
       <button class="rpcBtn" v-if="!provider" @click="connect" style="cursor: pointer">Connect</button>
       <button class="rpcBtn" v-if="provider" @click="logout" style="cursor: pointer">Logout</button>
       <button class="rpcBtn" v-if="provider" @click="getUserInfo" style="cursor: pointer">Get User Info</button>
+      <button class="rpcBtn" v-if="provider" @click="authenticateUser" style="cursor: pointer">Get Auth Id token</button>
       <SolanaRpc v-if="provider" :provider="provider" :console="console"></SolanaRpc>
       <!-- <button @click="showError" style="cursor: pointer">Show Error</button> -->
     </section>
@@ -212,6 +213,10 @@ export default Vue.extend({
       const userInfo = await this.web3auth.getUserInfo();
       this.console(userInfo);
     },
+    async authenticateUser() {
+      const idTokenDetails = await this.web3auth.authenticateUser();
+      this.console(idTokenDetails);
+    },
     console(...args: unknown[]): void {
       const el = document.querySelector("#console>p");
       if (el) {

demo/vue-app/src/chains/solana.vue

@@ -67,7 +67,7 @@ export const signEthMessage = async (provider: SafeEventEmitterProvider, uiConso
   }
 };
 
-export const getAccounts = async (provider: SafeEventEmitterProvider, uiConsole: any): Promise<string[]> => {
+export const getAccounts = async (provider: SafeEventEmitterProvider, uiConsole: any): Promise<string[] | undefined> => {
   try {
     const web3 = new Web3(provider as any);
     const accounts = await web3.eth.getAccounts();
@@ -78,7 +78,7 @@ export const getAccounts = async (provider: SafeEventEmitterProvider, uiConsole:
     uiConsole("error", error);
   }
 };
-export const getChainId = async (provider: SafeEventEmitterProvider, uiConsole: any): Promise<string> => {
+export const getChainId = async (provider: SafeEventEmitterProvider, uiConsole: any): Promise<string | undefined> => {
   try {
     const web3 = new Web3(provider as any);
     const chainId = await web3.eth.getChainId();

demo/vue-app/src/lib/eth.ts

@@ -18,7 +18,7 @@ function getNewTx(publicKeys, blockhash) {
   return new Transaction({ recentBlockhash: blockhash, feePayer: new PublicKey(publicKeys![0]) }).add(inst);
 }
 
-export const getAccounts = async (provider: SafeEventEmitterProvider, uiConsole: any): Promise<string[]> => {
+export const getAccounts = async (provider: SafeEventEmitterProvider, uiConsole: any): Promise<string[] | undefined> => {
   try {
     const solWeb3 = new SolanaWallet(provider);
     const acc = await solWeb3.requestAccounts();

demo/vue-app/src/lib/sol.ts

@@ -82,4 +82,4 @@
   "resolutions": {
     "@typescript-eslint/eslint-plugin": "^5.32.0"
   }
-}
+}

package.json

@@ -0,0 +1 @@
+*.d.ts

packages/adapters/base-evm-adapter /.gitignore

@@ -0,0 +1,39 @@
+# Web3Auth Base Evm Adapter (Basic Types and Interface for Web3Auth)
+
+[![npm version](https://img.shields.io/npm/v/@web3auth/base-evm-adapter?label=%22%22)](https://www.npmjs.com/package/@web3auth/base-evm-adapter/v/latest)
+[![minzip](https://img.shields.io/bundlephobia/minzip/@web3auth/base?label=%22%22)](https://bundlephobia.com/result?p=@web3auth/base-evm-adapter@latest)
+
+> Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.
+
+Web3Auth Base Evm Adapter contains a base class for EVM adapters.
+
+## 📖 Documentation
+
+Read more about the Web3Auth in the [official Web3Auth Documentation](https://web3auth.io/docs/sdk/web/).
+
+## 🔗 Installation
+
+```shell
+npm install --save @web3auth/base-evm-adapter
+```
+
+## 🩹 Example
+
+```ts
+import { BaseEvmAdapter } from "@web3auth/base-evm-adapter";
+
+
+export class EvmAdapter extends BaseEvmAdapter<void> {
+}
+```
+
+Checkout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/examples/)
+
+## 🌐 Demo
+Check out the [Web3Auth](https://demo-app.web3auth.io/) Demo](https://demo-app.web3auth.io/) to see how Web3Auth can be used in your application.
+
+## 💬 Troubleshooting and Discussions
+
+- Have a look at our [GitHub Discussions](https://github.com/Web3Auth/Web3Auth/discussions?discussions_q=sort%3Atop) to see if anyone has any questions or issues you might be having.
+- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions
+- Join our [Discord](https://discord.gg/web3auth) to join our community and get private integration support or help with your integration.

packages/adapters/base-evm-adapter /README.md

@@ -0,0 +1,48 @@
+{
+  "name": "@web3auth/base-evm-adapter",
+  "version": "1.1.4",
+  "homepage": "https://github.com/Web3Auth/Web3Auth#readme",
+  "license": "ISC",
+  "main": "dist/baseEvmAdapter.cjs.js",
+  "module": "dist/baseEvmAdapter.esm.js",
+  "unpkg": "dist/baseEvmAdapter.umd.min.js",
+  "jsdelivr": "dist/baseEvmAdapter.umd.min.js",
+  "types": "dist/types/index.d.ts",
+  "author": "Torus Labs",
+  "scripts": {
+    "test": "mocha --config ../../.mocharc.json test/**.ts",
+    "test-debugger": "mocha --config ../../.mocharc.json --inspect-brk test/**.ts",
+    "dev": "torus-scripts start",
+    "build": "torus-scripts build",
+    "lint": "eslint --fix 'src/**/*.ts'",
+    "prepack": "yarn run build",
+    "pre-commit": "lint-staged --cwd ."
+  },
+  "dependencies": {
+    "@web3auth/base": "^1.1.3"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "peerDependencies": {
+    "@babel/runtime": "^7.x"
+  },
+  "lint-staged": {
+    "!(*d).ts": [
+      "eslint --cache --fix",
+      "prettier --write"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Web3Auth/Web3Auth.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Web3Auth/Web3Auth/issues"
+  },
+  "keywords": [],
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/adapters/base-evm-adapter /package.json

@@ -0,0 +1,68 @@
+import {
+  ADAPTER_STATUS,
+  BaseAdapter,
+  checkIfTokenIsExpired,
+  clearToken,
+  getSavedToken,
+  saveToken,
+  signChallenge,
+  UserAuthInfo,
+  verifySignedChallenge,
+  WalletLoginError,
+} from "@web3auth/base";
+
+export abstract class BaseEvmAdapter<T> extends BaseAdapter<T> {
+  async authenticateUser(): Promise<UserAuthInfo> {
+    if (!this.provider || !this.chainConfig?.chainId) throw WalletLoginError.notConnectedError();
+
+    const { chainNamespace, chainId } = this.chainConfig;
+
+    if (this.status !== ADAPTER_STATUS.CONNECTED) throw WalletLoginError.notConnectedError("Not connected with wallet, Please login/connect first");
+    const accounts = await this.provider.request<string[]>({
+      method: "eth_accounts",
+    });
+    if (accounts && accounts.length > 0) {
+      const existingToken = getSavedToken(accounts[0] as string, this.name);
+      if (existingToken) {
+        const isExpired = checkIfTokenIsExpired(existingToken);
+        if (!isExpired) {
+          return { idToken: existingToken };
+        }
+      }
+
+      const payload = {
+        domain: window.location.origin,
+        uri: window.location.href,
+        address: accounts[0],
+        chainId: parseInt(chainId, 16),
+        version: "1",
+        nonce: Math.random().toString(36).slice(2),
+        issuedAt: new Date().toISOString(),
+      };
+
+      const challenge = await signChallenge(payload, chainNamespace);
+
+      const signedMessage = await this.provider.request<string>({
+        method: "personal_sign",
+        params: [challenge, accounts[0]],
+      });
+
+      const idToken = await verifySignedChallenge(chainNamespace, signedMessage as string, challenge, this.name, this.sessionTime);
+      saveToken(accounts[0] as string, this.name, idToken);
+      return {
+        idToken,
+      };
+    }
+    throw WalletLoginError.notConnectedError("Not connected with wallet, Please login/connect first");
+  }
+
+  async disconnect(): Promise<void> {
+    if (this.status !== ADAPTER_STATUS.CONNECTED) throw WalletLoginError.disconnectionError("Not connected with wallet");
+    const accounts = await this.provider.request<string[]>({
+      method: "eth_accounts",
+    });
+    if (accounts && accounts.length > 0) {
+      clearToken(accounts[0], this.name);
+    }
+  }
+}

packages/adapters/base-evm-adapter /src/baseEvmAdapter.ts

@@ -0,0 +1 @@
+export * from "./baseEvmAdapter";

packages/adapters/base-evm-adapter /src/index.ts

@@ -0,0 +1 @@
+module.exports = require("../../../torus.config");

packages/adapters/base-evm-adapter /torus.config.js

@@ -0,0 +1,3 @@
+{
+  "include": ["src"]
+}

packages/adapters/base-evm-adapter /tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": ["src","test"]
+}

packages/adapters/base-evm-adapter /tsconfig.json

@@ -0,0 +1,11 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const path = require("path");
+const generateWebpackConfig = require("../../../webpack.config");
+
+const pkg = require("./package.json");
+
+const currentPath = path.resolve(".");
+
+const config = generateWebpackConfig({ currentPath, pkg });
+
+module.exports = config;

packages/adapters/base-evm-adapter /webpack.config.js

@@ -0,0 +1 @@
+*.d.ts

packages/adapters/base-solana-adapter/.gitignore

@@ -0,0 +1,40 @@
+# Web3Auth Base solana Adapter (Basic Types and Interface for Web3Auth)
+
+[![npm version](https://img.shields.io/npm/v/@web3auth/base-solana-adapter?label=%22%22)](https://www.npmjs.com/package/@web3auth/base-solana-adapter/v/latest)
+[![minzip](https://img.shields.io/bundlephobia/minzip/@web3auth/base?label=%22%22)](https://bundlephobia.com/result?p=@web3auth/base-solana-adapter@latest)
+
+> Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.
+
+Web3Auth Base solana Adapter contains a base class for solana adapters.
+
+## 📖 Documentation
+
+Read more about the Web3Auth in the [official Web3Auth Documentation](https://web3auth.io/docs/sdk/web/).
+
+## 🔗 Installation
+
+```shell
+npm install --save @web3auth/base-solana-adapter
+```
+
+## 🩹 Example
+
+```ts
+import { BaseSolanaAdapter } from "@web3auth/base-solana-adapter";
+
+
+export class solanaAdapter extends BaseSolanaAdapter<void> {
+}
+```
+
+Checkout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/examples/)
+
+## 🌐 Demo
+
+Checkout the [Web3Auth Demo](https://demo-app.web3auth.io/) to see how Web3Auth can be used in your application.
+
+## 💬 Troubleshooting and Discussions
+
+- Have a look at our [GitHub Discussions](https://github.com/Web3Auth/Web3Auth/discussions?discussions_q=sort%3Atop) to see if anyone has any questions or issues you might be having.
+- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions
+- Join our [Discord](https://discord.gg/web3auth) to join our community and get private integration support or help with your integration.

packages/adapters/base-solana-adapter/README.md

@@ -0,0 +1,49 @@
+{
+  "name": "@web3auth/base-solana-adapter",
+  "version": "1.1.4",
+  "homepage": "https://github.com/Web3Auth/Web3Auth#readme",
+  "license": "ISC",
+  "main": "dist/baseSolanaAdapter.cjs.js",
+  "module": "dist/baseSolanaAdapter.esm.js",
+  "unpkg": "dist/baseSolanaAdapter.umd.min.js",
+  "jsdelivr": "dist/baseSolanaAdapter.umd.min.js",
+  "types": "dist/types/index.d.ts",
+  "author": "Torus Labs",
+  "scripts": {
+    "test": "mocha --config ../../.mocharc.json test/**.ts",
+    "test-debugger": "mocha --config ../../.mocharc.json --inspect-brk test/**.ts",
+    "dev": "torus-scripts start",
+    "build": "torus-scripts build",
+    "lint": "eslint --fix 'src/**/*.ts'",
+    "prepack": "yarn run build",
+    "pre-commit": "lint-staged --cwd ."
+  },
+  "dependencies": {
+    "@web3auth/base": "^1.1.3",
+    "bs58": "^5.0.0"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "peerDependencies": {
+    "@babel/runtime": "^7.x"
+  },
+  "lint-staged": {
+    "!(*d).ts": [
+      "eslint --cache --fix",
+      "prettier --write"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Web3Auth/Web3Auth.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Web3Auth/Web3Auth/issues"
+  },
+  "keywords": [],
+  "publishConfig": {
+    "access": "public"
+  }
+}