chore: improve tree traversal

sdk/src/ordinal-api/index.ts

@@ -477,18 +477,18 @@ export class OrdinalsClient {
     }
 
     /**
-     * Retrieves inscriptions based on the address.
+     * Retrieves outputs based on the address.
      * @param {String} address - The Bitcoin address to check.
      * @param {('cardinal' | 'inscribed' | 'runic' | 'any')} [type] - Optional type of UTXOs to be returned. If omitted returns all UTXOs.
-     * @returns {Promise<OutputJson>} A Promise that resolves to the inscription data.
+     * @returns {Promise<OutputJson[]>} A Promise that resolves to the inscription data.
      *
      * @example
      * ```typescript
      * const client = new OrdinalsClient("regtest");
      * const address: string = "enter_address_here";
      * const type: 'cardinal' | 'inscribed' | 'runic' = "enter_type_here";
-     * const output = await client.getOutputsFromAddress(address, type?);
-     * console.log("Output:", output);
+     * const outputs = await client.getOutputsFromAddress(address, type?);
+     * console.log("Outputs:", outputs);
      * ```
      */
     getOutputsFromAddress(address: string, type?: 'cardinal' | 'inscribed' | 'runic' | 'any'): Promise<OutputJson[]> {
@@ -498,6 +498,24 @@ export class OrdinalsClient {
         return this.getJson<OutputJson[]>(`${this.basePath}/outputs/${address}?${searchParams}`);
     }
 
+    /**
+     * Retrieves outputs based on the out points list.
+     * @param {string[]} data - The list of out points to check.
+     * @returns {Promise<OutputJson[]>} A Promise that resolves to the inscription data.
+     *
+     * @example
+     * ```typescript
+     * const client = new OrdinalsClient("regtest");
+     * const outpoints: string[] = "enter_outpoints_here";
+     * const outputs = await client.getOutputsFromOutPoints(outpoints);
+     * console.log("Outputs:", outputs);
+     * ```
+     */
+    getOutputsFromOutPoints(outpoints: string[]): Promise<OutputJson[]> {
+        // https://docs.ordinals.com/guides/api.html#description-19
+        return this.postJson<OutputJson[]>(`${this.basePath}/outputs/`, outpoints);
+    }
+
     /**
      * Retrieves an inscription based on its sat (something specific to your use case).
      * @param {number} sat - The sat of the inscription to retrieve.
@@ -554,6 +572,24 @@ export class OrdinalsClient {
         return (await response.json()) as Promise<T>;
     }
 
+    /**
+     * @ignore
+     */
+    private async postJson<T>(url: string, body: object): Promise<T> {
+        const response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+            },
+            body: JSON.stringify(body),
+        });
+        if (!response.ok) {
+            throw new Error(response.statusText);
+        }
+        return (await response.json()) as Promise<T>;
+    }
+
     /**
      * @ignore
      */

sdk/src/wallet/utxo.ts

@@ -27,18 +27,24 @@ class TreeNode<T> {
     }
 }
 
-const createUtxoNodes = (utxos: UTXO[], cardinalOutputsSet: Set<string>) =>
-    utxos.reduce(
-        (acc, utxo) => {
-            if (!cardinalOutputsSet.has(OutPoint.toString(utxo)))
-                // mark node as containing ordinals
-                acc.push(new TreeNode<OutputNodeData>({ ...utxo, cardinal: false }));
-            else acc.push(null);
-
-            return acc;
-        },
-        [] as (TreeNode<OutputNodeData> | null)[]
-    );
+const isCardinal = (output: OutputJson) => output.inscriptions.length === 0 && Object.keys(output.runes).length === 0;
+
+const createUtxoNodes = async (utxos: UTXO[], cardinalOutputsSet: Set<string>, ordinalsClient: OrdinalsClient) => {
+    const outputs = await ordinalsClient.getOutputsFromOutPoints(utxos.map(OutPoint.toString));
+
+    return utxos.map((utxo, index) => {
+        const output = outputs[index];
+
+        if (!cardinalOutputsSet.has(OutPoint.toString(utxo)))
+            return new TreeNode<OutputNodeData>({
+                ...utxo,
+                cardinal: isCardinal(output),
+                indexed: output.indexed,
+            });
+
+        return null;
+    });
+};
 
 const processNodes = async (
     rootNodes: (TreeNode<OutputNodeData> | null)[],
@@ -58,22 +64,22 @@ const processNodes = async (
         if (transaction.status.confirmed) {
             // if confirmed check if it contains ordinals
             childNode.val.cardinal = cardinalOutputsSet.has(OutPoint.toString(childNode.val));
-        } else {
-            const response = await ordinalsClient.getInscriptionsFromOutPoint(childNode.val);
-
-            if (Object.keys(response.runes).length === 0 && response.inscriptions.length === 0) {
-                // if not confirmed check inputs for current utxo
-                childNode.children = transaction.vin.map((vin) => {
-                    return new TreeNode<OutputNodeData>({
-                        vout: vin.vout,
-                        txid: vin.txid,
-                        // mark node as containing ordinals
-                        cardinal: false,
-                    });
+        } else if (!childNode.val.indexed || childNode.val.cardinal) {
+            const outputs = await ordinalsClient.getOutputsFromOutPoints(transaction.vin.map(OutPoint.toString));
+
+            // if not confirmed check inputs for current utxo
+            childNode.children = transaction.vin.map((vin, index) => {
+                const output = outputs[index];
+
+                return new TreeNode<OutputNodeData>({
+                    vout: vin.vout,
+                    txid: vin.txid,
+                    cardinal: isCardinal(output),
+                    indexed: output.indexed,
                 });
+            });
 
-                queue.push(...childNode.children);
-            }
+            queue.push(...childNode.children);
         }
     }
 };
@@ -85,7 +91,7 @@ const checkUtxoNode = (node: TreeNode<OutputNodeData>) => {
     return node.children.reduce((acc, child) => acc && checkUtxoNode(child), true);
 };
 
-type OutputNodeData = Pick<UTXO, 'txid' | 'vout'> & { cardinal: boolean };
+type OutputNodeData = Pick<UTXO, 'txid' | 'vout'> & { cardinal: boolean; indexed: boolean };
 
 export interface Input {
     txid: string;
@@ -177,7 +183,7 @@ export async function createBitcoinPsbt(
 
     const cardinalOutputsSet = new Set(cardinalOutputs.map((output) => output.outpoint));
 
-    const rootUtxoNodes = createUtxoNodes(utxos, cardinalOutputsSet);
+    const rootUtxoNodes = await createUtxoNodes(utxos, cardinalOutputsSet, ordinalsClient);
 
     await processNodes(rootUtxoNodes, cardinalOutputsSet, esploraClient, ordinalsClient);
 
@@ -393,7 +399,7 @@ export async function estimateTxFee(
 
     const cardinalOutputsSet = new Set(cardinalOutputs.map((output) => output.outpoint));
 
-    const rootUtxoNodes = createUtxoNodes(utxos, cardinalOutputsSet);
+    const rootUtxoNodes = await createUtxoNodes(utxos, cardinalOutputsSet, ordinalsClient);
 
     await processNodes(rootUtxoNodes, cardinalOutputsSet, esploraClient, ordinalsClient);
 
@@ -509,7 +515,7 @@ export async function getBalance(address?: string) {
 
     const cardinalOutputsSet = new Set(cardinalOutputs.map((output) => output.outpoint));
 
-    const rootUtxoNodes = createUtxoNodes(utxos, cardinalOutputsSet);
+    const rootUtxoNodes = await createUtxoNodes(utxos, cardinalOutputsSet, ordinalsClient);
 
     await processNodes(rootUtxoNodes, cardinalOutputsSet, esploraClient, ordinalsClient);