@atomiqlabs/base 10.0.0-dev.17 → 10.0.0-dev.19

package/dist/chains/ChainInterface.d.ts

@@ -30,6 +30,12 @@ export interface ChainInterface<TX = any, Signer extends AbstractSigner = Abstra
      * @param lenient Whether a lenient parsing should be used (i.e. don't strictly enforce the Starknet address lengths)
      */
     isValidAddress(address: string, lenient?: boolean): boolean;
+    /**
+     * Normalizes a given address i.e. pads it to the specific size
+     *
+     * @param address
+     */
+    normalizeAddress(address: string): string;
     /**
      * Checks if a given string is a valid token identifier
      *
@@ -80,6 +86,14 @@ export interface ChainInterface<TX = any, Signer extends AbstractSigner = Abstra
      * @param txId Transaction ID
      */
     getTxIdStatus(txId: string): Promise<"not_found" | "pending" | "success" | "reverted">;
+    /**
+     * Returns the latest known finalized block data (this is a block with 100% certainty of not getting re-org, i.e.
+     *  a block already committed on L1)
+     */
+    getFinalizedBlock(): Promise<{
+        height: number;
+        blockHash: string;
+    }>;
     /**
      * Signs, sends a batch of transaction and optionally waits for their confirmation
      *

package/dist/spv_swap/SpvVaultContract.d.ts

@@ -169,17 +169,21 @@ export interface SpvVaultContract<TX = any, Signer extends AbstractSigner = Abst
      */
     getAllVaults(owner?: string): Promise<Data[]>;
     /**
-     * Returns current state of the withdrawal as specified by the bitcoin transaction ID
+     * Returns current state of the withdrawal as specified by the bitcoin transaction ID, optionally
+     *  only check withdrawals from the provided block height
      *
      * @param btcTxId
+     * @param scStartBlockheight
      */
-    getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
+    getWithdrawalState(btcTxId: string, scStartBlockheight?: number): Promise<SpvWithdrawalState>;
     /**
-     * Returns current state of the withdrawals as specified by the bitcoin transaction IDs
+     * Returns current state of the withdrawals as specified by the bitcoin transaction IDs, optionally
+     *  only check withdrawals from the provided block height
      *
      * @param btcTxIds
+     * @param scStartBlockheight
      */
-    getWithdrawalStates(btcTxIds: string[]): Promise<{
+    getWithdrawalStates(btcTxIds: string[], scStartBlockheight?: number): Promise<{
         [btcTxId: string]: SpvWithdrawalState;
     }>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/base",
-  "version": "10.0.0-dev.17",
+  "version": "10.0.0-dev.19",
   "description": "Base classes and interfaces for atomiq protocol",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",

package/src/chains/ChainInterface.ts

@@ -45,6 +45,13 @@ export interface ChainInterface<
      */
     isValidAddress(address: string, lenient?: boolean): boolean;
 
+    /**
+     * Normalizes a given address i.e. pads it to the specific size
+     *
+     * @param address
+     */
+    normalizeAddress(address: string): string;
+
     /**
      * Checks if a given string is a valid token identifier
      *
@@ -102,6 +109,12 @@ export interface ChainInterface<
      */
     getTxIdStatus(txId: string): Promise<"not_found" | "pending" | "success" | "reverted">;
 
+    /**
+     * Returns the latest known finalized block data (this is a block with 100% certainty of not getting re-org, i.e.
+     *  a block already committed on L1)
+     */
+    getFinalizedBlock(): Promise<{height: number, blockHash: string}>;
+
     /**
      * Signs, sends a batch of transaction and optionally waits for their confirmation
      *

package/src/spv_swap/SpvVaultContract.ts

@@ -180,18 +180,22 @@ export interface SpvVaultContract<
     getAllVaults(owner?: string): Promise<Data[]>;
 
     /**
-     * Returns current state of the withdrawal as specified by the bitcoin transaction ID
+     * Returns current state of the withdrawal as specified by the bitcoin transaction ID, optionally
+     *  only check withdrawals from the provided block height
      *
      * @param btcTxId
+     * @param scStartBlockheight
      */
-    getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
+    getWithdrawalState(btcTxId: string, scStartBlockheight?: number): Promise<SpvWithdrawalState>;
 
     /**
-     * Returns current state of the withdrawals as specified by the bitcoin transaction IDs
+     * Returns current state of the withdrawals as specified by the bitcoin transaction IDs, optionally
+     *  only check withdrawals from the provided block height
      *
      * @param btcTxIds
+     * @param scStartBlockheight
      */
-    getWithdrawalStates(btcTxIds: string[]): Promise<{[btcTxId: string]: SpvWithdrawalState}>;
+    getWithdrawalStates(btcTxIds: string[], scStartBlockheight?: number): Promise<{[btcTxId: string]: SpvWithdrawalState}>;
 
     /**
      * Parses withdrawal data from the parsed bitcoin transaction