BTC Deposit

The BTC Deposit action converts native Bitcoin to BTC.b (wrapped Bitcoin) on EVM chains. It works similarly to BTC Stake but generates BTC.b rather than LBTC.

Basic Usage


import { createLombardSDK, Chain, AssetId } from '@lombard.finance/sdk';
import { config } from './lib/lombard';
 
const sdk = createLombardSDK(config);
 
const deposit = sdk.chain.btc.deposit({
  destChain: Chain.ETHEREUM,
  assetOut: AssetId.BTCb,
});
 
await deposit.prepare({
  amount: '0.1',
  recipient: '0x1234567890abcdef1234567890abcdef12345678',
});
 
await deposit.authorize();
 
const depositAddress = await deposit.generateDepositAddress();
// depositAddress: 'bc1q...'

Parameters

Deposit Options

Parameter	Type	Required	Description
`destChain`	`Chain`	Yes	Target EVM chain for BTC.b
`assetOut`	`AssetId`	Yes	Must be `AssetId.BTCb`
`sourceChain`	`Chain`	No	Bitcoin network selection

Prepare Parameters

Parameter	Type	Required	Description
`amount`	`string`	Yes	BTC quantity
`recipient`	`string`	Yes	EVM address for BTC.b
`referralCode`	`string`	No	Partner attribution code

Status Flow


IDLE → NEEDS_FEE_AUTHORIZATION → READY → ADDRESS_READY