@atomiqlabs/chain-solana 12.0.14 → 13.0.9

package/package.json

@@ -1,41 +1,44 @@
-{
-  "name": "@atomiqlabs/chain-solana",
-  "version": "12.0.14",
-  "description": "Solana specific base implementation",
-  "main": "./dist/index.js",
-  "types:": "./dist/index.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "files": [
-    "/dist",
-    "/src"
-  ],
-  "keywords": [
-    "Solana",
-    "Bitcoin",
-    "Cross-chain",
-    "Cryptocurrency",
-    "Bridge",
-    "Trustless"
-  ],
-  "author": "adambor",
-  "license": "ISC",
-  "dependencies": {
-    "@atomiqlabs/base": "^12.0.3",
-    "@noble/hashes": "^1.7.1",
-    "bn.js": "5.2.1",
-    "bs58": "4.0.1",
-    "buffer": "6.0.3",
-    "tweetnacl": "1.0.3"
-  },
-  "peerDependencies": {
-    "@coral-xyz/anchor": "^0.29.0",
-    "@solana/spl-token": "^0.3.9",
-    "@solana/web3.js": "^1.95.2"
-  },
-  "devDependencies": {
-    "@types/bn.js": "5.1.6",
-    "typescript": "4.9.5"
-  }
-}
+{
+  "name": "@atomiqlabs/chain-solana",
+  "version": "13.0.9",
+  "description": "Solana specific base implementation",
+  "main": "./dist/index.js",
+  "types:": "./dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:ts4": "npx -p typescript@4.9 tsc --noEmit",
+    "build:ts5": "npx -p typescript@5 tsc --noEmit"
+  },
+  "files": [
+    "/dist",
+    "/src"
+  ],
+  "keywords": [
+    "Solana",
+    "Bitcoin",
+    "Cross-chain",
+    "Cryptocurrency",
+    "Bridge",
+    "Trustless"
+  ],
+  "author": "adambor",
+  "license": "ISC",
+  "dependencies": {
+    "@atomiqlabs/base": "^13.0.4",
+    "@coral-xyz/anchor": "0.29.0",
+    "@noble/hashes": "^1.7.1",
+    "@solana/spl-token": "0.4.14",
+    "bn.js": "5.2.1",
+    "bs58": "^4.0.1",
+    "buffer": "6.0.3",
+    "tweetnacl": "1.0.3"
+  },
+  "peerDependencies": {
+    "@solana/web3.js": "^1.95.2"
+  },
+  "devDependencies": {
+    "@types/bn.js": "5.1.6",
+    "@types/node": "^25.0.9",
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -1,36 +1,17 @@
-export * from "./solana/btcrelay/headers/SolanaBtcHeader";
-export * from "./solana/btcrelay/headers/SolanaBtcStoredHeader";
-export * from "./solana/btcrelay/SolanaBtcRelay";
-
-export * from "./solana/chain/modules/SolanaAddresses";
-export * from "./solana/chain/modules/SolanaBlocks";
-export * from "./solana/chain/modules/SolanaEvents";
-export * from "./solana/chain/modules/SolanaFees";
-export * from "./solana/chain/modules/SolanaSignatures";
-export * from "./solana/chain/modules/SolanaSlots";
-export * from "./solana/chain/modules/SolanaTokens";
-export * from "./solana/chain/modules/SolanaTransactions";
-
-export * from "./solana/chain/SolanaAction";
-export * from "./solana/chain/SolanaChainInterface";
-export * from "./solana/chain/SolanaModule";
-
-export * from "./solana/program/modules/SolanaProgramEvents";
-export * from "./solana/program/SolanaProgramBase";
-
-export * from "./solana/swaps/SolanaSwapProgram";
-export * from "./solana/swaps/SolanaSwapData";
-export * from "./solana/swaps/SolanaSwapModule";
-export * from "./solana/swaps/modules/SolanaDataAccount";
-export * from "./solana/swaps/modules/SolanaLpVault";
-export * from "./solana/swaps/modules/SwapClaim";
-export * from "./solana/swaps/modules/SwapInit";
-export * from "./solana/swaps/modules/SwapRefund";
-
-export * from "./solana/wallet/SolanaKeypairWallet";
-export * from "./solana/wallet/SolanaSigner";
-
-export * from "./solana/SolanaChainType";
-export * from "./solana/SolanaInitializer";
-
-export * from "./utils/Utils";
+export {SolanaBtcHeader} from "./solana/btcrelay/headers/SolanaBtcHeader";
+export {SolanaBtcStoredHeader} from "./solana/btcrelay/headers/SolanaBtcStoredHeader";
+export * from "./solana/btcrelay/SolanaBtcRelay";
+
+export * from "./solana/chain/SolanaChainInterface";
+export * from "./solana/chain/modules/SolanaFees";
+
+export * from "./solana/events/SolanaChainEventsBrowser";
+
+export * from "./solana/swaps/SolanaSwapProgram";
+export {SolanaSwapData} from "./solana/swaps/SolanaSwapData";
+
+export * from "./solana/wallet/SolanaKeypairWallet";
+export * from "./solana/wallet/SolanaSigner";
+
+export * from "./solana/SolanaChainType";
+export * from "./solana/SolanaInitializer";

package/src/solana/SolanaChainType.ts

@@ -1,27 +1,32 @@
-import {ChainType} from "@atomiqlabs/base";
-import {SolanaTx} from "./chain/modules/SolanaTransactions";
-import {SolanaPreFetchData, SolanaPreFetchVerification} from "./swaps/modules/SwapInit";
-import {SolanaSigner} from "./wallet/SolanaSigner";
-import {SolanaSwapProgram} from "./swaps/SolanaSwapProgram";
-import {SolanaSwapData} from "./swaps/SolanaSwapData";
-import {SolanaChainEventsBrowser} from "./events/SolanaChainEventsBrowser";
-import {SolanaBtcRelay} from "./btcrelay/SolanaBtcRelay";
-import {SolanaChainInterface} from "./chain/SolanaChainInterface";
-import {Wallet} from "@coral-xyz/anchor/dist/cjs/provider";
-
-export type SolanaChainType = ChainType<
-    "SOLANA",
-    SolanaPreFetchData,
-    SolanaPreFetchVerification,
-    SolanaTx,
-    SolanaSigner,
-    Wallet,
-    SolanaSwapData,
-    SolanaSwapProgram,
-    SolanaChainInterface,
-    SolanaChainEventsBrowser,
-    SolanaBtcRelay<any>,
-    never,
-    never,
-    never
->;
+import {ChainType} from "@atomiqlabs/base";
+import {SignedSolanaTx, SolanaTx} from "./chain/modules/SolanaTransactions";
+import {SolanaPreFetchData, SolanaPreFetchVerification} from "./swaps/modules/SwapInit";
+import {SolanaSigner} from "./wallet/SolanaSigner";
+import {SolanaSwapProgram} from "./swaps/SolanaSwapProgram";
+import {SolanaSwapData} from "./swaps/SolanaSwapData";
+import {SolanaChainEventsBrowser} from "./events/SolanaChainEventsBrowser";
+import {SolanaBtcRelay} from "./btcrelay/SolanaBtcRelay";
+import {SolanaChainInterface} from "./chain/SolanaChainInterface";
+import {Wallet} from "@coral-xyz/anchor/dist/cjs/provider";
+
+/**
+ * Type definition for the Solana chain implementation
+ * @category Chain Interface
+ */
+export type SolanaChainType = ChainType<
+    "SOLANA",
+    SolanaPreFetchData,
+    SolanaPreFetchVerification,
+    SolanaTx,
+    SignedSolanaTx,
+    SolanaSigner,
+    Wallet,
+    SolanaSwapData,
+    SolanaSwapProgram,
+    SolanaChainInterface,
+    SolanaChainEventsBrowser,
+    SolanaBtcRelay<any>,
+    never,
+    never,
+    never
+>;

package/src/solana/SolanaChains.ts

@@ -1,23 +1,23 @@
-import {BitcoinNetwork} from "@atomiqlabs/base";
-
-export const SolanaChains = {
-    //TODO: Not deployed yet
-    [BitcoinNetwork.TESTNET4]: {
-        addresses: {
-            swapContract: "11111111111111111111111111111111",
-            btcRelayContract: "11111111111111111111111111111111"
-        }
-    },
-    [BitcoinNetwork.TESTNET]: {
-        addresses: {
-            swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM",
-            btcRelayContract: "3KHSHFpEK6bsjg3bqcxQ9qssJYtRCMi2S9TYVe4q6CQc"
-        }
-    },
-    [BitcoinNetwork.MAINNET]: {
-        addresses: {
-            swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM",
-            btcRelayContract: "3KHSHFpEK6bsjg3bqcxQ9qssJYtRCMi2S9TYVe4q6CQc"
-        }
-    }
-} as const;
+import {BitcoinNetwork} from "@atomiqlabs/base";
+
+export const SolanaChains: {[key in BitcoinNetwork]?: {addresses: {swapContract: string, btcRelayContract: string}}} = {
+    //TODO: Not deployed yet
+    // [BitcoinNetwork.TESTNET4]: {
+    //     addresses: {
+    //         swapContract: "11111111111111111111111111111111",
+    //         btcRelayContract: "11111111111111111111111111111111"
+    //     }
+    // },
+    [BitcoinNetwork.TESTNET]: {
+        addresses: {
+            swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM",
+            btcRelayContract: "3KHSHFpEK6bsjg3bqcxQ9qssJYtRCMi2S9TYVe4q6CQc"
+        }
+    },
+    [BitcoinNetwork.MAINNET]: {
+        addresses: {
+            swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM",
+            btcRelayContract: "3KHSHFpEK6bsjg3bqcxQ9qssJYtRCMi2S9TYVe4q6CQc"
+        }
+    }
+} as const;

package/src/solana/SolanaInitializer.ts

@@ -1,102 +1,126 @@
-import {
-    BaseTokenType,
-    BitcoinNetwork,
-    BitcoinRpc,
-    ChainData,
-    ChainInitializer,
-    IStorageManager,
-    StorageObject
-} from "@atomiqlabs/base";
-import {Connection} from "@solana/web3.js";
-import {StoredDataAccount} from "./swaps/modules/SolanaDataAccount";
-import {SolanaChainInterface, SolanaRetryPolicy} from "./chain/SolanaChainInterface";
-import {SolanaFees} from "./chain/modules/SolanaFees";
-import {SolanaChainType} from "./SolanaChainType";
-import {SolanaBtcRelay} from "./btcrelay/SolanaBtcRelay";
-import {SolanaChains} from "./SolanaChains";
-import {SolanaSwapProgram} from "./swaps/SolanaSwapProgram";
-import {SolanaChainEventsBrowser} from "./events/SolanaChainEventsBrowser";
-import {SolanaSwapData} from "./swaps/SolanaSwapData";
-
-const chainId = "SOLANA" as const;
-
-export type SolanaAssetsType = BaseTokenType<"WBTC" | "USDC" | "USDT" | "SOL" | "BONK">;
-const SolanaAssets: SolanaAssetsType = {
-    WBTC: {
-        address: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh",
-        decimals: 8
-    },
-    USDC: {
-        address: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
-        decimals: 6
-    },
-    USDT: {
-        address: "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
-        decimals: 6
-    },
-    SOL: {
-        address: "So11111111111111111111111111111111111111112",
-        decimals: 9
-    },
-    BONK: {
-        address: "DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263",
-        decimals: 5
-    }
-} as const;
-
-export type SolanaSwapperOptions = {
-    rpcUrl: string | Connection,
-    dataAccountStorage?: IStorageManager<StoredDataAccount>,
-    retryPolicy?: SolanaRetryPolicy,
-
-    btcRelayContract?: string,
-    swapContract?: string,
-
-    fees?: SolanaFees
-};
-
-export function initializeSolana(
-    options: SolanaSwapperOptions,
-    bitcoinRpc: BitcoinRpc<any>,
-    network: BitcoinNetwork,
-    storageCtor: <T extends StorageObject>(name: string) => IStorageManager<T>
-): ChainData<SolanaChainType> {
-    const connection = typeof(options.rpcUrl)==="string" ?
-        new Connection(options.rpcUrl) :
-        options.rpcUrl;
-
-    const Fees = options.fees ?? new SolanaFees(connection, 200000, 4, 100);
-
-    const chainInterface = new SolanaChainInterface(connection, options.retryPolicy ?? {transactionResendInterval: 1000}, Fees);
-
-    const btcRelay = new SolanaBtcRelay(chainInterface, bitcoinRpc, options.btcRelayContract ?? SolanaChains[network].addresses.btcRelayContract);
-
-    const swapContract = new SolanaSwapProgram(
-        chainInterface,
-        btcRelay,
-        options.dataAccountStorage || storageCtor("solAccounts"),
-        options.swapContract ?? SolanaChains[network].addresses.swapContract
-    );
-    const chainEvents = new SolanaChainEventsBrowser(connection, swapContract);
-
-    return {
-        chainId,
-        btcRelay,
-        swapContract,
-        chainEvents,
-        swapDataConstructor: SolanaSwapData,
-        chainInterface,
-        spvVaultContract: null as never,
-        spvVaultDataConstructor: null,
-        spvVaultWithdrawalDataConstructor: null
-    };
-}
-
-export type SolanaInitializerType = ChainInitializer<SolanaSwapperOptions, SolanaChainType, SolanaAssetsType>;
-export const SolanaInitializer: SolanaInitializerType = {
-    chainId,
-    chainType: null as SolanaChainType,
-    initializer: initializeSolana,
-    tokens: SolanaAssets,
-    options: null as SolanaSwapperOptions
-} as const;
+import {
+    BaseTokenType,
+    BitcoinNetwork,
+    BitcoinRpc,
+    ChainData,
+    ChainInitializer,
+    IStorageManager,
+    StorageObject
+} from "@atomiqlabs/base";
+import {Connection} from "@solana/web3.js";
+import {StoredDataAccount} from "./swaps/modules/SolanaDataAccount";
+import {SolanaChainInterface, SolanaRetryPolicy} from "./chain/SolanaChainInterface";
+import {SolanaFees} from "./chain/modules/SolanaFees";
+import {SolanaChainType} from "./SolanaChainType";
+import {SolanaBtcRelay} from "./btcrelay/SolanaBtcRelay";
+import {SolanaChains} from "./SolanaChains";
+import {SolanaSwapProgram} from "./swaps/SolanaSwapProgram";
+import {SolanaChainEventsBrowser} from "./events/SolanaChainEventsBrowser";
+import {SolanaSwapData} from "./swaps/SolanaSwapData";
+
+const chainId = "SOLANA" as const;
+
+/**
+ * Token assets available on Solana
+ * @category Chain Interface
+ */
+export type SolanaAssetsType = BaseTokenType<"WBTC" | "USDC" | "USDT" | "SOL" | "BONK">;
+const SolanaAssets: SolanaAssetsType = {
+    WBTC: {
+        address: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh",
+        decimals: 8
+    },
+    USDC: {
+        address: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
+        decimals: 6
+    },
+    USDT: {
+        address: "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
+        decimals: 6
+    },
+    SOL: {
+        address: "So11111111111111111111111111111111111111112",
+        decimals: 9
+    },
+    BONK: {
+        address: "DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263",
+        decimals: 5
+    }
+} as const;
+
+/**
+ * Configuration options for initializing Solana chain
+ * @category Chain Interface
+ */
+export type SolanaSwapperOptions = {
+    rpcUrl: string | Connection,
+    dataAccountStorage?: IStorageManager<StoredDataAccount>,
+    retryPolicy?: SolanaRetryPolicy,
+
+    btcRelayContract?: string,
+    swapContract?: string,
+
+    fees?: SolanaFees
+};
+
+/**
+ * Initialize Solana chain integration
+ * @category Chain Interface
+ */
+export function initializeSolana(
+    options: SolanaSwapperOptions,
+    bitcoinRpc: BitcoinRpc<any>,
+    network: BitcoinNetwork,
+    storageCtor: <T extends StorageObject>(name: string) => IStorageManager<T>
+): ChainData<SolanaChainType> {
+    const connection = typeof(options.rpcUrl)==="string" ?
+        new Connection(options.rpcUrl) :
+        options.rpcUrl;
+
+    const solanaChainData = SolanaChains[network];
+    if(solanaChainData==null) throw new Error(`Unsupported bitcoin network for Solana: ${BitcoinNetwork[network]}`);
+
+    const Fees = options.fees ?? new SolanaFees(connection, 200000, 4, 100);
+
+    const chainInterface = new SolanaChainInterface(connection, options.retryPolicy ?? {transactionResendInterval: 1000}, Fees);
+
+    const btcRelay = new SolanaBtcRelay(chainInterface, bitcoinRpc, options.btcRelayContract ?? solanaChainData.addresses.btcRelayContract);
+
+    const swapContract = new SolanaSwapProgram(
+        chainInterface,
+        btcRelay,
+        options.dataAccountStorage || storageCtor("solAccounts"),
+        options.swapContract ?? solanaChainData.addresses.swapContract
+    );
+    const chainEvents = new SolanaChainEventsBrowser(connection, swapContract);
+
+    return {
+        chainId,
+        btcRelay,
+        swapContract,
+        chainEvents,
+        swapDataConstructor: SolanaSwapData,
+        chainInterface,
+        spvVaultContract: null as never,
+        spvVaultDataConstructor: null as never,
+        spvVaultWithdrawalDataConstructor: null as never
+    };
+}
+
+/**
+ * Type definition for the Solana chain initializer
+ * @category Chain Interface
+ */
+export type SolanaInitializerType = ChainInitializer<SolanaSwapperOptions, SolanaChainType, SolanaAssetsType>;
+
+/**
+ * Solana chain initializer instance
+ * @category Chain Interface
+ */
+export const SolanaInitializer: SolanaInitializerType = {
+    chainId,
+    chainType: null as unknown as SolanaChainType,
+    initializer: initializeSolana,
+    tokens: SolanaAssets,
+    options: null as unknown as SolanaSwapperOptions
+} as const;