@bitgo-beta/sdk-core 8.2.1-beta.21 → 8.2.1-beta.2100

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

@@ -1,11 +1,20 @@
-import { IBaseCoin, SignedMessage, SignedTransaction } from '../baseCoin';
+/**
+ * @prettier
+ */
+import { type AddressQueryResult } from '@bitgo/public-types';
+import { EncryptionVersion, IRequestTracer } from '../../api';
+import { IAddressBook } from '../address-book';
+import { IBaseCoin, NFTTransferOptions, SignedMessage, SignedTransaction } from '../baseCoin';
 import { BitGoBase } from '../bitgoBase';
+import { SubmitTransactionResponse } from '../inscriptionBuilder';
+import { KeychainWithEncryptedPrv } from '../keychain';
+import { CreateLightningInvoiceParams, LightningInvoiceResponse } from '../../lightning';
 import { IPendingApproval } from '../pendingApproval';
-import { TradingAccount } from '../trading/tradingAccount';
+import { DefiVault } from '../defi';
+import { GoStakingWallet, StakingWallet } from '../staking';
+import { TradingAccount } from '../trading';
 import { TxRequest } from '../utils';
-import { AccelerateTransactionOptions, AddressesOptions, BuildConsolidationTransactionOptions, BuildTokenEnablementOptions, ChangeFeeOptions, ConsolidateUnspentsOptions, CreateAddressOptions, CreatePolicyRuleOptions, CreateShareOptions, CrossChainUTXO, DeployForwardersOptions, DownloadKeycardOptions, FanoutUnspentsOptions, FetchCrossChainUTXOsOptions, FlushForwarderTokenOptions, ForwarderBalance, ForwarderBalanceOptions, FreezeOptions, FundForwardersOptions, GetAddressOptions, GetPrvOptions, GetTransactionOptions, GetTransferOptions, GetUserPrvOptions, IWallet, MaximumSpendable, MaximumSpendableOptions, ModifyWebhookOptions, PaginationOptions, PrebuildAndSignTransactionOptions, PrebuildTransactionOptions, PrebuildTransactionResult, RecoverTokenOptions, RemovePolicyRuleOptions, RemoveUserOptions, SendManyOptions, SendOptions, ShareWalletOptions, SimulateWebhookOptions, SubmitTransactionOptions, SweepOptions, TransferBySequenceIdOptions, TransferCommentOptions, TransfersOptions, UnspentsOptions, UpdateAddressOptions, WalletCoinSpecific, WalletData, WalletEcdsaChallenges, WalletSignMessageOptions, WalletSignTransactionOptions, WalletSignTypedDataOptions } from './iWallet';
-import { StakingWallet } from '../staking/stakingWallet';
-import { Lightning } from '../lightning';
+import { AccelerateTransactionOptions, AddressesByBalanceOptions, AddressesOptions, BuildConsolidationTransactionOptions, BuildResourceDelegationTransactionOptions, BuildResourceManagementTransactionResult, BuildResourceUndelegationTransactionOptions, ResourceManagementSendResult, BuildTokenEnablementOptions, BulkCreateShareOption, BulkWalletShareKeychain, BulkWalletShareOptions, ChangeFeeOptions, ConsolidateUnspentsOptions, CreateAddressOptions, CreateBulkWalletShareListResponse, CreatePolicyRuleOptions, CreateShareOptions, CrossChainUTXO, DecryptedKeychainData, DeployForwardersOptions, DownloadKeycardOptions, FanoutUnspentsOptions, FetchCrossChainUTXOsOptions, FlushForwarderTokenOptions, ForwarderBalance, ForwarderBalanceOptions, FreezeOptions, FundForwarderParams, FundForwardersOptions, GetAddressOptions, GetPrvOptions, GetPotentialStuckTxsOptions, GetPotentialStuckTxsResult, GetTransactionOptions, GetTransferOptions, GetUserPrvOptions, type IWallet, ManageUnspentReservationOptions, MaximumSpendable, MaximumSpendableOptions, ModifyWebhookOptions, NftBalance, PaginationOptions, PrebuildAndSignTransactionOptions, PrebuildTransactionOptions, PrebuildTransactionResult, RecoverTokenOptions, RemovePolicyRuleOptions, RemoveUserOptions, SendManyOptions, SendNFTOptions, SendNFTResult, SendOptions, SharedKeyChain, ShareWalletOptions, SignAndSendTxRequestOptions, SignAndSendMessageTxRequestOptions, SimulateWebhookOptions, SubmitTransactionOptions, SubWalletType, SweepOptions, TransferBySequenceIdOptions, TransferCommentOptions, TransfersOptions, UnspentsOptions, UpdateAddressOptions, UpdateBuildDefaultOptions, UpdateWalletOptions, UpgradeEncryptionOptions, UpgradeEncryptionResult, VerifyKeyOptions, VerifyKeyResult, WalletCoinSpecific, WalletData, WalletEcdsaChallenges, WalletSignMessageOptions, WalletSignTransactionOptions, WalletSignTypedDataOptions, WalletType, BuildTokenApprovalResponse, WalletInitResult, GetAccountResourcesOptions, GetAccountResourcesResponse, GetResourceDelegationsOptions, GetResourceDelegationsResponse } from './iWallet';
 export declare enum ManageUnspentsOptions {
     BUILD_ONLY = 0,
     BUILD_SIGN_SEND = 1
@@ -14,8 +23,11 @@ export declare class Wallet implements IWallet {
     readonly bitgo: BitGoBase;
     readonly baseCoin: IBaseCoin;
     _wallet: WalletData;
+    private _defi?;
     private readonly tssUtils;
     private readonly _permissions?;
+    /** Root keychain from passphrase preflight; consumed by getUserPrv to avoid a second GET. */
+    private validatedSafeRootKeychain?;
     constructor(bitgo: BitGoBase, baseCoin: IBaseCoin, walletData: any);
     /**
      * Build a URL using this wallet's id which can be used for BitGo API operations
@@ -34,6 +46,7 @@ export declare class Wallet implements IWallet {
      * Get the current balance of this wallet
      */
     balance(): number;
+    /** @deprecated use codec instead: t.exact(BuildParams).encode(v) */
     prebuildWhitelistedParams(): string[];
     /**
      * This is a strict sub-set of prebuildWhitelistedParams
@@ -69,10 +82,24 @@ export declare class Wallet implements IWallet {
      * Get the coin identifier for the type of coin this wallet holds
      */
     coin(): string;
+    type(): WalletType;
+    multisigType(): 'onchain' | 'tss';
+    multisigTypeVersion(): 'MPCv2' | undefined;
+    /**
+     * Public id of the parent safe, if this wallet was minted in one.
+     * @experimental
+     */
+    safeId(): string | undefined;
+    subType(): SubWalletType | undefined;
     /**
      * Get the label (name) for this wallet
      */
     label(): string;
+    flags(): {
+        name: string;
+        value: string;
+    }[];
+    flag(name: string): string | undefined;
     /**
      * Get the public object ids for the keychains on this wallet.
      */
@@ -80,7 +107,7 @@ export declare class Wallet implements IWallet {
     /**
      * Get a receive address for this wallet
      */
-    receiveAddress(): string;
+    receiveAddress(): string | undefined;
     /**
      * Get the wallet id of the wallet that this wallet was migrated from.
      *
@@ -113,6 +140,31 @@ export declare class Wallet implements IWallet {
      * @returns {*}
      */
     transactions(params?: PaginationOptions): Promise<any>;
+    /**
+     * List potentially stuck transactions for this wallet.
+     * Age thresholds are opt-in; when both are supplied, the API uses OR semantics.
+     */
+    getPotentialStuckTxs(params?: GetPotentialStuckTxsOptions): Promise<GetPotentialStuckTxsResult[]>;
+    /**
+     * Return a list of nft tokens for this wallet. Will always return undefined if the wallet
+     * was not initialized with the allTokens flag.
+     *
+     * @returns {NftBalance[] | undefined}
+     */
+    nftBalances(): NftBalance[] | undefined;
+    /**
+     * Return a list of unsupported nft tokens for this wallet. Will always return undefined if the wallet
+     * was not initialized with the allTokens flag.
+     *
+     * @returns {NftBalance[] | undefined}
+     */
+    unsupportedNftBalances(): NftBalance[] | undefined;
+    /**
+     * Returns a list of the wallets nft & unsupported nfts.
+     *
+     * @returns {NftBalance[]}
+     */
+    getNftBalances(): Promise<NftBalance[]>;
     /**
      * List the transactions for a given wallet
      * @param params
@@ -187,8 +239,25 @@ export declare class Wallet implements IWallet {
      *                  - maximum number of unspents you want to use in the transaction
      * Output parameters:
      * @param {Number} params.numUnspentsToMake - the number of new unspents to make
+     * @param {Boolean} params.bulk - if set to True, this enables the consolidation of large number of unspents by creating multiple transactions,
+     *                                with each transaction composed of 200 unspents, except for the last transaction which may have fewer unspents.
      */
     private manageUnspents;
+    /**
+     * Manage the unspent reservations on the wallet
+     *
+     * @param params.create - create a new reservation
+     * @param params.modify - modify an existing reservation
+     * @param params.delete - delete an existing reservation
+     */
+    manageUnspentReservations(params: ManageUnspentReservationOptions): Promise<{
+        unspents: {
+            id: string;
+            walletId: string;
+            expireTime: string;
+            userId?: string;
+        }[];
+    }>;
     /**
      * Consolidate unspents on a wallet
      *
@@ -207,9 +276,11 @@ export declare class Wallet implements IWallet {
      * @param {Number} params.limit                for routeName === 'consolidate'
      *                 params.maxNumInputsToUse    for routeName === 'fanout'
      *                  - maximum number of unspents you want to use in the transaction
-     * @param {Number} params.numUnspentsToMake - the number of new unspents to make
+     * @param {Number} params.numUnspentsToMake - the number of new unspents to make. It is not applicable for if bulk consolidate.
+     * @param {Boolean} params.bulk - if set to True, this enables the consolidation of large number of unspents by creating multiple transactions,
+     *                                with each transaction composed of 200 unspents, except for the last transaction which may have fewer unspents.
      */
-    consolidateUnspents(params?: ConsolidateUnspentsOptions, option?: ManageUnspentsOptions): Promise<any>;
+    consolidateUnspents(params?: ConsolidateUnspentsOptions, option?: ManageUnspentsOptions): Promise<unknown>;
     /**
      * Fanout unspents on a wallet
      *
@@ -226,8 +297,10 @@ export declare class Wallet implements IWallet {
      * @param {Number} params.maxFeeRate - The max limit for a fee rate in satoshis/kB
      * @param {Number} params.maxNumInputsToUse - the number of unspents you want to use in the transaction
      * @param {Number} params.numUnspentsToMake - the number of new unspents to make
+     *
+     * @param {ManageUnspentsOptions} option - flag to toggle build and send or build only
      */
-    fanoutUnspents(params?: FanoutUnspentsOptions): Promise<any>;
+    fanoutUnspents(params?: FanoutUnspentsOptions, option?: ManageUnspentsOptions): Promise<unknown>;
     /**
      * Set the token flush thresholds for the wallet. Updates the wallet.
      * Tokens will only be flushed from forwarder contracts if the balance is greater than the threshold defined here.
@@ -300,7 +373,13 @@ export declare class Wallet implements IWallet {
      * @param params
      * @returns {*}
      */
-    addresses(params?: AddressesOptions): Promise<any>;
+    addresses(params?: AddressesOptions): Promise<AddressQueryResult>;
+    /**
+     * List the addresses sorted by balance for a given wallet
+     * @param params
+     * @returns {*}
+     */
+    addressesByBalance(params: AddressesByBalanceOptions): Promise<any>;
     /**
      * Get a single wallet address by its id
      * @param params
@@ -334,6 +413,20 @@ export declare class Wallet implements IWallet {
      * @returns {*}
      */
     updateAddress(params?: UpdateAddressOptions): Promise<any>;
+    /**
+     * Get account resources for the given addresses
+     * @param params - options object containing addresses and optional destinationAddress
+     * @returns {Promise<GetAccountResourcesResponse>} - response from WP API
+     */
+    getAccountResources(params: GetAccountResourcesOptions): Promise<GetAccountResourcesResponse>;
+    /**
+     * Get resource delegations for this wallet
+     * @param params - optional filters: type, resource, limit, nextBatchPrevId
+     * @returns {Promise<GetResourceDelegationsResponse>} - response from WP API
+     */
+    getResourceDelegations(params?: GetResourceDelegationsOptions): Promise<GetResourceDelegationsResponse>;
+    updateWalletBuildDefaults(params: UpdateBuildDefaultOptions): Promise<unknown>;
+    updateWallet(params: UpdateWalletOptions): Promise<unknown>;
     /**
      * List webhooks on this wallet
      * @param params
@@ -359,15 +452,13 @@ export declare class Wallet implements IWallet {
      */
     removeWebhook(params?: ModifyWebhookOptions): Promise<any>;
     /**
-     * Gets the user key chain for this wallet
+     * Gets the user keychain for this wallet
      *
-     * The user key chain is the first keychain of the wallet and usually has the encrypted prv stored on BitGo.
+     * The user keychain is the first keychain of the wallet and usually has the encrypted prv stored on BitGo.
      * Useful when trying to get the users' keychain from the server before decrypting to sign a transaction.
-     * @param params
      */
-    getEncryptedUserKeychain(params?: Record<string, never>): Promise<{
-        encryptedPrv: string;
-    }>;
+    getEncryptedUserKeychain(): Promise<KeychainWithEncryptedPrv>;
+    private getSafeOwnerChildKeychain;
     /**
      * Gets the unencrypted private key for this wallet (be careful!)
      * Requires wallet passphrase
@@ -375,11 +466,84 @@ export declare class Wallet implements IWallet {
      * @param params
      */
     getPrv(params?: GetPrvOptions): Promise<any>;
+    private isMultiUserKeyWallet;
     /**
      * Send an encrypted wallet share to BitGo.
      * @param params
      */
     createShare(params?: CreateShareOptions): Promise<any>;
+    /**
+     * Shares a wallet with multiple users by creating bulk wallet shares.
+     *
+     * @async
+     * @param {BulkWalletShareOptions} params - The options for sharing wallets in bulk.
+     * @param {Array<ShareOption>} params.shareOptions - An array of share option objects containing user and permissions information.
+     * @param {Object} [params.shareOptions[].keychain] - The keychain object used to share the wallet.
+     * @param {string} [params.shareOptions[].keychain.toPubKey] - The recipient's public key.
+     * @param {string} [params.shareOptions[].keychain.path] - The derivation path of the keychain.
+     * @param {string} params.shareOptions[].user - The user to share the wallet with.
+     * @param {string} params.shareOptions[].permissions - The permissions granted to the user.
+     * @param {string} [params.walletPassphrase] - The wallet passphrase used to decrypt the keychain.
+     * @throws {Error} If `shareOptions` is empty, or if required keychain parameters (`toPubKey` and `path`) are missing when needed.
+     * @throws {Error} If unable to decrypt the user keychain.
+     * @returns {Promise<CreateBulkWalletShareListResponse>} A promise that resolves with the response of the bulk wallet share creation.
+     */
+    createBulkWalletShare(params: BulkWalletShareOptions): Promise<CreateBulkWalletShareListResponse>;
+    /**
+     * Creates bulk wallet share entries for specified share options.
+     * Filters out share options that do not contain valid keychain information or have missing keychain fields.
+     * If all share options are invalid or empty, it throws an error.
+     * Sends a POST request to create the wallet shares for valid share options.
+     *
+     * @async
+     * @param {BulkCreateShareOption[]} [params=[]] - The array of share options to process.
+     *   Keychain entries must include the following fields: `pub`, `encryptedPrv`, `fromPubKey`, `toPubKey`, and `path`.
+     * @returns {Promise<CreateBulkWalletShareListResponse>} A promise resolving to the result of the wallet shares creation.
+     * @throws {Error} Throws an error if no valid share options are provided.
+     */
+    createBulkKeyShares(params?: BulkCreateShareOption[]): Promise<CreateBulkWalletShareListResponse>;
+    /**
+     * Gets keychain with encrypted private key to be shared for wallet sharing.
+     */
+    private getEncryptedWalletKeychainForWalletSharing;
+    /**
+     * Fetches and decrypts the wallet keychain for sharing.
+     * This method fetches the keychain once and decrypts it, returning the decrypted
+     * private key and public key info needed for sharing with multiple users.
+     *
+     * @param walletPassphrase - The passphrase to decrypt the keychain
+     * @returns Object containing decrypted prv and pub, or undefined for cold wallets
+     */
+    getDecryptedKeychainForSharing(walletPassphrase: string | undefined): Promise<DecryptedKeychainData | undefined>;
+    /**
+     * Encrypts a decrypted private key for sharing with a specific user.
+     * This is the pure encryption step - no API calls, no decryption.
+     *
+     * @param decryptedPrv - The already-decrypted private key
+     * @param pub - The wallet's public key
+     * @param userPubkey - The recipient user's public key
+     * @param path - The key path
+     * @param encryptionVersion - Deprecated and ignored because the shared key is high entropy.
+     * @returns The encrypted keychain for the recipient with all required fields
+     */
+    encryptPrvForUser(decryptedPrv: string, pub: string, userPubkey: string, path: string, 
+    /** @deprecated Ignored because the shared key is high entropy. */
+    encryptionVersion?: EncryptionVersion): Promise<BulkWalletShareKeychain>;
+    private rethrowUnlessColdWalletShare;
+    /**
+     * Prepares a keychain for sharing with another user.
+     * Fetches the wallet keychain, decrypts it, and encrypts it for the recipient.
+     *
+     * @param walletPassphrase - The passphrase to decrypt the keychain
+     * @param pubkey - The recipient's public key
+     * @param path - The key path
+     * @param encryptionVersion - Deprecated and ignored because the shared key is high entropy.
+     * @param decryptedKeychain - Pre-decrypted keychain for bulk sharing
+     * @returns The encrypted keychain for the recipient
+     */
+    prepareSharedKeychain(walletPassphrase: string | undefined, pubkey: string, path: string, 
+    /** @deprecated Ignored because the shared key is high entropy. */
+    encryptionVersion?: EncryptionVersion, decryptedKeychain?: DecryptedKeychainData): Promise<SharedKeyChain>;
     /**
      * Share this wallet with another BitGo user.
      * @param params
@@ -429,12 +593,25 @@ export declare class Wallet implements IWallet {
      * @returns {*}
      */
     prebuildTransaction(params?: PrebuildTransactionOptions): Promise<PrebuildTransactionResult>;
+    /**
+     * Gets the User Keychain and sign a TSS transaction
+     * @param txRequestId The transaction request id
+     * @param walletPassphrase The wallet passphrase
+     * @return Promise<SignedTransaction>
+     */
+    getUserKeyAndSignTssTransaction({ txRequestId, walletPassphrase, }: {
+        txRequestId: string;
+        walletPassphrase: string;
+    }): Promise<SignedTransaction>;
     /**
      * Sign a transaction
      * @param params
      * - txPrebuild
      * - [keychain / key] (object) or prv (string)
-     * - walletPassphrase
+     * - walletPassphrase (optional ONLY for OFC wallets with userKeySigningRequired = false)
+     * - verifyTxParams (optional) - when provided, the transaction will be verified before signing
+     *   - txParams: transaction parameters used for verification
+     *   - verification: optional verification options
      * @return {*}
      */
     signTransaction(params?: WalletSignTransactionOptions): Promise<SignedTransaction | TxRequest>;
@@ -451,28 +628,60 @@ export declare class Wallet implements IWallet {
      */
     signMessage(params?: WalletSignMessageOptions): Promise<SignedMessage>;
     /**
-     * Get the user private key from either a derivation or an encrypted keychain
+     * Prepares and creates a sign message request for TSS wallets, that can be used later for signing.
+     *
+     * @param params - Parameters for creating the sign message request
+     * @returns Promise<TxRequest> - The created transaction request for signing a message
+     */
+    buildSignMessageRequest(params: WalletSignMessageOptions): Promise<TxRequest>;
+    /**
+     * Get the user private key from either a derivation or an encrypted keychain.
+     * Supports both v1 (SJCL) and v2 (Argon2id) envelopes.
      * @param [params.keychain / params.key] (object) or params.prv (string)
      * @param params.walletPassphrase (string)
      */
-    getUserPrv(params?: GetUserPrvOptions): string;
+    getUserPrv(params?: GetUserPrvOptions): Promise<string>;
+    /**
+     * Verify that user-held TSS signing material belongs to this wallet.
+     *
+     * Recombines the shares locally and compares the result against the user keychain's
+     * `commonKeychain`, answering up front whether the material can sign for this wallet
+     * instead of discovering a mismatch only when a signature fails. Supported for TSS EdDSA
+     * (MPCv1) wallets; other wallet types are rejected.
+     *
+     * The result is a consistency check for a caller inspecting its own material, not proof of
+     * possession, and must never be used as an authorization signal.
+     *
+     * `walletPassphrase` is deliberately not accepted: decrypting the BitGo-held `encryptedPrv`
+     * and comparing it against the BitGo-held keychain is circular, and callers that hold their
+     * own key material do not need it.
+     *
+     * @param params.prv - user signing material, the same string that would be passed as `prv` when signing
+     * @param params.reqId - request tracer
+     * @returns whether the recombined key matches the wallet's commonKeychain
+     */
+    verifyKey(params: VerifyKeyOptions): Promise<VerifyKeyResult>;
     /**
      * Get a transaction prebuild from BitGo, validate it, and then decrypt the user key and sign the transaction
      * @param params
      */
     prebuildAndSignTransaction(params?: PrebuildAndSignTransactionOptions): Promise<SignedTransaction>;
     /**
-     * Accelerate a transaction's confirmation using Child-Pays-For-Parent (CPFP)
+     * Accelerate a transaction's confirmation using Child-Pays-For-Parent (CPFP) or Replace-By-Fee (RBF)
      * @param params
      */
     accelerateTransaction(params?: AccelerateTransactionOptions): Promise<any>;
+    private validateAccelerationParams;
+    private validateRbfParams;
+    private validateCpfpParams;
     /**
      * Submit a half-signed transaction to BitGo
      * @param params
      * - txHex: transaction hex to submit
      * - halfSigned: object containing transaction (txHex or txBase64) to submit
+     * @param reqId - request tracer request id
      */
-    submitTransaction(params?: SubmitTransactionOptions): Promise<any>;
+    submitTransaction(params?: SubmitTransactionOptions, reqId?: IRequestTracer): Promise<any>;
     /**
      * Send coins to a recipient
      * @param params
@@ -488,6 +697,19 @@ export declare class Wallet implements IWallet {
      * @returns {*}
      */
     send(params?: SendOptions): Promise<any>;
+    /**
+     * Send an ERC-721 NFT or ERC-1155 NFT(s).
+     *
+     * This function constructs the appropriate call data for an ERC-721/1155 token transfer,
+     * and calls the token contract with the data, and amount 0. This transaction will always produce
+     * a pending approval.
+     *
+     * @param sendOptions Options to specify how the transaction should be sent.
+     * @param sendNftOptions Options to specify the NFT(s) to be sent.
+     *
+     * @return A pending approval for the transaction.
+     */
+    sendNft(sendOptions: SendNFTOptions, sendNftOptions: NFTTransferOptions): Promise<SendNFTResult>;
     /**
      * Send money to multiple recipients
      * 1. Gets the user keychain by checking the wallet for a key which has an encrypted prv
@@ -606,16 +828,38 @@ export declare class Wallet implements IWallet {
      * Extract a JSON representable version of this wallet
      */
     toJSON(): WalletData;
+    /**
+     * Create a lightning invoice for this wallet.
+     * Supported for OFC (trading) and BTC wallets.
+     * Uses the same wallet-platform endpoint as lnbtc wallets.
+     * @param params.valueSat - Invoice value in satoshis - if not provided, a zero-value invoice is created
+     * @param params.memo - Optional memo/description
+     * @param params.expiry - Optional expiry in seconds (not supported for trading wallets)
+     */
+    createLightningInvoice(params: CreateLightningInvoiceParams): Promise<LightningInvoiceResponse>;
     /**
      * Create a trading account from this wallet
      */
     toTradingAccount(): TradingAccount;
+    /**
+     * Get the address book for this wallet
+     */
+    toAddressBook(): IAddressBook;
+    /**
+     * Access DeFi vault operations for this wallet (deposit, withdraw, resume).
+     */
+    get defi(): DefiVault;
     /**
      * Create a staking wallet from this wallet
      */
     toStakingWallet(): StakingWallet;
     /**
-     * Creates and downloads PDF keycard for wallet (requires response from wallets.generateWallet)
+     * Create a go staking wallet from this wallet
+     */
+    toGoStakingWallet(): GoStakingWallet;
+    /**
+     * Creates and downloads PDF keycard for wallet (requires response from wallets.generateWallet).
+     * `encryptionVersion` applies to the backup key. Box D uses its fixed version.
      *
      * Note: this is example code and is not the version used on bitgo.com
      *
@@ -632,7 +876,30 @@ export declare class Wallet implements IWallet {
      *   * backupKeyID - the Key ID used for deriving a cold wallet's backup key
      * @returns {*}
      */
-    downloadKeycard(params?: DownloadKeycardOptions): void;
+    downloadKeycard(params?: DownloadKeycardOptions): Promise<void>;
+    /**
+     * Upgrade this wallet's keychain encryption from v1 (SJCL / PBKDF2-SHA256 + AES-256-CCM) to
+     * v2 (Argon2id + AES-256-GCM) and, optionally, regenerate the keycard PDF.
+     *
+     * Steps:
+     *   1. Unlock the BitGo session (skipped in dry-run).
+     *   2. Validate MPCv2 requirements (boxA/boxB when relevant).
+     *   3. Resolve the current and original passphrases (deriving from boxD if needed).
+     *   4. Re-encrypt user and backup keychains from v1 to v2 and PUT them to the server.
+     *   5. Re-encrypt MPCv2 reducedEncryptedPrv shares from boxA/boxB (keycard-only, no server PUT).
+     *   6. Invoke the injected {@link UpgradeEncryptionPdfGenerator} to regenerate the keycard PDF.
+     *
+     * @returns the generated PDF and wallet label, or undefined in dry-run or when no PDF generator is provided.
+     */
+    upgradeEncryption(params: UpgradeEncryptionOptions): Promise<UpgradeEncryptionResult | undefined>;
+    /**
+     * Re-encrypt a ciphertext that was written at wallet creation time (backup key, boxA, boxB).
+     * These are not re-encrypted on password change, so the encryption passphrase may still be
+     * the original one from when the wallet was created. Try the current passphrase first; fall
+     * back to `originalPassphrase` if provided.
+     */
+    private reencryptCreationTimeKey;
+    private fetchPasscodeEncryptionCode;
     /**
      * Builds a set of consolidation transactions for a wallet.
      * @param params
@@ -653,6 +920,75 @@ export declare class Wallet implements IWallet {
      *     consolidateAddresses - these are the on-chain receive addresses we want to pick a consolidation amount from
      */
     sendAccountConsolidations(params?: BuildConsolidationTransactionOptions): Promise<any>;
+    /**
+     * Shared build logic for resource delegation and undelegation.
+     * POSTs to the given endpoint and post-processes each prebuild.
+     */
+    private buildResourceManagementTransactions;
+    /**
+     * Shared signing logic for a single resource management transaction (delegation or undelegation).
+     * Signing flow by wallet type (mirrors sendAccountConsolidation):
+     *   - TSS (hot or custodial)    → sendManyTxRequests  (requires txRequestId on prebuildTx)
+     *   - Custodial non-TSS         → initiateTransaction (BitGo auto-signs with its key)
+     *   - Hot non-TSS               → prebuildAndSignTransaction + submitTransaction
+     */
+    private sendResourceManagementTransaction;
+    /**
+     * Shared build → sign → send loop for resource delegation and undelegation.
+     * Validates the wallet passphrase upfront, then sends each transaction individually.
+     * Returns { success, failure } so partial success is handled gracefully.
+     */
+    private sendResourceManagementTransactions;
+    /**
+     * Builds a set of resource delegation transactions for the given delegation entries.
+     * Each entry delegates resources (e.g. ENERGY, BANDWIDTH) from this wallet's root address
+     * to a receiver address. Modelled after buildAccountConsolidations.
+     *
+     * @param params.delegations - Array of { receiverAddress, amount, resource } entries
+     * @returns Unsigned prebuild transaction results, one per delegation entry
+     */
+    buildResourceDelegations(params: BuildResourceDelegationTransactionOptions): Promise<BuildResourceManagementTransactionResult>;
+    /**
+     * Signs and sends a single resource delegation transaction.
+     * @param params.prebuildTx - A single prebuild result from buildResourceDelegations
+     */
+    sendResourceDelegation(params?: PrebuildAndSignTransactionOptions): Promise<ResourceManagementSendResult>;
+    /**
+     * Builds, signs, and sends all resource delegation transactions in a single call.
+     * @param params.delegations - Array of { receiverAddress, amount, resource } entries
+     */
+    sendResourceDelegations(params: BuildResourceDelegationTransactionOptions): Promise<{
+        success: ResourceManagementSendResult[];
+        failure: {
+            message: string;
+            receiverAddress?: string;
+        }[];
+    }>;
+    /**
+     * Builds a set of resource undelegation transactions for the given entries.
+     * Each entry reclaims delegated resources from this wallet's root address back from
+     * a receiver address. Modelled after buildResourceDelegations.
+     *
+     * @param params.undelegations - Array of { receiverAddress, amount, resource } entries
+     * @returns Unsigned prebuild transaction results, one per undelegation entry
+     */
+    buildResourceUndelegations(params: BuildResourceUndelegationTransactionOptions): Promise<BuildResourceManagementTransactionResult>;
+    /**
+     * Signs and sends a single resource undelegation transaction.
+     * @param params.prebuildTx - A single prebuild result from buildResourceUndelegations
+     */
+    sendResourceUndelegation(params?: PrebuildAndSignTransactionOptions): Promise<ResourceManagementSendResult>;
+    /**
+     * Builds, signs, and sends all resource undelegation transactions in a single call.
+     * @param params.undelegations - Array of { receiverAddress, amount, resource } entries
+     */
+    sendResourceUndelegations(params: BuildResourceUndelegationTransactionOptions): Promise<{
+        success: ResourceManagementSendResult[];
+        failure: {
+            message: string;
+            receiverAddress?: string;
+        }[];
+    }>;
     /**
      * Builds a set of transactions that enables the specified tokens
      * @param params -
@@ -660,6 +996,12 @@ export declare class Wallet implements IWallet {
      * @returns Unsigned transactions that enables the specified tokens
      */
     buildTokenEnablements(params?: BuildTokenEnablementOptions): Promise<PrebuildTransactionResult[]>;
+    /**
+     * Builds wallet initialization
+     * @param {PrebuildTransactionOptions} params
+     * @returns {Promise<PrebuildTransactionResult>}
+     */
+    buildWalletInitialization(params: PrebuildTransactionOptions): Promise<PrebuildTransactionResult>;
     /**
      * Signs and sends a single unsigned token enablement transaction
      * @param params
@@ -684,21 +1026,98 @@ export declare class Wallet implements IWallet {
         failure: Error[];
     }>;
     /**
-     * Create lightning for btc/tbtc from this wallet
+     * The chain canton, requires the wallet to be initialized by sending out a transaction
+     * to be onboarded onto the validator.
+     * Builds, Signs and sends a transaction that initializes the canton wallet
+     * @param params
      */
-    lightning(): Lightning;
+    sendWalletInitialization(params?: PrebuildTransactionOptions): Promise<WalletInitResult>;
     /**
      * Prebuilds a transaction for a TSS wallet.
      *
      * @param params prebuild transaction options
      */
-    private prebuildTransactionTss;
+    private prebuildTransactionTxRequests;
     /**
-     * Signs a transaction from a TSS wallet using external signer.
+     * Signs a transaction from a TSS EdDSA wallet using external signer.
      *
      * @param params signing options
      */
     private signTransactionTssExternalSignerEdDSA;
+    /**
+     * Signs and sends a transaction request from a TSS (hot) wallet, or a SMC (cold) wallet with an external signer.
+     * Meant to be used for a transaction request where the signing process is aborted.
+     *
+     * Always clears any existing signature shares before signing, for both full and lite transaction
+     * requests, so a resumed/retried sign (including one picked up by a different user than whoever
+     * last touched this transaction request) restarts cleanly instead of building on stale shares.
+     *
+     * @param params
+     *    txRequestId - The ID of the transaction request.
+     *    walletPassphrase - The passphrase for the wallet.
+     *    isTxRequestFull - Flag indicating if the transaction request is full.
+     * @returns A promise that resolves to a SignedTransaction.
+     */
+    signAndSendTxRequest(params: SignAndSendTxRequestOptions): Promise<SignedTransaction>;
+    /**
+     * Signs the message of a full (apiVersion === 'full') message-sign
+     * transaction request from a TSS wallet whose user signing material is
+     * held server-side and decryptable via wallet passphrase (hot wallets —
+     * there is no distinct warm wallet type). Meant to be used for a
+     * message-sign request whose signing was parked behind a pending approval
+     * by the message-signing policy and resumed after the approval was
+     * resolved. Message-sign transaction requests are full-only: the lite
+     * (deprecated) request flow never carries messages.
+     *
+     * Cold / external-signer wallets do not use this method: they resume via
+     * wallet.signMessage({ message: { ..., txRequestId }, prv }), which routes
+     * through the same pendingApproval guard and message signing path.
+     *
+     * Unlike signAndSendTxRequest, this signs through the message path
+     * (signTxRequestForMessage with the WP-persisted messageEncoded); the
+     * transaction signer has no transaction to sign on a message-only request.
+     * The method only signs — delivery of the signature to the requestor is
+     * completed server-side once the signature shares are ingested.
+     *
+     * If the request is still parked behind a pending approval (txRequest
+     * state 'pendingApproval'), resolves with the pendingApprovalId instead
+     * of signing (same contract as signMessage/signTypedData).
+     *
+     * @param params
+     *    txRequestId - The ID of the message-sign transaction request.
+     *    walletPassphrase - The passphrase for the wallet.
+     *    reqId - Optional request tracer.
+     * @returns A promise that resolves to a SignedMessage.
+     */
+    signAndSendMessageTxRequest(params: SignAndSendMessageTxRequestOptions): Promise<SignedMessage>;
+    /**
+     * Ensures signature shares are in a clean state before signing a transaction.
+     * Automatically deletes signature shares for Full TxRequests before signing to prevent
+     * issues with stale or partial signatures.
+     * Use this for Express API and other integrations that need automatic cleanup of signatures.
+     *
+     * @param params - signing options
+     * @returns signed transaction
+     */
+    ensureCleanSigSharesAndSignTransaction(params?: WalletSignTransactionOptions): Promise<SignedTransaction | TxRequest>;
+    /**
+     * Signs a transaction from a TSS ECDSA wallet using external signer.
+     *
+     * @param params signing options
+     */
+    private signTransactionTssExternalSignerECDSA;
+    /**
+     * Signs a transaction from a TSS EdDSA MPCv2 wallet using external signer.
+     *
+     * @param params signing options
+     */
+    private signTransactionTssExternalSignerEdDSAMPCv2;
+    /**
+     * Signs a transaction from a TSS ECDSA wallet using external signer.
+     *
+     * @param params signing options
+     */
+    private signTransactionTssExternalSignerECDSAMPCv2;
     /**
      * Signs a transaction from a TSS wallet.
      *
@@ -722,7 +1141,7 @@ export declare class Wallet implements IWallet {
      *
      * @param params send options
      */
-    private sendManyTss;
+    private sendManyTxRequests;
     /**
      * Send funds from a fee address to a forwarder. Only supports eth-like coins.
      *
@@ -731,7 +1150,15 @@ export declare class Wallet implements IWallet {
      * @param {String} params.amount - Amount to send the forwarder (optional). If not given, defaults to sending an estimate of the amount needed for a fund recovery
      * @returns {*}
      */
-    fundForwarder(params: FundForwardersOptions): Promise<any>;
+    fundForwarder(params: FundForwardersOptions): Promise<WalletData>;
+    /**
+     * Send funds from a fee address to a forwarder.
+     *
+     * @param {Object} params - parameters object
+     * @param {List} params.forwarders - list of fund forwarder options
+     * @returns {*}
+     */
+    fundForwarders(params: FundForwarderParams): Promise<WalletData>;
     /**
      * Gets forwarder's balance
      * @param params - optional query parameters
@@ -747,5 +1174,34 @@ export declare class Wallet implements IWallet {
      * @returns {Promise<WalletEcdsaChallenges>}
      */
     getChallengesForEcdsaSigning(): Promise<WalletEcdsaChallenges>;
+    private sendTransaction;
+    private initiateTransaction;
+    /**
+     * Get wallet keychains and validate passphrase if necessary
+     * @param {PrebuildTransactionOptions} params - prebuild transaction options
+     * @param {string} params.walletPassphrase - wallet passphrase
+     * @param {string} params.reqId - request id for tracing purposes
+     * @param {Function} params.customSigningFunction - custom signing function for external signing
+     * @returns {Promise<Keychain[]>}
+     */
+    private getKeychainsAndValidatePassphrase;
+    /**
+     * Approve token for use with a batcher contract
+     * This function builds, signs, and sends a token approval transaction
+     *
+     * @param {string} walletPassphrase - The passphrase to be used to decrypt the user key
+     * @param {string} tokenName - The name of the token to be approved
+     * @returns {Promise<any>} The transaction details
+     */
+    approveErc20Token(walletPassphrase: string, tokenName: string): Promise<SubmitTransactionResponse>;
+    /**
+     * Build token approval transaction for ERC20 tokens
+     * If walletPassphrase is provided, also signs and sends the transaction
+     *
+     * @param {string} tokenName - The name of the token to be approved
+     * @param {string} [walletPassphrase] - Optional wallet passphrase for signing and sending
+     * @returns {Promise<BuildTokenApprovalResponse | SubmitTransactionResponse>} The token approval build response or transaction details if signed
+     */
+    buildErc20TokenApproval(tokenName: string, walletPassphrase?: string): Promise<BuildTokenApprovalResponse | SubmitTransactionResponse>;
 }
 //# sourceMappingURL=wallet.d.ts.map