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

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

@@ -1,13 +1,18 @@
-import { IRequestTracer } from '../../api';
-import { IBaseCoin, Message, SignedMessage, SignedTransaction, TransactionPrebuild, VerificationOptions, TypedData } from '../baseCoin';
+import { EncryptionVersion, IRequestTracer } from '../../api';
+import { CreateLightningInvoiceParams, LightningInvoiceResponse } from '../../lightning';
+import { IBaseCoin, ITransactionRecipient, Message, SignedMessage, SignedTransaction, TransactionParams, TransactionPrebuild, VerificationOptions, TypedData, NFTTransferOptions, UnifiedRecipientPreference } from '../baseCoin';
 import { BitGoBase } from '../bitgoBase';
-import { Keychain } from '../keychain';
+import { Keychain, KeychainWithEncryptedPrv } from '../keychain';
 import { IPendingApproval, PendingApprovalData } from '../pendingApproval';
-import { IStakingWallet } from '../staking';
+import { IDefiVault } from '../defi';
+import { IGoStakingWallet, IStakingWallet } from '../staking';
 import { ITradingAccount } from '../trading';
-import { CustomGShareGeneratingFunction, CustomRShareGeneratingFunction, TokenEnablement, TokenTransferRecipientParams } from '../utils';
-import { ILightning } from '../lightning';
+import { CantonCommandParams, CustomCommitmentGeneratingFunction, CustomEddsaMPCv2SigningRound1GeneratingFunction, CustomEddsaMPCv2SigningRound2GeneratingFunction, CustomEddsaMPCv2SigningRound3GeneratingFunction, CustomGShareGeneratingFunction, CustomKShareGeneratingFunction, CustomMPCv2SigningRound1GeneratingFunction, CustomMPCv2SigningRound2GeneratingFunction, CustomMPCv2SigningRound3GeneratingFunction, CustomMuDeltaShareGeneratingFunction, CustomPaillierModulusGetterFunction, CustomRShareGeneratingFunction, CustomSShareGeneratingFunction, TokenEnablement, TokenTransferRecipientParams, TxRequest } from '../utils';
 import { SerializedNtilde } from '../../account-lib/mpc/tss/ecdsa/types';
+import { AttestationPayload } from './BuildParams';
+import { IAddressBook } from '../address-book';
+import { WalletUser, AddressQueryResult } from '@bitgo/public-types';
+import { SubmitTransactionResponse } from '../inscriptionBuilder';
 export interface MaximumSpendableOptions {
     minValue?: number | string;
     maxValue?: number | string;
@@ -29,13 +34,70 @@ export interface Memo {
     value: string;
     type: string;
 }
-export interface BuildConsolidationTransactionOptions extends PrebuildTransactionOptions {
+export interface BuildConsolidationTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
     consolidateAddresses?: string[];
+    consolidationMode?: 'single-asset' | 'legacy-multi-asset';
+}
+export interface ResourceDelegationEntry {
+    receiverAddress: string;
+    amount: string;
+    /** Resource type to delegate (e.g. 'ENERGY', 'BANDWIDTH'). */
+    resource: string;
+}
+export interface BuildResourceDelegationTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
+    delegations: ResourceDelegationEntry[];
+}
+export interface BuildResourceUndelegationTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
+    undelegations: ResourceDelegationEntry[];
+}
+export interface ResourceManagementSendResult {
+    txid?: string;
+    status?: string;
+    tx?: string;
+    txRequestId?: string;
+    pendingApprovalId?: string;
+}
+export interface BuildResourceManagementTransactionResult {
+    prebuilds: PrebuildTransactionResult[];
+    buildFailures: {
+        message: string;
+        receiverAddress?: string;
+    }[];
 }
 export interface BuildTokenEnablementOptions extends PrebuildTransactionOptions {
     enableTokens: TokenEnablement[];
 }
-export declare type ApiVersion = 'lite' | 'full';
+type BaseBalance = {
+    balanceString: string;
+    confirmedBalanceString: string;
+    spendableBalanceString: string;
+};
+export type NftBalance = BaseBalance & {
+    type: string;
+    metadata: {
+        name: string;
+        tokenContractAddress: string;
+    };
+    collections: {
+        [tokenId: string]: number;
+    };
+};
+export type ApiVersion = 'lite' | 'full';
+/** Parameters for sBTC bridging (BTC to sBTC). */
+export interface SbtcBridgingParams {
+    /** Amount in satoshis to bridge */
+    amount: number | string;
+    /** Stacks recipient address */
+    stacksRecipient: string;
+    /** Maximum fee in satoshis */
+    maxFee: number | string;
+    /** Lock time for the bridging transaction */
+    lockTime: number;
+}
+/** Parameters for cross-chain bridging transactions. */
+export interface BridgingParams {
+    sbtc?: SbtcBridgingParams;
+}
 export interface PrebuildTransactionOptions {
     reqId?: IRequestTracer;
     recipients?: {
@@ -57,7 +119,24 @@ export interface PrebuildTransactionOptions {
     gasPrice?: number;
     noSplitChange?: boolean;
     unspents?: any[];
+    /**
+     * The receive address from which funds will be withdrawn.
+     * This feature is supported only for specific coins, like ADA.
+     */
+    senderAddress?: string;
+    /**
+     * The wallet ID of the sender wallet when sender wallet is different from current wallet id.
+     * @type {string}
+     * @default {undefined}
+     * @description For BTC unstaking, the sender wallet(a descriptor wallet) is different from original wallet
+     * */
+    senderWalletId?: string;
+    messages?: {
+        address: string;
+        message: string;
+    }[];
     changeAddress?: string;
+    allowExternalChangeAddress?: boolean;
     type?: string;
     closeRemainderTo?: string;
     nonParticipation?: boolean;
@@ -66,6 +145,7 @@ export interface PrebuildTransactionOptions {
     instant?: boolean;
     memo?: Memo;
     addressType?: string;
+    changeAddressType?: string;
     hop?: boolean;
     walletPassphrase?: string;
     reservation?: {
@@ -78,8 +158,12 @@ export interface PrebuildTransactionOptions {
     idfUserId?: string;
     idfVersion?: number;
     comment?: string;
+    /** WebAuthn attestation for the withdrawal intent (WCN-539) — pass-through only. */
+    attestation?: AttestationPayload;
     [index: string]: unknown;
     tokenName?: string;
+    nftCollectionId?: string;
+    nftId?: string;
     enableTokens?: TokenEnablement[];
     nonce?: string;
     preview?: boolean;
@@ -90,6 +174,7 @@ export interface PrebuildTransactionOptions {
     isTss?: boolean;
     custodianTransactionId?: string;
     apiVersion?: ApiVersion;
+    stakingParams?: unknown;
     /**
      * If set to false, sweep all funds including the required minimums for address(es). E.g. Polkadot (DOT) requires 1 DOT minimum.
      */
@@ -98,28 +183,156 @@ export interface PrebuildTransactionOptions {
      * This comment applies to UTXO coins. It's asking which transaction format to use:
      * the legacy format defined by bitcoinjs-lib, or the 'psbt' format, which follows the BIP-174.
      */
-    txFormat?: 'legacy' | 'psbt';
+    txFormat?: 'legacy' | 'psbt' | 'psbt-lite';
+    /**
+     * how to resolve a Unified Address recipient for zec.
+     */
+    unifiedRecipientPreference?: UnifiedRecipientPreference;
+    /**
+     * Custom Solana instructions to include in the transaction.
+     * Each instruction contains a program ID, accounts array, and data buffer.
+     */
+    solInstructions?: {
+        programId: string;
+        keys: {
+            pubkey: string;
+            isSigner: boolean;
+            isWritable: boolean;
+        }[];
+        data: string;
+    }[];
+    /**
+     * Solana versioned transaction data for building transactions with Address Lookup Tables.
+     * Contains compiled instructions, address lookup tables, static account keys, and message header.
+     */
+    solVersionedTransactionData?: {
+        versionedInstructions: {
+            programIdIndex: number;
+            accountKeyIndexes: number[];
+            data: string;
+        }[];
+        addressLookupTables: {
+            accountKey: string;
+            writableIndexes: number[];
+            readonlyIndexes: number[];
+        }[];
+        staticAccountKeys: string[];
+        messageHeader: {
+            numRequiredSignatures: number;
+            numReadonlySignedAccounts: number;
+            numReadonlyUnsignedAccounts: number;
+        };
+        recentBlockhash?: string;
+        /** Transaction version. Absent or 0 = v0 (existing), 1 = v1 */
+        version?: 0 | 1;
+        /** V1 transaction config. Required when version === 1 */
+        transactionConfig?: {
+            computeUnitLimit: number | null;
+            heapSize: number | null;
+            loadedAccountsDataSizeLimit: number | null;
+            priorityFee: number | null;
+        };
+    };
+    /**
+     * Custom transaction parameters for Aptos entry function calls.
+     * Used with the customTx intent type for Aptos smart contract interactions.
+     */
+    aptosCustomTransactionParams?: {
+        moduleName: string;
+        functionName: string;
+        typeArguments?: string[];
+        functionArguments?: any[];
+        abi?: any;
+    };
+    txRequestId?: string;
+    isTestTransaction?: boolean;
+    qr?: boolean;
+    transferOfferId?: string;
+    /**
+     * Amount for intents that use a top-level amount instead of recipients (e.g. bridgeFunds).
+     * Named intentAmount to avoid collision with SendOptions.amount which is string | number.
+     */
+    intentAmount?: {
+        value: string;
+        symbol: string;
+    };
+    /**
+     * TIP-20 token address to use for paying transaction fees (Tempo only).
+     * When specified, fees will be deducted in this token instead of the native currency.
+     */
+    feeToken?: string;
+    /**
+     * Parameters for bridging transactions (e.g., BTC to sBTC).
+     * Used with type: 'bridging' for cross-chain bridging operations.
+     */
+    bridgingParams?: BridgingParams;
+    /**
+     * ERC-7984 wrap / wrapApprove parameters (`type: 'wrapApprove' | 'wrap'`).
+     * Passed through to WP as tokenName + amount on the intent.
+     */
+    wrapParams?: {
+        tokenName: string;
+        amount: string;
+    };
+    /**
+     * ERC-7984 unwrap (unshield) parameters (`type: 'unwrap'`).
+     * Passed through to WP as tokenName + amount on the intent.
+     */
+    unwrapParams?: {
+        tokenName: string;
+        amount: string;
+    };
+    /**
+     * Parameters for executing DAML commands on Canton.
+     */
+    cantonCommandParams?: CantonCommandParams;
+    /** Canton party ID of the end investor to onboard (cantonEndInvestorOnboardingOffer intent). */
+    endInvestorPartyId?: string;
+    /** Reason for rejecting the onboarding offer (cantonEndInvestorOnboardingReject intent). */
+    reason?: string;
+    /** DTCC operator party ID (cantonParticipantOnboardingRequest intent). */
+    operator?: string;
+    /** DTCC provider party ID (cantonParticipantOnboardingRequest intent). */
+    provider?: string;
+    /** DTCC compliance party ID (cantonParticipantOnboardingRequest intent). */
+    compliance?: string;
+    /** DTCC registrar party ID (cantonParticipantOnboardingRequest intent). */
+    registrar?: string;
+    /** DTCC client onboarder party ID (cantonParticipantOnboardingRequest intent). */
+    clientOnboarder?: string;
+    /** Optional ISO 8601 expiration timestamp (cantonParticipantOnboardingRequest intent). */
+    expirationIso?: string;
 }
 export interface PrebuildAndSignTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
     prebuildTx?: string | PrebuildTransactionResult;
     verification?: VerificationOptions;
 }
-export interface PrebuildTransactionResult extends TransactionPrebuild {
+/** Fee fields returned on {@link PrebuildTransactionResult} (withdraw / send previews). */
+export type PrebuildTransactionFeeInfo = {
+    fee?: number;
+    feeString?: string;
+};
+export type PrebuildTransactionResult = TransactionPrebuild & {
     walletId: string;
     consolidateId?: string;
+    stakingRequestId?: string;
     consolidationDetails?: {
         senderAddressIndex: number;
     };
-    feeInfo?: {
-        fee?: number;
-        feeString?: string;
-    };
-}
+    feeInfo?: PrebuildTransactionFeeInfo;
+    pendingApprovalId?: string;
+    reqId?: IRequestTracer;
+    payload?: string;
+    stakingParams?: unknown;
+    recipients?: ITransactionRecipient[];
+};
 export interface CustomSigningFunction {
     (params: {
         coin: IBaseCoin;
         txPrebuild: TransactionPrebuild;
         pubs?: string[];
+        derivationSeed?: string;
+        signingStep?: 'signerNonce' | 'signerSignature' | 'cosignerNonce';
     }): Promise<SignedTransaction>;
 }
 export interface WalletSignBaseOptions {
@@ -130,17 +343,43 @@ export interface WalletSignBaseOptions {
     cosignerPub?: string;
     isLastSignature?: boolean;
     customSigningFunction?: CustomSigningFunction;
+    bulk?: boolean;
 }
 export interface WalletSignTransactionOptions extends WalletSignBaseOptions {
     txPrebuild?: TransactionPrebuild;
+    customCommitmentGeneratingFunction?: CustomCommitmentGeneratingFunction;
     customRShareGeneratingFunction?: CustomRShareGeneratingFunction;
     customGShareGeneratingFunction?: CustomGShareGeneratingFunction;
+    customPaillierModulusGeneratingFunction?: CustomPaillierModulusGetterFunction;
+    customKShareGeneratingFunction?: CustomKShareGeneratingFunction;
+    customMuDeltaShareGeneratingFunction?: CustomMuDeltaShareGeneratingFunction;
+    customSShareGeneratingFunction?: CustomSShareGeneratingFunction;
+    customMPCv2SigningRound1GenerationFunction?: CustomMPCv2SigningRound1GeneratingFunction;
+    customMPCv2SigningRound2GenerationFunction?: CustomMPCv2SigningRound2GeneratingFunction;
+    customMPCv2SigningRound3GenerationFunction?: CustomMPCv2SigningRound3GeneratingFunction;
+    customEddsaMPCv2SigningRound1GenerationFunction?: CustomEddsaMPCv2SigningRound1GeneratingFunction;
+    customEddsaMPCv2SigningRound2GenerationFunction?: CustomEddsaMPCv2SigningRound2GeneratingFunction;
+    customEddsaMPCv2SigningRound3GenerationFunction?: CustomEddsaMPCv2SigningRound3GeneratingFunction;
     apiVersion?: ApiVersion;
+    multisigTypeVersion?: 'MPCv2';
+    walletPassphrase?: string;
+    /**
+     * Optional transaction verification parameters. When provided, the transaction will be verified
+     * using verifyTransaction before signing.
+     */
+    verifyTxParams?: {
+        txParams: TransactionParams;
+        verification?: VerificationOptions;
+    };
     [index: string]: unknown;
 }
 interface WalletSignMessageBase extends WalletSignBaseOptions {
     walletPassphrase?: string;
     custodianMessageId?: string;
+    customPaillierModulusGeneratingFunction?: CustomPaillierModulusGetterFunction;
+    customKShareGeneratingFunction?: CustomKShareGeneratingFunction;
+    customMuDeltaShareGeneratingFunction?: CustomMuDeltaShareGeneratingFunction;
+    customSShareGeneratingFunction?: CustomSShareGeneratingFunction;
 }
 export interface WalletSignMessageOptions extends WalletSignMessageBase {
     message?: Message;
@@ -148,6 +387,16 @@ export interface WalletSignMessageOptions extends WalletSignMessageBase {
 export interface WalletSignTypedDataOptions extends WalletSignMessageBase {
     typedData: TypedData;
 }
+export interface SignAndSendTxRequestOptions {
+    txRequestId: string;
+    walletPassphrase: string;
+    isTxRequestFull: boolean;
+}
+export interface SignAndSendMessageTxRequestOptions {
+    txRequestId: string;
+    walletPassphrase: string;
+    reqId?: IRequestTracer;
+}
 export interface GetUserPrvOptions {
     keychain?: Keychain;
     key?: Keychain;
@@ -155,6 +404,21 @@ export interface GetUserPrvOptions {
     coldDerivationSeed?: string;
     walletPassphrase?: string;
 }
+export interface VerifyKeyOptions {
+    /**
+     * User TSS signing material: the same string that would be passed as `prv` when signing a
+     * transaction. TSS EdDSA (MPCv1) wallets only.
+     */
+    prv: string;
+    reqId?: IRequestTracer;
+}
+export interface VerifyKeyResult {
+    /**
+     * Whether the signing material recombines to the wallet's commonKeychain. A consistency
+     * check, not proof of possession — never use it as an authorization signal.
+     */
+    match: boolean;
+}
 export interface WalletCoinSpecific {
     tokenFlushThresholds?: any;
     addressVersion?: number;
@@ -164,13 +428,57 @@ export interface WalletCoinSpecific {
     walletVersion?: number;
     hashAlgorithm?: string;
     pendingEcdsaTssInitialization?: boolean;
+    features?: string[];
+    freezeDepositsFromShielded?: boolean;
+    userKeySigningRequired?: boolean;
+    /**
+     * Lightning coin specific data starts
+     */
+    keys?: string[];
+    encryptedSignerAdminMacaroon?: string | null;
+    encryptedSignerMacaroon?: string | null;
+    watchOnlyExternalIp?: string | null;
+    signerHost?: string | null;
+    encryptedSignerTlsKey?: string | null;
+    signerTlsCert?: string | null;
+    watchOnlyAccounts?: Record<string, unknown> | null;
+    signedUserAuthKey?: string;
 }
 export interface PaginationOptions {
+    page?: number;
     prevId?: string;
     limit?: number;
 }
 export interface GetTransactionOptions extends PaginationOptions {
     txHash?: string;
+    includeRbf?: boolean;
+}
+export interface GetPotentialStuckTxsOptions {
+    /** Only return transactions unconfirmed longer than this many minutes. */
+    minUnconfirmedMinutes?: number;
+    /** Only return transactions unconfirmed longer than this many blocks. */
+    minUnconfirmedBlocks?: number;
+    expandSendTransferMetadata?: boolean;
+    txid?: string;
+}
+export interface GetPotentialStuckTxsResult {
+    txId?: string;
+    cause?: string;
+    message?: string;
+    nonce?: number;
+    txHex?: string;
+    txType?: string;
+    sendTransfer?: Record<string, unknown>;
+    gasAccelerationFee?: {
+        gasPrice?: string;
+        maxFeePerGas?: string;
+        maxPriorityFeePerGas?: string;
+    };
+    userActionDisabled?: boolean;
+    rbf?: boolean;
+    coin?: string;
+    wallet?: string;
+    isFeeAddress?: boolean;
 }
 export interface TransfersOptions extends PaginationOptions {
     txHash?: string;
@@ -184,6 +492,7 @@ export interface TransfersOptions extends PaginationOptions {
     includeHex?: boolean;
     state?: string[] | string;
     type?: string;
+    decorateUtxoSpecificFields?: boolean;
 }
 export interface GetTransferOptions {
     id?: string;
@@ -199,6 +508,22 @@ export interface UnspentsOptions extends PaginationOptions {
     target?: number | string;
     segwit?: boolean;
     chains?: number[];
+    unspentIds?: string[];
+}
+export interface ManageUnspentReservationOptions {
+    create?: {
+        unspentIds: string[];
+        expireTime: string;
+    };
+    modify?: {
+        unspentIds: string[];
+        changes: {
+            expireTime: string;
+        };
+    };
+    delete?: {
+        id: string;
+    };
 }
 export interface ConsolidateUnspentsOptions extends WalletSignTransactionOptions {
     walletPassphrase?: string;
@@ -217,6 +542,7 @@ export interface ConsolidateUnspentsOptions extends WalletSignTransactionOptions
     comment?: string;
     otp?: string;
     targetAddress?: string;
+    bulk?: boolean;
     [index: string]: unknown;
 }
 export interface FanoutUnspentsOptions extends WalletSignTransactionOptions {
@@ -226,6 +552,7 @@ export interface FanoutUnspentsOptions extends WalletSignTransactionOptions {
     maxValue?: number | string;
     minHeight?: number;
     maxNumInputsToUse?: number;
+    unspents?: string[];
     numUnspentsToMake?: number;
     minConfirms?: number;
     enforceMinConfirmsForChange?: boolean;
@@ -268,6 +595,12 @@ export interface AddressesOptions extends PaginationOptions {
     returnBalancesForToken?: string;
     pendingDeployment?: boolean;
 }
+export interface AddressesByBalanceOptions extends PaginationOptions {
+    token?: string;
+    nftCollectionId?: string;
+    nftId?: string;
+    sort?: number;
+}
 export interface GetAddressOptions {
     address?: string;
     id?: string;
@@ -281,6 +614,9 @@ export interface FundForwardersOptions {
     forwarderAddress: string;
     amount?: string;
 }
+export interface FundForwarderParams {
+    forwarders: FundForwardersOptions[];
+}
 export interface FlushForwarderTokenOptions {
     address?: string;
     id?: string;
@@ -299,6 +635,62 @@ export interface ForwarderBalanceOptions {
     minimumBalance?: number;
     maximumBalance?: number;
 }
+export interface GetAccountResourcesOptions {
+    addresses: string[];
+    destinationAddress?: string;
+}
+export interface AccountResourceInfo {
+    address: string;
+    freeBandwidthAvailable: number;
+    freeBandwidthUsed: number;
+    stakedBandwidthAvailable: number;
+    stakedBandwidthUsed: number;
+    energyAvailable: number;
+    energyUsed: number;
+    resourceDeficitForAssetTransfer?: {
+        bandwidthDeficit: number;
+        bandwidthSunRequired: string;
+        energyDeficit?: number;
+        energySunRequired?: string;
+    };
+    maxResourcesDelegatable?: {
+        bandwidthSun: string;
+        energySun: string;
+    };
+}
+export interface FailedAddressInfo {
+    address: string;
+    error: string;
+}
+export interface GetAccountResourcesResponse {
+    resources: AccountResourceInfo[];
+    failedAddresses: FailedAddressInfo[];
+}
+export interface GetResourceDelegationsOptions {
+    type?: 'outgoing' | 'incoming';
+    resource?: string;
+    limit?: number;
+    nextBatchPrevId?: string;
+}
+export interface DelegationRecord {
+    id: string;
+    coin: string;
+    ownerAddress: string;
+    receiverAddress: string;
+    resource: 'ENERGY' | 'BANDWIDTH';
+    balance: string;
+    updatedAt: string;
+}
+export interface GetResourceDelegationsResponse {
+    address: string;
+    coin: string;
+    delegations: {
+        outgoing: DelegationRecord[];
+        incoming: DelegationRecord[];
+        nextBatchPrevId?: string;
+    };
+}
+export type CreateAddressFormat = 'base58' | 'cashaddr';
 export interface CreateAddressOptions {
     chain?: number;
     gasPrice?: number | string;
@@ -306,17 +698,28 @@ export interface CreateAddressOptions {
     label?: string;
     lowPriority?: boolean;
     forwarderVersion?: number;
-    format?: 'base58' | 'cashaddr';
+    format?: CreateAddressFormat;
     baseAddress?: string;
     allowSkipVerifyAddress?: boolean;
     derivedAddress?: string;
     index?: number;
     onToken?: string;
+    evmKeyRingReferenceAddress?: string;
 }
 export interface UpdateAddressOptions {
     label?: string;
     address?: string;
 }
+export interface UpdateBuildDefaultOptions {
+    minFeeRate?: number;
+    changeAddressType?: string;
+    txFormat?: 'legacy' | 'psbt' | 'psbt-lite';
+}
+export interface UpdateWalletOptions {
+    coinSpecific?: WalletCoinSpecific;
+    buildDefaults?: UpdateBuildDefaultOptions;
+    label?: string;
+}
 export interface SimulateWebhookOptions {
     webhookId?: string;
     transferId?: string;
@@ -330,6 +733,13 @@ export interface GetPrvOptions {
     prv?: string;
     walletPassphrase?: string;
 }
+export interface SharedKeyChain {
+    pub?: string;
+    encryptedPrv?: string;
+    fromPubKey?: string;
+    toPubKey?: string;
+    path?: string;
+}
 export interface CreateShareOptions {
     user?: string;
     permissions?: string;
@@ -343,6 +753,11 @@ export interface CreateShareOptions {
     reshare?: boolean;
     message?: string;
     disableEmail?: boolean;
+    /**
+     * If true, allows sharing without a keychain.
+     * A falsy value is expected to throw an API error if an empty or undefined `keychain` is provided.
+     */
+    skipKeychain?: boolean;
 }
 export interface ShareWalletOptions {
     email?: string;
@@ -350,18 +765,88 @@ export interface ShareWalletOptions {
     walletPassphrase?: string;
     message?: string;
     reshare?: boolean;
+    /**
+     * If true, skips sharing the wallet keychain with the recipient.
+     */
     skipKeychain?: boolean;
     disableEmail?: boolean;
+    /** @deprecated Ignored because the shared key is high entropy. */
+    encryptionVersion?: EncryptionVersion;
+    /**
+     * Pre-decrypted wallet keychain. When supplied, shareWallet skips its internal
+     * getDecryptedKeychainForSharing call — useful when the caller is sharing the same wallet
+     * with many recipients under one walletPassphrase and wants to avoid N-1 redundant Argon2id
+     * decryptions of the user's wallet keychain.
+     */
+    decryptedKeychain?: DecryptedKeychainData;
+}
+export interface BulkCreateShareOption {
+    user: string;
+    permissions: string[];
+    keychain: BulkWalletShareKeychain;
+}
+export interface BulkWalletShareOptions {
+    walletPassphrase: string;
+    keyShareOptions: Array<{
+        userId: string;
+        pubKey: string;
+        path: string;
+        permissions: string[];
+    }>;
+    /** @deprecated Ignored because the shared key is high entropy. */
+    encryptionVersion?: EncryptionVersion;
+}
+export type WalletShareState = 'active' | 'accepted' | 'canceled' | 'rejected' | 'pendingapproval';
+export interface DecryptedKeychainData {
+    prv: string;
+    pub: string;
+}
+export interface BulkWalletShareKeychain {
+    pub: string;
+    encryptedPrv: string;
+    fromPubKey: string;
+    toPubKey: string;
+    path: string;
+}
+export interface WalletShare {
+    id: string;
+    coin: string;
+    wallet: string;
+    walletLabel?: string;
+    fromUser: string;
+    toUser: string;
+    permissions: string[];
+    state?: WalletShareState;
+    enterprise?: string;
+    message?: string;
+    pendingApprovalId?: string;
+    /**
+     * If true, the wallet share requires the user to provide a new keychain.
+     * When accepted, the wallet will be re-shared with all other spenders.
+     */
+    keychainOverrideRequired?: boolean;
+    /**
+     * If true, the wallet share requires the user to to generate a new key-pair.
+     * In addition to the encrypted private key, the user must provide the public key.
+     * */
+    userMultiKeyRotationRequired?: boolean;
+    isUMSInitiated?: boolean;
+    keychain?: BulkWalletShareKeychain;
+}
+export interface CreateBulkWalletShareListResponse {
+    shares: WalletShare[];
 }
 export interface RemoveUserOptions {
     userId?: string;
 }
 export interface AccelerateTransactionOptions {
     cpfpTxIds?: string[];
+    rbfTxIds?: string[];
     cpfpFeeRate?: number;
     noCpfpFeeRate?: boolean;
     maxFee?: number;
     noMaxFee?: boolean;
+    feeMultiplier?: number;
     recipients?: {
         address: string;
         amount: string;
@@ -379,6 +864,8 @@ export interface SubmitTransactionOptions {
     };
     comment?: string;
     txRequestId?: string;
+    /** WebAuthn attestation for the withdrawal intent (WCN-539) — pass-through only. */
+    attestation?: AttestationPayload;
 }
 export interface SendOptions {
     address?: string;
@@ -400,11 +887,13 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
         address: string;
         amount: string | number;
         feeLimit?: string;
-        data?: string;
+        data?: string | TokenTransferRecipientParams;
         tokenName?: string;
+        tokenData?: TokenTransferRecipientParams;
     }[];
     numBlocks?: number;
     feeRate?: number;
+    feeMultiplier?: number;
     maxFeeRate?: number;
     minConfirms?: number;
     enforceMinConfirmsForChange?: boolean;
@@ -421,6 +910,7 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
     comment?: string;
     otp?: string;
     changeAddress?: string;
+    allowExternalChangeAddress?: boolean;
     instant?: boolean;
     memo?: Memo;
     transferId?: number;
@@ -428,11 +918,31 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
     eip1559?: EIP1559;
     gasLimit?: number;
     custodianTransactionId?: string;
+    defiParams?: {
+        vaultId?: string;
+        amount?: string | number;
+        actionType?: string;
+        operationId?: string;
+    };
+    /**
+     * ERC-7984 wrap / wrapApprove parameters. WP builds approve/wrap calldata from these.
+     */
+    wrapParams?: {
+        tokenName: string;
+        amount: string;
+    };
+    /**
+     * ERC-7984 unwrap (unshield) parameters. WP builds unwrap calldata from these.
+     */
+    unwrapParams?: {
+        tokenName: string;
+        amount: string;
+    };
 }
 export interface FetchCrossChainUTXOsOptions {
     sourceChain?: 'P' | 'C';
 }
-export declare type Unspent = {
+export type Unspent = {
     outputID: number;
     amount: string;
     txid: string;
@@ -447,7 +957,8 @@ export interface CrossChainUTXO {
     toWallet: string;
     toAddress: string;
 }
-export declare type WalletType = 'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'trading';
+export type WalletType = 'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'trading' | 'advanced';
+export type SubWalletType = 'distributedCustody' | 'lightningCustody' | 'lightningSelfCustody' | 'onPrem';
 export interface WalletData {
     id: string;
     approvalsRequired: number;
@@ -460,9 +971,13 @@ export interface WalletData {
     coin: string;
     label: string;
     keys: string[];
-    receiveAddress: {
+    receiveAddress?: {
         address: string;
     };
+    walletFlags?: {
+        name: string;
+        value: string;
+    }[];
     migratedFrom?: string;
     coinSpecific: WalletCoinSpecific;
     pendingApprovals: PendingApprovalData[];
@@ -473,8 +988,28 @@ export interface WalletData {
         bitgo?: string;
     };
     multisigType: 'onchain' | 'tss';
+    multisigTypeVersion?: 'MPCv2';
     type?: WalletType;
+    subType?: SubWalletType;
     tokens?: Record<string, any>[];
+    nfts?: {
+        [contractAddressOrToken: string]: NftBalance;
+    };
+    unsupportedNfts?: {
+        [contractAddress: string]: NftBalance;
+    };
+    users?: WalletUser[];
+    evmKeyRingReferenceWalletId?: string;
+    isParent?: boolean;
+    enabledChildChains?: string[];
+    /** @experimental Public id of the parent safe this wallet was minted in */
+    safe?: string;
+    /**
+     * @deprecated Read from `coinSpecific.userKeySigningRequired` instead. Retained
+     * temporarily as a fallback while the field migrates from the top level to the OFC
+     * coinSpecific subdocument; will be removed in a follow-up major release.
+     */
+    userKeySigningRequired?: boolean;
 }
 export interface RecoverTokenOptions {
     tokenContractAddress?: string;
@@ -492,6 +1027,29 @@ export interface ChangeFeeOptions {
     fee?: string;
     eip1559?: EIP1559;
 }
+/**
+ * Response from the token approval build endpoint
+ */
+export interface BuildTokenApprovalResponse {
+    txHex: string;
+    txInfo: {
+        amount: string;
+        contractAddress: string;
+        spender: string;
+    };
+    recipients: {
+        address: string;
+        amount: string;
+        data: string;
+    }[];
+    eip1559?: {
+        maxFeePerGas: string;
+        maxPriorityFeePerGas: string;
+    };
+    nextContractSequenceId: number;
+    coin: string;
+    walletId: string;
+}
 export interface CreatePolicyRuleOptions {
     id?: string;
     type?: string;
@@ -503,6 +1061,48 @@ export interface RemovePolicyRuleOptions {
     id?: string;
     message?: string;
 }
+/**
+ * Callback invoked by {@link IWallet.upgradeEncryption} to generate the regenerated keycard PDF.
+ * The wallet method itself is agnostic to how the PDF is produced — callers wire in the PDF
+ * generator (typically the one exported from `@bitgo-beta/key-card`) so `sdk-core` does not need
+ * a browser/canvas dependency at build time.
+ */
+export type UpgradeEncryptionPdfGenerator = (params: {
+    coinName: string;
+    userKeychain: Keychain;
+    backupKeychain: Keychain;
+    bitgoKeychain: Keychain;
+    passphrase: string;
+    passcodeEncryptionCode: string;
+    walletLabel: string;
+}) => Promise<unknown>;
+export interface UpgradeEncryptionOptions {
+    /**
+     * Current wallet passphrase. Omit when {@link boxD} is provided and the passphrase has never
+     * been changed — the passphrase is derived by decrypting Box D with the PEC.
+     */
+    passphrase?: string;
+    otp?: string;
+    /**
+     * Box D ciphertext from the original keycard.
+     * Required when {@link passphrase} is omitted (to derive it).
+     * Also required when the passphrase was changed after wallet creation (to recover the original
+     * passphrase for decrypting the backup key).
+     */
+    boxD?: string;
+    /** Box A ciphertext — required for MPCv2 wallets (user reducedEncryptedPrv). */
+    boxA?: string;
+    /** Box B ciphertext — required for MPCv2 wallets and older wallets without server-stored backup key. */
+    boxB?: string;
+    passcodeEncryptionCode?: string;
+    dryRun?: boolean;
+    /** Optional callback for regenerating the keycard PDF. When omitted, no PDF is produced. */
+    generatePdf?: UpgradeEncryptionPdfGenerator;
+}
+export interface UpgradeEncryptionResult {
+    doc: unknown;
+    walletLabel: string;
+}
 export interface DownloadKeycardOptions {
     jsPDF?: any;
     QRCode?: any;
@@ -514,6 +1114,7 @@ export interface DownloadKeycardOptions {
     activationCode?: string;
     walletKeyID?: string;
     backupKeyID?: string;
+    encryptionVersion?: EncryptionVersion;
 }
 export interface ChallengeVerifiers {
     verifiers: {
@@ -525,6 +1126,14 @@ export interface WalletEcdsaChallenges {
     bitgoChallenge: SerializedNtilde & ChallengeVerifiers;
     createdBy: string;
 }
+export type SendNFTOptions = Omit<SendManyOptions, 'recipients' | 'enableTokens' | 'tokenName' | 'txFormat' | 'receiveAddress'>;
+export type SendNFTResult = {
+    pendingApproval: PendingApprovalData;
+};
+export type WalletInitResult = {
+    success: PrebuildTransactionResult[];
+    failure: Error[];
+};
 export interface IWallet {
     bitgo: BitGoBase;
     baseCoin: IBaseCoin;
@@ -539,24 +1148,33 @@ export interface IWallet {
     balanceString(): string;
     confirmedBalanceString(): string;
     spendableBalanceString(): string;
+    nftBalances(): NftBalance[] | undefined;
+    unsupportedNftBalances(): NftBalance[] | undefined;
     coin(): string;
+    type(): WalletType;
+    subType(): SubWalletType | undefined;
+    multisigType(): 'onchain' | 'tss';
+    multisigTypeVersion(): 'MPCv2' | undefined;
+    /** @experimental Public id of the parent safe this wallet was minted in */
+    safeId(): string | undefined;
     label(): string;
     keyIds(): string[];
-    receiveAddress(): string;
+    receiveAddress(): string | undefined;
     migratedFrom(): string | undefined;
     tokenFlushThresholds(): any;
     coinSpecific(): WalletCoinSpecific | undefined;
     pendingApprovals(): IPendingApproval[];
     refresh(params?: Record<string, never>): Promise<IWallet>;
     transactions(params?: PaginationOptions): Promise<any>;
+    getPotentialStuckTxs(params?: GetPotentialStuckTxsOptions): Promise<GetPotentialStuckTxsResult[]>;
     getTransaction(params?: GetTransactionOptions): Promise<any>;
     transfers(params?: TransfersOptions): Promise<any>;
     getTransfer(params?: GetTransferOptions): Promise<any>;
     transferBySequenceId(params?: TransferBySequenceIdOptions): Promise<any>;
     maximumSpendable(params?: MaximumSpendableOptions): Promise<MaximumSpendable>;
     unspents(params?: UnspentsOptions): Promise<any>;
-    consolidateUnspents(params?: ConsolidateUnspentsOptions): Promise<any>;
-    fanoutUnspents(params?: FanoutUnspentsOptions): Promise<any>;
+    consolidateUnspents(params?: ConsolidateUnspentsOptions): Promise<unknown>;
+    fanoutUnspents(params?: FanoutUnspentsOptions): Promise<unknown>;
     updateTokenFlushThresholds(thresholds?: any): Promise<any>;
     updateForwarders(forwarderFlags?: any): Promise<any>;
     deployForwarders(params: DeployForwardersOptions): Promise<any>;
@@ -565,29 +1183,34 @@ export interface IWallet {
     sweep(params?: SweepOptions): Promise<any>;
     freeze(params?: FreezeOptions): Promise<any>;
     transferComment(params?: TransferCommentOptions): Promise<any>;
-    addresses(params?: AddressesOptions): Promise<any>;
+    addresses(params?: AddressesOptions): Promise<AddressQueryResult>;
     getAddress(params?: GetAddressOptions): Promise<any>;
     createAddress(params?: CreateAddressOptions): Promise<any>;
     updateAddress(params?: UpdateAddressOptions): Promise<any>;
+    getAccountResources(params: GetAccountResourcesOptions): Promise<GetAccountResourcesResponse>;
+    getResourceDelegations(params?: GetResourceDelegationsOptions): Promise<GetResourceDelegationsResponse>;
     listWebhooks(params?: PaginationOptions): Promise<any>;
     simulateWebhook(params?: SimulateWebhookOptions): Promise<any>;
     addWebhook(params?: ModifyWebhookOptions): Promise<any>;
     removeWebhook(params?: ModifyWebhookOptions): Promise<any>;
-    getEncryptedUserKeychain(params?: Record<string, never>): Promise<{
-        encryptedPrv: string;
-    }>;
+    getEncryptedUserKeychain(): Promise<KeychainWithEncryptedPrv>;
     getPrv(params?: GetPrvOptions): Promise<any>;
     createShare(params?: CreateShareOptions): Promise<any>;
     shareWallet(params?: ShareWalletOptions): Promise<any>;
+    createBulkKeyShares(params?: BulkCreateShareOption[]): Promise<CreateBulkWalletShareListResponse>;
+    createBulkWalletShare(params?: BulkWalletShareOptions): Promise<CreateBulkWalletShareListResponse>;
     removeUser(params?: RemoveUserOptions): Promise<any>;
     prebuildTransaction(params?: PrebuildTransactionOptions): Promise<PrebuildTransactionResult>;
     signTransaction(params?: WalletSignTransactionOptions): Promise<SignedTransaction>;
-    getUserPrv(params?: GetUserPrvOptions): string;
+    getUserPrv(params?: GetUserPrvOptions): Promise<string>;
+    verifyKey(params: VerifyKeyOptions): Promise<VerifyKeyResult>;
     prebuildAndSignTransaction(params?: PrebuildAndSignTransactionOptions): Promise<SignedTransaction>;
+    signAndSendTxRequest(params?: SignAndSendTxRequestOptions): Promise<SignedTransaction>;
     accelerateTransaction(params?: AccelerateTransactionOptions): Promise<any>;
     submitTransaction(params?: SubmitTransactionOptions): Promise<any>;
     send(params?: SendOptions): Promise<any>;
     sendMany(params?: SendManyOptions): Promise<any>;
+    sendNft(sendOptions: SendNFTOptions, sendNftOptions: Omit<NFTTransferOptions, 'fromAddress'>): Promise<SendNFTResult>;
     recoverToken(params?: RecoverTokenOptions): Promise<any>;
     getFirstPendingTransaction(params?: Record<string, never>): Promise<any>;
     changeFee(params?: ChangeFeeOptions): Promise<any>;
@@ -600,20 +1223,49 @@ export interface IWallet {
     removePolicyRule(params?: RemovePolicyRuleOptions): Promise<any>;
     remove(params?: Record<string, never>): Promise<any>;
     toJSON(): WalletData;
+    createLightningInvoice(params: CreateLightningInvoiceParams): Promise<LightningInvoiceResponse>;
+    readonly defi: IDefiVault;
     toTradingAccount(): ITradingAccount;
     toStakingWallet(): IStakingWallet;
-    downloadKeycard(params?: DownloadKeycardOptions): void;
+    toGoStakingWallet(): IGoStakingWallet;
+    toAddressBook(): IAddressBook;
+    downloadKeycard(params?: DownloadKeycardOptions): Promise<void>;
+    upgradeEncryption(params: UpgradeEncryptionOptions): Promise<UpgradeEncryptionResult | undefined>;
     buildAccountConsolidations(params?: BuildConsolidationTransactionOptions): Promise<PrebuildTransactionResult[]>;
     sendAccountConsolidation(params?: PrebuildAndSignTransactionOptions): Promise<any>;
     sendAccountConsolidations(params?: BuildConsolidationTransactionOptions): Promise<any>;
+    buildResourceDelegations(params: BuildResourceDelegationTransactionOptions): Promise<BuildResourceManagementTransactionResult>;
+    sendResourceDelegation(params: PrebuildAndSignTransactionOptions): Promise<ResourceManagementSendResult>;
+    sendResourceDelegations(params: BuildResourceDelegationTransactionOptions): Promise<{
+        success: ResourceManagementSendResult[];
+        failure: {
+            message: string;
+            receiverAddress?: string;
+        }[];
+    }>;
+    buildResourceUndelegations(params: BuildResourceUndelegationTransactionOptions): Promise<BuildResourceManagementTransactionResult>;
+    sendResourceUndelegation(params: PrebuildAndSignTransactionOptions): Promise<ResourceManagementSendResult>;
+    sendResourceUndelegations(params: BuildResourceUndelegationTransactionOptions): Promise<{
+        success: ResourceManagementSendResult[];
+        failure: {
+            message: string;
+            receiverAddress?: string;
+        }[];
+    }>;
     buildTokenEnablements(params?: BuildTokenEnablementOptions): Promise<PrebuildTransactionResult[]>;
     sendTokenEnablement(params?: PrebuildAndSignTransactionOptions): Promise<any>;
     sendTokenEnablements(params?: BuildTokenEnablementOptions): Promise<any>;
-    lightning(): ILightning;
+    buildWalletInitialization(params?: PrebuildTransactionOptions): Promise<PrebuildTransactionResult>;
+    sendWalletInitialization(params?: PrebuildTransactionOptions): Promise<WalletInitResult>;
     signMessage(params: WalletSignMessageOptions): Promise<SignedMessage>;
+    buildSignMessageRequest(params: WalletSignMessageOptions): Promise<TxRequest>;
     signTypedData(params: WalletSignTypedDataOptions): Promise<SignedMessage>;
+    signAndSendMessageTxRequest(params: SignAndSendMessageTxRequestOptions): Promise<SignedMessage>;
     fetchCrossChainUTXOs(params: FetchCrossChainUTXOsOptions): Promise<CrossChainUTXO[]>;
     getChallengesForEcdsaSigning(): Promise<WalletEcdsaChallenges>;
+    getNftBalances(): Promise<NftBalance[]>;
+    approveErc20Token(walletPassphrase: string, tokenName: string): Promise<SubmitTransactionResponse>;
+    buildErc20TokenApproval(tokenName: string, walletPassphrase?: string): Promise<BuildTokenApprovalResponse | SubmitTransactionResponse>;
 }
 export {};
 //# sourceMappingURL=iWallet.d.ts.map