Merge branch 'master' into docs/ordinal-sdk

.github/workflows/sdk-npm.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: "20"
           registry-url: "https://registry.npmjs.org"

docs/docusaurus.config.js

@@ -22,8 +22,8 @@ const config = {
   organizationName: "bob-collective",
   projectName: "bob",
 
-  onBrokenLinks: "throw",
-  onBrokenMarkdownLinks: "throw",
+  onBrokenLinks: "warn",
+  onBrokenMarkdownLinks: "warn",
 
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want

sdk/package.json

@@ -19,7 +19,7 @@
   "devDependencies": {
     "@types/chai": "^4.3.6",
     "@types/mocha": "^10.0.2",
-    "@types/node": "^20.8.3",
+    "@types/node": "^20.8.9",
     "chai": "^4.3.10",
     "ecpair": "^2.1.0",
     "mocha": "^10.2.0",

sdk/src/electrs.ts

@@ -23,6 +23,15 @@ export interface MerkleProof {
     pos: number,
 }
 
+/**
+ * @ignore
+ */
+export interface UTXO {
+    txid: string
+    vout: number,
+    value: number,
+}
+
 export interface ElectrsClient {
     /**
      * Get the block hash of the Bitcoin block at a specific height.
@@ -122,6 +131,14 @@ export interface ElectrsClient {
      */
     getFeeEstimate(confirmationTarget: number): Promise<number>;
 
+    /**
+     * Get the Unspent Transaction Outputs (UTXOs) for an address.
+     *
+     * @param {string} address - The Bitcoin address to checl.
+     * @returns {Promise<Array<UTXO>>} A promise that resolves to an array of UTXOs.
+     */
+    getAddressUtxos(address: string): Promise<Array<UTXO>>;
+
     /**
      * Broadcast a raw transaction to the network.
      *
@@ -231,6 +248,32 @@ export class DefaultElectrsClient implements ElectrsClient {
         return response[confirmationTarget];
     }
 
+    /**
+     * @ignore
+     */
+    async getAddressUtxos(address: string, confirmed?: boolean): Promise<Array<UTXO>> {
+        const response = await this.getJson<Array<{
+            txid: string,
+            vout: number,
+            status: {
+                confirmed: boolean,
+                block_height: number,
+                block_hash: string,
+                block_time: number
+            },
+            value: number,
+        }>>(`${this.basePath}/address/${address}/utxo`);
+        return response
+            .filter(utxo => (typeof confirmed !== "undefined") ? confirmed === utxo.status.confirmed : true)
+            .map<UTXO>(utxo => {
+                return {
+                    txid: utxo.txid,
+                    vout: utxo.vout,
+                    value: utxo.value
+                }
+            });
+    }
+
     /**
      * @ignore
      */