@atomiqlabs/base 13.3.0 → 13.4.2

package/dist/chains/ChainInterface.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { BitcoinNetwork } from "../btc/BitcoinNetwork";
 /**
  * @category Chains
  */
@@ -118,6 +119,12 @@ export interface ChainInterface<TX = any, SignedTX = any, Signer extends Abstrac
      * @param txData Serialized transaction data string
      */
     deserializeSignedTx(txData: string): Promise<SignedTX>;
+    /**
+     * Returns the transaction ID of the signed transaction
+     *
+     * @param signedTX Signed transaction to get the transaction ID of
+     */
+    getTxId?(signedTX: SignedTX): Promise<string>;
     /**
      * Returns the status of the given serialized transaction
      *
@@ -185,4 +192,11 @@ export interface ChainInterface<TX = any, SignedTX = any, Signer extends Abstrac
      * Wraps a native chain signer object to an atomiq-understandable AbstractSigner
      */
     wrapSigner(signer: NativeSigner): Promise<Signer>;
+    /**
+     * Verifies whether the set network of this chain interface matches the passed bitcoin network (i.e. mainnet should
+     *  use mainnet networks and testnets should use testnet networks)
+     *
+     * @throws {Error} When the underlying network doesn't match
+     */
+    verifyNetwork?(bitcoinNetwork: BitcoinNetwork): Promise<void>;
 }

package/dist/swaps/SwapCommitState.d.ts

@@ -32,6 +32,7 @@ export declare enum SwapCommitStateType {
  */
 export type SwapNotCommitedState = {
     type: SwapCommitStateType.NOT_COMMITED;
+    getInitTxId?: () => Promise<string>;
     getRefundTxId?: () => Promise<string>;
     getTxBlock?: () => Promise<{
         blockHeight: number;
@@ -45,6 +46,7 @@ export type SwapNotCommitedState = {
  */
 export type SwapExpiredState = {
     type: SwapCommitStateType.EXPIRED;
+    getInitTxId?: () => Promise<string>;
     getRefundTxId?: () => Promise<string>;
     getTxBlock?: () => Promise<{
         blockHeight: number;
@@ -58,6 +60,7 @@ export type SwapExpiredState = {
  */
 export type SwapRefundableState = {
     type: SwapCommitStateType.REFUNDABLE;
+    getInitTxId?: () => Promise<string>;
 };
 /**
  * The escrow is active on-chain and can be claimed
@@ -66,6 +69,7 @@ export type SwapRefundableState = {
  */
 export type SwapCommitedState = {
     type: SwapCommitStateType.COMMITED;
+    getInitTxId?: () => Promise<string>;
 };
 /**
  * The escrow has been finalized and funds claimed by the claimer
@@ -74,6 +78,7 @@ export type SwapCommitedState = {
  */
 export type SwapPaidState = {
     type: SwapCommitStateType.PAID;
+    getInitTxId?: () => Promise<string>;
     getClaimTxId: () => Promise<string>;
     getClaimResult: () => Promise<string>;
     getTxBlock: () => Promise<{

package/package.json

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

package/src/chains/ChainInterface.ts

@@ -1,3 +1,5 @@
+import {BitcoinNetwork} from "../btc/BitcoinNetwork";
+
 /**
  * @category Chains
  */
@@ -142,6 +144,13 @@ export interface ChainInterface<
      */
     deserializeSignedTx(txData: string): Promise<SignedTX>;
 
+    /**
+     * Returns the transaction ID of the signed transaction
+     *
+     * @param signedTX Signed transaction to get the transaction ID of
+     */
+    getTxId?(signedTX: SignedTX): Promise<string>;
+
     /**
      * Returns the status of the given serialized transaction
      *
@@ -216,4 +225,12 @@ export interface ChainInterface<
      */
     wrapSigner(signer: NativeSigner): Promise<Signer>;
 
+    /**
+     * Verifies whether the set network of this chain interface matches the passed bitcoin network (i.e. mainnet should
+     *  use mainnet networks and testnets should use testnet networks)
+     *
+     * @throws {Error} When the underlying network doesn't match
+     */
+    verifyNetwork?(bitcoinNetwork: BitcoinNetwork): Promise<void>;
+
 }

package/src/swaps/SwapCommitState.ts

@@ -33,6 +33,7 @@ export enum SwapCommitStateType {
  */
 export type SwapNotCommitedState = {
     type: SwapCommitStateType.NOT_COMMITED,
+    getInitTxId?: () => Promise<string>,
     getRefundTxId?: () => Promise<string>,
     getTxBlock?: () => Promise<{blockHeight: number, blockTime: number}>
 };
@@ -44,6 +45,7 @@ export type SwapNotCommitedState = {
  */
 export type SwapExpiredState = {
     type: SwapCommitStateType.EXPIRED,
+    getInitTxId?: () => Promise<string>,
     getRefundTxId?: () => Promise<string>,
     getTxBlock?: () => Promise<{blockHeight: number, blockTime: number}>
 };
@@ -54,7 +56,8 @@ export type SwapExpiredState = {
  * @category Swaps
  */
 export type SwapRefundableState = {
-    type: SwapCommitStateType.REFUNDABLE
+    type: SwapCommitStateType.REFUNDABLE,
+    getInitTxId?: () => Promise<string>
 };
 
 /**
@@ -63,7 +66,8 @@ export type SwapRefundableState = {
  * @category Swaps
  */
 export type SwapCommitedState = {
-    type: SwapCommitStateType.COMMITED
+    type: SwapCommitStateType.COMMITED,
+    getInitTxId?: () => Promise<string>
 };
 
 /**
@@ -73,6 +77,7 @@ export type SwapCommitedState = {
  */
 export type SwapPaidState = {
     type: SwapCommitStateType.PAID,
+    getInitTxId?: () => Promise<string>,
     getClaimTxId: () => Promise<string>,
     getClaimResult: () => Promise<string>,
     getTxBlock: () => Promise<{blockHeight: number, blockTime: number}>