@injectivelabs/wallet-turnkey 1.15.10

package/dist/esm/strategy/turnkey/turnkey.js

@@ -0,0 +1,192 @@
+import { Turnkey, SessionType } from '@turnkey/sdk-browser';
+import { ErrorType, WalletException, GeneralException, UnspecifiedErrorCode, } from '@injectivelabs/exceptions';
+import { WalletAction } from '@injectivelabs/wallet-base';
+import { getInjectiveAddress } from '@injectivelabs/sdk-ts';
+import { HttpRestClient } from '@injectivelabs/utils';
+import { createAccount } from '@turnkey/viem';
+import { TurnkeyErrorCodes } from '../types.js';
+export class TurnkeyWallet {
+    iframeClient;
+    turnkey;
+    client;
+    metadata;
+    accountMap = {};
+    setMetadata(metadata) {
+        this.metadata = { ...this.metadata, ...metadata };
+    }
+    constructor(metadata) {
+        this.metadata = metadata;
+        this.client = new HttpRestClient(metadata.apiServerEndpoint);
+    }
+    static async getTurnkeyInstance(metadata) {
+        const { turnkey, iframeClient } = await createTurnkeyIFrame(metadata);
+        return {
+            turnkey,
+            iframeClient,
+        };
+    }
+    async getTurnkey() {
+        if (!this.iframeClient) {
+            await this.initFrame();
+        }
+        if (!this.turnkey) {
+            this.turnkey = new Turnkey(this.metadata);
+        }
+        return this.turnkey;
+    }
+    async getIframeClient() {
+        if (!this.iframeClient) {
+            await this.initFrame();
+        }
+        if (!this.iframeClient) {
+            throw new WalletException(new Error('Iframe client not initialized'));
+        }
+        return this.iframeClient;
+    }
+    async getSession(existingCredentialBundle) {
+        const { metadata } = this;
+        const iframeClient = await this.getIframeClient();
+        const turnkey = await this.getTurnkey();
+        const currentSession = await turnkey.getSession();
+        const organizationId = currentSession?.organizationId || metadata.defaultOrganizationId;
+        const credentialBundle = existingCredentialBundle || currentSession?.token;
+        if (!credentialBundle) {
+            return {
+                session: undefined,
+                organizationId,
+            };
+        }
+        try {
+            const loginResult = await iframeClient.injectCredentialBundle(credentialBundle);
+            // If there is no session, we want to force a refresh to enable to browser SDK to handle key storage and proper session management.
+            await iframeClient.refreshSession({
+                sessionType: SessionType.READ_WRITE,
+                targetPublicKey: iframeClient.iframePublicKey,
+                expirationSeconds: '900',
+            });
+            const [session, user] = await Promise.all([
+                turnkey.getSession(),
+                iframeClient.getWhoami(),
+            ]);
+            const actualOrganizationId = user?.organizationId || session?.organizationId || organizationId;
+            if (!loginResult) {
+                return {
+                    session: undefined,
+                    organizationId: actualOrganizationId,
+                };
+            }
+            return {
+                session,
+                organizationId: actualOrganizationId,
+            };
+        }
+        catch (e) {
+            throw new WalletException(new Error(e.message), {
+                code: UnspecifiedErrorCode,
+                type: ErrorType.WalletError,
+                contextModule: 'turnkey-wallet-get-session',
+            });
+        }
+    }
+    async getAccounts() {
+        const iframeClient = await this.getIframeClient();
+        if (!this.metadata.organizationId) {
+            return [];
+        }
+        try {
+            const response = await iframeClient.getWallets({
+                organizationId: this.metadata.organizationId,
+            });
+            const accounts = await Promise.allSettled(response.wallets.map((wallet) => iframeClient.getWalletAccounts({
+                walletId: wallet.walletId,
+                organizationId: this.metadata.organizationId,
+            })));
+            const filteredAccounts = accounts
+                .filter((account) => account.status === 'fulfilled')
+                .flatMap((result) => result.value?.accounts)
+                .filter((wa) => !!wa &&
+                wa.addressFormat === 'ADDRESS_FORMAT_ETHEREUM' &&
+                !!wa.address);
+            return filteredAccounts.map((account) => getInjectiveAddress(account.address));
+        }
+        catch (e) {
+            if (e.code === TurnkeyErrorCodes.UserLoggedOut) {
+                throw new WalletException(new Error('User is not logged in'), {
+                    code: UnspecifiedErrorCode,
+                    type: ErrorType.WalletError,
+                    contextModule: WalletAction.GetAccounts,
+                    contextCode: TurnkeyErrorCodes.UserLoggedOut,
+                });
+            }
+            throw new WalletException(new Error(e.message), {
+                code: UnspecifiedErrorCode,
+                type: ErrorType.WalletError,
+                contextModule: 'turnkey-wallet-get-accounts',
+            });
+        }
+    }
+    async getOrCreateAndGetAccount(address, organizationId) {
+        const { accountMap } = this;
+        const iframeClient = await this.getIframeClient();
+        if (accountMap[address] || accountMap[address.toLowerCase()]) {
+            return accountMap[address] || accountMap[address.toLowerCase()];
+        }
+        if (!organizationId) {
+            throw new WalletException(new Error('Organization ID is required'));
+        }
+        iframeClient.config.organizationId = organizationId;
+        if (!address) {
+            throw new WalletException(new Error('Account address not found'));
+        }
+        const turnkeyAccount = await createAccount({
+            organizationId,
+            signWith: address,
+            client: iframeClient,
+        });
+        this.accountMap[address] = turnkeyAccount;
+        return turnkeyAccount;
+    }
+    async injectAndRefresh(credentialBundle) {
+        const iframeClient = await this.getIframeClient();
+        await iframeClient.injectCredentialBundle(credentialBundle);
+        await iframeClient.refreshSession({
+            sessionType: SessionType.READ_WRITE,
+            targetPublicKey: iframeClient.iframePublicKey,
+            expirationSeconds: '900',
+        });
+        return;
+    }
+    async initFrame() {
+        const { metadata } = this;
+        const { turnkey, iframeClient } = await createTurnkeyIFrame(metadata);
+        this.turnkey = turnkey;
+        this.iframeClient = iframeClient;
+    }
+}
+async function createTurnkeyIFrame(metadata) {
+    const turnkey = new Turnkey(metadata);
+    const turnkeyAuthIframeElementId = metadata.iframeElementId || 'turnkey-auth-iframe-element-id';
+    if (!metadata.iframeContainerId) {
+        throw new GeneralException(new Error('iframeContainerId is required'));
+    }
+    if (!turnkey) {
+        throw new GeneralException(new Error('Turnkey is not initialized'));
+    }
+    const iframe = document.getElementById(metadata.iframeContainerId);
+    if (!iframe) {
+        throw new GeneralException(new Error('iframe is null'));
+    }
+    const existingIframeClient = document.getElementById(turnkeyAuthIframeElementId);
+    if (existingIframeClient) {
+        existingIframeClient.remove();
+    }
+    const iframeClient = await turnkey.iframeClient({
+        iframeContainer: iframe,
+        iframeElementId: turnkeyAuthIframeElementId,
+        iframeUrl: metadata?.iframeUrl || 'https://auth.turnkey.com',
+    });
+    return {
+        turnkey,
+        iframeClient,
+    };
+}

package/dist/esm/strategy/types.d.ts

@@ -0,0 +1,26 @@
+export declare enum TurnkeyErrorCodes {
+    UserLoggedOut = 7
+}
+export type TurnkeyOAuthArgs = {
+    provider: 'google';
+    oidcToken: string;
+    oauthLoginEndpoint: string;
+};
+export type TurnkeyEmailArgs = {
+    provider: 'email';
+    email: string;
+    initEmailOTPEndpoint: string;
+};
+export type TurnkeyEnableArgs = TurnkeyOAuthArgs | TurnkeyEmailArgs;
+export type TurnkeyOTPCredentialsResponse = {
+    otpId: string;
+    organizationId: string;
+};
+export type TurnkeyConfirmEmailOTPResponse = {
+    credentialBundle: string;
+};
+export type TurnkeyOauthLoginResponse = {
+    organizationId: string;
+    credentialBundle: string;
+    message: string;
+};

package/dist/esm/strategy/types.js

@@ -0,0 +1,4 @@
+export var TurnkeyErrorCodes;
+(function (TurnkeyErrorCodes) {
+    TurnkeyErrorCodes[TurnkeyErrorCodes["UserLoggedOut"] = 7] = "UserLoggedOut";
+})(TurnkeyErrorCodes || (TurnkeyErrorCodes = {}));

package/dist/esm/utils.d.ts

@@ -0,0 +1,7 @@
+export declare function generateGoogleUrl({ nonce, clientId, redirectUri, scope, prompt, }: {
+    nonce: string;
+    clientId: string;
+    redirectUri: string;
+    scope?: string;
+    prompt?: string;
+}): string;

package/dist/esm/utils.js

@@ -0,0 +1,7 @@
+export function generateGoogleUrl({ nonce, clientId, redirectUri, scope = 'openid profile email', prompt = 'consent', }) {
+    if (!clientId) {
+        throw new Error('Google client ID not found');
+    }
+    const responseType = 'id_token';
+    return `https://accounts.google.com/o/oauth2/v2/auth?prompt=${prompt}&client_id=${clientId}&redirect_uri=${redirectUri}&response_type=${responseType}&scope=${scope}&nonce=${nonce}`;
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@injectivelabs/wallet-turnkey",
+  "description": "Turnkey wallet strategy for use with @injectivelabs/wallet-core.",
+  "version": "1.15.10",
+  "sideEffects": false,
+  "type": "module",
+  "author": {
+    "name": "InjectiveLabs",
+    "email": "admin@injectivelabs.org"
+  },
+  "license": "Apache-2.0",
+  "types": "dist/cjs/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
+  "_moduleAliases": {
+    "~wallet-turnkey": "dist"
+  },
+  "exports": {
+    ".": {
+      "react-native": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js",
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "yarn build:esm && yarn build:cjs && yarn build:post",
+    "build:cjs": "tsc --build --force tsconfig.build.json",
+    "build:esm": "tsc --build --force tsconfig.build.esm.json",
+    "build:watch": "tsc --build -w tsconfig.build.json && tsc -w --build tsconfig.build.esm.json && yarn build:post",
+    "build:post": "shx cp ../../../etc/stub/package.json.stub dist/cjs/package.json && shx cp ../../../etc/stub/package.esm.json.stub dist/esm/package.json",
+    "clean": "tsc --build tsconfig.build.json --clean && tsc --build tsconfig.build.esm.json --clean && shx rm -rf coverage *.log junit.xml dist && jest --clearCache && shx mkdir -p dist",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:ci": "jest --coverage --ci --reporters='jest-junit'",
+    "coverage": "jest --coverage",
+    "coverage:show": "live-server coverage",
+    "dev": "ts-node -r tsconfig-paths/register src/index.ts",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@injectivelabs/exceptions": "^1.15.7",
+    "@injectivelabs/sdk-ts": "^1.15.10",
+    "@injectivelabs/ts-types": "^1.15.8",
+    "@injectivelabs/utils": "^1.15.8",
+    "@injectivelabs/wallet-base": "^1.15.10",
+    "@turnkey/sdk-browser": "^4.1.0",
+    "@turnkey/viem": "^0.9.0",
+    "viem": "^2.28.1"
+  },
+  "devDependencies": {
+    "jest": "^29.0.0",
+    "live-server": "^1.2.1",
+    "shx": "^0.3.4",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.0.0"
+  },
+  "gitHead": "6442ae377bbfb3459d2fb3a44c650630a5b7f445"
+}