@talismn/keyring 0.0.0-pr2277-20251211070508 → 0.0.0-pr2295-20260110031023

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/keyring",
-  "version": "0.0.0-pr2277-20251211070508",
+  "version": "0.0.0-pr2295-20260110031023",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -12,16 +12,16 @@
     "type": "git",
     "url": "https://github.com/talismansociety/talisman.git"
   },
-  "main": "dist/talismn-keyring.cjs.js",
-  "module": "dist/talismn-keyring.esm.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "files": [
-    "/dist"
+    "dist"
   ],
   "engines": {
     "node": ">=20"
   },
   "dependencies": {
-    "@talismn/crypto": "0.0.0-pr2277-20251211070508"
+    "@talismn/crypto": "0.0.0-pr2295-20260110031023"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
@@ -31,7 +31,7 @@
     "jest-fixed-jsdom": "^0.0.9",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.3",
-    "@talismn/eslint-config": "0.0.3",
+    "@talismn/eslint-config": "0.0.0-pr2295-20260110031023",
     "@talismn/tsconfig": "0.0.3"
   },
   "preconstruct": {
@@ -45,9 +45,23 @@
       "@talismn/eslint-config/base"
     ]
   },
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "scripts": {
     "test": "jest",
     "lint": "eslint src --max-warnings 0",
-    "clean": "rm -rf dist .turbo node_modules"
+    "clean": "rm -rf dist .turbo node_modules",
+    "build": "tsup"
   }
 }

package/dist/declarations/src/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./types";
-export * from "./keyring";

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

@@ -1,44 +0,0 @@
-import { KeypairCurve } from "@talismn/crypto";
-import type { Account, Mnemonic } from "../types";
-import type { AddAccountDeriveOptions, AddAccountExternalOptions, AddAccountKeypairOptions, AddMnemonicOptions, UpdateAccountOptions, UpdateMnemonicOptions } from "../types/keyring";
-import type { AccountStorage, MnemonicStorage } from "./types";
-export type KeyringStorage = {
-    passwordCheck: string | null;
-    mnemonics: MnemonicStorage[];
-    accounts: AccountStorage[];
-};
-export declare class Keyring {
-    #private;
-    protected constructor(data: KeyringStorage);
-    static create(): Keyring;
-    static load(data: KeyringStorage): Keyring;
-    private checkPassword;
-    toJson(): KeyringStorage;
-    export(password: string, jsonPassword: string): Promise<KeyringStorage>;
-    getMnemonics(): Mnemonic[];
-    addMnemonic({ name, mnemonic, confirmed }: AddMnemonicOptions, password: string): Promise<Mnemonic>;
-    getMnemonic(id: string): Mnemonic | null;
-    updateMnemonic(id: string, { name, confirmed }: UpdateMnemonicOptions): Mnemonic;
-    removeMnemonic(id: string): void;
-    getMnemonicText(id: string, password: string): Promise<string>;
-    getExistingMnemonicId(mnemonic: string): string | null;
-    getAccounts(): Account[];
-    getAccount(address: string): Account | null;
-    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>;
-    getAccountSecretKey(address: string, password: string): Promise<Uint8Array>;
-    getDerivedAddress(mnemonicId: string, derivationPath: string, curve: KeypairCurve, password: string): Promise<string>;
-}

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

@@ -1,3 +0,0 @@
-export declare const encryptData: (data: Uint8Array, password: string) => Promise<string>;
-export declare const decryptData: (encryptedData: string, password: string) => Promise<Uint8Array>;
-export declare const changeEncryptedDataPassword: (encryptedData: string, oldPassword: string, newPassword: string) => Promise<string>;

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

@@ -1 +0,0 @@
-export * from "./Keyring";

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

@@ -1,9 +0,0 @@
-import type { AccountContact, AccountKeypair, AccountLedgerEthereum, AccountLedgerPolkadot, AccountLedgerSolana, AccountPolkadotVault, AccountSignet, AccountWatchOnly } from "../types/account";
-import type { Mnemonic } from "../types/mnemonic";
-export type MnemonicStorage = Mnemonic & {
-    entropy: string;
-};
-export type AccountKeypairStorage = AccountKeypair & {
-    secretKey: string;
-};
-export type AccountStorage = AccountKeypairStorage | AccountContact | AccountWatchOnly | AccountLedgerEthereum | AccountLedgerPolkadot | AccountLedgerSolana | AccountPolkadotVault | AccountSignet;

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

@@ -1,4 +0,0 @@
-type HexString = `0x${string}`;
-export declare const REGEX_HEX_STRING: RegExp;
-export declare const isHexString: (value: unknown) => value is HexString;
-export {};

package/dist/declarations/src/types/account.d.ts

@@ -1,48 +0,0 @@
-import type { KeypairCurve } from "@talismn/crypto";
-export type LedgerPolkadotCurve = "ed25519" | "ethereum";
-export type AccountBase = {
-    address: string;
-    name: string;
-    createdAt: number;
-};
-export type AccountKeypair = AccountBase & {
-    type: "keypair";
-    curve: KeypairCurve;
-    mnemonicId?: string;
-    derivationPath?: string;
-};
-export type AccountContact = AccountBase & {
-    type: "contact";
-    genesisHash?: `0x${string}`;
-};
-export type AccountWatchOnly = AccountBase & {
-    type: "watch-only";
-    isPortfolio: boolean;
-};
-export type AccountLedgerPolkadot = AccountBase & {
-    type: "ledger-polkadot";
-    curve: LedgerPolkadotCurve;
-    app: string;
-    accountIndex: number;
-    addressOffset: number;
-    genesisHash?: `0x${string}`;
-};
-export type AccountLedgerEthereum = AccountBase & {
-    type: "ledger-ethereum";
-    derivationPath: string;
-};
-export type AccountLedgerSolana = AccountBase & {
-    type: "ledger-solana";
-    derivationPath: string;
-};
-export type AccountPolkadotVault = AccountBase & {
-    type: "polkadot-vault";
-    genesisHash: `0x${string}` | null;
-};
-export type AccountSignet = AccountBase & {
-    type: "signet";
-    genesisHash: `0x${string}`;
-    url: string;
-};
-export type Account = AccountKeypair | AccountContact | AccountWatchOnly | AccountLedgerEthereum | AccountLedgerPolkadot | AccountLedgerSolana | AccountPolkadotVault | AccountSignet;
-export type AccountType = Account["type"];

package/dist/declarations/src/types/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./mnemonic";
-export * from "./account";
-export * from "./utils";
-export * from "./keyring";

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

@@ -1,38 +0,0 @@
-import type { KeypairCurve } from "@talismn/crypto";
-import type { AccountBase, AccountContact, AccountLedgerEthereum, AccountLedgerPolkadot, AccountLedgerSolana, AccountPolkadotVault, AccountSignet, AccountWatchOnly } from "./account";
-export type AddMnemonicOptions = {
-    mnemonic: string;
-    name: string;
-    confirmed: boolean;
-};
-export type UpdateMnemonicOptions = {
-    name?: string;
-    confirmed?: boolean;
-};
-type DeriveFromNewMnemonic = {
-    type: "new-mnemonic";
-    mnemonic: string;
-    mnemonicName: string;
-    confirmed: boolean;
-    curve: KeypairCurve;
-    derivationPath: string;
-};
-type DeriveFromExistingMnemonic = {
-    type: "existing-mnemonic";
-    mnemonicId: string;
-    curve: KeypairCurve;
-    derivationPath: string;
-};
-type DeriveFromMnemonicOptions = DeriveFromNewMnemonic | DeriveFromExistingMnemonic;
-export type AddAccountDeriveOptions = Omit<AccountBase, "createdAt" | "address"> & DeriveFromMnemonicOptions;
-export type AddAccountKeypairOptions = Omit<AccountBase, "createdAt" | "address"> & {
-    curve: KeypairCurve;
-    secretKey: Uint8Array;
-};
-export type AddAccountExternalOptions = Omit<AccountContact, "createdAt"> | Omit<AccountWatchOnly, "createdAt"> | Omit<AccountLedgerEthereum, "createdAt"> | Omit<AccountLedgerPolkadot, "createdAt"> | Omit<AccountLedgerSolana, "createdAt"> | Omit<AccountPolkadotVault, "createdAt"> | Omit<AccountSignet, "createdAt">;
-export type UpdateAccountOptions = {
-    name?: string;
-    isPortfolio?: boolean;
-    genesisHash?: `0x${string}`;
-};
-export {};

package/dist/declarations/src/types/mnemonic.d.ts

@@ -1,6 +0,0 @@
-export type Mnemonic = {
-    id: string;
-    name: string;
-    confirmed: boolean;
-    createdAt: number;
-};

package/dist/declarations/src/types/utils.d.ts

@@ -1,59 +0,0 @@
-import type { Account, AccountLedgerPolkadot, AccountType } from "./account";
-export type AccountOfType<Type extends AccountType> = Extract<Account, {
-    type: Type;
-}>;
-export declare const isAccountOfType: <Type extends AccountType>(account: Account | null | undefined, type: Type) => account is AccountOfType<Type>;
-export declare const isAccountInTypes: <Types extends AccountType[]>(account: Account | null | undefined, types: Types) => account is AccountOfType<Types[number]>;
-declare const ACCOUNT_TYPES_OWNED: readonly ["keypair", "ledger-ethereum", "ledger-polkadot", "ledger-solana", "polkadot-vault"];
-declare const ACCOUNT_TYPES_EXTERNAL: readonly ["contact", "watch-only", "ledger-ethereum", "ledger-polkadot", "ledger-solana", "polkadot-vault", "signet"];
-declare const ACCOUNT_TYPES_ADDRESS_ETHEREUM: readonly ["contact", "watch-only", "keypair", "ledger-ethereum", "ledger-polkadot"];
-declare const ACCOUNT_TYPES_PLATFORM_ETHEREUM: readonly ["contact", "watch-only", "keypair", "ledger-ethereum"];
-declare const ACCOUNT_TYPES_PLATFORM_POLKADOT: readonly ["contact", "watch-only", "keypair", "ledger-polkadot", "polkadot-vault", "signet"];
-declare const ACCOUNT_TYPES_ADDRESS_SS58: readonly ["contact", "watch-only", "keypair", "ledger-polkadot", "polkadot-vault", "signet"];
-declare const ACCOUNT_TYPES_PLATFORM_SOLANA: readonly ["contact", "watch-only", "keypair", "ledger-solana"];
-declare const ACCOUNT_TYPES_BITCOIN: readonly ["contact", "watch-only"];
-export declare const isAccountExternal: (account: Account | null | undefined) => account is AccountOfType<(typeof ACCOUNT_TYPES_EXTERNAL)[number]>;
-export declare const isAccountOwned: (account: Account | null | undefined) => account is AccountOfType<(typeof ACCOUNT_TYPES_OWNED)[number]>;
-export declare const isAccountPortfolio: (account: Account | null | undefined) => account is Account;
-export declare const isAccountNotContact: (acc: Account) => acc is import("./account").AccountKeypair | import("./account").AccountWatchOnly | AccountLedgerPolkadot | import("./account").AccountLedgerEthereum | import("./account").AccountLedgerSolana | import("./account").AccountPolkadotVault | import("./account").AccountSignet;
-type AccountAddressEthereum = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_ADDRESS_ETHEREUM)[number];
-}> & {
-    address: `0x${string}`;
-};
-export declare const isAccountAddressEthereum: (account: Account | null | undefined) => account is AccountAddressEthereum;
-type AccountPlatformEthereum = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_PLATFORM_ETHEREUM)[number];
-}> & {
-    address: `0x${string}`;
-};
-export declare const isAccountPlatformEthereum: (account: Account | null | undefined) => account is AccountPlatformEthereum;
-type AccountPlatformSolana = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_PLATFORM_SOLANA)[number];
-}>;
-export declare const isAccountPlatformSolana: (account: Account | null | undefined) => account is AccountPlatformSolana;
-type AccountPlatformPolkadot = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_PLATFORM_POLKADOT)[number];
-}>;
-export declare const isAccountPlatformPolkadot: (account: Account | null | undefined) => account is AccountPlatformPolkadot;
-type AccountAddressSs58 = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_ADDRESS_SS58)[number];
-}> & {
-    genesisHash?: `0x${string}`;
-};
-export declare const isAccountAddressSs58: (account: Account | null | undefined) => account is AccountAddressSs58;
-export declare const isAccountLedgerPolkadot: (account: Account | null | undefined) => account is AccountLedgerPolkadot;
-export declare const isAccountLedgerPolkadotGeneric: (account: Account | null | undefined) => account is AccountLedgerPolkadot & {
-    genesisHash: undefined;
-};
-export declare const isAccountLedgerPolkadotLegacy: (account: Account | null | undefined) => account is AccountLedgerPolkadot & {
-    genesisHash: `0x${string}`;
-};
-type AccountBitcoin = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_BITCOIN)[number];
-}>;
-export declare const isAccountBitcoin: (account: Account | null | undefined) => account is AccountBitcoin;
-export declare const getAccountGenesisHash: (account: Account | null | undefined) => `0x${string}` | undefined;
-export declare const getAccountSignetUrl: (account: Account | null | undefined) => string | undefined;
-export declare const getAccountPlatform: (account: Account | null | undefined) => import("@talismn/crypto").AccountPlatform | undefined;
-export {};

package/dist/talismn-keyring.cjs.d.ts

@@ -1 +0,0 @@
-export * from "./declarations/src/index";