@ledgerhq/connect-kit-loader - npm Package Compare versions

Comparing version 1.1.0-beta.1 to 1.1.0-beta.2

CHANGELOG.md

@@ -10,2 +10,6 @@ # Changelog
 
+## 1.1.0-beta.2 - 2023-06-21
+### Changed
+- Rename the version parameter to walletConnectVersion
+
 ## 1.1.0-beta.1 - 2023-06-19
@@ -12,0 +16,0 @@ ### Added

dist/esm/index.d.ts

@@ -1,2 +0,1 @@
-import type { CoreTypes } from '@walletconnect/types';
 export declare enum SupportedProviderImplementations {
@@ -8,3 +7,3 @@ LedgerConnect = "LedgerConnect",
 export type CheckSupportOptions = {
-    version?: number;
+    walletConnectVersion?: number;
     providerType: SupportedProviders;
@@ -21,3 +20,2 @@ projectId?: string;
     };
-    metadata?: CoreTypes.Metadata;
     chainId?: number;
@@ -24,0 +22,0 @@ bridge?: string;

package.json

 {
   "name": "@ledgerhq/connect-kit-loader",
-  "version": "1.1.0-beta.1",
+  "version": "1.1.0-beta.2",
   "description": "Load Ledger Connect Kit at runtime, a library for dApps to integrate with the Ledger Extension and Ledger Live",
@@ -5,0 +5,0 @@ "author": "Ledger SAS <ledger.com>",

README.md

@@ -82,3 +82,3 @@ # Ledger Connect Kit
   providerType: SupportedProviders;
-  version?: number;
+  walletConnectVersion?: number;
 
@@ -94,3 +94,2 @@ // WalletConnect v2 init parameters
   rpcMap?: { [chainId: string]: string; };  // OPTIONAL rpc urls for each chain
-  metadata?: CoreTypes.Metadata;   // OPTIONAL metadata of your app
 }
@@ -102,7 +101,7 @@ ```
 
-The simplest use case is to just specify the `providerType`, `version` and
+The simplest use case is to just specify the `providerType`, `walletConnectVersion` and
 `projectId` parameters.
 
 - `providerType: SupportedProviders.Ethereum`
-- `version: 2` - use WallertConnect v2, default is 1
+- `walletConnectVersion: 2` - use WallertConnect v2, default is 1
 - `projectId` - required for WalletConnect v2 projects, create one at
@@ -187,3 +186,3 @@ [WalletConnect Cloud](https://cloud.walletconnect.com/)
 - Update Connect Kit loader to the latest version
-- Add `version: 2` and `projectId: 'id from step 1'` and rename `rpc` to `rpcMap` on your `checkSupport` parameters
+- Add `walletConnectVersion: 2` and `projectId: 'id from step 1'` and rename `rpc` to `rpcMap` on your `checkSupport` parameters
 
@@ -211,3 +210,3 @@ Have a look at the example velow and the full list of WalletConnect v2 options above.
       providerType: SupportedProviders.Ethereum,
-      version: 2,
+      walletConnectVersion: 2,
       projectId: 'YOUR_PROJECT_ID',
@@ -222,3 +221,2 @@ chains: [1, 137],
     });
-    console.log('checkSupportResult is', checkSupportResult);
 
@@ -263,2 +261,3 @@ const provider = await connectKit.getProvider();
       providerType: SupportedProviders.Ethereum,
+      walletConnectVersion: 1,
       chainId: 1,
@@ -265,0 +264,0 @@ rpc: {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

16038

decreased by-0.09%

Lines of code

66

decreased by-2.94%

Number of lines in readme file

279

decreased by-0.36%

No dependency changes