@atomiqlabs/chain-starknet 8.2.3 → 8.4.0

package/dist/starknet/StarknetInitializer.js

@@ -69,7 +69,7 @@ function initializeStarknet(options, bitcoinRpc, network) {
     const Fees = options.fees ?? new StarknetFees_1.StarknetFees(provider);
     const chainId = options.chainId ??
         (network === base_1.BitcoinNetwork.MAINNET ? starknet_1.constants.StarknetChainId.SN_MAIN : starknet_1.constants.StarknetChainId.SN_SEPOLIA);
-    const chainInterface = new StarknetChainInterface_1.StarknetChainInterface(chainId, provider, wsChannel, Fees, options.starknetConfig);
+    const chainInterface = new StarknetChainInterface_1.StarknetChainInterface(chainId, provider, wsChannel, Fees, options.starknetConfig, network);
     const btcRelay = new StarknetBtcRelay_1.StarknetBtcRelay(chainInterface, bitcoinRpc, network, options.btcRelayContract, options.btcRelayContractDeploymentHeight);
     const swapContract = new StarknetSwapContract_1.StarknetSwapContract(chainInterface, btcRelay, options.swapContract, options.handlerContracts, options.swapContractDeploymentHeight);
     const spvVaultContract = new StarknetSpvVaultContract_1.StarknetSpvVaultContract(chainInterface, btcRelay, bitcoinRpc, options.spvVaultContract, options.spvVaultContractDeploymentHeight);

package/dist/starknet/chain/StarknetChainInterface.d.ts

@@ -6,7 +6,7 @@ import { StarknetEvents } from "./modules/StarknetEvents";
 import { StarknetSignatures } from "./modules/StarknetSignatures";
 import { StarknetAccounts } from "./modules/StarknetAccounts";
 import { StarknetBlocks } from "./modules/StarknetBlocks";
-import { ChainInterface, TransactionConfirmationOptions } from "@atomiqlabs/base";
+import { BitcoinNetwork, ChainInterface, TransactionConfirmationOptions } from "@atomiqlabs/base";
 import { StarknetSigner } from "../wallet/StarknetSigner";
 /**
  * Configuration options for Starknet chain interface
@@ -64,7 +64,8 @@ export declare class StarknetChainInterface implements ChainInterface<StarknetTx
     readonly Accounts: StarknetAccounts;
     readonly Blocks: StarknetBlocks;
     readonly config: StarknetConfig;
-    constructor(chainId: constants.StarknetChainId, provider: Provider, wsChannel?: WebSocketChannel, feeEstimator?: StarknetFees, options?: StarknetConfig);
+    private readonly bitcoinNetwork?;
+    constructor(chainId: constants.StarknetChainId, provider: Provider, wsChannel?: WebSocketChannel, feeEstimator?: StarknetFees, options?: StarknetConfig, bitcoinNetwork?: BitcoinNetwork);
     /**
      * @inheritDoc
      */
@@ -164,4 +165,5 @@ export declare class StarknetChainInterface implements ChainInterface<StarknetTx
      * @inheritDoc
      */
     wrapSigner(signer: Account): Promise<StarknetSigner>;
+    verifyNetwork(bitcoinNetwork: BitcoinNetwork): Promise<void>;
 }

package/dist/starknet/chain/StarknetChainInterface.js

@@ -11,6 +11,7 @@ const StarknetEvents_1 = require("./modules/StarknetEvents");
 const StarknetSignatures_1 = require("./modules/StarknetSignatures");
 const StarknetAccounts_1 = require("./modules/StarknetAccounts");
 const StarknetBlocks_1 = require("./modules/StarknetBlocks");
+const base_1 = require("@atomiqlabs/base");
 const StarknetSigner_1 = require("../wallet/StarknetSigner");
 const buffer_1 = require("buffer");
 const StarknetKeypairWallet_1 = require("../wallet/accounts/StarknetKeypairWallet");
@@ -21,7 +22,7 @@ const StarknetBrowserSigner_1 = require("../wallet/StarknetBrowserSigner");
  * @category Chain Interface
  */
 class StarknetChainInterface {
-    constructor(chainId, provider, wsChannel, feeEstimator = new StarknetFees_1.StarknetFees(provider), options) {
+    constructor(chainId, provider, wsChannel, feeEstimator = new StarknetFees_1.StarknetFees(provider), options, bitcoinNetwork) {
         var _a, _b, _c, _d;
         this.chainId = "STARKNET";
         this.starknetChainId = chainId;
@@ -39,6 +40,7 @@ class StarknetChainInterface {
         this.Events = new StarknetEvents_1.StarknetEvents(this);
         this.Accounts = new StarknetAccounts_1.StarknetAccounts(this);
         this.Blocks = new StarknetBlocks_1.StarknetBlocks(this);
+        this.bitcoinNetwork = bitcoinNetwork;
     }
     /**
      * @inheritDoc
@@ -201,5 +203,16 @@ class StarknetChainInterface {
             return Promise.resolve(new StarknetSigner_1.StarknetSigner(signer));
         }
     }
+    async verifyNetwork(bitcoinNetwork) {
+        if (this.bitcoinNetwork != null && bitcoinNetwork !== this.bitcoinNetwork)
+            throw new Error(`Network mismatch, the chain interface was not setup for ${base_1.BitcoinNetwork[bitcoinNetwork]}, chain interface network: ${base_1.BitcoinNetwork[this.bitcoinNetwork]}`);
+        const chainId = await this.provider.getChainId();
+        if (chainId !== starknet_1.constants.StarknetChainId.SN_MAIN && chainId !== starknet_1.constants.StarknetChainId.SN_SEPOLIA) {
+            starknet_1.logger.warn(`verifyNetwork(): Using non-standard chainId ${chainId}, skipping network verfication!`);
+            return;
+        }
+        if (this.starknetChainId !== chainId)
+            throw new Error(`Network mismatch, the underlying RPC provider isn't using the correct chainId, expected: ${this.starknetChainId}, provider returned: ${chainId}`);
+    }
 }
 exports.StarknetChainInterface = StarknetChainInterface;

package/dist/starknet/chain/modules/StarknetTransactions.d.ts

@@ -52,7 +52,7 @@ export type StarknetTx = StarknetTxInvoke | StarknetTxDeployAccount;
  * Represents a signed Starknet transactions, which can either be an "INVOKE" or "DEPLOY_ACCOUNT" type, use the
  *  {@link isStarknetTxInvoke} & {@link isStarknetTxDeployAccount} to narrow down the type.
  *
- * @remark For Starknet this is just an alias for {@link StarknetTx}
+ * @remarks For Starknet this is just an alias for {@link StarknetTx}
  *
  * @category Chain Interface
  */

package/dist/starknet/swaps/StarknetSwapData.d.ts

@@ -231,4 +231,8 @@ export declare class StarknetSwapData extends SwapData {
      * @inheritDoc
      */
     hasSuccessAction(): boolean;
+    /**
+     * @inheritDoc
+     */
+    getEscrowStruct(): any;
 }

package/dist/starknet/swaps/StarknetSwapData.js

@@ -469,6 +469,12 @@ class StarknetSwapData extends base_1.SwapData {
     hasSuccessAction() {
         return this.successAction != null;
     }
+    /**
+     * @inheritDoc
+     */
+    getEscrowStruct() {
+        return (0, Utils_1.replaceBigInts)(this.toEscrowStruct());
+    }
 }
 exports.StarknetSwapData = StarknetSwapData;
 base_1.SwapData.deserializers["strk"] = StarknetSwapData;

package/dist/utils/Utils.d.ts

@@ -74,4 +74,5 @@ export declare function serializeResourceBounds(resourceBounds: {
     };
 };
 export declare function deserializeResourceBounds(resourceBounds: ResourceBounds): ResourceBoundsBN;
+export declare function replaceBigInts<T>(obj: T): ReplaceBigInt<T>;
 export {};

package/dist/utils/Utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeResourceBounds = exports.serializeResourceBounds = exports.deserializeSignature = exports.serializeSignature = exports.bigIntMax = exports.findLastIndex = exports.poseidonHashRange = exports.bufferToByteArray = exports.bufferToBytes31Span = exports.bytes31SpanToBuffer = exports.toBigInt = exports.bigNumberishToBuffer = exports.u32ReverseEndianness = exports.bufferToU32Array = exports.u32ArrayToBuffer = exports.calculateHash = exports.toHex = exports.tryWithRetries = exports.getLogger = exports.onceAsync = exports.timeoutPromise = exports.isUint256 = void 0;
+exports.replaceBigInts = exports.deserializeResourceBounds = exports.serializeResourceBounds = exports.deserializeSignature = exports.serializeSignature = exports.bigIntMax = exports.findLastIndex = exports.poseidonHashRange = exports.bufferToByteArray = exports.bufferToBytes31Span = exports.bytes31SpanToBuffer = exports.toBigInt = exports.bigNumberishToBuffer = exports.u32ReverseEndianness = exports.bufferToU32Array = exports.u32ArrayToBuffer = exports.calculateHash = exports.toHex = exports.tryWithRetries = exports.getLogger = exports.onceAsync = exports.timeoutPromise = exports.isUint256 = void 0;
 const starknet_1 = require("starknet");
 const buffer_1 = require("buffer");
 function isUint256(val) {
@@ -302,3 +302,21 @@ function deserializeResourceBounds(resourceBounds) {
     };
 }
 exports.deserializeResourceBounds = deserializeResourceBounds;
+function replaceBigInts(obj) {
+    const replace = (value) => {
+        if (typeof (value) === "bigint")
+            return "0x" + value.toString(16);
+        if (value == null || typeof (value) !== "object")
+            return value;
+        if (Array.isArray(value)) {
+            return value.map(replace);
+        }
+        const mapped = {};
+        for (const key of Object.keys(value)) {
+            mapped[key] = replace(value[key]);
+        }
+        return mapped;
+    };
+    return replace(obj);
+}
+exports.replaceBigInts = replaceBigInts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/chain-starknet",
-  "version": "8.2.3",
+  "version": "8.4.0",
   "description": "Starknet specific base implementation",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -31,7 +31,7 @@
     "url": "git+https://github.com/atomiqlabs/atomiq-chain-starknet.git"
   },
   "dependencies": {
-    "@atomiqlabs/base": "^13.2.0",
+    "@atomiqlabs/base": "^13.4.0",
     "@noble/hashes": "^1.7.1",
     "@scure/btc-signer": "^1.6.0",
     "abi-wan-kanabi": "2.2.4",

package/src/starknet/StarknetInitializer.ts

@@ -152,7 +152,7 @@ export function initializeStarknet(
     const chainId = options.chainId ??
         (network===BitcoinNetwork.MAINNET ? constants.StarknetChainId.SN_MAIN : constants.StarknetChainId.SN_SEPOLIA);
 
-    const chainInterface = new StarknetChainInterface(chainId, provider, wsChannel, Fees, options.starknetConfig);
+    const chainInterface = new StarknetChainInterface(chainId, provider, wsChannel, Fees, options.starknetConfig, network);
 
     const btcRelay = new StarknetBtcRelay(
         chainInterface, bitcoinRpc, network, options.btcRelayContract, options.btcRelayContractDeploymentHeight

package/src/starknet/chain/StarknetChainInterface.ts

@@ -1,4 +1,4 @@
-import {Provider, constants, stark, ec, Account, provider, wallet, WebSocketChannel} from "starknet";
+import {Provider, constants, stark, ec, Account, provider, wallet, WebSocketChannel, logger} from "starknet";
 import {getLogger, toHex} from "../../utils/Utils";
 import {SignedStarknetTx, StarknetTransactions, StarknetTx} from "./modules/StarknetTransactions";
 import {StarknetFees} from "./modules/StarknetFees";
@@ -8,7 +8,7 @@ import {StarknetEvents} from "./modules/StarknetEvents";
 import {StarknetSignatures} from "./modules/StarknetSignatures";
 import {StarknetAccounts} from "./modules/StarknetAccounts";
 import {StarknetBlocks} from "./modules/StarknetBlocks";
-import {ChainInterface, TransactionConfirmationOptions} from "@atomiqlabs/base";
+import {BitcoinNetwork, ChainInterface, TransactionConfirmationOptions} from "@atomiqlabs/base";
 import {StarknetSigner} from "../wallet/StarknetSigner";
 import {Buffer} from "buffer";
 import {StarknetKeypairWallet} from "../wallet/accounts/StarknetKeypairWallet";
@@ -76,12 +76,15 @@ export class StarknetChainInterface implements ChainInterface<StarknetTx, Signed
 
     public readonly config: StarknetConfig;
 
+    private readonly bitcoinNetwork?: BitcoinNetwork;
+
     constructor(
         chainId: constants.StarknetChainId,
         provider: Provider,
         wsChannel?: WebSocketChannel,
         feeEstimator: StarknetFees = new StarknetFees(provider),
-        options?: StarknetConfig
+        options?: StarknetConfig,
+        bitcoinNetwork?: BitcoinNetwork
     ) {
         this.starknetChainId = chainId;
         this.provider = provider;
@@ -100,6 +103,8 @@ export class StarknetChainInterface implements ChainInterface<StarknetTx, Signed
         this.Events = new StarknetEvents(this);
         this.Accounts = new StarknetAccounts(this);
         this.Blocks = new StarknetBlocks(this);
+
+        this.bitcoinNetwork = bitcoinNetwork;
     }
 
     /**
@@ -305,4 +310,18 @@ export class StarknetChainInterface implements ChainInterface<StarknetTx, Signed
         }
     }
 
+    async verifyNetwork(bitcoinNetwork: BitcoinNetwork): Promise<void> {
+        if(this.bitcoinNetwork!=null && bitcoinNetwork!==this.bitcoinNetwork)
+            throw new Error(`Network mismatch, the chain interface was not setup for ${BitcoinNetwork[bitcoinNetwork]}, chain interface network: ${BitcoinNetwork[this.bitcoinNetwork]}`);
+
+        const chainId = await this.provider.getChainId();
+        if(chainId!==constants.StarknetChainId.SN_MAIN && chainId!==constants.StarknetChainId.SN_SEPOLIA) {
+            logger.warn(`verifyNetwork(): Using non-standard chainId ${chainId}, skipping network verfication!`);
+            return;
+        }
+
+        if(this.starknetChainId!==chainId)
+            throw new Error(`Network mismatch, the underlying RPC provider isn't using the correct chainId, expected: ${this.starknetChainId}, provider returned: ${chainId}`);
+    }
+
 }

package/src/starknet/chain/modules/StarknetTransactions.ts

@@ -97,7 +97,7 @@ export type StarknetTx = StarknetTxInvoke | StarknetTxDeployAccount;
  * Represents a signed Starknet transactions, which can either be an "INVOKE" or "DEPLOY_ACCOUNT" type, use the
  *  {@link isStarknetTxInvoke} & {@link isStarknetTxDeployAccount} to narrow down the type.
  *
- * @remark For Starknet this is just an alias for {@link StarknetTx}
+ * @remarks For Starknet this is just an alias for {@link StarknetTx}
  *
  * @category Chain Interface
  */

package/src/starknet/swaps/StarknetSwapData.ts

@@ -1,7 +1,7 @@
 import {SwapData, ChainSwapType} from "@atomiqlabs/base";
 import {TimelockRefundHandler} from "./handlers/refund/TimelockRefundHandler";
 import {BigNumberish, cairo, CairoOption, CairoOptionVariant, hash} from "starknet";
-import {Serialized, toBigInt, toHex} from "../../utils/Utils";
+import {replaceBigInts, Serialized, toBigInt, toHex} from "../../utils/Utils";
 import {
     StringToPrimitiveType
 } from "abi-wan-kanabi/dist/kanabi";
@@ -582,6 +582,13 @@ export class StarknetSwapData extends SwapData {
         return this.successAction != null;
     }
 
+    /**
+     * @inheritDoc
+     */
+    getEscrowStruct(): any {
+        return replaceBigInts(this.toEscrowStruct());
+    }
+
 }
 
 SwapData.deserializers["strk"] = StarknetSwapData;

package/src/utils/Utils.ts

@@ -341,3 +341,22 @@ export function deserializeResourceBounds(resourceBounds: ResourceBounds): Resou
         }
     };
 }
+
+export function replaceBigInts<T>(obj: T): ReplaceBigInt<T> {
+    const replace = (value: any): any => {
+        if(typeof(value)==="bigint") return "0x"+value.toString(16);
+        if(value==null || typeof(value)!=="object") return value;
+
+        if(Array.isArray(value)) {
+            return value.map(replace);
+        }
+
+        const mapped: any = {};
+        for(const key of Object.keys(value)) {
+            mapped[key] = replace(value[key]);
+        }
+        return mapped;
+    };
+
+    return replace(obj);
+}