@keyringnetwork/keyring-connect-sdk 2.0.0 → 2.0.2

package/dist/main.d.ts

@@ -18,6 +18,7 @@ export declare class KeyringConnect {
      */
     static getExtensionState(): Promise<ExtensionState>;
     private static validateClientConfig;
+    private static validateCredentialConfig;
     private static validateProofConfig;
     private static validateDatasource;
     private static validateConfigData;

package/dist/main.js

@@ -89,6 +89,22 @@ class KeyringConnect {
             throw new Error("Policy ID is required");
         }
     }
+    static validateCredentialConfig(config) {
+        if (!config.credential_config) {
+            return config;
+        }
+        if (!config.credential_config.chain_id) {
+            throw new Error("Chain ID is required");
+        }
+        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)) {
+            throw new Error("Invalid chain ID");
+        }
+        return config;
+    }
     static validateProofConfig(config) {
         var _a;
         if ((_a = config.proof_config) === null || _a === void 0 ? void 0 : _a.datasource) {
@@ -121,6 +137,7 @@ class KeyringConnect {
         const validatedConfig = this.validateDatasource(config);
         this.validateClientConfig(validatedConfig);
         this.validateProofConfig(validatedConfig);
+        this.validateCredentialConfig(validatedConfig);
         return validatedConfig;
     }
     static convertToLaunchConfig(config) {
@@ -132,7 +149,8 @@ class KeyringConnect {
                 client_logo_url: config.logo_url,
                 client_policy_id: config.policy_id,
                 client_entity_id: (_a = config.krn_config) === null || _a === void 0 ? void 0 : _a.entity_id,
-                isolate_proving: config.isolate_proving,
+                isolate_proving: !!config.credential_config,
+                credential_config: config.credential_config,
             },
             krn_config: config.krn_config
                 ? {

package/dist/types.d.ts

@@ -27,9 +27,12 @@ export type ExtensionSDKConfig = {
      */
     policy_id: number;
     /**
-     * Whether to isolate the proving process. If true, will skip wallet interaction and on-chain credential creation
+     * If configured, will skip wallet interaction and on-chain credential creation and return calldata instead.
      */
-    isolate_proving?: boolean;
+    credential_config?: {
+        chain_id: SupportedChainId;
+        wallet_address: string;
+    };
     /**
      * Additional configuration to customize the extension's verification process.
      * @note should be used with caution as strict validation is applied to the proof config.
@@ -52,6 +55,28 @@ 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;
@@ -60,6 +85,10 @@ export type ExtensionLaunchConfig = {
         client_policy_id: number;
         client_entity_id?: string;
         isolate_proving?: boolean;
+        credential_config?: {
+            chain_id: SupportedChainId;
+            wallet_address: string;
+        };
     };
     proof_config?: {
         datasource?: DataSource;
@@ -76,7 +105,7 @@ export type ExtensionLaunchConfig = {
         access_token?: string;
     };
 };
-export type ExtensionStatus = "idle" | "mounted" | "proving" | "prove_success" | "error";
+export type ExtensionStatus = "idle" | "mounted" | "proving" | "prove_error" | "prove_success" | "error";
 export type AttestationStatus = "onboarding_required" | "onboarding_pending" | "attestation_ready" | "non_compliant";
 export type CredentialStatus = "expired" | "valid" | "none";
 export type User = {
@@ -107,6 +136,7 @@ export interface ExtensionState {
     error?: string;
     user?: User;
     tlsn_proof?: string;
+    credentialData?: CredentialData;
 }
 export interface DataSource {
     id: string;
@@ -149,3 +179,13 @@ export interface DisclosableField {
     path: string;
     key: string;
 }
+export interface CredentialData {
+    trader: `0x${string}`;
+    policyId: number;
+    chainId: number;
+    validUntil: number;
+    cost: number;
+    key: string;
+    signature: string;
+    backdoor: string;
+}

package/dist/types.js

@@ -1,9 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVENT_ACTIONS = void 0;
+exports.CHAIN_IDS = exports.CHAIN_FAMILY = 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.0",
+  "version": "2.0.2",
   "description": "An SDK for interacting with Keyring Connect browser extension",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,4 +21,4 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {}
-}
+}

package/readme.md

@@ -41,8 +41,6 @@ const extensionConfig = {
   app_url: "https://myapp.com",
   logo_url: "https://myapp.com/logo.png",
   policy_id: 123,
-  // Optional: Enable isolated proving mode
-  // isolate_proving: true,
 };
 
 // This method handles both launching the extension if installed
@@ -96,8 +94,6 @@ function KeyringConnectButton() {
     name: "My App",
     logo_url: "https://myapp.com/logo.png",
     policy_id: 7,
-    // For verification without credential creation:
-    // isolate_proving: true,
   };
 
   // Launch the extension (handles both installed and not installed cases)
@@ -117,12 +113,6 @@ function KeyringConnectButton() {
 }
 ```
 
-With isolated proving mode enabled, the extension will:
-- Focus solely on the verification process
-- Skip wallet connection and credential creation
-- Redirect back to your app when verification is complete
-- Provide simplified UI with no tabs or credential options
-
 ## API Reference
 
 #### Core Types Overview
@@ -133,7 +123,7 @@ With isolated proving mode enabled, the extension will:
 
 #### Status Types
 
-- `ExtensionStatus`: Extension states (`idle`, `mounted`, `proving`, `prove_success`, `error`)
+- `ExtensionStatus`: Extension states (`idle`, `mounted`, `proving`, `prove_error`, `prove_success`, `error`)
 - `AttestationStatus`: Off-chain verification status (`onboarding_required`, `onboarding_pending`, `attestation_ready`, `non_compliant`)
 - `CredentialStatus`: On-chain credential status (`expired`, `valid`, `none`)