@lombard.finance/sdk 4.0.0 → 4.1.2

package/src/chains/btc/actions/depositAndDeploy/index.ts

@@ -1,24 +0,0 @@
-/**
- * BTC DepositAndDeploy Action
- *
- * Exports for BTC → BTC.b → Vault operations.
- *
- * @module chains/btc/actions/depositAndDeploy
- */
-
-export { BtcDepositAndDeploy } from './BtcDepositAndDeploy';
-export {
-  depositAndDeployConfig,
-  isAssetOutSupported as isDepositAndDeployAssetOutSupported,
-  isDestChainSupported as isDepositAndDeployDestChainSupported,
-  isProtocolSupported as isDepositAndDeployProtocolSupported,
-  isRouteAvailable as isDepositAndDeployRouteAvailable,
-} from './config';
-export { createBtcDepositAndDeploy } from './factory';
-export {
-  BtcActionStatus,
-  type BtcDepositAndDeployParams,
-  type BtcDepositAndDeployPrepareParams,
-  type BtcDepositAndDeployProgress,
-  type BtcDepositAndDeploy as IBtcDepositAndDeploy,
-} from './types';

package/src/chains/btc/actions/depositAndDeploy/types.ts

@@ -1,120 +0,0 @@
-/**
- * BTC DepositAndDeploy Action Types
- *
- * Type definitions for BTC → BTC.b → Vault operations.
- * This is the deposit equivalent of StakeAndDeploy, producing BTC.b
- * instead of LBTC for protocols that require wrapped BTC (e.g., Silo on Avalanche).
- *
- * @module chains/btc/actions/depositAndDeploy/types
- */
-
-import type {
-  AssetId,
-  Chain,
-  DeployProtocol,
-  StepStatus,
-  StrategyProgress,
-} from '../../../../core';
-import type { MonitorableAction } from '../../../../shared/actions/BaseAction';
-import { BtcActionStatus } from '../../../../shared/constants/statusConstants';
-import type { MonitorProgress } from '../../../../shared/monitoring';
-
-// Re-export for convenience (single export statement avoids duplicate identifier)
-export { BtcActionStatus };
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Parameters
-// ═══════════════════════════════════════════════════════════════════════════
-
-/**
- * BTC DepositAndDeploy parameters
- */
-export interface BtcDepositAndDeployParams {
-  /** Input asset (BTC) */
-  assetIn?: AssetId;
-  /** Output asset (BTC.b vault shares) */
-  assetOut: AssetId;
-  /** Source Bitcoin network */
-  sourceChain?: typeof Chain.BITCOIN_MAINNET | typeof Chain.BITCOIN_SIGNET;
-  /** Destination chain where vault exists (e.g., Avalanche for Silo) */
-  destChain: Chain;
-  /** Protocol/vault to deploy to (e.g., Silo) */
-  protocol: DeployProtocol;
-}
-
-/**
- * Prepare parameters
- */
-export interface BtcDepositAndDeployPrepareParams {
-  /** Amount of BTC to deposit and deploy (human-readable) */
-  amount: string;
-  /** Recipient address on destination chain */
-  recipient: string;
-  /** Optional referral code */
-  referralCode?: string;
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Progress
-// ═══════════════════════════════════════════════════════════════════════════
-
-/**
- * BTC DepositAndDeploy progress
- */
-export interface BtcDepositAndDeployProgress
-  extends StrategyProgress<BtcActionStatus> {
-  status: BtcActionStatus;
-  steps: {
-    created: StepStatus;
-    verifying: StepStatus;
-    wrapping: StepStatus;
-    depositing: StepStatus;
-  };
-  depositAddress?: string;
-  confirmations?: number;
-  requiredConfirmations?: number;
-  hasEnoughConfirmations?: boolean;
-  isWrapped?: boolean;
-  isDeposited?: boolean;
-  metadata?: Record<string, unknown>;
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Interface
-// ═══════════════════════════════════════════════════════════════════════════
-
-/**
- * BTC DepositAndDeploy interface
- */
-export interface BtcDepositAndDeploy extends MonitorableAction {
-  readonly status: BtcActionStatus;
-  readonly amount?: string;
-  readonly recipient?: string;
-  readonly depositAddress?: string;
-  readonly referralCode?: string;
-
-  /**
-   * Prepare the operation
-   */
-  prepare(params: BtcDepositAndDeployPrepareParams): Promise<void>;
-
-  /**
-   * Authorize vault deposit via signature
-   */
-  authorizeDeposit(): Promise<void>;
-
-  /**
-   * Generate BTC deposit address
-   */
-  generateDepositAddress(): Promise<string>;
-
-  /**
-   * Execute the operation
-   */
-  execute(): Promise<{ depositAddress: string; txHash?: string }>;
-
-  /**
-   * Monitor deposit progress
-   */
-  monitorDeposit?(): Promise<MonitorProgress | undefined>;
-}

package/src/chains/btc/actions/index.ts

@@ -1,14 +0,0 @@
-/**
- * BTC Actions Exports
- *
- * @module chains/btc/actions
- */
-
-// Stake action
-export * from './stake';
-
-// Deposit action
-export * from './deposit';
-
-// StakeAndDeploy action
-export * from './stakeAndDeploy';

package/src/chains/btc/actions/shared/BaseBtcAction.ts

@@ -1,495 +0,0 @@
-/**
- * Base BTC Action Class
- *
- * Provides common functionality for all BTC actions:
- * - State management (amount, recipient, depositAddress, referralCode)
- * - Ensure methods for validation
- * - Bitcoin network helpers
- * - Deposit monitoring
- * - Bitcoin send operations
- * - Common validation and prepare patterns
- *
- * @module chains/btc/actions/shared/BaseBtcAction
- */
-
-import { z } from 'zod';
-
-import {
-  ChainId,
-  SolanaChain,
-  StarknetChainId,
-  SuiChain,
-} from '../../../../common/chains';
-import { Chain, StepStatus } from '../../../../core';
-import { BaseAction } from '../../../../shared/actions';
-import type { BtcCoreContext } from '../../../../shared/context';
-import { LombardError, ValidationErrorCode } from '../../../../shared/errors';
-import type {
-  MonitorProgress,
-  NetworkMode,
-} from '../../../../shared/monitoring';
-import { monitorDeposit } from '../../../../shared/monitoring';
-import type { EventHandler } from '../../../../shared/monitoring/createEventEmitter';
-import {
-  btcStakeAmountSchema,
-  referralCodeSchema,
-  validatePrepareParams as zodValidate,
-} from '../../../../shared/validation';
-import { ensureNotSanctionedAddress } from '../../../../utils/ensureNotSanctionedAddress';
-import { toSatoshi } from '../../../../utils/satoshi';
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Types
-// ═══════════════════════════════════════════════════════════════════════════
-
-/**
- * Common authorization state for BTC actions
- */
-export interface BtcAuthorizationState {
-  authorized: boolean;
-  signature?: string;
-  typedData?: unknown;
-  [key: string]: unknown;
-}
-
-/**
- * Common params that all BTC actions share
- */
-export interface BaseBtcParams {
-  sourceChain?: typeof Chain.BITCOIN_MAINNET | typeof Chain.BITCOIN_SIGNET;
-  destChain: Chain;
-}
-
-/**
- * Common prepare params
- */
-export interface BasePrepareParams {
-  amount: string;
-  recipient: string;
-  referralCode?: string;
-}
-
-/**
- * Progress step definitions
- */
-export type StepDefinition = Record<string, StepStatus>;
-
-/**
- * Status configuration for template methods
- */
-export interface StatusConfig<TStatus extends string> {
-  idle: TStatus;
-  ready: TStatus;
-  addressReady: TStatus;
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Base Class
-// ═══════════════════════════════════════════════════════════════════════════
-
-/**
- * Base class for BTC actions
- *
- * Provides template methods for common patterns:
- * - prepare() with validation and resume
- * - generateDepositAddress()
- * - execute()
- * - monitorDeposit()
- *
- * Subclasses implement abstract methods to customize behavior.
- *
- * @example
- * ```typescript
- * class BtcStake extends BaseBtcAction<StakeEventMap, BtcActionStatus, BtcStakeParams> {
- *   protected getAddressSchema() { return evmAddressSchema; }
- *   protected getStatusConfig() { return { idle: BtcActionStatus.IDLE, ... }; }
- *   protected getInitialSteps() { return { created: StepStatus.IDLE, ... }; }
- * }
- * ```
- */
-export abstract class BaseBtcAction<
-  TEventMap extends Record<string, EventHandler<unknown[]>>,
-  TStatus extends string,
-  TParams extends BaseBtcParams,
-> extends BaseAction<TEventMap, TStatus> {
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common State
-  // ─────────────────────────────────────────────────────────────────────────
-
-  protected _amount?: string;
-  protected _recipient?: string;
-  protected _depositAddress?: string;
-  protected _referralCode?: string;
-  protected _chainId?: unknown;
-
-  constructor(
-    protected readonly ctx: BtcCoreContext,
-    protected readonly params: TParams,
-    initialStatus: TStatus,
-  ) {
-    super(initialStatus);
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Abstract Methods - Subclasses Must Implement
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /** Get the address validation schema for this action */
-  protected abstract getAddressSchema(): z.ZodType<string>;
-
-  /** Get the status configuration for template methods */
-  protected abstract getStatusConfig(): StatusConfig<TStatus>;
-
-  /** Get the initial progress steps for this action */
-  protected abstract getInitialSteps(): StepDefinition;
-
-  /** Check if the action has been authorized */
-  protected abstract isAuthorized(): boolean;
-
-  /** Get the chain ID (after parsing in constructor) */
-  protected abstract getChainId():
-    | ChainId
-    | SuiChain
-    | SolanaChain
-    | StarknetChainId;
-
-  /**
-   * Get API params for generateDepositAddress
-   * Subclasses provide action-specific parameters
-   */
-  protected abstract getDepositAddressParams(): {
-    address: string;
-    chainId: ChainId | SuiChain | SolanaChain | StarknetChainId;
-    signature: string;
-    token: string;
-    eip712Data?: string;
-    signatureData?: string;
-    pubKey?: string;
-    partnerId?: string;
-    referrerCode?: string;
-  };
-
-  /**
-   * Get the expected destination token (LBTC, BTCb, etc.)
-   * Used for resuming from existing deposits before authorization is complete
-   */
-  protected abstract getExpectedToken(): string;
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common Getters
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /** Amount of BTC to stake/deposit */
-  get amount(): string | undefined {
-    return this._amount;
-  }
-
-  /** Recipient address on destination chain */
-  get recipient(): string | undefined {
-    return this._recipient;
-  }
-
-  /** Generated Bitcoin deposit address */
-  get depositAddress(): string | undefined {
-    return this._depositAddress;
-  }
-
-  /** Referral code (optional) */
-  get referralCode(): string | undefined {
-    return this._referralCode;
-  }
-
-  /** Bitcoin network mode for monitoring */
-  protected get bitcoinNetwork(): NetworkMode {
-    const source = this.params.sourceChain;
-    return source === Chain.BITCOIN_MAINNET ? 'mainnet' : 'testnet';
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common Validation
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /**
-   * Get the prepare schema (amount + recipient + referralCode)
-   * Uses abstract getAddressSchema() for chain-specific validation
-   */
-  protected get prepareSchema() {
-    return z.object({
-      amount: btcStakeAmountSchema,
-      recipient: this.getAddressSchema(),
-      referralCode: referralCodeSchema,
-    });
-  }
-
-  /**
-   * Validate prepare params using Zod
-   * Subclasses can override if they need custom validation
-   */
-  protected validatePrepareParams(
-    params: BasePrepareParams,
-  ): BasePrepareParams {
-    return zodValidate(this.prepareSchema, params, {
-      destChain: this.params.destChain,
-    });
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Ensure Methods (throw if missing)
-  // ─────────────────────────────────────────────────────────────────────────
-
-  protected ensureRecipient(): string {
-    if (!this._recipient) {
-      throw LombardError.missingParameter('recipient');
-    }
-    return this._recipient;
-  }
-
-  protected ensureAmount(): string {
-    if (!this._amount) {
-      throw LombardError.missingParameter('amount');
-    }
-    return this._amount;
-  }
-
-  protected ensureDepositAddress(): string {
-    if (!this._depositAddress) {
-      throw new LombardError(
-        ValidationErrorCode.INVALID_PARAMETER,
-        'Deposit address not generated. Call generateDepositAddress() first.',
-      );
-    }
-    return this._depositAddress;
-  }
-
-  /**
-   * Get error message for missing authorization
-   * Subclasses can override to provide specific messages
-   */
-  protected getAuthRequiredMessage(): string {
-    return 'Authorization required. Complete the authorization step first.';
-  }
-
-  protected ensureAuthorized(): void {
-    if (!this.isAuthorized()) {
-      throw new LombardError(
-        ValidationErrorCode.INVALID_PARAMETER,
-        this.getAuthRequiredMessage(),
-      );
-    }
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common Resume Logic
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /**
-   * Try to resume from an existing deposit address
-   *
-   * This method only stores the deposit address if found.
-   * It does NOT update the status - the caller must do that
-   * after performing any additional validation (e.g., fee authorization).
-   *
-   * @param recipient - The recipient address to check
-   * @returns true if a deposit address was found, false otherwise
-   */
-  protected async resumeFromExistingDeposit(
-    recipient: string,
-  ): Promise<boolean> {
-    try {
-      const depositAddress = await this.ctx.api.getDepositAddress({
-        address: recipient,
-        chainId: this.getChainId(),
-        token: this.getExpectedToken(),
-        partnerId: this.ctx.partner.getPartnerId(),
-      });
-
-      if (!depositAddress) {
-        return false;
-      }
-
-      this._depositAddress = depositAddress;
-      // NOTE: Status is NOT updated here - caller must set appropriate status
-      // after validating fee authorization (which may have expired)
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common Generate Deposit Address
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /**
-   * Generate a Bitcoin deposit address
-   *
-   * Template method that:
-   * 1. Validates status and authorization
-   * 2. Calls API to generate address
-   * 3. Updates state and emits progress
-   *
-   * Subclasses must implement getDepositAddressParams() to provide API params.
-   */
-  protected async generateDepositAddressImpl(): Promise<string> {
-    const statusConfig = this.getStatusConfig();
-
-    this.assertStatus(statusConfig.ready, 'generateDepositAddress');
-    this.ensureAuthorized();
-
-    if (this._depositAddress) {
-      return this._depositAddress;
-    }
-
-    return this.act(async () => {
-      const apiParams = this.getDepositAddressParams();
-
-      const depositAddress =
-        await this.ctx.api.generateDepositAddress(apiParams);
-
-      ensureNotSanctionedAddress(depositAddress);
-      this._depositAddress = depositAddress;
-
-      // Emit progress with address ready
-      const steps = this.getInitialSteps();
-      const addressReadySteps = Object.fromEntries(
-        Object.entries(steps).map(([key], index) => [
-          key,
-          index === 0 ? StepStatus.COMPLETE : StepStatus.IDLE,
-        ]),
-      );
-
-      this.emitProgress({
-        status: statusConfig.addressReady,
-        steps: addressReadySteps,
-        metadata: { depositAddress },
-      });
-
-      return depositAddress;
-    }, statusConfig.addressReady);
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common Execute Pattern
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /**
-   * Execute the action - generate address and optionally send BTC
-   *
-   * Template method that:
-   * 1. Ensures deposit address exists
-   * 2. Tries to send BTC if provider available
-   * 3. Returns result
-   */
-  protected async executeImpl(): Promise<{
-    depositAddress: string;
-    txHash?: string;
-  }> {
-    const statusConfig = this.getStatusConfig();
-
-    return this.act(async () => {
-      this.assertStatus(statusConfig.addressReady, 'execute');
-
-      if (!this._depositAddress) {
-        await this.generateDepositAddressImpl();
-      }
-
-      const depositAddress = this.ensureDepositAddress();
-      const txHash = await this.trySendBitcoin(depositAddress);
-
-      return txHash ? { depositAddress, txHash } : { depositAddress };
-    });
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Common Progress Emission
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /**
-   * Emit initial progress with action-specific steps
-   */
-  protected emitInitialProgress(): void {
-    this.emitProgress({
-      status: this.status,
-      steps: this.getInitialSteps(),
-    });
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Deposit Monitoring
-  // ─────────────────────────────────────────────────────────────────────────
-
-  /**
-   * Monitor Bitcoin deposit progress
-   */
-  async monitorDeposit(): Promise<MonitorProgress | undefined> {
-    const depositAddress = this._depositAddress;
-    const recipient = this._recipient;
-
-    if (!depositAddress || !recipient) {
-      throw LombardError.missingParameter('depositAddress or recipient');
-    }
-
-    const progress = await monitorDeposit({
-      network: this.bitcoinNetwork,
-      btcService: this.ctx.btc,
-      fetchDeposit: async () => {
-        const deposits = await this.ctx.api.getDeposits(recipient);
-        const ourDeposit = deposits.find(
-          deposit => deposit.depositAddress === depositAddress,
-        );
-
-        if (!ourDeposit) {
-          return undefined;
-        }
-
-        return {
-          blockHeight: ourDeposit.blockHeight,
-          isClaimed: ourDeposit.isClaimed,
-        };
-      },
-      onProgress: p => {
-        this.emitProgress({
-          status: this.status,
-          steps: p.steps,
-          confirmations: p.confirmations,
-          requiredConfirmations: p.requiredConfirmations,
-          metadata: { isClaimed: p.isClaimed },
-        });
-      },
-      onComplete: () => {
-        this.emitCompleted();
-      },
-    });
-
-    return progress;
-  }
-
-  // ─────────────────────────────────────────────────────────────────────────
-  // Bitcoin Send (Optional)
-  // ─────────────────────────────────────────────────────────────────────────
-
-  protected async trySendBitcoin(
-    depositAddress: string,
-  ): Promise<string | undefined> {
-    const amount = this._amount;
-    if (!amount) return undefined;
-
-    try {
-      const btcProvider = await this.ctx.getProvider('bitcoin');
-      if (!btcProvider) return undefined;
-
-      const provider = btcProvider as {
-        sendBitcoin?: (address: string, amountSats: number) => Promise<string>;
-      };
-
-      if (provider.sendBitcoin) {
-        const amountSats = toSatoshi(amount).toNumber();
-        return provider.sendBitcoin(depositAddress, amountSats);
-      }
-    } catch {
-      // Fall back to manual send
-    }
-
-    return undefined;
-  }
-}

package/src/chains/btc/actions/shared/index.ts

@@ -1,28 +0,0 @@
-/**
- * Shared BTC Action Utilities
- *
- * Common utilities and base classes for BTC actions.
- *
- * @module chains/btc/actions/shared
- */
-
-export type {
-  BaseBtcParams,
-  BtcAuthorizationState,
-  StatusConfig,
-  StepDefinition,
-} from './BaseBtcAction';
-export { BaseBtcAction } from './BaseBtcAction';
-export { assetIdToToken } from './tokenUtils';
-export type {
-  ValidatableConfig,
-  ValidatableParams,
-  ValidationContext,
-} from './validation';
-export {
-  isAssetSupported,
-  isDestChainSupported,
-  isRouteAvailable,
-  validateBtcActionParams,
-  validateProtocol,
-} from './validation';