@atomiqlabs/chain-starknet 3.0.0-dev.8 → 4.0.0-dev.3

package/package.json

@@ -1,37 +1,37 @@
-{
-  "name": "@atomiqlabs/chain-starknet",
-  "version": "3.0.0-dev.8",
-  "description": "Starknet 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": [
-    "Starknet",
-    "Bitcoin",
-    "Cross-chain",
-    "Cryptocurrency",
-    "Bridge",
-    "Trustless"
-  ],
-  "author": "adambor",
-  "license": "ISC",
-  "dependencies": {
-    "@atomiqlabs/base": "^9.0.0",
-    "@noble/hashes": "^1.7.1",
-    "@scure/btc-signer": "1.6.0",
-    "abi-wan-kanabi": "2.2.4",
-    "buffer": "6.0.3"
-  },
-  "peerDependencies": {
-    "starknet": "^7.5.0"
-  },
-  "devDependencies": {
-    "typescript": "4.9.5"
-  }
-}
+{
+  "name": "@atomiqlabs/chain-starknet",
+  "version": "4.0.0-dev.3",
+  "description": "Starknet 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": [
+    "Starknet",
+    "Bitcoin",
+    "Cross-chain",
+    "Cryptocurrency",
+    "Bridge",
+    "Trustless"
+  ],
+  "author": "adambor",
+  "license": "ISC",
+  "dependencies": {
+    "@atomiqlabs/base": "^10.0.0-dev.2",
+    "@noble/hashes": "^1.7.1",
+    "@scure/btc-signer": "1.6.0",
+    "abi-wan-kanabi": "2.2.4",
+    "buffer": "6.0.3"
+  },
+  "peerDependencies": {
+    "starknet": "^7.5.0"
+  },
+  "devDependencies": {
+    "typescript": "4.9.5"
+  }
+}

package/src/index.ts

@@ -1,47 +1,47 @@
-export * from "./starknet/chain/StarknetAction";
-export * from "./starknet/chain/StarknetChainInterface";
-export * from "./starknet/chain/StarknetModule";
-
-export * from "./starknet/chain/modules/StarknetFees";
-export * from "./starknet/chain/modules/StarknetEvents";
-export * from "./starknet/chain/modules/StarknetTokens";
-export * from "./starknet/chain/modules/StarknetAddresses";
-export * from "./starknet/chain/modules/StarknetTransactions";
-export * from "./starknet/chain/modules/StarknetSignatures";
-
-export * from "./starknet/btcrelay/headers/StarknetBtcStoredHeader";
-export * from "./starknet/btcrelay/headers/StarknetBtcHeader";
-export * from "./starknet/btcrelay/StarknetBtcRelay";
-
-export * from "./starknet/contract/modules/StarknetContractEvents";
-export * from "./starknet/contract/StarknetContractBase";
-
-export * from "./starknet/swaps/StarknetSwapContract";
-export * from "./starknet/swaps/StarknetSwapData";
-export * from "./starknet/swaps/StarknetSwapModule";
-export * from "./starknet/swaps/modules/StarknetLpVault";
-export * from "./starknet/swaps/modules/StarknetSwapClaim";
-export * from "./starknet/swaps/modules/StarknetSwapInit";
-export * from "./starknet/swaps/modules/StarknetSwapRefund";
-export * from "./starknet/swaps/handlers/IHandler";
-export * from "./starknet/swaps/handlers/refund/TimelockRefundHandler";
-export * from "./starknet/swaps/handlers/claim/ClaimHandlers";
-export * from "./starknet/swaps/handlers/claim/HashlockClaimHandler";
-export * from "./starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler";
-export * from "./starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler";
-export * from "./starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler";
-export * from "./starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler";
-
-export * from "./starknet/events/StarknetChainEventsBrowser";
-
-export * from "./starknet/wallet/StarknetSigner";
-export * from "./starknet/wallet/StarknetKeypairWallet";
-
-export * from "./starknet/StarknetChainType";
-export * from "./starknet/StarknetInitializer";
-
-export * from "./starknet/spv_swap/StarknetSpvVaultContract";
-export * from "./starknet/spv_swap/StarknetSpvVaultData";
-export * from "./starknet/spv_swap/StarknetSpvWithdrawalData";
-
-export * from "./starknet/provider/RpcProviderWithRetries";
+export * from "./starknet/chain/StarknetAction";
+export * from "./starknet/chain/StarknetChainInterface";
+export * from "./starknet/chain/StarknetModule";
+
+export * from "./starknet/chain/modules/StarknetFees";
+export * from "./starknet/chain/modules/StarknetEvents";
+export * from "./starknet/chain/modules/StarknetTokens";
+export * from "./starknet/chain/modules/StarknetAddresses";
+export * from "./starknet/chain/modules/StarknetTransactions";
+export * from "./starknet/chain/modules/StarknetSignatures";
+
+export * from "./starknet/btcrelay/headers/StarknetBtcStoredHeader";
+export * from "./starknet/btcrelay/headers/StarknetBtcHeader";
+export * from "./starknet/btcrelay/StarknetBtcRelay";
+
+export * from "./starknet/contract/modules/StarknetContractEvents";
+export * from "./starknet/contract/StarknetContractBase";
+
+export * from "./starknet/swaps/StarknetSwapContract";
+export * from "./starknet/swaps/StarknetSwapData";
+export * from "./starknet/swaps/StarknetSwapModule";
+export * from "./starknet/swaps/modules/StarknetLpVault";
+export * from "./starknet/swaps/modules/StarknetSwapClaim";
+export * from "./starknet/swaps/modules/StarknetSwapInit";
+export * from "./starknet/swaps/modules/StarknetSwapRefund";
+export * from "./starknet/swaps/handlers/IHandler";
+export * from "./starknet/swaps/handlers/refund/TimelockRefundHandler";
+export * from "./starknet/swaps/handlers/claim/ClaimHandlers";
+export * from "./starknet/swaps/handlers/claim/HashlockClaimHandler";
+export * from "./starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler";
+export * from "./starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler";
+export * from "./starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler";
+export * from "./starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler";
+
+export * from "./starknet/events/StarknetChainEventsBrowser";
+
+export * from "./starknet/wallet/StarknetSigner";
+export * from "./starknet/wallet/StarknetKeypairWallet";
+
+export * from "./starknet/StarknetChainType";
+export * from "./starknet/StarknetInitializer";
+
+export * from "./starknet/spv_swap/StarknetSpvVaultContract";
+export * from "./starknet/spv_swap/StarknetSpvVaultData";
+export * from "./starknet/spv_swap/StarknetSpvWithdrawalData";
+
+export * from "./starknet/provider/RpcProviderWithRetries";

package/src/starknet/StarknetChainType.ts

@@ -1,28 +1,28 @@
-import {ChainType} from "@atomiqlabs/base";
-import {StarknetTx} from "./chain/modules/StarknetTransactions";
-import {StarknetSigner} from "./wallet/StarknetSigner";
-import {StarknetSwapData} from "./swaps/StarknetSwapData";
-import {StarknetSwapContract} from "./swaps/StarknetSwapContract";
-import {StarknetChainEventsBrowser} from "./events/StarknetChainEventsBrowser";
-import {StarknetBtcRelay} from "./btcrelay/StarknetBtcRelay";
-import {StarknetPreFetchVerification} from "./swaps/modules/StarknetSwapInit";
-import {StarknetChainInterface} from "./chain/StarknetChainInterface";
-import {StarknetSpvVaultData} from "./spv_swap/StarknetSpvVaultData";
-import {StarknetSpvWithdrawalData} from "./spv_swap/StarknetSpvWithdrawalData";
-import {StarknetSpvVaultContract} from "./spv_swap/StarknetSpvVaultContract";
-
-export type StarknetChainType = ChainType<
-    "STARKNET",
-    never,
-    StarknetPreFetchVerification,
-    StarknetTx,
-    StarknetSigner,
-    StarknetSwapData,
-    StarknetSwapContract,
-    StarknetChainInterface,
-    StarknetChainEventsBrowser,
-    StarknetBtcRelay<any>,
-    StarknetSpvVaultData,
-    StarknetSpvWithdrawalData,
-    StarknetSpvVaultContract
->;
+import {ChainType} from "@atomiqlabs/base";
+import {StarknetTx} from "./chain/modules/StarknetTransactions";
+import {StarknetSigner} from "./wallet/StarknetSigner";
+import {StarknetSwapData} from "./swaps/StarknetSwapData";
+import {StarknetSwapContract} from "./swaps/StarknetSwapContract";
+import {StarknetChainEventsBrowser} from "./events/StarknetChainEventsBrowser";
+import {StarknetBtcRelay} from "./btcrelay/StarknetBtcRelay";
+import {StarknetPreFetchVerification} from "./swaps/modules/StarknetSwapInit";
+import {StarknetChainInterface} from "./chain/StarknetChainInterface";
+import {StarknetSpvVaultData} from "./spv_swap/StarknetSpvVaultData";
+import {StarknetSpvWithdrawalData} from "./spv_swap/StarknetSpvWithdrawalData";
+import {StarknetSpvVaultContract} from "./spv_swap/StarknetSpvVaultContract";
+
+export type StarknetChainType = ChainType<
+    "STARKNET",
+    never,
+    StarknetPreFetchVerification,
+    StarknetTx,
+    StarknetSigner,
+    StarknetSwapData,
+    StarknetSwapContract,
+    StarknetChainInterface,
+    StarknetChainEventsBrowser,
+    StarknetBtcRelay<any>,
+    StarknetSpvVaultData,
+    StarknetSpvWithdrawalData,
+    StarknetSpvVaultContract
+>;

package/src/starknet/StarknetInitializer.ts

@@ -1,100 +1,108 @@
-import {constants, Provider} from "starknet";
-import {StarknetFees} from "./chain/modules/StarknetFees";
-import {StarknetChainInterface, StarknetRetryPolicy} from "./chain/StarknetChainInterface";
-import {StarknetBtcRelay} from "./btcrelay/StarknetBtcRelay";
-import {StarknetSwapContract} from "./swaps/StarknetSwapContract";
-import {StarknetChainEventsBrowser} from "./events/StarknetChainEventsBrowser";
-import {BaseTokenType, BitcoinNetwork, BitcoinRpc, ChainData, ChainInitializer} from "@atomiqlabs/base";
-import {StarknetChainType} from "./StarknetChainType";
-import {StarknetSwapData} from "./swaps/StarknetSwapData";
-import {StarknetSpvVaultContract} from "./spv_swap/StarknetSpvVaultContract";
-import {StarknetSpvVaultData} from "./spv_swap/StarknetSpvVaultData";
-import {StarknetSpvWithdrawalData} from "./spv_swap/StarknetSpvWithdrawalData";
-import {RpcProviderWithRetries} from "./provider/RpcProviderWithRetries";
-
-export type StarknetAssetsType = BaseTokenType<"ETH" | "STRK" | "WBTC" | "TBTC">;
-export const StarknetAssets: StarknetAssetsType = {
-    ETH: {
-        address: "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
-        decimals: 18,
-        displayDecimals: 9
-    },
-    STRK: {
-        address: "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d",
-        decimals: 18,
-        displayDecimals: 9
-    },
-    WBTC: {
-        address: "0x03fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac",
-        decimals: 8
-    },
-    TBTC: {
-        address: "0x04daa17763b286d1e59b97c283C0b8C949994C361e426A28F743c67bDfE9a32f",
-        decimals: 18,
-        displayDecimals: 8
-    }
-} as const;
-
-export type StarknetOptions = {
-    rpcUrl: string | Provider,
-    retryPolicy?: StarknetRetryPolicy,
-    chainId?: constants.StarknetChainId,
-
-    swapContract?: string,
-    btcRelayContract?: string,
-    spvVaultContract?: string,
-
-    fees?: StarknetFees
-}
-
-export function initializeStarknet(
-    options: StarknetOptions,
-    bitcoinRpc: BitcoinRpc<any>,
-    network: BitcoinNetwork
-): ChainData<StarknetChainType> {
-    const provider = typeof(options.rpcUrl)==="string" ?
-        new RpcProviderWithRetries({nodeUrl: options.rpcUrl}) :
-        options.rpcUrl;
-
-    const Fees = options.fees ?? new StarknetFees(provider);
-
-    const chainId = options.chainId ??
-        (network===BitcoinNetwork.MAINNET ? constants.StarknetChainId.SN_MAIN : constants.StarknetChainId.SN_SEPOLIA);
-
-    const chainInterface = new StarknetChainInterface(chainId, provider, options.retryPolicy, Fees);
-
-    const btcRelay = new StarknetBtcRelay(
-        chainInterface, bitcoinRpc, network, options.btcRelayContract
-    );
-
-    const swapContract = new StarknetSwapContract(
-        chainInterface, btcRelay, options.swapContract
-    );
-
-    const spvVaultContract = new StarknetSpvVaultContract(
-        chainInterface, btcRelay, bitcoinRpc, options.spvVaultContract
-    )
-
-    const chainEvents = new StarknetChainEventsBrowser(chainInterface, swapContract, spvVaultContract);
-
-    return {
-        chainId: "STARKNET",
-        btcRelay,
-        chainInterface,
-        swapContract,
-        chainEvents,
-        swapDataConstructor: StarknetSwapData,
-        spvVaultContract,
-        spvVaultDataConstructor: StarknetSpvVaultData,
-        spvVaultWithdrawalDataConstructor: StarknetSpvWithdrawalData
-    }
-};
-
-export type StarknetInitializerType = ChainInitializer<StarknetOptions, StarknetChainType, StarknetAssetsType>;
-export const StarknetInitializer: StarknetInitializerType = {
-    chainId: "STARKNET",
-    chainType: null as StarknetChainType,
-    initializer: initializeStarknet,
-    tokens: StarknetAssets,
-    options: null as StarknetOptions
-} as const;
+import {constants, Provider} from "starknet";
+import {StarknetFees} from "./chain/modules/StarknetFees";
+import {StarknetChainInterface, StarknetRetryPolicy} from "./chain/StarknetChainInterface";
+import {StarknetBtcRelay} from "./btcrelay/StarknetBtcRelay";
+import {StarknetSwapContract} from "./swaps/StarknetSwapContract";
+import {StarknetChainEventsBrowser} from "./events/StarknetChainEventsBrowser";
+import {BaseTokenType, BitcoinNetwork, BitcoinRpc, ChainData, ChainInitializer, ChainSwapType} from "@atomiqlabs/base";
+import {StarknetChainType} from "./StarknetChainType";
+import {StarknetSwapData} from "./swaps/StarknetSwapData";
+import {StarknetSpvVaultContract} from "./spv_swap/StarknetSpvVaultContract";
+import {StarknetSpvVaultData} from "./spv_swap/StarknetSpvVaultData";
+import {StarknetSpvWithdrawalData} from "./spv_swap/StarknetSpvWithdrawalData";
+import {RpcProviderWithRetries} from "./provider/RpcProviderWithRetries";
+
+export type StarknetAssetsType = BaseTokenType<"ETH" | "STRK" | "WBTC">;
+export const StarknetAssets: StarknetAssetsType = {
+    ETH: {
+        address: "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
+        decimals: 18,
+        displayDecimals: 9
+    },
+    STRK: {
+        address: "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d",
+        decimals: 18,
+        displayDecimals: 9
+    },
+    WBTC: {
+        address: "0x03fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac",
+        decimals: 8
+    },
+    // TBTC: {
+    //     address: "0x04daa17763b286d1e59b97c283C0b8C949994C361e426A28F743c67bDfE9a32f",
+    //     decimals: 18,
+    //     displayDecimals: 8
+    // }
+} as const;
+
+export type StarknetOptions = {
+    rpcUrl: string | Provider,
+    retryPolicy?: StarknetRetryPolicy,
+    chainId?: constants.StarknetChainId,
+
+    swapContract?: string,
+    btcRelayContract?: string,
+    spvVaultContract?: string,
+    handlerContracts?: {
+        refund?: {
+            timelock?: string
+        },
+        claim?: {
+            [type in ChainSwapType]?: string
+        }
+    }
+
+    fees?: StarknetFees
+}
+
+export function initializeStarknet(
+    options: StarknetOptions,
+    bitcoinRpc: BitcoinRpc<any>,
+    network: BitcoinNetwork
+): ChainData<StarknetChainType> {
+    const provider = typeof(options.rpcUrl)==="string" ?
+        new RpcProviderWithRetries({nodeUrl: options.rpcUrl}) :
+        options.rpcUrl;
+
+    const Fees = options.fees ?? new StarknetFees(provider);
+
+    const chainId = options.chainId ??
+        (network===BitcoinNetwork.MAINNET ? constants.StarknetChainId.SN_MAIN : constants.StarknetChainId.SN_SEPOLIA);
+
+    const chainInterface = new StarknetChainInterface(chainId, provider, options.retryPolicy, Fees);
+
+    const btcRelay = new StarknetBtcRelay(
+        chainInterface, bitcoinRpc, network, options.btcRelayContract
+    );
+
+    const swapContract = new StarknetSwapContract(
+        chainInterface, btcRelay, options.swapContract, options.handlerContracts
+    );
+
+    const spvVaultContract = new StarknetSpvVaultContract(
+        chainInterface, btcRelay, bitcoinRpc, options.spvVaultContract
+    )
+
+    const chainEvents = new StarknetChainEventsBrowser(chainInterface, swapContract, spvVaultContract);
+
+    return {
+        chainId: "STARKNET",
+        btcRelay,
+        chainInterface,
+        swapContract,
+        chainEvents,
+        swapDataConstructor: StarknetSwapData,
+        spvVaultContract,
+        spvVaultDataConstructor: StarknetSpvVaultData,
+        spvVaultWithdrawalDataConstructor: StarknetSpvWithdrawalData
+    }
+};
+
+export type StarknetInitializerType = ChainInitializer<StarknetOptions, StarknetChainType, StarknetAssetsType>;
+export const StarknetInitializer: StarknetInitializerType = {
+    chainId: "STARKNET",
+    chainType: null as StarknetChainType,
+    initializer: initializeStarknet,
+    tokens: StarknetAssets,
+    options: null as StarknetOptions
+} as const;