@atomiqlabs/sdk 5.0.0-dev.1 → 5.0.0-dev.3

package/README.md

@@ -30,8 +30,10 @@ npm install @atomiqlabs/chain-evm@dev
   - [BTC L1 -> Starknet/EVM (New swap protocol)](#swap-bitcoin-on-chain---starknetevm)
   - [Smart Chain -> BTC Lightning network L2](#swap-smart-chain---bitcoin-lightning-network)
   - [Smart Chain -> BTC Lightning network L2 (LNURL-pay)](#swap-smart-chain---bitcoin-lightning-network-1)
-  - [BTC Lightning network L2 -> Smart Chain](#swap-bitcoin-lightning-network---smart-chain)
-  - [BTC Lightning network L2 (LNURL-withdraw) -> Smart Chain](#swap-bitcoin-lightning-network---smart-chain-1)
+  - [BTC Lightning network L2 -> Solana (Old swap protocol)](#swap-bitcoin-lightning-network---solana)
+  - [BTC Lightning network L2 -> Starknet/EVM (New swap protocol)](#swap-bitcoin-lightning-network---starknetevm)
+  - [BTC Lightning network L2 (LNURL-withdraw) -> Solana (Old swap protocol)](#swap-bitcoin-lightning-network---solana-1)
+  - [BTC Lightning network L2 (LNURL-withdraw) -> Starknet/EVM (New swap protocol)](#swap-bitcoin-lightning-network---starknetevm-1)
 - [Swap states](#getting-state-of-the-swap)
 - [Swap size limits](#swap-size-limits)
 - [Stored swaps](#stored-swaps)
@@ -587,7 +589,9 @@ if(!result) {
 - ToBTCSwapState.REFUNDABLE = 4
     - Swap was initiated but counterparty failed to process it, the user can now refund his funds
 
-#### Swap Bitcoin lightning network -> Smart chain
+#### Swap Bitcoin lightning network -> Solana
+
+NOTE: Solana uses an old swap protocol for Bitcoin lightning network -> Solana swaps, the flow here is different from the one for Starknet and other chains.
 
 Getting swap quote
 
@@ -597,7 +601,7 @@ const _amount = 10000n; //Amount in BTC base units - sats
 
 const swap = await swapper.swap(
     Tokens.BITCOIN.BTCLN, //Swap from BTC-LN
-    Tokens.STARKNET.STRK, //Into specified destination token
+    Tokens.SOLANA.SOL, //Into specified destination token
     _amount,
     _exactIn, //Whether we define an input or output amount
     undefined, //Source address for the swap, not used for swaps from BTC-LN
@@ -680,6 +684,88 @@ or [sign and send transactions manually](#manually-signing-smart-chain-transacti
 - FromBTCLNSwapState.CLAIM_CLAIMED = 3
   - Funds were successfully claimed & lightning network secret pre-image revealed, so the lightning network payment will settle now
 
+
+#### Swap Bitcoin lightning network -> Starknet/EVM
+
+Getting swap quote
+
+```typescript
+const _exactIn = true; //exactIn = true, so we specify the input amount
+const _amount = 10000n; //Amount in BTC base units - sats
+
+const swap = await swapper.swap(
+    Tokens.BITCOIN.BTCLN, //Swap from BTC-LN
+    Tokens.STARKNET.STRK, //Into specified destination token
+    _amount,
+    _exactIn, //Whether we define an input or output amount
+    undefined, //Source address for the swap, not used for swaps from BTC-LN
+    signer.getAddress(), //Destination address
+    {
+        gasAmount: 1_000_000_000_000_000_000n //We can also request a gas drop on the destination chain (here requesting 1 STRK)
+    }
+);
+
+//Get the bitcoin lightning network invoice (the invoice contains pre-entered amount)
+const receivingLightningInvoice: string = swap.getAddress();
+//Get the URI hyperlink (contains the lightning network invoice) which can be displayed also as QR code
+const qrCodeData: string = swap.getHyperlink();
+
+//Get the amount required to pay and fee
+const input: string = swap.getInputWithoutFee().toString(); //Input amount excluding fees
+const fee: string = swap.getFee().amountInSrcToken.toString(); //Fees paid on the output
+const inputWithFees: string = swap.getInput().toString(); //Total amount paid including fees
+
+const output: string = swap.getOutput().toString(); //Total output amount
+
+//Get swap expiration time
+const expiry: number = swap.getQuoteExpiry(); //Expiration time of the swap quote in UNIX milliseconds, swap needs to be initiated before this time
+
+//Get pricing info
+const swapPrice = swap.getPriceInfo().swapPrice; //Price of the current swap (excluding fees)
+const marketPrice = swap.getPriceInfo().marketPrice; //Current market price
+const difference = swap.getPriceInfo().difference; //Difference between the swap price & current market price
+```
+
+Pay the displayed lightning network invoice from an external lightning network wallet
+
+Wait for the payment to be received and settle the swap.
+
+```typescript
+//Start listening to incoming lightning network payment
+const success = await swap.waitForPayment();
+if(!success) {
+    //Lightning network payment not received in time and quote expired!
+    return;
+}
+
+//Swap should get automatically claimed by the watchtowers, if not we can call swap.claim() to claim the swap ourselves
+try {
+  await swap.waitTillClaimed(timeoutSignal(30*1000));
+} catch (e) {
+  //Claim ourselves when automatic claim doesn't happen in 30 seconds
+  await swap.claim(starknetSigner);
+}
+```
+
+##### Swap states
+
+- FromBTCLNAutoSwapState.FAILED = -4
+  - If the claiming of the funds was initiated, but never concluded, the user will get his lightning network payment refunded
+- FromBTCLNAutoSwapState.QUOTE_EXPIRED = -3
+  - Swap quote expired and cannot be executed anymore
+- FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED = -2
+  - Swap quote soft-expired (i.e. the quote probably expired, but if there is already an initialization transaction sent it might still succeed)
+- FromBTCLNAutoSwapState.EXPIRED = -1
+  - Lightning network invoice expired, meaning the swap is expired
+- FromBTCLNAutoSwapState.PR_CREATED = 0
+  - Swap is created, the user should now pay the provided lightning network invoice
+- FromBTCLNAutoSwapState.PR_PAID = 1
+  - Lightning network invoice payment was received (but cannot be settled by the counterparty yet)
+- FromBTCLNAutoSwapState.CLAIM_COMMITED = 2
+  - A swap HTLC was offered by the LP to the user
+- FromBTCLNAutoSwapState.CLAIM_CLAIMED = 3
+  - Funds were successfully claimed & lightning network secret pre-image revealed, so the lightning network payment will settle now
+
 ### LNURLs & readable lightning identifiers
 
 LNURLs extend the lightning network functionality by creating static lightning addreses (LNURL-pay & static internet identifiers) and QR codes which allow you to pull funds from them (LNURL-withdraw)
@@ -776,7 +862,9 @@ if(!result) {
 }
 ```
 
-#### Swap Bitcoin lightning network -> Smart chain
+#### Swap Bitcoin lightning network -> Solana
+
+NOTE: Solana uses an old swap protocol for Bitcoin lightning network -> Solana swaps, the flow here is different from the one for Starknet and other chains.
 
 Getting swap quote
 
@@ -787,7 +875,7 @@ const _amount = 10000n; //Amount in BTC base units - sats
 
 const swap = await swapper.swap(
     Tokens.BITCOIN.BTCLN, //Swap from BTC-LN
-    Tokens.STARKNET.STRK, //Into specified destination token
+    Tokens.SOLANA.SOL, //Into specified destination token
     _amount,
     _exactIn, //Whether we define an input or output amount
     _lnurl, //Source LNURL for the swap
@@ -844,6 +932,62 @@ try {
 
 or [sign and send transactions manually](#manually-signing-smart-chain-transactions)
 
+#### Swap Bitcoin lightning network -> Starknet/EVM
+
+Getting swap quote
+
+```typescript
+const _lnurl: string = "lnurl1dp68gurn8ghj7ampd3kx2ar0veekzar0wd5xjtnrdakj7tnhv4kxctttdehhwm30d3h82unvwqhkx6rfvdjx2ctvxyesuk0a27"; //Destination LNURL-pay or readable identifier
+const _exactIn = true; //exactIn = true, so we specify the input amount
+const _amount = 10000n; //Amount in BTC base units - sats
+
+const swap = await swapper.swap(
+    Tokens.BITCOIN.BTCLN, //Swap from BTC-LN
+    Tokens.STARKNET.STRK, //Into specified destination token
+    _amount,
+    _exactIn, //Whether we define an input or output amount
+    _lnurl, //Source LNURL for the swap
+    signer.getAddress(), //Destination address
+    {
+        gasAmount: 1_000_000_000_000_000_000n //We can also request a gas drop on the destination chain (here requesting 1 STRK)
+    }
+);
+
+//Get the amount required to pay and fee
+const input: string = swap.getInputWithoutFee().toString(); //Input amount excluding fees
+const fee: string = swap.getFee().amountInSrcToken.toString(); //Fees paid on the output
+const inputWithFees: string = swap.getInput().toString(); //Total amount paid including fees
+
+const output: string = swap.getOutput().toString(); //Total output amount
+
+//Get swap expiration time
+const expiry: number = swap.getQuoteExpiry(); //Expiration time of the swap quote in UNIX milliseconds, swap needs to be initiated before this time
+
+//Get pricing info
+const swapPrice = swap.getPriceInfo().swapPrice; //Price of the current swap (excluding fees)
+const marketPrice = swap.getPriceInfo().marketPrice; //Current market price
+const difference = swap.getPriceInfo().difference; //Difference between the swap price & current market price
+```
+
+Wait for the payment to be received & settle the swap.
+
+```typescript
+//Start listening to incoming lightning network payment
+const success = await swap.waitForPayment();
+if(!success) {
+  //Lightning network payment not received in time and quote expired!
+  return;
+}
+
+//Swap should get automatically claimed by the watchtowers, if not we can call swap.claim() to claim the swap ourselves
+try {
+  await swap.waitTillClaimed(timeoutSignal(30*1000));
+} catch (e) {
+  //Claim ourselves when automatic claim doesn't happen in 30 seconds
+  await swap.claim(starknetSigner);
+}
+```
+
 ### Getting state of the swap
 
 You can get the current state of the swap with:

package/dist/SwapperFactory.d.ts

@@ -1,4 +1,4 @@
-import { ChainData, BitcoinNetwork, BitcoinRpc, BaseTokenType, ChainType, StorageObject, IStorageManager } from "@atomiqlabs/base";
+import { ChainData, BitcoinNetwork, BitcoinRpc, BaseTokenType, ChainType, StorageObject, IStorageManager, Messenger } from "@atomiqlabs/base";
 import { BtcToken, CustomPriceFunction, MempoolApi, MempoolBitcoinRpc, SCToken, Swapper, SwapperOptions } from "@atomiqlabs/sdk-lib";
 type ChainInitializer<O, C extends ChainType, T extends BaseTokenType> = {
     chainId: ChainType["ChainId"];
@@ -33,6 +33,7 @@ export type MultichainSwapperOptions<T extends readonly ChainInitializer<any, an
     chainStorageCtor?: <T extends StorageObject>(name: string) => IStorageManager<T>;
     pricingFeeDifferencePPM?: bigint;
     mempoolApi?: MempoolApi | MempoolBitcoinRpc | string | string[];
+    messenger?: Messenger;
     getPriceFn?: CustomPriceFunction;
 };
 export declare class SwapperFactory<T extends readonly ChainInitializer<any, any, any>[]> {

package/dist/SwapperFactory.js

@@ -5,6 +5,7 @@ const base_1 = require("@atomiqlabs/base");
 const sdk_lib_1 = require("@atomiqlabs/sdk-lib");
 const SmartChainAssets_1 = require("./SmartChainAssets");
 const LocalStorageManager_1 = require("./storage/LocalStorageManager");
+const messenger_nostr_1 = require("@atomiqlabs/messenger-nostr");
 const registries = {
     [base_1.BitcoinNetwork.MAINNET]: "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry-mainnet.json?ref=main",
     [base_1.BitcoinNetwork.TESTNET]: "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry.json?ref=main",
@@ -34,6 +35,9 @@ const mempoolUrls = {
         "https://mempool.tk7.mempool.space/testnet4/api/"
     ]
 };
+const nostrUrls = [
+    "wss://relay.damus.io", "wss://nostr.einundzwanzig.space", "wss://nostr.mutinywallet.com"
+];
 class SwapperFactory {
     constructor(initializers) {
         this.initializers = initializers;
@@ -65,6 +69,7 @@ class SwapperFactory {
     newSwapper(options) {
         options.bitcoinNetwork ?? (options.bitcoinNetwork = base_1.BitcoinNetwork.MAINNET);
         options.storagePrefix ?? (options.storagePrefix = "atomiqsdk-" + options.bitcoinNetwork + "-");
+        options.messenger ?? (options.messenger = new messenger_nostr_1.NostrMessenger(nostrUrls));
         options.defaultTrustedIntermediaryUrl ?? (options.defaultTrustedIntermediaryUrl = trustedIntermediaries[options.bitcoinNetwork]);
         options.registryUrl ?? (options.registryUrl = registries[options.bitcoinNetwork]);
         const mempoolApi = options.mempoolApi ?? new sdk_lib_1.MempoolBitcoinRpc(mempoolUrls[options.bitcoinNetwork]);
@@ -99,7 +104,7 @@ class SwapperFactory {
                 };
             }), options.getPriceFn)) :
             sdk_lib_1.RedundantSwapPrice.createFromTokenMap(options.pricingFeeDifferencePPM ?? 10000n, pricingAssets);
-        return new sdk_lib_1.Swapper(bitcoinRpc, chains, swapPricing, pricingAssets, options);
+        return new sdk_lib_1.Swapper(bitcoinRpc, chains, swapPricing, pricingAssets, options.messenger, options);
     }
 }
 exports.SwapperFactory = SwapperFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "5.0.0-dev.1",
+  "version": "5.0.0-dev.3",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",
@@ -21,8 +21,9 @@
   "author": "adambor",
   "license": "ISC",
   "dependencies": {
-    "@atomiqlabs/base": "^10.0.0-dev.1",
-    "@atomiqlabs/sdk-lib": "^14.0.0-dev.3"
+    "@atomiqlabs/base": "^10.0.0-dev.9",
+    "@atomiqlabs/messenger-nostr": "^1.0.0-dev.2",
+    "@atomiqlabs/sdk-lib": "^14.0.0-dev.28"
   },
   "devDependencies": {
     "@types/node": "22.13.5",

package/src/SwapperFactory.ts

@@ -5,7 +5,7 @@ import {
     BaseTokenType,
     ChainType,
     StorageObject,
-    IStorageManager
+    IStorageManager, Messenger
 } from "@atomiqlabs/base";
 import {
     BitcoinTokens,
@@ -17,6 +17,7 @@ import {
 } from "@atomiqlabs/sdk-lib";
 import {SmartChainAssets} from "./SmartChainAssets";
 import {LocalStorageManager} from "./storage/LocalStorageManager";
+import {NostrMessenger} from "@atomiqlabs/messenger-nostr";
 
 type ChainInitializer<O, C extends ChainType, T extends BaseTokenType> = {
     chainId: ChainType["ChainId"],
@@ -67,6 +68,7 @@ export type MultichainSwapperOptions<T extends readonly ChainInitializer<any, an
     chainStorageCtor?: <T extends StorageObject>(name: string) => IStorageManager<T>,
     pricingFeeDifferencePPM?: bigint,
     mempoolApi?: MempoolApi | MempoolBitcoinRpc | string | string[],
+    messenger?: Messenger,
     getPriceFn?: CustomPriceFunction
 };
 
@@ -102,6 +104,10 @@ const mempoolUrls = {
     ]
 }
 
+const nostrUrls: string[] = [
+    "wss://relay.damus.io", "wss://nostr.einundzwanzig.space", "wss://nostr.mutinywallet.com"
+];
+
 export class SwapperFactory<T extends readonly ChainInitializer<any, any, any>[]> {
 
     Tokens: GetAllTokens<T> & {
@@ -143,6 +149,7 @@ export class SwapperFactory<T extends readonly ChainInitializer<any, any, any>[]
     newSwapper(options: MultichainSwapperOptions<T>) {
         options.bitcoinNetwork ??= BitcoinNetwork.MAINNET as any;
         options.storagePrefix ??= "atomiqsdk-"+options.bitcoinNetwork+"-";
+        options.messenger ??= new NostrMessenger(nostrUrls);
 
         options.defaultTrustedIntermediaryUrl ??= trustedIntermediaries[options.bitcoinNetwork];
 
@@ -188,6 +195,7 @@ export class SwapperFactory<T extends readonly ChainInitializer<any, any, any>[]
             chains as any,
             swapPricing,
             pricingAssets,
+            options.messenger,
             options
         );
     }