Merge pull request #9211 from BitGo/venkatesh/defi-279-deposittovault-getvaultconfig

feat(sdk-core): depositToVault with getVaultConfig and Concrete BTC support

Author: venkateshv1266

commitlint.config.js

@@ -85,6 +85,7 @@ module.exports = {
         'CHALO-',
         'CECHO-',
         'CSHLD-',
+        'DEFI-',
         '#', // Prefix used by GitHub issues
       ],
     },

modules/sdk-core/src/bitgo/defi/defiVault.ts

@@ -1,18 +1,24 @@
 /**
  * @prettier
  */
+import * as t from 'io-ts';
+import { GetVaultResponse, VaultProtocol } from '@bitgo/public-types';
 import {
+  ConcreteDepositResult,
+  MorphoDepositResult,
   DefiOperation,
   DefiOperationListResult,
   DepositResult,
   DepositToVaultOptions,
   GetOperationOptions,
+  GetVaultConfigOptions,
   IDefiVault,
   ListOperationsOptions,
   ResumeDepositOptions,
 } from './iDefiVault';
 import { IWallet } from '../wallet';
 import { BitGoBase } from '../bitgoBase';
+import { decodeWithCodec } from '../utils';
 
 /**
  * Error thrown when a concurrent active deposit already exists for the (wallet, vault) pair.
@@ -47,13 +53,26 @@ export class DefiVault implements IDefiVault {
     this.bitgo = wallet.bitgo;
   }
 
+  /**
+   * Fetch vault config from defi-service. Used internally to determine
+   * which deposit path to take (Concrete vs Morpho).
+   */
+  async getVaultConfig(params: GetVaultConfigOptions): Promise<GetVaultResponse> {
+    if (!params.vaultId) {
+      throw new Error('vaultId is required');
+    }
+    const raw = await this.bitgo
+      .get(this.bitgo.microservicesUrl(`/api/defi-service/v1/vaults/${params.vaultId}`))
+      .result();
+    return decodeWithCodec(GetVaultResponse, raw, 'getVaultConfig');
+  }
+
   /**
    * Deposit an amount of underlying asset into a vault.
    *
-   * Internally issues two sendMany calls (approve + deposit) and returns the
-   * operationId that links them. If the deposit sendMany fails after
-   * the approve succeeds, the error propagates — the server-side reconciler
-   * handles orphaned approvals.
+   * Dispatches to the concrete or morpho path based on vault provider.
+   * The concrete path returns a pendingApproval (custodial wallet).
+   * The morpho path issues two sendMany calls (approve + deposit).
    *
    * @param params.vaultId - DeFi-service vault identifier
    * @param params.amount - amount in base units of the underlying asset
@@ -68,6 +87,41 @@ export class DefiVault implements IDefiVault {
       throw new Error('amount is required');
     }
 
+    const config = await this.getVaultConfig({ vaultId: params.vaultId });
+
+    if (config.protocol === VaultProtocol.CONCRETE_BTCCX) {
+      return this.depositToConcreteVault(params);
+    } else if (config.protocol === VaultProtocol.MORPHO) {
+      return this.depositToMorphoVault(params);
+    } else {
+      throw new Error(`Unsupported vault protocol: ${config.protocol}`);
+    }
+  }
+
+  /**
+   * Concrete BTC vault deposit path. The client BTC wallet is custodial, so
+   * sendMany returns a pendingApproval rather than a signed transfer.
+   * No recipients are sent — WP resolves the escrow destination server-side.
+   */
+  private async depositToConcreteVault(params: DepositToVaultOptions): Promise<ConcreteDepositResult> {
+    const sendManyResult = await this.wallet.sendMany({
+      type: 'defi-deposit',
+      defiParams: {
+        vaultId: params.vaultId,
+        amount: params.amount,
+        actionType: 'defi-deposit',
+      },
+      ...(params.walletPassphrase ? { walletPassphrase: params.walletPassphrase } : {}),
+    });
+
+    return this.extractConcreteDepositResult(sendManyResult);
+  }
+
+  /**
+   * Morpho vault deposit path. Issues two sendMany calls (approve + deposit)
+   * and returns the operationId that links them.
+   */
+  private async depositToMorphoVault(params: DepositToVaultOptions): Promise<MorphoDepositResult> {
     // TODO(CGD-1709): Re-enable active operation pre-flight check once the
     // defi-service operations endpoint is deployed and returning active state.
     // const activeOps: DefiOperationListResult = await this.bitgo
@@ -256,6 +310,22 @@ export class DefiVault implements IDefiVault {
     return intent?.operationId as string | undefined;
   }
 
+  /**
+   * Extracts {@link ConcreteDepositResult} from a custodial sendMany response.
+   * Concrete BTC deposits return a `pendingApproval` instead of a txRequest —
+   * throws if `pendingApproval.id` is absent, indicating an unexpected shape.
+   */
+  private extractConcreteDepositResult(sendManyResult: Record<string, unknown>): ConcreteDepositResult {
+    const SendManyConcreteResponse = t.type({
+      pendingApproval: t.intersection([t.type({ id: t.string }), t.partial({ state: t.string })]),
+    });
+    const decoded = decodeWithCodec(SendManyConcreteResponse, sendManyResult, 'defi-deposit sendMany response');
+    return {
+      pendingApprovalId: decoded.pendingApproval.id,
+      state: decoded.pendingApproval.state ?? 'awaitingSignature',
+    };
+  }
+
   private operationsUrl(): string {
     return `/api/defi-service/v1/wallets/${this.wallet.id()}/operations`;
   }

modules/sdk-core/src/bitgo/defi/iDefiVault.ts

@@ -2,6 +2,8 @@
  * @prettier
  */
 
+import { GetVaultResponse } from '@bitgo/public-types';
+
 export interface DepositToVaultOptions {
   /** DeFi-service vault identifier */
   vaultId: string;
@@ -32,6 +34,10 @@ export interface ListOperationsOptions {
   cursor?: string;
 }
 
+export interface GetVaultConfigOptions {
+  vaultId: string;
+}
+
 export interface DefiOperation {
   operationId: string;
   walletId: string;
@@ -45,14 +51,18 @@ export interface DefiOperation {
   updatedAt: string;
 }
 
-export interface DepositResult {
+export interface ConcreteDepositResult {
+  pendingApprovalId: string;
+  state: string;
+}
+
+export interface MorphoDepositResult {
   operationId: string;
-  txRequestIds: {
-    approve: string;
-    deposit: string;
-  };
+  txRequestIds: { approve: string; deposit: string };
 }
 
+export type DepositResult = ConcreteDepositResult | MorphoDepositResult;
+
 export interface DefiOperationListResult {
   items: DefiOperation[];
   nextCursor?: string;
@@ -63,4 +73,5 @@ export interface IDefiVault {
   resumeDeposit(params: ResumeDepositOptions): Promise<DepositResult>;
   getOperation(params: GetOperationOptions): Promise<DefiOperation>;
   listOperations(params: ListOperationsOptions): Promise<DefiOperationListResult>;
+  getVaultConfig(params: GetVaultConfigOptions): Promise<GetVaultResponse>;
 }

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

@@ -139,6 +139,7 @@ export const BuildParams = t.exact(
       feeToken: t.unknown,
       // Bridging parameters for cross-chain operations (e.g., BTC to sBTC)
       bridgingParams: t.unknown,
+      defiParams: t.unknown,
     }),
   ])
 );

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

@@ -937,6 +937,13 @@ export interface SendManyOptions extends PrebuildAndSignTransactionOptions {
   eip1559?: EIP1559;
   gasLimit?: number;
   custodianTransactionId?: string;
+  defiParams?: {
+    vaultId?: string;
+    amount?: string | number;
+    actionType?: string;
+    operationId?: string;
+    clientIdempotencyKey?: string;
+  };
 }
 
 export interface FetchCrossChainUTXOsOptions {