feat: share lightning wallet

This may not work because we are deriving a new userAuthKey

BTC-1926

TICKET: BTC-1926

Author: davidkaplanbitgo

modules/abstract-lightning/src/wallet/lightning.ts

@@ -8,6 +8,7 @@ import {
   commonTssMethods,
   TxRequestState,
   decodeOrElse,
+  ShareWalletOptions,
 } from '@bitgo/sdk-core';
 import * as t from 'io-ts';
 import { createMessageSignature, unwrapLightningCoinSpecific } from '../lightning';
@@ -190,6 +191,15 @@ export interface ILightningWallet {
    * @returns {Promise<Transaction[]>} List of transactions
    */
   listTransactions(params: TransactionQuery): Promise<Transaction[]>;
+
+  /**
+   * Shares the wallet with another user. Since we are sharing different keys in
+   * different places, it needs to be done through here. For custody wallets,
+   * we only need to share the userAuthKey. For self custody wallets, we need to
+   * share more keys depending on the sharing permissions
+   * @param params {ShareWalletOptions}
+   */
+  shareWallet(params?: ShareWalletOptions): Promise<any>;
 }
 
 export class LightningWallet implements ILightningWallet {
@@ -334,4 +344,20 @@ export class LightningWallet implements ILightningWallet {
       throw new Error(`Invalid transaction list response: ${error}`);
     });
   }
+
+  async shareWallet(params: ShareWalletOptions = {}): Promise<any> {
+    const { needsKeychain, sharing } = await this.wallet.validateShareWalletOptions(params);
+    let sharedKeychain;
+    if (needsKeychain) {
+      const { userAuthKey } = await getLightningAuthKeychains(this.wallet);
+      sharedKeychain = await this.wallet.prepareSharedKeychain(
+        params.walletPassphrase,
+        sharing.pubkey,
+        sharing.path,
+        userAuthKey as any
+      );
+    }
+    console.log(sharedKeychain);
+    return await this.wallet.createShare(this.wallet.prepareCreateShareOptions(params, sharing, sharedKeychain));
+  }
 }

modules/sdk-core/src/bitgo/wallet/iWallet.ts

@@ -854,7 +854,19 @@ export interface IWallet {
   removeWebhook(params?: ModifyWebhookOptions): Promise<any>;
   getEncryptedUserKeychain(): Promise<KeychainWithEncryptedPrv>;
   getPrv(params?: GetPrvOptions): Promise<any>;
+  prepareSharedKeychain(
+    walletPassphrase: string | undefined,
+    pubkey: string,
+    path: string,
+    keychain?: KeychainWithEncryptedPrv
+  ): Promise<SharedKeyChain>;
+  prepareCreateShareOptions(
+    params: ShareWalletOptions,
+    sharing: { userId: string },
+    sharedKeychain: KeychainWithEncryptedPrv | undefined
+  ): CreateShareOptions;
   createShare(params?: CreateShareOptions): Promise<any>;
+  validateShareWalletOptions(params: ShareWalletOptions): Promise<{ needsKeychain: boolean; sharing: any }>;
   shareWallet(params?: ShareWalletOptions): Promise<any>;
   createBulkKeyShares(params?: BulkCreateShareOption[]): Promise<CreateBulkWalletShareListResponse>;
   createBulkWalletShare(params?: BulkWalletShareOptions): Promise<CreateBulkWalletShareListResponse>;

modules/sdk-core/src/bitgo/wallet/wallet.ts

@@ -1612,12 +1612,13 @@ export class Wallet implements IWallet {
   async prepareSharedKeychain(
     walletPassphrase: string | undefined,
     pubkey: string,
-    path: string
+    path: string,
+    keychain?: KeychainWithEncryptedPrv
   ): Promise<SharedKeyChain> {
     let sharedKeychain: SharedKeyChain = {};
 
     try {
-      const keychain = await this.getEncryptedUserKeychain();
+      keychain = keychain ?? (await this.getEncryptedUserKeychain());
 
       // Decrypt the user key with a passphrase
       if (keychain.encryptedPrv) {
@@ -1664,12 +1665,7 @@ export class Wallet implements IWallet {
     return sharedKeychain;
   }
 
-  /**
-   * Share this wallet with another BitGo user.
-   * @param params
-   * @returns {*}
-   */
-  async shareWallet(params: ShareWalletOptions = {}): Promise<any> {
+  async validateShareWalletOptions(params: ShareWalletOptions): Promise<{ needsKeychain: boolean; sharing: any }> {
     common.validateParams(params, ['email', 'permissions'], ['walletPassphrase', 'message']);
     if (params.reshare !== undefined && !_.isBoolean(params.reshare)) {
       throw new Error('Expected reshare to be a boolean.');
@@ -1689,12 +1685,15 @@ export class Wallet implements IWallet {
     }
 
     const sharing = (await this.bitgo.getSharingKey({ email: params.email.toLowerCase() })) as any;
-    let sharedKeychain;
-    if (needsKeychain) {
-      sharedKeychain = await this.prepareSharedKeychain(params.walletPassphrase, sharing.pubkey, sharing.path);
-    }
+    return { needsKeychain: !!needsKeychain, sharing };
+  }
 
-    const options: CreateShareOptions = {
+  prepareCreateShareOptions(
+    params: ShareWalletOptions,
+    sharing: { userId: string },
+    sharedKeychain: KeychainWithEncryptedPrv | undefined
+  ): CreateShareOptions {
+    return {
       user: sharing.userId,
       permissions: params.permissions,
       reshare: params.reshare,
@@ -1703,8 +1702,21 @@ export class Wallet implements IWallet {
       skipKeychain: Object.keys(sharedKeychain ?? {}).length === 0,
       keychain: Object.keys(sharedKeychain ?? {}).length === 0 ? undefined : sharedKeychain,
     };
+  }
+
+  /**
+   * Share this wallet with another BitGo user.
+   * @param params
+   * @returns {*}
+   */
+  async shareWallet(params: ShareWalletOptions = {}): Promise<any> {
+    const { needsKeychain, sharing } = await this.validateShareWalletOptions(params);
+    let sharedKeychain;
+    if (needsKeychain) {
+      sharedKeychain = await this.prepareSharedKeychain(params.walletPassphrase, sharing.pubkey, sharing.path);
+    }
 
-    return await this.createShare(options);
+    return await this.createShare(this.prepareCreateShareOptions(params, sharing, sharedKeychain));
   }
 
   /**