@gardenfi/core 2.1.14 → 2.2.0

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-BwOLJ71D.cjs");exports.API=e.API;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.StarknetHTLC=e.StarknetHTLC;exports.StarknetRelay=e.StarknetRelay;exports.SwapStatus=e.SwapStatus;exports.botanix=e.botanixMainnet;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.parseAction=e.parseAction;exports.parseActionFromStatus=e.parseActionFromStatus;exports.resolveApiConfig=e.resolveApiConfig;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-aGo-Fuz8.cjs");exports.API=e.API;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.constructOrderPair=e.constructOrderPair;exports.evmToViemChainMap=e.evmToViemChainMap;exports.filterDeadlineExpiredOrders=e.filterDeadlineExpiredOrders;exports.hyperliquid=e.hyperliquid;exports.hyperliquidTestnet=e.hyperliquidTestnet;exports.isExpired=e.isExpired;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;

package/dist/index.js

@@ -1,30 +1,34 @@
-import { F as e, j as r, E as t, G as i, O as d, k as o, P as n, n as p, Q as S, I as u, t as l, h as c, S as A, m as O, D as m, u as h, y, q as C, C as T, A as k, o as v, p as w, r as x, x as E, z as P, w as F, v as N } from "./index-CAqXP6qV.js";
+import { J as e, m as r, E as t, G as o, O as d, n as i, P as n, q as l, Q as S, K as p, v as u, k as A, j as c, L as O, h as m, S as y, o as C, I as T, w as h, A as P, t as k, F as v, D as w, r as x, p as E, u as R, z as F, M as N, C as f, y as g, x as q } from "./index-CslSAu9n.js";
 export {
   e as API,
   r as BlockNumberFetcher,
   t as EvmRelay,
-  i as Garden,
+  o as Garden,
   d as OrderActions,
-  o as OrderStatus,
+  i as OrderStatus,
   n as ParseOrderStatus,
-  p as ParseSwapStatus,
+  l as ParseSwapStatus,
   S as Quote,
-  u as STARKNET_CONFIG,
-  l as SecretManager,
-  c as StarknetHTLC,
-  A as StarknetRelay,
-  O as SwapStatus,
-  m as botanix,
+  p as STARKNET_CONFIG,
+  u as SecretManager,
+  A as SolanaHTLC,
+  c as SolanaRelay,
+  O as SolanaRelayerAddress,
+  m as StarknetHTLC,
+  y as StarknetRelay,
+  C as SwapStatus,
+  T as botanix,
   h as constructOrderPair,
-  y as evmToViemChainMap,
-  C as filterDeadlineExpiredOrders,
-  T as hyperliquid,
-  k as hyperliquidTestnet,
-  v as isExpired,
-  w as parseAction,
-  x as parseActionFromStatus,
-  E as resolveApiConfig,
-  P as switchOrAddNetwork,
-  F as toXOnly,
-  N as validateBTCAddress
+  P as evmToViemChainMap,
+  k as filterDeadlineExpiredOrders,
+  v as hyperliquid,
+  w as hyperliquidTestnet,
+  x as isExpired,
+  E as parseAction,
+  R as parseActionFromStatus,
+  F as resolveApiConfig,
+  N as solanaProgramAddress,
+  f as switchOrAddNetwork,
+  g as toXOnly,
+  q as validateBTCAddress
 };

package/dist/src/index.d.ts

@@ -7,6 +7,9 @@ export type { IEVMHTLC } from './lib/evm/htlc.types';
 export { StarknetRelay } from './lib/starknet/relay/starknetRelay';
 export type { IStarknetHTLC } from './lib/starknet/starknetHTLC.types';
 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';
@@ -17,4 +20,4 @@ export { Quote } from './lib/quote/quote';
 export type { IQuote, 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 { API, STARKNET_CONFIG } from './lib/constants';
+export { API, STARKNET_CONFIG, SolanaRelayerAddress, solanaProgramAddress, } from './lib/constants';

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

@@ -7,12 +7,18 @@ export type Api = {
     info: string;
     evmRelay: string;
     starknetRelay: string;
+    solanaRelay: string;
 };
 export declare const API: Record<Environment, Api>;
 export declare const STARKNET_CONFIG: Record<Network, {
     chainId: string;
     nodeUrl: string;
 }>;
+export declare const SolanaRelayerAddress: Record<Network, string>;
+export declare const solanaProgramAddress: {
+    mainnet: string;
+    staging: string;
+};
 export declare const DEFAULT_AFFILIATE_ASSET: {
     chain: "base";
     asset: "0xeae7721d779276eb0f5837e2fe260118724a2ba4";

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

@@ -8,6 +8,7 @@ import { IBitcoinWallet } from '@catalogfi/wallets';
 import { IBlockNumberFetcher } from '../blockNumberFetcher/blockNumber';
 import { IEVMHTLC } from '../evm/htlc.types';
 import { IStarknetHTLC } from '../starknet/starknetHTLC.types';
+import { ISolanaHTLC } from '../solana/htlc/ISolanaHTLC';
 
 export declare class Garden extends EventBroker<GardenEvents> implements IGardenJS {
     private environment;
@@ -21,6 +22,7 @@ export declare class Garden extends EventBroker<GardenEvents> implements IGarden
     private refundSacpCache;
     private _evmHTLC;
     private _starknetHTLC;
+    private _solanaHTLC;
     private _btcWallet;
     private bitcoinRedeemCache;
     private _digestKey;
@@ -29,13 +31,20 @@ export declare class Garden extends EventBroker<GardenEvents> implements IGarden
     static fromWallets(config: GardenConfigWithWallets): Garden;
     get evmHTLC(): IEVMHTLC | undefined;
     get starknetHTLC(): IStarknetHTLC | undefined;
+    get solanaHTLC(): ISolanaHTLC | undefined;
     get quote(): IQuote;
-    get btcWallet(): IBitcoinWallet;
+    get btcWallet(): IBitcoinWallet | undefined;
     get orderbook(): IOrderbook;
     get blockNumberFetcher(): IBlockNumberFetcher;
     get secretManager(): ISecretManager;
     get auth(): IAuth;
     get digestKey(): DigestKey;
+    /**
+     * This method takes in the `SwapParams` and returns a placed order
+     * It internally calls `getAttestedQuote`, `createOrder` and `pollOrder`
+     * @param swapParams
+     * @returns MatchedOrder
+     */
     swap(params: SwapParams): AsyncResult<MatchedOrder, string>;
     private withDefaultAffiliateFees;
     private validateAndFillParams;
@@ -43,6 +52,7 @@ export declare class Garden extends EventBroker<GardenEvents> implements IGarden
     private validateAmount;
     private pollOrder;
     execute(interval?: number): Promise<() => void>;
+    private solRedeem;
     private evmRedeem;
     private starknetRedeem;
     private btcRedeem;

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

@@ -5,12 +5,14 @@ import { Environment, EventBroker, IAuth, DigestKey } from '@gardenfi/utils';
 import { ISecretManager } from '../secretManager/secretManager.types';
 import { IQuote } from '../quote/quote.types';
 import { IBlockNumberFetcher } from '../blockNumberFetcher/blockNumber';
-import { IBitcoinWallet } from '@catalogfi/wallets';
+import { BitcoinWallet, IBitcoinWallet } from '@catalogfi/wallets';
 import { IEVMHTLC } from '../evm/htlc.types';
 import { IStarknetHTLC } from '../starknet/starknetHTLC.types';
 import { AccountInterface } from 'starknet';
 import { WalletClient } from 'viem';
 import { Api } from '../constants';
+import { ISolanaHTLC } from '../solana/htlc/ISolanaHTLC';
+import { AnchorProvider } from '@coral-xyz/anchor';
 
 export type SwapParams = {
     /**
@@ -95,6 +97,11 @@ export interface IGardenJS extends EventBroker<GardenEvents> {
      * @readonly
      */
     get starknetHTLC(): IStarknetHTLC | undefined;
+    /**
+     * The Solana relay.
+     * @readonly
+     */
+    get solanaHTLC(): ISolanaHTLC | undefined;
     /**
      * The current quote.
      * @readonly
@@ -152,17 +159,21 @@ export type GardenCoreConfig = {
     orderbook?: IOrderbook;
     quote?: IQuote;
     blockNumberFetcher?: IBlockNumberFetcher;
+    btcWallet?: BitcoinWallet;
+    solanaProgramAddress?: string;
 };
 export type GardenHTLCModules = {
     htlc: {
         evm?: IEVMHTLC;
         starknet?: IStarknetHTLC;
+        solana?: ISolanaHTLC;
     };
 };
 export type GardenWalletModules = {
     wallets: {
         evm?: WalletClient;
         starknet?: AccountInterface;
+        solana?: AnchorProvider;
     };
 };
 export type GardenConfigWithWallets = GardenCoreConfig & GardenWalletModules;

package/dist/src/lib/solana/htlc/ISolanaHTLC.d.ts

@@ -0,0 +1,28 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@catalogfi/utils';
+
+export interface ISolanaHTLC {
+    /**
+     * 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/dist/src/lib/solana/htlc/solanaHTLC.d.ts

@@ -0,0 +1,56 @@
+import { AnchorProvider } from '@coral-xyz/anchor';
+import { ISolanaHTLC } from './ISolanaHTLC';
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@catalogfi/utils';
+
+/**
+ * SolanaHTLC is an implementation of ISolanaHTLC that performs atomic swaps directly on-chain.
+ * As such, fees will be deducted from the initiator.
+ * To use a relayer that pays fees on behalf, see SolanaRelay
+ */
+export declare class SolanaHTLC implements ISolanaHTLC {
+    private provider;
+    /**
+     * The on-chain Program Derived Address (PDA) that facilitates this swap.
+     * Stores the swap state (initiator, redeemer, secrethash etc) and escrows the tokens.
+     */
+    private swapAccount?;
+    private program;
+    /**
+     * Creates a new instance of SolanaHTLC.
+     * @param {AnchorProvider} provider - Solana Provider (abstraction of RPC connection and a Wallet)
+     * @throws {Error} If provider is not provided
+     */
+    constructor(provider: AnchorProvider);
+    /**
+     * Gets the on-chain address of the atomic swap program.
+     * @returns {string} The program's on-chain address in base58 format
+     * @throws {Error} If no program ID is found
+     */
+    get htlcActorAddress(): string;
+    /**
+     * Initiates a swap by creating a new swap account and locking funds.
+     * @param {MatchedOrder} order - The matched order containing swap details
+     * @returns {Promise<AsyncResult<string, string>>} A promise that resolves to either:
+     *   - Ok with the transaction ID on success
+     *   - Err with an error message on failure
+     */
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    /**
+     * Redeems a swap by providing the secret.
+     * @param {MatchedOrder} order - Matched order object containing swap details
+     * @param {string} secret - Secret key in hex format
+     * @returns {AsyncResult<string, string>} A promise that resolves to either:
+     *   - Ok with the transaction ID on success
+     *   - Err with an error message on failure
+     */
+    redeem(order: MatchedOrder, secret: string): AsyncResult<string, string>;
+    /**
+     * Refunds the swap back to the initiator.
+     * @param {MatchedOrder} order - Matched order object
+     * @returns {AsyncResult<string, string>} A promise that resolves to either:
+     *   - Ok with the transaction ID on success
+     *   - Err with an error message on failure
+     */
+    refund(order: MatchedOrder): AsyncResult<string, string>;
+}

package/dist/src/lib/solana/idl/solana_native_swaps.d.ts

@@ -0,0 +1,299 @@
+/**
+ * Program IDL in camelCase format in order to be used in JS/TS.
+ *
+ * Note that this is only a type helper and is not the actual IDL. The original
+ * IDL can be found at `target/idl/solana_native_swaps.json`.
+ */
+export type SolanaNativeSwaps = {
+    address: '2bag6xpshpvPe7SJ9nSDLHpxqhEAoHPGpEkjNSv7gxoF';
+    metadata: {
+        name: 'solanaNativeSwaps';
+        version: '0.3.0';
+        spec: '0.1.0';
+        description: 'Created with Anchor';
+    };
+    instructions: [
+        {
+            name: 'initiate';
+            discriminator: [5, 63, 123, 113, 153, 75, 148, 14];
+            accounts: [
+                {
+                    name: 'swapAccount';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [115, 119, 97, 112, 95, 97, 99, 99, 111, 117, 110, 116];
+                            },
+                            {
+                                kind: 'account';
+                                path: 'initiator';
+                            },
+                            {
+                                kind: 'arg';
+                                path: 'secretHash';
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'initiator';
+                    docs: ['Initiator must sign this transaction'];
+                    writable: true;
+                    signer: true;
+                },
+                {
+                    name: 'systemProgram';
+                    address: '11111111111111111111111111111111';
+                }
+            ];
+            args: [
+                {
+                    name: 'amountLamports';
+                    type: 'u64';
+                },
+                {
+                    name: 'expiresInSlots';
+                    type: 'u64';
+                },
+                {
+                    name: 'redeemer';
+                    type: 'pubkey';
+                },
+                {
+                    name: 'secretHash';
+                    type: {
+                        array: ['u8', 32];
+                    };
+                }
+            ];
+        },
+        {
+            name: 'instantRefund';
+            discriminator: [211, 202, 103, 41, 183, 147, 59, 251];
+            accounts: [
+                {
+                    name: 'swapAccount';
+                    writable: true;
+                },
+                {
+                    name: 'initiator';
+                    writable: true;
+                },
+                {
+                    name: 'redeemer';
+                    docs: ['Redeemer must sign this transaction'];
+                    signer: true;
+                }
+            ];
+            args: [];
+        },
+        {
+            name: 'redeem';
+            discriminator: [184, 12, 86, 149, 70, 196, 97, 225];
+            accounts: [
+                {
+                    name: 'swapAccount';
+                    writable: true;
+                },
+                {
+                    name: 'initiator';
+                    docs: [
+                        'This is included here for the PDA rent refund using the `close` attribute above'
+                    ];
+                    writable: true;
+                },
+                {
+                    name: 'redeemer';
+                    writable: true;
+                }
+            ];
+            args: [
+                {
+                    name: 'secret';
+                    type: {
+                        array: ['u8', 32];
+                    };
+                }
+            ];
+        },
+        {
+            name: 'refund';
+            discriminator: [2, 96, 183, 251, 63, 208, 46, 46];
+            accounts: [
+                {
+                    name: 'swapAccount';
+                    writable: true;
+                },
+                {
+                    name: 'initiator';
+                    writable: true;
+                }
+            ];
+            args: [];
+        }
+    ];
+    accounts: [
+        {
+            name: 'swapAccount';
+            discriminator: [53, 126, 9, 14, 14, 197, 105, 182];
+        }
+    ];
+    events: [
+        {
+            name: 'initiated';
+            discriminator: [6, 108, 212, 91, 67, 60, 207, 221];
+        },
+        {
+            name: 'instantRefunded';
+            discriminator: [220, 50, 18, 207, 183, 232, 218, 25];
+        },
+        {
+            name: 'redeemed';
+            discriminator: [14, 29, 183, 71, 31, 165, 107, 38];
+        },
+        {
+            name: 'refunded';
+            discriminator: [35, 103, 149, 246, 196, 123, 221, 99];
+        }
+    ];
+    errors: [
+        {
+            code: 6000;
+            name: 'invalidInitiator';
+            msg: 'The provided initiator is not the original initiator of this swap account';
+        },
+        {
+            code: 6001;
+            name: 'invalidRedeemer';
+            msg: 'The provided redeemer is not the original redeemer of this swap amount';
+        },
+        {
+            code: 6002;
+            name: 'invalidSecret';
+            msg: 'The provided secret does not correspond to the secret hash in the swap account';
+        },
+        {
+            code: 6003;
+            name: 'refundBeforeExpiry';
+            msg: 'Attempt to perform a refund before expiry time';
+        }
+    ];
+    types: [
+        {
+            name: 'initiated';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'amountLamports';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'expiresInSlots';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'initiator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'redeemer';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'secretHash';
+                        type: {
+                            array: ['u8', 32];
+                        };
+                    }
+                ];
+            };
+        },
+        {
+            name: 'instantRefunded';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'initiator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'secretHash';
+                        type: {
+                            array: ['u8', 32];
+                        };
+                    }
+                ];
+            };
+        },
+        {
+            name: 'redeemed';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'initiator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'secret';
+                        type: {
+                            array: ['u8', 32];
+                        };
+                    }
+                ];
+            };
+        },
+        {
+            name: 'refunded';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'initiator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'secretHash';
+                        type: {
+                            array: ['u8', 32];
+                        };
+                    }
+                ];
+            };
+        },
+        {
+            name: 'swapAccount';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'amountLamports';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'expirySlot';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'initiator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'redeemer';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'secretHash';
+                        type: {
+                            array: ['u8', 32];
+                        };
+                    }
+                ];
+            };
+        }
+    ];
+};