@gardenfi/core 2.0.22 → 2.0.23

package/dist/src/lib/evm/htlc.types.d.ts

@@ -0,0 +1,29 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@gardenfi/utils';
+
+export interface IEVMHTLC {
+    /**
+     * Returns the HTLC actor address.
+     * This is the user's wallet address in the case of EVM.
+     */
+    get htlcActorAddress(): string;
+    /**
+     * Initiates the HTLC by sending funds to the HTLC contract.
+     * @param order - The matched order.
+     * @returns A promise resolving to the transaction hash of the initiation.
+     */
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    /**
+     * Redeems funds from the HTLC contract to the actor's address.
+     * @param order - The matched order.
+     * @param secret - The secret required to unlock the htlc.
+     * @returns A promise resolving to the transaction hash of the redemption.
+     */
+    redeem(order: MatchedOrder, secret: string): AsyncResult<string, string>;
+    /**
+     * Refunds funds from the HTLC contract back to the actor's address upon expiration.
+     * @param order - The matched order.
+     * @returns A promise resolving to the transaction hash of the refund.
+     */
+    refund(order: MatchedOrder): AsyncResult<string, string>;
+}

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

@@ -1,13 +1,15 @@
+import { AsyncResult, IAuth, Url } from '@gardenfi/utils';
 import { WalletClient } from 'viem';
 import { MatchedOrder } from '@gardenfi/orderbook';
-import { IEVMRelay } from './evmRelay.types';
-import { AsyncResult } from '@catalogfi/utils';
-import { IAuth, Url } from '@gardenfi/utils';
+import { IEVMHTLC } from '../htlc.types';
 
-export declare class EvmRelay implements IEVMRelay {
+export declare class EvmRelay implements IEVMHTLC {
     private url;
     private auth;
-    constructor(url: string | Url, auth: IAuth);
-    init(walletClient: WalletClient, order: MatchedOrder): AsyncResult<string, string>;
-    redeem(orderId: string, secret: string): AsyncResult<string, string>;
+    private wallet;
+    constructor(url: string | Url, wallet: WalletClient, auth: IAuth);
+    get htlcActorAddress(): string;
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    redeem(order: MatchedOrder, secret: string): AsyncResult<string, string>;
+    refund(): AsyncResult<string, string>;
 }

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

@@ -0,0 +1,11 @@
+export declare class DigestKey {
+    private _digestKey;
+    private _userId;
+    constructor(digestKey: string);
+    static from(digestKey: string): import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<DigestKey, never>;
+    static generateRandom(): import('@catalogfi/utils').Result<never, string> | import('@catalogfi/utils').Result<DigestKey, never>;
+    private static isValidPrivateKey;
+    private static generateRandomDigestKey;
+    get digestKey(): string;
+    get userId(): string;
+}

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

@@ -2,16 +2,20 @@ import { ISecretManager } from './../secretManager/secretManager.types';
 import { AsyncResult } from '@catalogfi/utils';
 import { GardenEvents, GardenProps, IGardenJS, SwapParams } from './garden.types';
 import { IOrderbook, MatchedOrder } from '@gardenfi/orderbook';
-import { EventBroker } from '@gardenfi/utils';
+import { Environment, EventBroker, IAuth } from '@gardenfi/utils';
 import { IQuote } from '../quote/quote.types';
 import { IBitcoinWallet } from '@catalogfi/wallets';
 import { IBlockNumberFetcher } from '../blockNumberFetcher/blockNumber';
-import { IEVMRelay } from '../evm/relay/evmRelay.types';
+import { IEVMHTLC } from '../evm/htlc.types';
+import { DigestKey } from './digestKey/digestKey';
+import { WalletClient } from 'viem';
+import { IStarknetHTLC } from '../starknet/starknetHTLC.types';
+import { Account } from 'starknet';
 
 export declare class Garden extends EventBroker<GardenEvents> implements IGardenJS {
     private environment;
     private _secretManager;
-    private _orderBook;
+    private _orderbook;
     private _quote;
     private getOrderThreshold;
     private _orderbookUrl;
@@ -19,18 +23,30 @@ export declare class Garden extends EventBroker<GardenEvents> implements IGarden
     private orderExecutorCache;
     private _blockNumberFetcher;
     private refundSacpCache;
-    private _evmRelay;
-    private _evmWallet;
+    private _evmHTLC;
+    private _starknetHTLC;
     private _btcWallet;
     private bitcoinRedeemCache;
+    private _digestKey;
     constructor(config: GardenProps);
+    static from(config: {
+        environment: Environment;
+        digestKey: string;
+        wallets: {
+            evm: WalletClient;
+            starknet: Account;
+        };
+    }): Garden;
     get orderbookUrl(): string;
-    get evmRelay(): IEVMRelay;
+    get evmHTLC(): IEVMHTLC | undefined;
+    get starknetHTLC(): IStarknetHTLC | undefined;
     get quote(): IQuote;
     get btcWallet(): IBitcoinWallet | undefined;
     get orderbook(): IOrderbook;
     get blockNumberFetcher(): IBlockNumberFetcher;
     get secretManager(): ISecretManager;
+    get auth(): IAuth;
+    get digestKey(): DigestKey;
     private initializeSMandBTCWallet;
     swap(params: SwapParams): AsyncResult<MatchedOrder, string>;
     private validateAndFillParams;
@@ -39,11 +55,10 @@ export declare class Garden extends EventBroker<GardenEvents> implements IGarden
     private pollOrder;
     execute(interval?: number): Promise<() => void>;
     private evmRedeem;
+    private starknetRedeem;
     private btcRedeem;
     private btcRefund;
-    private getWallet;
     private postRefundSACP;
-    private fetchCurrentBlockNumbers;
     private filterExpiredAndAssignStatus;
     private broadcastRedeemTx;
 }

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

@@ -1,13 +1,14 @@
 import { AsyncResult } from '@catalogfi/utils';
 import { Asset, IOrderbook, MatchedOrder } from '@gardenfi/orderbook';
-import { OrderStatus } from '../status';
-import { Environment, EventBroker, SiweOpts } from '@gardenfi/utils';
-import { WalletClient } from 'viem';
+import { OrderStatus } from '../orderStatus/status';
+import { Environment, EventBroker, IAuth } from '@gardenfi/utils';
 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';
+import { IEVMHTLC } from '../evm/htlc.types';
+import { DigestKey } from './digestKey/digestKey';
+import { IStarknetHTLC } from '../starknet/starknetHTLC.types';
 
 export type SwapParams = {
     /**
@@ -19,11 +20,11 @@ export type SwapParams = {
      */
     toAsset: Asset;
     /**
-     * Amount in lowest denomination of the asset.
+     * Amount in lowest denomination of the sendAsset.
      */
     sendAmount: string;
     /**
-     * Amount in lowest denomination of the asset.
+     * Amount in lowest denomination of the toAsset.
      */
     receiveAmount: string;
     /**
@@ -87,7 +88,12 @@ export interface IGardenJS extends EventBroker<GardenEvents> {
      * The EVM relay.
      * @readonly
      */
-    get evmRelay(): IEVMRelay;
+    get evmHTLC(): IEVMHTLC | undefined;
+    /**
+     * The Starknet relay.
+     * @readonly
+     */
+    get starknetHTLC(): IStarknetHTLC | undefined;
     /**
      * The current quote.
      * @readonly
@@ -113,6 +119,16 @@ export interface IGardenJS extends EventBroker<GardenEvents> {
      * @readonly
      */
     get secretManager(): ISecretManager;
+    /**
+     * The auth.
+     * @readonly
+     */
+    get auth(): IAuth;
+    /**
+     * The digest key.
+     * @readonly
+     */
+    get digestKey(): DigestKey;
 }
 export type OrderCacheValue = {
     txHash: string;
@@ -126,13 +142,16 @@ export interface IOrderExecutorCache {
 }
 export type GardenProps = {
     environment: Environment;
-    apiKey?: string;
-    evmWallet: WalletClient;
+    digestKey: string;
+    api?: string;
     secretManager?: ISecretManager;
-    siweOpts?: SiweOpts;
-    orderbookURl?: string;
-    quote?: string;
+    orderbook?: IOrderbook;
+    quote?: IQuote;
     blockNumberFetcher?: IBlockNumberFetcher;
+    htlc: {
+        evm?: IEVMHTLC;
+        starknet?: IStarknetHTLC;
+    };
 };
 /**
  * Actions that can be performed on the order.

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

@@ -1,5 +1,5 @@
 import { MatchedOrder, Swap } from '@gardenfi/orderbook';
-import { OrderActions } from './garden/garden.types';
+import { OrderActions } from '../garden/garden.types';
 import { OrderStatus, SwapStatus } from './status';
 
 /**

package/dist/src/lib/starknet/abi/starknetHtlcABI.d.ts

@@ -0,0 +1,86 @@
+export declare const starknetHtlcABI: ({
+    name: string;
+    type: string;
+    interface_name: string;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+    variants?: undefined;
+} | {
+    name: string;
+    type: string;
+    members: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+    variants?: undefined;
+} | {
+    name: string;
+    type: string;
+    items: ({
+        name: string;
+        type: string;
+        inputs: never[];
+        outputs: {
+            type: string;
+        }[];
+        state_mutability: string;
+    } | {
+        name: string;
+        type: string;
+        inputs: {
+            name: string;
+            type: string;
+        }[];
+        outputs: never[];
+        state_mutability: string;
+    })[];
+    interface_name?: undefined;
+    members?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+    variants?: undefined;
+} | {
+    name: string;
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    kind?: undefined;
+    variants?: undefined;
+} | {
+    kind: string;
+    name: string;
+    type: string;
+    members: {
+        kind: string;
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    variants?: undefined;
+} | {
+    kind: string;
+    name: string;
+    type: string;
+    variants: {
+        kind: string;
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+})[];

package/dist/src/lib/starknet/abi/starknetTokenABI.d.ts

@@ -0,0 +1,122 @@
+export declare const TokenABI: ({
+    name: string;
+    type: string;
+    interface_name: string;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    members: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    variants: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    items: {
+        name: string;
+        type: string;
+        inputs: {
+            name: string;
+            type: string;
+        }[];
+        outputs: {
+            type: string;
+        }[];
+        state_mutability: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    inputs?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    outputs: {
+        type: string;
+    }[];
+    state_mutability: string;
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    kind?: undefined;
+} | {
+    kind: string;
+    name: string;
+    type: string;
+    members: {
+        kind: string;
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+} | {
+    kind: string;
+    name: string;
+    type: string;
+    variants: {
+        kind: string;
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    outputs?: undefined;
+    state_mutability?: undefined;
+})[];

package/dist/src/lib/starknet/checkAllowanceAndApprove.d.ts

@@ -0,0 +1,4 @@
+import { Account } from 'starknet';
+import { AsyncResult } from '@catalogfi/utils';
+
+export declare const checkAllowanceAndApprove: (account: Account, tokenAddress: string, htlcAddress: string, amount: bigint, nodeUrl: string) => AsyncResult<string, string>;

package/dist/src/lib/starknet/htlc/starknetHTLC.d.ts

@@ -0,0 +1,34 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@catalogfi/utils';
+import { Account, CallData } from 'starknet';
+import { IStarknetHTLC } from '../starknetHTLC.types';
+
+export declare class StarknetHTLC implements IStarknetHTLC {
+    private nodeUrl;
+    private account;
+    constructor(account: Account, nodeUrl?: string);
+    get htlcActorAddress(): string;
+    private getHTLCContract;
+    /**
+     * Initiates the HTLC
+     * @param order Order to initiate HTLC for
+     * @returns Transaction ID
+     */
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    callData: CallData;
+    /**
+     * Redeems the HTLC
+     *
+     * @param order Order to redeem HTLC for
+     * @param secret Secret to redeem HTLC with
+     * @returns Transaction ID
+     */
+    redeem(order: MatchedOrder, secret: string): AsyncResult<string, string>;
+    /**
+     * Refunds the HTLC
+     *
+     * @param order Order to refund HTLC for
+     * @returns Refund transaction ID
+     */
+    refund(order: MatchedOrder): AsyncResult<string, string>;
+}

package/dist/src/lib/starknet/relay/starknetRelay.d.ts

@@ -0,0 +1,16 @@
+import { Account } from 'starknet';
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@catalogfi/utils';
+import { Url } from '@gardenfi/utils';
+import { IStarknetHTLC } from '../starknetHTLC.types';
+
+export declare class StarknetRelay implements IStarknetHTLC {
+    private url;
+    private nodeUrl;
+    private account;
+    constructor(relayerUrl: string | Url, account: Account, nodeUrl?: string);
+    get htlcActorAddress(): string;
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    redeem(order: MatchedOrder, secret: string): AsyncResult<string, string>;
+    refund(): AsyncResult<string, string>;
+}

package/dist/src/lib/starknet/starknetHTLC.types.d.ts

@@ -0,0 +1,28 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@catalogfi/utils';
+
+export interface IStarknetHTLC {
+    /**
+     * The address of the HTLC actor.
+     */
+    get htlcActorAddress(): string;
+    /**
+     * Initiates the HTLC by sending funds to the HTLC contract.
+     * @param order - The matched order.
+     * @returns A promise resolving to the transaction hash of the initiation.
+     */
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    /**
+     * Redeems funds from the HTLC contract to the actor's address.
+     * @param order - The matched order.
+     * @param secret - The secret required to unlock the htlc.
+     * @returns A promise resolving to the transaction hash of the redemption.
+     */
+    redeem(order: MatchedOrder, secret: string): AsyncResult<string, string>;
+    /**
+     * Refunds funds from the HTLC contract back to the actor's address upon expiration.
+     * @param order - The matched order.
+     * @returns A promise resolving to the transaction hash of the refund.
+     */
+    refund(order: MatchedOrder): AsyncResult<string, string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gardenfi/core",
-  "version": "2.0.22",
+  "version": "2.0.23",
   "type": "module",
   "scripts": {
     "build": "vite build",
@@ -27,10 +27,12 @@
   },
   "dependencies": {
     "@catalogfi/wallets": "^0.2.59",
-    "@gardenfi/orderbook": "^2.0.6",
-    "@gardenfi/utils": "^2.0.3",
+    "@gardenfi/orderbook": "^2.0.7",
+    "@gardenfi/utils": "^2.0.5",
     "bignumber.js": "^9.1.2",
     "bitcoinjs-lib": "^6.1.6",
+    "crypto-browserify": "^3.12.1",
+    "starknet": "6.23.1",
     "tiny-secp256k1": "^2.2.3",
     "varuint-bitcoin": "^1.1.2",
     "viem": "^2.21.23"