@mysten-incubation/hashi 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @mysten-incubation/hashi
 
+## 0.4.0
+
+### Minor Changes
+
+- 874ec08: feat: add a `client.hashi.guardian.*` namespace (`info`, `limiterStatus`, `canWithdraw`) that reads the guardian's rate-limiter headroom from its read-only `/info` endpoint, resolving the guardian URL from `guardianUrl`, a `guardianInfoProvider`, or the on-chain `guardian_url` config
+
+### Patch Changes
+
+- 8f7606f: Track the redeployed devnet contracts: regenerate bindings against hashi's `testnet` tip (`0e67b619`) (`config_value::Value` gained `U128`/`U256`, shifting the BCS tags the SDK decodes the on-chain config with), follow the `DepositRequested`/`WithdrawalRequested` event renames and request-object field renames, and point `NETWORK_CONFIG.devnet` at the new package and Hashi object.
+
 ## 0.3.1
 
 ### Patch Changes

package/README.md

@@ -45,7 +45,7 @@ await client.hashi.deposit({
 });
 ```
 
-End-user actions only: **deposit**, **request withdrawal**, **cancel withdrawal**.
+End-user actions only: **deposit**, **request withdrawal**, **cancel withdrawal**. An optional `client.hashi.guardian.*` namespace reads the guardian's rate-limiter headroom (`limiterStatus`, `canWithdraw`) — see the root README.
 
 ## Documentation
 

package/dist/client.d.mts

@@ -1,5 +1,5 @@
 import { RawTransactionArgument } from "./contracts/utils/index.mjs";
-import { BitcoinNetwork, CancelWithdrawalParams, DepositFees, DepositInfo, DepositParams, GovernanceConfig, HashiClientOptions, HbtcBalance, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoLookupResult, UtxoUsageResult, WaitOptions, WithdrawalFees, WithdrawalInfo, WithdrawalParams } from "./types.mjs";
+import { BitcoinNetwork, CancelWithdrawalParams, DepositFees, DepositInfo, DepositParams, GovernanceConfig, GuardianInfoProvider, GuardianLimiterSnapshot, GuardianWithdrawCheck, HashiClientOptions, HbtcBalance, RawGuardianInfo, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoLookupResult, UtxoUsageResult, WaitOptions, WithdrawalFees, WithdrawalInfo, WithdrawalParams } from "./types.mjs";
 import * as _mysten_sui_transactions0 from "@mysten/sui/transactions";
 import { Transaction } from "@mysten/sui/transactions";
 import { ClientWithCoreApi, SuiClientTypes } from "@mysten/sui/client";
@@ -37,7 +37,9 @@ declare class HashiClient {
     packageId,
     bitcoinNetwork,
     btcRpcUrl,
-    graphqlUrl
+    graphqlUrl,
+    guardianUrl,
+    guardianInfoProvider
   }: {
     client: ClientWithCoreApi;
     network: SuiNetwork;
@@ -46,6 +48,8 @@ declare class HashiClient {
     bitcoinNetwork?: BitcoinNetwork;
     btcRpcUrl?: string;
     graphqlUrl?: string;
+    guardianUrl?: string;
+    guardianInfoProvider?: GuardianInfoProvider;
   });
   /**
    * Generates a unique Bitcoin P2TR deposit address for a Sui address.
@@ -85,7 +89,7 @@ declare class HashiClient {
    * into a single Sui PTB. Signs with `signer` and submits, returning the
    * execution result (`$kind: "Transaction" | "FailedTransaction"`). The
    * result includes `effects` and `events` so callers can confirm
-   * `DepositRequestedEvent` without an extra round-trip.
+   * `DepositRequested` without an extra round-trip.
    *
    * The method runs three preflight stages before signing:
    *
@@ -124,7 +128,7 @@ declare class HashiClient {
    * from the signer's balance and enqueues a request for the committee to
    * send `amountSats` to `bitcoinAddress` on the Bitcoin network. Signs
    * with `signer` and submits, returning the execution result including
-   * `effects` and `events` (`WithdrawalRequestedEvent`).
+   * `effects` and `events` (`WithdrawalRequested`).
    *
    * The method runs three preflight stages before signing:
    *
@@ -331,7 +335,7 @@ declare class HashiClient {
     /**
      * Get the status and details of a deposit by its Sui transaction digest.
      *
-     * Fetches the `DepositRequestedEvent` from the transaction, extracts the
+     * Fetches the `DepositRequested` event from the transaction, extracts the
      * request ID, then probes on-chain state to determine whether the deposit
      * is pending (still in `requests` ObjectBag), confirmed (object exists
      * but not in requests), or expired (object destroyed).
@@ -340,7 +344,7 @@ declare class HashiClient {
     /**
      * Get the status and details of a withdrawal by its Sui transaction digest.
      *
-     * Fetches the `WithdrawalRequestedEvent` from the transaction, extracts the
+     * Fetches the `WithdrawalRequested` event from the transaction, extracts the
      * request ID, then reads the `WithdrawalRequest` object to determine the
      * current lifecycle state. If a `WithdrawalTransaction` is linked, its
      * Bitcoin txid is populated.
@@ -361,7 +365,7 @@ declare class HashiClient {
      * Fetch the unified transaction history (deposits + withdrawals) for
      * a Sui address. Confirmed requests come from the on-chain
      * `user_requests` index; in-flight deposits are discovered via
-     * GraphQL `DepositRequestedEvent` queries (indexed by sender).
+     * GraphQL `DepositRequested` event queries (indexed by sender).
      */
     transactionHistory: (suiAddress: string) => Promise<TransactionHistoryItem[]>;
   };
@@ -396,6 +400,28 @@ declare class HashiClient {
      */
     confirmations: (txid: string) => Promise<number>;
   };
+  guardian: {
+    /**
+     * Fetch the guardian's curated `/info` (identity + limiter). `limiter`
+     * is `null` when the guardian is not yet provisioned/activated; this
+     * method never throws for that state, so it can detect an uninitialized
+     * guardian without a try/catch.
+     */
+    info: () => Promise<RawGuardianInfo>;
+    /**
+     * Fetch the limiter and compute derived fields: capacity projected to
+     * now, bucket fill percentage, and the refill-to-full ETA. Throws
+     * `HashiGuardianError` (`code: "not-initialized"`) if the guardian has
+     * no limiter yet.
+     */
+    limiterStatus: () => Promise<GuardianLimiterSnapshot>;
+    /**
+     * Check whether the guardian can sign a withdrawal of `amountSats` right
+     * now, with an estimated wait if not. Throws `HashiGuardianError`
+     * (`code: "not-initialized"`) if the guardian has no limiter yet.
+     */
+    canWithdraw: (amountSats: bigint) => Promise<GuardianWithdrawCheck>;
+  };
 }
 //#endregion
 export { HashiClient, hashi };

package/dist/client.mjs

@@ -7,9 +7,10 @@ import { BitcoinState, BitcoinStateKey } from "./contracts/hashi/bitcoin_state.m
 import { deposit } from "./contracts/hashi/deposit.mjs";
 import { cancelWithdrawal, requestWithdrawal } from "./contracts/hashi/withdraw.mjs";
 import { DUST_RELAY_MIN_VALUE, GUARDIAN_BTC_PUBLIC_KEY_LEN, GUARDIAN_PUBLIC_KEY_LEN, NETWORK_CONFIG } from "./constants.mjs";
-import { AmountBelowMinimumError, HashiConfigError, HashiFetchError, HashiPausedError, InvalidParamsError } from "./errors.mjs";
+import { AmountBelowMinimumError, HashiConfigError, HashiFetchError, HashiGuardianError, HashiPausedError, InvalidParamsError } from "./errors.mjs";
 import { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, generateDepositAddress } from "./bitcoin.mjs";
 import { getTxConfirmations, lookupAllVouts, lookupVout } from "./btc-rpc.mjs";
+import { estimateWaitSecs, fetchGuardianInfo, projectCapacity } from "./guardian.mjs";
 import { assertHex32, configBytes, entry, reverseTxidBytes } from "./util.mjs";
 import { TypeTagSerializer, bcs } from "@mysten/sui/bcs";
 import { deriveDynamicFieldID, fromHex, normalizeSuiAddress } from "@mysten/sui/utils";
@@ -90,7 +91,10 @@ var HashiClient = class {
 	#bitcoinNetwork;
 	#btcRpcUrl;
 	#graphqlUrl;
-	constructor({ client, network, hashiObjectId, packageId, bitcoinNetwork, btcRpcUrl, graphqlUrl }) {
+	#guardianUrl;
+	#guardianInfoProvider;
+	#resolvedGuardianUrl;
+	constructor({ client, network, hashiObjectId, packageId, bitcoinNetwork, btcRpcUrl, graphqlUrl, guardianUrl, guardianInfoProvider }) {
 		this.tx = {
 			deposit: (params) => {
 				const tx = new Transaction();
@@ -252,7 +256,7 @@ var HashiClient = class {
 				});
 				const txData = txResult.Transaction ?? txResult.FailedTransaction;
 				if (!txData?.events) return null;
-				const depositEvent = txData.events.find((e) => e.eventType.includes("::deposit::DepositRequestedEvent"));
+				const depositEvent = txData.events.find((e) => e.eventType.includes("::deposit::DepositRequested"));
 				if (!depositEvent?.json) return null;
 				const parsed = depositEvent.json;
 				let status = "unknown";
@@ -263,7 +267,7 @@ var HashiClient = class {
 						client: this.#client,
 						objectId: parsed.request_id
 					});
-					if (reqObj.json.approval_timestamp_ms != null) approvalTimestampMs = BigInt(reqObj.json.approval_timestamp_ms);
+					if (reqObj.json.approved_timestamp_ms != null) approvalTimestampMs = BigInt(reqObj.json.approved_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;
@@ -298,7 +302,7 @@ var HashiClient = class {
 				});
 				const txData = txResult.Transaction ?? txResult.FailedTransaction;
 				if (!txData?.events) return null;
-				const withdrawEvent = txData.events.find((e) => e.eventType.includes("::withdrawal_queue::WithdrawalRequestedEvent"));
+				const withdrawEvent = txData.events.find((e) => e.eventType.includes("::withdrawal_queue::WithdrawalRequested"));
 				if (!withdrawEvent?.json) return null;
 				const parsed = withdrawEvent.json;
 				let status = "Requested";
@@ -402,7 +406,7 @@ var HashiClient = class {
 					}
 				}
 				try {
-					const depositEventType = `${this.#packageId}::deposit::DepositRequestedEvent`;
+					const depositEventType = `${this.#packageId}::deposit::DepositRequested`;
 					const pendingIds = (await this.#queryEventRequestIds(suiAddress, depositEventType)).filter((id) => !confirmedIds.has(id));
 					if (pendingIds.length > 0) {
 						const objects = await this.#batchGetObjects(pendingIds, { content: true });
@@ -428,6 +432,38 @@ var HashiClient = class {
 				return getTxConfirmations(this.#btcRpcUrl, txid);
 			}
 		};
+		this.guardian = {
+			info: async () => {
+				return (await this.#resolveGuardianProvider())();
+			},
+			limiterStatus: async () => {
+				const { state, config: config$1 } = this.#requireLimiter(await this.guardian.info());
+				const nowSecs = BigInt(Math.floor(Date.now() / 1e3));
+				const availableNowSats = projectCapacity(config$1, state, nowSecs);
+				const max = config$1.maxBucketCapacitySats;
+				const bucketFillPercent = max > 0n ? Number(availableNowSats) / Number(max) * 100 : 0;
+				let fullAtSecs = null;
+				if (availableNowSats < max && config$1.refillRateSatsPerSec > 0n) fullAtSecs = nowSecs + (max - availableNowSats + config$1.refillRateSatsPerSec - 1n) / config$1.refillRateSatsPerSec;
+				return {
+					state,
+					config: config$1,
+					availableNowSats,
+					bucketFillPercent,
+					fullAtSecs
+				};
+			},
+			canWithdraw: async (amountSats) => {
+				const { state, config: config$1 } = this.#requireLimiter(await this.guardian.info());
+				const nowSecs = BigInt(Math.floor(Date.now() / 1e3));
+				const availableNowSats = projectCapacity(config$1, state, nowSecs);
+				const estimatedWaitSecs = estimateWaitSecs(config$1, state, amountSats, nowSecs);
+				return {
+					allowed: availableNowSats >= amountSats,
+					availableNowSats,
+					estimatedWaitSecs
+				};
+			}
+		};
 		const config = NETWORK_CONFIG[network];
 		const resolvedObjectId = hashiObjectId ?? config?.hashiObjectId;
 		const resolvedPackageId = packageId ?? config?.packageId;
@@ -438,6 +474,8 @@ var HashiClient = class {
 		this.#bitcoinNetwork = bitcoinNetwork ?? config?.bitcoinNetwork ?? "testnet";
 		this.#btcRpcUrl = btcRpcUrl;
 		this.#graphqlUrl = graphqlUrl ?? defaultGraphqlUrl(network);
+		this.#guardianUrl = guardianUrl;
+		this.#guardianInfoProvider = guardianInfoProvider;
 	}
 	/**
 	* Generates a unique Bitcoin P2TR deposit address for a Sui address.
@@ -479,7 +517,7 @@ var HashiClient = class {
 	* into a single Sui PTB. Signs with `signer` and submits, returning the
 	* execution result (`$kind: "Transaction" | "FailedTransaction"`). The
 	* result includes `effects` and `events` so callers can confirm
-	* `DepositRequestedEvent` without an extra round-trip.
+	* `DepositRequested` without an extra round-trip.
 	*
 	* The method runs three preflight stages before signing:
 	*
@@ -530,7 +568,7 @@ var HashiClient = class {
 	* from the signer's balance and enqueues a request for the committee to
 	* send `amountSats` to `bitcoinAddress` on the Bitcoin network. Signs
 	* with `signer` and submits, returning the execution result including
-	* `effects` and `events` (`WithdrawalRequestedEvent`).
+	* `effects` and `events` (`WithdrawalRequested`).
 	*
 	* The method runs three preflight stages before signing:
 	*
@@ -705,6 +743,43 @@ var HashiClient = class {
 	#requireBtcRpc() {
 		if (!this.#btcRpcUrl) throw new Error("btcRpcUrl is required for Bitcoin RPC operations. Pass it in HashiClientOptions.");
 	}
+	#requireLimiter(info) {
+		if (info.limiter === null) throw new HashiGuardianError({
+			message: "Guardian rate limiter is not initialized (limiter is null).",
+			code: "not-initialized"
+		});
+		return info.limiter;
+	}
+	async #resolveGuardianProvider() {
+		if (this.#guardianInfoProvider) return this.#guardianInfoProvider;
+		const url = this.#guardianUrl || await this.#resolveOnChainGuardianUrl();
+		if (!url) throw new HashiGuardianError({
+			message: "Guardian URL is not configured. Pass `guardianUrl` or `guardianInfoProvider` to hashi({...}), or set `guardian_url` in the on-chain config.",
+			code: "not-configured"
+		});
+		return () => fetchGuardianInfo(url);
+	}
+	/**
+	* Resolve the guardian origin from the on-chain `guardian_url`, caching only
+	* a found URL. `guardian_url` is absent until launch (`finish_publish`
+	* publishes it), so a missing value is left uncached and each call re-reads
+	* the chain — a client created before launch starts working once the URL is
+	* published, rather than caching the absence forever (mirrors the node's
+	* lazy `guardian_client()` resolution). Returns `undefined` while unresolved.
+	*/
+	async #resolveOnChainGuardianUrl() {
+		if (this.#resolvedGuardianUrl) return this.#resolvedGuardianUrl;
+		let onChain;
+		try {
+			onChain = (await this.view.all()).guardianUrl;
+		} catch (cause) {
+			throw new HashiGuardianError({
+				message: "Could not read the on-chain guardian_url config. Pass `guardianUrl` or `guardianInfoProvider` to bypass the on-chain read.",
+				code: "not-configured"
+			}, { cause });
+		}
+		return this.#resolvedGuardianUrl = onChain || void 0;
+	}
 	async #estimateGas(tx) {
 		try {
 			const result = await this.#client.core.simulateTransaction({
@@ -913,12 +988,12 @@ function parseMpcPublicKey(raw) {
 }
 function parseDepositHistoryItem(content, timeDelayMs) {
 	const parsed = DepositRequest.parse(content);
-	const approvalTimestampMs = parsed.approval_timestamp_ms === null ? null : BigInt(parsed.approval_timestamp_ms);
+	const approvalTimestampMs = parsed.approved_timestamp_ms === null ? null : BigInt(parsed.approved_timestamp_ms);
 	return {
 		kind: "deposit",
 		requestId: parsed.id,
 		sender: parsed.sender,
-		timestampMs: BigInt(parsed.timestamp_ms),
+		timestampMs: BigInt(parsed.created_timestamp_ms),
 		suiTxDigest: base58.encode(new Uint8Array(parsed.sui_tx_digest)),
 		amountSats: BigInt(parsed.utxo.amount),
 		btcTxid: reverseTxidBytes(parsed.utxo.id.txid),
@@ -936,7 +1011,7 @@ function parseWithdrawalHistoryItem(content) {
 		sender: parsed.sender,
 		btcAmountSats: BigInt(parsed.btc_amount),
 		bitcoinAddress: new Uint8Array(parsed.bitcoin_address),
-		timestampMs: BigInt(parsed.timestamp_ms),
+		timestampMs: BigInt(parsed.created_timestamp_ms),
 		suiTxDigest: base58.encode(new Uint8Array(parsed.sui_tx_digest)),
 		status: parsed.status.$kind,
 		withdrawalTxnId: parsed.withdrawal_txn_id ?? null,

package/dist/constants.mjs

@@ -61,8 +61,8 @@ const GUARDIAN_PUBLIC_KEY_LEN = 32;
 */
 const GUARDIAN_BTC_PUBLIC_KEY_LEN = 32;
 const NETWORK_CONFIG = { devnet: {
-	hashiObjectId: "0x61f1acbf8dd79d284cb312853389747a55a158b1b12a68554afcade05dec5f40",
-	packageId: "0xc377616c626d73556cae080706acf37e862d24d26c690cc7be5a957f53fadf17",
+	hashiObjectId: "0x84081242ebb05eac5e09ab2a930a60b1357d3d8bc6f927380979f72de991ccca",
+	packageId: "0xa877d4d97b6a8bae1da982a84980c502c5ad2ead4b24e6c8e50c57cd6ddc3771",
 	bitcoinNetwork: "signet"
 } };
 

package/dist/contracts/hashi/bitcoin_state.mjs

@@ -9,6 +9,13 @@ import { bcs } from "@mysten/sui/bcs";
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
+/**
+* Per-chain Bitcoin state, attached to the `Hashi` shared object as a dynamic
+* field keyed by `BitcoinStateKey`. Bundles the deposit queue, withdrawal queue,
+* and UTXO pool behind package-only accessors, and maintains a per-user index of
+* request IDs so clients can discover all deposits and withdrawals belonging to an
+* address.
+*/
 const $moduleName = "@local-pkg/hashi::bitcoin_state";
 const BitcoinStateKey = new MoveStruct({
 	name: `${$moduleName}::BitcoinStateKey`,
@@ -17,6 +24,7 @@ const BitcoinStateKey = new MoveStruct({
 const BitcoinState = new MoveStruct({
 	name: `${$moduleName}::BitcoinState`,
 	fields: {
+		id: bcs.Address,
 		deposit_queue: DepositRequestQueue,
 		withdrawal_queue: WithdrawalRequestQueue,
 		utxo_pool: UtxoPool,

package/dist/contracts/hashi/committee.mjs

@@ -1,11 +1,20 @@
 import { MoveStruct } from "../utils/index.mjs";
 import { Element } from "./deps/sui/group_ops.mjs";
+import { Config } from "./config.mjs";
 import { bcs } from "@mysten/sui/bcs";
 
 //#region src/contracts/hashi/committee.ts
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
+/**
+* BLS signing committees and certificate verification. A `Committee` pins an
+* epoch's members (validator addresses, BLS public keys, encryption keys, voting
+* weights) together with the MPC parameters snapshotted at reconfig time.
+* `verify_certificate` checks an aggregate BLS12-381 min-pk signature against a
+* signers bitmap, enforces the stake threshold, and wraps the payload in a
+* `CertifiedMessage` as proof of committee approval.
+*/
 const $moduleName = "@local-pkg/hashi::committee";
 const CommitteeMember = new MoveStruct({
 	name: `${$moduleName}::CommitteeMember`,
@@ -22,9 +31,7 @@ const Committee = new MoveStruct({
 		epoch: bcs.u64(),
 		members: bcs.vector(CommitteeMember),
 		total_weight: bcs.u64(),
-		mpc_threshold_in_basis_points: bcs.u64(),
-		mpc_weight_reduction_allowed_delta: bcs.u64(),
-		mpc_max_faulty_in_basis_points: bcs.u64()
+		config: Config
 	}
 });
 const CommitteeSignature = new MoveStruct({

package/dist/contracts/hashi/committee_set.mjs

@@ -1,23 +1,51 @@
 import { MoveStruct } from "../utils/index.mjs";
-import { Bag } from "./deps/sui/bag.mjs";
 import { Element } from "./deps/sui/group_ops.mjs";
+import { Config } from "./config.mjs";
+import { CommitteeSignature } from "./committee.mjs";
+import { Bag } from "./deps/sui/bag.mjs";
 import { bcs } from "@mysten/sui/bcs";
 
 //#region src/contracts/hashi/committee_set.ts
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
+/**
+* Registry of Hashi committee state: registered member metadata (`MemberInfo`),
+* per-epoch `Committee`s, the current epoch, the MPC threshold public key, and the
+* pending epoch change while a reconfiguration is in flight. Members register (and
+* rotate keys/metadata) here between epochs; `start_reconfig` builds the next
+* committee from Sui's active validator set, and `end_reconfig` activates it —
+* storing the outgoing committee's handoff certificate for non-initial reconfigs.
+*/
 const $moduleName = "@local-pkg/hashi::committee_set";
+const PendingEpochChange = new MoveStruct({
+	name: `${$moduleName}::PendingEpochChange`,
+	fields: {
+		epoch: bcs.u64(),
+		committee_handoff_cert: bcs.option(CommitteeSignature)
+	}
+});
 const CommitteeSet = new MoveStruct({
 	name: `${$moduleName}::CommitteeSet`,
 	fields: {
 		members: Bag,
 		epoch: bcs.u64(),
 		committees: Bag,
-		pending_epoch_change: bcs.option(bcs.u64()),
+		pending_epoch_change: bcs.option(PendingEpochChange),
 		mpc_public_key: bcs.vector(bcs.u8())
 	}
 });
+const CommitteeHandoffKey = new MoveStruct({
+	name: `${$moduleName}::CommitteeHandoffKey`,
+	fields: { epoch: bcs.u64() }
+});
+const CommitteeHandoff = new MoveStruct({
+	name: `${$moduleName}::CommitteeHandoff`,
+	fields: {
+		next_epoch: bcs.u64(),
+		cert: CommitteeSignature
+	}
+});
 const MemberInfo = new MoveStruct({
 	name: `${$moduleName}::MemberInfo`,
 	fields: {
@@ -26,7 +54,8 @@ const MemberInfo = new MoveStruct({
 		next_epoch_public_key: Element,
 		endpoint_url: bcs.string(),
 		tls_public_key: bcs.vector(bcs.u8()),
-		next_epoch_encryption_public_key: bcs.vector(bcs.u8())
+		next_epoch_encryption_public_key: bcs.vector(bcs.u8()),
+		extra_fields: Config
 	}
 });
 

package/dist/contracts/hashi/config.mjs

@@ -1,8 +1,6 @@
 import { MoveStruct } from "../utils/index.mjs";
 import { VecMap } from "./deps/sui/vec_map.mjs";
 import { Value } from "./config_value.mjs";
-import { VecSet } from "./deps/sui/vec_set.mjs";
-import { UpgradeCap } from "./deps/sui/package.mjs";
 import { bcs } from "@mysten/sui/bcs";
 
 //#region src/contracts/hashi/config.ts
@@ -10,18 +8,20 @@ import { bcs } from "@mysten/sui/bcs";
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
 /**
-* Core configuration: versioning, pause state, upgrade management, and generic
-* key-value config store. Chain-specific configuration (e.g. BTC fee parameters)
-* lives in separate modules that use get/upsert.
+* A general-purpose, typed key-value configuration store: a map from string keys
+* to `config_value::Value`s, with domain-specific accessors layered on top (pause
+* state, guardian, emergency thresholds). Chain-specific configuration (e.g. BTC
+* fee parameters) lives in separate modules that use get/upsert.
+*
+* `Config` has `copy, drop, store` and carries no policy of its own (no
+* versioning, no upgrade authority — those live in `versioning`), so it can be
+* embedded by value wherever a bag of settings is needed: it backs the package's
+* global config and is also pinned per-epoch onto a `Committee`.
 */
 const $moduleName = "@local-pkg/hashi::config";
 const Config = new MoveStruct({
 	name: `${$moduleName}::Config`,
-	fields: {
-		config: VecMap(bcs.string(), Value),
-		enabled_versions: VecSet(bcs.u64()),
-		upgrade_cap: bcs.option(UpgradeCap)
-	}
+	fields: { config: VecMap(bcs.string(), Value) }
 });
 
 //#endregion

package/dist/contracts/hashi/config_value.mjs

@@ -5,11 +5,21 @@ import { bcs } from "@mysten/sui/bcs";
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
+/**
+* Typed value wrapper for config entries: the `Value` enum carries one of the
+* primitive types a configuration entry can hold, with a public constructor per
+* variant and package-level helpers for variant checks (`is_*`) and extraction
+* (`as_*`, aborting on a type mismatch). Storing typed values — rather than raw
+* bytes — lets `config::is_valid_config_update` reject governance updates that
+* would change an entry's type.
+*/
 const $moduleName = "@local-pkg/hashi::config_value";
 const Value = new MoveEnum({
 	name: `${$moduleName}::Value`,
 	fields: {
 		U64: bcs.u64(),
+		U128: bcs.u128(),
+		U256: bcs.u256(),
 		Address: bcs.Address,
 		String: bcs.string(),
 		Bool: bcs.bool(),

package/dist/contracts/hashi/deposit.mjs

@@ -1,12 +1,21 @@
 import { MoveStruct, normalizeMoveArguments } from "../utils/index.mjs";
-import { Utxo, UtxoId } from "./utxo.mjs";
 import { CommitteeSignature } from "./committee.mjs";
+import { Utxo, UtxoId } from "./utxo.mjs";
 import { bcs } from "@mysten/sui/bcs";
 
 //#region src/contracts/hashi/deposit.ts
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
+/**
+* User-facing Bitcoin deposit flow. A depositor registers the UTXO they sent to
+* the bridge's address, the committee approves it with a certificate over
+* `(request_id, utxo)`, and — after a configurable time delay in which a faulty
+* approval can be caught and the service paused — the deposit is confirmed: hBTC
+* is minted to the recipient encoded in the UTXO's derivation path and the UTXO
+* joins the active pool. Requests that are never confirmed can be
+* garbage-collected once they expire.
+*/
 const $moduleName = "@local-pkg/hashi::deposit";
 const DepositConfirmationMessage = new MoveStruct({
 	name: `${$moduleName}::DepositConfirmationMessage`,
@@ -15,8 +24,8 @@ const DepositConfirmationMessage = new MoveStruct({
 		utxo: Utxo
 	}
 });
-const DepositRequestedEvent = new MoveStruct({
-	name: `${$moduleName}::DepositRequestedEvent`,
+const DepositRequested = new MoveStruct({
+	name: `${$moduleName}::DepositRequested`,
 	fields: {
 		request_id: bcs.Address,
 		utxo_id: UtxoId,
@@ -27,8 +36,8 @@ const DepositRequestedEvent = new MoveStruct({
 		sui_tx_digest: bcs.vector(bcs.u8())
 	}
 });
-const DepositApprovedEvent = new MoveStruct({
-	name: `${$moduleName}::DepositApprovedEvent`,
+const DepositApproved = new MoveStruct({
+	name: `${$moduleName}::DepositApproved`,
 	fields: {
 		request_id: bcs.Address,
 		utxo: Utxo,
@@ -36,15 +45,15 @@ const DepositApprovedEvent = new MoveStruct({
 		approval_timestamp_ms: bcs.u64()
 	}
 });
-const DepositConfirmedEvent = new MoveStruct({
-	name: `${$moduleName}::DepositConfirmedEvent`,
+const DepositConfirmed = new MoveStruct({
+	name: `${$moduleName}::DepositConfirmed`,
 	fields: {
 		request_id: bcs.Address,
 		utxo: Utxo
 	}
 });
-const ExpiredDepositDeletedEvent = new MoveStruct({
-	name: `${$moduleName}::ExpiredDepositDeletedEvent`,
+const ExpiredDepositDeleted = new MoveStruct({
+	name: `${$moduleName}::ExpiredDepositDeleted`,
 	fields: { request_id: bcs.Address }
 });
 function deposit(options) {

package/dist/contracts/hashi/deposit_queue.mjs

@@ -1,13 +1,20 @@
 import { MoveStruct } from "../utils/index.mjs";
+import { CommitteeSignature } from "./committee.mjs";
 import { ObjectBag } from "./deps/sui/object_bag.mjs";
 import { Utxo } from "./utxo.mjs";
-import { CommitteeSignature } from "./committee.mjs";
 import { bcs } from "@mysten/sui/bcs";
 
 //#region src/contracts/hashi/deposit_queue.ts
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
+/**
+* Storage and bookkeeping for Bitcoin deposit requests. Active requests sit in an
+* ObjectBag awaiting committee approval and confirmation; confirmed requests move
+* to a processed bag, and requests that were never confirmed can be deleted once
+* they pass the maximum age. The state transitions themselves (certificate
+* verification, minting, time-delay enforcement) are driven by `hashi::deposit`.
+*/
 const $moduleName = "@local-pkg/hashi::deposit_queue";
 const DepositRequestQueue = new MoveStruct({
 	name: `${$moduleName}::DepositRequestQueue`,
@@ -21,11 +28,12 @@ const DepositRequest = new MoveStruct({
 	fields: {
 		id: bcs.Address,
 		sender: bcs.Address,
-		timestamp_ms: bcs.u64(),
+		created_timestamp_ms: bcs.u64(),
 		sui_tx_digest: bcs.vector(bcs.u8()),
 		utxo: Utxo,
 		approval_cert: bcs.option(CommitteeSignature),
-		approval_timestamp_ms: bcs.option(bcs.u64())
+		approved_timestamp_ms: bcs.option(bcs.u64()),
+		confirmed_timestamp_ms: bcs.option(bcs.u64())
 	}
 });
 

package/dist/contracts/hashi/hashi.mjs

@@ -1,7 +1,8 @@
 import { MoveStruct } from "../utils/index.mjs";
+import { Config } from "./config.mjs";
 import { Bag } from "./deps/sui/bag.mjs";
 import { CommitteeSet } from "./committee_set.mjs";
-import { Config } from "./config.mjs";
+import { Versioning } from "./versioning.mjs";
 import { Treasury } from "./treasury.mjs";
 import { Proposals } from "./proposals.mjs";
 import { bcs } from "@mysten/sui/bcs";
@@ -10,7 +11,15 @@ import { bcs } from "@mysten/sui/bcs";
 /**************************************************************
 * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
 **************************************************************/
-/** Module: hashi */
+/**
+* The root shared object of the bridge. `Hashi` aggregates every subsystem —
+* committee set, config, versioning, treasury, governance proposals, and TOB
+* certificate storage — and hangs per-chain state (e.g. `BitcoinState`) off its
+* `UID` as dynamic fields. It also provides the package-wide guards (pause,
+* reconfig, committee-signature verification) that entry functions in other
+* modules call through, and the one-time `finish_publish` launch switch that hands
+* the package `UpgradeCap` into on-chain custody.
+*/
 const $moduleName = "@local-pkg/hashi::hashi";
 const Hashi = new MoveStruct({
 	name: `${$moduleName}::Hashi`,
@@ -18,6 +27,7 @@ const Hashi = new MoveStruct({
 		id: bcs.Address,
 		committee_set: CommitteeSet,
 		config: Config,
+		versioning: Versioning,
 		treasury: Treasury,
 		proposals: Proposals,
 		tob: Bag,