@bitgo-beta/sdk-core 8.2.1-beta.112 → 8.2.1-beta.1121

package/dist/src/bitgo/wallet/wallets.d.ts

@@ -1,7 +1,11 @@
 import { IBaseCoin } from '../baseCoin';
 import { BitGoBase } from '../bitgoBase';
-import { AcceptShareOptions, AddWalletOptions, GenerateWalletOptions, GetWalletByAddressOptions, GetWalletOptions, IWallets, ListWalletOptions, UpdateShareOptions, WalletWithKeychains } from './iWallets';
+import { AcceptShareOptions, AcceptShareOptionsRequest, AddWalletOptions, BulkAcceptShareOptions, BulkAcceptShareResponse, BulkUpdateWalletShareOptions, BulkUpdateWalletShareOptionsRequest, BulkUpdateWalletShareResponse, GenerateWalletOptions, GetWalletByAddressOptions, GetWalletOptions, IWallets, LightningWalletWithKeychains, ListWalletOptions, UpdateShareOptions, WalletShares, WalletWithKeychains } from './iWallets';
 import { Wallet } from './wallet';
+/**
+ * Check if a wallet is a WalletWithKeychains
+ */
+export declare function isWalletWithKeychains(wallet: WalletWithKeychains | LightningWalletWithKeychains): wallet is WalletWithKeychains;
 export declare class Wallets implements IWallets {
     private readonly bitgo;
     private readonly baseCoin;
@@ -16,7 +20,9 @@ export declare class Wallets implements IWallets {
      * @param params
      * @returns {*}
      */
-    list(params?: ListWalletOptions): Promise<{
+    list(params?: ListWalletOptions & {
+        enterprise?: string;
+    }): Promise<{
         wallets: Wallet[];
     }>;
     /**
@@ -30,6 +36,7 @@ export declare class Wallets implements IWallets {
      *    "keys": array of keychain ids
      */
     add(params: AddWalletOptions): Promise<any>;
+    private generateLightningWallet;
     /**
      * Generate a new wallet
      * 1. Creates the user keychain locally on the client, and encrypts it with the provided passphrase
@@ -38,28 +45,40 @@ export declare class Wallets implements IWallets {
      * 4. Creates the BitGo key on the service
      * 5. Creates the wallet on BitGo with the 3 public keys above
      * @param params
-     * @param params.label
-     * @param params.passphrase
+     * @param params.label Label for the wallet
+     * @param params.passphrase Passphrase to be used to encrypt the user and backup keychains
      * @param params.userKey User xpub
      * @param params.backupXpub Backup xpub
      * @param params.backupXpubProvider
-     * @param params.backupProvider Third party backup provider for TSS
-     * @param params.enterprise
+     * @param params.enterprise the enterpriseId
      * @param params.disableTransactionNotifications
-     * @param params.passcodeEncryptionCode
-     * @param params.coldDerivationSeed
+     * @param params.passcodeEncryptionCode optional this is a recovery code that can be used to decrypt the original passphrase in a recovery case.
+     *                                      The user must generate and keep the encrypted original passphrase safe while this code is stored on BitGo
+     * @param params.coldDerivationSeed optional seed for SMC wallets
      * @param params.gasPrice
      * @param params.disableKRSEmail
      * @param params.walletVersion
      * @param params.multisigType optional multisig type, 'onchain' or 'tss' or 'blsdkg'; if absent, we will defer to the coin's default type
+     * @param params.isDistributedCustody optional parameter for creating bitgo key. This is only necessary if you want to create
+     *                                    a distributed custody wallet. If provided, you must have the enterprise license and pass in
+     *                                    `params.enterprise` into `generateWallet` as well.
+     * @param params.type optional wallet type, 'hot' or 'cold' or 'custodial'; if absent, we will defer to 'hot'
+     * @param params.bitgoKeyId optional bitgo key id for SMC TSS wallets
+     * @param params.commonKeychain optional common keychain for SMC TSS wallets
+     *
      * @returns {*}
      */
-    generateWallet(params?: GenerateWalletOptions): Promise<WalletWithKeychains>;
+    generateWallet(params?: GenerateWalletOptions): Promise<WalletWithKeychains | LightningWalletWithKeychains>;
     /**
      * List the user's wallet shares
      * @param params
      */
     listShares(params?: Record<string, unknown>): Promise<any>;
+    /**
+     * List the user's wallet shares v2
+     * @returns {Promise<WalletShares>}
+     */
+    listSharesV2(): Promise<WalletShares>;
     /**
      * Gets a wallet share information, including the encrypted sharing keychain. requires unlock if keychain is present.
      * @param params
@@ -75,6 +94,14 @@ export declare class Wallets implements IWallets {
      * @param params
      */
     updateShare(params?: UpdateShareOptions): Promise<any>;
+    /**
+     * Bulk accept wallet shares
+     * @param params AcceptShareOptionsRequest[]
+     * @returns {Promise<BulkAcceptShareResponse>}
+     */
+    bulkAcceptShareRequest(params: AcceptShareOptionsRequest[]): Promise<BulkAcceptShareResponse>;
+    private bulkAcceptShareRequestWithRetry;
+    bulkUpdateWalletShareRequest(params: BulkUpdateWalletShareOptionsRequest[]): Promise<BulkUpdateWalletShareResponse>;
     /**
      * Resend a wallet share invitation email
      * @param params
@@ -91,6 +118,12 @@ export declare class Wallets implements IWallets {
     cancelShare(params?: {
         walletShareId?: string;
     }): Promise<any>;
+    /**
+     * Re-share wallet with existing spenders of the wallet
+     * @param walletId
+     * @param userPassword
+     */
+    reshareWalletWithSpenders(walletId: string, userPassword: string): Promise<void>;
     /**
      * Accepts a wallet share, adding the wallet to the user's list
      * Needs a user's password to decrypt the shared key
@@ -104,6 +137,48 @@ export declare class Wallets implements IWallets {
      * @param params.overrideEncryptedPrv - set only if the prv was received out-of-band.
      */
     acceptShare(params?: AcceptShareOptions): Promise<any>;
+    /**
+     * Bulk Accept wallet shares, adding the wallets to the user's list
+     * Needs a user's password to decrypt the shared key
+     *
+     * @param params BulkAcceptShareOptions
+     * @param params.walletShareId - array of the wallet shares to accept
+     * @param params.userPassword - user's password to decrypt the shared wallet key
+     * @param params.newWalletPassphrase - new wallet passphrase for saving the shared wallet prv.
+     *                                     If left blank then the user's login password is used.
+     *
+     *@returns {Promise<BulkAcceptShareResponse>}
+     */
+    bulkAcceptShare(params: BulkAcceptShareOptions): Promise<BulkAcceptShareResponse>;
+    /**
+     * Updates multiple wallet shares in bulk
+     * This method allows users to accept or reject multiple wallet shares in a single operation.
+     * It handles different types of wallet shares including those requiring special keychain overrides
+     * and those with encrypted private keys that need to be decrypted and re-encrypted.
+     * After processing, it also reshares accepted wallets with spenders for special override cases.
+     *
+     * @param params - Options for bulk updating wallet shares
+     * @param params.shares - Array of wallet shares to update with their status (accept/reject)
+     * @param params.userLoginPassword - User's login password for decryption operations
+     * @param params.newWalletPassphrase - New wallet passphrase for re-encryption
+     * @returns Array of responses for each wallet share update
+     */
+    bulkUpdateWalletShare(params: BulkUpdateWalletShareOptions): Promise<BulkUpdateWalletShareResponse>;
+    /**
+     * Process a wallet share that is being accepted
+     * This method handles the different cases for accepting a wallet share:
+     * 1. Special override case requiring user keychain and signing
+     * 2. Simple case with no keychain to decrypt
+     * 3. Standard case requiring decryption and re-encryption
+     *
+     * @param walletShareId - ID of the wallet share
+     * @param walletShare - Wallet share object
+     * @param userLoginPassword - User's login password
+     * @param newWalletPassphrase - New wallet passphrase
+     * @param sharingKeychainPrv - Decrypted sharing keychain private key
+     * @returns Array of wallet share update requests
+     */
+    private processAcceptShare;
     /**
      * Get a wallet by its ID
      * @param params
@@ -131,5 +206,18 @@ export declare class Wallets implements IWallets {
      * @private
      */
     private generateMpcWallet;
+    /**
+     * Generates a Self-Managed Cold TSS Wallet.
+     * @param params
+     * @private
+     */
+    private generateSMCMpcWallet;
+    /**
+     * Generates a Custodial TSS Wallet.
+     * @param params
+     * @private
+     */
+    private generateCustodialMpcWallet;
+    private determineEcdsaMpcWalletVersion;
 }
 //# sourceMappingURL=wallets.d.ts.map

package/dist/src/bitgo/wallet/wallets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/wallet/wallets.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAqD,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAEhB,qBAAqB,EACrB,yBAAyB,EACzB,gBAAgB,EAChB,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,qBAAa,OAAQ,YAAW,QAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;gBAEzB,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS;IAKjD;;;OAGG;IACG,GAAG,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzD;;;;OAIG;IACG,IAAI,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAsC1E;;;;;;;;;OASG;IACG,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAuDjD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,cAAc,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAyQtF;;;OAGG;IACG,UAAU,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE;;;;OAIG;IACG,QAAQ,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAMrE;;;;;OAKG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAShE;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9E;;;;OAIG;IACG,WAAW,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IASxE;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IA4DhE;;;;;OAKG;IACG,SAAS,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB/D;;;;;OAKG;IACG,kBAAkB,CAAC,MAAM,GAAE,yBAA8B,GAAG,OAAO,CAAC,MAAM,CAAC;IASjF;;;;;OAKG;IACG,gBAAgB,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE;;;;OAIG;YACW,iBAAiB;CA4ChC"}
+{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/wallet/wallets.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,SAAS,EAAqD,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,4BAA4B,EAC5B,mCAAmC,EACnC,6BAA6B,EAM7B,qBAAqB,EACrB,yBAAyB,EACzB,gBAAgB,EAChB,QAAQ,EACR,4BAA4B,EAC5B,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,mBAAmB,GAAG,4BAA4B,GACzD,MAAM,IAAI,mBAAmB,CAE/B;AAED,qBAAa,OAAQ,YAAW,QAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;gBAEzB,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS;IAKjD;;;OAGG;IACG,GAAG,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzD;;;;OAIG;IACG,IAAI,CAAC,MAAM,GAAE,iBAAiB,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IASpG;;;;;;;;;OASG;IACG,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;YAmEnC,uBAAuB;IAmDrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,cAAc,CAClB,MAAM,GAAE,qBAA0B,GACjC,OAAO,CAAC,mBAAmB,GAAG,4BAA4B,CAAC;IA4V9D;;;OAGG;IACG,UAAU,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC;IAI3C;;;;OAIG;IACG,QAAQ,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAMrE;;;;;OAKG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAShE;;;;OAIG;IACG,sBAAsB,CAAC,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,uBAAuB,CAAC;YAIrF,+BAA+B;IA8DvC,4BAA4B,CAChC,MAAM,EAAE,mCAAmC,EAAE,GAC5C,OAAO,CAAC,6BAA6B,CAAC;IASzC;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9E;;;;OAIG;IACG,WAAW,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IASxE;;;;OAIG;IACG,yBAAyB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCtF;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAsGhE;;;;;;;;;;;OAWG;IACG,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAgEvF;;;;;;;;;;;;OAYG;IACG,qBAAqB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAoKzG;;;;;;;;;;;;;OAaG;YACW,kBAAkB;IA0FhC;;;;;OAKG;IACG,SAAS,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAwB/D;;;;;OAKG;IACG,kBAAkB,CAAC,MAAM,GAAE,yBAA8B,GAAG,OAAO,CAAC,MAAM,CAAC;IASjF;;;;;OAKG;IACG,gBAAgB,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE;;;;OAIG;YACW,iBAAiB;IA0D/B;;;;OAIG;YACW,oBAAoB;IAuFlC;;;;OAIG;YACW,0BAA0B;IAyCxC,OAAO,CAAC,8BAA8B;CAQvC"}