@mysten-incubation/hashi 0.0.1 → 0.1.0

package/CHANGELOG.md

@@ -1 +1,13 @@
 # @mysten-incubation/hashi
+
+## 0.1.0
+
+### Minor Changes
+
+- 75fcdca: Fix btcTxid display values to strip the 0x prefix. Add GraphQL-based discovery of pending deposits to transaction history — confirmed requests still read from the on-chain user_requests index; in-flight deposits are discovered via DepositRequestedEvent queries and deduplicated. Bump GET_OBJECTS_BATCH to 500.
+
+## 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,17 @@ declare class HashiClient {
     network,
     hashiObjectId,
     packageId,
-    bitcoinNetwork
+    bitcoinNetwork,
+    btcRpcUrl,
+    graphqlUrl
   }: {
     client: ClientWithCoreApi;
     network: SuiNetwork;
     hashiObjectId?: string;
     packageId?: string;
     bitcoinNetwork?: BitcoinNetwork;
+    btcRpcUrl?: string;
+    graphqlUrl?: string;
   });
   /**
    * Generates a unique Bitcoin P2TR deposit address for a Sui address.
@@ -298,21 +302,87 @@ 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[]>;
     /**
-     * Fetch the unified transaction history (deposits + withdrawals) for
-     * a Sui address. Reads from `BitcoinState.user_requests` — a Table
-     * that maps each user address to a Bag of request IDs — then batch-
-     * fetches the request objects and dispatches by Move type.
+     * 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.
      *
-     * Deposit items include `btcTxid` / `btcVout` extracted from the
-     * UTXO stored on the `DepositRequest`. Withdrawal items include the
-     * BTC txid from the linked `WithdrawalTransaction` once the committee
-     * has committed one.
+     * @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. Confirmed requests come from the on-chain
+     * `user_requests` index; in-flight deposits are discovered via
+     * GraphQL `DepositRequestedEvent` queries (indexed by sender).
      */
     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 };