@lombard.finance/sdk-common 3.4.1 → 4.0.0-canary.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Lombard Finance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,22 @@
 # @lombard.finance/sdk-common
+
+Shared utilities and types used internally by the [Lombard SDK](https://github.com/lombard-finance/sdk) packages.
+
+## What's included
+
+- Environment configuration (`Env`, chain definitions)
+- Provider interfaces and abstractions
+- Bitcoin output script generation utilities
+- Chain service abstractions
+
+## Usage
+
+This package is an internal dependency of `@lombard.finance/sdk`, `@lombard.finance/sdk-solana`, `@lombard.finance/sdk-starknet`, and `@lombard.finance/sdk-sui`. You typically do not need to install it directly.
+
+```bash
+npm install @lombard.finance/sdk-common
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@lombard.finance/sdk-common",
-  "version": "3.4.1",
+  "version": "4.0.0-canary.0.4",
+  "description": "Shared utilities and types for the Lombard SDK packages",
   "exports": {
     ".": {
       "types": "./src/index.ts",
@@ -14,7 +15,8 @@
   "types": "./src/index.ts",
   "files": [
     "dist",
-    "src"
+    "src",
+    "LICENSE"
   ],
   "engines": {
     "node": ">= 18.0.0"
@@ -27,6 +29,24 @@
     "format:check": "prettier --check \"src/**/*.{js,jsx,ts,tsx}\"",
     "types": "tsc --noEmit"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lombard-finance/sdk.git",
+    "directory": "packages/sdk-common"
+  },
+  "homepage": "https://docs.lombard.finance",
+  "bugs": {
+    "url": "https://github.com/lombard-finance/sdk/issues"
+  },
+  "keywords": [
+    "lombard",
+    "sdk",
+    "common",
+    "utilities"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "peerDependencies": {
     "@bitcoinerlab/secp256k1": "^1.2.0",
     "bitcoinjs-lib": "^6.1.5"

package/src/services/solana.ts

@@ -1,3 +1,5 @@
+import type { Env } from '../env';
+
 /**
  * Solana Chain Service
  *
@@ -14,18 +16,65 @@ export interface SolanaService {
   }): Promise<{ signature: string }>;
 
   /**
-   * Unstake LBTC on Solana to receive BTC
+   * Redeem BTC.b or LBTC on Solana to receive BTC
    *
-   * Burns LBTC on Solana and releases BTC to the provided Bitcoin address.
+   * Burns the source token on Solana and sends a GMP message to trigger
+   * a BTC payout to the specified Bitcoin address.
    *
-   * @param args.amount - Amount of LBTC to unstake in base units (satoshis)
+   * @param args.amount - Amount to redeem in base units (satoshis)
    * @param args.btcAddress - Bitcoin address to receive BTC
    * @param args.network - Solana network ('mainnet-beta', 'devnet', 'testnet')
-   * @returns Transaction signature
+   * @param args.tokenMint - Source SPL mint: must be the environment’s LBTC or BTC.b mint.
+   * @returns `{ signature }` — base58 Solana transaction signature for the initiating burn/GMP transaction (not a Bitcoin payout txid).
    */
-  unstake(args: {
+  redeemForBtc(args: {
     amount: string;
     btcAddress: string;
     network: string;
-  }): Promise<{ txHash: string }>;
+    env?: Env;
+    tokenMint: string;
+  }): Promise<{ signature: string }>;
+
+  /**
+   * Redeem tokens via Asset Router's generic `redeem` instruction.
+   *
+   * Burns the source token (default LBTC) and sends a GMP message through
+   * the Mailbox to route the destination token (default BTC.b) to the recipient.
+   *
+   * @param args.amount - Amount in base units (satoshis)
+   * @param args.recipient - Owner wallet (Solana base58); the SDK derives the native_mint ATA for the GMP payload from on-chain Asset Router config
+   * @param args.network - Solana network
+   * @returns `{ signature }` — base58 Solana transaction signature for the submitted transaction.
+   */
+  redeem(args: {
+    amount: string;
+    recipient: string;
+    network: string;
+    env?: Env;
+    tokenMint?: string;
+    toLchainId?: string;
+    toTokenAddress?: string;
+  }): Promise<{ signature: string }>;
+
+  /**
+   * Deposit source token (default BTC.b) to receive destination token (default LBTC)
+   * via Asset Router's `deposit` instruction.
+   *
+   * Burns the source token and sends a GMP message through the Mailbox
+   * to mint the destination token to the recipient.
+   *
+   * @param args.amount - Amount in base units (satoshis)
+   * @param args.recipient - Owner wallet (Solana base58); the SDK derives the destination mint ATA for the GMP payload
+   * @param args.network - Solana network
+   * @returns `{ signature }` — base58 Solana transaction signature for the submitted transaction.
+   */
+  deposit(args: {
+    amount: string;
+    recipient: string;
+    network: string;
+    env?: Env;
+    sourceTokenMint?: string;
+    toLchainId?: string;
+    toTokenAddress?: string;
+  }): Promise<{ signature: string }>;
 }