Skip to Content

SDK FAQ

Quick answers to common integration questions.


About the Lombard SDK

Lombard SDK is a JavaScript/TypeScript package enabling Bitcoin functionality integration without operating Bitcoin infrastructure. Install via npm and get access to Bitcoin staking, wrapping, yield strategies, and cross-chain routing backed by Lombard’s production infrastructure.

Teams shipping quality products: DeFi protocols launching canonical BTC assets, chains wanting native or whitelabeled Bitcoin, fintechs offering Bitcoin yield, exchanges and wallets adding BTC capabilities, and institutions integrating onchain Bitcoin strategies.

Most teams launch to production in 2-4 weeks: several days testing in the Playground, approximately one week configuring and validating flows, then 1-2 weeks on production integration.

No. Lombard operates custody, validators, cross-chain routing, and monitoring. Teams handle UX and business logic without touching Bitcoin private keys or signing operations.

About Bitcoin Connect

Bitcoin Connect is Lombard’s developer platform for Bitcoin product development. It’s an evolving suite of developer tools including APIs and Oracles freely accessible for integrating Lombard’s assets and infrastructure on any chain, protocol, or application.

The Lombard SDK is the first tool available within Bitcoin Connect. It’s a deployment-ready toolkit for integrating Lombard’s Bitcoin infrastructure directly into your application.

Partner ID

A Partner ID allows users to skip CAPTCHA when generating deposit addresses, tracks deposits to your organization for analytics, and makes you eligible for fee sharing and partner rewards. For testing, use 'test' as your Partner ID. For production, request one via email — typically issued same day.

You can, but requesting separate Partner IDs for different products or integrations enables independent attribution tracking.

How It Works

Create a stake action, prepare with amount and recipient, authorize the signature (fee authorization for Ethereum or address confirmation for other chains), then generate a BTC deposit address. Users send BTC to that address, and LBTC gets minted to their destination address after confirmations.

Each combination of destination chain, recipient address, and Partner ID receives a unique Bitcoin address. These addresses never expire and can receive multiple deposits. Each deposit processes independently.

After sending BTC, several Bitcoin block confirmations occur before LBTC minting. Exact timing depends on Bitcoin network conditions and destination chain settlement. The SDK provides progress events for displaying confirmation status.

Capabilities

Production: Ethereum, Arbitrum, Base, Avalanche, Solana, Sui, and Starknet. Testing: Sepolia, Bitcoin Signet.

Yes. Use stakeAndDeploy or depositAndDeploy actions to complete everything in one step. Supported vaults include Veda and Silo.

Yes, but this requires coordination with Lombard. Email partnerships@lombard.finance to discuss.

SDK Patterns

The full SDK object (createLombardSDK) provides all capabilities in one place. Modular factories (btcStake, evmUnstake, etc.) import only what’s needed for better tree-shaking and smaller bundles.

The action stays at the failure step without resetting. Users can retry the same step without starting over. All errors are LombardError instances with code, message, and metadata.

Wallets

Currently OKX Wallet via window.okxwallet.bitcoin. Must support getAccounts, signMessage, and signPsbt.

Any EIP-1193 wallet: MetaMask, WalletConnect, Coinbase Wallet, etc.

Standard wallet adapters: window.solana, window.suiWallet, window.starknet.

Data and Tracking

sdk.api.deposits(address) returns all deposits with amounts, transaction hashes, chains, and status.

sdk.api.exchangeRatio() returns tokenBTCRatio and BTCTokenRatio for all supported tokens.

Testing

A live testing environment for configuring flows, validating execution paths, simulating operations, and generating SDK code without deploying to mainnet.

Set env: Env.testnet and partnerId: 'test'. Get testnet BTC from a Signet faucet and Sepolia ETH from a Sepolia faucet.

Operations and Security

Lombard operates all custody infrastructure with audited smart contracts, hardware-enforced signing via Cubist Bascule, Chainlink Proof-of-Reserve, and a 15-institution Security Consortium.

Yes. Binance, Bybit, Ledger, Figment, Xverse, and Cool Wallet power their Bitcoin products through the Lombard SDK.

Support

Reach out via Builder Support or Discord.

Last updated on