@keyringnetwork/keyring-connect-sdk 2.0.2 → 2.1.1

package/dist/constants/datasources.json

@@ -272,7 +272,7 @@
                 "label": "Profile information from Kraken"
             }
         ],
-        "target_url": null,
+        "target_url": "https://www.kraken.com/",
         "user_actions": [
             "Log in",
             "Navigate to your Profile page",
@@ -597,7 +597,8 @@
                     "headers": [
                         "Cookie",
                         "User-Agent",
-                        "x-device-id"
+                        "x-device-id",
+                        "x-client-version"
                     ],
                     "method": "GET",
                     "required_cookies": null,
@@ -607,7 +608,7 @@
                 "label": "User information from revolut"
             }
         ],
-        "target_url": "https://app.revolut.com/api/retail/user/current/wallet",
+        "target_url": null,
         "user_actions": [
             "Login",
             "Navigate to your profile page",
@@ -653,7 +654,7 @@
                 "label": "KYC from Keyring Connect"
             }
         ],
-        "target_url": null,
+        "target_url": "https://app.keyringdev.network/",
         "user_actions": [
             "Make sure you have logged in",
             "Navigate to the marketplace"

package/dist/constants/index.d.ts

@@ -0,0 +1 @@
+export declare const EXTENSION_TIMEOUT = 2000;

package/dist/constants/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXTENSION_TIMEOUT = void 0;
+exports.EXTENSION_TIMEOUT = 2000;

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { KeyringConnect } from './main';
-export * from './types';
+export { KeyringConnect } from "./main";
+export * from "./types";

package/dist/main.d.ts

@@ -5,18 +5,21 @@ import { ExtensionSDKConfig, ExtensionState } from "./types";
 export declare class KeyringConnect {
     private static keyringConnectUrl;
     /**
-     * Launch the Keyring Connect Extension with the provided configuration
-     * @note This will redirect to the Keyring Connect page if it is not installed
+     * Tries to launch the Keyring Connect Extension with the provided configuration.
+     * If the extension is not installed, it will redirect to the Keyring Connect page.
+     * @param data - The configuration for the extension
      */
     static launchExtension(data: ExtensionSDKConfig): Promise<void>;
     /**
      * Check if Keyring Connect Extension is installed and ready to use
+     * @returns Promise that resolves with true if extension is installed and ready to use, false otherwise
      */
     static isKeyringConnectInstalled(): Promise<boolean>;
     /**
-     * Get the current state of the Keyring Connect Extension to allow for UI updates
+     * Get the current state of the Keyring Connect Extension
+     * @returns Promise that resolves with extension state or null if unavailable
      */
-    static getExtensionState(): Promise<ExtensionState>;
+    static getExtensionState(): Promise<ExtensionState | null>;
     private static validateClientConfig;
     private static validateCredentialConfig;
     private static validateProofConfig;

package/dist/main.js

@@ -13,6 +13,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringConnect = void 0;
+const contracts_abi_1 = require("@keyringnetwork/contracts-abi");
+const constants_1 = require("./constants");
 const datasources_json_1 = __importDefault(require("./constants/datasources.json"));
 const types_1 = require("./types");
 /**
@@ -20,8 +22,9 @@ const types_1 = require("./types");
  */
 class KeyringConnect {
     /**
-     * Launch the Keyring Connect Extension with the provided configuration
-     * @note This will redirect to the Keyring Connect page if it is not installed
+     * Tries to launch the Keyring Connect Extension with the provided configuration.
+     * If the extension is not installed, it will redirect to the Keyring Connect page.
+     * @param data - The configuration for the extension
      */
     static launchExtension(data) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -45,15 +48,12 @@ class KeyringConnect {
     }
     /**
      * Check if Keyring Connect Extension is installed and ready to use
+     * @returns Promise that resolves with true if extension is installed and ready to use, false otherwise
      */
     static isKeyringConnectInstalled() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const timeout = new Promise((resolve) => {
-                    setTimeout(() => resolve(false), 2000);
-                });
-                const checkExtension = this.getExtensionState().then((state) => Boolean(state.manifest));
-                return Promise.race([timeout, checkExtension]);
+                return this.getExtensionState().then((state) => state ? Boolean(state.manifest) : false);
             }
             catch (error) {
                 return false;
@@ -61,11 +61,15 @@ class KeyringConnect {
         });
     }
     /**
-     * Get the current state of the Keyring Connect Extension to allow for UI updates
+     * Get the current state of the Keyring Connect Extension
+     * @returns Promise that resolves with extension state or null if unavailable
      */
     static getExtensionState() {
         return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve) => {
+            const timeout = new Promise((resolve) => {
+                setTimeout(() => resolve(null), constants_1.EXTENSION_TIMEOUT);
+            });
+            const extensionResponse = new Promise((resolve) => {
                 window.addEventListener("message", (event) => {
                     if (event.data.type === types_1.EVENT_ACTIONS.KEYRING_CONNECT_STATUS) {
                         resolve(event.data.data);
@@ -73,6 +77,7 @@ class KeyringConnect {
                 });
                 window.postMessage({ type: types_1.EVENT_ACTIONS.GET_STATUS }, "*");
             });
+            return Promise.race([timeout, extensionResponse]);
         });
     }
     static validateClientConfig(config) {
@@ -99,8 +104,7 @@ class KeyringConnect {
         if (!config.credential_config.wallet_address) {
             throw new Error("Wallet address is required");
         }
-        const validChainIds = Object.keys(types_1.CHAIN_IDS[types_1.CHAIN_FAMILY.EVM]).map((key) => types_1.CHAIN_IDS[types_1.CHAIN_FAMILY.EVM][key]);
-        if (!validChainIds.includes(config.credential_config.chain_id)) {
+        if (!(config.credential_config.chain_id in contracts_abi_1.SupportedChainIds)) {
             throw new Error("Invalid chain ID");
         }
         return config;

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { KrnSupportedChainId as SupportedChainId } from "@keyringnetwork/contracts-abi";
 export declare enum EVENT_ACTIONS {
     LAUNCH_KEYRING_CONNECT = "LAUNCH_KEYRING_CONNECT",
     GET_STATUS = "GET_STATUS",
@@ -23,7 +24,7 @@ export type ExtensionSDKConfig = {
      */
     logo_url: string;
     /**
-     * The policy ID of the client.
+     * The onchain policy ID of the client.
      */
     policy_id: number;
     /**
@@ -55,28 +56,6 @@ export type ExtensionSDKConfig = {
         websocketProxyUrl?: string;
     };
 };
-export declare enum CHAIN_FAMILY {
-    EVM = "EVM",
-    SOLANA = "SOLANA"
-}
-export declare const CHAIN_IDS: {
-    readonly EVM: {
-        readonly MAINNET: 1;
-        readonly OPTIMISM: 10;
-        readonly SEPOLIA: 11155111;
-        readonly ARBITRUM: 42161;
-        readonly BASE: 8453;
-        readonly ZKSYNC: 324;
-        readonly AVALANCHE: 43114;
-        readonly POLYGON: 137;
-        readonly HOLESKY: 17000;
-    };
-    readonly SOLANA: {
-        readonly MAINNET: 1915121141;
-    };
-};
-export type EVMChainId = (typeof CHAIN_IDS)[typeof CHAIN_FAMILY.EVM][keyof (typeof CHAIN_IDS)[typeof CHAIN_FAMILY.EVM]];
-export type SupportedChainId = EVMChainId;
 export type ExtensionLaunchConfig = {
     client: {
         client_name: string;

package/dist/types.js

@@ -1,31 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CHAIN_IDS = exports.CHAIN_FAMILY = exports.EVENT_ACTIONS = void 0;
+exports.EVENT_ACTIONS = void 0;
 var EVENT_ACTIONS;
 (function (EVENT_ACTIONS) {
     EVENT_ACTIONS["LAUNCH_KEYRING_CONNECT"] = "LAUNCH_KEYRING_CONNECT";
     EVENT_ACTIONS["GET_STATUS"] = "GET_STATUS";
     EVENT_ACTIONS["KEYRING_CONNECT_STATUS"] = "KEYRING_CONNECT_STATUS";
 })(EVENT_ACTIONS || (exports.EVENT_ACTIONS = EVENT_ACTIONS = {}));
-var CHAIN_FAMILY;
-(function (CHAIN_FAMILY) {
-    CHAIN_FAMILY["EVM"] = "EVM";
-    CHAIN_FAMILY["SOLANA"] = "SOLANA";
-})(CHAIN_FAMILY || (exports.CHAIN_FAMILY = CHAIN_FAMILY = {}));
-// Define chain IDs by family
-exports.CHAIN_IDS = {
-    [CHAIN_FAMILY.EVM]: {
-        MAINNET: 1,
-        OPTIMISM: 10,
-        SEPOLIA: 11155111,
-        ARBITRUM: 42161,
-        BASE: 8453,
-        ZKSYNC: 324,
-        AVALANCHE: 43114,
-        POLYGON: 137,
-        HOLESKY: 17000,
-    },
-    [CHAIN_FAMILY.SOLANA]: {
-        MAINNET: 1915121141,
-    },
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyringnetwork/keyring-connect-sdk",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "An SDK for interacting with Keyring Connect browser extension",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,9 +16,11 @@
   "keywords": [],
   "author": "",
   "license": "ISC",
+  "dependencies": {
+    "@keyringnetwork/contracts-abi": "2.2.0"
+  },
   "devDependencies": {
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
-  },
-  "dependencies": {}
+  }
 }