@bitgo/sdk-core 1.0.2-rc.0 → 1.1.0-dev.0

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

@@ -0,0 +1,650 @@
+/**
+ * @prettier
+ */
+import { IBaseCoin, SignedTransaction } from '../baseCoin';
+import { BitGoBase } from '../bitgoBase';
+import { IPendingApproval } from '../pendingApproval';
+import { TradingAccount } from '../trading/tradingAccount';
+import { AccelerateTransactionOptions, AddressesOptions, BuildConsolidationTransactionOptions, ChangeFeeOptions, ConsolidateUnspentsOptions, CreateAddressOptions, CreatePolicyRuleOptions, CreateShareOptions, DeployForwardersOptions, DownloadKeycardOptions, FanoutUnspentsOptions, FlushForwarderTokenOptions, FreezeOptions, 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, WalletSignTransactionOptions } from './iWallet';
+export declare class Wallet implements IWallet {
+    readonly bitgo: BitGoBase;
+    readonly baseCoin: IBaseCoin;
+    private _wallet;
+    private readonly tssUtils;
+    private readonly _permissions?;
+    constructor(bitgo: BitGoBase, baseCoin: IBaseCoin, walletData: any);
+    /**
+     * Build a URL using this wallet's id which can be used for BitGo API operations
+     * @param extra API specific string to append to the wallet id
+     */
+    url(extra?: string): string;
+    /**
+     * Get this wallet's id
+     */
+    id(): string;
+    /**
+     * Get the number of approvals required for spending funds from this wallet
+     */
+    approvalsRequired(): number;
+    /**
+     * Get the current balance of this wallet
+     */
+    balance(): number;
+    prebuildWhitelistedParams(): string[];
+    /**
+     * This is a strict sub-set of prebuildWhitelistedParams
+     */
+    prebuildConsolidateAccountParams(): string[];
+    /**
+     * Get the confirmed balance of this wallet
+     */
+    confirmedBalance(): number;
+    /**
+     * Get the spendable balance of this wallet
+     */
+    spendableBalance(): number;
+    /**
+     * Get a string representation of the balance of this wallet
+     *
+     * This is useful when balances have the potential to overflow standard javascript numbers
+     */
+    balanceString(): string;
+    /**
+     * Get a string representation of the confirmed balance of this wallet
+     *
+     * This is useful when balances have the potential to overflow standard javascript numbers
+     */
+    confirmedBalanceString(): string;
+    /**
+     * Get a string representation of the spendable balance of this wallet
+     *
+     * This is useful when balances have the potential to overflow standard javascript numbers
+     */
+    spendableBalanceString(): string;
+    /**
+     * Get the coin identifier for the type of coin this wallet holds
+     */
+    coin(): string;
+    /**
+     * Get the label (name) for this wallet
+     */
+    label(): string;
+    /**
+     * Get the public object ids for the keychains on this wallet.
+     */
+    keyIds(): string[];
+    /**
+     * Get a receive address for this wallet
+     */
+    receiveAddress(): string;
+    /**
+     * Get the wallet id of the wallet that this wallet was migrated from.
+     *
+     * For example, if this is a BCH wallet that was created from a BTC wallet,
+     * the BCH wallet migrated from field would have the BTC wallet id.
+     */
+    migratedFrom(): string | undefined;
+    /**
+     * Return the token flush thresholds for this wallet
+     * @return {*|Object} pairs of { [tokenName]: thresholds } base units
+     */
+    tokenFlushThresholds(): any;
+    /**
+     * Get wallet properties which are specific to certain coin implementations
+     */
+    coinSpecific(): WalletCoinSpecific | undefined;
+    /**
+     * Get all pending approvals on this wallet
+     */
+    pendingApprovals(): IPendingApproval[];
+    /**
+     * Refresh the wallet object by syncing with the back-end
+     * @param params
+     * @returns {Wallet}
+     */
+    refresh(params?: Record<string, never>): Promise<Wallet>;
+    /**
+     * List the transactions for a given wallet
+     * @param params
+     * @returns {*}
+     */
+    transactions(params?: PaginationOptions): Promise<any>;
+    /**
+     * List the transactions for a given wallet
+     * @param params
+     *  - txHash the transaction hash to search for
+     * @returns {*}
+     */
+    getTransaction(params?: GetTransactionOptions): Promise<any>;
+    /**
+     * List the transfers for a given wallet
+     * @param params
+     * @returns {*}
+     */
+    transfers(params?: TransfersOptions): Promise<any>;
+    /**
+     * Get transfers on this wallet
+     * @param params
+     */
+    getTransfer(params?: GetTransferOptions): Promise<any>;
+    /**
+     * Get a transaction by sequence id for a given wallet
+     * @param params
+     */
+    transferBySequenceId(params?: TransferBySequenceIdOptions): Promise<any>;
+    /**
+     * Get the maximum amount you can spend in a single transaction
+     *
+     * @param {Object} params - parameters object
+     * @param {Number} params.limit - maximum number of selectable unspents
+     * @param {Number} params.minValue - the minimum value of unspents to use in satoshis
+     * @param {Number} params.maxValue - the maximum value of unspents to use in satoshis
+     * @param {Number} params.minHeight - the minimum height of unspents on the block chain to use
+     * @param {Number} params.minConfirms - all selected unspents will have at least this many confirmations
+     * @param {Boolean} params.enforceMinConfirmsForChange - Enforces minConfirms on change inputs
+     * @param {Number} params.feeRate - fee rate to use in calculation of maximum spendable in satoshis/kB
+     * @param {Number} params.maxFeeRate - upper limit for feeRate in satoshis/kB
+     * @param {String} params.recipientAddress - recipient addresses for a more accurate calculation of the maximum available to send
+     * @returns {{maximumSpendable: Number, coin: String}}
+     * NOTE : feeTxConfirmTarget omitted on purpose because gauging the maximum spendable amount with dynamic fees does not make sense
+     */
+    maximumSpendable(params?: MaximumSpendableOptions): Promise<MaximumSpendable>;
+    /**
+     * List the unspents for a given wallet
+     * @param params
+     * @returns {*}
+     */
+    unspents(params?: UnspentsOptions): Promise<any>;
+    /**
+     * Consolidate or fanout unspents on a wallet
+     *
+     * @param {String} routeName - either `consolidate` or `fanout`
+     *
+     * @param {Object} params - parameters object
+     *
+     * Wallet parameters:
+     * @param {String} params.walletPassphrase - the users wallet passphrase
+     * @param {String} params.xprv - the private key in string form if the walletPassphrase is not available
+     *
+     * Fee parameters:
+     * @param {Number} params.feeRate - The fee rate to use for the consolidation in satoshis/kB
+     * @param {Number} params.maxFeeRate - upper limit for feeRate in satoshis/kB
+     * @param {Number} params.maxFeePercentage - the maximum relative portion that you're willing to spend towards fees
+     * @param {Number} params.feeTxConfirmTarget - estimate the fees to aim for first confirmation with this number of blocks
+     *
+     * Input parameters:
+     * @param {Number} params.minValue - the minimum value of unspents to use in satoshis
+     * @param {Number} params.maxValue - the maximum value of unspents to use in satoshis
+     * @param {Number} params.minHeight - the minimum height of unspents on the block chain to use
+     * @param {Number} params.minConfirms - all selected unspents will have at least this many confirmations
+     * @param {Boolean} params.enforceMinConfirmsForChange - if true, minConfirms also applies to change outputs
+     * @param {Number} params.limit                for routeName === 'consolidate'
+     *                 params.maxNumInputsToUse    for routeName === 'fanout'
+     *                  - maximum number of unspents you want to use in the transaction
+     * Output parameters:
+     * @param {Number} params.numUnspentsToMake - the number of new unspents to make
+     */
+    private manageUnspents;
+    /**
+     * Consolidate unspents on a wallet
+     *
+     * @param {Object} params - parameters object
+     * @param {String} params.walletPassphrase - the users wallet passphrase
+     * @param {String} params.xprv - the private key in string form if the walletPassphrase is not available
+     * @param {Number} params.feeRate - The fee rate to use for the consolidation in satoshis/kB
+     * @param {Number} params.maxFeeRate - upper limit for feeRate in satoshis/kB
+     * @param {Number} params.maxFeePercentage - the maximum relative portion that you're willing to spend towards fees
+     * @param {Number} params.feeTxConfirmTarget - estimate the fees to aim for first confirmation with this number of blocks
+     * @param {Number} params.minValue - the minimum value of unspents to use in satoshis
+     * @param {Number} params.maxValue - the maximum value of unspents to use in satoshis
+     * @param {Number} params.minHeight - the minimum height of unspents on the block chain to use
+     * @param {Number} params.minConfirms - all selected unspents will have at least this many confirmations
+     * @param {Boolean} params.enforceMinConfirmsForChange - if true, minConfirms also applies to change outputs
+     * @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
+     */
+    consolidateUnspents(params?: ConsolidateUnspentsOptions): Promise<any>;
+    /**
+     * Fanout unspents on a wallet
+     *
+     * @param {Object} params - parameters object
+     * @param {String} params.walletPassphrase - the users wallet passphrase
+     * @param {String} params.xprv - the private key in string form if the walletPassphrase is not available
+     * @param {Number} params.minValue - the minimum value of unspents to use
+     * @param {Number} params.maxValue - the maximum value of unspents to use
+     * @param {Number} params.minHeight - the minimum height of unspents on the block chain to use
+     * @param {Number} params.minConfirms - all selected unspents will have at least this many confirmations
+     * @param {Number} params.maxFeePercentage - the maximum proportion of an unspent you are willing to lose to fees
+     * @param {Number} params.feeTxConfirmTarget - estimate the fees to aim for first confirmation with this number of blocks
+     * @param {Number} params.feeRate - The desired fee rate for the transaction in satoshis/kB
+     * @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
+     */
+    fanoutUnspents(params?: FanoutUnspentsOptions): Promise<any>;
+    /**
+     * 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.
+     * @param thresholds {Object} - pairs of { [tokenName]: threshold } (base units)
+     */
+    updateTokenFlushThresholds(thresholds?: any): Promise<any>;
+    /**
+        * Updates the wallet. Sets flags for deployForwardersManually and flushForwardersManually of the wallet.
+        * @param forwarderFlags {Object} - {
+          "coinSpecific": {
+            [coinName]: {
+              "deployForwardersManually": {Boolean},
+              "flushForwardersManually": {Boolean}
+            }
+          }
+        }
+        */
+    updateForwarders(forwarderFlags?: any): Promise<any>;
+    /**
+     * To manually deploy an ETH address
+     *
+     * @param {Object} params - parameters object
+     * @param {String} [params.address] - addressId
+     * @param {String} [params.id] - addressId could be received also as id
+     * @returns {Object} Http response
+     */
+    deployForwarders(params: DeployForwardersOptions): Promise<any>;
+    /**
+     * To manually forward tokens from an ETH or CELO address
+     *
+     * @param {Object} params - parameters object
+     * @param {String} params.tokenName - Name of token that needs to be forwarded from the address
+     * @param {String} [params.address] -
+     * @param {String} [params.address] - addressId
+     * @param {String} [params.id] - addressId could be received also as id
+     * @param {String} [params.gasPrice] - Explicit gas price to use when forwarding token from the forwarder contract (ETH and Celo only). If not given, defaults to the current estimated network gas price.
+     * @param {String} [params.eip1559] - Specify eip1559 fee parameters in token forwarding transaction.
+     * @returns {Object} Http response
+     */
+    flushForwarderToken(params: FlushForwarderTokenOptions): Promise<any>;
+    /**
+     * Sweep funds for a wallet
+     *
+     * @param {Object} params - parameters object
+     * @param {String} params.address - The address to send all the funds in the wallet to
+     * @param {String} params.walletPassphrase - the users wallet passphrase
+     * @param {String} params.xprv - the private key in string form if the walletPassphrase is not available
+     * @param {String} params.otp - Two factor auth code to enable sending the transaction
+     * @param {Number} params.feeTxConfirmTarget - Estimate the fees to aim for first confirmation within this number of blocks
+     * @param {Number} params.feeRate - The desired fee rate for the transaction in satoshis/kB
+     * @param {Number} [params.maxFeeRate] - upper limit for feeRate in satoshis/kB
+     * @param {Boolean} [params.allowPartialSweep] - allows sweeping 200 unspents when the wallet has more than that
+     * @returns txHex {String} the txHex of the signed transaction
+     */
+    sweep(params?: SweepOptions): Promise<any>;
+    /**
+     * Freeze a given wallet
+     * @param params
+     * @returns {*}
+     */
+    freeze(params?: FreezeOptions): Promise<any>;
+    /**
+     * Update comment of a transfer
+     * @param params
+     * @returns {*}
+     */
+    transferComment(params?: TransferCommentOptions): Promise<any>;
+    /**
+     * List the addresses for a given wallet
+     * @param params
+     * @returns {*}
+     */
+    addresses(params?: AddressesOptions): Promise<any>;
+    /**
+     * Get a single wallet address by its id
+     * @param params
+     * @returns {*}
+     */
+    getAddress(params?: GetAddressOptions): Promise<any>;
+    /**
+     * Create one or more new address(es) for use with this wallet.
+     *
+     * If the `count` field is defined and greater than 1, an object with a single
+     * array property named `addresses` containing `count` address objects
+     * will be returned. Otherwise, a single address object is returned.
+     *
+     * @param params
+     * @param {Number} params.chain on which the new address should be created
+     * @param {(Number|String)} params.gasPrice gas price for new address creation, if applicable
+     * @param {String} params.label label for the new address(es)
+     * @param {String} params.label label for the new address(es)
+     * @param {Number} params.count=1 number of new addresses which should be created (maximum 250)
+     * @param {Number} params.forwarderVersion The version of address to create, if applicable
+     * @param {Boolean} params.lowPriority Ethereum-specific param to create address using low priority fee address
+     * @param {String} params.baseAddress base address of the wallet(optional parameter)
+     * @param {Boolean} params.allowSkipVerifyAddress When set to false, it throws error if address verification is skipped for any reason. Default is true.
+     * @param {String} [params.derivedAddress]  Derived address
+     * @param {Number} [params.index] Index of the derived address
+     * @param {String} [params.passphrase] passphrase
+     * Address verification can be skipped when forwarderVersion is 0 and pendingChainInitialization is true OR
+     * if 'coinSpecific' is not part of the response from api call to create address
+     */
+    createAddress(params?: CreateAddressOptions): Promise<any>;
+    /**
+     * Update properties on an address
+     * @param params
+     * @returns {*}
+     */
+    updateAddress(params?: UpdateAddressOptions): Promise<any>;
+    /**
+     * List webhooks on this wallet
+     * @param params
+     */
+    listWebhooks(params?: PaginationOptions): Promise<any>;
+    /**
+     * Simulate wallet webhook, currently for webhooks of type transfer and pending approval
+     * @param params
+     * - webhookId (required) id of the webhook to be simulated
+     * - transferId (optional but required for transfer webhooks) id of the simulated transfer
+     * - pendingApprovalId (optional but required for pending approval webhooks) id of the simulated pending approval
+     * @returns {*}
+     */
+    simulateWebhook(params?: SimulateWebhookOptions): Promise<any>;
+    /**
+     * Add a webhook to this wallet
+     * @param params
+     */
+    addWebhook(params?: ModifyWebhookOptions): Promise<any>;
+    /**
+     * Remove a webhook from this wallet
+     * @param params
+     */
+    removeWebhook(params?: ModifyWebhookOptions): Promise<any>;
+    /**
+     * Gets the user key chain for this wallet
+     *
+     * The user key chain 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;
+    }>;
+    /**
+     * Gets the unencrypted private key for this wallet (be careful!)
+     * Requires wallet passphrase
+     *
+     * @param params
+     */
+    getPrv(params?: GetPrvOptions): Promise<any>;
+    /**
+     * Send an encrypted wallet share to BitGo.
+     * @param params
+     */
+    createShare(params?: CreateShareOptions): Promise<any>;
+    /**
+     * Share this wallet with another BitGo user.
+     * @param params
+     * @returns {*}
+     */
+    shareWallet(params?: ShareWalletOptions): Promise<any>;
+    /**
+     * Remove user from wallet
+     * @param params
+     * - userId Id of the user to remove
+     * @return {*}
+     */
+    removeUser(params?: RemoveUserOptions): Promise<any>;
+    /**
+     * Fetch a transaction prebuild (unsigned transaction) from BitGo
+     *
+     * @param {Object} params
+     * @param {{address: string, amount: string}} params.recipients - list of recipients and necessary recipient information
+     * @param {Number} params.numBlocks - Estimates the approximate fee per kilobyte necessary for a transaction confirmation within numBlocks blocks
+     * @param {Number} params.feeRate - the desired feeRate for the transaction in base units/kB
+     * @param {Number} params.maxFeeRate - upper limit for feeRate in base units/kB
+     * @param {Number} params.minConfirms - Minimum number of confirmations unspents going into this transaction should have
+     * @param {Boolean} params.enforceMinConfirmsForChange - Enforce minimum number of confirmations on change (internal) inputs.
+     * @param {Number} params.targetWalletUnspents - The desired count of unspents in the wallet. If the wallet’s current unspent count is lower than the target, up to four additional change outputs will be added to the transaction.
+     * @param {Number} params.minValue - Ignore unspents smaller than this amount of base units
+     * @param {Number} params.maxValue - Ignore unspents larger than this amount of base units
+     * @param {Number} params.sequenceId - The sequence ID of the transaction
+     * @param {Number} params.lastLedgerSequence - Absolute max ledger the transaction should be accepted in, whereafter it will be rejected.
+     * @param {Number} params.ledgerSequenceDelta - Relative ledger height (in relation to the current ledger) that the transaction should be accepted in, whereafter it will be rejected.
+     * @param {Number} params.gasPrice - Custom gas price to be used for sending the transaction
+     * @param {Number} params.gasLimit - Custom gas limit to be used for sending the transaction
+     * @param {Boolean} params.noSplitChange - Set to true to disable automatic change splitting for purposes of unspent management
+     * @param {Array} params.unspents - The unspents to use in the transaction. Each unspent should be in the form prevTxId:nOutput
+     * @param {String} params.changeAddress - Specifies the destination of the change output
+     * @param {Boolean} params.nonParticipation - (Algorand) Non participating key reg transaction
+     * @param {Number} params.validFromBlock - (Algorand) The minimum round this will run on
+     * @param {Number} params.validToBlock - (Algorand) The maximum round this will run on
+     * @param {Boolean} params.instant - Build this transaction to conform with instant sending coin-specific method (if available)
+     * @param {{value: String, type: String}} params.memo - Memo to use in transaction (supported by Stellar)
+     * @param {String} param.transferId - transfer Id to use in transaction (supported by casper)
+     * @param {String} params.addressType - The type of address to create for change. One of `p2sh`, `p2shP2wsh`, and `p2wsh`. Case-sensitive.
+     * @param {Boolean} params.hop - Build this as an Ethereum hop transaction
+     * @param {Object} params.reservation - Object to reserve the unspents that this tx build uses. Format is reservation = { expireTime: ISODateString, pendingApprovalId: String }
+     * @param {String} params.walletPassphrase The passphrase to the wallet user key, to sign commitment data for Ethereum hop transactions
+     * @param {String} params.walletContractAddress - The contract address used as the "to" field of a transaction
+     * @returns {*}
+     */
+    prebuildTransaction(params?: PrebuildTransactionOptions): Promise<PrebuildTransactionResult>;
+    /**
+     * Sign a transaction
+     * @param params
+     * - txPrebuild
+     * - [keychain / key] (object) or prv (string)
+     * - walletPassphrase
+     * @return {*}
+     */
+    signTransaction(params?: WalletSignTransactionOptions): Promise<SignedTransaction>;
+    /**
+     * Get the user private key from either a derivation or an encrypted keychain
+     * @param [params.keychain / params.key] (object) or params.prv (string)
+     * @param params.walletPassphrase (string)
+     */
+    getUserPrv(params?: GetUserPrvOptions): string;
+    /**
+     * 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)
+     * @param params
+     */
+    accelerateTransaction(params?: AccelerateTransactionOptions): Promise<any>;
+    /**
+     * Submit a half-signed transaction to BitGo
+     * @param params
+     * - txHex: transaction hex to submit
+     * - halfSigned: object containing transaction (txHex or txBase64) to submit
+     */
+    submitTransaction(params?: SubmitTransactionOptions): Promise<any>;
+    /**
+     * Send coins to a recipient
+     * @param params
+     * @param params.address - the destination address
+     * @param params.amount - the amount in satoshis/wei/base value to be sent
+     * @param params.message - optional message to attach to transaction
+     * @param params.data - [Ethereum Specific] optional data to pass to transaction
+     * @param params.custodianTransactionId - [Ethereum/MMI Specific] id of transaction created via metamask
+     * @param params.walletPassphrase - the passphrase to be used to decrypt the user key on this wallet
+     * @param params.prv - the private key in string form, if walletPassphrase is not available
+     * @param params.minConfirms - the minimum confirmation threshold for inputs
+     * @param params.enforceMinConfirmsForChange - whether to enforce minConfirms for change inputs
+     * @returns {*}
+     */
+    send(params?: SendOptions): Promise<any>;
+    /**
+     * Send money to multiple recipients
+     * 1. Gets the user keychain by checking the wallet for a key which has an encrypted prv
+     * 2. Decrypts user key
+     * 3. Creates the transaction with default fee
+     * 4. Signs transaction with decrypted user key
+     * 5. Sends the transaction to BitGo
+     * @param {object} params
+     * @param {{address: string, amount: string}} params.recipients - list of recipients and necessary recipient information
+     * @param {Number} params.numBlocks - Estimates the approximate fee per kilobyte necessary for a transaction confirmation within numBlocks blocks
+     * @param {Number} params.feeRate - the desired feeRate for the transaction in satothis/kB
+     * @param {Number} params.maxFeeRate - upper limit for feeRate in satoshis/kB
+     * @param {Number} params.minConfirms - all selected unspents will have at least this many confirmations
+     * @param {Boolean} params.enforceMinConfirmsForChange - Enforces minConfirms on change inputs
+     * @param {Number} params.targetWalletUnspents - The desired count of unspents in the wallet
+     * @param {String} params.message - optional message to attach to transaction
+     * @param {Number} params.minValue - Ignore unspents smaller than this amount of satoshis
+     * @param {Number} params.maxValue - Ignore unspents larger than this amount of satoshis
+     * @param {Number} params.sequenceId - The sequence ID of the transaction
+     * @param {Number} params.lastLedgerSequence - Absolute max ledger the transaction should be accepted in, whereafter it will be rejected.
+     * @param {Number} params.ledgerSequenceDelta - Relative ledger height (in relation to the current ledger) that the transaction should be accepted in, whereafter it will be rejected.
+     * @param {Number} params.gasPrice - Custom gas price to be used for sending the transaction
+     * @param {Boolean} params.noSplitChange - Set to true to disable automatic change splitting for purposes of unspent management
+     * @param {Array} params.unspents - The unspents to use in the transaction. Each unspent should be in the form prevTxId:nOutput
+     * @param {String} params.comment - Any additional comment to attach to the transaction
+     * @param {String} params.otp - Two factor auth code to enable sending the transaction
+     * @param {String} params.changeAddress - Specifies the destination of the change output
+     * @param {Boolean} params.instant - Send this transaction using coin-specific instant sending method (if available)
+     * @param {{value: String, type: String}} params.memo - Memo to use in transaction (supported by Stellar)
+     * @param {String} params.type - Type of the transaction (e.g. trustline)
+     * @param {{token: params, action: String, limit: String}[]} options.trustlines - Array of trustlines to manage (supported by Stellar)
+     * @returns {*}
+     */
+    sendMany(params?: SendManyOptions): Promise<any>;
+    /**
+     * Recover an unsupported token from a BitGo multisig wallet
+     * params are validated in Eth.prototype.recoverToken
+     * @param params
+     * @param params.tokenContractAddress the contract address of the unsupported token
+     * @param params.recipient the destination address recovered tokens should be sent to
+     * @param params.walletPassphrase the wallet passphrase
+     * @param params.prv the xprv
+     */
+    recoverToken(params?: RecoverTokenOptions): Promise<any>;
+    /**
+     * Get transaction metadata for the oldest transaction that is still pending or attempted
+     * @param params
+     * @returns {Object} Object with txid, walletId, tx, and fee (if supported for coin)
+     */
+    getFirstPendingTransaction(params?: Record<string, never>): Promise<any>;
+    /**
+     * Change the fee on the pending transaction that corresponds to the given txid to the given new fee
+     * @param params
+     * @param {String} params.txid The transaction Id corresponding to the transaction whose fee is to be changed
+     * @param {String} params.fee The new fee to apply to the denoted transaction
+     * @returns {String} The transaction ID of the new transaction that contains the new fee rate
+     */
+    changeFee(params?: ChangeFeeOptions): Promise<any>;
+    /**
+     * Fetch info from merchant server
+     * @param {Object} params The params passed into the function
+     * @param {String} params.url The Url to retrieve info from
+     * @returns {Object} The info returned from the merchant server
+     * @deprecated
+     */
+    getPaymentInfo(params?: {
+        url?: string;
+    }): Promise<any>;
+    /**
+     * Send json payment response
+     * @param {Object} params The params passed into the function
+     * @param {String} params.paymentUrl - The url to send the fully signed transaction to
+     * @param {String} params.txHex - The transaction hex of the payment
+     * @param {String} params.memo {String} - A memo supplied by the merchant, to be inserted into the transfer as the comment
+     * @param {String} params.expires {String} - ISO Date format of when the payment request expires
+     * @returns {Object} The info returned from the merchant server Payment Ack
+     * @deprecated
+     */
+    sendPaymentResponse(params?: any): Promise<any>;
+    /**
+     * Create a policy rule
+     * @param params
+     * @param params.condition condition object
+     * @param params.action action object
+     * @returns {*}
+     */
+    createPolicyRule(params?: CreatePolicyRuleOptions): Promise<any>;
+    /**
+     * Update a policy rule
+     * @param params
+     * @param params.condition condition object
+     * @param params.action action object
+     * @returns {*}
+     */
+    setPolicyRule(params?: any): Promise<any>;
+    /**
+     * Remove Policy Rule
+     * @param params
+     * @returns {*}
+     */
+    removePolicyRule(params?: RemovePolicyRuleOptions): Promise<any>;
+    /**
+     * Remove this wallet
+     * @param params
+     * @returns {*}
+     */
+    remove(params?: Record<string, never>): Promise<any>;
+    /**
+     * Extract a JSON representable version of this wallet
+     */
+    toJSON(): WalletData;
+    /**
+     * Create a trading account from this wallet
+     */
+    toTradingAccount(): TradingAccount;
+    /**
+     * Creates and downloads PDF keycard for wallet (requires response from wallets.generateWallet)
+     *
+     * Note: this is example code and is not the version used on bitgo.com
+     *
+     * @param params
+     *   * jsPDF - an instance of the jsPDF library
+     *   * QRCode - an instance of the QRious library
+     *   * userKeychain - a wallet's private user keychain
+     *   * backupKeychain - a wallet's private backup keychain
+     *   * bitgoKeychain - a wallet's private bitgo keychain
+     *   * passphrase - the wallet passphrase
+     *   * passcodeEncryptionCode - the encryption secret used for Box D
+     *   * activationCode - a randomly generated six-digit activation code
+     *   * walletKeyID - the Key ID used for deriving a cold wallet's signing key
+     *   * backupKeyID - the Key ID used for deriving a cold wallet's backup key
+     * @returns {*}
+     */
+    downloadKeycard(params?: DownloadKeycardOptions): void;
+    /**
+     * Builds a set of consolidation transactions for a wallet.
+     * @param params
+     *     consolidateAddresses - these are the on-chain receive addresses we want to pick a consolidation amount from
+     */
+    buildAccountConsolidations(params?: BuildConsolidationTransactionOptions): Promise<PrebuildTransactionResult[]>;
+    /**
+     * Builds and sends a set of consolidation transactions for a wallet.
+     * @param params
+     *     prebuildTx   - this is the pre-build consolidation tx. this is a normally built tx with
+     *                    an additional parameter of consolidateId.
+     *     verification - normal keychains, etc. for verification
+     */
+    sendAccountConsolidation(params?: PrebuildAndSignTransactionOptions): Promise<any>;
+    /**
+     * Builds and sends a set of account consolidations. This is intended to flush many balances to the root wallet balance.
+     * @param params -
+     *     consolidateAddresses - these are the on-chain receive addresses we want to pick a consolidation amount from
+     */
+    sendAccountConsolidations(params?: BuildConsolidationTransactionOptions): Promise<any>;
+    /**
+     * Prebuilds a transaction for a TSS wallet.
+     *
+     * @param params prebuild transaction options
+     */
+    private prebuildTransactionTss;
+    /**
+     * Signs a transaction from a TSS wallet.
+     *
+     * @param params signing options
+     */
+    private signTransactionTss;
+    /**
+     * Builds, signs, and sends a transaction from a TSS wallet.
+     *
+     * @param params send options
+     */
+    private sendManyTss;
+}
+//# sourceMappingURL=wallet.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/wallet/wallet.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EACL,SAAS,EACT,iBAAiB,EAIlB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAMzC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EACL,4BAA4B,EAC5B,gBAAgB,EAChB,oCAAoC,EACpC,gBAAgB,EAChB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,OAAO,EACP,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,iCAAiC,EACjC,0BAA0B,EAC1B,yBAAyB,EACzB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,YAAY,EACZ,2BAA2B,EAC3B,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,kBAAkB,EAClB,UAAU,EACV,4BAA4B,EAC7B,MAAM,WAAW,CAAC;AAMnB,qBAAa,MAAO,YAAW,OAAO;IACpC,SAAgB,KAAK,EAAE,SAAS,CAAC;IACjC,SAAgB,QAAQ,EAAE,SAAS,CAAC;IACpC,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAW;gBAE7B,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG;IAYlE;;;OAGG;IACH,GAAG,CAAC,KAAK,SAAK,GAAG,MAAM;IAIvB;;OAEG;IACH,EAAE,IAAI,MAAM;IAIZ;;OAEG;IACH,iBAAiB,IAAI,MAAM;IAI3B;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB,yBAAyB,IAAI,MAAM,EAAE;IAmDrC;;OAEG;IACH,gCAAgC,IAAI,MAAM,EAAE;IAI5C;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;;OAIG;IACH,aAAa,IAAI,MAAM;IAIvB;;;;OAIG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;;;OAIG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;OAEG;IACH,IAAI,IAAI,MAAM;IAId;;OAEG;IACI,KAAK,IAAI,MAAM;IAItB;;OAEG;IACI,MAAM,IAAI,MAAM,EAAE;IAIzB;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;;OAKG;IACI,YAAY,IAAI,MAAM,GAAG,SAAS;IAIzC;;;OAGG;IACH,oBAAoB,IAAI,GAAG;IAO3B;;OAEG;IACH,YAAY,IAAI,kBAAkB,GAAG,SAAS;IAI9C;;OAEG;IACH,gBAAgB,IAAI,gBAAgB,EAAE;IAMtC;;;;OAIG;IACG,OAAO,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKlE;;;;OAIG;IACG,YAAY,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;IAuBhE;;;;;OAKG;IACG,cAAc,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAwBtE;;;;OAIG;IACG,SAAS,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAwG5D;;;OAGG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAKhE;;;OAGG;IACG,oBAAoB,CAAC,MAAM,GAAE,2BAAgC,GAAG,OAAO,CAAC,GAAG,CAAC;IAKlF;;;;;;;;;;;;;;;OAeG;IACG,gBAAgB,CAAC,MAAM,GAAE,uBAA4B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkBvF;;;;OAIG;IACG,QAAQ,CAAC,MAAM,GAAE,eAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAgB1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;YACW,cAAc;IAkD5B;;;;;;;;;;;;;;;;;;;OAmBG;IACG,mBAAmB,CAAC,MAAM,GAAE,0BAA+B,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhF;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAItE;;;;OAIG;IACG,0BAA0B,CAAC,UAAU,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;;;;;;UAUM;IACA,gBAAgB,CAAC,cAAc,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9D;;;;;;;OAOG;IACG,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAerE;;;;;;;;;;;OAWG;IACG,mBAAmB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAe3E;;;;;;;;;;;;;OAaG;IACG,KAAK,CAAC,MAAM,GAAE,YAAiB,GAAG,OAAO,CAAC,GAAG,CAAC;IA+DpD;;;;OAIG;IACG,MAAM,CAAC,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAYtD;;;;OAIG;IACG,eAAe,CAAC,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,GAAG,CAAC;IASxE;;;;OAIG;IACG,SAAS,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAqF5D;;;;OAIG;IACG,UAAU,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;IAqB9D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,aAAa,CAAC,MAAM,GAAE,oBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IAwIpE;;;;OAIG;IACG,aAAa,CAAC,MAAM,GAAE,oBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IAapE;;;OAGG;IACG,YAAY,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBhE;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,GAAG,CAAC;IA0BxE;;;OAGG;IACG,UAAU,CAAC,MAAM,GAAE,oBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IAMjE;;;OAGG;IACG,aAAa,CAAC,MAAM,GAAE,oBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IAMpE;;;;;;OAMG;IACG,wBAAwB,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBrG;;;;;OAKG;IACG,MAAM,CAAC,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAiCtD;;;OAGG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBhE;;;;OAIG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IA+EhE;;;;;OAKG;IACG,UAAU,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,mBAAmB,CAAC,MAAM,GAAE,0BAA+B,GAAG,OAAO,CAAC,yBAAyB,CAAC;IA8CtG;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,GAAE,4BAAiC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsC5F;;;;OAIG;IACH,UAAU,CAAC,MAAM,GAAE,iBAAsB,GAAG,MAAM;IAsClD;;;OAGG;IACG,0BAA0B,CAAC,MAAM,GAAE,iCAAsC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAqF5G;;;OAGG;IACG,qBAAqB,CAAC,MAAM,GAAE,4BAAiC,GAAG,OAAO,CAAC,GAAG,CAAC;IAmDpF;;;;;OAKG;IACG,iBAAiB,CAAC,MAAM,GAAE,wBAA6B,GAAG,OAAO,CAAC,GAAG,CAAC;IAiB5E;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,MAAM,GAAE,WAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAoClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,MAAM,GAAE,eAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAwD1D;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,GAAE,mBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBlE;;;;OAIG;IACG,0BAA0B,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlF;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAS5D;;;;;;OAMG;IACG,cAAc,CAAC,MAAM,GAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAOjE;;;;;;;;;OASG;IACG,mBAAmB,CAAC,MAAM,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzD;;;;;;OAMG;IACG,gBAAgB,CAAC,MAAM,GAAE,uBAA4B,GAAG,OAAO,CAAC,GAAG,CAAC;IAc1E;;;;;;OAMG;IACG,aAAa,CAAC,MAAM,GAAE,GAAQ;IAcpC;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,GAAE,uBAA4B,GAAG,OAAO,CAAC,GAAG,CAAC;IAM1E;;;;OAIG;IACG,MAAM,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9D;;OAEG;IACH,MAAM,IAAI,UAAU;IAIpB;;OAEG;IACH,gBAAgB,IAAI,cAAc;IAOlC;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,CAAC,MAAM,GAAE,sBAA2B,GAAG,IAAI;IA8E1D;;;;OAIG;IACG,0BAA0B,CAC9B,MAAM,GAAE,oCAAyC,GAChD,OAAO,CAAC,yBAAyB,EAAE,CAAC;IA4CvC;;;;;;OAMG;IACG,wBAAwB,CAAC,MAAM,GAAE,iCAAsC,GAAG,OAAO,CAAC,GAAG,CAAC;IAgC5F;;;;OAIG;IACG,yBAAyB,CAAC,MAAM,GAAE,oCAAyC,GAAG,OAAO,CAAC,GAAG,CAAC;IAgChG;;;;OAIG;YACW,sBAAsB;IA+DpC;;;;OAIG;YACW,kBAAkB;IA2BhC;;;;OAIG;YACW,WAAW;CAQ1B"}