@omnity/ree-client-ts-sdk 0.4.1 → 0.4.3

package/README.md

@@ -70,9 +70,14 @@ const poolInfo = await client.getPoolInfo("pool-address");
 const transaction = await client.createTransaction({
   address: "bc1p...", // Bitcoin address for runes
   paymentAddress: "bc1q...", // Payment address for BTC
-  // feeRate: BigInt(25), // Optional manual fee rate in sat/vbyte
+  // feeRate: 25, // Optional manual fee rate in sat/vbyte
+  // mergeSelfRuneBtcOutputs: true, // Optional: reuse BTC output when your rune address also receives sats
 });
 
+// By default, runes delivered back to your own rune address are kept on a separate
+// dust output to avoid mixing with BTC change. Set `mergeSelfRuneBtcOutputs` to true
+// if you prefer to consolidate the runes and sats into the same output.
+
 // Add a single intention (e.g., swap BTC for runes)
 transaction.addIntention({
   poolAddress: "bc1p...",
@@ -112,7 +117,7 @@ const result = await transaction.send(signedPsbt.toHex());
 const transaction = await client.createTransaction({
   address: "bc1p...",
   paymentAddress: "bc1q...",
-  // feeRate: BigInt(25),
+  // feeRate: 25,
 });
 
 // Add multiple intentions in a single transaction
@@ -196,7 +201,7 @@ function WalletComponent() {
   const executeComplexTransaction = async () => {
     // Create transaction with multiple pools
     const tx = await createTransaction({
-      // feeRate: BigInt(25), // Optional manual fee rate override
+      feeRate: 25, // Optional manual fee rate override
     });
 
     // Add multiple intentions
@@ -375,7 +380,7 @@ new ReeClient(config: Config)
 
 ##### Transaction Methods
 
-- `createTransaction(params?: { feeRate?: bigint }): Promise<Transaction>` - Create a transaction with optional manual fee rate
+- `createTransaction(params?: { feeRate?: number }): Promise<Transaction>` - Create a transaction with optional manual fee rate
 
 ### Transaction
 
@@ -454,6 +459,7 @@ import {
   useRuneInfo,
   usePoolList,
   usePoolInfo,
+  useRecommendedFeeRate,
 } from "@ree-network/ts-sdk";
 
 function TradingDashboard() {
@@ -462,6 +468,11 @@ function TradingDashboard() {
   const { balance: runeBalance } = useRuneBalance("840000:3");
   const { utxos: btcUtxos } = useBtcUtxos();
   const { utxos: runeUtxos } = useRuneUtxos("840000:3");
+  const {
+    feeRate,
+    loading: feeRateLoading,
+    refetch: refreshFeeRate,
+  } = useRecommendedFeeRate();
 
   const [runes, setRunes] = useState([]);
 
@@ -482,6 +493,12 @@ function TradingDashboard() {
       <h2>Balances</h2>
       <div>BTC: {btcBalance} BTC</div>
       <div>Rune: {runeBalance}</div>
+      <div>
+        Recommended Fee Rate:{" "}
+        {feeRateLoading
+          ? "Loading..."
+          : `${feeRate?.min?.toString()} - ${feeRate?.max?.toString()} sat/vB`}
+      </div>
 
       <h2>Search Runes</h2>
       <button onClick={handleSearch}>Search DOG</button>
@@ -513,6 +530,10 @@ function TradingDashboard() {
 - `usePoolList(options?)` - Get all available pools
 - `usePoolInfo(poolAddress?, options?)` - Get specific pool information
 
+**Fee Rate Hooks:**
+
+- `useRecommendedFeeRate(options?)` - Retrieve recommended fee rate range
+
 #### Hook Usage Examples
 
 ```tsx

package/dist/index.d.ts

@@ -295,11 +295,16 @@ export declare class ReeClient {
      * @param params.involvedRuneId - Optional rune ID for rune swaps
      * @returns Transaction instance
      */
-    createTransaction({ address, paymentAddress, feeRate, }: {
+    createTransaction({ address, paymentAddress, feeRate, mergeSelfRuneBtcOutputs, }: {
         address: string;
         paymentAddress: string;
         feeRate?: number;
+        mergeSelfRuneBtcOutputs?: boolean;
     }): Promise<Transaction>;
+    getRecommendedFeeRate(): Promise<{
+        min: number;
+        max: number;
+    }>;
 }
 
 declare interface ReeContextValue {
@@ -530,6 +535,11 @@ export declare interface TransactionConfig {
     paymentAddress: string;
     /** Optional manual fee rate in satoshis per virtual byte */
     feeRate?: number;
+    /**
+     * When true, rune outputs to the local rune address reuse existing BTC value
+     * instead of emitting a separate dust output. Defaults to false.
+     */
+    mergeSelfRuneBtcOutputs?: boolean;
 }
 
 declare interface UseBalanceOptions {
@@ -584,6 +594,20 @@ export declare function usePoolList(): {
     refetch: () => Promise<void>;
 };
 
+/**
+ * Hook to retrieve the recommended fee rate range
+ * @returns Object with minimum/maximum fee rates, loading state, error, and refetch function
+ */
+export declare function useRecommendedFeeRate(options?: UseBalanceOptions): {
+    feeRate: {
+        min: number;
+        max: number;
+    } | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+};
+
 export declare function useRee(): ReeContextValue;
 
 /**