@gardenfi/core 2.5.3 → 3.0.0

package/dist/src/lib/bitcoin/htlc.d.ts

@@ -1,106 +0,0 @@
-import { IHTLCWallet } from '../htlc.interface';
-import { IBitcoinWallet } from './wallet/wallet.interface';
-
-export declare enum Leaf {
-    REFUND = 0,
-    REDEEM = 1,
-    INSTANT_REFUND = 2
-}
-export declare class GardenHTLC implements IHTLCWallet {
-    /**
-     * Signer of the HTLC can be either the initiator or the redeemer
-     */
-    private signer;
-    private secretHash;
-    /**
-     * redeemer's x-only public key without 02 or 03 prefix
-     */
-    private redeemerPubkey;
-    /**
-     * initiator's x-only public key without 02 or 03 prefix
-     */
-    private initiatorPubkey;
-    private expiry;
-    /**
-     * NUMS internal key which blocks key path spending
-     */
-    private internalPubkey;
-    private network;
-    private initiateAmount;
-    private utxoHashes?;
-    /**
-     * Note: redeemerAddress and initiatorAddress should be x-only public key without 02 or 03 prefix
-     */
-    private constructor();
-    /**
-     * Creates a GardenHTLC instance
-     * @param signer Bitcoin wallet of the initiator or redeemer
-     * @param secretHash 32 bytes secret hash
-     * @param initiatorPubkey initiator's x-only public key without 02 or 03 prefix
-     * @param redeemerPubkey redeemer's x-only public key without 02 or 03 prefix
-     * @param expiry block height after which the funds can be refunded
-     * @returns GardenHTLC instance
-     *
-     *
-     * Note: When the signer is the initiator, only refund and instant refund can be done
-     * When the signer is the redeemer, only redeem can be done
-     */
-    static from(signer: IBitcoinWallet, initiateAmount: number, secretHash: string, initiatorPubkey: string, redeemerPubkey: string, expiry: number, utxoHashes?: string[]): Promise<GardenHTLC>;
-    /**
-     * Generates a taproot address for receiving the funds
-     */
-    address(): string;
-    /**
-     * returns the address of the HTLC
-     */
-    id(): string;
-    private _buildRawTx;
-    /**
-     * prevout script for the gardenHTLC address
-     */
-    private getOutputScript;
-    init(fee?: number): Promise<string>;
-    generateRedeemSACP(secret: string, receiver: string, fee?: number): Promise<string>;
-    generateInstantRefundSACP(receiver: string): Promise<string>;
-    generateInstantRefundSACPWithHash(hash: string[]): Promise<string[]>;
-    /**
-     * Instantly refunds the funds to the initiator given the counterparty's signatures and pubkey
-     *
-     * Note: If there are multiple UTXOs being spend, there should be a signature for each UTXO in counterPartySigs
-     */
-    instantRefund(counterPartySigs: {
-        utxo: string;
-        sig: string;
-    }[], fee?: number): Promise<string>;
-    /**
-     * Reveals the secret and redeems the HTLC
-     */
-    redeem(secret: string, receiver?: string): Promise<string>;
-    getRedeemHex(secret: string, receiver?: string): Promise<string>;
-    /**
-     * Refunds the funds back to the initiator if the expiry block height + 1 is reached
-     */
-    refund(receiver?: string, fee?: number): Promise<string>;
-    /**
-     * Given a list of UTXOs, checks if the HTLC can be refunded
-     */
-    private canRefund;
-    /**
-     * Given a leaf, generates the control block necessary for spending the leaf
-     */
-    private generateControlBlockFor;
-    /**
-     * Generates the hash of the leaf script
-     * @param leaf Use leaf enum or pass 0 for refund, 1 for redeem, 2 for instant refund
-     * @returns hash of the leaf script
-     */
-    leafHash(leaf: Leaf): Buffer;
-    private refundLeaf;
-    private redeemLeaf;
-    private instantRefundLeaf;
-    private leaves;
-    /**
-     * Generates the merkle proof for the leaf script
-     */
-    private generateMerkleProofFor;
-}

package/dist/src/lib/blockNumberFetcher/blockNumber.d.ts

@@ -1,15 +0,0 @@
-import { Chain } from '@gardenfi/orderbook';
-import { Environment, AsyncResult } from '@gardenfi/utils';
-
-type Response = {
-    [key in Chain]: number;
-};
-export interface IBlockNumberFetcher {
-    fetchBlockNumbers(): AsyncResult<Response, string>;
-}
-export declare class BlockNumberFetcher implements IBlockNumberFetcher {
-    private url;
-    constructor(url: string, network: Environment);
-    fetchBlockNumbers(): AsyncResult<Response, string>;
-}
-export {};

package/dist/src/lib/evm/relay/evmRelay.types.d.ts

@@ -1,26 +0,0 @@
-import { MatchedOrder } from '@gardenfi/orderbook';
-import { AsyncResult, IStore } from '@gardenfi/utils';
-import { WalletClient } from 'viem';
-
-export type EVMRelayOpts = {
-    store?: IStore;
-    domain?: string;
-};
-export interface IEVMRelay {
-    /**
-     * Deposits funds to the EVM atomic swap contract using relay service.
-     * Sends the signature to the relay service.
-     * @param order Matched Order
-     * @param currentL1BlockNumber Current L1 block number. Used to calculate the swap expiry.
-     * @NOTE send the current block number of the L1 chain, if the order is on L2 chain (arbitrum).
-     * @returns txHash of Initiation
-     */
-    init(walletClient: WalletClient, order: MatchedOrder): AsyncResult<string, string>;
-    /**
-     * Redeems funds from the EVM atomic swap contract using relay service.
-     * Sends the secret to the relay service.
-     * @param orderId Create order Id of the order
-     * @param secret Secret of the HTLC generated when creating the order
-     */
-    redeem(orderId: string, secret: string): AsyncResult<string, string>;
-}

package/dist/src/lib/garden/cache/executorCache.d.ts

@@ -1,14 +0,0 @@
-import { MatchedOrder } from '@gardenfi/orderbook';
-import { IOrderExecutorCache, OrderActions, OrderCacheValue } from '../garden.types';
-
-export declare class ExecutorCache implements IOrderExecutorCache {
-    private cache;
-    set(order: MatchedOrder, action: OrderActions, txHash: string, utxo?: string): void;
-    get(order: MatchedOrder, action: OrderActions): OrderCacheValue | null;
-    remove(order: MatchedOrder, action: OrderActions): void;
-}
-export declare class Cache<T> {
-    private cache;
-    set(key: string, value: T): void;
-    get(key: string): T | null;
-}

package/dist/src/lib/orderStatus/orderStatusParser.d.ts

@@ -1,37 +0,0 @@
-import { MatchedOrder, Swap } from '@gardenfi/orderbook';
-import { OrderActions } from '../garden/garden.types';
-import { OrderStatus, SwapStatus } from './status';
-
-/**
- * Parse the order status based on the current block number and checks if its expired or initiated or redeemed or refunded
- * @param order Order object
- * @param sourceChainCurrentBlockNumber source chain current block number
- * @param destChainCurrentBlockNumber destination chain current block number
- * @note send the current block number of the L1 chain even if the order is on L2 chain.
- * @returns {OrderStatus} The status of the order
- */
-export declare const ParseOrderStatus: (order: MatchedOrder, sourceChainCurrentBlockNumber: number, destChainCurrentBlockNumber: number) => OrderStatus;
-/**
- * Parse the swap status based on the current block number and checks if its expired or initiated or redeemed or refunded
- * @param swap The swap object
- * @param currentBlockNumber
- */
-export declare const ParseSwapStatus: (swap: Swap, currentBlockNumber: number) => SwapStatus;
-/**
- * Parse the action to be performed on the.
- * @param order Order object
- * @param sourceChainCurrentBlockNumber source chain current block number
- * @param destChainCurrentBlockNumber destination chain current block number
- * @note send the current block number of the L1 chain even if the order is on L2 chain.
- * @returns {OrderActions} The action to be performed on the order
- */
-export declare const parseAction: (order: MatchedOrder, sourceChainCurrentBlockNumber: number, destChainCurrentBlockNumber: number) => OrderActions;
-/**
- * Parse the action to be performed on the order based on the order status.
- * @param status Order status
- * @returns {OrderActions} The action to be performed on the order
- */
-export declare const parseActionFromStatus: (status: OrderStatus) => OrderActions;
-export declare const isExpired: (unixTime: number, tillHours?: number) => boolean;
-export declare const filterDeadlineExpiredOrders: (orders: MatchedOrder[]) => MatchedOrder[];
-export declare const isOrderExpired: (order: MatchedOrder) => boolean;

package/dist/src/lib/orderStatus/status.d.ts

@@ -1,130 +0,0 @@
-/**
- * Order statuses
- */
-export declare enum OrderStatus {
-    /**
-     * - Order is created
-     * - Waiting for match
-     */
-    Created = "Created",
-    /**
-     * - Order is matched
-     * - User has to initiate
-     */
-    Matched = "Matched",
-    /**
-     * - User initiate tx detected on-chain but not confirmed
-     */
-    InitiateDetected = "InitiateDetected",
-    /**
-     * - User initiated
-     * - Waiting for counter party to initiate
-     */
-    Initiated = "Initiated",
-    /**
-     * - Counter party initiate tx detected on-chain but not confirmed
-     */
-    CounterPartyInitiateDetected = "CounterPartyInitiateDetected",
-    /**
-     * - Counter party initiated
-     * - User has to redeem
-     */
-    CounterPartyInitiated = "CounterPartyInitiated",
-    /**
-     * - User redeem tx detected on-chain but not confirmed
-     */
-    RedeemDetected = "RedeemDetected",
-    /**
-     * - User redeemed
-     * - Counter party has to redeem
-     * - We also consider user redemption as completed order.
-     */
-    Redeemed = "Redeemed",
-    /**
-     * - Counter party redeem tx detected on-chain but not confirmed
-     */
-    CounterPartyRedeemDetected = "CounterPartyRedeemDetected",
-    /**
-     * - Counter party redeemed
-     * - Order is completed
-     */
-    CounterPartyRedeemed = "CounterPartyRedeemed",
-    /**
-     * - Counter party redeemed
-     * - Order is completed
-     */
-    Completed = "Completed",
-    /**
-     * - The counterparty's swap has expired, and they will refund their funds.
-     * - The user can no longer redeem the funds. The user must wait for their swap to expire and then refund their funds.
-     * - Typically, in our system, the counterparty's swap expires in 24 hours, and the user's swap expires in 48 hours.
-     */
-    CounterPartySwapExpired = "CounterPartySwapExpired",
-    /**
-     * - The user's swap has expired, and they have to refund their funds.
-     * - The user's expiry only happens after counterparty's expiry.
-     * - Typically, in our system, the counterparty's swap expires in 24 hours, and the user's swap expires in 48 hours.
-     */
-    Expired = "Expired",
-    /**
-     * - User refund tx detected on-chain but not confirmed
-     */
-    RefundDetected = "RefundDetected",
-    /**
-     * - User refunded
-     * - User can only refund if their swap has expired
-     */
-    Refunded = "Refunded",
-    /**
-     * - Counter party refund tx detected on-chain but not confirmed
-     */
-    CounterPartyRefundDetected = "CounterPartyRefundDetected",
-    /**
-     * - Counter party refunded
-     */
-    CounterPartyRefunded = "CounterPartyRefunded",
-    /**
-     * - Order is cancelled
-     */
-    Cancelled = "Cancelled",
-    /**
-     * - DeadLine exceeded
-     * - Initiate not detected before 1 hour of deadline or initiate not confirmed before 12 hours of deadline
-     */
-    DeadLineExceeded = "DeadLineExceeded"
-}
-export declare enum SwapStatus {
-    /**
-     * - Swap is idle
-     */
-    Idle = "Idle",
-    /**
-     * - Initiate tx detected on-chain but not confirmed
-     */
-    InitiateDetected = "InitiateDetected",
-    /**
-     * - Swap is initiated
-     */
-    Initiated = "Initiated",
-    /**
-     * - Redeem tx detected on-chain but not confirmed
-     */
-    RedeemDetected = "RedeemDetected",
-    /**
-     * - Redeemed
-     */
-    Redeemed = "Redeemed",
-    /**
-     * - Refund tx detected on-chain but not confirmed
-     */
-    RefundDetected = "RefundDetected",
-    /**
-     * - Refunded
-     */
-    Refunded = "Refunded",
-    /**
-     * - Swap is expired.
-     * - Should refund.
-     */
-    Expired = "Expired"
-}