@gardenfi/core 2.1.14 → 2.2.0

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

@@ -0,0 +1,296 @@
+declare const _default: {
+  "address": "2bag6xpshpvPe7SJ9nSDLHpxqhEAoHPGpEkjNSv7gxoF",
+  "metadata": {
+    "name": "solana_native_swaps",
+    "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": "swap_account",
+          "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": "secret_hash"
+              }
+            ]
+          }
+        },
+        {
+          "name": "initiator",
+          "docs": ["Initiator must sign this transaction"],
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "system_program",
+          "address": "11111111111111111111111111111111"
+        }
+      ],
+      "args": [
+        {
+          "name": "amount_lamports",
+          "type": "u64"
+        },
+        {
+          "name": "expires_in_slots",
+          "type": "u64"
+        },
+        {
+          "name": "redeemer",
+          "type": "pubkey"
+        },
+        {
+          "name": "secret_hash",
+          "type": {
+            "array": ["u8", 32]
+          }
+        }
+      ]
+    },
+    {
+      "name": "instant_refund",
+      "discriminator": [211, 202, 103, 41, 183, 147, 59, 251],
+      "accounts": [
+        {
+          "name": "swap_account",
+          "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": "swap_account",
+          "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": "swap_account",
+          "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": "amount_lamports",
+            "type": "u64"
+          },
+          {
+            "name": "expires_in_slots",
+            "type": "u64"
+          },
+          {
+            "name": "initiator",
+            "type": "pubkey"
+          },
+          {
+            "name": "redeemer",
+            "type": "pubkey"
+          },
+          {
+            "name": "secret_hash",
+            "type": {
+              "array": ["u8", 32]
+            }
+          }
+        ]
+      }
+    },
+    {
+      "name": "InstantRefunded",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "initiator",
+            "type": "pubkey"
+          },
+          {
+            "name": "secret_hash",
+            "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": "secret_hash",
+            "type": {
+              "array": ["u8", 32]
+            }
+          }
+        ]
+      }
+    },
+    {
+      "name": "SwapAccount",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "amount_lamports",
+            "type": "u64"
+          },
+          {
+            "name": "expiry_slot",
+            "type": "u64"
+          },
+          {
+            "name": "initiator",
+            "type": "pubkey"
+          },
+          {
+            "name": "redeemer",
+            "type": "pubkey"
+          },
+          {
+            "name": "secret_hash",
+            "type": {
+              "array": ["u8", 32]
+            }
+          }
+        ]
+      }
+    }
+  ]
+}
+;
+
+export default _default;

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

@@ -0,0 +1,71 @@
+import { AnchorProvider } from '@coral-xyz/anchor';
+import { AsyncResult } from '@catalogfi/utils';
+import { Url } from '@gardenfi/utils';
+import { ISolanaHTLC } from '../htlc/ISolanaHTLC';
+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.
+ */
+export declare class SolanaRelay implements ISolanaHTLC {
+    private provider;
+    private url;
+    /**
+     * 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.
+     */
+    private swapAccount?;
+    private program;
+    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
+     * @throws {Error} If any required parameters are missing or invalid
+     */
+    constructor(provider: AnchorProvider, url: Url, relayer: string, programAddress: 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
+     */
+    get htlcActorAddress(): string;
+    /**
+     * Sends a transaction via the relayer.
+     * @param {web3.Transaction} transaction - The transaction to send
+     * @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;
+    /**
+     * 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 {Promise<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>;
+    /**
+     * DO NOT CALL THIS FUNCTION. Refund is automatically taken care of by the relayer!
+     * This method exists only to satisfy the ISolanaHTLC interface but is not intended for direct use.
+     * @param order - Matched order object
+     * @returns {AsyncResult<string, string>} Always returns an error message
+     * @deprecated This function should never be called directly
+     */
+    refund(): AsyncResult<string, string>;
+}

package/dist/src/lib/solana/solanaTypes.d.ts

@@ -0,0 +1,31 @@
+import { web3, BN } from '@coral-xyz/anchor';
+import { MatchedOrder } from '@gardenfi/orderbook';
+
+/**
+ * A Swap configuration in Solana
+ */
+export declare class SwapConfig {
+    swapId: number[];
+    redeemer: web3.PublicKey;
+    secretHash: number[];
+    amount: BN;
+    expiresIn: BN;
+    /**
+     * @param swapId - A Unique 32-bit ID to represent this configuration in hex
+     * @param redeemer - The Solana address of redeemer in base58
+     * @param secretHash - The 32-bit Secret Hash used for this Swap in hex
+     * @param amount - The Swap amount in lowest denomination
+     * @param expiresIn - The number of Slots in which the Swap should expire. (1 Solana Slot = 400 ms)
+     */
+    constructor(swapId: string, redeemer: string, secretHash: string, amount: bigint, expiresIn: number);
+    /**
+     * Constructs a SwapConfig from a matched order object with Solana as a source swap
+     * @param order - The MatchedOrder with a Solana as source swap
+     */
+    static from(order: MatchedOrder): SwapConfig;
+}
+/**
+ * Checks whether given secret is a valid 32 byte hex string.
+ * @returns Validated and decoded secret
+ */
+export declare function validateSecret(secret: string): number[];

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

@@ -4,6 +4,7 @@ import { Chain } from '@gardenfi/orderbook';
 import { Signature } from 'starknet';
 import { Api } from './constants';
 import { ApiConfig } from './garden/garden.types';
+import { web3 } from '@coral-xyz/anchor';
 
 export declare function resolveApiConfig(env: ApiConfig): {
     api: Api;
@@ -32,3 +33,4 @@ export declare function validateBTCAddress(address: string, networkType: Environ
 export declare const getBitcoinNetwork: (network: Environment) => BitcoinNetwork;
 export declare const isHexString: (value: string) => boolean;
 export declare const formatStarknetSignature: (sig: Signature) => Ok<string[]> | Err<string>;
+export declare const waitForSolanaTxConfirmation: (connection: web3.Connection, txHash: string) => Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gardenfi/core",
-  "version": "2.1.14",
+  "version": "2.2.0",
   "type": "module",
   "scripts": {
     "build": "vite build",
@@ -26,9 +26,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
+    "@catalogfi/utils": "^0.1.6",
     "@catalogfi/wallets": "^0.2.59",
-    "@gardenfi/orderbook": "2.1.10",
-    "@gardenfi/utils": "2.1.3",
+    "@coral-xyz/anchor": "^0.30.1",
+    "@gardenfi/orderbook": "2.2.0",
+    "@gardenfi/utils": "2.2.0",
     "bignumber.js": "^9.1.2",
     "bitcoinjs-lib": "^6.1.6",
     "starknet": "6.23.1",