@gardenfi/core 2.5.3 → 3.0.0

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-s2tkcnpk.cjs");exports.API=e.API;exports.BitcoinNetwork=e.BitcoinNetwork;exports.BitcoinProvider=e.BitcoinProvider;exports.BitcoinWallet=e.BitcoinWallet;exports.BlockNumberFetcher=e.BlockNumberFetcher;exports.EvmRelay=e.EvmRelay;exports.Garden=e.Garden;exports.OrderActions=e.OrderActions;exports.OrderStatus=e.OrderStatus;exports.ParseOrderStatus=e.ParseOrderStatus;exports.ParseSwapStatus=e.ParseSwapStatus;exports.Quote=e.Quote;exports.STARKNET_CONFIG=e.STARKNET_CONFIG;exports.SecretManager=e.SecretManager;exports.SolanaHTLC=e.SolanaHTLC;exports.SolanaRelay=e.SolanaRelay;exports.SolanaRelayerAddress=e.SolanaRelayerAddress;exports.StarknetHTLC=e.StarknetHTLC;exports.StarknetRelay=e.StarknetRelay;exports.SwapStatus=e.SwapStatus;exports.botanix=e.botanixMainnet;exports.checkStarknetAlloance=e.checkAllowance;exports.checkStarknetAllowanceAndApprove=e.checkAllowanceAndApprove;exports.constructOrderPair=e.constructOrderPair;exports.evmToViemChainMap=e.evmToViemChainMap;exports.filterDeadlineExpiredOrders=e.filterDeadlineExpiredOrders;exports.hyperliquid=e.hyperliquid;exports.hyperliquidTestnet=e.hyperliquidTestnet;exports.isExpired=e.isExpired;exports.isOrderExpired=e.isOrderExpired;exports.isStarknetAllowanceSufficient=e.isAllowanceSufficient;exports.parseAction=e.parseAction;exports.parseActionFromStatus=e.parseActionFromStatus;exports.resolveApiConfig=e.resolveApiConfig;exports.solanaProgramAddress=e.solanaProgramAddress;exports.switchOrAddNetwork=e.switchOrAddNetwork;exports.toXOnly=e.toXOnly;exports.validateBTCAddress=e.validateBTCAddress;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-BB1moYTm.cjs");exports.API=e.API;exports.BitcoinNetwork=e.BitcoinNetwork;exports.BitcoinProvider=e.BitcoinProvider;exports.BitcoinWallet=e.BitcoinWallet;exports.DEFAULT_AFFILIATE_ASSET=e.DEFAULT_AFFILIATE_ASSET;exports.EvmRelay=e.EvmRelay;exports.Garden=e.Garden;exports.Quote=e.Quote;exports.STARKNET_CONFIG=e.STARKNET_CONFIG;exports.SUI_CONFIG=e.SUI_CONFIG;exports.SecretManager=e.SecretManager;exports.SolanaHTLC=e.SolanaHTLC;exports.SolanaRelay=e.SolanaRelay;exports.SolanaRelayerAddress=e.SolanaRelayerAddress;exports.StarknetHTLC=e.StarknetHTLC;exports.StarknetRelay=e.StarknetRelay;exports.alpenTestnet=e.alpenTestnet;exports.botanixMainnet=e.botanixMainnet;exports.checkStarknetAlloance=e.checkAllowance;exports.checkStarknetAllowanceAndApprove=e.checkAllowanceAndApprove;exports.constructOrderPair=e.constructOrderPair;exports.evmToViemChainMap=e.evmToViemChainMap;exports.getChainNameFromChainId=e.getChainNameFromChainId;exports.hyperliquid=e.hyperliquid;exports.hyperliquidTestnet=e.hyperliquidTestnet;exports.isStarknetAllowanceSufficient=e.isAllowanceSufficient;exports.resolveApiConfig=e.resolveApiConfig;exports.solanaProgramAddress=e.solanaProgramAddress;exports.switchOrAddNetwork=e.switchOrAddNetwork;exports.toXOnly=e.toXOnly;exports.validateBTCAddress=e.validateBTCAddress;

package/dist/index.js

@@ -1,41 +1,34 @@
-import { U as e, N as r, R as t, T as i, m as n, E as o, G as d, O as l, n as c, P as S, q as A, Q as p, V as u, w as k, k as O, j as h, W as m, h as w, S as y, o as T, M as v, z as C, x as P, A as x, I as E, u as N, L as R, K as f, r as B, t as F, y as g, p as q, v as G, F as I, X as L, J as M, D as b, C as D } from "./index-D-NHDZrP.js";
+import { K as s, D as t, F as n, I as r, J as o, E as i, G as l, Q as A, L as d, M as c, m as S, k as T, j as k, N as C, h, S as p, A as m, u as y, p as I, n as v, q as F, w as N, x as u, y as w, z as E, o as O, r as L, O as R, C as f, t as g, v as B } from "./index-dcGJN5tW.js";
 export {
-  e as API,
-  r as BitcoinNetwork,
-  t as BitcoinProvider,
-  i as BitcoinWallet,
-  n as BlockNumberFetcher,
-  o as EvmRelay,
-  d as Garden,
-  l as OrderActions,
-  c as OrderStatus,
-  S as ParseOrderStatus,
-  A as ParseSwapStatus,
-  p as Quote,
-  u as STARKNET_CONFIG,
-  k as SecretManager,
-  O as SolanaHTLC,
-  h as SolanaRelay,
-  m as SolanaRelayerAddress,
-  w as StarknetHTLC,
-  y as StarknetRelay,
-  T as SwapStatus,
-  v as botanix,
-  C as checkStarknetAlloance,
-  P as checkStarknetAllowanceAndApprove,
-  x as constructOrderPair,
-  E as evmToViemChainMap,
-  N as filterDeadlineExpiredOrders,
-  R as hyperliquid,
-  f as hyperliquidTestnet,
-  B as isExpired,
-  F as isOrderExpired,
-  g as isStarknetAllowanceSufficient,
-  q as parseAction,
-  G as parseActionFromStatus,
-  I as resolveApiConfig,
-  L as solanaProgramAddress,
-  M as switchOrAddNetwork,
-  b as toXOnly,
-  D as validateBTCAddress
+  s as API,
+  t as BitcoinNetwork,
+  n as BitcoinProvider,
+  r as BitcoinWallet,
+  o as DEFAULT_AFFILIATE_ASSET,
+  i as EvmRelay,
+  l as Garden,
+  A as Quote,
+  d as STARKNET_CONFIG,
+  c as SUI_CONFIG,
+  S as SecretManager,
+  T as SolanaHTLC,
+  k as SolanaRelay,
+  C as SolanaRelayerAddress,
+  h as StarknetHTLC,
+  p as StarknetRelay,
+  m as alpenTestnet,
+  y as botanixMainnet,
+  I as checkStarknetAlloance,
+  v as checkStarknetAllowanceAndApprove,
+  F as constructOrderPair,
+  N as evmToViemChainMap,
+  u as getChainNameFromChainId,
+  w as hyperliquid,
+  E as hyperliquidTestnet,
+  O as isStarknetAllowanceSufficient,
+  L as resolveApiConfig,
+  R as solanaProgramAddress,
+  f as switchOrAddNetwork,
+  g as toXOnly,
+  B as validateBTCAddress
 };

package/dist/src/index.d.ts

@@ -1,8 +1,6 @@
 export { Garden } from './lib/garden/garden';
-export type { IGardenJS, SwapParams, GardenEvents, IOrderExecutorCache, OrderCacheValue, EventCallback, OrderWithStatus, GardenCoreConfig, GardenWalletModules, GardenHTLCModules, GardenConfigWithWallets, GardenConfigWithHTLCs, } from './lib/garden/garden.types';
-export { OrderActions } from './lib/garden/garden.types';
+export type { IGardenJS, SwapParams, GardenEvents, IOrderExecutorCache, OrderCacheValue, EventCallback, OrderWithStatus, GardenCoreConfig, GardenWalletModules, GardenHTLCModules, GardenConfigWithWallets, GardenConfigWithHTLCs, ApiConfig, } from './lib/garden/garden.types';
 export { EvmRelay } from './lib/evm/relay/evmRelay';
-export type { IEVMRelay } from './lib/evm/relay/evmRelay.types';
 export type { IEVMHTLC } from './lib/evm/htlc.types';
 export { StarknetRelay } from './lib/starknet/relay/starknetRelay';
 export type { IStarknetHTLC } from './lib/starknet/starknetHTLC.types';
@@ -10,19 +8,16 @@ export { StarknetHTLC } from './lib/starknet/htlc/starknetHTLC';
 export { SolanaRelay } from './lib/solana/relayer/solanaRelay';
 export type { ISolanaHTLC } from './lib/solana/htlc/ISolanaHTLC';
 export { SolanaHTLC } from './lib/solana/htlc/solanaHTLC';
-export { BlockNumberFetcher } from './lib/blockNumberFetcher/blockNumber';
-export type { IBlockNumberFetcher } from './lib/blockNumberFetcher/blockNumber';
-export { OrderStatus, SwapStatus } from './lib/orderStatus/status';
-export { parseAction, ParseOrderStatus, ParseSwapStatus, isExpired, isOrderExpired, filterDeadlineExpiredOrders, parseActionFromStatus, } from './lib/orderStatus/orderStatusParser';
 export { SecretManager } from './lib/secretManager/secretManager';
-export type { ISecretManager, Secret, } from './lib/secretManager/secretManager.types';
+export type { ISecretManager, Secret, SecretManagerEvents, } from './lib/secretManager/secretManager.types';
 export { checkAllowanceAndApprove as checkStarknetAllowanceAndApprove, isAllowanceSufficient as isStarknetAllowanceSufficient, checkAllowance as checkStarknetAlloance, } from './lib/starknet/checkAllowanceAndApprove';
 export { Quote } from './lib/quote/quote';
-export type { IQuote, QuoteResponse, Strategies, QuoteParamsForAssets, QuoteParamsForOrderPair, QuoteOptions, BaseQuoteParams, } from './lib/quote/quote.types';
+export type { StrategiesResponse, BaseQuoteParams, IQuote, QuoteOptions, QuoteParamsForAssets, QuoteParamsForOrderPair, QuoteResponse, Strategies, } from './lib/quote/quote.types';
 export { constructOrderPair, validateBTCAddress, toXOnly, resolveApiConfig, } from './lib/utils';
-export { evmToViemChainMap, switchOrAddNetwork, hyperliquidTestnet, hyperliquid, botanixMainnet as botanix, } from './lib/switchOrAddNetwork';
+export { botanixMainnet, evmToViemChainMap, getChainNameFromChainId, hyperliquid, hyperliquidTestnet, alpenTestnet, switchOrAddNetwork, } from './lib/switchOrAddNetwork';
 export { BitcoinNetwork } from './lib/bitcoin/provider/provider.interface';
 export { BitcoinProvider } from './lib/bitcoin/provider/provider';
 export { BitcoinWallet } from './lib/bitcoin/wallet/wallet';
-export type { IBitcoinProvider } from './lib/bitcoin/provider/provider.interface';
-export { API, STARKNET_CONFIG, SolanaRelayerAddress, solanaProgramAddress, } from './lib/constants';
+export type { UrgencyToFeeRateKey, Urgency, IBitcoinProvider, FeeRates, BitcoinTxType, BitcoinTx, BitcoinUTXO, FeeRateKeys, } from './lib/bitcoin/provider/provider.interface';
+export { DEFAULT_AFFILIATE_ASSET, API, STARKNET_CONFIG, SUI_CONFIG, SolanaRelayerAddress, solanaProgramAddress, } from './lib/constants';
+export type { Api } from './lib/constants';

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

@@ -1,4 +1,6 @@
+import { Network } from '@gardenfi/utils';
+
 export declare const verifyAPIs: (APIs: string[]) => string[];
-export declare const getAPIs: (network: string) => string[];
+export declare const getAPIs: (network: Network) => string[];
 export declare const RPC_URLS_TESTNET: string[];
 export declare const RPC_URLS_MAINNET: string[];

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

@@ -0,0 +1,98 @@
+import { IBitcoinProvider } from './provider/provider.interface';
+import { IBitcoinWallet } from './wallet/wallet.interface';
+import { IBitcoinHTLC } from './bitcoinhtlc.types';
+import { BitcoinOrderResponse, Order } from '@gardenfi/orderbook';
+import { AsyncResult, Network } from '@gardenfi/utils';
+
+export declare enum Leaf {
+    REFUND = 0,
+    REDEEM = 1,
+    INSTANT_REFUND = 2
+}
+export type TxType = 'redeem' | 'refund' | 'instantRefund';
+export type LeafScript = {
+    version: number;
+    output: Buffer;
+};
+export type LeafTree = LeafScript | [LeafScript, LeafScript];
+export declare class BitcoinHTLC implements IBitcoinHTLC {
+    /**
+     * Signer of the HTLC can be either the initiator or the redeemer
+     */
+    private signer;
+    private internalPubkey;
+    private network;
+    /**
+     * Note: redeemerAddress and initiatorAddress should be x-only public key without 02 or 03 prefix
+     */
+    constructor(signer: IBitcoinWallet, network: Network);
+    /**
+     * Generates a taproot address for receiving the funds
+     * @param order The order object
+     * @param type The type of address to generate ('redeem' | 'refund' | 'instantRefund')
+     *   - 'redeem': uses destination_swap parameters (default)
+     *   - 'refund': uses source_swap parameters
+     *   - 'instantRefund': uses source_swap parameters with redeemer
+     */
+    address(order: Order, type: TxType): string;
+    private _buildRawTx;
+    /**
+     * prevout script for the BitcoinHTLC address
+     */
+    private getOutputScript;
+    initiate(order: Order | BitcoinOrderResponse, fee?: number): AsyncResult<string, string>;
+    generateRedeemSACP(order: Order, secret: string, fee?: number): Promise<string>;
+    generateInstantRefundSACP(order: Order): Promise<string>;
+    generateInstantRefundSACPWithHash(hash: string[]): AsyncResult<string[], 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(order: Order, counterPartySigs: {
+        utxo: string;
+        sig: string;
+    }[], fee?: number): Promise<string>;
+    /**
+     * Reveals the secret and redeems the HTLC
+     */
+    redeem(order: Order, secret: string, utxoHashes?: string[]): AsyncResult<string, string>;
+    getRedeemHex(order: Order, secret: string, utxoHashes?: string[]): AsyncResult<string, string>;
+    /**
+     * Refunds the funds back to the initiator if the expiry block height + 1 is reached
+     */
+    refund(order: Order, fee?: number): AsyncResult<string, 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, order: Order): Buffer;
+    private refundLeaf;
+    private redeemLeaf;
+    private instantRefundLeaf;
+    /**
+     * Generates leaves for a given action type (redeem, refund, instant refund)
+     * @param order The order object
+     * @param type 'redeem' | 'refund' | 'instantRefund'
+     *   - 'redeem': uses destination_swap for all params
+     *   - 'refund': uses source_swap for all params
+     *   - 'instantRefund': uses source_swap, but redeem/instantRefund use .redeemer
+     */
+    private generateLeaves;
+    /**
+     * Generates the merkle proof for the leaf script
+     */
+    private generateMerkleProofFor;
+    getProvider(): Promise<IBitcoinProvider>;
+    get getPublicKey(): string;
+    get htlcActorAddress(): string;
+}

package/dist/src/lib/bitcoin/bitcoinhtlc.types.d.ts

@@ -0,0 +1,53 @@
+import { BitcoinOrderResponse, Order } from '@gardenfi/orderbook';
+import { AsyncResult } from '@gardenfi/utils';
+import { IBitcoinProvider } from './provider/provider.interface';
+
+export interface IBitcoinHTLC {
+    /**
+     * 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: Order | BitcoinOrderResponse, fee?: number): 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: Order, 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: Order): AsyncResult<string, string>;
+    /**
+     * Generates the instant refund SACP with the hash of the refund transaction.
+     * @param hash - The hash of the refund transaction.
+     * @returns A promise resolving to the SACP.
+     */
+    generateInstantRefundSACPWithHash(hash: string[]): AsyncResult<string[], string>;
+    /**
+     * Generates the redeem SACP with the secret.
+     * @param order - The matched order.
+     * @param secret - The secret required to unlock the htlc.
+     * @returns A promise resolving to the SACP.
+     */
+    getRedeemHex(order: Order, secret: string, utxoHashes?: string[]): AsyncResult<string, string>;
+    /**
+     * Gets the provider of the wallet.
+     * @returns A promise resolving to the provider.
+     */
+    getProvider(): Promise<IBitcoinProvider>;
+    /**
+     * Gets the public key of the wallet.
+     * @returns A promise resolving to the public key.
+     */
+    get getPublicKey(): string;
+    /**
+     * Returns the HTLC actor address.
+     * This is the user's wallet address in the case of EVM.
+     */
+    get htlcActorAddress(): string;
+}

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

@@ -1,3 +1,4 @@
+import { Network } from '@gardenfi/utils';
 import { BitcoinNetwork, BitcoinTx, BitcoinTxType, BitcoinUTXO, FeeRates, IBitcoinProvider, Urgency } from './provider.interface';
 
 export declare class BitcoinProvider implements IBitcoinProvider {
@@ -5,7 +6,7 @@ export declare class BitcoinProvider implements IBitcoinProvider {
     private readonly APIs;
     private cacheTimeout;
     private readonly utxosCache;
-    constructor(network: BitcoinNetwork, API?: string);
+    constructor(network: Network, API?: string);
     /**
      * Gets the output index of the UTXO
      *

package/dist/src/lib/bitcoin/wallet/abstractWallet.d.ts

@@ -11,7 +11,7 @@ export declare abstract class AbstractBitcoinWallet implements IBitcoinWallet {
     abstract getAddress(): Promise<string>;
     abstract getBalance(): Promise<number>;
     abstract sign(hexString: string): Promise<string>;
-    abstract getPublicKey(): Promise<string>;
+    abstract getPublicKey(): string;
     abstract getNetwork(): Promise<Network>;
     abstract getProvider(): Promise<IBitcoinProvider>;
     abstract send(toAddress: string, amt: number, fee?: number): Promise<string>;

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

@@ -90,7 +90,7 @@ export declare class BitcoinWallet extends AbstractBitcoinWallet {
     getAddress(): Promise<string>;
     getProvider(): Promise<IBitcoinProvider>;
     getBalance(): Promise<number>;
-    getPublicKey(): Promise<string>;
+    getPublicKey(): string;
     getNetwork(): Promise<networks.Network>;
     static generateUnsignedPSBT(provider: IBitcoinProvider, network: networks.Network, fromAddress: string, toAddress: string, amt: number, fee?: number): Promise<{
         txHex: string;

package/dist/src/lib/bitcoin/wallet/wallet.interface.d.ts

@@ -14,7 +14,7 @@ export interface IBitcoinWallet extends IBaseWallet {
     /**
      * @returns {Promise<string>} Public key of the wallet
      */
-    getPublicKey(): Promise<string>;
+    getPublicKey(): string;
     /**
      * @returns {Promise<Network>} Network of the wallet provided during initialization
      */

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

@@ -1,14 +1,10 @@
+import { ChainAsset } from '@gardenfi/orderbook';
 import { Environment, Network } from '@gardenfi/utils';
 
 export type Api = {
-    orderbook: string;
+    baseurl: string;
     auth: string;
-    quote: string;
-    info: string;
-    evmRelay: string;
-    starknetRelay: string;
-    solanaRelay: string;
-    suiRelay: string;
+    relayer: string;
 };
 export declare const API: Record<Environment, Api>;
 export declare const STARKNET_CONFIG: Record<Network, {
@@ -31,6 +27,5 @@ export declare const SUI_CONFIG: Record<Network, {
     moduleName: string;
 }>;
 export declare const DEFAULT_AFFILIATE_ASSET: {
-    chain: "base";
-    asset: "0xeae7721d779276eb0f5837e2fe260118724a2ba4";
+    asset: ChainAsset;
 };