@atomiqlabs/base 13.1.8 → 13.1.12

package/dist/btc/lightning/LightningNetworkApi.d.ts

@@ -1,7 +1,7 @@
 /**
  * A type defining total capacity of a given lightning network node
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNNodeLiquidity = {
     publicKey: string;
@@ -11,7 +11,7 @@ export type LNNodeLiquidity = {
 /**
  * An interface for Lightning API, provides view of the public lightning network data like channel graph
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export interface LightningNetworkApi {
     /**

package/dist/btcrelay/BtcRelay.d.ts

@@ -6,7 +6,7 @@ import { AbstractSigner } from "../chains/ChainInterface";
 /**
  * Represents a BTC relay bitcoin light client contract, which verifies the bitcoin blockheaders on smart chains
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface BtcRelay<V extends BtcStoredHeader<any>, T, B extends BtcBlock, Signer extends AbstractSigner = AbstractSigner> {
     /**

package/dist/btcrelay/synchronizer/RelaySynchronizer.d.ts

@@ -43,7 +43,7 @@ export type SynchronizationResponse<V extends BtcStoredHeader<any>, T, B extends
  *  necessary to synchronize the underlying relay contract to the current tip of the canonical chain,
  *  automatically handles forking if necessary
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface RelaySynchronizer<V extends BtcStoredHeader<any>, T, B extends BtcBlock> {
     /**

package/dist/btcrelay/types/BtcHeader.d.ts

@@ -3,7 +3,7 @@ import { Buffer } from "buffer";
 /**
  * Represents a raw bitcoin header (80-bytes) that can be synchronized to the underlying BTC relay light client contract
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface BtcHeader {
     /**

package/dist/btcrelay/types/BtcStoredHeader.d.ts

@@ -5,7 +5,7 @@ import { Buffer } from "buffer";
  * Represents a bitcoin blockheader that has already been synchronized and saved (committed) in the BTC relay
  *  contract
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface BtcStoredHeader<T extends BtcHeader> {
     /**

package/dist/chains/ChainInterface.d.ts

@@ -1,5 +1,5 @@
 /**
- * @category Chain
+ * @category Chains
  */
 export type TransactionConfirmationOptions = {
     waitForConfirmation?: boolean;
@@ -10,11 +10,12 @@ export type TransactionConfirmationOptions = {
  * Defines of a signer, contains an address getter and optionally init() & stop() functions
  *  to initiate internal processes inside the signer (if required and exposed)
  *
- * @category Signer
+ * @category Chains
  */
 export type AbstractSigner = {
     type: "AtomiqAbstractSigner";
     getAddress: () => string;
+    getReproducibleEntropy?: (appName: string) => string;
     init?: () => Promise<void>;
     stop?: () => Promise<void>;
 };
@@ -26,6 +27,8 @@ export type AbstractSigner = {
 export declare function isAbstractSigner(val: any): val is AbstractSigner;
 /**
  * An interface representing a smart chain, allowing basic operations on the chain and reading chain data
+ *
+ * @category Chains
  */
 export interface ChainInterface<TX = any, SignedTX = any, Signer extends AbstractSigner = AbstractSigner, ChainId extends string = string, NativeSigner = any> {
     /**

package/dist/events/ChainEvents.d.ts

@@ -3,13 +3,13 @@ import { ChainEvent } from "./types/ChainEvent";
 /**
  * A type of the on-chain event listener callback
  *
- * @category Events
+ * @category Chains
  */
 export type EventListener<T extends SwapData> = (obj: ChainEvent<T>[]) => Promise<boolean>;
 /**
  * An interface defining an on-chain events listener, allowing registering callbacks to receive on-chain events
  *
- * @category Events
+ * @category Chains
  */
 export interface ChainEvents<T extends SwapData, S extends any = any> {
     /**

package/dist/spv_swap/SpvVaultContract.d.ts

@@ -10,7 +10,7 @@ import { BtcTx } from "../btc/rpc/BitcoinRpc";
 /**
  * Represents an SPV vault (UTXO-controlled vault) contract, exposes operations on the vaults
  *
- * @category Swaps
+ * @category Chains
  */
 export interface SpvVaultContract<TX = any, Signer extends AbstractSigner = AbstractSigner, ChainId extends string = string, WithdrawalTX extends SpvWithdrawalTransactionData = SpvWithdrawalTransactionData, Data extends SpvVaultData<WithdrawalTX> = SpvVaultData<WithdrawalTX>> {
     /**

package/dist/spv_swap/SpvVaultData.d.ts

@@ -7,7 +7,7 @@ import { SpvVaultDepositEvent } from "../events/types/spv_vault/SpvVaultDepositE
 /**
  * Balance for a specific token inside a vault
  *
- * @category Swaps
+ * @category Chains
  */
 export type SpvVaultTokenBalance = SpvVaultTokenData & {
     /**
@@ -22,7 +22,7 @@ export type SpvVaultTokenBalance = SpvVaultTokenData & {
 /**
  * Configuration for a specific token inside an SPV vault (UTXO-controlled vault)
  *
- * @category Swaps
+ * @category Chains
  */
 export type SpvVaultTokenData = {
     /**
@@ -37,7 +37,7 @@ export type SpvVaultTokenData = {
 /**
  * Represents the state of a single SPV vault (UTXO-controlled vault)
  *
- * @category Swaps
+ * @category Chains
  */
 export declare abstract class SpvVaultData<T extends SpvWithdrawalTransactionData = SpvWithdrawalTransactionData> implements StorageObject {
     /**

package/dist/spv_swap/SpvVaultData.js

@@ -4,7 +4,7 @@ exports.SpvVaultData = void 0;
 /**
  * Represents the state of a single SPV vault (UTXO-controlled vault)
  *
- * @category Swaps
+ * @category Chains
  */
 class SpvVaultData {
     /**

package/dist/spv_swap/SpvWithdrawalState.d.ts

@@ -1,7 +1,7 @@
 /**
  * Possible states of a vault withdrawal (claim) transaction
  *
- * @category Swaps
+ * @category Chains
  */
 export declare enum SpvWithdrawalStateType {
     /**
@@ -36,6 +36,11 @@ type SpvWithdrawalStateCommon = {
     txId: string;
     owner: string;
     vaultId: bigint;
+    btcTxId?: string;
+    getTxBlock?: () => Promise<{
+        blockHeight: number;
+        blockTime: number;
+    }>;
 };
 /**
  * The withdrawal was successfully processed on the smart chain side
@@ -47,11 +52,6 @@ export type SpvWithdrawalClaimedState = {
     recipient: string;
     claimer: string;
     fronter: string;
-    getClaimTxId?: () => Promise<string>;
-    getTxBlock?: () => Promise<{
-        blockHeight: number;
-        blockTime: number;
-    }>;
 } & SpvWithdrawalStateCommon;
 /**
  * The withdrawal has been fronted by some 3rd party
@@ -62,11 +62,6 @@ export type SpvWithdrawalFrontedState = {
     type: SpvWithdrawalStateType.FRONTED;
     recipient: string;
     fronter: string;
-    getFrontTxId?: () => Promise<string>;
-    getTxBlock?: () => Promise<{
-        blockHeight: number;
-        blockTime: number;
-    }>;
 } & SpvWithdrawalStateCommon;
 /**
  * An SPV vault (UTXO-controlled vault), has been closed as a result of the claim (withdrawal) transaction,
@@ -77,11 +72,6 @@ export type SpvWithdrawalFrontedState = {
 export type SpvWithdrawalClosedState = {
     type: SpvWithdrawalStateType.CLOSED;
     error: string;
-    getClosedTxId?: () => Promise<string>;
-    getTxBlock?: () => Promise<{
-        blockHeight: number;
-        blockTime: number;
-    }>;
 } & SpvWithdrawalStateCommon;
 /**
  * A union type for the state of the spv vault claim (withdrawal)

package/dist/spv_swap/SpvWithdrawalState.js

@@ -4,7 +4,7 @@ exports.SpvWithdrawalStateType = void 0;
 /**
  * Possible states of a vault withdrawal (claim) transaction
  *
- * @category Swaps
+ * @category Chains
  */
 var SpvWithdrawalStateType;
 (function (SpvWithdrawalStateType) {

package/dist/spv_swap/SpvWithdrawalTransactionData.d.ts

@@ -4,6 +4,8 @@ import { Buffer } from "buffer";
 import { StorageObject } from "../storage/StorageObject";
 /**
  * Execution data assigned to the withdrawal
+ *
+ * @category Chains
  */
 export type ExecutionData = {
     executionHash: string;
@@ -12,7 +14,7 @@ export type ExecutionData = {
 /**
  * Represents the data of a single SPV vault (UTXO-controlled) vault withdrawal
  *
- * @category Swaps
+ * @category Chains
  */
 export declare abstract class SpvWithdrawalTransactionData implements StorageObject {
     /**

package/dist/spv_swap/SpvWithdrawalTransactionData.js

@@ -5,7 +5,7 @@ const buffer_1 = require("buffer");
 /**
  * Represents the data of a single SPV vault (UTXO-controlled) vault withdrawal
  *
- * @category Swaps
+ * @category Chains
  */
 class SpvWithdrawalTransactionData {
     /**

package/dist/swaps/ChainSwapType.d.ts

@@ -1,7 +1,7 @@
 /**
  * Smart chain escrow swap types
  *
- * @category Swaps
+ * @category Chains
  */
 export declare enum ChainSwapType {
     /**

package/dist/swaps/ChainSwapType.js

@@ -4,7 +4,7 @@ exports.ChainSwapType = void 0;
 /**
  * Smart chain escrow swap types
  *
- * @category Swaps
+ * @category Chains
  */
 var ChainSwapType;
 (function (ChainSwapType) {

package/dist/swaps/SwapCommitState.d.ts

@@ -1,7 +1,7 @@
 /**
  * Possible on-chain states of the swap escrow
  *
- * @category Swaps
+ * @category Chains
  */
 export declare enum SwapCommitStateType {
     /**

package/dist/swaps/SwapCommitState.js

@@ -4,7 +4,7 @@ exports.SwapCommitStateType = void 0;
 /**
  * Possible on-chain states of the swap escrow
  *
- * @category Swaps
+ * @category Chains
  */
 var SwapCommitStateType;
 (function (SwapCommitStateType) {

package/dist/swaps/SwapContract.d.ts

@@ -55,7 +55,7 @@ export type BitcoinTransactionData = {
 /**
  * A contract for interacting with escrow manager swaps - escrow based swaps like HTLCs and PrTLCs
  *
- * @category Swaps
+ * @category Chains
  */
 export interface SwapContract<T extends SwapData = SwapData, TX = any, PreFetchData = any, PreFetchVerification = any, Signer extends AbstractSigner = AbstractSigner, ChainId extends string = string> {
     /**

package/dist/swaps/SwapData.d.ts

@@ -3,7 +3,7 @@ import { StorageObject } from "../storage/StorageObject";
 /**
  * Represents full escrow swap data and parameters
  *
- * @category Swaps
+ * @category Chains
  */
 export declare abstract class SwapData implements StorageObject {
     /**

package/dist/swaps/SwapData.js

@@ -4,7 +4,7 @@ exports.SwapData = void 0;
 /**
  * Represents full escrow swap data and parameters
  *
- * @category Swaps
+ * @category Chains
  */
 class SwapData {
     /**

package/package.json

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

package/src/btc/lightning/LightningNetworkApi.ts

@@ -2,7 +2,7 @@
 /**
  * A type defining total capacity of a given lightning network node
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNNodeLiquidity = {
     publicKey: string,
@@ -13,7 +13,7 @@ export type LNNodeLiquidity = {
 /**
  * An interface for Lightning API, provides view of the public lightning network data like channel graph
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export interface LightningNetworkApi {
 

package/src/btcrelay/BtcRelay.ts

@@ -6,7 +6,7 @@ import {AbstractSigner} from "../chains/ChainInterface";
 /**
  * Represents a BTC relay bitcoin light client contract, which verifies the bitcoin blockheaders on smart chains
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface BtcRelay<
     V extends BtcStoredHeader<any>,

package/src/btcrelay/synchronizer/RelaySynchronizer.ts

@@ -41,7 +41,7 @@ export type SynchronizationResponse<V extends BtcStoredHeader<any>, T, B extends
  *  necessary to synchronize the underlying relay contract to the current tip of the canonical chain,
  *  automatically handles forking if necessary
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface RelaySynchronizer<V extends BtcStoredHeader<any>, T, B extends BtcBlock> {
 

package/src/btcrelay/types/BtcHeader.ts

@@ -3,7 +3,7 @@ import {Buffer} from "buffer";
 /**
  * Represents a raw bitcoin header (80-bytes) that can be synchronized to the underlying BTC relay light client contract
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface BtcHeader {
 

package/src/btcrelay/types/BtcStoredHeader.ts

@@ -5,7 +5,7 @@ import {Buffer} from "buffer";
  * Represents a bitcoin blockheader that has already been synchronized and saved (committed) in the BTC relay
  *  contract
  *
- * @category BTC Relay
+ * @category Chains
  */
 export interface BtcStoredHeader<T extends BtcHeader> {
 

package/src/chains/ChainInterface.ts

@@ -1,5 +1,5 @@
 /**
- * @category Chain
+ * @category Chains
  */
 export type TransactionConfirmationOptions = {
     waitForConfirmation?: boolean,
@@ -11,11 +11,12 @@ export type TransactionConfirmationOptions = {
  * Defines of a signer, contains an address getter and optionally init() & stop() functions
  *  to initiate internal processes inside the signer (if required and exposed)
  *
- * @category Signer
+ * @category Chains
  */
 export type AbstractSigner = {
     type: "AtomiqAbstractSigner",
     getAddress: () => string,
+    getReproducibleEntropy?: (appName: string) => string,
     init?: () => Promise<void>,
     stop?: () => Promise<void>
 };
@@ -31,6 +32,8 @@ export function isAbstractSigner(val: any): val is AbstractSigner {
 
 /**
  * An interface representing a smart chain, allowing basic operations on the chain and reading chain data
+ *
+ * @category Chains
  */
 export interface ChainInterface<
     TX = any,

package/src/events/ChainEvents.ts

@@ -4,14 +4,14 @@ import {ChainEvent} from "./types/ChainEvent";
 /**
  * A type of the on-chain event listener callback
  *
- * @category Events
+ * @category Chains
  */
 export type EventListener<T extends SwapData> = (obj: ChainEvent<T>[]) => Promise<boolean>;
 
 /**
  * An interface defining an on-chain events listener, allowing registering callbacks to receive on-chain events
  *
- * @category Events
+ * @category Chains
  */
 export interface ChainEvents<T extends SwapData, S extends any = any> {
 

package/src/spv_swap/SpvVaultContract.ts

@@ -15,7 +15,7 @@ import {BtcTx} from "../btc/rpc/BitcoinRpc";
 /**
  * Represents an SPV vault (UTXO-controlled vault) contract, exposes operations on the vaults
  *
- * @category Swaps
+ * @category Chains
  */
 export interface SpvVaultContract<
     TX = any,

package/src/spv_swap/SpvVaultData.ts

@@ -8,7 +8,7 @@ import {SpvVaultDepositEvent} from "../events/types/spv_vault/SpvVaultDepositEve
 /**
  * Balance for a specific token inside a vault
  *
- * @category Swaps
+ * @category Chains
  */
 export type SpvVaultTokenBalance = SpvVaultTokenData & {
     /**
@@ -24,7 +24,7 @@ export type SpvVaultTokenBalance = SpvVaultTokenData & {
 /**
  * Configuration for a specific token inside an SPV vault (UTXO-controlled vault)
  *
- * @category Swaps
+ * @category Chains
  */
 export type SpvVaultTokenData = {
     /**
@@ -40,7 +40,7 @@ export type SpvVaultTokenData = {
 /**
  * Represents the state of a single SPV vault (UTXO-controlled vault)
  *
- * @category Swaps
+ * @category Chains
  */
 export abstract class SpvVaultData<T extends SpvWithdrawalTransactionData = SpvWithdrawalTransactionData> implements StorageObject {
 

package/src/spv_swap/SpvWithdrawalState.ts

@@ -1,7 +1,7 @@
 /**
  * Possible states of a vault withdrawal (claim) transaction
  *
- * @category Swaps
+ * @category Chains
  */
 export enum SpvWithdrawalStateType {
     /**
@@ -38,6 +38,8 @@ type SpvWithdrawalStateCommon = {
     txId: string,
     owner: string,
     vaultId: bigint,
+    btcTxId?: string,
+    getTxBlock?: () => Promise<{blockHeight: number, blockTime: number}>
 };
 
 /**
@@ -49,9 +51,7 @@ export type SpvWithdrawalClaimedState = {
     type: SpvWithdrawalStateType.CLAIMED,
     recipient: string,
     claimer: string,
-    fronter: string,
-    getClaimTxId?: () => Promise<string>,
-    getTxBlock?: () => Promise<{blockHeight: number, blockTime: number}>
+    fronter: string
 } & SpvWithdrawalStateCommon;
 
 /**
@@ -62,9 +62,7 @@ export type SpvWithdrawalClaimedState = {
 export type SpvWithdrawalFrontedState = {
     type: SpvWithdrawalStateType.FRONTED,
     recipient: string,
-    fronter: string,
-    getFrontTxId?: () => Promise<string>,
-    getTxBlock?: () => Promise<{blockHeight: number, blockTime: number}>
+    fronter: string
 } & SpvWithdrawalStateCommon;
 
 /**
@@ -75,9 +73,7 @@ export type SpvWithdrawalFrontedState = {
  */
 export type SpvWithdrawalClosedState = {
     type: SpvWithdrawalStateType.CLOSED,
-    error: string,
-    getClosedTxId?: () => Promise<string>,
-    getTxBlock?: () => Promise<{blockHeight: number, blockTime: number}>
+    error: string
 } & SpvWithdrawalStateCommon;
 
 /**

package/src/spv_swap/SpvWithdrawalTransactionData.ts

@@ -4,6 +4,8 @@ import {StorageObject} from "../storage/StorageObject";
 
 /**
  * Execution data assigned to the withdrawal
+ *
+ * @category Chains
  */
 export type ExecutionData = {
     executionHash: string,
@@ -13,7 +15,7 @@ export type ExecutionData = {
 /**
  * Represents the data of a single SPV vault (UTXO-controlled) vault withdrawal
  *
- * @category Swaps
+ * @category Chains
  */
 export abstract class SpvWithdrawalTransactionData implements StorageObject {
 

package/src/swaps/ChainSwapType.ts

@@ -1,7 +1,7 @@
 /**
  * Smart chain escrow swap types
  *
- * @category Swaps
+ * @category Chains
  */
 export enum ChainSwapType {
     /**

package/src/swaps/SwapCommitState.ts

@@ -1,7 +1,7 @@
 /**
  * Possible on-chain states of the swap escrow
  *
- * @category Swaps
+ * @category Chains
  */
 export enum SwapCommitStateType {
     /**

package/src/swaps/SwapContract.ts

@@ -58,7 +58,7 @@ export type BitcoinTransactionData = {
 /**
  * A contract for interacting with escrow manager swaps - escrow based swaps like HTLCs and PrTLCs
  *
- * @category Swaps
+ * @category Chains
  */
 export interface SwapContract<
     T extends SwapData = SwapData,

package/src/swaps/SwapData.ts

@@ -4,7 +4,7 @@ import {StorageObject} from "../storage/StorageObject";
 /**
  * Represents full escrow swap data and parameters
  *
- * @category Swaps
+ * @category Chains
  */
 export abstract class SwapData implements StorageObject {