@gardenfi/core 0.3.0-beta.2 → 0.3.0-beta.21

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

@@ -1,38 +1,36 @@
 import { ISecretManager } from './../secretManager/secretManager.types';
 import { AsyncResult } from '@catalogfi/utils';
-import { GardenEvents, IGardenJS, SwapParams } from './garden.types';
-import { MatchedOrder } from '@gardenfi/orderbook';
-import { IAuth } from '@gardenfi/utils';
+import { GardenEvents, GardenProps, IGardenJS, SwapParams } from './garden.types';
+import { IOrderbook, MatchedOrder } from '@gardenfi/orderbook';
+import { EventBroker } from '@gardenfi/utils';
 import { IQuote } from '../quote/quote.types';
-import { WalletClient } from 'viem';
 import { IBitcoinWallet } from '@catalogfi/wallets';
-import { IBlockNumberFetcher } from './blockNumber';
+import { IBlockNumberFetcher } from '../blockNumberFetcher/blockNumber';
+import { IEVMRelay } from '../evm/relay/evmRelay.types';
 
-export declare class Garden implements IGardenJS {
-    private secretManager;
-    private readonly eventListeners;
-    private orderBook;
-    private quote;
+export declare class Garden extends EventBroker<GardenEvents> implements IGardenJS {
+    private environment;
+    private _secretManager;
+    private _orderBook;
+    private _quote;
     private getOrderThreshold;
-    private orderbookUrl;
-    private auth;
-    private useRelay;
-    private wallets;
-    private evmAddress;
+    private _orderbookUrl;
+    private _auth;
     private orderExecutorCache;
-    private blockNumberFetcher;
-    constructor(config: {
-        orderbookURl: string;
-        secretManager: ISecretManager;
-        quote: IQuote;
-        auth: IAuth;
-        wallets: {
-            evmWallet: WalletClient;
-            btcWallet?: IBitcoinWallet;
-        };
-        blockNumberFetcher?: IBlockNumberFetcher;
-    });
-    setUseRelay(useRelay: boolean): void;
+    private _blockNumberFetcher;
+    private refundSacpCache;
+    private _evmRelay;
+    private _evmWallet;
+    private _btcWallet;
+    constructor(config: GardenProps);
+    get orderbookUrl(): string;
+    get evmRelay(): IEVMRelay;
+    get quote(): IQuote;
+    get btcWallet(): IBitcoinWallet | undefined;
+    get orderbook(): IOrderbook;
+    get blockNumberFetcher(): IBlockNumberFetcher;
+    get secretManager(): ISecretManager;
+    private initializeSMandBTCWallet;
     swap(params: SwapParams): AsyncResult<MatchedOrder, string>;
     private validateAndFillParams;
     private getAddresses;
@@ -43,9 +41,7 @@ export declare class Garden implements IGardenJS {
     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 postRefundSACP;
     private fetchCurrentBlockNumbers;
-    private assignOrderStatus;
+    private filterExpiredAndAssignStatus;
 }

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

@@ -1,6 +1,13 @@
 import { AsyncResult } from '@catalogfi/utils';
-import { Asset, MatchedOrder } from '@gardenfi/orderbook';
+import { Asset, IOrderbook, MatchedOrder } from '@gardenfi/orderbook';
 import { OrderStatus } from '../status';
+import { Environment, EventBroker, SiweOpts } from '@gardenfi/utils';
+import { WalletClient } from 'viem';
+import { ISecretManager } from '../secretManager/secretManager.types';
+import { IQuote } from '../quote/quote.types';
+import { IBlockNumberFetcher } from '../blockNumberFetcher/blockNumber';
+import { IEVMRelay } from '../evm/relay/evmRelay.types';
+import { IBitcoinWallet } from '@catalogfi/wallets';
 
 export type SwapParams = {
     /**
@@ -55,20 +62,56 @@ export type GardenEvents = {
     log: (id: string, message: string) => void;
 };
 export type EventCallback = (...args: any[]) => void;
-export interface IGardenJS {
+/**
+ * Interface representing the GardenJS library.
+ */
+export interface IGardenJS extends EventBroker<GardenEvents> {
     /**
      * Create Order
-     * @param {SwapParams} - The parameters for creating the order.
+     * @param {SwapParams} params - The parameters for creating the order.
+     * @returns {AsyncResult<MatchedOrder, string>} The result of the swap operation.
      */
     swap(params: SwapParams): AsyncResult<MatchedOrder, string>;
     /**
-     * Subscribe to orders. This will poll the orderbook and call callback for each order.
-     * @param cb - Callback function to be called for each order. This callback will take orderExecutor as an argument.
-     * @param interval - Polling interval in milliseconds.
+     * Execute an action.
+     * @returns {Promise<() => void>} A promise that resolves to a function to cancel the execution.
      */
     execute(): Promise<() => void>;
-    on<E extends keyof GardenEvents>(event: E, cb: GardenEvents[E]): void;
-    off<E extends keyof GardenEvents>(event: E, cb: GardenEvents[E]): void;
+    /**
+     * The URL of the orderbook.
+     * @readonly
+     */
+    get orderbookUrl(): string;
+    /**
+     * The EVM relay.
+     * @readonly
+     */
+    get evmRelay(): IEVMRelay;
+    /**
+     * The current quote.
+     * @readonly
+     */
+    get quote(): IQuote;
+    /**
+     * The BTC wallet.
+     * @readonly
+     */
+    get btcWallet(): IBitcoinWallet | undefined;
+    /**
+     * The orderbook.
+     * @readonly
+     */
+    get orderbook(): IOrderbook;
+    /**
+     * The block number fetcher.
+     * @readonly
+     */
+    get blockNumberFetcher(): IBlockNumberFetcher;
+    /**
+     * The secret manager.
+     * @readonly
+     */
+    get secretManager(): ISecretManager;
 }
 export type OrderCacheValue = {
     txHash: string;
@@ -80,6 +123,15 @@ export interface IOrderExecutorCache {
     get(order: MatchedOrder, action: OrderActions): OrderCacheValue | null;
     remove(order: MatchedOrder, action: OrderActions): void;
 }
+export type GardenProps = {
+    environment: Environment;
+    evmWallet: WalletClient;
+    secretManager?: ISecretManager;
+    siweOpts?: SiweOpts;
+    orderbookURl?: string;
+    quote?: IQuote;
+    blockNumberFetcher?: IBlockNumberFetcher;
+};
 /**
  * Actions that can be performed on the order.
  */

package/dist/src/lib/{garden/orderStatusParser.d.ts → orderStatusParser.d.ts}

@@ -1,6 +1,6 @@
 import { MatchedOrder, Swap } from '@gardenfi/orderbook';
-import { OrderActions } from './garden.types';
-import { OrderStatus, SwapStatus } from '../status';
+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
@@ -34,3 +34,4 @@ export declare const parseAction: (order: MatchedOrder, sourceChainCurrentBlockN
 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/secretManager/secretManager.d.ts

@@ -1,15 +1,20 @@
 import { WalletClient } from 'viem';
-import { ISecretManager } from './secretManager.types';
+import { EventBroker } from '@gardenfi/utils';
+import { ISecretManager, SecretManagerEvents } from './secretManager.types';
 
-export declare class SecretManager implements ISecretManager {
-    private privKey;
+export declare class SecretManager extends EventBroker<SecretManagerEvents> implements ISecretManager {
+    private privKey?;
+    private walletClient?;
+    get isInitialized(): boolean;
     private constructor();
     static fromPrivKey(privKey: string): SecretManager;
-    static fromWalletClient(walletClient: WalletClient): Promise<import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<SecretManager, never>>;
-    getMasterPrivKey(): string;
-    generateSecret(nonce: number): import('@catalogfi/utils').Result<{
+    static fromWalletClient(walletClient: WalletClient): SecretManager;
+    initialize(): Promise<import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<string, never>>;
+    private derivePrivKeyFromWalletClient;
+    getMasterPrivKey(): Promise<import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<string, never>>;
+    generateSecret(nonce: number): Promise<import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<{
         secret: `0x${string}`;
         secretHash: `0x${string}`;
-    }, never>;
+    }, never>>;
     private signMessage;
 }

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

@@ -1,4 +1,5 @@
-import { Result } from '@catalogfi/utils';
+import { AsyncResult } from '@catalogfi/utils';
+import { EventBroker } from '@gardenfi/utils';
 
 export type Secret = {
     secretHash: string;
@@ -9,18 +10,31 @@ export type Secret = {
  * This interface is used to generate and retrieve secrets and secretHashes.
  * The secret is generated by hashing the signature and the secretHash is generated by hashing the secret.
  */
-export interface ISecretManager {
+export interface ISecretManager extends EventBroker<SecretManagerEvents> {
+    /**
+     * Initializes the SecretManager with the wallet client.
+     */
+    initialize: () => AsyncResult<string, string>;
     /**
      * Generates a new master private key.
      * If the master private key already exists, it will return the existing master private key.
      * Else, it will generate a new master private key by hashing a signature generated by signing a message with the wallet client.
      * @returns Master private key
      */
-    getMasterPrivKey: () => string;
+    getMasterPrivKey: () => AsyncResult<string, string>;
     /**
      * Generates secret and secretHash by signing the nonce. Secret is generated by hashing the signature and secretHash is generated by hashing the secret.
      * @param nonce
      * @returns {AsyncResult<Secret, string>} secret,secretHash
      */
-    generateSecret: (nonce: number) => Result<Secret, string>;
+    generateSecret: (nonce: number) => AsyncResult<Secret, string>;
+    /**
+     * Checks if the SecretManager is initialized with a private key.
+     * @returns boolean
+     */
+    readonly isInitialized: boolean;
 }
+export type SecretManagerEvents = {
+    error: (error: string) => void;
+    initialized: (init: boolean) => void;
+};

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

@@ -0,0 +1,53 @@
+import { Chain as viemChain } from 'viem/chains';
+import { Chain, EvmChain } from '@gardenfi/orderbook';
+import { WalletClient } from 'viem';
+import { AsyncResult } from '@catalogfi/utils';
+
+export declare const citreaTestnet: {
+    blockExplorers: {
+        readonly default: {
+            readonly name: "Citrea Explorer";
+            readonly url: "https://explorer.testnet.citrea.xyz";
+            readonly apiUrl: "https://explorer.testnet.citrea.xyz/api/v2/";
+        };
+    };
+    contracts?: import('viem').Prettify<{
+        [key: string]: import('viem').ChainContract | {
+            [sourceId: number]: import('viem').ChainContract | undefined;
+        } | undefined;
+    } & {
+        ensRegistry?: import('viem').ChainContract | undefined;
+        ensUniversalResolver?: import('viem').ChainContract | undefined;
+        multicall3?: import('viem').ChainContract | undefined;
+        universalSignatureVerifier?: import('viem').ChainContract | undefined;
+    }> | undefined;
+    id: 5115;
+    name: "Citrea Testnet";
+    nativeCurrency: {
+        readonly name: "";
+        readonly symbol: "cBTC";
+        readonly decimals: 18;
+    };
+    rpcUrls: {
+        readonly default: {
+            readonly http: readonly ["https://rpc.testnet.citrea.xyz"];
+        };
+    };
+    sourceId?: number | undefined;
+    testnet: true;
+    custom?: Record<string, unknown> | undefined;
+    fees?: import('viem').ChainFees<undefined> | undefined;
+    formatters?: undefined;
+    serializers?: import('viem').ChainSerializers<undefined, import('viem').TransactionSerializable> | undefined;
+};
+export declare const evmToViemChainMap: Record<EvmChain, viemChain>;
+/**
+ * Switches or adds a network to the wallet
+ * @param chain Garden supported chain
+ * @param walletClient
+ * @returns new walletClient with updated chain
+ */
+export declare const switchOrAddNetwork: (chain: Chain, walletClient: WalletClient) => AsyncResult<{
+    message: string;
+    walletClient: WalletClient;
+}, string>;

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

@@ -1,8 +1,6 @@
-import { Chain as viemChain } from 'viem/chains';
-import { IBaseWallet } from '@catalogfi/wallets';
-import { Chain, EvmChain, NetworkType } from '@gardenfi/orderbook';
-import { WalletClient } from 'viem';
-import { AsyncResult } from '@catalogfi/utils';
+import { BitcoinNetwork, IBaseWallet } from '@catalogfi/wallets';
+import { Environment } from '@gardenfi/utils';
+import { Chain, NetworkType } from '@gardenfi/orderbook';
 
 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";
@@ -22,16 +20,6 @@ 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 evmToViemChainMap: Record<EvmChain, viemChain>;
-/**
- * Switches or adds a network to the wallet
- * @param chain Garden supported chain
- * @param walletClient
- * @returns new walletClient with updated chain
- */
-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;
+export declare const getBitcoinNetwork: (network: Environment) => BitcoinNetwork;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gardenfi/core",
-  "version": "0.3.0-beta.2",
+  "version": "0.3.0-beta.21",
   "type": "module",
   "files": [
     "dist"
@@ -28,8 +28,8 @@
   "dependencies": {
     "@catalogfi/utils": "^0.1.6",
     "@catalogfi/wallets": "^0.2.51",
-    "@gardenfi/orderbook": "^0.2.0-beta.34",
-    "@gardenfi/utils": "^0.0.1-beta.18",
+    "@gardenfi/orderbook": "^0.2.0-beta.44",
+    "@gardenfi/utils": "^0.0.1-beta.22",
     "bignumber.js": "^9.1.2",
     "bitcoinjs-lib": "^6.1.6",
     "tiny-secp256k1": "^2.2.3",