@atomiqlabs/sdk 4.0.0 → 5.0.0-dev.0

package/README.md

@@ -6,7 +6,7 @@ Example SDK integration in NodeJS available [here](https://github.com/atomiqlabs
 
 ## Installation
 ```
-npm install @atomiqlabs/sdk
+npm install @atomiqlabs/sdk@dev
 ```
 
 ## Installing chain-specific connectors
@@ -14,8 +14,9 @@ npm install @atomiqlabs/sdk
 You can install only the chain-specific connectors that your project requires
 
 ```
-npm install @atomiqlabs/chain-solana
-npm install @atomiqlabs/chain-starknet
+npm install @atomiqlabs/chain-solana@dev
+npm install @atomiqlabs/chain-starknet@dev
+npm install @atomiqlabs/chain-evm@dev
 ```
 
 ## How to use?
@@ -26,7 +27,7 @@ npm install @atomiqlabs/chain-starknet
 - Swaps:
   - [Smart Chain -> BTC L1](#swap-smart-chain---bitcoin-on-chain)
   - [BTC L1 -> Solana (Old swap protocol)](#swap-bitcoin-on-chain---solana)
-  - [BTC L1 -> Starknet (New swap protocol)](#swap-bitcoin-on-chain---starknet)
+  - [BTC L1 -> Starknet/EVM (New swap protocol)](#swap-bitcoin-on-chain---starknet-evm)
   - [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)
@@ -48,7 +49,8 @@ Set Solana & Starknet RPC URL to use
 
 ```typescript
 const solanaRpc = "https://api.mainnet-beta.solana.com";
-const starknetRpc = "https://starknet-mainnet.public.blastapi.io/rpc/v0_7";
+const starknetRpc = "https://starknet-mainnet.public.blastapi.io/rpc/v0_8";
+const citreaRpc = "https://rpc.testnet.citrea.xyz";
 ```
 
 Create swapper factory, here we can pick and choose which chains we want to have supported in the SDK, ensure the "as const" keyword is used such that the typescript compiler can properly infer the types.
@@ -56,9 +58,10 @@ Create swapper factory, here we can pick and choose which chains we want to have
 ```typescript
 import {SolanaInitializer, SolanaInitializerType} from "@atomiqlabs/chain-solana";
 import {StarknetInitializer, StarknetInitializerType} from "@atomiqlabs/chain-starknet";
+import {CitreaInitializer, CitreaInitializerType} from "@atomiqlabs/chain-evm";
 import {SwapperFactory} from "@atomiqlabs/sdk";
 
-const Factory = new SwapperFactory<[SolanaInitializerType, StarknetInitializerType]>([SolanaInitializer, StarknetInitializer] as const);
+const Factory = new SwapperFactory<[SolanaInitializerType, StarknetInitializerType, CitreaInitializerType]>([SolanaInitializer, StarknetInitializer, CitreaInitializer] as const);
 const Tokens = Factory.Tokens; //Get the supported tokens for all the specified chains.
 ```
 
@@ -75,7 +78,10 @@ const swapper = Factory.newSwapper({
             rpcUrl: solanaRpc //You can also pass Connection object here
         },
         STARKNET: {
-            rpcUrl: starknetRpc //You can also pass Provider object here
+            rpcUrl: starknetRpc //You can also pass Provider object here           
+        },
+        CITREA: {
+            rpcUrl: citreaRpc, //You can also pass JsonApiProvider object here
         }
     },
     bitcoinNetwork: BitcoinNetwork.TESTNET //or BitcoinNetwork.MAINNET, BitcoinNetwork.TESTNET4 - this also sets the network to use for Solana (solana devnet for bitcoin testnet) & Starknet (sepolia for bitcoin testnet)
@@ -105,6 +111,9 @@ const swapper = Factory.newSwapper({
         },
         STARKNET: {
             rpcUrl: starknetRpc //You can also pass Provider object here
+        },
+        CITREA: {
+            rpcUrl: citreaRpc, //You can also pass JsonApiProvider object here
         }
     },
     bitcoinNetwork: BitcoinNetwork.TESTNET, //or BitcoinNetwork.MAINNET - this also sets the network to use for Solana (solana devnet for bitcoin testnet) & Starknet (sepolia for bitcoin testnet)
@@ -144,11 +153,19 @@ const solanaSigner = new SolanaSigner(new SolanaKeypairWallet(Keypair.fromSecret
 ```
 
 ```typescript
-import {SolanaKeypairWallet, SolanaSigner} from "@atomiqlabs/chain-solana";
+import {StarknetSigner, StarknetKeypairWallet} from "@atomiqlabs/chain-starknet";
 //Creating Starknet signer from private key
 const starknetSigner = new StarknetSigner(new StarknetKeypairWallet(starknetRpc, starknetKey));
 ```
 
+```typescript
+import {BaseWallet, SigningKey} from "ethers";
+import {EVMSigner} from "@atomiqlabs/chain-evm";
+//Creating EVM signer from private key
+const wallet = new BaseWallet(new SigningKey(evmKey));
+const evmWallet = new EVMSigner(wallet, wallet.address);
+```
+
 ### Initialization
 
 Initialize the swapper
@@ -371,9 +388,9 @@ try {
   - Swap funds are claimed to the user's wallet
 
 
-#### Swap Bitcoin on-chain -> Starknet
+#### Swap Bitcoin on-chain -> Starknet/EVM
 
-NOTE: Starknet uses a new swap protocol for Bitcoin on-chain -> Solana swaps, the flow here is different from the one for Solana!
+NOTE: Starknet & EVM uses a new swap protocol for Bitcoin on-chain -> Smart chain swaps, the flow here is different from the one for Solana!
 
 Getting swap quote
 
@@ -774,7 +791,7 @@ const swap = await swapper.swap(
     _amount,
     _exactIn, //Whether we define an input or output amount
     _lnurl, //Source LNURL for the swap
-    signer.getAddress() //Destination address
+    signer.getAddress(), //Destination address
 );
 
 //Get the amount required to pay and fee
@@ -1042,6 +1059,13 @@ for(let tx of txns) {
     if(tx.type==="DEPLOY_ACCOUNT") await starknetSigner.account.deployAccount(tx.tx, tx.details);
 }
 await swap.waitTillCommited(); //Or other relevant waitTillClaimed, waitTillRefunded
+
+//Example for EVM
+const txns = await swap.txsCommit(); //Also works with txsClaim, txsRefund, txCommitAndClaim
+for(let tx of txns) {
+  await evmSigner.account.sendTransaction(tx);
+}
+await swap.waitTillCommited(); //Or other relevant waitTillClaimed, waitTillRefunded
 ```
 
 ### Additional swapper options

package/dist/SmartChainAssets.d.ts

@@ -69,5 +69,25 @@ export declare const SmartChainAssets: {
         };
         readonly name: "Starknet";
     };
+    readonly CBTC: {
+        readonly pricing: {
+            readonly binancePair: "$fixed-100000000";
+            readonly okxPair: "$fixed-100000000";
+            readonly coinGeckoCoinId: "$fixed-100000000";
+            readonly coinPaprikaCoinId: "$fixed-100000000";
+            readonly krakenPair: "$fixed-100000000";
+        };
+        readonly name: "Citrea BTC";
+    };
+    readonly BBTC: {
+        readonly pricing: {
+            readonly binancePair: "$fixed-100000000";
+            readonly okxPair: "$fixed-100000000";
+            readonly coinGeckoCoinId: "$fixed-100000000";
+            readonly coinPaprikaCoinId: "$fixed-100000000";
+            readonly krakenPair: "$fixed-100000000";
+        };
+        readonly name: "Botanix BTC";
+    };
 };
 export type SmartChainAssetTickers = keyof typeof SmartChainAssets;

package/dist/SmartChainAssets.js

@@ -71,5 +71,25 @@ exports.SmartChainAssets = {
             krakenPair: "STRKUSD;!XXBTZUSD"
         },
         name: "Starknet"
+    },
+    CBTC: {
+        pricing: {
+            binancePair: "$fixed-100000000",
+            okxPair: "$fixed-100000000",
+            coinGeckoCoinId: "$fixed-100000000",
+            coinPaprikaCoinId: "$fixed-100000000",
+            krakenPair: "$fixed-100000000"
+        },
+        name: "Citrea BTC"
+    },
+    BBTC: {
+        pricing: {
+            binancePair: "$fixed-100000000",
+            okxPair: "$fixed-100000000",
+            coinGeckoCoinId: "$fixed-100000000",
+            coinPaprikaCoinId: "$fixed-100000000",
+            krakenPair: "$fixed-100000000"
+        },
+        name: "Botanix BTC"
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "4.0.0",
+  "version": "5.0.0-dev.0",
   "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,8 @@
   "author": "adambor",
   "license": "ISC",
   "dependencies": {
-    "@atomiqlabs/base": "^9.0.0",
-    "@atomiqlabs/sdk-lib": "^13.0.0"
+    "@atomiqlabs/base": "^10.0.0-dev.1",
+    "@atomiqlabs/sdk-lib": "^14.0.0-dev.3"
   },
   "devDependencies": {
     "@types/node": "22.13.5",

package/src/SmartChainAssets.ts

@@ -70,6 +70,26 @@ export const SmartChainAssets = {
             krakenPair: "STRKUSD;!XXBTZUSD"
         },
         name: "Starknet"
+    },
+    CBTC: {
+        pricing: {
+            binancePair: "$fixed-100000000",
+            okxPair: "$fixed-100000000",
+            coinGeckoCoinId: "$fixed-100000000",
+            coinPaprikaCoinId: "$fixed-100000000",
+            krakenPair: "$fixed-100000000"
+        },
+        name: "Citrea BTC"
+    },
+    BBTC: {
+        pricing: {
+            binancePair: "$fixed-100000000",
+            okxPair: "$fixed-100000000",
+            coinGeckoCoinId: "$fixed-100000000",
+            coinPaprikaCoinId: "$fixed-100000000",
+            krakenPair: "$fixed-100000000"
+        },
+        name: "Botanix BTC"
     }
 } as const;