@atomiqlabs/chain-solana 12.0.15 → 13.0.10

package/dist/index.d.ts

@@ -1,29 +1,12 @@
-export * from "./solana/btcrelay/headers/SolanaBtcHeader";
-export * from "./solana/btcrelay/headers/SolanaBtcStoredHeader";
+export { SolanaBtcHeader } from "./solana/btcrelay/headers/SolanaBtcHeader";
+export { SolanaBtcStoredHeader } 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/chain/modules/SolanaFees";
+export * from "./solana/events/SolanaChainEventsBrowser";
 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 { SolanaSwapData } from "./solana/swaps/SolanaSwapData";
 export * from "./solana/wallet/SolanaKeypairWallet";
 export * from "./solana/wallet/SolanaSigner";
 export * from "./solana/SolanaChainType";
 export * from "./solana/SolanaInitializer";
-export * from "./utils/Utils";

package/dist/index.js

@@ -14,32 +14,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./solana/btcrelay/headers/SolanaBtcHeader"), exports);
-__exportStar(require("./solana/btcrelay/headers/SolanaBtcStoredHeader"), exports);
+exports.SolanaSwapData = exports.SolanaBtcStoredHeader = exports.SolanaBtcHeader = void 0;
+var SolanaBtcHeader_1 = require("./solana/btcrelay/headers/SolanaBtcHeader");
+Object.defineProperty(exports, "SolanaBtcHeader", { enumerable: true, get: function () { return SolanaBtcHeader_1.SolanaBtcHeader; } });
+var SolanaBtcStoredHeader_1 = require("./solana/btcrelay/headers/SolanaBtcStoredHeader");
+Object.defineProperty(exports, "SolanaBtcStoredHeader", { enumerable: true, get: function () { return SolanaBtcStoredHeader_1.SolanaBtcStoredHeader; } });
 __exportStar(require("./solana/btcrelay/SolanaBtcRelay"), exports);
-__exportStar(require("./solana/chain/modules/SolanaAddresses"), exports);
-__exportStar(require("./solana/chain/modules/SolanaBlocks"), exports);
-__exportStar(require("./solana/chain/modules/SolanaEvents"), exports);
-__exportStar(require("./solana/chain/modules/SolanaFees"), exports);
-__exportStar(require("./solana/chain/modules/SolanaSignatures"), exports);
-__exportStar(require("./solana/chain/modules/SolanaSlots"), exports);
-__exportStar(require("./solana/chain/modules/SolanaTokens"), exports);
-__exportStar(require("./solana/chain/modules/SolanaTransactions"), exports);
-__exportStar(require("./solana/chain/SolanaAction"), exports);
 __exportStar(require("./solana/chain/SolanaChainInterface"), exports);
-__exportStar(require("./solana/chain/SolanaModule"), exports);
-__exportStar(require("./solana/program/modules/SolanaProgramEvents"), exports);
-__exportStar(require("./solana/program/SolanaProgramBase"), exports);
+__exportStar(require("./solana/chain/modules/SolanaFees"), exports);
+__exportStar(require("./solana/events/SolanaChainEventsBrowser"), exports);
 __exportStar(require("./solana/swaps/SolanaSwapProgram"), exports);
-__exportStar(require("./solana/swaps/SolanaSwapData"), exports);
-__exportStar(require("./solana/swaps/SolanaSwapModule"), exports);
-__exportStar(require("./solana/swaps/modules/SolanaDataAccount"), exports);
-__exportStar(require("./solana/swaps/modules/SolanaLpVault"), exports);
-__exportStar(require("./solana/swaps/modules/SwapClaim"), exports);
-__exportStar(require("./solana/swaps/modules/SwapInit"), exports);
-__exportStar(require("./solana/swaps/modules/SwapRefund"), exports);
+var SolanaSwapData_1 = require("./solana/swaps/SolanaSwapData");
+Object.defineProperty(exports, "SolanaSwapData", { enumerable: true, get: function () { return SolanaSwapData_1.SolanaSwapData; } });
 __exportStar(require("./solana/wallet/SolanaKeypairWallet"), exports);
 __exportStar(require("./solana/wallet/SolanaSigner"), exports);
 __exportStar(require("./solana/SolanaChainType"), exports);
 __exportStar(require("./solana/SolanaInitializer"), exports);
-__exportStar(require("./utils/Utils"), exports);

package/dist/solana/SolanaChainType.d.ts

@@ -1,5 +1,5 @@
 import { ChainType } from "@atomiqlabs/base";
-import { SolanaTx } from "./chain/modules/SolanaTransactions";
+import { SignedSolanaTx, SolanaTx } from "./chain/modules/SolanaTransactions";
 import { SolanaPreFetchData, SolanaPreFetchVerification } from "./swaps/modules/SwapInit";
 import { SolanaSigner } from "./wallet/SolanaSigner";
 import { SolanaSwapProgram } from "./swaps/SolanaSwapProgram";
@@ -8,4 +8,8 @@ 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>;
+/**
+ * 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/dist/solana/SolanaChains.d.ts

@@ -1,20 +1,9 @@
+import { BitcoinNetwork } from "@atomiqlabs/base";
 export declare const SolanaChains: {
-    readonly 2: {
-        readonly addresses: {
-            readonly swapContract: "11111111111111111111111111111111";
-            readonly btcRelayContract: "11111111111111111111111111111111";
-        };
-    };
-    readonly 1: {
-        readonly addresses: {
-            readonly swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM";
-            readonly btcRelayContract: "3KHSHFpEK6bsjg3bqcxQ9qssJYtRCMi2S9TYVe4q6CQc";
-        };
-    };
-    readonly 0: {
-        readonly addresses: {
-            readonly swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM";
-            readonly btcRelayContract: "3KHSHFpEK6bsjg3bqcxQ9qssJYtRCMi2S9TYVe4q6CQc";
+    [key in BitcoinNetwork]?: {
+        addresses: {
+            swapContract: string;
+            btcRelayContract: string;
         };
     };
 };

package/dist/solana/SolanaChains.js

@@ -4,12 +4,12 @@ exports.SolanaChains = void 0;
 const base_1 = require("@atomiqlabs/base");
 exports.SolanaChains = {
     //TODO: Not deployed yet
-    [base_1.BitcoinNetwork.TESTNET4]: {
-        addresses: {
-            swapContract: "11111111111111111111111111111111",
-            btcRelayContract: "11111111111111111111111111111111"
-        }
-    },
+    // [BitcoinNetwork.TESTNET4]: {
+    //     addresses: {
+    //         swapContract: "11111111111111111111111111111111",
+    //         btcRelayContract: "11111111111111111111111111111111"
+    //     }
+    // },
     [base_1.BitcoinNetwork.TESTNET]: {
         addresses: {
             swapContract: "4hfUykhqmD7ZRvNh1HuzVKEY7ToENixtdUKZspNDCrEM",

package/dist/solana/SolanaInitializer.d.ts

@@ -4,7 +4,15 @@ import { StoredDataAccount } from "./swaps/modules/SolanaDataAccount";
 import { SolanaRetryPolicy } from "./chain/SolanaChainInterface";
 import { SolanaFees } from "./chain/modules/SolanaFees";
 import { SolanaChainType } from "./SolanaChainType";
+/**
+ * Token assets available on Solana
+ * @category Chain Interface
+ */
 export type SolanaAssetsType = BaseTokenType<"WBTC" | "USDC" | "USDT" | "SOL" | "BONK">;
+/**
+ * Configuration options for initializing Solana chain
+ * @category Chain Interface
+ */
 export type SolanaSwapperOptions = {
     rpcUrl: string | Connection;
     dataAccountStorage?: IStorageManager<StoredDataAccount>;
@@ -13,6 +21,18 @@ export type SolanaSwapperOptions = {
     swapContract?: string;
     fees?: SolanaFees;
 };
+/**
+ * Initialize Solana chain integration
+ * @category Chain Interface
+ */
 export declare function initializeSolana(options: SolanaSwapperOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork, storageCtor: <T extends StorageObject>(name: string) => IStorageManager<T>): ChainData<SolanaChainType>;
+/**
+ * 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 declare const SolanaInitializer: SolanaInitializerType;

package/dist/solana/SolanaInitializer.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SolanaInitializer = exports.initializeSolana = void 0;
+const base_1 = require("@atomiqlabs/base");
 const web3_js_1 = require("@solana/web3.js");
 const SolanaChainInterface_1 = require("./chain/SolanaChainInterface");
 const SolanaFees_1 = require("./chain/modules/SolanaFees");
@@ -32,14 +33,21 @@ const SolanaAssets = {
         decimals: 5
     }
 };
+/**
+ * Initialize Solana chain integration
+ * @category Chain Interface
+ */
 function initializeSolana(options, bitcoinRpc, network, storageCtor) {
     const connection = typeof (options.rpcUrl) === "string" ?
         new web3_js_1.Connection(options.rpcUrl) :
         options.rpcUrl;
+    const solanaChainData = SolanaChains_1.SolanaChains[network];
+    if (solanaChainData == null)
+        throw new Error(`Unsupported bitcoin network for Solana: ${base_1.BitcoinNetwork[network]}`);
     const Fees = options.fees ?? new SolanaFees_1.SolanaFees(connection, 200000, 4, 100);
     const chainInterface = new SolanaChainInterface_1.SolanaChainInterface(connection, options.retryPolicy ?? { transactionResendInterval: 1000 }, Fees);
-    const btcRelay = new SolanaBtcRelay_1.SolanaBtcRelay(chainInterface, bitcoinRpc, options.btcRelayContract ?? SolanaChains_1.SolanaChains[network].addresses.btcRelayContract);
-    const swapContract = new SolanaSwapProgram_1.SolanaSwapProgram(chainInterface, btcRelay, options.dataAccountStorage || storageCtor("solAccounts"), options.swapContract ?? SolanaChains_1.SolanaChains[network].addresses.swapContract);
+    const btcRelay = new SolanaBtcRelay_1.SolanaBtcRelay(chainInterface, bitcoinRpc, options.btcRelayContract ?? solanaChainData.addresses.btcRelayContract);
+    const swapContract = new SolanaSwapProgram_1.SolanaSwapProgram(chainInterface, btcRelay, options.dataAccountStorage || storageCtor("solAccounts"), options.swapContract ?? solanaChainData.addresses.swapContract);
     const chainEvents = new SolanaChainEventsBrowser_1.SolanaChainEventsBrowser(connection, swapContract);
     return {
         chainId,
@@ -54,6 +62,10 @@ function initializeSolana(options, bitcoinRpc, network, storageCtor) {
     };
 }
 exports.initializeSolana = initializeSolana;
+/**
+ * Solana chain initializer instance
+ * @category Chain Interface
+ */
 exports.SolanaInitializer = {
     chainId,
     chainType: null,

package/dist/solana/btcrelay/SolanaBtcRelay.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { PublicKey, Signer, Transaction } from "@solana/web3.js";
 import { SolanaBtcStoredHeader } from "./headers/SolanaBtcStoredHeader";
 import { BitcoinRpc, BtcBlock, BtcRelay } from "@atomiqlabs/base";
@@ -7,6 +8,9 @@ import { SolanaAction } from "../chain/SolanaAction";
 import { Buffer } from "buffer";
 import { SolanaSigner } from "../wallet/SolanaSigner";
 import { SolanaChainInterface } from "../chain/SolanaChainInterface";
+/**
+ * @category BTC Relay
+ */
 export declare class SolanaBtcRelay<B extends BtcBlock> extends SolanaProgramBase<any> implements BtcRelay<SolanaBtcStoredHeader, {
     tx: Transaction;
     signers: Signer[];
@@ -18,7 +22,6 @@ export declare class SolanaBtcRelay<B extends BtcBlock> extends SolanaProgramBas
      * @param header
      * @param epochStart
      * @param pastBlocksTimestamps
-     * @constructor
      * @private
      */
     private Initialize;
@@ -66,7 +69,6 @@ export declare class SolanaBtcRelay<B extends BtcBlock> extends SolanaProgramBas
      * @param signer
      * @param headers headers to sync to the btc relay
      * @param storedHeader current latest stored block header for a given fork
-     * @param tipWork work of the current tip in a given fork
      * @param forkId forkId to submit to, forkId=0 means main chain
      * @param feeRate feeRate for the transaction
      * @param createTx transaction generator function
@@ -74,20 +76,16 @@ export declare class SolanaBtcRelay<B extends BtcBlock> extends SolanaProgramBas
      */
     private _saveHeaders;
     /**
-     * Returns data about current main chain tip stored in the btc relay
+     * @inheritDoc
      */
     getTipData(): Promise<{
         commitHash: string;
         blockhash: string;
         chainWork: Buffer;
         blockheight: number;
-    }>;
+    } | null>;
     /**
-     * Retrieves blockheader with a specific blockhash, returns null if requiredBlockheight is provided and
-     *  btc relay contract is not synced up to the desired blockheight
-     *
-     * @param blockData
-     * @param requiredBlockheight
+     * @inheritDoc
      */
     retrieveLogAndBlockheight(blockData: {
         blockhash: string;
@@ -96,133 +94,91 @@ export declare class SolanaBtcRelay<B extends BtcBlock> extends SolanaProgramBas
         height: number;
     } | null>;
     /**
-     * Retrieves blockheader data by blockheader's commit hash,
-     *
-     * @param commitmentHashStr
-     * @param blockData
+     * @inheritDoc
      */
     retrieveLogByCommitHash(commitmentHashStr: string, blockData: {
         blockhash: string;
-    }): Promise<SolanaBtcStoredHeader>;
+    }): Promise<SolanaBtcStoredHeader | null>;
     /**
-     * Retrieves latest known stored blockheader & blockheader from bitcoin RPC that is in the main chain
+     * @inheritDoc
      */
     retrieveLatestKnownBlockLog(): Promise<{
         resultStoredHeader: SolanaBtcStoredHeader;
         resultBitcoinHeader: B;
-    }>;
+    } | null>;
     /**
-     * Saves initial block header when the btc relay is in uninitialized state
-     *
-     * @param signer
-     * @param header a bitcoin blockheader to submit
-     * @param epochStart timestamp of the start of the epoch (block timestamp at blockheight-(blockheight%2016))
-     * @param pastBlocksTimestamps timestamp of the past 10 blocks
-     * @param feeRate fee rate to use for the transaction
+     * @inheritDoc
      */
     saveInitialHeader(signer: string, header: B, epochStart: number, pastBlocksTimestamps: number[], feeRate?: string): Promise<{
         tx: Transaction;
         signers: Signer[];
     }>;
     /**
-     * Saves blockheaders as a bitcoin main chain to the btc relay
-     *
-     * @param signer
-     * @param mainHeaders
-     * @param storedHeader
-     * @param feeRate
+     * @inheritDoc
      */
     saveMainHeaders(signer: string, mainHeaders: BtcBlock[], storedHeader: SolanaBtcStoredHeader, feeRate?: string): Promise<{
         forkId: number;
         lastStoredHeader: SolanaBtcStoredHeader;
         tx: {
             tx: Transaction;
-            signers: any[];
+            signers: never[];
         };
         computedCommitedHeaders: SolanaBtcStoredHeader[];
     }>;
     /**
-     * Creates a new long fork and submits the headers to it
-     *
-     * @param signer
-     * @param forkHeaders
-     * @param storedHeader
-     * @param tipWork
-     * @param feeRate
+     * @inheritDoc
      */
     saveNewForkHeaders(signer: string, forkHeaders: BtcBlock[], storedHeader: SolanaBtcStoredHeader, tipWork: Buffer, feeRate?: string): Promise<{
         forkId: number;
         lastStoredHeader: SolanaBtcStoredHeader;
         tx: {
             tx: Transaction;
-            signers: any[];
+            signers: never[];
         };
         computedCommitedHeaders: SolanaBtcStoredHeader[];
     }>;
     /**
-     * Continues submitting blockheaders to a given fork
-     *
-     * @param signer
-     * @param forkHeaders
-     * @param storedHeader
-     * @param forkId
-     * @param tipWork
-     * @param feeRate
+     * @inheritDoc
      */
     saveForkHeaders(signer: string, forkHeaders: BtcBlock[], storedHeader: SolanaBtcStoredHeader, forkId: number, tipWork: Buffer, feeRate?: string): Promise<{
         forkId: number;
         lastStoredHeader: SolanaBtcStoredHeader;
         tx: {
             tx: Transaction;
-            signers: any[];
+            signers: never[];
         };
         computedCommitedHeaders: SolanaBtcStoredHeader[];
     }>;
     /**
-     * Submits short fork with given blockheaders
-     *
-     * @param signer
-     * @param forkHeaders
-     * @param storedHeader
-     * @param tipWork
-     * @param feeRate
+     * @inheritDoc
      */
     saveShortForkHeaders(signer: string, forkHeaders: BtcBlock[], storedHeader: SolanaBtcStoredHeader, tipWork: Buffer, feeRate?: string): Promise<{
         forkId: number;
         lastStoredHeader: SolanaBtcStoredHeader;
         tx: {
             tx: Transaction;
-            signers: any[];
+            signers: never[];
         };
         computedCommitedHeaders: SolanaBtcStoredHeader[];
     }>;
     /**
-     * Sweeps fork data PDAs back to self
-     *
-     * @param signer
-     * @param lastSweepId lastCheckedId returned from the previous sweepForkData() call
-     * @returns {number} lastCheckedId that should be passed to the next call of sweepForkData()
+     * @inheritDoc
      */
     sweepForkData(signer: SolanaSigner, lastSweepId?: number): Promise<number | null>;
     /**
-     * Estimate required synchronization fee (worst case) to synchronize btc relay to the required blockheight
-     *
-     * @param requiredBlockheight
-     * @param feeRate
+     * @inheritDoc
      */
     estimateSynchronizeFee(requiredBlockheight: number, feeRate?: string): Promise<bigint>;
     /**
-     * Returns fee required (in SOL) to synchronize a single block to btc relay
-     *
-     * @param feeRate
+     * @inheritDoc
      */
     getFeePerBlock(feeRate?: string): Promise<bigint>;
     /**
-     * Gets fee rate required for submitting blockheaders to the main chain
+     * @inheritDoc
      */
     getMainFeeRate(signer: string | null): Promise<string>;
     /**
-     * Gets fee rate required for submitting blockheaders to the specific fork
+     * @inheritDoc
      */
     getForkFeeRate(signer: string, forkId: number): Promise<string>;
 }