@bitgo-beta/sdk-core 8.2.1-beta.76 → 8.2.1-beta.760

package/dist/src/bitgo/wallet/BuildParams.js

@@ -0,0 +1,140 @@
+"use strict";
+/* eslint no-redeclare: off */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildParamKeys = exports.BuildParams = exports.BuildParamsOffchain = exports.BuildParamsStacks = exports.BuildParamsUTXO = void 0;
+const t = __importStar(require("io-ts"));
+const codecProps_1 = require("../utils/codecProps");
+exports.BuildParamsUTXO = t.partial({
+    /* deprecated. the change address type */
+    addressType: t.unknown,
+    /* the change address type */
+    changeAddressType: t.unknown,
+    /* a fixed change address */
+    changeAddress: t.unknown,
+    allowExternalChangeAddress: t.boolean,
+    cpfpFeeRate: t.unknown,
+    cpfpTxIds: t.unknown,
+    unspents: t.unknown,
+    minValue: t.unknown,
+    minConfirms: t.unknown,
+    maxValue: t.unknown,
+    targetWalletUnspents: t.unknown,
+    /* unspent selection strategy */
+    strategy: t.unknown,
+    strategyAllowFallback: t.unknown,
+    noSplitChange: t.unknown,
+    smallestChangeSplitSize: t.unknown,
+    enforceMinConfirmsForChange: t.unknown,
+    /* legacy or psbt */
+    txFormat: t.unknown,
+    maxChangeOutputs: t.unknown,
+    /* rbf */
+    rbfTxIds: t.array(t.string),
+    isReplaceableByFee: t.boolean,
+});
+exports.BuildParamsStacks = t.partial({
+    contractName: t.unknown,
+    functionName: t.unknown,
+    functionArgs: t.unknown,
+});
+exports.BuildParamsOffchain = t.partial({
+    idfSignedTimestamp: t.unknown,
+    idfVersion: t.unknown,
+    idfUserId: t.unknown,
+});
+exports.BuildParams = t.exact(t.intersection([
+    exports.BuildParamsUTXO,
+    exports.BuildParamsStacks,
+    exports.BuildParamsOffchain,
+    t.partial({
+        apiVersion: t.unknown,
+        consolidateAddresses: t.unknown,
+        consolidateId: t.unknown,
+        comment: t.string,
+        delayMs: t.unknown,
+        fee: t.unknown,
+        feeRate: t.unknown,
+        feeMultiplier: t.unknown,
+        enableTokens: t.unknown,
+        gasLimit: t.unknown,
+        gasPrice: t.unknown,
+        hopParams: t.unknown,
+        instant: t.unknown,
+        lastLedgerSequence: t.unknown,
+        ledgerSequenceDelta: t.unknown,
+        maxFee: t.unknown,
+        maxFeeRate: t.unknown,
+        memo: t.unknown,
+        transferId: t.unknown,
+        message: t.unknown,
+        numBlocks: t.unknown,
+        nonce: t.unknown,
+        pendingApprovalId: t.unknown,
+        preview: t.unknown,
+        previewPendingTxs: t.unknown,
+        senderAddress: t.unknown,
+        receiveAddress: t.unknown,
+        recipients: t.unknown,
+        reservation: t.unknown,
+        refundOptions: t.unknown,
+        sequenceId: t.unknown,
+        sourceChain: t.unknown,
+        destinationChain: t.unknown,
+        trustlines: t.unknown,
+        type: t.unknown,
+        limit: t.unknown,
+        timeBounds: t.unknown,
+        startTime: t.unknown,
+        stateProofKey: t.unknown,
+        nonParticipation: t.unknown,
+        validFromBlock: t.unknown,
+        validToBlock: t.unknown,
+        messageKey: t.unknown,
+        stakingParams: t.unknown,
+        stakingOptions: t.unknown,
+        unstakingOptions: t.unknown,
+        eip1559: t.unknown,
+        keyregTxBase64: t.unknown,
+        closeRemainderTo: t.unknown,
+        tokenName: t.unknown,
+        prebuildTx: t.unknown,
+        // param to set emergency flag on a custodial transaction.
+        // This transaction should be performed in less than 1 hour or it will fail.
+        emergency: t.unknown,
+    }),
+]));
+exports.buildParamKeys = (0, codecProps_1.getCodecProperties)(exports.BuildParams);
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"BuildParams.js","sourceRoot":"","sources":["../../../../src/bitgo/wallet/BuildParams.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE9B,yCAA2B;AAC3B,oDAAyD;AAE5C,QAAA,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC;IACvC,yCAAyC;IACzC,WAAW,EAAE,CAAC,CAAC,OAAO;IACtB,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,CAAC,OAAO;IAC5B,4BAA4B;IAC5B,aAAa,EAAE,CAAC,CAAC,OAAO;IACxB,0BAA0B,EAAE,CAAC,CAAC,OAAO;IACrC,WAAW,EAAE,CAAC,CAAC,OAAO;IACtB,SAAS,EAAE,CAAC,CAAC,OAAO;IACpB,QAAQ,EAAE,CAAC,CAAC,OAAO;IACnB,QAAQ,EAAE,CAAC,CAAC,OAAO;IACnB,WAAW,EAAE,CAAC,CAAC,OAAO;IACtB,QAAQ,EAAE,CAAC,CAAC,OAAO;IACnB,oBAAoB,EAAE,CAAC,CAAC,OAAO;IAC/B,gCAAgC;IAChC,QAAQ,EAAE,CAAC,CAAC,OAAO;IACnB,qBAAqB,EAAE,CAAC,CAAC,OAAO;IAChC,aAAa,EAAE,CAAC,CAAC,OAAO;IACxB,uBAAuB,EAAE,CAAC,CAAC,OAAO;IAClC,2BAA2B,EAAE,CAAC,CAAC,OAAO;IACtC,oBAAoB;IACpB,QAAQ,EAAE,CAAC,CAAC,OAAO;IACnB,gBAAgB,EAAE,CAAC,CAAC,OAAO;IAC3B,SAAS;IACT,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3B,kBAAkB,EAAE,CAAC,CAAC,OAAO;CAC9B,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC;IACzC,YAAY,EAAE,CAAC,CAAC,OAAO;IACvB,YAAY,EAAE,CAAC,CAAC,OAAO;IACvB,YAAY,EAAE,CAAC,CAAC,OAAO;CACxB,CAAC,CAAC;AAEU,QAAA,mBAAmB,GAAG,CAAC,CAAC,OAAO,CAAC;IAC3C,kBAAkB,EAAE,CAAC,CAAC,OAAO;IAC7B,UAAU,EAAE,CAAC,CAAC,OAAO;IACrB,SAAS,EAAE,CAAC,CAAC,OAAO;CACrB,CAAC,CAAC;AAEU,QAAA,WAAW,GAAG,CAAC,CAAC,KAAK,CAChC,CAAC,CAAC,YAAY,CAAC;IACb,uBAAe;IACf,yBAAiB;IACjB,2BAAmB;IACnB,CAAC,CAAC,OAAO,CAAC;QACR,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,oBAAoB,EAAE,CAAC,CAAC,OAAO;QAC/B,aAAa,EAAE,CAAC,CAAC,OAAO;QACxB,OAAO,EAAE,CAAC,CAAC,MAAM;QACjB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,GAAG,EAAE,CAAC,CAAC,OAAO;QACd,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,aAAa,EAAE,CAAC,CAAC,OAAO;QACxB,YAAY,EAAE,CAAC,CAAC,OAAO;QACvB,QAAQ,EAAE,CAAC,CAAC,OAAO;QACnB,QAAQ,EAAE,CAAC,CAAC,OAAO;QACnB,SAAS,EAAE,CAAC,CAAC,OAAO;QACpB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,kBAAkB,EAAE,CAAC,CAAC,OAAO;QAC7B,mBAAmB,EAAE,CAAC,CAAC,OAAO;QAC9B,MAAM,EAAE,CAAC,CAAC,OAAO;QACjB,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,IAAI,EAAE,CAAC,CAAC,OAAO;QACf,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,SAAS,EAAE,CAAC,CAAC,OAAO;QACpB,KAAK,EAAE,CAAC,CAAC,OAAO;QAChB,iBAAiB,EAAE,CAAC,CAAC,OAAO;QAC5B,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,iBAAiB,EAAE,CAAC,CAAC,OAAO;QAC5B,aAAa,EAAE,CAAC,CAAC,OAAO;QACxB,cAAc,EAAE,CAAC,CAAC,OAAO;QACzB,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,WAAW,EAAE,CAAC,CAAC,OAAO;QACtB,aAAa,EAAE,CAAC,CAAC,OAAO;QACxB,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,WAAW,EAAE,CAAC,CAAC,OAAO;QACtB,gBAAgB,EAAE,CAAC,CAAC,OAAO;QAC3B,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,IAAI,EAAE,CAAC,CAAC,OAAO;QACf,KAAK,EAAE,CAAC,CAAC,OAAO;QAChB,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,SAAS,EAAE,CAAC,CAAC,OAAO;QACpB,aAAa,EAAE,CAAC,CAAC,OAAO;QACxB,gBAAgB,EAAE,CAAC,CAAC,OAAO;QAC3B,cAAc,EAAE,CAAC,CAAC,OAAO;QACzB,YAAY,EAAE,CAAC,CAAC,OAAO;QACvB,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,aAAa,EAAE,CAAC,CAAC,OAAO;QACxB,cAAc,EAAE,CAAC,CAAC,OAAO;QACzB,gBAAgB,EAAE,CAAC,CAAC,OAAO;QAC3B,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,cAAc,EAAE,CAAC,CAAC,OAAO;QACzB,gBAAgB,EAAE,CAAC,CAAC,OAAO;QAC3B,SAAS,EAAE,CAAC,CAAC,OAAO;QACpB,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,0DAA0D;QAC1D,4EAA4E;QAC5E,SAAS,EAAE,CAAC,CAAC,OAAO;KACrB,CAAC;CACH,CAAC,CACH,CAAC;AAGW,QAAA,cAAc,GAAG,IAAA,+BAAkB,EAAC,mBAAW,CAAC,CAAC","sourcesContent":["/* eslint no-redeclare: off */\n\nimport * as t from 'io-ts';\nimport { getCodecProperties } from '../utils/codecProps';\n\nexport const BuildParamsUTXO = t.partial({\n  /* deprecated. the change address type */\n  addressType: t.unknown,\n  /* the change address type */\n  changeAddressType: t.unknown,\n  /* a fixed change address */\n  changeAddress: t.unknown,\n  allowExternalChangeAddress: t.boolean,\n  cpfpFeeRate: t.unknown,\n  cpfpTxIds: t.unknown,\n  unspents: t.unknown,\n  minValue: t.unknown,\n  minConfirms: t.unknown,\n  maxValue: t.unknown,\n  targetWalletUnspents: t.unknown,\n  /* unspent selection strategy */\n  strategy: t.unknown,\n  strategyAllowFallback: t.unknown,\n  noSplitChange: t.unknown,\n  smallestChangeSplitSize: t.unknown,\n  enforceMinConfirmsForChange: t.unknown,\n  /* legacy or psbt */\n  txFormat: t.unknown,\n  maxChangeOutputs: t.unknown,\n  /* rbf */\n  rbfTxIds: t.array(t.string),\n  isReplaceableByFee: t.boolean,\n});\n\nexport const BuildParamsStacks = t.partial({\n  contractName: t.unknown,\n  functionName: t.unknown,\n  functionArgs: t.unknown,\n});\n\nexport const BuildParamsOffchain = t.partial({\n  idfSignedTimestamp: t.unknown,\n  idfVersion: t.unknown,\n  idfUserId: t.unknown,\n});\n\nexport const BuildParams = t.exact(\n  t.intersection([\n    BuildParamsUTXO,\n    BuildParamsStacks,\n    BuildParamsOffchain,\n    t.partial({\n      apiVersion: t.unknown,\n      consolidateAddresses: t.unknown,\n      consolidateId: t.unknown,\n      comment: t.string,\n      delayMs: t.unknown,\n      fee: t.unknown,\n      feeRate: t.unknown,\n      feeMultiplier: t.unknown,\n      enableTokens: t.unknown,\n      gasLimit: t.unknown,\n      gasPrice: t.unknown,\n      hopParams: t.unknown,\n      instant: t.unknown,\n      lastLedgerSequence: t.unknown,\n      ledgerSequenceDelta: t.unknown,\n      maxFee: t.unknown,\n      maxFeeRate: t.unknown,\n      memo: t.unknown,\n      transferId: t.unknown,\n      message: t.unknown,\n      numBlocks: t.unknown,\n      nonce: t.unknown,\n      pendingApprovalId: t.unknown,\n      preview: t.unknown,\n      previewPendingTxs: t.unknown,\n      senderAddress: t.unknown,\n      receiveAddress: t.unknown,\n      recipients: t.unknown,\n      reservation: t.unknown,\n      refundOptions: t.unknown,\n      sequenceId: t.unknown,\n      sourceChain: t.unknown,\n      destinationChain: t.unknown,\n      trustlines: t.unknown,\n      type: t.unknown,\n      limit: t.unknown,\n      timeBounds: t.unknown,\n      startTime: t.unknown,\n      stateProofKey: t.unknown,\n      nonParticipation: t.unknown,\n      validFromBlock: t.unknown,\n      validToBlock: t.unknown,\n      messageKey: t.unknown,\n      stakingParams: t.unknown,\n      stakingOptions: t.unknown,\n      unstakingOptions: t.unknown,\n      eip1559: t.unknown,\n      keyregTxBase64: t.unknown,\n      closeRemainderTo: t.unknown,\n      tokenName: t.unknown,\n      prebuildTx: t.unknown,\n      // param to set emergency flag on a custodial transaction.\n      // This transaction should be performed in less than 1 hour or it will fail.\n      emergency: t.unknown,\n    }),\n  ])\n);\n\nexport type BuildParams = t.TypeOf<typeof BuildParams>;\nexport const buildParamKeys = getCodecProperties(BuildParams);\n"]}

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

@@ -1,13 +1,15 @@
 import { IRequestTracer } from '../../api';
-import { IBaseCoin, Message, SignedMessage, SignedTransaction, TransactionPrebuild, VerificationOptions, TypedData } from '../baseCoin';
+import { IBaseCoin, Message, SignedMessage, SignedTransaction, TransactionPrebuild, VerificationOptions, TypedData, NFTTransferOptions } 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 { ITradingAccount } from '../trading';
-import { CustomCommitmentGeneratingFunction, CustomGShareGeneratingFunction, CustomRShareGeneratingFunction, TokenEnablement, TokenTransferRecipientParams } from '../utils';
-import { ILightning } from '../lightning';
+import { CustomCommitmentGeneratingFunction, CustomGShareGeneratingFunction, CustomKShareGeneratingFunction, CustomMPCv2SigningRound1GeneratingFunction, CustomMPCv2SigningRound2GeneratingFunction, CustomMPCv2SigningRound3GeneratingFunction, CustomMuDeltaShareGeneratingFunction, CustomPaillierModulusGetterFunction, CustomRShareGeneratingFunction, CustomSShareGeneratingFunction, TokenEnablement, TokenTransferRecipientParams } from '../utils';
+import { ILightning } from '../lightning/custodial';
 import { SerializedNtilde } from '../../account-lib/mpc/tss/ecdsa/types';
+import { IAddressBook } from '../address-book';
+import { WalletUser } from '@bitgo/public-types';
 export interface MaximumSpendableOptions {
     minValue?: number | string;
     maxValue?: number | string;
@@ -29,13 +31,28 @@ export interface Memo {
     value: string;
     type: string;
 }
-export interface BuildConsolidationTransactionOptions extends PrebuildTransactionOptions {
+export interface BuildConsolidationTransactionOptions extends PrebuildTransactionOptions, WalletSignTransactionOptions {
     consolidateAddresses?: 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';
 export interface PrebuildTransactionOptions {
     reqId?: IRequestTracer;
     recipients?: {
@@ -57,7 +74,20 @@ 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;
     changeAddress?: string;
+    allowExternalChangeAddress?: boolean;
     type?: string;
     closeRemainderTo?: string;
     nonParticipation?: boolean;
@@ -66,6 +96,7 @@ export interface PrebuildTransactionOptions {
     instant?: boolean;
     memo?: Memo;
     addressType?: string;
+    changeAddressType?: string;
     hop?: boolean;
     walletPassphrase?: string;
     reservation?: {
@@ -114,12 +145,16 @@ export interface PrebuildTransactionResult extends TransactionPrebuild {
         fee?: number;
         feeString?: string;
     };
+    pendingApprovalId?: string;
+    reqId?: IRequestTracer;
 }
 export interface CustomSigningFunction {
     (params: {
         coin: IBaseCoin;
         txPrebuild: TransactionPrebuild;
         pubs?: string[];
+        derivationSeed?: string;
+        signingStep?: 'signerNonce' | 'signerSignature' | 'cosignerNonce';
     }): Promise<SignedTransaction>;
 }
 export interface WalletSignBaseOptions {
@@ -136,12 +171,25 @@ export interface WalletSignTransactionOptions extends WalletSignBaseOptions {
     customCommitmentGeneratingFunction?: CustomCommitmentGeneratingFunction;
     customRShareGeneratingFunction?: CustomRShareGeneratingFunction;
     customGShareGeneratingFunction?: CustomGShareGeneratingFunction;
+    customPaillierModulusGeneratingFunction?: CustomPaillierModulusGetterFunction;
+    customKShareGeneratingFunction?: CustomKShareGeneratingFunction;
+    customMuDeltaShareGeneratingFunction?: CustomMuDeltaShareGeneratingFunction;
+    customSShareGeneratingFunction?: CustomSShareGeneratingFunction;
+    customMPCv2SigningRound1GenerationFunction?: CustomMPCv2SigningRound1GeneratingFunction;
+    customMPCv2SigningRound2GenerationFunction?: CustomMPCv2SigningRound2GeneratingFunction;
+    customMPCv2SigningRound3GenerationFunction?: CustomMPCv2SigningRound3GeneratingFunction;
     apiVersion?: ApiVersion;
+    multisigTypeVersion?: 'MPCv2';
+    walletPassphrase?: string;
     [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;
@@ -149,6 +197,11 @@ export interface WalletSignMessageOptions extends WalletSignMessageBase {
 export interface WalletSignTypedDataOptions extends WalletSignMessageBase {
     typedData: TypedData;
 }
+export interface SignAndSendTxRequestOptions {
+    txRequestId: string;
+    walletPassphrase: string;
+    isTxRequestFull: boolean;
+}
 export interface GetUserPrvOptions {
     keychain?: Keychain;
     key?: Keychain;
@@ -165,6 +218,18 @@ export interface WalletCoinSpecific {
     walletVersion?: number;
     hashAlgorithm?: string;
     pendingEcdsaTssInitialization?: 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 {
     prevId?: string;
@@ -172,6 +237,7 @@ export interface PaginationOptions {
 }
 export interface GetTransactionOptions extends PaginationOptions {
     txHash?: string;
+    includeRbf?: boolean;
 }
 export interface TransfersOptions extends PaginationOptions {
     txHash?: string;
@@ -201,6 +267,21 @@ export interface UnspentsOptions extends PaginationOptions {
     segwit?: boolean;
     chains?: number[];
 }
+export interface ManageUnspentReservationOptions {
+    create?: {
+        unspentIds: string[];
+        expireTime: string;
+    };
+    modify?: {
+        unspentIds: string[];
+        changes: {
+            expireTime: string;
+        };
+    };
+    delete?: {
+        id: string;
+    };
+}
 export interface ConsolidateUnspentsOptions extends WalletSignTransactionOptions {
     walletPassphrase?: string;
     xprv?: string;
@@ -218,6 +299,7 @@ export interface ConsolidateUnspentsOptions extends WalletSignTransactionOptions
     comment?: string;
     otp?: string;
     targetAddress?: string;
+    bulk?: boolean;
     [index: string]: unknown;
 }
 export interface FanoutUnspentsOptions extends WalletSignTransactionOptions {
@@ -227,6 +309,7 @@ export interface FanoutUnspentsOptions extends WalletSignTransactionOptions {
     maxValue?: number | string;
     minHeight?: number;
     maxNumInputsToUse?: number;
+    unspents?: string[];
     numUnspentsToMake?: number;
     minConfirms?: number;
     enforceMinConfirmsForChange?: boolean;
@@ -300,6 +383,7 @@ export interface ForwarderBalanceOptions {
     minimumBalance?: number;
     maximumBalance?: number;
 }
+export type CreateAddressFormat = 'base58' | 'cashaddr';
 export interface CreateAddressOptions {
     chain?: number;
     gasPrice?: number | string;
@@ -307,7 +391,7 @@ export interface CreateAddressOptions {
     label?: string;
     lowPriority?: boolean;
     forwarderVersion?: number;
-    format?: 'base58' | 'cashaddr';
+    format?: CreateAddressFormat;
     baseAddress?: string;
     allowSkipVerifyAddress?: boolean;
     derivedAddress?: string;
@@ -318,6 +402,11 @@ export interface UpdateAddressOptions {
     label?: string;
     address?: string;
 }
+export interface UpdateBuildDefaultOptions {
+    minFeeRate?: number;
+    changeAddressType?: string;
+    txFormat?: 'legacy' | 'psbt';
+}
 export interface SimulateWebhookOptions {
     webhookId?: string;
     transferId?: string;
@@ -331,6 +420,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;
@@ -344,6 +440,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;
@@ -351,18 +452,64 @@ export interface ShareWalletOptions {
     walletPassphrase?: string;
     message?: string;
     reshare?: boolean;
+    /**
+     * If true, skips sharing the wallet keychain with the recipient.
+     */
     skipKeychain?: boolean;
     disableEmail?: boolean;
 }
+export interface BulkCreateShareOption {
+    user: string;
+    permissions: string[];
+    keychain: BulkWalletShareKeychain;
+}
+export interface BulkWalletShareOptions {
+    walletPassphrase: string;
+    keyShareOptions: Array<{
+        userId: string;
+        pubKey: string;
+        path: string;
+        permissions: string[];
+    }>;
+}
+export type WalletShareState = 'active' | 'accepted' | 'canceled' | 'rejected' | 'pendingapproval';
+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;
+    keychainOverrideRequired?: 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;
@@ -406,6 +553,7 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
     }[];
     numBlocks?: number;
     feeRate?: number;
+    feeMultiplier?: number;
     maxFeeRate?: number;
     minConfirms?: number;
     enforceMinConfirmsForChange?: boolean;
@@ -422,6 +570,7 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
     comment?: string;
     otp?: string;
     changeAddress?: string;
+    allowExternalChangeAddress?: boolean;
     instant?: boolean;
     memo?: Memo;
     transferId?: number;
@@ -433,7 +582,7 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
 export interface FetchCrossChainUTXOsOptions {
     sourceChain?: 'P' | 'C';
 }
-export declare type Unspent = {
+export type Unspent = {
     outputID: number;
     amount: string;
     txid: string;
@@ -448,7 +597,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';
+export type SubWalletType = 'distributedCustody';
 export interface WalletData {
     id: string;
     approvalsRequired: number;
@@ -461,9 +611,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[];
@@ -474,8 +628,17 @@ 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[];
 }
 export interface RecoverTokenOptions {
     tokenContractAddress?: string;
@@ -526,6 +689,10 @@ export interface WalletEcdsaChallenges {
     bitgoChallenge: SerializedNtilde & ChallengeVerifiers;
     createdBy: string;
 }
+export type SendNFTOptions = Omit<SendManyOptions, 'recipients' | 'enableTokens' | 'tokenName' | 'txFormat' | 'receiveAddress'>;
+export type SendNFTResult = {
+    pendingApproval: PendingApprovalData;
+};
 export interface IWallet {
     bitgo: BitGoBase;
     baseCoin: IBaseCoin;
@@ -540,10 +707,15 @@ export interface IWallet {
     balanceString(): string;
     confirmedBalanceString(): string;
     spendableBalanceString(): string;
+    nftBalances(): NftBalance[] | undefined;
+    unsupportedNftBalances(): NftBalance[] | undefined;
     coin(): string;
+    type(): WalletType;
+    multisigType(): 'onchain' | 'tss';
+    multisigTypeVersion(): 'MPCv2' | undefined;
     label(): string;
     keyIds(): string[];
-    receiveAddress(): string;
+    receiveAddress(): string | undefined;
     migratedFrom(): string | undefined;
     tokenFlushThresholds(): any;
     coinSpecific(): WalletCoinSpecific | undefined;
@@ -556,8 +728,8 @@ export interface IWallet {
     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>;
@@ -574,21 +746,23 @@ export interface IWallet {
     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;
     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>;
@@ -603,6 +777,7 @@ export interface IWallet {
     toJSON(): WalletData;
     toTradingAccount(): ITradingAccount;
     toStakingWallet(): IStakingWallet;
+    toAddressBook(): IAddressBook;
     downloadKeycard(params?: DownloadKeycardOptions): void;
     buildAccountConsolidations(params?: BuildConsolidationTransactionOptions): Promise<PrebuildTransactionResult[]>;
     sendAccountConsolidation(params?: PrebuildAndSignTransactionOptions): Promise<any>;
@@ -615,6 +790,7 @@ export interface IWallet {
     signTypedData(params: WalletSignTypedDataOptions): Promise<SignedMessage>;
     fetchCrossChainUTXOs(params: FetchCrossChainUTXOsOptions): Promise<CrossChainUTXO[]>;
     getChallengesForEcdsaSigning(): Promise<WalletEcdsaChallenges>;
+    getNftBalances(): Promise<NftBalance[]>;
 }
 export {};
 //# sourceMappingURL=iWallet.d.ts.map