@mysten-incubation/hashi 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @mysten-incubation/hashi
 
+## 0.2.0
+
+### Minor Changes
+
+- 5f9f592: Surface deposit time delay: add `bitcoinDepositTimeDelayMs` to `GovernanceConfig`, `approvalTimestampMs` and `confirmableAtMs` to `DepositInfo`, and `confirmableAtMs` to `DepositHistoryItem`
+
+## 0.1.1
+
+### Patch Changes
+
+- 5b3389e: Update README install instructions to use the published npm package
+- 72b6efc: Expand README to document the status, balance, history, fee, polling, and Bitcoin RPC APIs
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -1,6 +1,6 @@
 # @mysten-incubation/hashi
 
-TypeScript SDK for the [Hashi](https://github.com/MystenLabs/hashi) protocol — a Sui Move bridge that mints `hBTC` against Bitcoin deposits and burns it on withdrawal back to BTC.
+TypeScript SDK for the [Hashi](https://github.com/MystenLabs/hashi) protocol. Hashi is a decentralized Bitcoin collateralization primitive on Sui. Orchestrate native BTC directly from smart contracts—without centralized balance sheets.
 
 > [!CAUTION]
 > **Pre-1.0:** This package is under active development. Minor versions may contain breaking changes until the API stabilizes at 1.0.

package/dist/client.mjs

@@ -269,12 +269,17 @@ var HashiClient = class {
 				if (!depositEvent?.json) return null;
 				const parsed = depositEvent.json;
 				let status = "unknown";
+				let approvalTimestampMs = null;
+				let confirmableAtMs = null;
 				try {
-					await DepositRequest.get({
+					const reqObj = await DepositRequest.get({
 						client: this.#client,
 						objectId: parsed.request_id
 					});
-					const requestsBagId = (await this.#fetchBitcoinState()).deposit_queue.requests.id;
+					if (reqObj.json.approval_timestamp_ms != null) approvalTimestampMs = BigInt(reqObj.json.approval_timestamp_ms);
+					const [btcState, config$1] = await Promise.all([this.#fetchBitcoinState(), this.view.all().catch(() => null)]);
+					if (approvalTimestampMs !== null && config$1) confirmableAtMs = approvalTimestampMs + config$1.bitcoinDepositTimeDelayMs;
+					const requestsBagId = btcState.deposit_queue.requests.id;
 					status = (await this.#client.core.getDynamicField({
 						parentId: requestsBagId,
 						name: {
@@ -293,6 +298,8 @@ var HashiClient = class {
 					btcTxid: reverseTxidBytes(parsed.utxo_id.txid),
 					btcVout: parsed.utxo_id.vout,
 					timestampMs: BigInt(parsed.timestamp_ms),
+					approvalTimestampMs,
+					confirmableAtMs,
 					status,
 					suiTxDigest
 				};
@@ -393,7 +400,7 @@ var HashiClient = class {
 				};
 			},
 			transactionHistory: async (suiAddress) => {
-				const btcState = await this.#fetchBitcoinState();
+				const [btcState, timeDelayMs] = await Promise.all([this.#fetchBitcoinState(), this.view.all().then((c) => c.bitcoinDepositTimeDelayMs, () => null)]);
 				const confirmedIds = /* @__PURE__ */ new Set();
 				const items = [];
 				const userBagId = await this.#fetchUserRequestsBagId(btcState.user_requests.id, suiAddress);
@@ -401,7 +408,7 @@ var HashiClient = class {
 					const requestIds = await this.#listAllDynamicFieldAddressKeys(userBagId);
 					if (requestIds.length > 0) {
 						const objects = await this.#batchGetObjects(requestIds, { content: true });
-						const classified = this.#classifyRequestObjects(objects);
+						const classified = this.#classifyRequestObjects(objects, timeDelayMs);
 						items.push(...classified.items);
 						await this.#populateWithdrawalBtcTxids(items, classified.withdrawalTxnLookups);
 						for (const id of requestIds) confirmedIds.add(id);
@@ -412,7 +419,7 @@ var HashiClient = class {
 					const pendingIds = (await this.#queryEventRequestIds(suiAddress, depositEventType)).filter((id) => !confirmedIds.has(id));
 					if (pendingIds.length > 0) {
 						const objects = await this.#batchGetObjects(pendingIds, { content: true });
-						const classified = this.#classifyRequestObjects(objects);
+						const classified = this.#classifyRequestObjects(objects, timeDelayMs);
 						items.push(...classified.items);
 					}
 				} catch {}
@@ -637,6 +644,7 @@ var HashiClient = class {
 			bitcoinWithdrawalMinimum,
 			bitcoinConfirmationThreshold: u64("bitcoin_confirmation_threshold"),
 			withdrawalCancellationCooldownMs: u64("withdrawal_cancellation_cooldown_ms"),
+			bitcoinDepositTimeDelayMs: u64("bitcoin_deposit_time_delay_ms"),
 			depositMinimum: bitcoinDepositMinimum,
 			worstCaseNetworkFee: bitcoinWithdrawalMinimum - DUST_RELAY_MIN_VALUE
 		};
@@ -803,14 +811,14 @@ var HashiClient = class {
 	* items plus the indices that need a follow-up `WithdrawalTransaction`
 	* fetch to populate `btcTxid`.
 	*/
-	#classifyRequestObjects(objects) {
+	#classifyRequestObjects(objects, timeDelayMs) {
 		const items = [];
 		const withdrawalTxnLookups = [];
 		const depositRequestType = `${this.#packageId}::deposit_queue::DepositRequest`;
 		const withdrawalRequestType = `${this.#packageId}::withdrawal_queue::WithdrawalRequest`;
 		for (const obj of objects) {
 			if (obj instanceof Error) continue;
-			if (obj.type === depositRequestType) items.push(parseDepositHistoryItem(obj.content));
+			if (obj.type === depositRequestType) items.push(parseDepositHistoryItem(obj.content, timeDelayMs));
 			else if (obj.type === withdrawalRequestType) {
 				const item = parseWithdrawalHistoryItem(obj.content);
 				items.push(item);
@@ -843,8 +851,9 @@ var HashiClient = class {
 		}
 	}
 };
-function parseDepositHistoryItem(content) {
+function parseDepositHistoryItem(content, timeDelayMs) {
 	const parsed = DepositRequest.parse(content);
+	const approvalTimestampMs = parsed.approval_timestamp_ms === null ? null : BigInt(parsed.approval_timestamp_ms);
 	return {
 		kind: "deposit",
 		requestId: parsed.id,
@@ -855,7 +864,8 @@ function parseDepositHistoryItem(content) {
 		btcTxid: reverseTxidBytes(parsed.utxo.id.txid),
 		btcVout: parsed.utxo.id.vout,
 		approved: parsed.approval_cert !== null,
-		approvalTimestampMs: parsed.approval_timestamp_ms === null ? null : BigInt(parsed.approval_timestamp_ms)
+		approvalTimestampMs,
+		confirmableAtMs: approvalTimestampMs !== null && timeDelayMs !== null ? approvalTimestampMs + timeDelayMs : null
 	};
 }
 function parseWithdrawalHistoryItem(content) {

package/dist/types.d.mts

@@ -36,6 +36,7 @@ interface GovernanceConfig {
   readonly bitcoinWithdrawalMinimum: bigint;
   readonly bitcoinConfirmationThreshold: bigint;
   readonly withdrawalCancellationCooldownMs: bigint;
+  readonly bitcoinDepositTimeDelayMs: bigint;
   readonly depositMinimum: bigint;
   readonly worstCaseNetworkFee: bigint;
 }
@@ -120,6 +121,8 @@ interface DepositHistoryItem {
   /** `true` once the committee has approved the deposit. */
   readonly approved: boolean;
   readonly approvalTimestampMs: bigint | null;
+  /** Earliest wall-clock time (ms since epoch) at which the deposit can be confirmed. `null` until approved. */
+  readonly confirmableAtMs: bigint | null;
 }
 type WithdrawalStatus = "Requested" | "Approved" | "Processing" | "Signed" | "Confirmed";
 interface WithdrawalHistoryItem {
@@ -157,6 +160,10 @@ interface DepositInfo {
   readonly btcVout: number;
   /** Request timestamp (ms since epoch). */
   readonly timestampMs: bigint;
+  /** Timestamp (ms since epoch) when the committee approved this deposit. `null` if not yet approved. */
+  readonly approvalTimestampMs: bigint | null;
+  /** Earliest wall-clock time (ms since epoch) at which the deposit can be confirmed. `null` until approved or if the config could not be read. */
+  readonly confirmableAtMs: bigint | null;
   /** Current deposit status. */
   readonly status: DepositStatus;
   /** Sui transaction digest that created this request. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mysten-incubation/hashi",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK for the Hashi Sui Move smart contracts",
   "license": "Apache-2.0",
   "author": "Mysten Labs <build@mystenlabs.com>",