@mysten-incubation/hashi 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -1 +1,7 @@
 # @mysten-incubation/hashi
+
+## 0.0.2
+
+### Patch Changes
+
+- 9422708: Add a package-level `README.md` so the npm landing page has a real overview (install, one quickstart snippet, link to the repo README for full docs). Also corrects stale `@mysten/hashi` references in the root README to the actual published name `@mysten-incubation/hashi`.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mysten Labs, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,58 @@
+# @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.
+
+> [!CAUTION]
+> **Pre-1.0:** This package is under active development. Minor versions may contain breaking changes until the API stabilizes at 1.0.
+
+> [!WARNING]
+> Only Sui **devnet** is currently wired up (Bitcoin **signet** by default). Testnet and mainnet are not yet deployed.
+
+## Install
+
+```bash
+pnpm add @mysten-incubation/hashi @mysten/sui
+```
+
+`@mysten/sui` is a peer dependency.
+
+## Quick start
+
+The SDK attaches to any Sui client via `$extend`:
+
+```ts
+import { SuiGrpcClient } from "@mysten/sui/grpc";
+import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
+import { hashi } from "@mysten-incubation/hashi";
+
+const client = new SuiGrpcClient({
+  network: "devnet",
+  baseUrl: "https://fullnode.devnet.sui.io:443",
+}).$extend(hashi({ network: "devnet" }));
+
+const signer = Ed25519Keypair.fromSecretKey(/* … */);
+const recipient = signer.toSuiAddress();
+
+// Derive your unique P2TR Bitcoin deposit address.
+const btcAddress = await client.hashi.generateDepositAddress({ suiAddress: recipient });
+
+// After sending BTC to `btcAddress`, record the funding tx on Sui:
+await client.hashi.deposit({
+  signer,
+  txid: "0x<64-hex display-order txid>",
+  utxos: [{ vout: 0, amountSats: 100_000n }],
+  recipient,
+});
+```
+
+End-user actions only: **deposit**, **request withdrawal**, **cancel withdrawal**.
+
+## Documentation
+
+Full guide — including withdrawals, cancellations, governance views, composable transactions, and the typed error model — lives in the repository root README:
+
+→ **https://github.com/MystenLabs/hashi-ts-sdk#readme**
+
+## License
+
+Apache-2.0

package/dist/bitcoin.d.mts

@@ -136,5 +136,17 @@ declare function bitcoinAddressToWitnessProgram(address: string, network: Bitcoi
   version: number;
   program: Uint8Array;
 };
+/**
+ * Encodes a witness program back into a bech32/bech32m Bitcoin address.
+ *
+ * Inverse of {@link bitcoinAddressToWitnessProgram}. Useful for displaying
+ * the Bitcoin address associated with a withdrawal request whose on-chain
+ * state stores only the raw witness program bytes.
+ *
+ * @param program - Raw witness program bytes (20 for P2WPKH, 32 for P2TR)
+ * @param network - Bitcoin network for the HRP
+ * @returns Encoded bech32 (v0) or bech32m (v1+) address
+ */
+declare function witnessProgramToAddress(program: Uint8Array, network: BitcoinNetwork): string;
 //#endregion
-export { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress };
+export { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress, witnessProgramToAddress };

package/dist/bitcoin.mjs

@@ -1,11 +1,11 @@
 import { NETWORK_HRP, NUMS_KEY } from "./constants.mjs";
 import { InvalidBitcoinAddressError } from "./errors.mjs";
+import { bech32, bech32m } from "@scure/base";
 import { secp256k1 } from "@noble/curves/secp256k1.js";
 import { sha3_256 } from "@noble/hashes/sha3.js";
 import { hkdf } from "@noble/hashes/hkdf.js";
 import { sha256 } from "@noble/hashes/sha2.js";
 import { concatBytes } from "@noble/hashes/utils.js";
-import { bech32, bech32m } from "@scure/base";
 
 //#region src/bitcoin.ts
 /**
@@ -267,6 +267,29 @@ function bitcoinAddressToWitnessProgram(address, network) {
 		program
 	};
 }
+/**
+* Encodes a witness program back into a bech32/bech32m Bitcoin address.
+*
+* Inverse of {@link bitcoinAddressToWitnessProgram}. Useful for displaying
+* the Bitcoin address associated with a withdrawal request whose on-chain
+* state stores only the raw witness program bytes.
+*
+* @param program - Raw witness program bytes (20 for P2WPKH, 32 for P2TR)
+* @param network - Bitcoin network for the HRP
+* @returns Encoded bech32 (v0) or bech32m (v1+) address
+*/
+function witnessProgramToAddress(program, network) {
+	const hrp = NETWORK_HRP[network];
+	if (program.length === 20) {
+		const words = [0, ...bech32.toWords(program)];
+		return bech32.encode(hrp, words);
+	}
+	if (program.length === 32) {
+		const words = [1, ...bech32m.toWords(program)];
+		return bech32m.encode(hrp, words);
+	}
+	throw new Error(`Unsupported witness program length ${program.length}; expected 20 (P2WPKH) or 32 (P2TR).`);
+}
 
 //#endregion
-export { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress };
+export { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress, witnessProgramToAddress };

package/dist/btc-rpc.mjs

@@ -0,0 +1,39 @@
+//#region src/btc-rpc.ts
+async function rpcCall(url, method, params, id) {
+	const data = await (await fetch(url, {
+		method: "POST",
+		headers: { "Content-Type": "application/json" },
+		body: JSON.stringify({
+			jsonrpc: "1.0",
+			id,
+			method,
+			params
+		})
+	})).json();
+	if (data.error) throw new Error(data.error.message);
+	return data.result;
+}
+async function lookupVout(btcRpcUrl, txid, depositAddress) {
+	const tx = await rpcCall(btcRpcUrl, "getrawtransaction", [txid, true], "hashi-lookup-vout");
+	for (const output of tx.vout) if (output.scriptPubKey?.address === depositAddress) return {
+		vout: output.n,
+		amountSats: BigInt(Math.round(output.value * 1e8))
+	};
+	return null;
+}
+async function lookupAllVouts(btcRpcUrl, txid, depositAddress) {
+	const tx = await rpcCall(btcRpcUrl, "getrawtransaction", [txid, true], "hashi-lookup-all");
+	const matches = [];
+	for (const output of tx.vout) if (output.scriptPubKey?.address === depositAddress) matches.push({
+		vout: output.n,
+		amountSats: BigInt(Math.round(output.value * 1e8))
+	});
+	return matches;
+}
+async function getTxConfirmations(btcRpcUrl, txid) {
+	const tx = await rpcCall(btcRpcUrl, "getrawtransaction", [txid, true], "hashi-confirmations");
+	return Number(tx?.confirmations ?? 0);
+}
+
+//#endregion
+export { getTxConfirmations, lookupAllVouts, lookupVout };

package/dist/client.d.mts

@@ -1,5 +1,5 @@
 import { RawTransactionArgument } from "./contracts/utils/index.mjs";
-import { BitcoinNetwork, CancelWithdrawalParams, DepositParams, GovernanceConfig, HashiClientOptions, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoUsageResult, WithdrawalParams } from "./types.mjs";
+import { BitcoinNetwork, CancelWithdrawalParams, DepositFees, DepositInfo, DepositParams, GovernanceConfig, HashiClientOptions, HbtcBalance, 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";
@@ -35,13 +35,15 @@ declare class HashiClient {
     network,
     hashiObjectId,
     packageId,
-    bitcoinNetwork
+    bitcoinNetwork,
+    btcRpcUrl
   }: {
     client: ClientWithCoreApi;
     network: SuiNetwork;
     hashiObjectId?: string;
     packageId?: string;
     bitcoinNetwork?: BitcoinNetwork;
+    btcRpcUrl?: string;
   });
   /**
    * Generates a unique Bitcoin P2TR deposit address for a Sui address.
@@ -298,8 +300,48 @@ declare class HashiClient {
      *
      * `txid` in each `UtxoId` is **display byte order**; the method
      * reverses to internal byte order before encoding the on-chain key.
+     *
+     * Throws on any RPC failure that isn't a clean "object does not
+     * exist" — a transient transport error must not be downgraded to
+     * `isUsed: false`, because that could lead a caller to re-spend an
+     * already-used UTXO.
      */
     findUsedUtxos: (utxos: readonly UtxoId[]) => Promise<UtxoUsageResult[]>;
+    /**
+     * Get the hBTC balance for a Sui address.
+     *
+     * @returns Total balance in satoshis and the number of coin objects held.
+     */
+    balance: (owner: string) => Promise<HbtcBalance>;
+    /**
+     * Get the status and details of a deposit by its Sui transaction digest.
+     *
+     * Fetches the `DepositRequestedEvent` 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).
+     */
+    depositStatus: (suiTxDigest: string) => Promise<DepositInfo | null>;
+    /**
+     * Get the status and details of a withdrawal by its Sui transaction digest.
+     *
+     * Fetches the `WithdrawalRequestedEvent` 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.
+     */
+    withdrawalStatus: (suiTxDigest: string) => Promise<WithdrawalInfo | null>;
+    /**
+     * Estimate the gas cost for a deposit transaction via dry-run.
+     * Returns `0n` if simulation fails (best-effort).
+     */
+    depositGasEstimate: (sender: string) => Promise<DepositFees>;
+    /**
+     * Fetch current withdrawal fees, minimums, and gas estimates.
+     *
+     * @param sender - If provided, estimates gas cost via dry-run.
+     */
+    withdrawalFees: (sender?: string) => Promise<WithdrawalFees>;
     /**
      * Fetch the unified transaction history (deposits + withdrawals) for
      * a Sui address. Reads from `BitcoinState.user_requests` — a Table
@@ -313,6 +355,37 @@ declare class HashiClient {
      */
     transactionHistory: (suiAddress: string) => Promise<TransactionHistoryItem[]>;
   };
+  /**
+   * Poll deposit status until it reaches a terminal state (confirmed or expired).
+   */
+  waitForDeposit(suiTxDigest: string, options?: WaitOptions): Promise<DepositInfo>;
+  /**
+   * Poll withdrawal status until it reaches a terminal state (confirmed or cancelled).
+   */
+  waitForWithdrawal(suiTxDigest: string, options?: WaitOptions): Promise<WithdrawalInfo>;
+  bitcoin: {
+    /**
+     * Look up the first UTXO output in a Bitcoin transaction that pays
+     * to the given deposit address.
+     *
+     * Requires `btcRpcUrl` to be configured.
+     */
+    lookupVout: (txid: string, depositAddress: string) => Promise<UtxoLookupResult | null>;
+    /**
+     * Look up ALL outputs in a Bitcoin transaction that pay to the given
+     * deposit address.
+     *
+     * Requires `btcRpcUrl` to be configured.
+     */
+    lookupAllVouts: (txid: string, depositAddress: string) => Promise<UtxoLookupResult[]>;
+    /**
+     * Returns the current confirmation count for a Bitcoin transaction.
+     * Returns 0 if the transaction is in the mempool but not yet mined.
+     *
+     * Requires `btcRpcUrl` to be configured.
+     */
+    confirmations: (txid: string) => Promise<number>;
+  };
 }
 //#endregion
 export { HashiClient, hashi };

package/dist/client.mjs

@@ -9,16 +9,45 @@ import { cancelWithdrawal, requestWithdrawal } from "./contracts/hashi/withdraw.
 import { DUST_RELAY_MIN_VALUE, NETWORK_CONFIG } from "./constants.mjs";
 import { AmountBelowMinimumError, HashiConfigError, HashiFetchError, HashiPausedError, InvalidParamsError } from "./errors.mjs";
 import { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, generateDepositAddress } from "./bitcoin.mjs";
+import { getTxConfirmations, lookupAllVouts, lookupVout } from "./btc-rpc.mjs";
 import { assertHex32, entry, reverseTxidBytes } from "./util.mjs";
 import { TypeTagSerializer, bcs } from "@mysten/sui/bcs";
-import { deriveDynamicFieldID, fromHex, toHex } from "@mysten/sui/utils";
+import { deriveDynamicFieldID, fromHex } from "@mysten/sui/utils";
+import { base58 } from "@scure/base";
 import { Transaction, coinWithBalance } from "@mysten/sui/transactions";
 
 //#region src/client.ts
+/** ObjectBag dynamic field name type (Wrapper<address> for dynamic_object_field lookups). */
+const OBJECT_BAG_ADDRESS_TYPE = "0x0000000000000000000000000000000000000000000000000000000000000002::dynamic_object_field::Wrapper<address>";
 /** Max value of an unsigned 32-bit integer; vout is a u32 on the Bitcoin side. */
 const U32_MAX = 4294967295;
 /** Max objects per `getObjects` call — Sui transports typically cap at 50. */
 const GET_OBJECTS_BATCH = 50;
+/**
+* Recognize the per-object errors that mean "the object (or dynamic field)
+* genuinely does not exist" — the only Error shape that `findUsedUtxos` is
+* allowed to treat as a pool miss. Anything else (deleted, displayError,
+* unknown) must propagate so other per-object failures can't be silently
+* downgraded to "not used."
+*
+* Two transports, two shapes:
+* - JSON-RPC returns a typed `ObjectError` whose `.code` is `notExists` or
+*   `dynamicFieldNotFound`. `ObjectError` is not re-exported from
+*   `@mysten/sui/client`, so the guard duck-types the field.
+* - gRPC stringifies the per-object error into `new Error(message)` with no
+*   code (see the `TODO: improve error handling` in `@mysten/sui/grpc/core.ts`).
+*   For now the only signal is the message, which the Sui ledger service
+*   returns as exactly `Object <id> not found` for missing objects.
+*
+* Transport-level failures don't show up here — they reject the whole
+* `getObjects` promise rather than appearing in the result array.
+*/
+const GRPC_NOT_FOUND_MESSAGE_RE = /^Object 0x[0-9a-f]+ not found$/i;
+function isObjectNotFoundError(err) {
+	const code = err.code;
+	if (code === "notExists" || code === "dynamicFieldNotFound") return true;
+	return code === void 0 && GRPC_NOT_FOUND_MESSAGE_RE.test(err.message);
+}
 function hashi({ name = "hashi", ...options }) {
 	return {
 		name,
@@ -50,7 +79,8 @@ var HashiClient = class {
 	#hashiObjectId;
 	#packageId;
 	#bitcoinNetwork;
-	constructor({ client, network, hashiObjectId, packageId, bitcoinNetwork }) {
+	#btcRpcUrl;
+	constructor({ client, network, hashiObjectId, packageId, bitcoinNetwork, btcRpcUrl }) {
 		this.tx = {
 			deposit: (params) => {
 				const tx = new Transaction();
@@ -181,6 +211,8 @@ var HashiClient = class {
 					fieldIds.push(deriveDynamicFieldID(activePoolId, typeTag, keyBcs), deriveDynamicFieldID(spentPoolId, typeTag, keyBcs));
 				}
 				const objects = await this.#batchGetObjects(fieldIds);
+				if (objects.length !== fieldIds.length) throw new HashiFetchError(`findUsedUtxos: getObjects returned ${objects.length} results, expected ${fieldIds.length}`, this.#hashiObjectId);
+				for (const result of objects) if (result instanceof Error && !isObjectNotFoundError(result)) throw result;
 				return utxos.map((u, i) => {
 					const inActivePool = !(objects[i * 2] instanceof Error);
 					const inSpentPool = !(objects[i * 2 + 1] instanceof Error);
@@ -192,86 +224,190 @@ var HashiClient = class {
 					};
 				});
 			},
-			transactionHistory: async (suiAddress) => {
-				const tableId = (await this.#fetchBitcoinState()).user_requests.id;
-				let userBagId;
+			balance: async (owner) => {
+				const btcType = `${this.#packageId}::btc::BTC`;
+				const { balance } = await this.#client.core.getBalance({
+					owner,
+					coinType: btcType
+				});
+				let coinObjectCount = 0;
+				let cursor = null;
+				let hasNextPage = true;
+				while (hasNextPage) {
+					const page = await this.#client.core.listCoins({
+						owner,
+						coinType: btcType,
+						cursor: cursor ?? void 0
+					});
+					coinObjectCount += page.objects.length;
+					cursor = page.cursor;
+					hasNextPage = page.hasNextPage;
+				}
+				return {
+					totalBalance: BigInt(balance.balance ?? "0"),
+					coinObjectCount
+				};
+			},
+			depositStatus: async (suiTxDigest) => {
+				const txResult = await this.#client.core.getTransaction({
+					digest: suiTxDigest,
+					include: { events: true }
+				});
+				const txData = txResult.Transaction ?? txResult.FailedTransaction;
+				if (!txData?.events) return null;
+				const depositEvent = txData.events.find((e) => e.eventType.includes("::deposit::DepositRequestedEvent"));
+				if (!depositEvent?.json) return null;
+				const parsed = depositEvent.json;
+				let status = "unknown";
 				try {
-					const { dynamicField } = await this.#client.core.getDynamicField({
-						parentId: tableId,
+					await DepositRequest.get({
+						client: this.#client,
+						objectId: parsed.request_id
+					});
+					const requestsBagId = (await this.#fetchBitcoinState()).deposit_queue.requests.id;
+					status = (await this.#client.core.getDynamicField({
+						parentId: requestsBagId,
 						name: {
-							type: "address",
-							bcs: bcs.Address.serialize(suiAddress).toBytes()
+							type: OBJECT_BAG_ADDRESS_TYPE,
+							bcs: bcs.Address.serialize(parsed.request_id).toBytes()
 						}
-					});
-					userBagId = Bag.parse(new Uint8Array(dynamicField.value.bcs)).id;
-				} catch {
-					return [];
+					}).catch(() => null))?.dynamicField ? "pending" : "confirmed";
+				} catch (err) {
+					if (err instanceof Error && isObjectNotFoundError(err)) status = "expired";
+					else throw err;
 				}
-				const requestIds = [];
-				let cursor = null;
-				do {
-					const page = await this.#client.core.listDynamicFields({
-						parentId: userBagId,
-						cursor: cursor ?? void 0
+				return {
+					requestId: parsed.request_id,
+					amountSats: BigInt(parsed.amount),
+					recipient: parsed.derivation_path,
+					btcTxid: reverseTxidBytes(parsed.utxo_id.txid),
+					btcVout: parsed.utxo_id.vout,
+					timestampMs: BigInt(parsed.timestamp_ms),
+					status,
+					suiTxDigest
+				};
+			},
+			withdrawalStatus: async (suiTxDigest) => {
+				const txResult = await this.#client.core.getTransaction({
+					digest: suiTxDigest,
+					include: { events: true }
+				});
+				const txData = txResult.Transaction ?? txResult.FailedTransaction;
+				if (!txData?.events) return null;
+				const withdrawEvent = txData.events.find((e) => e.eventType.includes("::withdrawal_queue::WithdrawalRequestedEvent"));
+				if (!withdrawEvent?.json) return null;
+				const parsed = withdrawEvent.json;
+				let status = "Requested";
+				let btcTxid = null;
+				try {
+					const reqObj = await WithdrawalRequest.get({
+						client: this.#client,
+						objectId: parsed.request_id
 					});
-					for (const df of page.dynamicFields) requestIds.push(bcs.Address.parse(new Uint8Array(df.name.bcs)));
-					cursor = page.hasNextPage ? page.cursor : null;
-				} while (cursor);
-				if (requestIds.length === 0) return [];
-				const objects = await this.#batchGetObjects(requestIds, { content: true });
-				const items = [];
-				const withdrawalTxnLookups = [];
-				for (const obj of objects) {
-					if (obj instanceof Error) continue;
-					if (obj.type.includes("::deposit_queue::DepositRequest")) {
-						const parsed = DepositRequest.parse(obj.content);
-						items.push({
-							kind: "deposit",
-							requestId: parsed.id,
-							sender: parsed.sender,
-							timestampMs: BigInt(parsed.timestamp_ms),
-							suiTxDigest: `0x${toHex(new Uint8Array(parsed.sui_tx_digest))}`,
-							amountSats: BigInt(parsed.utxo.amount),
-							btcTxid: reverseTxidBytes(parsed.utxo.id.txid),
-							btcVout: parsed.utxo.id.vout,
-							approved: parsed.approval_cert !== null,
-							approvalTimestampMs: parsed.approval_timestamp_ms !== null ? BigInt(parsed.approval_timestamp_ms) : null
-						});
-					} else if (obj.type.includes("::withdrawal_queue::WithdrawalRequest")) {
-						const parsed = WithdrawalRequest.parse(obj.content);
-						const txnId = parsed.withdrawal_txn_id ?? null;
-						items.push({
-							kind: "withdrawal",
-							requestId: parsed.id,
-							sender: parsed.sender,
-							btcAmountSats: BigInt(parsed.btc_amount),
-							bitcoinAddress: new Uint8Array(parsed.bitcoin_address),
-							timestampMs: BigInt(parsed.timestamp_ms),
-							suiTxDigest: `0x${toHex(new Uint8Array(parsed.sui_tx_digest))}`,
-							status: parsed.status.$kind,
-							withdrawalTxnId: txnId,
-							btcTxid: null
-						});
-						if (txnId) withdrawalTxnLookups.push({
-							itemIndex: items.length - 1,
-							txnId
-						});
-					}
+					status = reqObj.json.status.$kind;
+					const withdrawalTxnId = reqObj.json.withdrawal_txn_id;
+					if (withdrawalTxnId && (status === "Processing" || status === "Signed" || status === "Confirmed")) try {
+						btcTxid = reverseTxidBytes((await WithdrawalTransaction.get({
+							client: this.#client,
+							objectId: withdrawalTxnId
+						})).json.txid);
+					} catch {}
+				} catch (err) {
+					if (err instanceof Error && isObjectNotFoundError(err)) status = "cancelled";
+					else throw err;
 				}
-				if (withdrawalTxnLookups.length > 0) {
-					const txnIds = withdrawalTxnLookups.map((l) => l.txnId);
-					const txnObjects = await this.#batchGetObjects(txnIds, { content: true });
-					for (let i = 0; i < withdrawalTxnLookups.length; i++) {
-						const txnObj = txnObjects[i];
-						if (txnObj instanceof Error) continue;
-						const parsed = WithdrawalTransaction.parse(txnObj.content);
-						const item = items[withdrawalTxnLookups[i].itemIndex];
-						item.btcTxid = reverseTxidBytes(parsed.txid);
+				return {
+					requestId: parsed.request_id,
+					btcAmountSats: BigInt(parsed.btc_amount),
+					bitcoinAddress: new Uint8Array(parsed.bitcoin_address),
+					sender: parsed.requester_address,
+					timestampMs: BigInt(parsed.timestamp_ms),
+					status,
+					suiTxDigest,
+					btcTxid
+				};
+			},
+			depositGasEstimate: async (sender) => {
+				const dummyAmount = (await this.view.all()).bitcoinDepositMinimum + 1n;
+				const dummyTxid = "0x" + "01".repeat(32);
+				const tx = new Transaction();
+				const utxoId$1 = tx.add(utxoId({
+					package: this.#packageId,
+					arguments: {
+						txid: dummyTxid,
+						vout: 0
 					}
+				}));
+				const utxo$1 = tx.add(utxo({
+					package: this.#packageId,
+					arguments: {
+						utxoId: utxoId$1,
+						amount: dummyAmount,
+						derivationPath: sender
+					}
+				}));
+				tx.add(this.call.deposit({ utxo: utxo$1 }));
+				tx.setSender(sender);
+				return { gasEstimateMist: await this.#estimateGas(tx) };
+			},
+			withdrawalFees: async (sender) => {
+				const snap = await this.view.all();
+				let gasEstimateMist = 0n;
+				if (sender) {
+					const dummyAmount = snap.bitcoinWithdrawalMinimum + 1n;
+					const btcType = `${this.#packageId}::btc::BTC`;
+					const tx = new Transaction();
+					const coin = tx.add(coinWithBalance({
+						type: btcType,
+						balance: dummyAmount,
+						useGasCoin: false
+					}));
+					const [balance] = tx.moveCall({
+						package: "0x2",
+						module: "coin",
+						function: "into_balance",
+						typeArguments: [btcType],
+						arguments: [coin]
+					});
+					tx.add(this.call.requestWithdrawal({
+						btc: balance,
+						bitcoinAddress: Array(20).fill(0)
+					}));
+					tx.setSender(sender);
+					gasEstimateMist = await this.#estimateGas(tx);
 				}
+				return {
+					worstCaseNetworkFeeSats: snap.worstCaseNetworkFee,
+					withdrawalMinimumSats: snap.bitcoinWithdrawalMinimum,
+					gasEstimateMist
+				};
+			},
+			transactionHistory: async (suiAddress) => {
+				const btcState = await this.#fetchBitcoinState();
+				const userBagId = await this.#fetchUserRequestsBagId(btcState.user_requests.id, suiAddress);
+				if (userBagId === null) return [];
+				const requestIds = await this.#listAllDynamicFieldAddressKeys(userBagId);
+				if (requestIds.length === 0) return [];
+				const objects = await this.#batchGetObjects(requestIds, { content: true });
+				const { items, withdrawalTxnLookups } = this.#classifyRequestObjects(objects);
+				await this.#populateWithdrawalBtcTxids(items, withdrawalTxnLookups);
 				return items;
 			}
 		};
+		this.bitcoin = {
+			lookupVout: async (txid, depositAddress) => {
+				this.#requireBtcRpc();
+				return lookupVout(this.#btcRpcUrl, txid, depositAddress);
+			},
+			lookupAllVouts: async (txid, depositAddress) => {
+				this.#requireBtcRpc();
+				return lookupAllVouts(this.#btcRpcUrl, txid, depositAddress);
+			},
+			confirmations: async (txid) => {
+				this.#requireBtcRpc();
+				return getTxConfirmations(this.#btcRpcUrl, txid);
+			}
+		};
 		const config = NETWORK_CONFIG[network];
 		const resolvedObjectId = hashiObjectId ?? config?.hashiObjectId;
 		const resolvedPackageId = packageId ?? config?.packageId;
@@ -280,6 +416,7 @@ var HashiClient = class {
 		this.#hashiObjectId = resolvedObjectId;
 		this.#packageId = resolvedPackageId;
 		this.#bitcoinNetwork = bitcoinNetwork ?? config?.bitcoinNetwork ?? "testnet";
+		this.#btcRpcUrl = btcRpcUrl;
 	}
 	/**
 	* Generates a unique Bitcoin P2TR deposit address for a Sui address.
@@ -478,6 +615,52 @@ var HashiClient = class {
 		};
 	}
 	/**
+	* Poll deposit status until it reaches a terminal state (confirmed or expired).
+	*/
+	async waitForDeposit(suiTxDigest, options) {
+		const intervalMs = options?.intervalMs ?? 15e3;
+		const signal = options?.signal;
+		while (!signal?.aborted) {
+			const info = await this.view.depositStatus(suiTxDigest);
+			if (!info) throw new Error(`Deposit not found for digest: ${suiTxDigest}`);
+			if (info.status === "confirmed" || info.status === "expired") return info;
+			await sleep(intervalMs, signal);
+		}
+		throw new Error("Polling aborted");
+	}
+	/**
+	* Poll withdrawal status until it reaches a terminal state (confirmed or cancelled).
+	*/
+	async waitForWithdrawal(suiTxDigest, options) {
+		const intervalMs = options?.intervalMs ?? 15e3;
+		const signal = options?.signal;
+		while (!signal?.aborted) {
+			const info = await this.view.withdrawalStatus(suiTxDigest);
+			if (!info) throw new Error(`Withdrawal not found for digest: ${suiTxDigest}`);
+			if (info.status === "Confirmed" || info.status === "cancelled") return info;
+			await sleep(intervalMs, signal);
+		}
+		throw new Error("Polling aborted");
+	}
+	#requireBtcRpc() {
+		if (!this.#btcRpcUrl) throw new Error("btcRpcUrl is required for Bitcoin RPC operations. Pass it in HashiClientOptions.");
+	}
+	async #estimateGas(tx) {
+		try {
+			const result = await this.#client.core.simulateTransaction({
+				transaction: tx,
+				include: { effects: true }
+			});
+			const simTx = result.Transaction ?? result.FailedTransaction;
+			if (simTx?.effects?.gasUsed) {
+				const gas = simTx.effects.gasUsed;
+				const total = BigInt(gas.computationCost) + BigInt(gas.storageCost) - BigInt(gas.storageRebate);
+				return total > 0n ? total * 120n / 100n : 0n;
+			}
+		} catch {}
+		return 0n;
+	}
+	/**
 	* Fetches the `BitcoinState` dynamic field from the Hashi shared object.
 	* Returns the BCS-parsed struct whose nested Bag/Table IDs are used by
 	* `findUsedUtxos` and `transactionHistory`.
@@ -516,7 +699,133 @@ var HashiClient = class {
 		}
 		return results;
 	}
+	/**
+	* Resolve the Bag id holding a user's request IDs from `user_requests`,
+	* or `null` if the user has never had a request (no Table entry yet —
+	* `getDynamicField` rejects rather than returning a sentinel).
+	*/
+	async #fetchUserRequestsBagId(tableId, suiAddress) {
+		try {
+			const { dynamicField } = await this.#client.core.getDynamicField({
+				parentId: tableId,
+				name: {
+					type: "address",
+					bcs: bcs.Address.serialize(suiAddress).toBytes()
+				}
+			});
+			return Bag.parse(new Uint8Array(dynamicField.value.bcs)).id;
+		} catch {
+			return null;
+		}
+	}
+	/**
+	* Enumerate every `address`-keyed dynamic field on `parentId`, paginating
+	* through `listDynamicFields` until exhausted. Decodes each `name.bcs` as
+	* a Sui address.
+	*/
+	async #listAllDynamicFieldAddressKeys(parentId) {
+		const keys = [];
+		let cursor = null;
+		do {
+			const page = await this.#client.core.listDynamicFields({
+				parentId,
+				cursor: cursor ?? void 0
+			});
+			for (const df of page.dynamicFields) keys.push(bcs.Address.parse(new Uint8Array(df.name.bcs)));
+			cursor = page.hasNextPage ? page.cursor : null;
+		} while (cursor);
+		return keys;
+	}
+	/**
+	* Classify a batch of request objects into deposit / withdrawal history
+	* items. Errors in the batch are skipped (the request object may have
+	* been deleted between the bag enumeration and the fetch). Returns the
+	* items plus the indices that need a follow-up `WithdrawalTransaction`
+	* fetch to populate `btcTxid`.
+	*/
+	#classifyRequestObjects(objects) {
+		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));
+			else if (obj.type === withdrawalRequestType) {
+				const item = parseWithdrawalHistoryItem(obj.content);
+				items.push(item);
+				if (item.withdrawalTxnId) withdrawalTxnLookups.push({
+					itemIndex: items.length - 1,
+					txnId: item.withdrawalTxnId
+				});
+			}
+		}
+		return {
+			items,
+			withdrawalTxnLookups
+		};
+	}
+	/**
+	* Batch-fetch `WithdrawalTransaction` objects for the withdrawal items
+	* that have a linked txn and overwrite their `btcTxid` in place. Errors
+	* in the batch leave `btcTxid` at the initial `null`.
+	*/
+	async #populateWithdrawalBtcTxids(items, lookups) {
+		if (lookups.length === 0) return;
+		const txnIds = lookups.map((l) => l.txnId);
+		const txnObjects = await this.#batchGetObjects(txnIds, { content: true });
+		for (let i = 0; i < lookups.length; i++) {
+			const txnObj = txnObjects[i];
+			if (txnObj instanceof Error) continue;
+			const parsed = WithdrawalTransaction.parse(txnObj.content);
+			const item = items[lookups[i].itemIndex];
+			item.btcTxid = reverseTxidBytes(parsed.txid);
+		}
+	}
 };
+function parseDepositHistoryItem(content) {
+	const parsed = DepositRequest.parse(content);
+	return {
+		kind: "deposit",
+		requestId: parsed.id,
+		sender: parsed.sender,
+		timestampMs: BigInt(parsed.timestamp_ms),
+		suiTxDigest: base58.encode(new Uint8Array(parsed.sui_tx_digest)),
+		amountSats: BigInt(parsed.utxo.amount),
+		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)
+	};
+}
+function parseWithdrawalHistoryItem(content) {
+	const parsed = WithdrawalRequest.parse(content);
+	return {
+		kind: "withdrawal",
+		requestId: parsed.id,
+		sender: parsed.sender,
+		btcAmountSats: BigInt(parsed.btc_amount),
+		bitcoinAddress: new Uint8Array(parsed.bitcoin_address),
+		timestampMs: BigInt(parsed.timestamp_ms),
+		suiTxDigest: base58.encode(new Uint8Array(parsed.sui_tx_digest)),
+		status: parsed.status.$kind,
+		withdrawalTxnId: parsed.withdrawal_txn_id ?? null,
+		btcTxid: null
+	};
+}
+function sleep(ms, signal) {
+	return new Promise((resolve, reject) => {
+		if (signal?.aborted) {
+			reject(/* @__PURE__ */ new Error("Aborted"));
+			return;
+		}
+		const timer = setTimeout(resolve, ms);
+		signal?.addEventListener("abort", () => {
+			clearTimeout(timer);
+			reject(/* @__PURE__ */ new Error("Aborted"));
+		}, { once: true });
+	});
+}
 
 //#endregion
 export { HashiClient, hashi };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { BitcoinNetwork, CancelWithdrawalParams, DepositHistoryItem, DepositParams, GovernanceConfig, HashiClientOptions, NetworkConfig, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoOutput, UtxoUsageResult, WithdrawalHistoryItem, WithdrawalParams, WithdrawalStatus } from "./types.mjs";
+import { BitcoinNetwork, CancelWithdrawalParams, DepositFees, DepositHistoryItem, DepositInfo, DepositParams, DepositStatus, GovernanceConfig, HashiClientOptions, HbtcBalance, NetworkConfig, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoLookupResult, UtxoOutput, UtxoUsageResult, WaitOptions, WithdrawalFees, WithdrawalHistoryItem, WithdrawalInfo, WithdrawalParams, WithdrawalStatus } from "./types.mjs";
 import { HashiClient, hashi } from "./client.mjs";
 import { AmountBelowMinimumError, AmountViolation, HashiConfigError, HashiFetchError, HashiPausedError, InvalidBitcoinAddressCode, InvalidBitcoinAddressError, InvalidParamsError } from "./errors.mjs";
-import { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress } from "./bitcoin.mjs";
-export { AmountBelowMinimumError, type AmountViolation, type BitcoinNetwork, type CancelWithdrawalParams, type DepositHistoryItem, type DepositParams, type GovernanceConfig, HashiClient, type HashiClientOptions, HashiConfigError, HashiFetchError, HashiPausedError, type InvalidBitcoinAddressCode, InvalidBitcoinAddressError, InvalidParamsError, type NetworkConfig, type SuiNetwork, type TransactionHistoryItem, type UtxoId, type UtxoOutput, type UtxoUsageResult, type WithdrawalHistoryItem, type WithdrawalParams, type WithdrawalStatus, arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, hashi, taprootScriptPathAddress };
+import { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress, witnessProgramToAddress } from "./bitcoin.mjs";
+export { AmountBelowMinimumError, type AmountViolation, type BitcoinNetwork, type CancelWithdrawalParams, type DepositFees, type DepositHistoryItem, type DepositInfo, type DepositParams, type DepositStatus, type GovernanceConfig, HashiClient, type HashiClientOptions, HashiConfigError, HashiFetchError, HashiPausedError, type HbtcBalance, type InvalidBitcoinAddressCode, InvalidBitcoinAddressError, InvalidParamsError, type NetworkConfig, type SuiNetwork, type TransactionHistoryItem, type UtxoId, type UtxoLookupResult, type UtxoOutput, type UtxoUsageResult, type WaitOptions, type WithdrawalFees, type WithdrawalHistoryItem, type WithdrawalInfo, type WithdrawalParams, type WithdrawalStatus, arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, hashi, taprootScriptPathAddress, witnessProgramToAddress };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { AmountBelowMinimumError, HashiConfigError, HashiFetchError, HashiPausedError, InvalidBitcoinAddressError, InvalidParamsError } from "./errors.mjs";
-import { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress } from "./bitcoin.mjs";
+import { arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, taprootScriptPathAddress, witnessProgramToAddress } from "./bitcoin.mjs";
 import { HashiClient, hashi } from "./client.mjs";
 
-export { AmountBelowMinimumError, HashiClient, HashiConfigError, HashiFetchError, HashiPausedError, InvalidBitcoinAddressError, InvalidParamsError, arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, hashi, taprootScriptPathAddress };
+export { AmountBelowMinimumError, HashiClient, HashiConfigError, HashiFetchError, HashiPausedError, InvalidBitcoinAddressError, InvalidParamsError, arkworksToSec1Compressed, bitcoinAddressToWitnessProgram, deriveChildPubkey, generateDepositAddress, hashi, taprootScriptPathAddress, witnessProgramToAddress };

package/dist/types.d.mts

@@ -16,6 +16,8 @@ interface HashiClientOptions<Name = "HashiClient"> {
   packageId?: string;
   /** Override the auto-resolved Bitcoin network for address encoding. */
   bitcoinNetwork?: BitcoinNetwork;
+  /** Optional Bitcoin Core JSON-RPC URL for UTXO lookups and confirmation checks. */
+  btcRpcUrl?: string;
 }
 /**
  * Frozen snapshot of every governance-controlled protocol parameter, returned
@@ -133,5 +135,72 @@ interface WithdrawalHistoryItem {
   /** Bitcoin txid from the `WithdrawalTransaction`, in display byte order. `null` until the committee commits. */
   readonly btcTxid: string | null;
 }
+interface HbtcBalance {
+  /** Total hBTC balance in satoshis. */
+  readonly totalBalance: bigint;
+  /** Number of coin objects held. */
+  readonly coinObjectCount: number;
+}
+type DepositStatus = "pending" | "confirmed" | "expired" | "unknown";
+interface DepositInfo {
+  /** Unique request ID on-chain. */
+  readonly requestId: string;
+  /** Deposit amount in satoshis. */
+  readonly amountSats: bigint;
+  /** Recipient Sui address (derivation path). */
+  readonly recipient: string | null;
+  /** Bitcoin transaction ID (display byte order). */
+  readonly btcTxid: string;
+  /** Bitcoin output index. */
+  readonly btcVout: number;
+  /** Request timestamp (ms since epoch). */
+  readonly timestampMs: bigint;
+  /** Current deposit status. */
+  readonly status: DepositStatus;
+  /** Sui transaction digest that created this request. */
+  readonly suiTxDigest: string;
+}
+interface WithdrawalInfo {
+  /** Unique request ID on-chain. */
+  readonly requestId: string;
+  /** Withdrawal amount in satoshis. */
+  readonly btcAmountSats: bigint;
+  /** Raw witness program bytes of the destination Bitcoin address. */
+  readonly bitcoinAddress: Uint8Array;
+  /** Sui address of the requester. */
+  readonly sender: string;
+  /** Request timestamp (ms since epoch). */
+  readonly timestampMs: bigint;
+  /** Current withdrawal status. */
+  readonly status: WithdrawalStatus | "cancelled";
+  /** Sui transaction digest that created this request. */
+  readonly suiTxDigest: string;
+  /** Bitcoin txid from the `WithdrawalTransaction`, in display byte order. `null` until the committee commits. */
+  readonly btcTxid: string | null;
+}
+interface DepositFees {
+  /** Estimated gas cost in MIST. */
+  readonly gasEstimateMist: bigint;
+}
+interface WithdrawalFees {
+  /** Worst-case BTC network fee in satoshis. */
+  readonly worstCaseNetworkFeeSats: bigint;
+  /** Minimum withdrawal amount in satoshis. */
+  readonly withdrawalMinimumSats: bigint;
+  /** Estimated gas cost in MIST (`0n` if `sender` was not provided). */
+  readonly gasEstimateMist: bigint;
+}
+interface WaitOptions {
+  /** Polling interval in milliseconds (default: 15_000). */
+  readonly intervalMs?: number;
+  /** Abort signal to cancel polling. */
+  readonly signal?: AbortSignal;
+}
+interface UtxoLookupResult {
+  /** Output index. */
+  readonly vout: number;
+  /** Amount in satoshis. */
+  readonly amountSats: bigint;
+}
 //#endregion
-export { BitcoinNetwork, CancelWithdrawalParams, DepositHistoryItem, DepositParams, GovernanceConfig, HashiClientOptions, NetworkConfig, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoOutput, UtxoUsageResult, WithdrawalHistoryItem, WithdrawalParams, WithdrawalStatus };
+export { BitcoinNetwork, CancelWithdrawalParams, DepositFees, DepositHistoryItem, DepositInfo, DepositParams, DepositStatus, GovernanceConfig, HashiClientOptions, HbtcBalance, NetworkConfig, SuiNetwork, TransactionHistoryItem, UtxoId, UtxoLookupResult, UtxoOutput, UtxoUsageResult, WaitOptions, WithdrawalFees, WithdrawalHistoryItem, WithdrawalInfo, WithdrawalParams, WithdrawalStatus };

package/package.json

@@ -1,64 +1,65 @@
 {
-    "name": "@mysten-incubation/hashi",
-    "version": "0.0.1",
-    "description": "TypeScript SDK for the Hashi Sui Move smart contracts",
-    "license": "Apache-2.0",
-    "author": "Mysten Labs <build@mystenlabs.com>",
-    "type": "module",
-    "main": "./dist/index.mjs",
-    "types": "./dist/index.d.mts",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.mts",
-            "import": "./dist/index.mjs"
-        }
-    },
-    "sideEffects": false,
-    "files": [
-        "CHANGELOG.md",
-        "LICENSE",
-        "dist"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/MystenLabs/hashi-ts-sdk.git"
-    },
-    "bugs": {
-        "url": "https://github.com/MystenLabs/hashi-ts-sdk/issues/new"
-    },
-    "homepage": "https://github.com/MystenLabs/hashi-ts-sdk#readme",
-    "publishConfig": {
-        "access": "public"
-    },
-    "keywords": [
-        "sui",
-        "hashi",
-        "bitcoin",
-        "btc",
-        "sdk",
-        "mysten"
-    ],
-    "scripts": {
-        "build": "rm -rf dist && tsc --noEmit && tsdown",
-        "test": "vitest --project=unit",
-        "test:integration": "vitest run --project=integration",
-        "coverage": "vitest run --project=unit --coverage",
-        "codegen": "sui-ts-codegen generate",
-        "format": "prettier --write \"**/*.{ts,json,md}\""
-    },
-    "peerDependencies": {
-        "@mysten/sui": "^2.14.1"
-    },
-    "devDependencies": {
-        "@mysten/codegen": "^0.8.3",
-        "@mysten/sui": "^2.14.1",
-        "@types/node": "^25.6.0",
-        "@vitest/coverage-v8": "^4.1.5",
-        "vitest": "^4.1.5"
-    },
-    "dependencies": {
-        "@noble/curves": "^2.0.1",
-        "@noble/hashes": "^2.0.1",
-        "@scure/base": "^2.0.0"
+  "name": "@mysten-incubation/hashi",
+  "version": "0.0.2",
+  "description": "TypeScript SDK for the Hashi Sui Move smart contracts",
+  "license": "Apache-2.0",
+  "author": "Mysten Labs <build@mystenlabs.com>",
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     }
-}
+  },
+  "sideEffects": false,
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MystenLabs/hashi-ts-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/MystenLabs/hashi-ts-sdk/issues/new"
+  },
+  "homepage": "https://github.com/MystenLabs/hashi-ts-sdk#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "sui",
+    "hashi",
+    "bitcoin",
+    "btc",
+    "sdk",
+    "mysten"
+  ],
+  "peerDependencies": {
+    "@mysten/sui": "^2.14.1"
+  },
+  "devDependencies": {
+    "@mysten/codegen": "^0.8.3",
+    "@mysten/sui": "^2.14.1",
+    "@types/node": "^25.6.0",
+    "@vitest/coverage-v8": "^4.1.5",
+    "vitest": "^4.1.5"
+  },
+  "dependencies": {
+    "@noble/curves": "^2.0.1",
+    "@noble/hashes": "^2.0.1",
+    "@scure/base": "^2.0.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc --noEmit && tsdown",
+    "test": "vitest --project=unit",
+    "test:integration": "vitest run --project=integration",
+    "coverage": "vitest run --project=unit --coverage",
+    "codegen": "sui-ts-codegen generate",
+    "format": "prettier --write \"**/*.{ts,json,md}\""
+  }
+}