@atomiqlabs/base 10.0.0-dev.10 → 10.0.0-dev.14

package/dist/chains/ChainInterface.d.ts

@@ -8,7 +8,7 @@ export type AbstractSigner = {
     init?: () => Promise<void>;
     stop?: () => Promise<void>;
 };
-export interface ChainInterface<TX = any, Signer extends AbstractSigner = AbstractSigner, ChainId extends string = string> {
+export interface ChainInterface<TX = any, Signer extends AbstractSigner = AbstractSigner, ChainId extends string = string, NativeSigner = any> {
     readonly chainId: ChainId;
     /**
      * Returns the token balance of a specific address
@@ -109,4 +109,8 @@ export interface ChainInterface<TX = any, Signer extends AbstractSigner = Abstra
      * Returns randomly generated signer
      */
     randomSigner(): Signer;
+    /**
+     * Wraps a native chain signer object to an atomiq-understandable AbstractSigner
+     */
+    wrapSigner(signer: NativeSigner): Signer;
 }

package/dist/chains/ChainType.d.ts

@@ -6,7 +6,7 @@ import { AbstractSigner, ChainInterface } from "./ChainInterface";
 import { SpvVaultData } from "../spv_swap/SpvVaultData";
 import { SpvVaultContract } from "../spv_swap/SpvVaultContract";
 import { SpvWithdrawalTransactionData } from "../spv_swap/SpvWithdrawalTransactionData";
-export type ChainType<ChainId extends string = string, PreFetchData = any, PreFetchVerification = any, TXType = any, Signer extends AbstractSigner = AbstractSigner, T extends SwapData = SwapData, C extends SwapContract<T, TXType, PreFetchData, PreFetchVerification, Signer, ChainId> = SwapContract<T, TXType, PreFetchData, PreFetchVerification, Signer, ChainId>, I extends ChainInterface<TXType, Signer, ChainId> = ChainInterface<TXType, Signer, ChainId>, E extends ChainEvents<T> = ChainEvents<T>, B extends BtcRelay<any, TXType, any, Signer> = BtcRelay<any, TXType, any, Signer>, SpvData extends SpvVaultData = SpvVaultData, SpvWithdrawalData extends SpvWithdrawalTransactionData = SpvWithdrawalTransactionData, SpvContract extends SpvVaultContract<TXType, Signer, ChainId, SpvData, SpvWithdrawalData> = SpvVaultContract<TXType, Signer, ChainId, SpvData, SpvWithdrawalData>> = {
+export type ChainType<ChainId extends string = string, PreFetchData = any, PreFetchVerification = any, TXType = any, Signer extends AbstractSigner = AbstractSigner, NativeSigner = any, T extends SwapData = SwapData, C extends SwapContract<T, TXType, PreFetchData, PreFetchVerification, Signer, ChainId> = SwapContract<T, TXType, PreFetchData, PreFetchVerification, Signer, ChainId>, I extends ChainInterface<TXType, Signer, ChainId, NativeSigner> = ChainInterface<TXType, Signer, ChainId, NativeSigner>, E extends ChainEvents<T> = ChainEvents<T>, B extends BtcRelay<any, TXType, any, Signer> = BtcRelay<any, TXType, any, Signer>, SpvData extends SpvVaultData = SpvVaultData, SpvWithdrawalData extends SpvWithdrawalTransactionData = SpvWithdrawalTransactionData, SpvContract extends SpvVaultContract<TXType, Signer, ChainId, SpvData, SpvWithdrawalData> = SpvVaultContract<TXType, Signer, ChainId, SpvData, SpvWithdrawalData>> = {
     ChainId: ChainId;
     PreFetchData: PreFetchData;
     PreFetchVerification: PreFetchVerification;
@@ -20,4 +20,5 @@ export type ChainType<ChainId extends string = string, PreFetchData = any, PreFe
     SpvVaultData: SpvData;
     SpvVaultContract: SpvContract;
     SpvVaultWithdrawalData: SpvWithdrawalData;
+    NativeSigner: NativeSigner;
 };

package/dist/spv_swap/SpvVaultContract.d.ts

@@ -111,6 +111,18 @@ export interface SpvVaultContract<TX = any, Signer extends AbstractSigner = Abst
      * @param withdrawal Withdrawal transaction to check the fronting for
      */
     getFronterAddress(owner: string, vaultId: bigint, withdrawal: WithdrawalTX): Promise<string | null>;
+    /**
+     * Returns the parties which currently fronted the withdrawal transactions
+     *
+     * @param withdrawals withdrawals to query
+     */
+    getFronterAddresses(withdrawals: {
+        owner: string;
+        vaultId: bigint;
+        withdrawal: WithdrawalTX;
+    }[]): Promise<{
+        [btcTxId: string]: string | null;
+    }>;
     /**
      * Returns current vault data
      *
@@ -118,6 +130,39 @@ export interface SpvVaultContract<TX = any, Signer extends AbstractSigner = Abst
      * @param vaultId Vault ID
      */
     getVaultData(owner: string, vaultId: bigint): Promise<Data>;
+    /**
+     * Returns current vault data for multiple vaults
+     *
+     * @param vaults Vault data to query
+     */
+    getMultipleVaultData(vaults: {
+        owner: string;
+        vaultId: bigint;
+    }[]): Promise<{
+        [owner: string]: {
+            [vaultId: string]: Data;
+        };
+    }>;
+    /**
+     * Returns the latest utxo of a vault (or null if vault closed or not found)
+     *
+     * @param owner Owner of the vault
+     * @param vaultId Vault ID
+     */
+    getVaultLatestUtxo(owner: string, vaultId: bigint): Promise<string | null>;
+    /**
+     * Returns the latest utxos of for multiple vaults (or null if vault closed or not found)
+     *
+     * @param vaults Vault data to query
+     */
+    getVaultLatestUtxos(vaults: {
+        owner: string;
+        vaultId: bigint;
+    }[]): Promise<{
+        [owner: string]: {
+            [vaultId: string]: string | null;
+        };
+    }>;
     /**
      * Returns all currently opened vaults
      * NOTE: This will take a long time, since the implementation will have to go through all the prior events
@@ -129,6 +174,14 @@ export interface SpvVaultContract<TX = any, Signer extends AbstractSigner = Abst
      * @param btcTxId
      */
     getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
+    /**
+     * Returns current state of the withdrawals as specified by the bitcoin transaction IDs
+     *
+     * @param btcTxIds
+     */
+    getWithdrawalStates(btcTxIds: string[]): Promise<{
+        [btcTxId: string]: SpvWithdrawalState;
+    }>;
     /**
      * Parses withdrawal data from the parsed bitcoin transaction
      *

package/dist/swaps/SwapContract.d.ts

@@ -190,6 +190,17 @@ export interface SwapContract<T extends SwapData = SwapData, TX = any, PreFetchD
      * @param swapData
      */
     getCommitStatus(signer: string, swapData: T): Promise<SwapCommitState>;
+    /**
+     * Returns the full status of the passed swaps, expiry is handled by the isExpired function so also requires a signer/sender
+     *
+     * @param request
+     */
+    getCommitStatuses(request: {
+        signer: string;
+        swapData: T;
+    }[]): Promise<{
+        [escrowHash: string]: SwapCommitState;
+    }>;
     /**
      * Checks whether a given swap is refundable by us, i.e. it is already expired, we are offerer & swap is committed on-chain
      *

package/package.json

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

package/src/chains/ChainInterface.ts

@@ -13,7 +13,8 @@ export type AbstractSigner = {
 export interface ChainInterface<
     TX = any,
     Signer extends AbstractSigner = AbstractSigner,
-    ChainId extends string = string
+    ChainId extends string = string,
+    NativeSigner = any
 > {
 
     readonly chainId: ChainId;
@@ -132,4 +133,9 @@ export interface ChainInterface<
      */
     randomSigner(): Signer;
 
+    /**
+     * Wraps a native chain signer object to an atomiq-understandable AbstractSigner
+     */
+    wrapSigner(signer: NativeSigner): Signer;
+
 }

package/src/chains/ChainType.ts

@@ -13,9 +13,10 @@ export type ChainType<
     PreFetchVerification = any,
     TXType = any,
     Signer extends AbstractSigner = AbstractSigner,
+    NativeSigner = any,
     T extends SwapData = SwapData,
     C extends SwapContract<T, TXType, PreFetchData, PreFetchVerification, Signer, ChainId> = SwapContract<T, TXType, PreFetchData, PreFetchVerification, Signer, ChainId>,
-    I extends ChainInterface<TXType, Signer, ChainId> = ChainInterface<TXType, Signer, ChainId>,
+    I extends ChainInterface<TXType, Signer, ChainId, NativeSigner> = ChainInterface<TXType, Signer, ChainId, NativeSigner>,
     E extends ChainEvents<T> = ChainEvents<T>,
     B extends BtcRelay<any, TXType, any, Signer> = BtcRelay<any, TXType, any, Signer>,
     SpvData extends SpvVaultData = SpvVaultData,
@@ -34,5 +35,6 @@ export type ChainType<
     BtcRelay: B,
     SpvVaultData: SpvData,
     SpvVaultContract: SpvContract,
-    SpvVaultWithdrawalData: SpvWithdrawalData
+    SpvVaultWithdrawalData: SpvWithdrawalData,
+    NativeSigner: NativeSigner
 }

package/src/spv_swap/SpvVaultContract.ts

@@ -136,6 +136,13 @@ export interface SpvVaultContract<
      */
     getFronterAddress(owner: string, vaultId: bigint, withdrawal: WithdrawalTX): Promise<string | null>;
 
+    /**
+     * Returns the parties which currently fronted the withdrawal transactions
+     *
+     * @param withdrawals withdrawals to query
+     */
+    getFronterAddresses(withdrawals: {owner: string, vaultId: bigint, withdrawal: WithdrawalTX}[]): Promise<{[btcTxId: string]: string | null}>;
+
     /**
      * Returns current vault data
      *
@@ -144,6 +151,28 @@ export interface SpvVaultContract<
      */
     getVaultData(owner: string, vaultId: bigint): Promise<Data>;
 
+    /**
+     * Returns current vault data for multiple vaults
+     *
+     * @param vaults Vault data to query
+     */
+    getMultipleVaultData(vaults: {owner: string, vaultId: bigint}[]): Promise<{[owner: string]: {[vaultId: string]: Data}}>;
+
+    /**
+     * Returns the latest utxo of a vault (or null if vault closed or not found)
+     *
+     * @param owner Owner of the vault
+     * @param vaultId Vault ID
+     */
+    getVaultLatestUtxo(owner: string, vaultId: bigint): Promise<string | null>;
+
+    /**
+     * Returns the latest utxos of for multiple vaults (or null if vault closed or not found)
+     *
+     * @param vaults Vault data to query
+     */
+    getVaultLatestUtxos(vaults: {owner: string, vaultId: bigint}[]): Promise<{[owner: string]: {[vaultId: string]: string | null}}>;
+
     /**
      * Returns all currently opened vaults
      * NOTE: This will take a long time, since the implementation will have to go through all the prior events
@@ -157,6 +186,13 @@ export interface SpvVaultContract<
      */
     getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
 
+    /**
+     * Returns current state of the withdrawals as specified by the bitcoin transaction IDs
+     *
+     * @param btcTxIds
+     */
+    getWithdrawalStates(btcTxIds: string[]): Promise<{[btcTxId: string]: SpvWithdrawalState}>;
+
     /**
      * Parses withdrawal data from the parsed bitcoin transaction
      *

package/src/swaps/SwapContract.ts

@@ -238,6 +238,13 @@ export interface SwapContract<
      */
     getCommitStatus(signer: string, swapData: T): Promise<SwapCommitState>;
 
+    /**
+     * Returns the full status of the passed swaps, expiry is handled by the isExpired function so also requires a signer/sender
+     *
+     * @param request
+     */
+    getCommitStatuses(request: {signer: string, swapData: T}[]): Promise<{[escrowHash: string]: SwapCommitState}>;
+
     /**
      * Checks whether a given swap is refundable by us, i.e. it is already expired, we are offerer & swap is committed on-chain
      *