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

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

@@ -0,0 +1,134 @@
+import { IBaseCoin } from '../baseCoin';
+import { BitGoBase } from '../bitgoBase';
+import { AcceptShareOptions, AddWalletOptions, GenerateWalletOptions, GetWalletByAddressOptions, GetWalletOptions, IWallets, ListWalletOptions, UpdateShareOptions, WalletWithKeychains } from './iWallets';
+import { Wallet } from './wallet';
+export declare class Wallets implements IWallets {
+    private readonly bitgo;
+    private readonly baseCoin;
+    constructor(bitgo: BitGoBase, baseCoin: IBaseCoin);
+    /**
+     * Get a wallet by ID (proxy for getWallet)
+     * @param params
+     */
+    get(params?: GetWalletOptions): Promise<Wallet>;
+    /**
+     * List a user's wallets
+     * @param params
+     * @returns {*}
+     */
+    list(params?: ListWalletOptions): Promise<{
+        wallets: Wallet[];
+    }>;
+    /**
+     * add
+     * Add a new wallet (advanced mode).
+     * This allows you to manually submit the keys, type, m and n of the wallet
+     * Parameters include:
+     *    "label": label of the wallet to be shown in UI
+     *    "m": number of keys required to unlock wallet (2)
+     *    "n": number of keys available on the wallet (3)
+     *    "keys": array of keychain ids
+     */
+    add(params?: AddWalletOptions): Promise<any>;
+    /**
+     * Generate a new wallet
+     * 1. Creates the user keychain locally on the client, and encrypts it with the provided passphrase
+     * 2. If no pub was provided, creates the backup keychain locally on the client, and encrypts it with the provided passphrase
+     * 3. Uploads the encrypted user and backup keychains to BitGo
+     * 4. Creates the BitGo key on the service
+     * 5. Creates the wallet on BitGo with the 3 public keys above
+     * @param params
+     * @param params.label
+     * @param params.passphrase
+     * @param params.userKey User xpub
+     * @param params.backupXpub Backup xpub
+     * @param params.backupXpubProvider
+     * @param params.enterprise
+     * @param params.disableTransactionNotifications
+     * @param params.passcodeEncryptionCode
+     * @param params.coldDerivationSeed
+     * @param params.gasPrice
+     * @param params.disableKRSEmail
+     * @param params.walletVersion
+     * @param params.multisigType optional multisig type, 'onchain' or 'tss' or 'blsdkg'; if absent, we will defer to the coin's default type
+     * @returns {*}
+     */
+    generateWallet(params?: GenerateWalletOptions): Promise<WalletWithKeychains>;
+    /**
+     * List the user's wallet shares
+     * @param params
+     */
+    listShares(params?: Record<string, unknown>): Promise<any>;
+    /**
+     * Gets a wallet share information, including the encrypted sharing keychain. requires unlock if keychain is present.
+     * @param params
+     * @param params.walletShareId - the wallet share to get information on
+     */
+    getShare(params?: {
+        walletShareId?: string;
+    }): Promise<any>;
+    /**
+     * Update a wallet share
+     * @param params.walletShareId - the wallet share to update
+     * @param params.state - the new state of the wallet share
+     * @param params
+     */
+    updateShare(params?: UpdateShareOptions): Promise<any>;
+    /**
+     * Resend a wallet share invitation email
+     * @param params
+     * @param params.walletShareId - the wallet share whose invitiation should be resent
+     */
+    resendShareInvite(params?: {
+        walletShareId?: string;
+    }): Promise<any>;
+    /**
+     * Cancel a wallet share
+     * @param params
+     * @param params.walletShareId - the wallet share to update
+     */
+    cancelShare(params?: {
+        walletShareId?: string;
+    }): Promise<any>;
+    /**
+     * Accepts a wallet share, adding the wallet to the user's list
+     * Needs a user's password to decrypt the shared key
+     *
+     * @param params
+     * @param params.walletShareId - the wallet share to accept
+     * @param params.userPassword - (required if more a keychain was shared) user's password to decrypt the shared wallet
+     * @param params.newWalletPassphrase - new wallet passphrase for saving the shared wallet prv.
+     *                                     If left blank and a wallet with more than view permissions was shared,
+     *                                     then the user's login password is used.
+     * @param params.overrideEncryptedPrv - set only if the prv was received out-of-band.
+     */
+    acceptShare(params?: AcceptShareOptions): Promise<any>;
+    /**
+     * Get a wallet by its ID
+     * @param params
+     * @param params.id wallet id
+     * @returns {*}
+     */
+    getWallet(params?: GetWalletOptions): Promise<Wallet>;
+    /**
+     * Get a wallet by its address
+     * @param params
+     * @param params.address wallet address
+     * @returns {*}
+     */
+    getWalletByAddress(params?: GetWalletByAddressOptions): Promise<Wallet>;
+    /**
+     * For any given supported coin, get total balances for all wallets of that
+     * coin type on the account.
+     * @param params
+     * @returns {*}
+     */
+    getTotalBalances(params?: Record<string, never>): Promise<any>;
+    /**
+     * Generates a TSS or BLS-DKG Wallet.
+     * @param params
+     * @private
+     */
+    private generateMpcWallet;
+}
+//# sourceMappingURL=wallets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/wallet/wallets.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAqD,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAEhB,qBAAqB,EACrB,yBAAyB,EACzB,gBAAgB,EAChB,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,qBAAa,OAAQ,YAAW,QAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;gBAEzB,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS;IAKjD;;;OAGG;IACG,GAAG,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzD;;;;OAIG;IACG,IAAI,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAsC1E;;;;;;;;;OASG;IACG,GAAG,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAyFtD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,cAAc,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+PtF;;;OAGG;IACG,UAAU,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE;;;;OAIG;IACG,QAAQ,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAMrE;;;;;OAKG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAShE;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9E;;;;OAIG;IACG,WAAW,CAAC,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IASxE;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IA4DhE;;;;;OAKG;IACG,SAAS,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB/D;;;;;OAKG;IACG,kBAAkB,CAAC,MAAM,GAAE,yBAA8B,GAAG,OAAO,CAAC,MAAM,CAAC;IASjF;;;;;OAKG;IACG,gBAAgB,CAAC,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE;;;;OAIG;YACW,iBAAiB;CA0ChC"}