@gardenfi/core 0.2.0-beta.9 → 0.2.0-beta.90

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

@@ -6,6 +6,7 @@ import { IAuth } from '@gardenfi/utils';
 import { IQuote } from '../quote/quote.types';
 import { WalletClient } from 'viem';
 import { IBitcoinWallet } from '@catalogfi/wallets';
+import { IBlockNumberFetcher } from './blockNumber';
 
 export declare class Garden implements IGardenJS {
     private secretManager;
@@ -13,13 +14,13 @@ export declare class Garden implements IGardenJS {
     private orderBook;
     private quote;
     private getOrderThreshold;
-    private pendingOrdersCount;
     private orderbookUrl;
     private auth;
     private useRelay;
     private wallets;
     private evmAddress;
-    private store;
+    private orderExecutorCache;
+    private blockNumberFetcher;
     constructor(config: {
         orderbookURl: string;
         secretManager: ISecretManager;
@@ -29,19 +30,22 @@ export declare class Garden implements IGardenJS {
             evmWallet: WalletClient;
             btcWallet?: IBitcoinWallet;
         };
+        blockNumberFetcher?: IBlockNumberFetcher;
     });
-    getPendingOrderCount(): number;
     setUseRelay(useRelay: boolean): void;
     swap(params: SwapParams): AsyncResult<MatchedOrder, string>;
     private validateAndFillParams;
     private getAddresses;
     private validateAmount;
-    private getTimelock;
     private pollOrder;
-    private emit;
     execute(interval?: number): Promise<() => void>;
+    private evmRedeem;
+    private btcRedeem;
+    private btcRefund;
     private getWallet;
+    private emit;
     on<E extends keyof GardenEvents>(event: E, cb: GardenEvents[E]): void;
     off<E extends keyof GardenEvents>(event: E, cb: GardenEvents[E]): void;
     private fetchCurrentBlockNumbers;
+    private assignOrderStatus;
 }

package/dist/src/lib/garden/garden.types.d.ts

@@ -1,5 +1,6 @@
 import { AsyncResult } from '@catalogfi/utils';
 import { Asset, MatchedOrder } from '@gardenfi/orderbook';
+import { OrderStatus } from '../status';
 
 export type SwapParams = {
     /**
@@ -26,6 +27,10 @@ export type SwapParams = {
      * This will wait for the specified number of confirmations before redeeming the funds.
      */
     minDestinationConfirmations?: number;
+    /**
+     * Unique nonce for generating secret and secret hashes. If not provided, it will be generated as the total order count until now + 1.
+     */
+    nonce?: number;
     /**
      * Additional data for the order.
      */
@@ -40,14 +45,14 @@ export type SwapParams = {
         btcAddress?: string;
     };
 };
-export declare enum TimeLocks {
-    evm = 14400,
-    btc = 288
-}
+export type OrderWithStatus = MatchedOrder & {
+    status: OrderStatus;
+};
 export type GardenEvents = {
     error: (order: MatchedOrder, error: string) => void;
     success: (order: MatchedOrder, action: OrderActions, result: string) => void;
-    onPendingOrdersChanged: (orders: MatchedOrder[]) => void;
+    onPendingOrdersChanged: (orders: OrderWithStatus[]) => void;
+    log: (id: string, message: string) => void;
 };
 export type EventCallback = (...args: any[]) => void;
 export interface IGardenJS {
@@ -62,18 +67,18 @@ export interface IGardenJS {
      * @param interval - Polling interval in milliseconds.
      */
     execute(): Promise<() => void>;
-    getPendingOrderCount(): number;
     on<E extends keyof GardenEvents>(event: E, cb: GardenEvents[E]): void;
+    off<E extends keyof GardenEvents>(event: E, cb: GardenEvents[E]): void;
 }
 export type OrderCacheValue = {
     txHash: string;
     timeStamp: number;
+    btcRedeemUTXO?: string;
 };
-export interface IOrderCache {
-    getOrder(): MatchedOrder;
-    set(action: OrderActions, txHash: string): void;
-    get(action: OrderActions): OrderCacheValue | null;
-    remove(action: OrderActions): void;
+export interface IOrderExecutorCache {
+    set(order: MatchedOrder, action: OrderActions, txHash: string, utxo?: string): void;
+    get(order: MatchedOrder, action: OrderActions): OrderCacheValue | null;
+    remove(order: MatchedOrder, action: OrderActions): void;
 }
 /**
  * Actions that can be performed on the order.

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

@@ -26,3 +26,11 @@ export declare const ParseSwapStatus: (swap: Swap, currentBlockNumber: number) =
  * @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[];

package/dist/src/lib/quote/quote.d.ts

@@ -1,5 +1,5 @@
 import { AsyncResult } from '@catalogfi/utils';
-import { IQuote, QuoteResponse } from './quote.types';
+import { IQuote, QuoteResponse, Strategies } from './quote.types';
 import { CreateOrderRequestWithAdditionalData, CreateOrderReqWithStrategyId } from '@gardenfi/orderbook';
 
 export declare class Quote implements IQuote {
@@ -7,4 +7,5 @@ export declare class Quote implements IQuote {
     constructor(quoteUrl: string);
     getQuote(orderpair: string, amount: number, isExactOut?: boolean): Promise<import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<QuoteResponse, never>>;
     getAttestedQuote(order: CreateOrderReqWithStrategyId): AsyncResult<CreateOrderRequestWithAdditionalData, string>;
+    getStrategies(): Promise<import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<Strategies, never>>;
 }

package/dist/src/lib/quote/quote.types.d.ts

@@ -1,5 +1,6 @@
 import { AsyncResult } from '@catalogfi/utils';
-import { CreateOrderRequestWithAdditionalData, CreateOrderReqWithStrategyId } from '@gardenfi/orderbook';
+import { Chain, CreateOrderRequestWithAdditionalData, CreateOrderReqWithStrategyId } from '@gardenfi/orderbook';
+import { APIResponse } from '@gardenfi/utils';
 
 export interface IQuote {
     /**
@@ -19,6 +20,11 @@ export interface IQuote {
      * @returns {string} The attestation signature
      */
     getAttestedQuote(order: CreateOrderReqWithStrategyId): AsyncResult<CreateOrderRequestWithAdditionalData, string>;
+    /**
+     * Get the strategies available for quoting
+     * @returns {Strategies} The strategies available
+     */
+    getStrategies(): AsyncResult<Strategies, string>;
 }
 export type QuoteResponse = {
     quotes: {
@@ -27,3 +33,29 @@ export type QuoteResponse = {
     input_token_price: number;
     output_token_price: number;
 };
+export type Strategies = Record<string, {
+    id: string;
+    minAmount: string;
+    maxAmount: string;
+    fee: number;
+}>;
+export type StrategiesResponse = APIResponse<{
+    [strategy: string]: {
+        id: string;
+        min_amount: string;
+        max_amount: string;
+        fee: number;
+        source_chain: Chain;
+        dest_chain: Chain;
+        source_asset: {
+            asset: string;
+            token_id: string;
+            decimals: number;
+        };
+        dest_asset: {
+            asset: string;
+            token_id: string;
+            decimals: number;
+        };
+    };
+}>;

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

@@ -85,11 +85,13 @@ export declare enum OrderStatus {
     CounterPartyRefunded = "CounterPartyRefunded",
     /**
      * - Order is cancelled
-     * - There are some cases where the order is cancelled:
-     *   1) Not matched within 1 hour.
-     *   2) Both parties refund.
      */
-    Cancelled = "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 {
     /**

package/dist/src/lib/utils.d.ts

@@ -1,7 +1,8 @@
 import { Chain as viemChain } from 'viem/chains';
 import { IBaseWallet } from '@catalogfi/wallets';
-import { Chain, EvmChain } from '@gardenfi/orderbook';
+import { Chain, EvmChain, NetworkType } from '@gardenfi/orderbook';
 import { WalletClient } from 'viem';
+import { AsyncResult } from '@catalogfi/utils';
 
 export declare const computeSecret: (fromChain: Chain, toChain: Chain, wallets: Partial<Record<Chain, IBaseWallet>>, nonce: number) => Promise<string>;
 export declare const isFromChainBitcoin: (chain: Chain) => chain is "bitcoin" | "bitcoin_testnet" | "bitcoin_regtest";
@@ -11,21 +12,26 @@ export declare const isFromChainBitcoin: (chain: Chain) => chain is "bitcoin" |
 export declare function xOnlyPubkey(pubkey: Buffer | string): Buffer;
 export declare function assert(condition: boolean, message: string): void;
 /**
- * concats the leaf version, the length of the script, and the script itself
+ * concat the leaf version, the length of the script, and the script itself
  */
 export declare function serializeScript(leafScript: Buffer): Buffer;
 /**
- * concats the length of the script and the script itself
+ * concat the length of the script and the script itself
  */
 export declare function prefixScriptLength(s: Buffer): Buffer;
 export declare function sortLeaves(leaf1: Buffer, leaf2: Buffer): Buffer[];
 export declare const toXOnly: (pubKey: string) => string;
 export declare const isValidBitcoinPubKey: (pubKey: string) => boolean;
-export declare const ChainToID: Record<EvmChain, viemChain>;
+export declare const evmToViemChainMap: Record<EvmChain, viemChain>;
 /**
  * Switches or adds a network to the wallet
  * @param chain Garden supported chain
  * @param walletClient
- * @returns
+ * @returns new walletClient with updated chain
  */
-export declare const switchOrAddNetwork: (chain: Chain, walletClient: WalletClient) => Promise<import('@catalogfi/utils').Result<string, never> | import('@catalogfi/utils').Result<never, string>>;
+export declare const switchOrAddNetwork: (chain: Chain, walletClient: WalletClient) => AsyncResult<{
+    message: string;
+    walletClient: WalletClient;
+}, string>;
+export declare const constructOrderPair: (sourceChain: Chain, sourceAsset: string, destChain: Chain, destAsset: string) => string;
+export declare function validateBTCAddress(address: string, networkType: NetworkType): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gardenfi/core",
-  "version": "0.2.0-beta.9",
+  "version": "0.2.0-beta.90",
   "type": "module",
   "files": [
     "dist"
@@ -27,8 +27,10 @@
   },
   "dependencies": {
     "@catalogfi/utils": "^0.1.6",
-    "@catalogfi/wallets": "^0.2.50",
-    "@gardenfi/orderbook": "^0.2.0-beta.9",
+    "@catalogfi/wallets": "^0.2.51",
+    "@gardenfi/orderbook": "^0.2.0-beta.27",
+    "@gardenfi/utils": "^0.0.1-beta.18",
+    "bignumber.js": "^9.1.2",
     "bitcoinjs-lib": "^6.1.6",
     "tiny-secp256k1": "^2.2.3",
     "varuint-bitcoin": "^1.1.2",

package/dist/src/lib/garden/orderCache.d.ts

@@ -1,13 +0,0 @@
-import { MatchedOrder } from '@gardenfi/orderbook';
-import { IStore } from '@gardenfi/utils';
-import { IOrderCache, OrderActions, OrderCacheValue } from './garden.types';
-
-export declare class OrderCache implements IOrderCache {
-    private order;
-    private store;
-    constructor(order: MatchedOrder, store: IStore);
-    getOrder(): MatchedOrder;
-    set(action: OrderActions, txHash: string): void;
-    get(action: OrderActions): OrderCacheValue | null;
-    remove(action: OrderActions): void;
-}