@lombard.finance/sdk-solana 1.2.2 → 2.0.0-canary.0.4

package/README.md

@@ -113,31 +113,64 @@ const depositAddress = await generateDepositBtcAddress({
 
 ```
 
-### Claiming LBTC
+### Claiming tokens (Asset Router)
 
-This operation mints the deposited amount of BTC into LBTC and transfers that
-to the provided recipient address.
+Mints BTC.b or LBTC on Solana from a notarized deposit payload using the
+Asset Router program. Replaces the previous `claimLBTC` helper.
 
-```javascript
-const txHash = await claimLBTC(provider, {
+```typescript
+import { claimToken } from '@lombard.finance/sdk-solana';
+
+const txHash = await claimToken(provider, {
   recipientAddress: address,
-  amount: '10000',
+  tokenMint: getConfig(Env.prod).btcbTokenMint, // or lbtcTokenMint
   network: 'mainnet-beta',
-  // The signatures (obtained from `getDepositsByAddress`)
+  // Obtained from `getDepositsByAddress`
   proofSignature: selectedOutput.proof,
   rawPayload: selectedOutput.raw_payload,
 });
 ```
 
-### Unstaking LBTC
+### Redeeming tokens for BTC (Asset Router)
 
-This operation burns given amount of LBTC and initiates transfer of BTC to the
-given BTC address.
+Burns BTC.b or LBTC on Solana and sends a GMP message through the Mailbox to
+trigger a BTC payout to the specified Bitcoin address.
 
-```javascript
-const txHash = await unstakeLBTC(provider, {
-  amount: '10000',
-  btcAddress,
-  network: 'mainnet-beta',
+```typescript
+import { redeemForBtc } from '@lombard.finance/sdk-solana';
+
+// BTC.b → BTC (default)
+const { signature } = await redeemForBtc(provider, {
+  amount: '2000',
+  btcAddress: 'bc1q...',
+  network: 'devnet',
+  env: 'stage',
+});
+
+// LBTC → BTC (pass LBTC mint)
+const { signature } = await redeemForBtc(provider, {
+  amount: '2000',
+  btcAddress: 'bc1q...',
+  tokenMint: 'LBTCojyVJ63rsEED2DLEGWMzSxWJyQynXE91LMLgV1J',
+  network: 'devnet',
+  env: 'stage',
 });
 ```
+
+### Redeeming LBTC for BTC.b (Asset Router)
+
+Burns LBTC and sends a GMP message to route BTC.b to the recipient on Solana.
+
+```typescript
+import { redeem } from '@lombard.finance/sdk-solana';
+
+const txHash = await redeem(provider, {
+  amount: '2000',
+  recipient: '8yarEiDaJVik7n6wX8JCbubTbtZD3WZ67Q1ytMDA2BKA',
+  network: 'devnet',
+  env: 'dev',
+});
+```
+
+Optional overrides: `tokenMint` (source token), `toTokenAddress` (destination
+token), `toLchainId` (destination chain). All default to LBTC → BTC.b on Solana.

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index2.cjs");exports.ALREADY_MINTED_TX_HASH=e.ALREADY_MINTED_TX_HASH;exports.BFF_BASE_URL_PROD=e.BFF_BASE_URL_PROD;exports.BFF_BASE_URL_STAGE=e.BFF_BASE_URL_STAGE;exports.BFF_WS_URL_PROD=e.BFF_WS_URL_PROD;exports.BFF_WS_URL_STAGE=e.BFF_WS_URL_STAGE;exports.DEFAULT_COMMITMENT=e.DEFAULT_COMMITMENT;exports.DEFAULT_NETWORK=e.DEFAULT_NETWORK;exports.INVALID_ADDRESS_ERROR=e.INVALID_ADDRESS_ERROR;exports.InjectedWallet=e.InjectedWallet;exports.RPC_URLS=e.RPC_URLS;exports.SolanaNetwork=e.SolanaNetwork;exports.WS_URLS=e.WS_URLS;exports.claimLBTC=e.claimLBTC;exports.claimToken=e.claimToken;exports.getBalance=e.getBalance;exports.getConfig=e.getConfig;exports.getConnection=e.getConnection;exports.getLBTCAddress=e.getLBTCAddress;exports.getLBTCProgramAddress=e.getLBTCProgramAddress;exports.getOftAmountCanBeSent=e.getOftAmountCanBeSent;exports.getRpcUrl=e.getRpcUrl;exports.getSolanaWalletProvider=e.getSolanaWalletProvider;exports.getUnifiedChainId=e.getUnifiedChainId;exports.isWalletAvailable=e.isWalletAvailable;exports.loadBridgeFunctions=e.loadBridgeFunctions;exports.parseOFTRecipient=e.parseOFTRecipient;exports.redeemForBtc=e.redeemForBtc;exports.signLbtcDestinationAddrSolana=e.signLbtcDestinationAddrSolana;exports.signMessage=e.signMessage;exports.signTermsOfService=e.signTermsOfService;exports.solanaModule=e.solanaModule;exports.unstakeLBTC=e.unstakeLBTC;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index2.cjs");exports.ALREADY_MINTED_TX_HASH=e.ALREADY_MINTED_TX_HASH;exports.BFF_BASE_URL_PROD=e.BFF_BASE_URL_PROD;exports.BFF_BASE_URL_STAGE=e.BFF_BASE_URL_STAGE;exports.BFF_WS_URL_PROD=e.BFF_WS_URL_PROD;exports.BFF_WS_URL_STAGE=e.BFF_WS_URL_STAGE;exports.DEFAULT_COMMITMENT=e.DEFAULT_COMMITMENT;exports.DEFAULT_NETWORK=e.DEFAULT_NETWORK;exports.INVALID_ADDRESS_ERROR=e.INVALID_ADDRESS_ERROR;exports.InjectedWallet=e.InjectedWallet;exports.RPC_URLS=e.RPC_URLS;exports.SolanaNetwork=e.SolanaNetwork;exports.WS_URLS=e.WS_URLS;exports.claimToken=e.claimToken;exports.deposit=e.deposit;exports.getBTCBAddress=e.getBTCBAddress;exports.getBalance=e.getBalance;exports.getConfig=e.getConfig;exports.getConnection=e.getConnection;exports.getLBTCAddress=e.getLBTCAddress;exports.getLBTCProgramAddress=e.getLBTCProgramAddress;exports.getMinRedeemAmountSolana=e.getMinRedeemAmountSolana;exports.getMinRedeemAmountWithFeeSolana=e.getMinRedeemAmountWithFeeSolana;exports.getMintingFeeSolana=e.getMintingFeeSolana;exports.getOftAmountCanBeSent=e.getOftAmountCanBeSent;exports.getRedeemFeeSolana=e.getRedeemFeeSolana;exports.getRpcUrl=e.getRpcUrl;exports.getSolanaWalletProvider=e.getSolanaWalletProvider;exports.getTokenFeeConfig=e.getTokenFeeConfig;exports.getUnifiedChainId=e.getUnifiedChainId;exports.isWalletAvailable=e.isWalletAvailable;exports.loadBridgeFunctions=e.loadBridgeFunctions;exports.parseOFTRecipient=e.parseOFTRecipient;exports.redeem=e.redeem;exports.redeemForBtc=e.redeemForBtc;exports.signLbtcDestinationAddrSolana=e.signLbtcDestinationAddrSolana;exports.signMessage=e.signMessage;exports.signTermsOfService=e.signTermsOfService;exports.solanaModule=e.solanaModule;

package/dist/index.js

@@ -1,35 +1,41 @@
-import { A as e, x as t, y as n, z as _, D as i, E as o, F as l, I as R, G as S, R as r, S as A, W as g, H as L, J as T, K as d, k as B, c as F, d as E, L as c, M as D, N as C, O as U, Q as O, X as W, Y as m, Z as I, _ as M, $ as N, a0 as f, a1 as P, a2 as k, a3 as p } from "./index2.js";
+import { A as s, x as n, y as t, z as o, D as i, E as g, F as d, I as S, G as _, R as l, S as R, W as A, H as r, J as F, K as T, L as B, k as L, c as E, d as m, M as c, N as D, O as C, Q as M, X as U, Y as O, Z as W, _ as I, $ as f, a0 as N, a1 as p, a2 as u, a3 as P, a4 as k, a5 as v, a6 as G, a7 as H, a8 as b, a9 as h } from "./index2.js";
 export {
-  e as ALREADY_MINTED_TX_HASH,
-  t as BFF_BASE_URL_PROD,
-  n as BFF_BASE_URL_STAGE,
-  _ as BFF_WS_URL_PROD,
+  s as ALREADY_MINTED_TX_HASH,
+  n as BFF_BASE_URL_PROD,
+  t as BFF_BASE_URL_STAGE,
+  o as BFF_WS_URL_PROD,
   i as BFF_WS_URL_STAGE,
-  o as DEFAULT_COMMITMENT,
-  l as DEFAULT_NETWORK,
-  R as INVALID_ADDRESS_ERROR,
-  S as InjectedWallet,
-  r as RPC_URLS,
-  A as SolanaNetwork,
-  g as WS_URLS,
-  L as claimLBTC,
-  T as claimToken,
-  d as getBalance,
-  B as getConfig,
-  F as getConnection,
-  E as getLBTCAddress,
+  g as DEFAULT_COMMITMENT,
+  d as DEFAULT_NETWORK,
+  S as INVALID_ADDRESS_ERROR,
+  _ as InjectedWallet,
+  l as RPC_URLS,
+  R as SolanaNetwork,
+  A as WS_URLS,
+  r as claimToken,
+  F as deposit,
+  T as getBTCBAddress,
+  B as getBalance,
+  L as getConfig,
+  E as getConnection,
+  m as getLBTCAddress,
   c as getLBTCProgramAddress,
-  D as getOftAmountCanBeSent,
-  C as getRpcUrl,
-  U as getSolanaWalletProvider,
-  O as getUnifiedChainId,
-  W as isWalletAvailable,
-  m as loadBridgeFunctions,
-  I as parseOFTRecipient,
-  M as redeemForBtc,
-  N as signLbtcDestinationAddrSolana,
-  f as signMessage,
-  P as signTermsOfService,
-  k as solanaModule,
-  p as unstakeLBTC
+  D as getMinRedeemAmountSolana,
+  C as getMinRedeemAmountWithFeeSolana,
+  M as getMintingFeeSolana,
+  U as getOftAmountCanBeSent,
+  O as getRedeemFeeSolana,
+  W as getRpcUrl,
+  I as getSolanaWalletProvider,
+  f as getTokenFeeConfig,
+  N as getUnifiedChainId,
+  p as isWalletAvailable,
+  u as loadBridgeFunctions,
+  P as parseOFTRecipient,
+  k as redeem,
+  v as redeemForBtc,
+  G as signLbtcDestinationAddrSolana,
+  H as signMessage,
+  b as signTermsOfService,
+  h as solanaModule
 };