@talismn/keyring 0.0.0-pr1827-20250314021218 → 0.1.0

package/README.md

@@ -8,5 +8,9 @@
 
 **@talismn/keyring** is a basic keyring implementation used by the Talisman wallet.
 
+This keyring is not ecosystem specific. As such, it does not provide any signing functionality, and is only used to store accounts and mnemonics.
+
+![](./docs/keyring-diagram.png)
+
 > ⚠️ This package relies on the browser's native crypto API for encryption and decryption. It is designed for use in modern browsers—Talisman wallet runs on Chromium v102+ and Firefox v109+ at the time of writing.
 > Using this library in environments with weaker crypto API implementations, particularly for random number generation, may introduce security risks.

package/dist/declarations/src/keyring/Keyring.d.ts

@@ -27,6 +27,15 @@ export declare class Keyring {
     updateAccount(address: string, { name, isPortfolio, genesisHash }: UpdateAccountOptions): Account;
     removeAccount(address: string): void;
     addAccountExternal(options: AddAccountExternalOptions): Account;
+    /**
+     * Needs to be called before deriving an account from a mnemonic.
+     *
+     * This will ensure that it is present (or add it if possible) in the keyring before actually creating the account.
+     *
+     * @param options
+     * @param password
+     * @returns the id of the mnemonic
+     */
     private ensureMnemonic;
     addAccountDerive(options: AddAccountDeriveOptions, password: string): Promise<Account>;
     addAccountKeypair({ curve, name, secretKey }: AddAccountKeypairOptions, password: string): Promise<Account>;

package/dist/talismn-keyring.cjs.dev.js

@@ -258,7 +258,7 @@ class Keyring {
       account.name = name;
     }
     if (account.type === "watch-only" && isPortfolio !== undefined) {
-      if (typeof isPortfolio !== "boolean") throw new Error("confirmed is required");
+      if (typeof isPortfolio !== "boolean") throw new Error("isPortfolio must be a boolean");
       account.isPortfolio = isPortfolio;
     }
     // allow updating genesisHash only for contacts
@@ -286,6 +286,16 @@ class Keyring {
     this.#data.accounts.push(account);
     return accountFromStorage(account);
   }
+
+  /**
+   * Needs to be called before deriving an account from a mnemonic.
+   *
+   * This will ensure that it is present (or add it if possible) in the keyring before actually creating the account.
+   *
+   * @param options
+   * @param password
+   * @returns the id of the mnemonic
+   */
   async ensureMnemonic(options, password) {
     await this.checkPassword(password);
     switch (options.type) {

package/dist/talismn-keyring.cjs.prod.js

@@ -258,7 +258,7 @@ class Keyring {
       account.name = name;
     }
     if (account.type === "watch-only" && isPortfolio !== undefined) {
-      if (typeof isPortfolio !== "boolean") throw new Error("confirmed is required");
+      if (typeof isPortfolio !== "boolean") throw new Error("isPortfolio must be a boolean");
       account.isPortfolio = isPortfolio;
     }
     // allow updating genesisHash only for contacts
@@ -286,6 +286,16 @@ class Keyring {
     this.#data.accounts.push(account);
     return accountFromStorage(account);
   }
+
+  /**
+   * Needs to be called before deriving an account from a mnemonic.
+   *
+   * This will ensure that it is present (or add it if possible) in the keyring before actually creating the account.
+   *
+   * @param options
+   * @param password
+   * @returns the id of the mnemonic
+   */
   async ensureMnemonic(options, password) {
     await this.checkPassword(password);
     switch (options.type) {

package/dist/talismn-keyring.esm.js

@@ -256,7 +256,7 @@ class Keyring {
       account.name = name;
     }
     if (account.type === "watch-only" && isPortfolio !== undefined) {
-      if (typeof isPortfolio !== "boolean") throw new Error("confirmed is required");
+      if (typeof isPortfolio !== "boolean") throw new Error("isPortfolio must be a boolean");
       account.isPortfolio = isPortfolio;
     }
     // allow updating genesisHash only for contacts
@@ -284,6 +284,16 @@ class Keyring {
     this.#data.accounts.push(account);
     return accountFromStorage(account);
   }
+
+  /**
+   * Needs to be called before deriving an account from a mnemonic.
+   *
+   * This will ensure that it is present (or add it if possible) in the keyring before actually creating the account.
+   *
+   * @param options
+   * @param password
+   * @returns the id of the mnemonic
+   */
   async ensureMnemonic(options, password) {
     await this.checkPassword(password);
     switch (options.type) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/keyring",
-  "version": "0.0.0-pr1827-20250314021218",
+  "version": "0.1.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -22,7 +22,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@talismn/crypto": "0.0.0-pr1827-20250314021218"
+    "@talismn/crypto": "0.1.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
@@ -31,8 +31,8 @@
     "jest-fixed-jsdom": "^0.0.9",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.3",
-    "@talismn/eslint-config": "0.0.0-pr1827-20250314021218",
-    "@talismn/tsconfig": "0.0.2"
+    "@talismn/tsconfig": "0.0.2",
+    "@talismn/eslint-config": "0.0.3"
   },
   "preconstruct": {
     "entrypoints": [