@lombard.finance/sdk 3.6.20 → 3.7.0-canary.1

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+# 3.7.0
+
+* **added custom signer support for flexible transaction signing:**
+  * introduced `SignerAdapter` interface for custom transaction signing logic,
+  * `redeemToken` and `unstakeLBTC` now accept either `provider` (legacy) or `signer` (custom) parameter,
+  * backward compatible - existing provider-based code continues to work unchanged.
+* added `depositToken` function that triggers the deposit method on the LBTC contract,
+* replaced `token` parameter of `redeemToken` function with a pair of new parameters `tokenIn` (the token that is being redeemed) and `tokenOut` (the token received after redemption, defaults to `undefined` [**BTC**]),
+* introduced `fetchAllPaginated` utility to handle pagination across all endpoints,
+* added unified deposits support:
+  * introduced `Deposit` interface to unify Direct BTC Deposits and Native Deposits APIs.  
+  * added `isNative` flag to distinguish between deposit types.  
+  * added fetchers: `fetchDirectDeposits` and `fetchNativeDeposits` (now uses `fetchAllPaginated` internally).
+  * added unified `getDepositsByAddress` function to fetch and combine deposits from both APIs.  
+  * improved mapping helpers: `mapDirectBtcDeposit` and `mapNativeDeposit` to normalize fields such as `txHash`, `eventIndex`, `amount`, `blockTime`, `fromChainId`, `toChainId`, `toTokenAddress`, `toToken`, `sanctioned`, `claimTxHash`, and `notarizationWaitDur`.  
+  * added JSDoc for all deposit types and fetchers.
+  * ensured robust error handling: failure of one API does not prevent fetching from the other.
+  * renamed `signature` property to `proof`.
+* refactored unstakes fetching:
+  * `fetchUnstakesByAddress` now uses `fetchAllPaginated` internally,
+  * removed `unstakeDate` property from `Unstake` interface,
+  * added `blockTime` property to `Unstake` to retain original timestamp,
+  * added `isNative` flag to distinguish between unstakes (directly to BTC) and redemptions (to native chain).
+  * `fromChainId` and `toChainId` clearly separated; `toChainId` is undefined for BTC unstakes,
+  * fully typed JSDoc added for `Unstake`, `UnstakeEntry`, and fetchers,
+  * public API `getUnstakesByAddress` added as a wrapper over the fetcher.
+* renamed tokens:
+  * `Token.NativeLBTC` to `Token.BTCb` (`BTC.b`)
+  * `Token.BTCB` to `Token.BTCBinance` (`BTCB` - Binance BTC wrapper)
+  * deprecated `Token.BTCK` which will be sunset as soon as the Katana contracts are updated.
+
+# 3.6.21
+
+* changed sevenseas api requests to proxy through bff
+
 # 3.6.20
 
 * updated LBTC token contract addresses for staging environment.

package/README.md

@@ -13,14 +13,14 @@ The SDK depends on the following packages:
 * axios
 * viem@2.23
 * bignumber.js@9
+* @bitcoinerlab/secp256k1@1.2.0
 * bitcoinjs-lib@6.1.5
-* @bitcoin-js/tiny-secp256k1-asmjs@2.2.3
 * @layerzerolabs/lz-v2-utilities@3.0.17
 
 You may install them by running the following command:
 
 ```bash
-npm i --save viem@^2.23.15 axios@^1 bignumber.js@^9 @bitcoin-js/tiny-secp256k1-asmjs@2.2.3 bitcoinjs-lib@6.1.5 @layerzerolabs/lz-v2-utilities@3.0.17
+npm i --save viem@^2.23.15 axios@^1 bignumber.js@^9 @bitcoinerlab/secp256k1@1.2.0 bitcoinjs-lib@6.1.5 @layerzerolabs/lz-v2-utilities@3.0.17
 ```
 
 ### 2. SDK installation
@@ -37,7 +37,7 @@ All functions are documented with JSDoc comments. You can use your IDE's autocom
 
 ### 1. Depositing BTC in order to get LBTC (aka staking)
 
-You can read more about LBTC here: [Introduction to LBTC](https://docs.lombard.finance/lbtc-liquid-bitcoin/introduction-to-lbtc)
+You can read more about LBTC here: [LBTC (Staked Bitcoin)](https://docs.lombard.finance/lbtc-liquid-bitcoin/lbtc-staked-bitcoin)
 
 If you'd like to stake your BTC and get LBTC, follow the steps below.
 
@@ -84,52 +84,81 @@ if (fee.gt(0)) {
 }
 ```
 
-#### 1.3. Deposit BTC to the address
+#### 1.3. Depositing
 
 Deposit your BTC to the generated address. Funds will be claimed automatically by Lombard’s claimer and credited to your account (`address`).
 
+If you hold `BTC.b` and want to deposit it to Lombard in order to receive `LBTC`, you can use the `depositToken` function.
+
+```ts
+const txHash = await depositToken({
+  account: accountAddress,    // Your account address
+  chainId,                    // The chain ID
+  amount,                     // Amount of tokens to deposit (human-readable format)
+  tokenIn = Token.BTCb, // Input token to deposit (default: `Token.BTCb`)
+  tokenOut = Token.LBTC,      // Output token to be minted (default: `Token.LBTC`)
+  provider,                   // Instance of an `EIP1193Provider`
+  env,                        // Optional environment setting
+  rpcUrl,                     // Optional RPC endpoint URL
+});
+```
+
+> **Note**: If you are using the `BTC.b` deposit flow, you can skip generating a BTC deposit address. The `depositToken` function handles the deposit and conversion automatically.
 
-#### 1.4. Check the status of your deposit.
 
-If you'd like to check the status of your deposit use `getDepositsByAddress` function.
+#### 1.4. Check the status of your deposit
+
+Use `getDepositsByAddress` to retrieve all deposits (Direct BTC + Native BTC.b Deposits) in a unified format:
 
 ```javascript
 const deposits = await getDepositsByAddress({ address });
 ```
 
-Every entry in the result of the above function may consist of the following properties:
-* `txid` - the BTC transaction id,
-* `index` - the index of the actual deposit transaction,
-* `blockHeight`
-* `blockTime`
-* `value` - the amount of BTC deposited,
-* `address` - the destination address,
-* `chainId` - the destination chain id,
-* `isClaimer` - a flag determining whether the deposit has been already claimed,
-* `claimedTxId` - the corresponding claim transaction that transfer funds to the destination address,
-* `rawPayload` - the payload of the transaction (can be use to claim the funds manually),
-* `signature` - the signature used (can be used to claim the funds manually),
-* `isRestricted` - a flag determining whether the transaction has been marked as suspicious/restricted,
-* `payload` - the payload (corresponding to the Bascule drawbridge security),
-* `sessionId`
-* `notarizationStatus` - the notarization status of the deposit (pending, submitted, approved or failed),
-* `sessionState` - the state of the session (pending, completed, expired)
+Each deposit entry contains the following properties:
+
+| Property              | Description                                                                 |
+| --------------------- | --------------------------------------------------------------------------- |
+| `txHash`              | Transaction hash on the source blockchain.                                  |
+| `eventIndex`          | Index of the deposit event within the transaction.                          |
+| `amount`              | Amount deposited (satoshis or smallest unit).                               |
+| `depositAddress`      | BTC/EVM deposit address (Direct BTC only).                                  |
+| `fromAddress`         | Sender address (Native deposits).                                           |
+| `toAddress`           | Receiver address on the destination chain (Native deposits).                |
+| `toTokenAddress`      | Destination token contract (if applicable).                                 |
+| `toToken`.            | Destination token (if applicable).                                          |
+| `toChainId`           | Destination chain ID.                                                       |
+| `fromChainId`         | Source chain ID (Native deposits).                                          |
+| `blockHeight`         | Block height of the confirmation.                                           |
+| `blockTime`           | Unix timestamp of confirmation (seconds).                                   |
+| `payloadHash`         | Hash of the payload proving the deposit details.                            |
+| `rawPayload`          | Hex-encoded raw payload (used for manual claiming).                         |
+| `proof`               | Cryptographic proof (hex-encoded).                                          |
+| `sessionId`           | Notarization session ID.                                                    |
+| `notarizationStatus`  | Deposit notarization status (`pending`, `submitted`, `approved`, `failed`). |
+| `sessionState`        | Notarization session state (`pending`, `completed`, `expired`).             |
+| `claimTxHash`         | Claim transaction hash if deposit has been claimed.                         |
+| `isClaimed`           | Boolean indicating whether the deposit has been claimed.                    |
+| `sanctioned`          | Boolean indicating if the deposit is restricted/sanctioned.                 |
+| `auxVersion`          | Optional auxiliary version (Direct BTC only).                               |
+| `notarizationWaitDur` | Optional notarization wait duration in seconds (Direct BTC only).           |
 
 ---
 
-### 2. Manually claiming LBTC.
+### 2. Minting
 
-In case when a user deposited BTC to the BTC deposit address but the transaction has not been claimed automatically (due to expired signature or any other issue), you may want to claim LBTC manually as in the example below:
+If a deposit has not been automatically claimed (e.g., expired signature), you can manually claim LBTC or other supported tokens using `mintToken`.
 
-```javascript
-const txHash = await claimLBTC({
-  data: rawPayload, // Pass the raw payload from the deposit data as presented in the previous step.
-  proofSignature: signature, // Pass the signature from the deposit data.
-  account, // The connected account address
-  chainId, // The chain id
-  provider, // The EIP-1193 provider,
-  rpcUrl, // The optional RPC url.
-})
+> **Note**: `mintToken` is the preferred function. `claimLBTC` (available in the SDK) is a convenience wrapper for LBTC.
+
+```ts
+const txHash = await mintToken({
+  data: rawPayload,              // The rawPayload from the notarized deposit.
+  proofSignature: deposit.proof, // The proof signature of a notarized deposit.
+  account,                       // The account address/
+  chainId,                       // The chain id.
+  provider,                      // The EIP-1193 provider,
+  token: Token.LBTC,             // The token to be minted, defaults to `Token.LBTC`
+});
 ```
 
 The successful execution of the above will result with the transaction id.
@@ -140,7 +169,12 @@ The successful execution of the above will result with the transaction id.
 
 You can read more about the DeFi vaults here: https://docs.lombard.finance/lbtc-liquid-bitcoin/defi-vaults/lombard-defi-vault
 
-If you'd wish to stake and bake your BTC follow the steps below.
+If you'd wish to stake and bake your BTC follow the steps below. The SDK currently supports:
+
+- **`DefiProtocol.Veda`** – the Lombard DeFi vault that accepts BTC/LBTC on Ethereum, BNB Chain, and Holesky.
+- **`DefiProtocol.Silo`** – the Silo Finance vault (testnet) that accepts BTCb on Avalanche Fuji.
+
+Pick the appropriate `vaultKey` (and token) to match the protocol you're targeting.
 
 #### 3.1. See what's the current stake and bake fee.
 
@@ -148,13 +182,41 @@ To check the current stake and bake fee you may use the following function:
 
 ```javascript
 const fee = await getStakeAndBakeFee({
-  vaultKey: Vault.Veda, // The vault identifier, currently only "veda" is accepted.
-  chainId, // The chain id.
-  rpcUrl, // The options RPC url.
+  protocol: DefiProtocol.Veda, // The DeFi protocol (Veda or Silo).
+  token: Token.LBTC,            // Optional: The token to query fee for. Defaults to protocol's primary token.
+  chainId,                      // The chain id.
+  env,                          // Optional: Environment (prod, testnet, etc.).
+  rpcUrl,                       // Optional: RPC url.
 });
 const expectedLBTCAmount = BigNumber(amountToBeDeposited).minus(fee);
 ```
-The fee amount will be deducted from the claimed LBTC automatically.
+
+**Parameters:**
+
+| Param      | Type           | Required | Description                                                                                           |
+| ---------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------- |
+| `protocol` | `DefiProtocol` | ❌        | The DeFi protocol identifier. Defaults to `DefiProtocol.Veda`.                                        |
+| `token`    | `StakeAndBakeToken` | ❌        | The token to query fee for. If not provided, defaults to the protocol's primary token (see below).   |
+| `chainId`  | `number`       | ✅        | The target chain ID.                                                                                  |
+| `env`      | `Env`          | ❌        | Optional environment (prod, testnet, etc.). Defaults to production.                                   |
+| `rpcUrl`   | `string`       | ❌        | Optional RPC URL override.                                                                            |
+
+**Protocol Default Tokens:**
+- `DefiProtocol.Veda` → `Token.LBTC` (also supports `'BTC'`)
+- `DefiProtocol.Silo` → `Token.BTCb`
+
+**Example: Query fee for Silo on Avalanche Fuji**
+
+```typescript
+const fee = await getStakeAndBakeFee({
+  protocol: DefiProtocol.Silo,
+  chainId: ChainId.avalancheFuji,
+  env: Env.testnet,
+  // token defaults to Token.BTCb for Silo
+});
+```
+
+The fee amount will be deducted from the claimed token automatically during stake and bake.
 
 #### 3.2. Sign the stake and bake signature
 
@@ -163,9 +225,9 @@ const { signature, typedData } = await signStakeAndBake({
   account,   // The connected account address.
   expiry,    // Optional expiration timestamp (unix). Defaults to 24h from now. Recommended: at least 8h from now.
   value,     // The amount of the token (see `token` param).
-  token,     // The token to sign with. Defaults to "BTC": the value is converted to LBTC using the current ratio. 
+  token,     // The token to sign with. Defaults to "BTC": the value is converted to LBTC using the current ratio.
              // If "LBTC" is chosen, no conversion is applied.
-  vaultKey: Vault.Veda, // The vault identifier. Currently only "veda" is accepted.
+  vaultKey: DefiProtocol.Veda, // Choose the DeFi protocol (e.g. Veda or Silo Finance).
   chainId,   // The chain ID.
   provider,  // The EIP-1193 provider.
   rpcUrl,    // Optional RPC URL.
@@ -178,7 +240,7 @@ const { signature, typedData } = await signStakeAndBake({
 | `expiry`   | `number`            | ❌        | Optional expiration time (Unix timestamp). Defaults to 24h from now. Recommended: set at least 8h from now.                                                                      |
 | `value`    | `string`/`number`   | ✅        | The token amount (interpreted based on the `token` param).                                                                                                                       |
 | `token`    | `"BTC"` \| `"LBTC"` | ❌        | The token to sign with. Defaults to `"BTC"`. If `"BTC"`, the amount is converted to LBTC using the current exchange ratio. If `"LBTC"`, the value is used as-is (no conversion). |
-| `vaultKey` | `Vault`             | ❌        | The vault identifier. Currently only `"veda"` is accepted.                                                                                                                       |
+| `vaultKey` | `DefiProtocol`      | ❌        | The DeFi protocol identifier. Use `DefiProtocol.Veda` for Lombard's vault or `DefiProtocol.Silo` for the Silo Finance integration.                                                |
 | `chainId`  | `number`            | ✅        | The target chain ID.                                                                                                                                                             |
 | `provider` | `EIP-1193 provider` | ✅        | The connected Web3 provider.                                                                                                                                                     |
 | `rpcUrl`   | `string`            | ❌        | Optional RPC URL override.                                                                                                                                                       |
@@ -187,6 +249,27 @@ const { signature, typedData } = await signStakeAndBake({
 **Note:**
 - If token is `"BTC"`, the function automatically converts the value to the corresponding **LBTC** amount using the current exchange ratio.
 - If token is `"LBTC"`, the value is used as-is (no conversion).
+- `DefiProtocol.Veda` supports BTC/LBTC stake-and-bake on Ethereum, BSC, and Holesky. `DefiProtocol.Silo` currently targets the Silo Finance vault with BTCb on Avalanche Fuji (testnet) using the approval flow defined in the DeFi registry.
+
+**Example: Silo Finance stake and bake on Avalanche Fuji**
+
+```ts
+import {
+  ChainId,
+  DefiProtocol,
+  signStakeAndBake,
+  Token,
+} from '@lombard.finance/sdk';
+
+const { signature, typedData } = await signStakeAndBake({
+  account,
+  chainId: ChainId.avalancheFuji,
+  provider,
+  token: Token.BTCb,
+  vaultKey: DefiProtocol.Silo,
+  value: '0.5', // BTCb amount in human-readable format
+});
+```
 
 
 #### 3.3. Store the signature to the Lombard's systems.
@@ -235,7 +318,7 @@ const deposits = await getDepositsByAddress({ address });
 
 ```javascript
 const { balance, exchangeRate, balanceLbtc } = await getSharesByAddress({
-  vaultKey: Vault.Veda, // The vault identifier.
+  vaultKey: Vault.Veda, // Lombard DeFi vault identifier (stake & bake deposits that land in Veda).
   address, // The account address.
   chainId, // The chain id.
   rpcUrl, // The optional RPC url
@@ -249,24 +332,43 @@ The above code results with:
 
 ---
 
-### 4. Unstaking LBTC and getting BTC back.
+### 4. Redeeming LBTC to BTC or other supported tokens.
 
 Every LBTC is redeemable back to BTC, you can do that programmatically by following the steps:
 
-#### 4.1. Unstake LBTC.
+#### 4.1. Redeeming.
+
+Use `redeemToken` to redeem LBTC → BTC (or other supported flows).
+When redeeming to BTC, be sure to pass a valid `btcAddress`.
 
 ```javascript
-const txaHash = await unstakeLBTC({
-  btcAddress, // The address to which the funds will be redeemed.
-  amount, // The amount of LBTC to unstake.
-  account, // The account address.
-  chainId, // The chain id.
-  provider, // The EIP-1193 provider.
-  rpcUrl, // The optional RPC url.
+import { redeemToken, Token } from '@lombard.finance/sdk';
+
+// Redeem LBTC into BTC
+const txHash = await redeemToken({
+  btcAddress,       // The BTC address to receive the redeemed funds.
+  amount,           // Amount of LBTC to redeem (e.g. "1.23").
+  account,          // Your EVM account address.
+  chainId,          // The chain ID where LBTC is deployed.
+  provider,         // The EIP-1193 provider (e.g. from MetaMask).
+  rpcUrl,           // (Optional) Custom RPC URL.
+  tokenIn: Token.LBTC, // The token you are redeeming.
 });
+
+// Redeem LBTC into BTC.b
+const txHash = await redeemToken({
+  amount,           // Amount of LBTC to redeem (e.g. "1.23")
+  account,          // Your EVM account address
+  chainId,          // The chain ID where LBTC is deployed
+  provider,         // The EIP-1193 provider (e.g. from MetaMask)
+  rpcUrl,           // (Optional) Custom RPC URL
+  tokenIn: Token.LBTC,        // The token you are redeeming
+  tokenOut: Token.BTCb, // The token to receive
+});
+
 ```
 
-#### 4.2. Check the status of your unstakes.
+#### 4.3. Check the status of your redemptions (unstakes).
 
 If you'd like to get the list of all unstaked made by an address, use this:
 
@@ -275,17 +377,23 @@ const unstakes = await getUnstakesByAddress({ address });
 ```
 
 Every entry in the result of the above may consist of:
-* `txHash` - The unstake transaction hash,
-* `chainId`,
-* `blockHeight`,
-* `unstakeDate`,
-* `fromAddress` - The EVM source address,
-* `toAddress` - The BTC destination address of the funds,
-* `amount` - The amount unstaked,
-* `payoutTxHash` - The BTC transaction hash,
-* `payoutTxIndex` - The index of the actual payout transfer,
-* `payoutTxStatus` - The status of the payout, available values: `PayoutTxStatus.Completed` or `PayoutTxStatus.Pending`,
-* `sanctioned` - A flag indicating whether the unstake transaction has been sanctioned and flagged as suspicious.
+
+| Field              | Type                                              | Description                                                                                                                      |
+| ------------------ | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| **isNative**       | `boolean`                                         | `true` if the record originates from a **native-chain redemption** (e.g. BTC.b), `false` if it’s a direct BTC unstake.           |
+| **txHash**         | `string`                                          | Transaction hash of the unstake/redemption on the source chain.                                                                  |
+| **fromChainId**    | `ChainId \| SuiChain \| SolanaChain`              | Identifier of the **source chain** where the unstake was initiated.                                                              |
+| **toChainId**      | `ChainId \| SuiChain \| SolanaChain` *(optional)* | Destination chain identifier (undefined for BTC unstakes).                                                                       |
+| **blockHeight**    | `number`                                          | Block height on the source chain where the unstake was confirmed.                                                                |
+| **blockTime**      | `number` (epoch seconds)                          | Timestamp (in epoch seconds) of the confirmation block.                                                                          |
+| **fromAddress**    | `string`                                          | Address of the initiator of the unstake transaction.                                                                             |
+| **toAddress**      | `string` *(optional)*                             | Destination address receiving the redeemed funds (BTC, EVM, or Solana).                                                          |
+| **amount**         | `BigNumber`                                       | Amount unstaked, normalized to **satoshis / smallest unit**.                                                                     |
+| **payoutTxHash**   | `string` *(optional)*                             | Transaction hash of the payout on the **destination chain**, if the claim/payout has occurred.                                   |
+| **payoutTxIndex**  | `number` *(optional)*                             | Transaction index of the payout within the destination block, if applicable.                                                     |
+| **payoutTxStatus** | `PayoutTxStatus`                                  | Current status of the payout transaction (e.g. *pending*, *confirmed*, *failed*).                                                |
+| **sanctioned**     | `boolean` *(optional)*                            | `true` if the unstake transaction has been sanctioned or flagged.                                                                |
+
 
 ---
 
@@ -423,55 +531,12 @@ const txHash = await cancelWithdraw({
 You can check the amount of Lux points earned by an address with:
 
 ```ts
-import { getPointsByAddress } from "@lombard.finance/sdk";
-
-// Fetch **current season** points (defaults to Season 2)
-const points = await getPointsByAddress({ address: "0x...YOUR_ADDRESS" });
+import { getLuxSeason2Points } from "@lombard.finance/sdk";
+const points = await getLuxSeason2Points({ address: "0x...YOUR_ADDRESS" });
 ```
 
-> 💡 **Tip:** If you already know which season you need,
-> you can use the **season-specific wrappers** for cleaner, type-safe results:
->
-> ```ts
-> import { getLuxSeason1Points, getLuxSeason2Points } from "@lombard.finance/sdk";
->
-> const s1 = await getLuxSeason1Points({ address: "0x...YOUR_ADDRESS" }); // Season 1 only
-> const s2 = await getLuxSeason2Points({ address: "0x...YOUR_ADDRESS" }); // Season 2 only
-> ```
-
 #### Returned Object
 
-The shape of the returned object depends on the **season**:
-
-##### **Season 1**
-
-```ts
-{
-  /** Points earned by holding LBTC. */
-  holdingPoints: number;
-  /** Points earned by taking positions in DeFi vaults. */
-  protocolPoints: number;
-  /** Total referral points (referees + referrals). */
-  referralPoints: number;
-  /** Points earned in the OKX campaign. */
-  okxPoints: number;
-  /** Points earned in the first flash event. */
-  flashEvent1Points: number;
-  /** Points earned in the second flash event. */
-  flashEvent2Points: number;
-  /** Total points earned. */
-  totalPoints: number;
-  /** Breakdown of points earned from each protocol. */
-  protocolPointsBreakdown: IProtocolPointsBreakdown;
-  /** Lux points earned from badges. */
-  badgesPoints: number;
-  /** Total Lux points excluding badge points. */
-  totalWithoutBadgesPoints: number;
-}
-```
-
-##### **Season 2**
-
 ```ts
 {
   /** Points earned by holding LBTC. */
@@ -495,10 +560,6 @@ The shape of the returned object depends on the **season**:
 }
 ```
 
-✅ Use `getPointsByAddress` when you want to dynamically select a season,
-or `getLuxSeason1Points` / `getLuxSeason2Points` when you want **strong typing**
-and guarantees for a specific season’s fields.
-
 ---
 
 ### 8. Getting the DeFi vault points earned by an address.
@@ -693,4 +754,4 @@ The above returns:
   * **`name`** (`string`): Name of the reward campaign.  
   * **`amount`** (`BigNumber`): Amount of BTC yet to be distributed.
 
----
+---

package/dist/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.d.ts

@@ -0,0 +1,67 @@
+import type { ChainId, SolanaChain, StarknetChainId, SuiChain } from '../../common/chains';
+import type { IEnvParam } from '../../common/parameters';
+import { Token } from '../../tokens/token-addresses';
+/**
+ * The address which will be returned if the provided EVM address is sanctioned.
+ */
+export declare const SANCTIONED_ADDRESS = "sanctioned_address";
+export interface IGenerateDepositBtcAddressParams extends IEnvParam {
+    /**
+     * The destination EVM user address where LBTC will be claimed.
+     */
+    address: string;
+    /**
+     * The intended destination token, defaults to LBTC.
+     */
+    token?: Token;
+    /**
+     * The destination chain ID where LBTC will be claimed.
+     */
+    chainId: ChainId | SuiChain | SolanaChain | StarknetChainId;
+    /**
+     * The signature of the address. The signature is generated by signing the address using EVM wallet.
+     */
+    signature: string;
+    /**
+     * The typed data object used to generate the signature if using a network fee authorization signature.
+     */
+    eip712Data?: string;
+    /**
+     * The captcha token.
+     */
+    captchaToken?: string;
+    /**
+     * The referrer code.
+     */
+    referrerCode?: string;
+    /**
+     * The referral ID.
+     */
+    partnerId?: string;
+    /**
+     * The typed data object used to generate the signature if using a stake and bake feature.
+     */
+    signatureData?: string;
+    /** The pubKey required for starknet addresses signatures. */
+    pubKey?: string;
+}
+/**
+ * Generates a BTC deposit address.
+ *
+ * If the provided EVM address is sanctioned, the function will return the `SANCTIONED_ADDRESS`.
+ *
+ * @param {IGenerateDepositBtcAddressParams} parameters - The parameters for generating the deposit address.
+ * @param {string} parameters.address - The destination EVM user address where LBTC will be claimed.
+ * @param {ChainId} parameters.chainId - The destination chain ID where LBTC will be claimed.
+ * @param {string} parameters.signature - The signature of the address. The signature is generated by signing the address using EVM wallet.
+ * @param {string} parameters.eip712Data - The typed data object used to generate the signature if using a network fee authorization signature.
+ * @param {string} parameters.captchaToken - The captcha token.
+ * @param {string} parameters.referrerCode - The referrer code.
+ * @param {string} parameters.partnerId - The partner ID.
+ * @param {string} parameters.signatureData - The typed data object used to generate the signature if using a stake and bake feature.
+ * @param {Env} parameters.env - The optional environment identifier.
+ *
+ * @returns {Promise<string>} The generated deposit address.
+ */
+export declare function generateDepositBtcAddress({ address, token, chainId, signature, eip712Data, env, referrerCode, partnerId, captchaToken, signatureData, pubKey, }: IGenerateDepositBtcAddressParams): Promise<string>;
+//# sourceMappingURL=generateDepositBtcAddress.d.ts.map

package/dist/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateDepositBtcAddress.d.ts","sourceRoot":"","sources":["../../../src/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACX,eAAe,EACf,QAAQ,EACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAKzD,OAAO,EAAe,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAIlE;;GAEG;AACH,eAAO,MAAM,kBAAkB,uBAAuB,CAAC;AAQvD,MAAM,WAAW,gCAAiC,SAAQ,SAAS;IACjE;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,eAAe,CAAC;IAC5D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAKD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,yBAAyB,CAAC,EAC9C,OAAO,EACP,KAAkB,EAClB,OAAO,EACP,SAAS,EACT,UAAU,EACV,GAAG,EACH,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,aAAa,EACb,MAAM,GACP,EAAE,gCAAgC,GAAG,OAAO,CAAC,MAAM,CAAC,CA0HpD"}

package/dist/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.stories.d.ts

@@ -0,0 +1,16 @@
+import type { StoryObj } from '@storybook/react';
+import { IGenerateDepositBtcAddressParams } from './generateDepositBtcAddress';
+declare const meta: {
+    title: string;
+    component: typeof StoryView;
+    tags: string[];
+    decorators: ((Story: any) => import("react/jsx-runtime").JSX.Element)[];
+    argTypes: {
+        [x: string]: import("@storybook/core/csf").InputType | undefined;
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const WithParams: Story;
+export declare function StoryView(props: IGenerateDepositBtcAddressParams): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=generateDepositBtcAddress.stories.d.ts.map

package/dist/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateDepositBtcAddress.stories.d.ts","sourceRoot":"","sources":["../../../src/api-functions/generateDepositBtcAddress/generateDepositBtcAddress.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAQ,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AASvD,OAAO,EACL,gCAAgC,EAEjC,MAAM,6BAA6B,CAAC;AAErC,QAAA,MAAM,IAAI;;;;;;;;CASwB,CAAC;AAEnC,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AASnC,eAAO,MAAM,UAAU,EAAE,KAWxB,CAAC;AAEF,wBAAgB,SAAS,CAAC,KAAK,EAAE,gCAAgC,2CAmBhE"}

package/dist/api-functions/generateDepositBtcAddress/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generateDepositBtcAddress';
+//# sourceMappingURL=index.d.ts.map

package/dist/api-functions/generateDepositBtcAddress/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api-functions/generateDepositBtcAddress/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC"}

package/dist/api-functions/get-badges-by-address/get-badges-by-address.d.ts

@@ -0,0 +1,8 @@
+import { Address } from 'viem';
+import { IEnvParam } from '../../common/parameters';
+export type GetBadgesByAddress = {
+    /** The account address */
+    address: Address;
+} & IEnvParam;
+export declare function getBadgesByAddress({ address, env }: GetBadgesByAddress): Promise<void>;
+//# sourceMappingURL=get-badges-by-address.d.ts.map

package/dist/api-functions/get-badges-by-address/get-badges-by-address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-badges-by-address.d.ts","sourceRoot":"","sources":["../../../src/api-functions/get-badges-by-address/get-badges-by-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0BAA0B;IAC1B,OAAO,EAAE,OAAO,CAAC;CAClB,GAAG,SAAS,CAAC;AAEd,wBAAsB,kBAAkB,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,iBAG5E"}

package/dist/api-functions/get-badges-by-address/index.d.ts

@@ -0,0 +1,2 @@
+export * from './get-badges-by-address';
+//# sourceMappingURL=index.d.ts.map

package/dist/api-functions/get-badges-by-address/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api-functions/get-badges-by-address/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/api-functions/getDepositBtcAddress/getDepositBtcAddress.d.ts

@@ -0,0 +1,13 @@
+import type { IGetDepositBtcAddressParameters, IGetDepositBtcAddressesParameters } from './types';
+/**
+ * Returns the current address for depositing BTC by given parameters.
+ *
+ * @throws {Error} - Throws an error if no address found or the provided chain id is not supported.
+ */
+export declare function getDepositBtcAddress({ address, chainId, env, partnerId, token, }: IGetDepositBtcAddressParameters): Promise<string>;
+/**
+ * Returns the addresses for depositing BTC by given parameters.
+ * @throws {Error} - Throws an error if chain id is not supported.
+ */
+export declare function getDepositBtcAddresses(parameters: IGetDepositBtcAddressesParameters): Promise<import("./types").IDepositAddress[] | undefined>;
+//# sourceMappingURL=getDepositBtcAddress.d.ts.map

package/dist/api-functions/getDepositBtcAddress/getDepositBtcAddress.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDepositBtcAddress.d.ts","sourceRoot":"","sources":["../../../src/api-functions/getDepositBtcAddress/getDepositBtcAddress.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EACV,+BAA+B,EAC/B,iCAAiC,EAClC,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,OAAO,EACP,OAAO,EACP,GAAG,EACH,SAAS,EACT,KAAkB,GACnB,EAAE,+BAA+B,mBAwHjC;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAC1C,UAAU,EAAE,iCAAiC,4DAI9C"}

package/dist/api-functions/getDepositBtcAddress/getDepositBtcAddress.stories.d.ts

@@ -0,0 +1,16 @@
+import type { StoryObj } from '@storybook/react';
+import { IGetDepositBtcAddressParameters } from './types';
+declare const meta: {
+    title: string;
+    component: typeof StoryView;
+    tags: string[];
+    decorators: ((Story: any) => import("react/jsx-runtime").JSX.Element)[];
+    argTypes: {
+        [x: string]: import("@storybook/core/csf").InputType | undefined;
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const WithParams: Story;
+export declare function StoryView(props: IGetDepositBtcAddressParameters): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=getDepositBtcAddress.stories.d.ts.map

package/dist/api-functions/getDepositBtcAddress/getDepositBtcAddress.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDepositBtcAddress.stories.d.ts","sourceRoot":"","sources":["../../../src/api-functions/getDepositBtcAddress/getDepositBtcAddress.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAQ,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAUvD,OAAO,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE1D,QAAA,MAAM,IAAI;;;;;;;;CASwB,CAAC;AAEnC,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnC,eAAO,MAAM,UAAU,EAAE,KAQxB,CAAC;AAEF,wBAAgB,SAAS,CAAC,KAAK,EAAE,+BAA+B,2CAmB/D"}

package/dist/api-functions/getDepositBtcAddress/getDepositBtcAddress.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getDepositBtcAddress.test.d.ts.map

package/dist/api-functions/getDepositBtcAddress/getDepositBtcAddress.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDepositBtcAddress.test.d.ts","sourceRoot":"","sources":["../../../src/api-functions/getDepositBtcAddress/getDepositBtcAddress.test.ts"],"names":[],"mappings":""}