@atomiqlabs/base 10.0.0-dev.9 → 12.0.0

package/dist/chains/ChainInterface.d.ts

@@ -4,9 +4,13 @@ export type TransactionConfirmationOptions = {
     feeRate?: string;
 };
 export type AbstractSigner = {
+    type: "AtomiqAbstractSigner";
     getAddress: () => string;
+    init?: () => Promise<void>;
+    stop?: () => Promise<void>;
 };
-export interface ChainInterface<TX = any, Signer extends AbstractSigner = AbstractSigner, ChainId extends string = string> {
+export declare function isAbstractSigner(val: any): val is AbstractSigner;
+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
@@ -23,8 +27,15 @@ export interface ChainInterface<TX = any, Signer extends AbstractSigner = Abstra
      * Checks if a given string is a valid wallet address
      *
      * @param address
+     * @param lenient Whether a lenient parsing should be used (i.e. don't strictly enforce the Starknet address lengths)
      */
-    isValidAddress(address: string): boolean;
+    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
      *
@@ -75,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
      *
@@ -107,4 +126,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): Promise<Signer>;
 }

package/dist/chains/ChainInterface.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAbstractSigner = void 0;
+function isAbstractSigner(val) {
+    return typeof (val) === "object" && val.type === "AtomiqAbstractSigner" && typeof (val.getAddress) === "function";
+}
+exports.isAbstractSigner = isAbstractSigner;

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/errors/TransactionRevertedError.d.ts

@@ -0,0 +1,3 @@
+export declare class TransactionRevertedError extends Error {
+    constructor(msg: string);
+}

package/dist/errors/TransactionRevertedError.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionRevertedError = void 0;
+class TransactionRevertedError extends Error {
+    constructor(msg) {
+        super(msg);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, TransactionRevertedError.prototype);
+    }
+}
+exports.TransactionRevertedError = TransactionRevertedError;

package/dist/index.d.ts

@@ -20,6 +20,7 @@ export * from "./swaps/SwapCommitState";
 export * from "./errors/SignatureVerificationError";
 export * from "./errors/CannotInitializeATAError";
 export * from "./errors/SwapDataVerificationError";
+export * from "./errors/TransactionRevertedError";
 export * from "./chains/ChainType";
 export * from "./chains/ChainData";
 export * from "./utils/BigIntBufferUtils";

package/dist/index.js

@@ -36,6 +36,7 @@ __exportStar(require("./swaps/SwapCommitState"), exports);
 __exportStar(require("./errors/SignatureVerificationError"), exports);
 __exportStar(require("./errors/CannotInitializeATAError"), exports);
 __exportStar(require("./errors/SwapDataVerificationError"), exports);
+__exportStar(require("./errors/TransactionRevertedError"), exports);
 __exportStar(require("./chains/ChainType"), exports);
 __exportStar(require("./chains/ChainData"), exports);
 __exportStar(require("./utils/BigIntBufferUtils"), exports);

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,17 +130,64 @@ 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
      */
     getAllVaults(owner?: string): Promise<Data[]>;
     /**
-     * Returns current state of the withdrawal as specified by the bitcoin transaction ID
+     * Returns current state of the withdrawal, optionally
+     *  only check withdrawals from the provided block height
+     *
+     * @param withdrawalTx
+     * @param scStartBlockheight
+     */
+    getWithdrawalState(withdrawalTx: WithdrawalTX, scStartBlockheight?: number): Promise<SpvWithdrawalState>;
+    /**
+     * Returns current state of the withdrawals, optionally
+     *  only check withdrawals from the provided block height
      *
-     * @param btcTxId
+     * @param withdrawalTxs Object with the withdrawal tx to check + an optional start blockheight
      */
-    getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
+    getWithdrawalStates(withdrawalTxs: {
+        withdrawal: WithdrawalTX;
+        scStartBlockheight?: number;
+    }[]): 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.9",
+  "version": "12.0.0",
   "description": "Base classes and interfaces for atomiq protocol",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",

package/src/chains/ChainInterface.ts

@@ -5,13 +5,21 @@ export type TransactionConfirmationOptions = {
 };
 
 export type AbstractSigner = {
-    getAddress: () => string
+    type: "AtomiqAbstractSigner",
+    getAddress: () => string,
+    init?: () => Promise<void>,
+    stop?: () => Promise<void>
 };
 
+export function isAbstractSigner(val: any): val is AbstractSigner {
+    return typeof(val)==="object" && val.type==="AtomiqAbstractSigner" && typeof(val.getAddress)==="function";
+}
+
 export interface ChainInterface<
     TX = any,
     Signer extends AbstractSigner = AbstractSigner,
-    ChainId extends string = string
+    ChainId extends string = string,
+    NativeSigner = any
 > {
 
     readonly chainId: ChainId;
@@ -33,8 +41,16 @@ export interface ChainInterface<
      * Checks if a given string is a valid wallet address
      *
      * @param address
+     * @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
      */
-    isValidAddress(address: string): boolean;
+    normalizeAddress(address: string): string;
 
     /**
      * Checks if a given string is a valid token identifier
@@ -93,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
      *
@@ -130,4 +152,9 @@ export interface ChainInterface<
      */
     randomSigner(): Signer;
 
+    /**
+     * Wraps a native chain signer object to an atomiq-understandable AbstractSigner
+     */
+    wrapSigner(signer: NativeSigner): Promise<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/errors/TransactionRevertedError.ts

@@ -0,0 +1,11 @@
+
+export class TransactionRevertedError extends Error {
+
+    constructor(msg: string) {
+        super(msg);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, TransactionRevertedError.prototype);
+    }
+
+}
+

package/src/index.ts

@@ -21,6 +21,7 @@ export * from "./swaps/SwapCommitState";
 export * from "./errors/SignatureVerificationError";
 export * from "./errors/CannotInitializeATAError"
 export * from "./errors/SwapDataVerificationError";
+export * from "./errors/TransactionRevertedError";
 
 export * from "./chains/ChainType";
 export * from "./chains/ChainData";

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
@@ -151,11 +180,21 @@ 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, optionally
+     *  only check withdrawals from the provided block height
+     *
+     * @param withdrawalTx
+     * @param scStartBlockheight
+     */
+    getWithdrawalState(withdrawalTx: WithdrawalTX, scStartBlockheight?: number): Promise<SpvWithdrawalState>;
+
+    /**
+     * Returns current state of the withdrawals, optionally
+     *  only check withdrawals from the provided block height
      *
-     * @param btcTxId
+     * @param withdrawalTxs Object with the withdrawal tx to check + an optional start blockheight
      */
-    getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState>;
+    getWithdrawalStates(withdrawalTxs: {withdrawal: WithdrawalTX, scStartBlockheight?: number}[]): 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
      *

package/dist/messaging/EventMessaging.d.ts

@@ -1,8 +0,0 @@
-import { Message } from "./messages/Message";
-export interface EventMessaging {
-    init(): Promise<void>;
-    broadcast(msg: Message): Promise<void>;
-    subscribe(callback: (msg: Message) => void): Promise<void>;
-    unsubscribe(callback: (msg: Message) => void): Promise<boolean>;
-    stop(): Promise<void>;
-}

package/dist/messaging/EventMessaging.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });