@keyringnetwork/keyring-connect-sdk 1.1.4 → 2.0.1

package/dist/constants/datasources.json

@@ -546,6 +546,24 @@
                         "id": "revolut_kyc_verified",
                         "label": "KYC Verified",
                         "rule_id": "revolut_kyc_verified"
+                    },
+                    {
+                        "entity_type": "individual",
+                        "id": "revolut_kyc_not_under_review",
+                        "label": "KYC Not Under Review",
+                        "rule_id": "revolut_kyc_not_under_review"
+                    },
+                    {
+                        "entity_type": "individual",
+                        "id": "revolut_kyc_user_status_active",
+                        "label": "KYC User Status Active",
+                        "rule_id": "revolut_kyc_user_status_active"
+                    },
+                    {
+                        "entity_type": "individual",
+                        "id": "revolut_kyc_not_in_fatf_tlsn-revolut-kyc",
+                        "label": "Revolut Residence Country not on FATF",
+                        "rule_id": "revolut_kyc_not_in_fatf_tlsn-revolut-kyc"
                     }
                 ],
                 "endpoint": {
@@ -595,5 +613,50 @@
             "Navigate to your profile page",
             "The verification process will start automatically"
         ]
+    },
+    {
+        "id": "tlsn-keyring-connect",
+        "image": "https://uploads-ssl.webflow.com/65df8e71bab45b70f5433fba/664359927ac82d0c110ff6be_Keyring%20Icon%20Square.svg",
+        "label": "keyring-connect",
+        "link": "https://app.keyringdev.network",
+        "login_url": "https://app.keyringdev.network/login",
+        "name": "Keyring Connect",
+        "proof_sources": [
+            {
+                "claims": [
+                    {
+                        "entity_type": "individual",
+                        "id": "keyring_connect_kyc",
+                        "label": "KYC from Keyring Connect",
+                        "rule_id": "keyring_connect_kyc"
+                    }
+                ],
+                "endpoint": {
+                    "body": null,
+                    "data_bounds": null,
+                    "disclosable_fields": [
+                        {
+                            "label": "user id",
+                            "path": "id",
+                            "key": "user_id"
+                        }
+                    ],
+                    "headers": [
+                        "user-agent",
+                        "authorization"
+                    ],
+                    "method": "GET",
+                    "required_cookies": null,
+                    "url": "https://main.api.keyring-backend.krndev.net/api/v1/onboarding/users/me"
+                },
+                "id": "tlsn-keyring-connect-kyc",
+                "label": "KYC from Keyring Connect"
+            }
+        ],
+        "target_url": null,
+        "user_actions": [
+            "Make sure you have logged in",
+            "Navigate to the marketplace"
+        ]
     }
 ]

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,15 +149,15 @@ 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.credential_config,
+                credential_config: config.credential_config,
             },
             krn_config: config.krn_config
                 ? {
                     keyring_api_url: config.krn_config.keyring_api_url,
                     keyring_user_app_url: config.krn_config.keyring_user_app_url,
                     analytics_api_url: config.krn_config.analytics_api_url,
-                    isolate_proving: config.krn_config.isolate_proving,
                     notaryUrl: config.krn_config.notaryUrl,
-                    notaryWebsocketUrl: config.krn_config.notaryWebsocketUrl,
                     websocketProxyUrl: config.krn_config.websocketProxyUrl,
                 }
                 : undefined,

package/dist/types.d.ts

@@ -26,6 +26,13 @@ export type ExtensionSDKConfig = {
      * The policy ID of the client.
      */
     policy_id: number;
+    /**
+     * If configured, will skip wallet interaction and on-chain credential creation and return calldata instead.
+     */
+    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.
@@ -44,12 +51,32 @@ export type ExtensionSDKConfig = {
         analytics_api_url?: string;
         keyring_access_token?: string;
         entity_id?: string;
-        isolate_proving?: boolean;
         notaryUrl?: string;
-        notaryWebsocketUrl?: string;
         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;
@@ -57,6 +84,11 @@ export type ExtensionLaunchConfig = {
         client_logo_url: string;
         client_policy_id: number;
         client_entity_id?: string;
+        isolate_proving?: boolean;
+        credential_config?: {
+            chain_id: SupportedChainId;
+            wallet_address: string;
+        };
     };
     proof_config?: {
         datasource?: DataSource;
@@ -66,9 +98,7 @@ export type ExtensionLaunchConfig = {
         keyring_api_url?: string;
         keyring_user_app_url?: string;
         analytics_api_url?: string;
-        isolate_proving?: boolean;
         notaryUrl?: string;
-        notaryWebsocketUrl?: string;
         websocketProxyUrl?: string;
     };
     session_info?: {
@@ -106,6 +136,7 @@ export interface ExtensionState {
     error?: string;
     user?: User;
     tlsn_proof?: string;
+    credentialData?: CredentialData;
 }
 export interface DataSource {
     id: string;
@@ -148,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": "1.1.4",
+  "version": "2.0.1",
   "description": "An SDK for interacting with Keyring Connect browser extension",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,7 +20,5 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
   },
-  "dependencies": {
-    "jwt-decode": "^4.0.0"
-  }
-}
+  "dependencies": {}
+}

package/readme.md

@@ -17,6 +17,7 @@ pnpm install @keyringnetwork/keyring-connect-sdk
 - Redirect the user back to the app where they left off after extension installation
 - Monitor extension status and user state
 - Full TypeScript support with comprehensive type definitions
+- Support for isolated proving mode (verification without credential creation)
 
 ## Usage