@talismn/keyring 0.1.4 → 1.0.0

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

@@ -1,4 +1,5 @@
 import type { KeypairCurve } from "@talismn/crypto";
+export type LedgerPolkadotCurve = "ed25519" | "ethereum";
 export type AccountPlatform = "ethereum" | "polkadot" | "solana" | "bitcoin";
 export type AccountBase = {
     address: string;
@@ -21,6 +22,7 @@ export type AccountWatchOnly = AccountBase & {
 };
 export type AccountLedgerPolkadot = AccountBase & {
     type: "ledger-polkadot";
+    curve: LedgerPolkadotCurve;
     app: string;
     accountIndex: number;
     addressOffset: number;

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

@@ -6,25 +6,38 @@ export declare const isAccountOfType: <Type extends AccountType>(account: Accoun
 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", "polkadot-vault"];
 declare const ACCOUNT_TYPES_EXTERNAL: readonly ["contact", "watch-only", "ledger-ethereum", "ledger-polkadot", "polkadot-vault", "signet"];
-declare const ACCOUNT_TYPES_ETHEREUM: readonly ["contact", "watch-only", "keypair", "ledger-ethereum"];
-declare const ACCOUNT_TYPES_POLKADOT: readonly ["contact", "watch-only", "keypair", "ledger-polkadot", "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_ADDRESS_SS58: readonly ["contact", "watch-only", "keypair", "ledger-polkadot", "polkadot-vault", "signet"];
+declare const ACCOUNT_TYPES_PLATFORM_POLKADOT: readonly ["contact", "watch-only", "keypair", "ledger-polkadot", "polkadot-vault", "signet"];
 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").AccountPolkadotVault | import("./account").AccountSignet;
-type AccountEthereum = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_ETHEREUM)[number];
+type AccountAddressEthereum = Extract<Account, {
+    type: (typeof ACCOUNT_TYPES_ADDRESS_ETHEREUM)[number];
 }> & {
     address: `0x${string}`;
 };
-export declare const isAccountEthereum: (account: Account | null | undefined) => account is AccountEthereum;
-type AccountPolkadot = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_POLKADOT)[number];
+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 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 isAccountPolkadot: (account: Account | null | undefined) => account is AccountPolkadot;
+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;
 };

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

@@ -20,12 +20,21 @@ const isAccountPortfolio = account => {
   return isAccountOwned(account) || isAccountOfType(account, "watch-only") && account.isPortfolio;
 };
 const isAccountNotContact = acc => acc.type !== "contact";
-const isAccountEthereum = account => {
+const isAccountAddressEthereum = account => {
   return !!account && crypto$1.isEthereumAddress(account.address);
 };
-const isAccountPolkadot = account => {
+const isAccountPlatformEthereum = account => {
+  return !!account && account.type !== "ledger-polkadot" && crypto$1.isEthereumAddress(account.address);
+};
+const isAccountPlatformPolkadot = account => {
+  return !!account && account.type !== "ledger-ethereum" && (isAccountAddressEthereum(account) || isAccountAddressSs58(account));
+};
+const isAccountAddressSs58 = account => {
   return !!account && crypto$1.detectAddressEncoding(account.address) === "ss58";
 };
+const isAccountLedgerPolkadot = account => {
+  return isAccountOfType(account, "ledger-polkadot");
+};
 const isAccountLedgerPolkadotGeneric = account => {
   return isAccountOfType(account, "ledger-polkadot") && !account.genesisHash;
 };
@@ -139,8 +148,14 @@ class Keyring {
     });
   }
   static load(data) {
-    // TODO: schema check ?
     if (!data.accounts || !data.mnemonics) throw new Error("Invalid data");
+
+    // automatic upgrade : set default values for newly introduced properties
+    for (const account of data.accounts) {
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-expect-error
+      if (account.type === "ledger-polkadot" && !account.curve) account.curve = "ed25519";
+    }
     return new Keyring(data);
   }
   async checkPassword(password, reset = false) {
@@ -414,14 +429,17 @@ exports.Keyring = Keyring;
 exports.getAccountGenesisHash = getAccountGenesisHash;
 exports.getAccountPlatform = getAccountPlatform;
 exports.getAccountSignetUrl = getAccountSignetUrl;
+exports.isAccountAddressEthereum = isAccountAddressEthereum;
+exports.isAccountAddressSs58 = isAccountAddressSs58;
 exports.isAccountBitcoin = isAccountBitcoin;
-exports.isAccountEthereum = isAccountEthereum;
 exports.isAccountExternal = isAccountExternal;
 exports.isAccountInTypes = isAccountInTypes;
+exports.isAccountLedgerPolkadot = isAccountLedgerPolkadot;
 exports.isAccountLedgerPolkadotGeneric = isAccountLedgerPolkadotGeneric;
 exports.isAccountLedgerPolkadotLegacy = isAccountLedgerPolkadotLegacy;
 exports.isAccountNotContact = isAccountNotContact;
 exports.isAccountOfType = isAccountOfType;
 exports.isAccountOwned = isAccountOwned;
-exports.isAccountPolkadot = isAccountPolkadot;
+exports.isAccountPlatformEthereum = isAccountPlatformEthereum;
+exports.isAccountPlatformPolkadot = isAccountPlatformPolkadot;
 exports.isAccountPortfolio = isAccountPortfolio;

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

@@ -20,12 +20,21 @@ const isAccountPortfolio = account => {
   return isAccountOwned(account) || isAccountOfType(account, "watch-only") && account.isPortfolio;
 };
 const isAccountNotContact = acc => acc.type !== "contact";
-const isAccountEthereum = account => {
+const isAccountAddressEthereum = account => {
   return !!account && crypto$1.isEthereumAddress(account.address);
 };
-const isAccountPolkadot = account => {
+const isAccountPlatformEthereum = account => {
+  return !!account && account.type !== "ledger-polkadot" && crypto$1.isEthereumAddress(account.address);
+};
+const isAccountPlatformPolkadot = account => {
+  return !!account && account.type !== "ledger-ethereum" && (isAccountAddressEthereum(account) || isAccountAddressSs58(account));
+};
+const isAccountAddressSs58 = account => {
   return !!account && crypto$1.detectAddressEncoding(account.address) === "ss58";
 };
+const isAccountLedgerPolkadot = account => {
+  return isAccountOfType(account, "ledger-polkadot");
+};
 const isAccountLedgerPolkadotGeneric = account => {
   return isAccountOfType(account, "ledger-polkadot") && !account.genesisHash;
 };
@@ -139,8 +148,14 @@ class Keyring {
     });
   }
   static load(data) {
-    // TODO: schema check ?
     if (!data.accounts || !data.mnemonics) throw new Error("Invalid data");
+
+    // automatic upgrade : set default values for newly introduced properties
+    for (const account of data.accounts) {
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-expect-error
+      if (account.type === "ledger-polkadot" && !account.curve) account.curve = "ed25519";
+    }
     return new Keyring(data);
   }
   async checkPassword(password, reset = false) {
@@ -414,14 +429,17 @@ exports.Keyring = Keyring;
 exports.getAccountGenesisHash = getAccountGenesisHash;
 exports.getAccountPlatform = getAccountPlatform;
 exports.getAccountSignetUrl = getAccountSignetUrl;
+exports.isAccountAddressEthereum = isAccountAddressEthereum;
+exports.isAccountAddressSs58 = isAccountAddressSs58;
 exports.isAccountBitcoin = isAccountBitcoin;
-exports.isAccountEthereum = isAccountEthereum;
 exports.isAccountExternal = isAccountExternal;
 exports.isAccountInTypes = isAccountInTypes;
+exports.isAccountLedgerPolkadot = isAccountLedgerPolkadot;
 exports.isAccountLedgerPolkadotGeneric = isAccountLedgerPolkadotGeneric;
 exports.isAccountLedgerPolkadotLegacy = isAccountLedgerPolkadotLegacy;
 exports.isAccountNotContact = isAccountNotContact;
 exports.isAccountOfType = isAccountOfType;
 exports.isAccountOwned = isAccountOwned;
-exports.isAccountPolkadot = isAccountPolkadot;
+exports.isAccountPlatformEthereum = isAccountPlatformEthereum;
+exports.isAccountPlatformPolkadot = isAccountPlatformPolkadot;
 exports.isAccountPortfolio = isAccountPortfolio;

package/dist/talismn-keyring.esm.js

@@ -18,12 +18,21 @@ const isAccountPortfolio = account => {
   return isAccountOwned(account) || isAccountOfType(account, "watch-only") && account.isPortfolio;
 };
 const isAccountNotContact = acc => acc.type !== "contact";
-const isAccountEthereum = account => {
+const isAccountAddressEthereum = account => {
   return !!account && isEthereumAddress(account.address);
 };
-const isAccountPolkadot = account => {
+const isAccountPlatformEthereum = account => {
+  return !!account && account.type !== "ledger-polkadot" && isEthereumAddress(account.address);
+};
+const isAccountPlatformPolkadot = account => {
+  return !!account && account.type !== "ledger-ethereum" && (isAccountAddressEthereum(account) || isAccountAddressSs58(account));
+};
+const isAccountAddressSs58 = account => {
   return !!account && detectAddressEncoding(account.address) === "ss58";
 };
+const isAccountLedgerPolkadot = account => {
+  return isAccountOfType(account, "ledger-polkadot");
+};
 const isAccountLedgerPolkadotGeneric = account => {
   return isAccountOfType(account, "ledger-polkadot") && !account.genesisHash;
 };
@@ -137,8 +146,14 @@ class Keyring {
     });
   }
   static load(data) {
-    // TODO: schema check ?
     if (!data.accounts || !data.mnemonics) throw new Error("Invalid data");
+
+    // automatic upgrade : set default values for newly introduced properties
+    for (const account of data.accounts) {
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-expect-error
+      if (account.type === "ledger-polkadot" && !account.curve) account.curve = "ed25519";
+    }
     return new Keyring(data);
   }
   async checkPassword(password, reset = false) {
@@ -408,4 +423,4 @@ const accountFromStorage = data => {
   return Object.freeze(copy);
 };
 
-export { Keyring, getAccountGenesisHash, getAccountPlatform, getAccountSignetUrl, isAccountBitcoin, isAccountEthereum, isAccountExternal, isAccountInTypes, isAccountLedgerPolkadotGeneric, isAccountLedgerPolkadotLegacy, isAccountNotContact, isAccountOfType, isAccountOwned, isAccountPolkadot, isAccountPortfolio };
+export { Keyring, getAccountGenesisHash, getAccountPlatform, getAccountSignetUrl, isAccountAddressEthereum, isAccountAddressSs58, isAccountBitcoin, isAccountExternal, isAccountInTypes, isAccountLedgerPolkadot, isAccountLedgerPolkadotGeneric, isAccountLedgerPolkadotLegacy, isAccountNotContact, isAccountOfType, isAccountOwned, isAccountPlatformEthereum, isAccountPlatformPolkadot, isAccountPortfolio };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/keyring",
-  "version": "0.1.4",
+  "version": "1.0.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -22,7 +22,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@talismn/crypto": "0.1.3"
+    "@talismn/crypto": "0.1.4"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",