BTC Stake

Stake BTC to receive LBTC on an EVM chain.

---

Overview

The BTC Stake action converts native Bitcoin to LBTC on your chosen destination chain. The flow:

1. Prepare with amount and recipient

2. Authorize the fee or address signature

3. Generate a BTC deposit address

4. Send BTC to the deposit address

5. LBTC is minted on the destination chain

---

Basic Usage

import { createLombardSDK, Chain, AssetId } from '@lombard.finance/sdk';
import { config } from './lib/lombard';

const sdk = createLombardSDK(config);

const stake = sdk.chain.btc.stake({
  destChain: Chain.ETHEREUM,
  assetOut: AssetId.LBTC,
});

await stake.prepare({
  amount: '0.1',
  recipient: '0x1234567890abcdef1234567890abcdef12345678',
});

await stake.authorize();

const depositAddress = await stake.generateDepositAddress();
// depositAddress: 'bc1q...'

// User sends BTC to depositAddress
// LBTC will be minted to recipient after confirmations

---

Parameters

Stake Options

Parameter	Type	Required	Description
destChain	Chain	Yes	Destination chain for LBTC
assetOut	AssetId	Yes	Output asset (AssetId.LBTC)
sourceChain	Chain	No	Bitcoin network (defaults based on env)

Prepare Parameters

Parameter	Type	Required	Description
amount	string	Yes	Amount in BTC (e.g., "0.1")
recipient	string	Yes	Destination address for LBTC
referralCode	string	No	Referral code for attribution

---

With Referral Code

await stake.prepare({
  amount: '0.1',
  recipient: '0x1234567890abcdef1234567890abcdef12345678',
  referralCode: 'PARTNER123',
});

---

Status Flow

To Ethereum

IDLE → NEEDS_FEE_AUTHORIZATION → READY → ADDRESS_READY

To Other EVM Chains

IDLE → NEEDS_ADDRESS_CONFIRMATION → READY → ADDRESS_READY

---

Checking Status

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

if (stake.status === BtcActionStatus.IDLE) {
  await stake.prepare({ amount: '0.1', recipient: '0x...' });
}

if (stake.status === BtcActionStatus.NEEDS_FEE_AUTHORIZATION) {
  await stake.authorize();
}

if (stake.status === BtcActionStatus.READY) {
  const address = await stake.generateDepositAddress();
}

if (stake.status === BtcActionStatus.ADDRESS_READY) {
  // Display deposit address to user
  // stake.depositAddress: 'bc1q...'
}

---

Events (Optional)

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

stake.on(StakeEvent.StatusChange, (status) => {
  // Update UI based on status
});

stake.on(StakeEvent.Progress, (progress) => {
  // progress.confirmations, progress.requiredConfirmations
});

stake.on(StakeEvent.Completed, () => {
  // LBTC minted successfully
});

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

---

Error Handling

import { isLombardError, ProviderErrorCode } from '@lombard.finance/sdk';

try {
  await stake.authorize();
} catch (error) {
  if (isLombardError(error)) {
    if (error.code === ProviderErrorCode.USER_REJECTED) {
      // User cancelled - show retry option
    }
  }
}