@gardenfi/core 2.4.6 → 2.5.0

package/dist/src/lib/solana/relayer/solanaRelay.d.ts

@@ -5,7 +5,7 @@ import { MatchedOrder } from '@gardenfi/orderbook';
 
 /**
  * A Relay is an endpoint that submits the transaction on-chain on one's behalf, paying any fees.
- * SolanaRelay is one such implementation performs the atomic swaps through a given relayer url.
+ * SolanaRelay is a unified implementation that performs atomic swaps for both SPL and native tokens.
  */
 export declare class SolanaRelay implements ISolanaHTLC {
     private provider;
@@ -13,37 +13,86 @@ export declare class SolanaRelay implements ISolanaHTLC {
     /**
      * The on-chain Program Derived Address (PDA) that facilitates this swap.
      * A PDA represents an on-chain memory space. It can store SOL too and is owned by a program (that derived it).
-     * This PDA stores the swap state (initiator, redeemer, secrethash etc) on-chain and also escrows the SOL.
+     * This PDA stores the swap state (initiator, redeemer, secrethash etc) on-chain and also escrows the tokens/SOL.
      */
-    private swapAccount?;
-    private program;
+    private splProgram?;
+    private nativeProgram?;
     private relayer;
     /**
      * Creates a new instance of SolanaRelay.
      * @param {AnchorProvider} provider - An abstraction of RPC connection and a Wallet
      * @param {Url} endpoint - API endpoint of the relayer node
      * @param {string} relayer - On-chain address of the relayer in base58 format
+     * @param {string} splProgramAddress - On-chain address of the SPL token swap program
+     * @param {string} nativeProgramAddress - On-chain address of the native token swap program
      * @throws {Error} If any required parameters are missing or invalid
      */
-    constructor(provider: AnchorProvider, url: Url, relayer: string, programAddress: string);
+    constructor(provider: AnchorProvider, url: Url, relayer: string, programAddress: {
+        native?: string;
+        spl?: string;
+    });
     /**
-     * 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
+     * Gets the on-chain address of the current user's wallet.
+     * @returns {string} The wallet's on-chain address in base58 format
+     * @throws {Error} If no provider public key is found
      */
     get htlcActorAddress(): string;
     /**
-     * Sends a transaction via the relayer.
+     * Determines if the given order is for a native Solana token (SOL).
+     * @param {MatchedOrder} order - The matched order to check
+     * @returns {boolean} True if it's a native token, false if it's an SPL token
+     * @private
+     */
+    private isNativeToken;
+    /**
+     * Sends a transaction via the relayer for SPL tokens.
+     * @param {web3.Transaction} transaction - The transaction to send
+     * @param {string} orderId - The order ID for tracking
+     * @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
+     * @private
+     */
+    private sendSplViaRelayer;
+    /**
+     * Initiates a swap directly via HTLC (without relayer).
      * @param {web3.Transaction} transaction - The transaction to send
+     * @param {MatchedOrder} order - The matched order
      * @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
      * @private
      */
-    private sendViaRelayer;
     private initiateViaHTLC;
+    /**
+     * Creates a PDA (Program Derived Address) for the swap account.
+     * @param {Buffer} secretHash - The secret hash buffer
+     * @param {web3.PublicKey} programId - The program ID to use for PDA derivation
+     * @returns {web3.PublicKey} The derived PDA
+     * @private
+     */
+    private createSwapPDA;
+    /**
+     * Initiates a swap for SPL tokens.
+     * @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
+     * @private
+     */
+    private initiateSplSwap;
+    /**
+     * Initiates a swap for native tokens (SOL).
+     * @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
+     * @private
+     */
+    private initiateNativeSwap;
     /**
      * Initiates a swap by creating a new swap account and locking funds.
+     * Automatically detects whether to use SPL or native token handling.
      * @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

package/dist/src/lib/sui/htlc/suiHTLC.d.ts

@@ -0,0 +1,34 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult, Network } from '@gardenfi/utils';
+import { ISuiHTLC } from '../suiHTLC.types';
+import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
+import { WalletWithRequiredFeatures } from '@mysten/wallet-standard';
+
+export declare class SuiHTLC implements ISuiHTLC {
+    private client;
+    private account;
+    private network;
+    constructor(account: WalletWithRequiredFeatures | Ed25519Keypair, network: Network);
+    get htlcActorAddress(): string;
+    /**
+     * Initiates the HTLC
+     * @param order Order to initiate HTLC for
+     * @returns Transaction ID
+     */
+    initiate(order: MatchedOrder): AsyncResult<string, string>;
+    /**
+     * 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/sui/relay/suiRelay.d.ts

@@ -0,0 +1,17 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult, Network, Url } from '@gardenfi/utils';
+import { ISuiHTLC } from '../suiHTLC.types';
+import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
+import { WalletWithRequiredFeatures } from '@mysten/wallet-standard';
+
+export declare class SuiRelay implements ISuiHTLC {
+    private client;
+    private url;
+    private account;
+    private network;
+    constructor(relayerUrl: string | Url, account: WalletWithRequiredFeatures | Ed25519Keypair, network: Network);
+    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/sui/suiHTLC.types.d.ts

@@ -0,0 +1,28 @@
+import { MatchedOrder } from '@gardenfi/orderbook';
+import { AsyncResult } from '@gardenfi/utils';
+
+export interface ISuiHTLC {
+    /**
+     * 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,11 +1,12 @@
 {
   "name": "@gardenfi/core",
-  "version": "2.4.6",
+  "version": "2.5.0",
   "type": "module",
   "scripts": {
     "build": "vite build",
     "test": "vitest run",
-    "dev": "vite build --watch"
+    "dev": "vite build --watch",
+    "link": "yarn link"
   },
   "files": [
     "dist"
@@ -26,9 +27,13 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@coral-xyz/anchor": "^0.30.1",
-    "@gardenfi/orderbook": "2.4.6",
-    "@gardenfi/utils": "2.4.6",
+    "@coral-xyz/anchor": "^0.31.1",
+    "@gardenfi/orderbook": "2.5.0",
+    "@gardenfi/utils": "2.5.0",
+    "@mysten/signers": "^0.3.4",
+    "@mysten/sui": "^1.37.1",
+    "@mysten/wallet-standard": "^0.16.9",
+    "@solana/spl-token": "^0.4.13",
     "bignumber.js": "^9.1.2",
     "bip32": "^4.0.0",
     "bip39": "^3.1.0",