@omnity/ree-client-ts-sdk 0.3.3 → 0.3.5

package/README.md

@@ -99,7 +99,7 @@ transaction.addIntention({
 });
 
 // Build and execute
-const psbt = await transaction.build();
+const { psbt } = await transaction.build();
 const signedPsbt = await wallet.signPsbt(psbt);
 const result = await transaction.send(signedPsbt.toHex());
 ```
@@ -117,6 +117,7 @@ const transaction = await client.createTransaction({
 // Intention 1: Deposit BTC to Pool 1
 transaction.addIntention({
   poolAddress: "bc1p...pool1",
+  poolUtxos: [],
   inputCoins: [
     {
       // Deposit 0.0005 BTC
@@ -135,6 +136,7 @@ transaction.addIntention({
 // Intention 2: Swap runes between pools
 transaction.addIntention({
   poolAddress: "bc1q...pool2",
+  poolUtxos: [],
   inputCoins: [
     {
       // Send 500 of rune A,
@@ -160,7 +162,7 @@ transaction.addIntention({
 });
 
 // Build and execute the multi-intention transaction
-const psbt = await transaction.build();
+const { psbt } = await transaction.build();
 const signedPsbt = await wallet.signPsbt(psbt);
 const result = await transaction.send(signedPsbt.toHex());
 ```
@@ -196,6 +198,7 @@ function WalletComponent() {
     // Add multiple intentions
     tx.addIntention({
       poolAddress: "pool1",
+      poolUtxos: [],
       inputCoins: [{
         coin: {
           id: "0:0",
@@ -216,6 +219,7 @@ function WalletComponent() {
 
     tx.addIntention({
       poolAddress: "pool2",
+      poolUtxos: [],
       inputCoins: [{
         coin: {
           id: "840000:3",
@@ -234,7 +238,7 @@ function WalletComponent() {
       nonce: BigInt(Date.now() + 1),
     });
 
-    const psbt = await tx.build();
+    const { psbt } = await tx.build();
     // Sign and send...
   };
 
@@ -283,6 +287,7 @@ function MyComponent({ children }) {
 
     tx.addIntention({
       poolAddress: "bc1q...",
+      poolUtxos: [],
       inputCoins: [
         {
           coin: {
@@ -297,7 +302,7 @@ function MyComponent({ children }) {
       nonce: depositOffer.nonce,
     });
 
-    const psbt = await tx.build();
+    const { psbt } = await tx.build();
 
     const signedPsbt = await signPsbt(psbt);
     const txid = await tx.send(signedPsbt.toHex());
@@ -373,7 +378,7 @@ Transaction builder for Bitcoin and Rune transactions with multi-intention suppo
 #### Methods
 
 - `addIntention(intention: Intention): void` - Add an intention to the transaction
-- `build(): Promise<bitcoin.Psbt>` - Build the PSBT with all intentions
+- `build(): Promise<{ psbt: bitcoin.Psbt, txid: string }>` - Build the PSBT with all intentions
 - `send(signedPsbtHex: string): Promise<any>` - Submit the signed transaction
 
 #### Intention Structure
@@ -383,7 +388,6 @@ interface Intention {
   // Target pool address
   poolAddress: string;
   // the UTXOs obtained through the pool’s pre methods
-  // if not provided, will be fetched via the maestro API.
   poolUtxos?: [];
   // Coins being sent to the pool
   inputCoins: InputCoin[];

package/dist/index.d.ts

@@ -61,6 +61,8 @@ declare function getAddressType(address: string): AddressType;
 
 declare function getScriptByAddress(address: string, network?: Network): Uint8Array<ArrayBufferLike>;
 
+declare function getUtxoProof(utxos: Utxo[], network: Network): Promise<number[] | null>;
+
 declare function hexToBytes(hex: string): Uint8Array;
 
 export declare type InputCoin = {
@@ -471,11 +473,14 @@ export declare class Transaction {
      * @example
      * ```typescript
      * // After adding intentions
-     * const psbt = await transaction.build();
+     * const { psbt, txid } = await transaction.build();
      * const signedPsbt = await wallet.signPsbt(psbt);
      * ```
      */
-    build(): Promise<bitcoin.Psbt>;
+    build(): Promise<{
+        psbt: bitcoin.Psbt;
+        txid: string;
+    }>;
     /**
      * Submit the signed transaction to the orchestrator for execution
      * This method sends the signed PSBT along with the intention set to the orchestrator canister
@@ -605,7 +610,8 @@ export declare namespace utils {
         toBitcoinNetwork,
         getScriptByAddress,
         getAddressType,
-        formatPoolUtxo
+        formatPoolUtxo,
+        getUtxoProof
     }
 }