feat: tx status endpoint

packages/btcindexer/db/migrations/0001_initial_schema.sql

@@ -2,7 +2,7 @@
 CREATE TABLE processed_blocks (
     height INTEGER PRIMARY KEY,
     hash TEXT NOT NULL UNIQUE,
-    processed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+    processed_at INTEGER DEFAULT unixepoch('subsec')
 ) STRICT;
 
 -- This table tracks the nBTC deposit txs
@@ -14,8 +14,8 @@ CREATE TABLE nbtc_txs (
     sui_recipient TEXT NOT NULL,
     amount_sats INTEGER NOT NULL,
     status TEXT NOT NULL, -- 'broadcasting' | 'confirming' | 'finalized' | 'minting' | 'minted' | 'reorg'
-    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
-    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+    created_at INTEGER DEFAULT unixepoch('subsec'),
+    updated_at INTEGER DEFAULT unixepoch('subsec')
 ) STRICT;
 
 -- Indexes

packages/btcindexer/src/btcindexer.test.ts

@@ -1,9 +1,10 @@
 import { describe, it, assert, vi } from "vitest";
-import { Deposit, Indexer, ProofResult, storageFromEnv } from "../src/btcindexer";
+import { Indexer, storageFromEnv } from "../src/btcindexer";
 import { Block, networks, Transaction } from "bitcoinjs-lib";
 import { MerkleTree } from "merkletreejs";
 import SHA256 from "crypto-js/sha256";
 import { SuiClient, SuiClientCfg } from "./sui_client";
+import { Deposit, ProofResult } from "./models";
 
 interface TxInfo {
 	id: string;

packages/btcindexer/src/btcindexer.ts

@@ -4,38 +4,19 @@ import { OP_RETURN } from "./opcodes";
 import { MerkleTree } from "merkletreejs";
 import SHA256 from "crypto-js/sha256";
 import SuiClient, { suiClientFromEnv } from "./sui_client";
+import {
+	Deposit,
+	ProofResult,
+	PendingTx,
+	BlockRecord,
+	Storage,
+	NbtcTxStatus,
+	NbtcTxStatusResp,
+	NbtcTxD1Row,
+} from "./models";
 
 const CONFIRMATION_DEPTH = 8;
 
-export interface Deposit {
-	vout: number;
-	amountSats: number;
-	suiRecipient: string;
-}
-
-export interface ProofResult {
-	proofPath: Buffer[];
-	merkleRoot: string;
-}
-
-export interface PendingTx {
-	tx_id: string;
-	block_hash: string | null;
-	block_height: number;
-}
-
-interface BlockRecord {
-	tx_id: string;
-	block_hash: string;
-	block_height: number;
-}
-
-interface Storage {
-	d1: D1Database; // SQL DB
-	blocksDB: KVNamespace;
-	nbtcTxDB: KVNamespace;
-}
-
 export function storageFromEnv(env: Env): Storage {
 	return { d1: env.DB, blocksDB: env.btc_blocks, nbtcTxDB: env.nbtc_txs };
 }
@@ -183,6 +164,10 @@ export class Indexer implements Storage {
 			console.log(`Cron: No new nBTC deposits found in the scanned blocks`);
 		}
 
+		const latestHeightProcessed = Math.max(...blocksToProcess.results.map((b) => b.height));
+		await this.blocksDB.put("chain_tip", latestHeightProcessed.toString());
+		console.log(`Cron: Updated chain_tip to ${latestHeightProcessed}`);
+
 		const heightsToDelete = blocksToProcess.results.map((r) => r.height);
 		const heights = heightsToDelete.join(",");
 		const deleteStmt = `DELETE FROM processed_blocks WHERE height IN (${heights})`;
@@ -401,4 +386,57 @@ export class Indexer implements Storage {
 		}
 		return updates;
 	}
+
+	async getStatusByTxid(txid: string): Promise<NbtcTxStatusResp | null> {
+		const latestHeightStr = await this.blocksDB.get("chain_tip");
+		const latestHeight = latestHeightStr ? parseInt(latestHeightStr, 10) : 0;
+
+		const tx = await this.d1
+			.prepare("SELECT * FROM nbtc_txs WHERE tx_id = ?")
+			.bind(txid)
+			.first<NbtcTxD1Row>();
+
+		if (!tx) {
+			return null;
+		}
+
+		const blockHeight = tx.block_height as number;
+		const confirmations = blockHeight ? latestHeight - blockHeight + 1 : 0;
+
+		return {
+			btc_tx_id: tx.tx_id,
+			status: tx.status as NbtcTxStatus,
+			block_height: blockHeight,
+			confirmations: confirmations > 0 ? confirmations : 0,
+			sui_recipient: tx.sui_recipient,
+			amount_sats: tx.amount_sats,
+		};
+	}
+
+	async getStatusBySuiAddress(suiAddress: string): Promise<NbtcTxStatusResp[]> {
+		const latestHeightStr = await this.blocksDB.get("chain_tip");
+		const latestHeight = latestHeightStr ? parseInt(latestHeightStr, 10) : 0;
+
+		const dbResult = await this.d1
+			.prepare("SELECT * FROM nbtc_txs WHERE sui_recipient = ? ORDER BY created_at DESC")
+			.bind(suiAddress)
+			.all<NbtcTxD1Row>();
+
+		if (!dbResult.results) {
+			return [];
+		}
+
+		return dbResult.results.map((tx): NbtcTxStatusResp => {
+			const blockHeight = tx.block_height as number;
+			const confirmations = blockHeight ? latestHeight - blockHeight + 1 : 0;
+			return {
+				btc_tx_id: tx.tx_id,
+				status: tx.status as NbtcTxStatus,
+				block_height: blockHeight,
+				confirmations: confirmations > 0 ? confirmations : 0,
+				sui_recipient: tx.sui_recipient,
+				amount_sats: tx.amount_sats,
+			};
+		});
+	}
 }

packages/btcindexer/src/models.ts

@@ -0,0 +1,51 @@
+export interface Deposit {
+	vout: number;
+	amountSats: number;
+	suiRecipient: string;
+}
+
+export interface ProofResult {
+	proofPath: Buffer[];
+	merkleRoot: string;
+}
+
+export interface PendingTx {
+	tx_id: string;
+	block_hash: string | null;
+	block_height: number;
+}
+
+export interface BlockRecord {
+	tx_id: string;
+	block_hash: string;
+	block_height: number;
+}
+
+export interface Storage {
+	d1: D1Database; // SQL DB
+	blocksDB: KVNamespace;
+	nbtcTxDB: KVNamespace;
+}
+
+export type NbtcTxStatus = "confirming" | "finalized" | "minted" | "failed" | "reorg";
+
+export interface NbtcTxStatusResp {
+	btc_tx_id: string;
+	status: NbtcTxStatus;
+	block_height: number | null;
+	confirmations: number;
+	sui_recipient: string;
+	amount_sats: number;
+}
+
+export interface NbtcTxD1Row {
+	tx_id: string;
+	block_hash: string;
+	block_height: number | null;
+	vout: number;
+	sui_recipient: string;
+	amount_sats: number;
+	status: NbtcTxStatus;
+	created_at: number;
+	updated_at: number;
+}

packages/btcindexer/src/router.ts

@@ -1,4 +1,5 @@
 import { IRequest, Router, error, json } from "itty-router";
+import { isValidSuiAddress } from "@mysten/sui/utils";
 
 import { Indexer } from "./btcindexer";
 import { RestPath } from "./api/client";
@@ -26,6 +27,10 @@
 		r.put(RestPath.blocks, this.putBlocks);
 		r.put(RestPath.nbtcTx, this.putNbtcTx);
 
+		// ?sui_recipient="0x..."  - query by sui address
+		r.get(RestPath.nbtcTx, this.getStatusBySuiAddress);
+		r.get(RestPath.nbtcTx + "/:txid", this.getStatusByTxid); // query by bitcoin_tx_id
+
 		//
 		// TESTING
 		// we can return Response object directly, to avoid JSON serialization
@@ -78,7 +83,7 @@
 		}
 	};
 
 	putNbtcTx = async (req: IRequest) => {
 		return { inserted: await this.indexer().putNbtcTx() };
 	};
 
@@ -99,4 +104,25 @@
 		const key = req.params.key;
 		return kv.get(key);
 	};
+
+	getStatusByTxid = async (req: IRequest) => {
+		const { txid } = req.params;
+		const result = await this.indexer().getStatusByTxid(txid);
+
+		if (result === null) {
+			return error(404, "Transaction not found.");
+		}
+		return result;
+	};
+
+	getStatusBySuiAddress = async (req: IRequest) => {
+		const suiRecipient = req.query.sui_recipient;
+		if (!suiRecipient || typeof suiRecipient !== "string") {
+			return error(400, "Missing or invalid sui_recipient query parameter.");
+		}
+		if (!isValidSuiAddress(suiRecipient)) {
+			return error(400, "Invalid SUI address format.");
+		}
+		return this.indexer().getStatusBySuiAddress(suiRecipient);
+	};
 }

packages/btcindexer/src/sui_client.ts

@@ -3,7 +3,7 @@ import type { Signer } from "@mysten/sui/cryptography";
 import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
 import { Transaction as SuiTransaction } from "@mysten/sui/transactions";
 import { Transaction } from "bitcoinjs-lib";
-import { ProofResult } from "./btcindexer";
+import { ProofResult } from "./models";
 
 export interface SuiClientCfg {
 	network: "testnet" | "mainnet" | "devnet" | "localnet";