@libp2p/keychain - npm Package Compare versions

Comparing version 5.0.14-c4e862731 to 5.0.14-cc7fcfe98

dist/src/index.d.ts

@@ -62,4 +62,23 @@ /**
 export interface KeychainInit {
+    /**
+     * The password is used to derive a key which encrypts the keychain at rest
+     */
     pass?: string;
+    /**
+     * This key configures how the keychain encryption key is derived from the
+     * configured password
+     */
     dek?: DEKConfig;
+    /**
+     * The 'self' key is the private key of the node from which the peer id is
+     * derived.
+     *
+     * It cannot be renamed or removed.
+     *
+     * By default it is stored under the 'self' key, to use a different name, pass
+     * this option.
+     *
+     * @default 'self'
+     */
+    selfKey?: string;
 }
@@ -66,0 +85,0 @@ export interface KeychainComponents {

dist/src/keychain.d.ts

@@ -25,2 +25,3 @@ import { serviceCapabilities } from '@libp2p/interface';
     private readonly log;
+    private readonly self;
     /**
@@ -27,0 +28,0 @@ * Creates a new instance of a key chain

dist/src/keychain.js

@@ -82,2 +82,3 @@ /* eslint max-nested-callbacks: ["error", 5] */
     log;
+    self;
     /**
@@ -90,2 +91,3 @@ * Creates a new instance of a key chain
         this.init = mergeOptions(defaultOptions, init);
+        this.self = init.selfKey ?? 'self';
         // Enforce NIST SP 800-132
@@ -229,3 +231,3 @@ if (this.init.pass != null && this.init.pass?.length < 20) {
     async removeKey(name) {
-        if (!validateKeyName(name) || name === 'self') {
+        if (!validateKeyName(name) || name === this.self) {
             await randomDelay();
@@ -265,7 +267,7 @@ throw new InvalidParametersError(`Invalid key name '${name}'`);
     async renameKey(oldName, newName) {
-        if (!validateKeyName(oldName) || oldName === 'self') {
+        if (!validateKeyName(oldName) || oldName === this.self) {
             await randomDelay();
             throw new InvalidParametersError(`Invalid old key name '${oldName}'`);
         }
-        if (!validateKeyName(newName) || newName === 'self') {
+        if (!validateKeyName(newName) || newName === this.self) {
             await randomDelay();
@@ -272,0 +274,0 @@ throw new InvalidParametersError(`Invalid new key name '${newName}'`);

package.json

 {
   "name": "@libp2p/keychain",
-  "version": "5.0.14-c4e862731",
+  "version": "5.0.14-cc7fcfe98",
   "description": "Key management and cryptographically protected messages",
@@ -62,4 +62,4 @@ "license": "Apache-2.0 OR MIT",
   "dependencies": {
-    "@libp2p/crypto": "5.0.11-c4e862731",
-    "@libp2p/interface": "2.5.0-c4e862731",
+    "@libp2p/crypto": "5.0.11-cc7fcfe98",
+    "@libp2p/interface": "2.5.0-cc7fcfe98",
     "@noble/hashes": "^1.6.1",
@@ -74,3 +74,3 @@ "asn1js": "^3.0.5",
   "devDependencies": {
-    "@libp2p/logger": "5.1.8-c4e862731",
+    "@libp2p/logger": "5.1.8-cc7fcfe98",
     "aegir": "^45.0.5",
@@ -77,0 +77,0 @@ "datastore-core": "^10.0.2"

src/index.ts

@@ -66,4 +66,25 @@ /**
 export interface KeychainInit {
+  /**
+   * The password is used to derive a key which encrypts the keychain at rest
+   */
   pass?: string
+
+  /**
+   * This key configures how the keychain encryption key is derived from the
+   * configured password
+   */
   dek?: DEKConfig
+
+  /**
+   * The 'self' key is the private key of the node from which the peer id is
+   * derived.
+   *
+   * It cannot be renamed or removed.
+   *
+   * By default it is stored under the 'self' key, to use a different name, pass
+   * this option.
+   *
+   * @default 'self'
+   */
+  selfKey?: string
 }
@@ -70,0 +91,0 @@

src/keychain.ts

@@ -96,2 +96,3 @@ /* eslint max-nested-callbacks: ["error", 5] */
   private readonly log: Logger
+  private readonly self: string
 
@@ -105,2 +106,3 @@ /**
     this.init = mergeOptions(defaultOptions, init)
+    this.self = init.selfKey ?? 'self'
 
@@ -271,3 +273,3 @@ // Enforce NIST SP 800-132
   async removeKey (name: string): Promise<KeyInfo> {
-    if (!validateKeyName(name) || name === 'self') {
+    if (!validateKeyName(name) || name === this.self) {
       await randomDelay()
@@ -313,7 +315,7 @@ throw new InvalidParametersError(`Invalid key name '${name}'`)
   async renameKey (oldName: string, newName: string): Promise<KeyInfo> {
-    if (!validateKeyName(oldName) || oldName === 'self') {
+    if (!validateKeyName(oldName) || oldName === this.self) {
       await randomDelay()
       throw new InvalidParametersError(`Invalid old key name '${oldName}'`)
     }
-    if (!validateKeyName(newName) || newName === 'self') {
+    if (!validateKeyName(newName) || newName === this.self) {
       await randomDelay()
@@ -320,0 +322,0 @@ throw new InvalidParametersError(`Invalid new key name '${newName}'`)

No alert changes

Improved metrics

Total package byte prevSize

260378

increased by0.56%

Lines of code

2600

increased by1.68%

Published versions last months

47

increased by34.29%

Published versions last two months

56

increased by30.23%

Published versions last week

19

increased by111.11%

Published versions last year

324

increased by4.18%

Worsened metrics

Number of downloads

8216

decreased by-9.1%

Dependency changes

• + Added@libp2p/crypto@5.0.11-cc7fcfe98(transitive)

• + Added@libp2p/interface@2.5.0-cc7fcfe98(transitive)

• + Added@types/node@22.13.5(transitive)

• - Removed@libp2p/crypto@5.0.11-c4e862731(transitive)

• - Removed@libp2p/interface@2.5.0-c4e862731(transitive)

• - Removed@types/node@22.13.4(transitive)

• Updated@libp2p/crypto@5.0.11-cc7fcfe98

• Updated@libp2p/interface@2.5.0-cc7fcfe98