Events Reference

This section defines all events emitted by the SDK and how to handle them. Covers what triggers each event, what data it returns, and how to implement event listeners in your application.

---

Event Constants

Source: packages/sdk/src/shared/events.ts

All action types emit the same event types:

const StakeEvent = {
  Progress: 'progress',
  StatusChange: 'status-change',
  Completed: 'completed',
  Failed: 'failed',
  Error: 'error',
} as const;

Available Event Constants

import {
  StakeEvent,
  DepositEvent,
  UnstakeEvent,
  DeployEvent,
  RedeemEvent,
  BridgeEvent,
  StakeAndDeployEvent,
  DepositAndDeployEvent,
} from '@lombard.finance/sdk';

---

Event Handlers

StakeEventMap

interface StakeEventMap {
  'progress': (progress: StrategyProgress<string>) => void;
  'status-change': (status: string) => void;
  'completed': () => void;
  'failed': () => void;
  'error': (error: LombardError) => void;
}

DepositEventMap

interface DepositEventMap {
  'progress': (progress: StrategyProgress<string>) => void;
  'status-change': (status: string) => void;
  'completed': () => void;
  'failed': () => void;
  'error': (error: LombardError) => void;
}

UnstakeEventMap

interface UnstakeEventMap {
  'progress': (progress: StrategyProgress<string>) => void;
  'status-change': (status: string) => void;
  'completed': () => void;
  'failed': () => void;
  'error': (error: LombardError) => void;
}

---

Usage

Subscribing

import { StakeEvent } from '@lombard.finance/sdk';

stake.on(StakeEvent.Progress, (progress) => {
  // progress.status, progress.steps
});

stake.on(StakeEvent.StatusChange, (status) => {
  // status: string
});

stake.on(StakeEvent.Completed, () => {
  // Operation completed
});

stake.on(StakeEvent.Error, (error) => {
  // error: LombardError
});

Unsubscribing

const handler = (status: string) => {
  // Handle status change
};

stake.on(StakeEvent.StatusChange, handler);
stake.off(StakeEvent.StatusChange, handler);

---

Progress Object

interface StrategyProgress<TStatus> {
  status: TStatus;
  steps: Record<string, StepStatus>;
  confirmations?: number;
  requiredConfirmations?: number;
  metadata?: Record<string, unknown>;
}

---