@shieldedpools/sdk 0.0.0-stage → 0.1.0

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 reasonable and customary use in 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 Additional Liability. 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 additional liability.
+
+   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 [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# Shielded Pool SDK
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A browser SDK for Shielded Pool, a 1:1 shielded wrapper for Midnight's unshielded tokens. A connected wallet owns keys, proving, balancing and submission. This SDK builds the contract calls and hands them to the wallet.
+
+## Usage
+
+```sh
+npm install @shieldedpools/sdk
+```
+
+```ts
+import { connectorProviders, contractKeys, NIGHT, shield } from "@shieldedpools/sdk";
+
+const keys = contractKeys(new URL("/zk/", location.href).href);
+const providers = await connectorProviders(connected, keys);
+
+const txId = await shield(providers, contractAddress, NIGHT, 1_000_000n);
+```
+
+`connected` is the wallet's connector API, version 4.1. Amounts are `bigint`s in a token's smallest units. `unshield` takes a recipient from `parseUnshieldedAddress`, `locked` reads what a contract holds, `isImmutable` checks what `maintenanceAuthority` returns, and `wrappedColor` names a wrapped token for the wallet's balances and transfers.
+
+Your build needs:
+
+- A `Buffer` global, set before the SDK loads.
+- WebAssembly support. With Vite, that's `vite-plugin-wasm` and a `build.target` of `esnext`.
+- The `compiler`, `keys` and `zkir` directories from `@shieldedpools/contracts/contract/managed/shielded-pools`, served at the URL you pass to `contractKeys`.
+
+## License
+
+Copyright 2026 The Shielded Pool Authors. Apache-2.0: see [`LICENSE`](LICENSE). Contributions are made under the same license.
+
+The license doesn't cover the Shielded Pool names or logos. Don't imply that your project is official or endorsed, and give a modified version its own name.

package/dist/address.d.ts

@@ -0,0 +1,8 @@
+/** The two keys a shielded address is made of, in hex. */
+export interface ShieldedKeys {
+    coinPublicKey: string;
+    encryptionPublicKey: string;
+}
+export declare function parseShieldedAddress(text: string, networkId: string): ShieldedKeys;
+/** The 32 bytes a contract sees as this address's `UserAddress`. */
+export declare function parseUnshieldedAddress(text: string, networkId: string): Uint8Array;

package/dist/address.js

@@ -0,0 +1,20 @@
+import { bech32m, hex } from "@scure/base";
+function decode(text, type, networkId, length) {
+    const { prefix, bytes } = bech32m.decodeToBytes(text, false);
+    const expected = networkId === "mainnet" ? `mn_${type}` : `mn_${type}_${networkId}`;
+    if (prefix !== expected || bytes.length !== length) {
+        throw new Error(`Not a ${type} address on ${networkId}: ${text}`);
+    }
+    return bytes;
+}
+export function parseShieldedAddress(text, networkId) {
+    const bytes = decode(text, "shield-addr", networkId, 64);
+    return {
+        coinPublicKey: hex.encode(bytes.subarray(0, 32)),
+        encryptionPublicKey: hex.encode(bytes.subarray(32)),
+    };
+}
+/** The 32 bytes a contract sees as this address's `UserAddress`. */
+export function parseUnshieldedAddress(text, networkId) {
+    return decode(text, "addr", networkId, 32);
+}

package/dist/connector.d.ts

@@ -0,0 +1,5 @@
+import type { ConnectedAPI } from "@midnightntwrk/dapp-connector-api";
+import type { ContractProviders } from "@midnight-ntwrk/midnight-js-contracts";
+import { type ZKConfigProvider } from "@midnight-ntwrk/midnight-js-types";
+/** Providers for `shield`, `unshield` and `attach` that go through a connected wallet. */
+export declare function connectorProviders(connected: ConnectedAPI, zkConfigProvider: ZKConfigProvider<string>): Promise<ContractProviders>;

package/dist/connector.js

@@ -0,0 +1,73 @@
+import * as ledger from "@midnightntwrk/ledger-v9";
+import { dappConnectorProofProvider } from "@midnight-ntwrk/midnight-js-dapp-connector-proof-provider";
+import { indexerPublicDataProvider } from "@midnight-ntwrk/midnight-js-indexer-public-data-provider";
+import { createMidnightProvider, createWalletProvider, } from "@midnight-ntwrk/midnight-js-types";
+import { hex } from "@scure/base";
+import { parseShieldedAddress } from "./address.js";
+// A connected wallet holds the keys, proves, balances and signs. This side never sees a seed or a
+// secret key, and only reaches the wallet through the connector API.
+const TX_TTL_SECONDS = 30 * 60;
+const toHex = (tx) => hex.encode(tx.serialize());
+function deserializeSealed(tx) {
+    return ledger.Transaction.deserialize("signature", "proof", "binding", hex.decode(tx));
+}
+// midnight-js wants a transaction's id, but the connector's submit returns nothing.
+function transactionId(tx) {
+    const id = tx.identifiers().at(-1);
+    if (id === undefined)
+        throw new Error("The wallet returned a transaction with no identifier");
+    return id;
+}
+async function submit(connected, tx) {
+    await connected.submitTransaction(toHex(tx));
+    return transactionId(tx);
+}
+// The contract has no witnesses, so its private state is always empty. midnight-js also makes a
+// signing key whenever it attaches, but the contract has no maintenance committee for it to be on,
+// so it controls nothing and doesn't need to outlive this object. A connected wallet never deploys.
+function emptyPrivateState() {
+    const states = new Map();
+    const signingKeys = new Map();
+    const unsupported = async () => {
+        throw new Error("A connected wallet has no private state to export or import");
+    };
+    return {
+        setContractAddress: () => undefined,
+        set: async (id, state) => void states.set(id, state),
+        get: async (id) => states.get(id) ?? null,
+        remove: async (id) => void states.delete(id),
+        clear: async () => states.clear(),
+        setSigningKey: async (address, key) => void signingKeys.set(address, key),
+        getSigningKey: async (address) => signingKeys.get(address) ?? null,
+        removeSigningKey: async (address) => void signingKeys.delete(address),
+        clearSigningKeys: async () => signingKeys.clear(),
+        exportPrivateStates: unsupported,
+        importPrivateStates: unsupported,
+        exportSigningKeys: unsupported,
+        importSigningKeys: unsupported,
+    };
+}
+/** Providers for `shield`, `unshield` and `attach` that go through a connected wallet. */
+export async function connectorProviders(connected, zkConfigProvider) {
+    const { indexerUri, indexerWsUri, networkId } = await connected.getConfiguration();
+    // The connector gives its public keys in Bech32m and midnight-js wants hex.
+    const { shieldedAddress } = await connected.getShieldedAddresses();
+    const keys = parseShieldedAddress(shieldedAddress, networkId);
+    const costModel = ledger.CostModel.initialCostModel();
+    return {
+        config: { networkId, ttlSeconds: TX_TTL_SECONDS },
+        privateStateProvider: emptyPrivateState(),
+        publicDataProvider: indexerPublicDataProvider(indexerUri, indexerWsUri),
+        zkConfigProvider,
+        proofProvider: await dappConnectorProofProvider(connected, zkConfigProvider, costModel),
+        walletProvider: createWalletProvider({
+            getCoinPublicKey: () => keys.coinPublicKey,
+            getEncryptionPublicKey: () => keys.encryptionPublicKey,
+            balanceTx: async (tx) => {
+                const balanced = await connected.balanceUnsealedTransaction(toHex(tx));
+                return deserializeSealed(balanced.tx);
+            },
+        }),
+        midnightProvider: createMidnightProvider((tx) => submit(connected, tx)),
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { parseUnshieldedAddress } from "./address.ts";
+export { connectorProviders } from "./connector.ts";
+export { type Authority, contractKeys, isImmutable, locked, maintenanceAuthority, NIGHT, shield, unshield, wrappedColor, } from "./pool.ts";

package/dist/index.js

@@ -0,0 +1,5 @@
+// The published SDK. A connected wallet owns keys, proving, balancing and submission, so nothing
+// here may need Node, a seed or a filesystem.
+export { parseUnshieldedAddress } from "./address.js";
+export { connectorProviders } from "./connector.js";
+export { contractKeys, isImmutable, locked, maintenanceAuthority, NIGHT, shield, unshield, wrappedColor, } from "./pool.js";

package/dist/pool.d.ts

@@ -0,0 +1,57 @@
+import { CompiledContract, type Contract as CompactContract } from "@midnight-ntwrk/compact-js";
+import { type ContractProviders } from "@midnight-ntwrk/midnight-js-contracts";
+import type { ZKConfigProvider } from "@midnight-ntwrk/midnight-js-types";
+import { type Circuits } from "@shieldedpools/contracts";
+/** NIGHT's colour. Tokens are identified by colour, as 64 hex characters. */
+export declare const NIGHT: string;
+export declare const compiled: CompiledContract.CompiledContract<CompactContract.Any, any, never>;
+export declare const PRIVATE_STATE_ID = "shielded-pool";
+/**
+ * Keys and ZKIR for `connectorProviders`, fetched from `baseUrl`, an absolute URL. It has to serve
+ * the contract's `compiler`, `keys` and `zkir` directories, and is checked against this release.
+ */
+export declare function contractKeys(baseUrl: string): ZKConfigProvider<string>;
+/**
+ * The two circuits, narrowed from the SDK's Contract.Any view. Their arguments come from the
+ * generated types, so a change to a circuit's signature fails to compile here.
+ */
+interface WrapperCircuits {
+    shield(...args: CircuitArgs<"shield">): Promise<CallResult>;
+    unshield(...args: CircuitArgs<"unshield">): Promise<CallResult>;
+}
+type CircuitArgs<K extends keyof Circuits<unknown>> = Parameters<Circuits<unknown>[K]> extends [unknown, ...infer Args] ? Args : never;
+type CallResult = {
+    public: {
+        txId: string;
+    };
+};
+/** The colour of `token`'s wrapped token. It must match `tokenType()` in the contract. */
+export declare function wrappedColor(contractAddress: string, token: string): string;
+export declare function attach(providers: ContractProviders, contractAddress: string): Promise<WrapperCircuits>;
+/** Locks `amount` units of `token` and mints the same amount of its wrapped token to this wallet. */
+export declare function shield(providers: ContractProviders, contractAddress: string, token: string, amount: bigint): Promise<string>;
+/**
+ * Pays `amount` units of `token`'s wrapped token into the contract, where they are retired,
+ * and releases the same amount of `token` to `recipient`.
+ *
+ * The coin is fresh: the wallet funds it from whatever wrapped coins it holds and
+ * keeps the change, so the amount does not have to match an earlier `shield`.
+ */
+export declare function unshield(providers: ContractProviders, contractAddress: string, token: string, amount: bigint, recipient: Uint8Array): Promise<string>;
+export interface Authority {
+    committee: string[];
+    threshold: number;
+    counter: bigint;
+}
+/** Who can replace this contract's circuits, and with them take everything it holds. */
+export declare function maintenanceAuthority(providers: ContractProviders, contractAddress: string): Promise<Authority>;
+/**
+ * Whether nobody can ever change this contract. An update needs `threshold` signatures from
+ * different committee positions, so a threshold above the committee's size can't be met. An empty
+ * committee isn't enough: the ledger accepts a threshold of 0, and then anyone can change the
+ * contract without signing.
+ */
+export declare function isImmutable({ committee, threshold }: Authority): boolean;
+/** The `token` backing its wrapped token, read from the contract's public balance. */
+export declare function locked(providers: ContractProviders, contractAddress: string, token: string): Promise<bigint>;
+export {};

package/dist/pool.js

@@ -0,0 +1,83 @@
+import { CompiledContract } from "@midnight-ntwrk/compact-js";
+import { findDeployedContract, getUnshieldedBalances, } from "@midnight-ntwrk/midnight-js-contracts";
+import { createShieldedCoinInfo, encodeShieldedCoinInfo, nativeToken, rawTokenType, } from "@midnightntwrk/ledger-v9";
+import { FetchZkConfigProvider } from "@midnight-ntwrk/midnight-js-fetch-zk-config-provider";
+import { Contract } from "@shieldedpools/contracts";
+import { hex } from "@scure/base";
+/** NIGHT's colour. Tokens are identified by colour, as 64 hex characters. */
+export const NIGHT = nativeToken().raw;
+// The generated class and the SDK's contract type disagree on circuit shapes, so
+// the SDK's generics are bound to Contract.Any here and nowhere else. Proofs get their keys from
+// the providers: nothing reads the assets path, but the type requires one.
+export const compiled = CompiledContract.withCompiledFileAssets(CompiledContract.withVacantWitnesses(CompiledContract.make("shielded-pools", Contract)), "shielded-pools");
+export const PRIVATE_STATE_ID = "shielded-pool";
+// SHA-256 of the contract's compiler/contract-manifest.json, which lists every key and ZKIR file
+// by hash. Pinning it here means whoever serves those files can't swap them, even with a matching
+// manifest. A unit test fails if this drifts from the contracts package this SDK is locked to.
+const CONTRACT_MANIFEST_SHA256 = "6b939d17f4ebd6d985d28aa76b252058cb851994916fac09f9abef591477183e";
+/**
+ * Keys and ZKIR for `connectorProviders`, fetched from `baseUrl`, an absolute URL. It has to serve
+ * the contract's `compiler`, `keys` and `zkir` directories, and is checked against this release.
+ */
+export function contractKeys(baseUrl) {
+    return new FetchZkConfigProvider(baseUrl, {
+        expectedManifestHash: CONTRACT_MANIFEST_SHA256,
+        fetchFunc: globalThis.fetch.bind(globalThis),
+    });
+}
+/** The colour of `token`'s wrapped token. It must match `tokenType()` in the contract. */
+export function wrappedColor(contractAddress, token) {
+    return rawTokenType(hex.decode(token), contractAddress);
+}
+export async function attach(providers, contractAddress) {
+    const found = await findDeployedContract(providers, {
+        compiledContract: compiled,
+        contractAddress,
+        privateStateId: PRIVATE_STATE_ID,
+        initialPrivateState: {},
+    });
+    return found.callTx;
+}
+/** Locks `amount` units of `token` and mints the same amount of its wrapped token to this wallet. */
+export async function shield(providers, contractAddress, token, amount) {
+    const contract = await attach(providers, contractAddress);
+    const nonce = crypto.getRandomValues(new Uint8Array(32));
+    const result = await contract.shield(hex.decode(token), amount, nonce);
+    return result.public.txId;
+}
+/**
+ * Pays `amount` units of `token`'s wrapped token into the contract, where they are retired,
+ * and releases the same amount of `token` to `recipient`.
+ *
+ * The coin is fresh: the wallet funds it from whatever wrapped coins it holds and
+ * keeps the change, so the amount does not have to match an earlier `shield`.
+ */
+export async function unshield(providers, contractAddress, token, amount, recipient) {
+    const contract = await attach(providers, contractAddress);
+    const color = wrappedColor(contractAddress, token);
+    const coin = encodeShieldedCoinInfo(createShieldedCoinInfo(color, amount));
+    const result = await contract.unshield(hex.decode(token), coin, { bytes: recipient });
+    return result.public.txId;
+}
+/** Who can replace this contract's circuits, and with them take everything it holds. */
+export async function maintenanceAuthority(providers, contractAddress) {
+    const contract = await providers.publicDataProvider.queryContractState(contractAddress);
+    if (contract?.version !== "v9")
+        throw new Error(`No ledger 9 contract at ${contractAddress}`);
+    const { committee, threshold, counter } = contract.state.maintenanceAuthority;
+    return { committee: committee.map((key) => key.value), threshold, counter };
+}
+/**
+ * Whether nobody can ever change this contract. An update needs `threshold` signatures from
+ * different committee positions, so a threshold above the committee's size can't be met. An empty
+ * committee isn't enough: the ledger accepts a threshold of 0, and then anyone can change the
+ * contract without signing.
+ */
+export function isImmutable({ committee, threshold }) {
+    return threshold > committee.length;
+}
+/** The `token` backing its wrapped token, read from the contract's public balance. */
+export async function locked(providers, contractAddress, token) {
+    const held = await getUnshieldedBalances(providers.publicDataProvider, contractAddress);
+    return held.find(({ tokenType }) => tokenType === token)?.balance ?? 0n;
+}

package/package.json

@@ -1,6 +1,75 @@
 {
   "name": "@shieldedpools/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "A browser SDK for Shielded Pool contract calls through a connected Midnight wallet.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shieldedpools/shielded-pool-sdk.git"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "node --disable-warning=ExperimentalWarning --test test/unit/*.test.ts",
+    "test:live": "compact compile +0.35.0 test/e2e/fixtures/minter.compact test/e2e/managed/minter && node --disable-warning=ExperimentalWarning --test --test-force-exit test/e2e/live.test.ts",
+    "test:live:connector": "E2E_CONNECTOR=1 npm run test:live",
+    "network:up": "docker compose up -d --wait",
+    "network:down": "docker compose down",
+    "prepublishOnly": "npm run build && npm test",
+    "release": "npm run build && npm test && mkdir -p release && npm pack --pack-destination release",
+    "test:browser": "npm run build && node --disable-warning=ExperimentalWarning test/browser/run.ts"
+  },
+  "overrides": {
+    "effect": "3.22.4"
+  },
+  "dependencies": {
+    "@midnight-ntwrk/compact-js": "3.0.0-rc.3",
+    "@midnight-ntwrk/midnight-js-contracts": "5.0.0-rc.5",
+    "@midnight-ntwrk/midnight-js-dapp-connector-proof-provider": "5.0.0-rc.5",
+    "@midnight-ntwrk/midnight-js-fetch-zk-config-provider": "5.0.0-rc.5",
+    "@midnight-ntwrk/midnight-js-indexer-public-data-provider": "5.0.0-rc.5",
+    "@midnight-ntwrk/midnight-js-types": "5.0.0-rc.5",
+    "@midnightntwrk/dapp-connector-api": "4.1.0-beta.1",
+    "@midnightntwrk/ledger-v9": "1.0.0-rc.5",
+    "@scure/base": "2.4.0",
+    "@shieldedpools/contracts": "0.1.1"
+  },
+  "devDependencies": {
+    "@midnight-ntwrk/compact-runtime": "0.20.0",
+    "@midnight-ntwrk/midnight-js-http-client-proof-provider": "5.0.0-rc.5",
+    "@midnight-ntwrk/midnight-js-level-private-state-provider": "5.0.0-rc.5",
+    "@midnight-ntwrk/midnight-js-node-zk-config-provider": "5.0.0-rc.5",
+    "@midnightntwrk/wallet-sdk-abstractions": "3.0.0-rc.1",
+    "@midnightntwrk/wallet-sdk-address-format": "4.0.0-rc.0",
+    "@midnightntwrk/wallet-sdk-dust-wallet": "5.0.0-rc.1",
+    "@midnightntwrk/wallet-sdk-facade": "5.0.0-rc.1",
+    "@midnightntwrk/wallet-sdk-hd": "3.1.0-rc.0",
+    "@midnightntwrk/wallet-sdk-shielded": "4.0.0-rc.1",
+    "@midnightntwrk/wallet-sdk-unshielded-wallet": "4.0.0-rc.1",
+    "@types/node": "24.19.2",
+    "@types/ws": "8.18.2",
+    "buffer": "6.0.3",
+    "rxjs": "7.8.2",
+    "typescript": "5.9.3",
+    "vite": "8.3.5",
+    "vite-plugin-wasm": "3.6.0",
+    "ws": "8.22.0"
+  }
+}