@talismn/keyring 1.0.12 → 2.0.0

package/dist/index.d.ts

@@ -1,99 +1,101 @@
-import * as _talismn_crypto from '@talismn/crypto';
-import { KeypairCurve } from '@talismn/crypto';
-
+import { KeypairCurve } from "@talismn/crypto";
+//#region src/types/account.d.ts
 type LedgerPolkadotCurve = "ed25519" | "ethereum";
 type AccountBase = {
-    address: string;
-    name: string;
-    createdAt: number;
+  address: string;
+  name: string;
+  createdAt: number;
 };
 type AccountKeypair = AccountBase & {
-    type: "keypair";
-    curve: KeypairCurve;
-    mnemonicId?: string;
-    derivationPath?: string;
+  type: "keypair";
+  curve: KeypairCurve;
+  mnemonicId?: string;
+  derivationPath?: string;
 };
 type AccountContact = AccountBase & {
-    type: "contact";
-    genesisHash?: `0x${string}`;
+  type: "contact";
+  genesisHash?: `0x${string}`;
 };
 type AccountWatchOnly = AccountBase & {
-    type: "watch-only";
-    isPortfolio: boolean;
+  type: "watch-only";
+  isPortfolio: boolean;
 };
 type AccountLedgerPolkadot = AccountBase & {
-    type: "ledger-polkadot";
-    curve: LedgerPolkadotCurve;
-    app: string;
-    accountIndex: number;
-    addressOffset: number;
-    genesisHash?: `0x${string}`;
+  type: "ledger-polkadot";
+  curve: LedgerPolkadotCurve;
+  app: string;
+  accountIndex: number;
+  addressOffset: number;
+  genesisHash?: `0x${string}`;
 };
 type AccountLedgerEthereum = AccountBase & {
-    type: "ledger-ethereum";
-    derivationPath: string;
+  type: "ledger-ethereum";
+  derivationPath: string;
 };
 type AccountLedgerSolana = AccountBase & {
-    type: "ledger-solana";
-    derivationPath: string;
+  type: "ledger-solana";
+  derivationPath: string;
 };
 type AccountPolkadotVault = AccountBase & {
-    type: "polkadot-vault";
-    genesisHash: `0x${string}` | null;
+  type: "polkadot-vault";
+  genesisHash: `0x${string}` | null;
 };
 type AccountSignet = AccountBase & {
-    type: "signet";
-    genesisHash: `0x${string}`;
-    url: string;
+  type: "signet";
+  genesisHash: `0x${string}`;
+  url: string;
 };
 type Account = AccountKeypair | AccountContact | AccountWatchOnly | AccountLedgerEthereum | AccountLedgerPolkadot | AccountLedgerSolana | AccountPolkadotVault | AccountSignet;
 type AccountType = Account["type"];
-
+//#endregion
+//#region src/types/keyring.d.ts
 type AddMnemonicOptions = {
-    mnemonic: string;
-    name: string;
-    confirmed: boolean;
+  mnemonic: string;
+  name: string;
+  confirmed: boolean;
 };
 type UpdateMnemonicOptions = {
-    name?: string;
-    confirmed?: boolean;
+  name?: string;
+  confirmed?: boolean;
 };
 type DeriveFromNewMnemonic = {
-    type: "new-mnemonic";
-    mnemonic: string;
-    mnemonicName: string;
-    confirmed: boolean;
-    curve: KeypairCurve;
-    derivationPath: string;
+  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: "existing-mnemonic";
+  mnemonicId: string;
+  curve: KeypairCurve;
+  derivationPath: string;
 };
 type DeriveFromMnemonicOptions = DeriveFromNewMnemonic | DeriveFromExistingMnemonic;
 type AddAccountDeriveOptions = Omit<AccountBase, "createdAt" | "address"> & DeriveFromMnemonicOptions;
 type AddAccountKeypairOptions = Omit<AccountBase, "createdAt" | "address"> & {
-    curve: KeypairCurve;
-    secretKey: Uint8Array;
+  curve: KeypairCurve;
+  secretKey: Uint8Array;
 };
 type AddAccountExternalOptions = Omit<AccountContact, "createdAt"> | Omit<AccountWatchOnly, "createdAt"> | Omit<AccountLedgerEthereum, "createdAt"> | Omit<AccountLedgerPolkadot, "createdAt"> | Omit<AccountLedgerSolana, "createdAt"> | Omit<AccountPolkadotVault, "createdAt"> | Omit<AccountSignet, "createdAt">;
 type UpdateAccountOptions = {
-    name?: string;
-    isPortfolio?: boolean;
-    genesisHash?: `0x${string}`;
+  name?: string;
+  isPortfolio?: boolean;
+  genesisHash?: `0x${string}`;
 };
-
+//#endregion
+//#region src/types/mnemonic.d.ts
 type Mnemonic = {
-    id: string;
-    name: string;
-    confirmed: boolean;
-    createdAt: number;
+  id: string;
+  name: string;
+  confirmed: boolean;
+  createdAt: number;
 };
-
+//#endregion
+//#region src/types/utils.d.ts
 type AccountOfType<Type extends AccountType> = Extract<Account, {
-    type: Type;
+  type: Type;
 }>;
 declare const isAccountOfType: <Type extends AccountType>(account: Account | null | undefined, type: Type) => account is AccountOfType<Type>;
 declare const isAccountInTypes: <Types extends AccountType[]>(account: Account | null | undefined, types: Types) => account is AccountOfType<Types[number]>;
@@ -108,108 +110,111 @@ declare const ACCOUNT_TYPES_BITCOIN: readonly ["contact", "watch-only"];
 declare const isAccountExternal: (account: Account | null | undefined) => account is AccountOfType<(typeof ACCOUNT_TYPES_EXTERNAL)[number]>;
 declare const isAccountOwned: (account: Account | null | undefined) => account is AccountOfType<(typeof ACCOUNT_TYPES_OWNED)[number]>;
 declare const isAccountPortfolio: (account: Account | null | undefined) => account is Account;
-declare const isAccountNotContact: (acc: Account) => acc is AccountKeypair | AccountWatchOnly | AccountLedgerPolkadot | AccountLedgerEthereum | AccountLedgerSolana | AccountPolkadotVault | AccountSignet;
+declare const isAccountNotContact: (acc: Account) => acc is AccountKeypair | AccountLedgerEthereum | AccountLedgerPolkadot | AccountLedgerSolana | AccountPolkadotVault | AccountSignet | AccountWatchOnly;
 type AccountAddressEthereum = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_ADDRESS_ETHEREUM)[number];
+  type: (typeof ACCOUNT_TYPES_ADDRESS_ETHEREUM)[number];
 }> & {
-    address: `0x${string}`;
+  address: `0x${string}`;
 };
 declare const isAccountAddressEthereum: (account: Account | null | undefined) => account is AccountAddressEthereum;
 type AccountPlatformEthereum = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_PLATFORM_ETHEREUM)[number];
+  type: (typeof ACCOUNT_TYPES_PLATFORM_ETHEREUM)[number];
 }> & {
-    address: `0x${string}`;
+  address: `0x${string}`;
 };
 declare const isAccountPlatformEthereum: (account: Account | null | undefined) => account is AccountPlatformEthereum;
 type AccountPlatformSolana = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_PLATFORM_SOLANA)[number];
+  type: (typeof ACCOUNT_TYPES_PLATFORM_SOLANA)[number];
 }>;
 declare const isAccountPlatformSolana: (account: Account | null | undefined) => account is AccountPlatformSolana;
 type AccountPlatformPolkadot = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_PLATFORM_POLKADOT)[number];
+  type: (typeof ACCOUNT_TYPES_PLATFORM_POLKADOT)[number];
 }>;
 declare const isAccountPlatformPolkadot: (account: Account | null | undefined) => account is AccountPlatformPolkadot;
 type AccountAddressSs58 = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_ADDRESS_SS58)[number];
+  type: (typeof ACCOUNT_TYPES_ADDRESS_SS58)[number];
 }> & {
-    genesisHash?: `0x${string}`;
+  genesisHash?: `0x${string}`;
 };
 declare const isAccountAddressSs58: (account: Account | null | undefined) => account is AccountAddressSs58;
 declare const isAccountLedgerPolkadot: (account: Account | null | undefined) => account is AccountLedgerPolkadot;
 declare const isAccountLedgerPolkadotGeneric: (account: Account | null | undefined) => account is AccountLedgerPolkadot & {
-    genesisHash: undefined;
+  genesisHash: undefined;
 };
 declare const isAccountLedgerPolkadotLegacy: (account: Account | null | undefined) => account is AccountLedgerPolkadot & {
-    genesisHash: `0x${string}`;
+  genesisHash: `0x${string}`;
 };
 type AccountBitcoin = Extract<Account, {
-    type: (typeof ACCOUNT_TYPES_BITCOIN)[number];
+  type: (typeof ACCOUNT_TYPES_BITCOIN)[number];
 }>;
 declare const isAccountBitcoin: (account: Account | null | undefined) => account is AccountBitcoin;
 declare const getAccountGenesisHash: (account: Account | null | undefined) => `0x${string}` | undefined;
 declare const getAccountSignetUrl: (account: Account | null | undefined) => string | undefined;
-declare const getAccountPlatform: (account: Account | null | undefined) => _talismn_crypto.AccountPlatform | undefined;
-
+declare const getAccountPlatform: (account: Account | null | undefined) => import("@talismn/crypto").AccountPlatform | undefined;
+//#endregion
+//#region src/keyring/types.d.ts
 type MnemonicStorage = Mnemonic & {
-    entropy: string;
+  entropy: string;
 };
 type AccountKeypairStorage = AccountKeypair & {
-    secretKey: string;
+  secretKey: string;
 };
 type AccountStorage = AccountKeypairStorage | AccountContact | AccountWatchOnly | AccountLedgerEthereum | AccountLedgerPolkadot | AccountLedgerSolana | AccountPolkadotVault | AccountSignet;
-
+//#endregion
+//#region src/keyring/Keyring.d.ts
 type KeyringStorage = {
-    passwordCheck: string | null;
-    mnemonics: MnemonicStorage[];
-    accounts: AccountStorage[];
+  passwordCheck: string | null;
+  mnemonics: MnemonicStorage[];
+  accounts: AccountStorage[];
 };
 declare class Keyring {
-    #private;
-    protected constructor(data: KeyringStorage);
-    static create(): Keyring;
-    static load(data: KeyringStorage): Keyring;
-    private checkPassword;
-    /** Returns true if a password has been set on this keyring. */
-    hasPassword(): boolean;
-    /**
-     * Verify a password against the keyring's passwordCheck blob.
-     * Returns true on success, false on wrong password.
-     * Throws if no password has been set (caller should check hasPassword() first).
-     */
-    verifyPassword(password: string): Promise<boolean>;
-    /**
-     * Initialize the password on a fresh keyring that has no password set.
-     * Throws if a password is already set (use changePassword flow instead).
-     */
-    initializePassword(password: string): Promise<void>;
-    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>;
+  #private;
+  protected constructor(data: KeyringStorage);
+  static create(): Keyring;
+  static load(data: KeyringStorage): Keyring;
+  private checkPassword;
+  /** Returns true if a password has been set on this keyring. */
+  hasPassword(): boolean;
+  /**
+   * Verify a password against the keyring's passwordCheck blob.
+   * Returns true on success, false on wrong password.
+   * Throws if no password has been set (caller should check hasPassword() first).
+   */
+  verifyPassword(password: string): Promise<boolean>;
+  /**
+   * Initialize the password on a fresh keyring that has no password set.
+   * Throws if a password is already set (use changePassword flow instead).
+   */
+  initializePassword(password: string): Promise<void>;
+  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>;
 }
-
-export { type Account, type AccountBase, type AccountContact, type AccountKeypair, type AccountLedgerEthereum, type AccountLedgerPolkadot, type AccountLedgerSolana, type AccountOfType, type AccountPolkadotVault, type AccountSignet, type AccountType, type AccountWatchOnly, type AddAccountDeriveOptions, type AddAccountExternalOptions, type AddAccountKeypairOptions, type AddMnemonicOptions, Keyring, type KeyringStorage, type LedgerPolkadotCurve, type Mnemonic, type UpdateAccountOptions, type UpdateMnemonicOptions, getAccountGenesisHash, getAccountPlatform, getAccountSignetUrl, isAccountAddressEthereum, isAccountAddressSs58, isAccountBitcoin, isAccountExternal, isAccountInTypes, isAccountLedgerPolkadot, isAccountLedgerPolkadotGeneric, isAccountLedgerPolkadotLegacy, isAccountNotContact, isAccountOfType, isAccountOwned, isAccountPlatformEthereum, isAccountPlatformPolkadot, isAccountPlatformSolana, isAccountPortfolio };
+//#endregion
+export { Account, AccountBase, AccountContact, AccountKeypair, AccountLedgerEthereum, AccountLedgerPolkadot, AccountLedgerSolana, AccountOfType, AccountPolkadotVault, AccountSignet, AccountType, AccountWatchOnly, AddAccountDeriveOptions, AddAccountExternalOptions, AddAccountKeypairOptions, AddMnemonicOptions, Keyring, KeyringStorage, LedgerPolkadotCurve, Mnemonic, UpdateAccountOptions, UpdateMnemonicOptions, getAccountGenesisHash, getAccountPlatform, getAccountSignetUrl, isAccountAddressEthereum, isAccountAddressSs58, isAccountBitcoin, isAccountExternal, isAccountInTypes, isAccountLedgerPolkadot, isAccountLedgerPolkadotGeneric, isAccountLedgerPolkadotLegacy, isAccountNotContact, isAccountOfType, isAccountOwned, isAccountPlatformEthereum, isAccountPlatformPolkadot, isAccountPlatformSolana, isAccountPortfolio };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types/account.ts","../src/types/keyring.ts","../src/types/mnemonic.ts","../src/types/utils.ts","../src/keyring/types.ts","../src/keyring/Keyring.ts"],"mappings":";;KAEY;KAEA;EAIV;EACA;EACA;;KAGU,iBAAiB;EAC3B;EACA,OAAO;EACP;EACA;;KAGU,iBAAiB;EAC3B;EACA;;KAGU,mBAAmB;EAC7B;EACA;;KAGU,wBAAwB;EAClC;EACA,OAAO;EACP;EACA;EACA;EACA;;KAGU,wBAAwB;EAClC;EACA;;KAGU,sBAAsB;EAChC;EACA;;KAGU,uBAAuB;EACjC;EACA;;KAGU,gBAAgB;EAC1B;EACA;EACA;;KAsBU,UACR,iBACA,iBACA,mBACA,wBACA,wBACA,sBACA,uBACA;KAEQ,cAAc;;;KC5Ed;EACV;EACA;EACA;;KAGU;EACV;EACA;;KAGG;EACH;EACA;EACA;EACA;EACA,OAAO;EACP;;KAGG;EACH;EACA;EACA,OAAO;EACP;;KAGG,4BAA4B,wBAAwB;KAE7C,0BAA0B,KAAK,wCACzC;KAEU,2BAA2B,KAAK;EAC1C,OAAO;EACP,WAAW;;KAGD,4BACR,KAAK,+BACL,KAAK,iCACL,KAAK,sCACL,KAAK,sCACL,KAAK,oCACL,KAAK,qCACL,KAAK;KAEG;EACV;EACA;EACA;;;;KC9DU;EACV;EACA;EACA;EACA;;;;KCOU,cAAc,aAAa,eAAe,QAAQ;EAAW,MAAM;;cAElE,kBAAmB,aAAa,aAAW,SAC7C,4BAA0B,MAC7B,SACL,WAAW,cAAc;cAIf,mBAAoB,cAAc,eAAa,SACjD,4BAA0B,OAC5B,UACN,WAAW,cAAc;cAItB;cAQA;cAUA;cAQA;cAOA;cASA;cASA;cAEA;cAEO,oBAAiB,SACnB,+BACR,WAAW,sBAAsB;cAIvB,iBAAc,SAChB,+BACR,WAAW,sBAAsB;cAIvB,qBAAkB,SAAa,+BAA6B,WAAW;cAIvE,sBAAmB,KAAS,YAAO,OAAP,iBAAO,wBAAA,wBAAA,sBAAA,uBAAA,gBAAA;KAE3C,yBAAyB,QAC5B;EACE,cAAc;;EAEhB;;cAEW,2BAAwB,SAC1B,+BACR,WAAW;KAIT,0BAA0B,QAC7B;EACE,cAAc;;EAEhB;;cAEW,4BAAyB,SAC3B,+BACR,WAAW;KAIT,wBAAwB,QAC3B;EACE,cAAc;;cAGL,0BAAuB,SACzB,+BACR,WAAW;KAIT,0BAA0B,QAC7B;EACE,cAAc;;cAEL,4BAAyB,SAC3B,+BACR,WAAW;KAQT,qBAAqB,QACxB;EACE,cAAc;;EAEhB;;cAEW,uBAAoB,SACtB,+BACR,WAAW;cAID,0BAAuB,SACzB,+BACR,WAAW;cAID,iCAA8B,SAChC,+BACR,WAAW;EAA0B;;cAI3B,gCAA6B,SAC/B,+BACR,WAAW;EAA0B;;KAInC,iBAAiB,QAAQ;EAAW,cAAc;;cAC1C,mBAAgB,SAClB,+BACR,WAAW;cAID,wBAAqB,SAAa;cAKlC,sBAAmB,SAAa;cAIhC,qBAAkB,SAAa,yDAA0B;;;KCrL1D,kBAAkB;EAC5B;;KAGU,wBAAwB;EAClC;;KAGU,iBACR,wBACA,iBACA,mBACA,wBACA,wBACA,sBACA,uBACA;;;KCCQ;EACV;EACA,WAAW;EACX,UAAU;;cAGC;;YAGF,YAAa,MAAM;SAId,UAAU;SAQV,KAAK,MAAM,iBAAiB;UAY5B;;EAsBP;;;;;;EASM,eAAe,mBAAmB;;;;;EAgBlC,mBAAmB,mBAAmB;EAO5C,UAAM;EAIA,OAAO,kBAAkB,uBAAuB,QAAQ;EAoB9D,gBAAgB;EAIV,cACT,MAAM,UAAU,aAAa,oBAC/B,mBACC,QAAQ;EA4BJ,YAAY,aAAa;EAKzB,eAAe,cAAc,MAAM,aAAa,wBAAqB;EAcrE,eAAe;EAMhB,gBAAgB,YAAY,mBAAmB;EAS9C,sBAAsB;EAMtB,eAAe;EAIf,WAAW,kBAAkB;EAK7B,cAAc,mBAAmB,MAAM,aAAa,eAAe,uBAAoB;EAuBvF,cAAc;EAMd,mBAAmB,SAAS,4BAA4B;;;;;;;;;;UA2BjD;EAiCD,iBACX,SAAS,yBACT,mBACC,QAAQ;EAgCE,oBACT,OAAO,MAAM,aAAa,0BAC5B,mBACC,QAAQ;EAuBJ,oBAAoB,iBAAiB,mBAAmB,QAAQ;EAW1D,kBACX,oBACA,wBACA,OAAO,cACP,mBACC"}