@gardenfi/core 3.0.7-beta.1 → 3.0.8-beta.1

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

@@ -3,6 +3,7 @@ import { IGardenJS, SwapParams, GardenConfigWithHTLCs, GardenConfigWithWallets,
 import { BlockchainType, CreateOrderRequest, CreateOrderResponse, Orderbook } from '@gardenfi/orderbook';
 import { IAuth, DigestKey, AsyncResult } from '@gardenfi/utils';
 import { IQuote } from '../quote/quote.types';
+import { OrderCreationStatus } from '../constants';
 import { Executor } from './executor/executor';
 
 export declare class Garden extends Orderbook implements IGardenJS {
@@ -38,6 +39,7 @@ export declare class Garden extends Orderbook implements IGardenJS {
         readonly sui: import('../sui/suiHTLC.types').ISuiHTLC | undefined;
         readonly bitcoin: import('../bitcoin/bitcoinhtlc.types').IBitcoinHTLC | undefined;
         readonly tron: import('../tron/tronHTLC.types').ITronHTLC | undefined;
+        readonly xrpl: import('../..').IXrplHTLC | undefined;
     };
     get quote(): IQuote;
     get secretManager(): ISecretManager;
@@ -48,9 +50,10 @@ export declare class Garden extends Orderbook implements IGardenJS {
     /**
      * Creates an order for a swap operation and initiates the HTLC on the source chain.
      * @param params SwapParams
+     * @param onProgress Callback for order creation and initiation status
      * @returns AsyncResult<Order, string>
      */
-    createSwap(params: SwapParams): AsyncResult<CreateOrderResponse | string, string>;
+    createSwap(params: SwapParams, onProgress?: (status: OrderCreationStatus) => void): AsyncResult<CreateOrderResponse | string, string>;
     createOrder<T extends BlockchainType>(arg: CreateOrderRequest | SwapParams): AsyncResult<CreateOrderResponse<T>, string>;
     private validateAndFillParams;
     private _getAddresses;

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

@@ -1,4 +1,4 @@
-import { AffiliateFee, AssetLike, BitcoinOrderResponse, BlockchainType, EvmOrderResponse, IOrderbook, Order, OrderAction, OrderStatus, SolanaOrderResponse, StarknetOrderResponse, SuiOrderResponse, CreateOrderResponse } from '@gardenfi/orderbook';
+import { AffiliateFee, AssetLike, BitcoinOrderResponse, BlockchainType, EvmOrderResponse, IOrderbook, Order, OrderAction, OrderStatus, SolanaOrderResponse, StarknetOrderResponse, SuiOrderResponse, XrplOrderResponse, CreateOrderResponse } from '@gardenfi/orderbook';
 import { ApiKey, AsyncResult, IAuth, Network, DigestKey } from '@gardenfi/utils';
 import { ISecretManager } from '../secretManager/secretManager.types';
 import { IQuote } from '../quote/quote.types';
@@ -9,7 +9,7 @@ import { WalletClient } from 'viem';
 import { IBitcoinWallet } from '../bitcoin/wallet/wallet.interface';
 import { ISolanaHTLC } from '../solana/htlc/ISolanaHTLC';
 import { AnchorProvider } from '@coral-xyz/anchor';
-import { Api } from '../constants';
+import { Api, OrderCreationStatus } from '../constants';
 import { ISuiHTLC } from '../sui/suiHTLC.types';
 import { WalletWithRequiredFeatures } from '@mysten/wallet-standard';
 import { IBitcoinHTLC } from '../bitcoin/bitcoinhtlc.types';
@@ -17,6 +17,9 @@ import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
 import { ITronHTLC } from '../tron/tronHTLC.types';
 import { Adapter } from '@tronweb3/tronwallet-abstract-adapter';
 import { TronWeb } from 'tronweb';
+import { IXrplHTLC } from '../xrpl/xrplHTLC.types';
+import { Wallet as XrplWallet } from 'xrpl';
+import { vanilla as CrossmarkSDK } from '@crossmarkio/sdk';
 
 export type SwapParams = {
     /**
@@ -47,6 +50,14 @@ export type SwapParams = {
      * Addresses for the order.
      */
     addresses?: Partial<Record<BlockchainType, string>>;
+    /**
+     * Address for source chain.
+     */
+    sourceAddress?: string;
+    /**
+     * Address for destination chain.
+     */
+    destinationAddress?: string;
     /**
      * Integrator fee for the order.
      */
@@ -73,9 +84,10 @@ export interface IGardenJS extends IOrderbook {
     /**
      * Create Order
      * @param {SwapParams} params - The parameters for creating the order.
+     * @param {SwapProgressCallback} onProgress - Optional callback for progress messages: 'order created', 'order initiating', 'order initiated'.
      * @returns {AsyncResult<string, string>} The result of the swap operation.
      */
-    createSwap(params: SwapParams): AsyncResult<CreateOrderResponse | string, string>;
+    createSwap(params: SwapParams, onProgress?: (status: OrderCreationStatus) => void): AsyncResult<CreateOrderResponse | string, string>;
     /**
      * The current quote.
      * @readonly
@@ -148,6 +160,9 @@ export type GardenHTLCModules = {
     sui?: ISuiHTLC;
     bitcoin?: IBitcoinHTLC;
     tron?: ITronHTLC;
+    xrpl?: IXrplHTLC;
+    litecoin?: IBitcoinHTLC;
+    alpen_signet?: IBitcoinHTLC;
 };
 export type GardenWalletModules = {
     evm?: WalletClient;
@@ -156,6 +171,7 @@ export type GardenWalletModules = {
     sui?: WalletWithRequiredFeatures | Ed25519Keypair;
     bitcoin?: IBitcoinWallet;
     tron?: TronWeb | Adapter;
+    xrpl?: XrplWallet | CrossmarkSDK;
 };
 export type GardenConfigWithWallets = GardenCoreConfig & {
     wallets?: GardenWalletModules;
@@ -169,4 +185,8 @@ export type ResponseTypeMap = {
     [BlockchainType.starknet]: StarknetOrderResponse;
     [BlockchainType.solana]: SolanaOrderResponse;
     [BlockchainType.sui]: SuiOrderResponse;
+    [BlockchainType.tron]: EvmOrderResponse;
+    [BlockchainType.xrpl]: XrplOrderResponse;
+    [BlockchainType.litecoin]: BitcoinOrderResponse;
+    [BlockchainType.alpen_signet]: BitcoinOrderResponse;
 };

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

@@ -1,6 +1,6 @@
 export declare const starknetHtlcABI: ({
-    name: string;
     type: string;
+    name: string;
     interface_name: string;
     members?: undefined;
     items?: undefined;
@@ -8,8 +8,8 @@ export declare const starknetHtlcABI: ({
     kind?: undefined;
     variants?: undefined;
 } | {
-    name: string;
     type: string;
+    name: string;
     members: {
         name: string;
         type: string;
@@ -20,34 +20,28 @@ export declare const starknetHtlcABI: ({
     kind?: undefined;
     variants?: undefined;
 } | {
-    name: string;
     type: string;
-    items: ({
-        name: string;
+    name: string;
+    items: {
         type: string;
-        inputs: never[];
-        outputs: {
-            type: string;
-        }[];
-        state_mutability: string;
-    } | {
         name: string;
-        type: string;
         inputs: {
             name: string;
             type: string;
         }[];
-        outputs: never[];
+        outputs: {
+            type: string;
+        }[];
         state_mutability: string;
-    })[];
+    }[];
     interface_name?: undefined;
     members?: undefined;
     inputs?: undefined;
     kind?: undefined;
     variants?: undefined;
 } | {
-    name: string;
     type: string;
+    name: string;
     inputs: {
         name: string;
         type: string;
@@ -58,26 +52,26 @@ export declare const starknetHtlcABI: ({
     kind?: undefined;
     variants?: undefined;
 } | {
-    kind: string;
-    name: string;
     type: string;
+    name: string;
+    kind: string;
     members: {
-        kind: string;
         name: string;
         type: string;
+        kind: string;
     }[];
     interface_name?: undefined;
     items?: undefined;
     inputs?: undefined;
     variants?: undefined;
 } | {
-    kind: string;
-    name: string;
     type: string;
+    name: string;
+    kind: string;
     variants: {
-        kind: string;
         name: string;
         type: string;
+        kind: string;
     }[];
     interface_name?: undefined;
     members?: undefined;

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

@@ -39,11 +39,12 @@ export declare const toXOnly: (pubKey: string) => string;
 export declare const isValidBitcoinPubKey: (pubKey: string) => boolean;
 export declare const constructOrderPair: (sourceChain: Chain, sourceAsset: string, destChain: Chain, destAsset: string) => string;
 export declare function validateBTCAddress(address: string, networkType: Environment): boolean;
+export declare function validateLTCAddress(address: string, networkType: Environment): boolean;
 export declare function generateOutputs(output: Buffer, count: number): Buffer[];
 export declare const getBitcoinNetworkFromEnvironment: (network: Network) => BitcoinNetwork;
 export declare const getBitcoinNetworkFromNetwork: (network: Network) => bitcoin.networks.Network;
 export declare const isHexString: (value: string) => boolean;
-export declare const formatStarknetSignature: (sig: Signature) => Err<string> | Ok<string[]>;
+export declare const formatStarknetSignature: (sig: Signature) => Err<string> | Ok<string> | Ok<string[]>;
 export declare function reversify(val: string): Buffer;
 export declare function isErrorWithMessage(err: unknown): err is {
     message: string;

package/dist/src/lib/xrpl/xrplHTLC.types.d.ts

@@ -0,0 +1,32 @@
+import { Order, XrplOrderResponse } from '@gardenfi/orderbook';
+import { AsyncResult } from '@gardenfi/utils';
+import { EscrowCancel, EscrowCreate, EscrowFinish, Wallet as XrplWallet } from 'xrpl';
+import { vanilla as CrossmarkSDK } from '@crossmarkio/sdk';
+
+export type SupportedWallet = XrplWallet | CrossmarkSDK;
+export type SupportedTx = EscrowCreate | EscrowFinish | EscrowCancel;
+export interface IXrplHTLC {
+    /**
+     * 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: Order | XrplOrderResponse): 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>;
+}

package/dist/src/lib/xrpl/xrplRelay.d.ts

@@ -0,0 +1,26 @@
+import { Order, XrplOrderResponse } from '@gardenfi/orderbook';
+import { AsyncResult, IAuth, Network, Url } from '@gardenfi/utils';
+import { IXrplHTLC, SupportedWallet } from './xrplHTLC.types';
+
+export declare class XrplRelay implements IXrplHTLC {
+    private url;
+    private auth;
+    private client;
+    private wallet;
+    private relayer;
+    constructor(relayerUrl: string | Url, network: Network, auth: IAuth, wallet: SupportedWallet);
+    private isXrplWallet;
+    private isCrossmarkWallet;
+    get htlcActorAddress(): string;
+    initiate(order: Order | XrplOrderResponse): AsyncResult<string, string>;
+    private initiateFromOrderResponse;
+    private initiateFromOrder;
+    redeem(order: Order, secret: string): AsyncResult<string, string>;
+    refund(): AsyncResult<string, string>;
+    private submitTransaction;
+    private signPreparedTransaction;
+    /**
+     * Builds the condition string from hash (ASN.1 DER encoding)
+     */
+    private buildCondition;
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@gardenfi/core",
-  "version": "3.0.7-beta.1",
+  "version": "3.0.8-beta.1",
   "type": "module",
   "scripts": {
     "build": "vite build",
     "test": "vitest run",
     "dev": "vite build --watch",
-    "link": "yarn link"
+    "link": "bun link"
   },
   "files": [
     "dist"
@@ -28,8 +28,8 @@
   },
   "dependencies": {
     "@coral-xyz/anchor": "^0.31.1",
-    "@gardenfi/orderbook": "3.0.5-beta.4",
-    "@gardenfi/utils": "3.0.0",
+    "@gardenfi/orderbook": "3.0.6-beta.1",
+    "@gardenfi/utils": "3.0.0-beta.3",
     "@mysten/signers": "^0.3.4",
     "@mysten/sui": "^1.37.1",
     "@mysten/wallet-standard": "^0.16.9",
@@ -39,12 +39,14 @@
     "bip32": "^4.0.0",
     "bip39": "^3.1.0",
     "bitcoinjs-lib": "^6.1.5",
+    "bitcore-lib-ltc": "^10.10.5",
     "ecpair": "^2.1.0",
     "node-cache": "^5.1.2",
-    "starknet": "7.6.4",
+    "starknet": "8.0.0",
     "tiny-secp256k1": "^2.2.3",
     "tronweb": "^6.0.4",
     "varuint-bitcoin": "^1.1.2",
+    "xrpl": "^4.5.0",
     "yup": "^1.4.0"
   },
   "devDependencies": {
@@ -55,4 +57,4 @@
     "vitest": "^1.6.0"
   },
   "sideEffects": false
-}
+}