@cloak.dev/sdk 0.1.6 → 0.1.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloak.dev/sdk",
   "description": "Shield, send, and swap on Solana privately — TypeScript SDK with UTXO-based zero-knowledge transactions",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -103,7 +103,6 @@
   "files": [
     "dist",
     "README.md",
-    "CHANGELOG.md",
     "LICENSE"
   ],
   "publishConfig": {

package/CHANGELOG.md

@@ -1,173 +0,0 @@
-# Changelog
-
-All notable changes to `@cloak.dev/sdk` are documented here. The format
-follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the
-project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.1.6] — 2026-04-27
-
-### Removed (BREAKING)
-
-- **`CloakSDK.deposit / privateTransfer / withdraw / send / swap`** —
-  these methods built a legacy `[discriminator: 1, amount: u64,
-  commitment: 32]` deposit instruction. The deployed shield-pool program
-  has repurposed discriminator `1` to `TransactSwap` (which requires
-  `>= 8` accounts), so every external invocation hit `0x1063
-  MissingAccounts` at ~112 CU. Reported by the cloak-squads hackathon
-  team on 2026-04-26.
-- **`createDepositInstruction` / `validateDepositParams` /
-  `DepositInstructionParams`** — the disc-1 instruction builder and its
-  validators.
-- **`CloakNote` model and helpers** — `generateNote`, `parseNote`,
-  `exportNote`, `findNoteByCommitment`, `filterNotesByNetwork`,
-  `filterWithdrawableNotes`, `isWithdrawable`, `updateNoteWithDeposit`,
-  `getRecipientAmount`, `generateNoteFromWallet`. The OLD
-  `withdraw_regular.circom` model used a 3-input
-  `Poseidon(amount, r0, r1, pk_spend)` commitment that is incompatible
-  with the deployed `transaction.circom` UTXO circuit (4-input
-  `Poseidon(amount, pubkey, blinding, mintAddress)`).
-- **`CloakSDK.loadNotes / saveNote / findNote / getTransactionMetadata`**
-  and the `StorageAdapter.notes*` methods. The adapter is now keys-only.
-- **Encrypted-note helpers** — `prepareEncryptedOutput`,
-  `prepareEncryptedOutputForRecipient`, `encodeNoteSimple` (legacy
-  `CloakNote`-based variants).
-- **Pending-operations helpers** — `savePendingDeposit`/`Withdrawal`
-  and friends, plus `PendingDeposit` / `PendingWithdrawal` types.
-- **Legacy proof generation** — `src/utils/proof-generation.ts`
-  (`generateWithdrawRegularProof`, `generateWithdrawSwapProof`,
-  `verifyCircuitIntegrity`, `verifyAllCircuits`,
-  `areCircuitsAvailable`, `getDefaultCircuitsPath`,
-  `EXPECTED_CIRCUIT_HASHES`, `DEFAULT_CIRCUITS_URL`).
-- **Legacy bigint hash helpers** in `src/utils/crypto.ts` —
-  `computeCommitment` (3-arg), `generateCommitmentAsync`,
-  `computeNullifier{,Async,Sync}`, `computeOutputsHash{,Async,Sync,FromLimbs}`,
-  `computeSwapOutputsHash{,Async,Sync}`. The UTXO-model
-  `computeCommitment(utxo)` / `computeNullifier(utxo)` live in
-  `core/utxo` and are re-exported as `computeUtxoCommitment` /
-  `computeUtxoNullifier`.
-- **OLD types** in `src/core/types.ts` — `CloakNote`, `Transfer`,
-  `MaxLengthArray`, `TransferResult`, `DepositResult`, `DepositOptions`,
-  `TransferOptions`, `WithdrawOptions`, `DepositStatus`, `SwapOptions`,
-  `SwapParams`, `SwapResult`. Plus `proofTimeout` (was unused on the
-  snapshot).
-- **`withdraw_regular_final.zkey`** — the ~10 MB legacy circuit asset.
-
-### Changed (BREAKING)
-
-- **`CloakConfig` is now a snapshot-only type.** It is the structurally
-  narrow value returned by `CloakSDK.getConfig()`: exactly seven
-  fields — `network`, `cloakKeys`, `programId`, `poolAddress`,
-  `merkleTreeAddress`, `treasuryAddress`, `debug`. The constructor
-  input is the new exported `CloakSDKOptions` interface (which still
-  accepts `keypairBytes`, `wallet`, and `storage` — they are consumed
-  into private SDK state and are *never* persisted on the snapshot).
-  `sdk.getConfig().keypairBytes` is now a `TS2339` compile-time error.
-- `CloakConfig.cloakKeys` is now typed as `CloakKeyPair | undefined`
-  (was `any`).
-- `LocalStorageAdapter` constructor signature is `(keysKey?: string)`;
-  the second `notesKey` parameter is gone.
-- `CloakSDK` constructor now throws `CloakError(_, "validation", false)`
-  instead of plain `Error` when no signer is provided; `getPublicKey()`
-  throws `CloakError(_, "wallet", false)` when neither keypair nor
-  wallet adapter is configured. Consumers' `parseError()` /
-  `classifyRelayError()` flows now handle these uniformly.
-
-### Added
-
-- **`LocalStorageAdapter` auto-purges legacy plaintext secrets.** On
-  the first construction in any browser origin, the adapter removes the
-  pre-0.1.6 `cloak_notes` localStorage entry (which contained `r`
-  randomness and `sk_spend` hex in plaintext) and writes a sentinel at
-  `cloak_purged_v0_1_5` so subsequent constructions skip the work.
-  Closes the upgrade-time security gap without requiring consumers to
-  call any helper. Consumers using a non-default legacy key can still
-  call `LocalStorageAdapter.purgeLegacyNoteStorage(customKey)`
-  explicitly.
-- `LocalStorageAdapter.LEGACY_PURGE_SENTINEL_KEY` and
-  `LocalStorageAdapter.LEGACY_NOTES_KEY` static constants for callers
-  that want to inspect / reset the purge state.
-- `LocalStorageAdapter.runLegacyPurgeOnce()` static helper for callers
-  that want to force the auto-purge before the first adapter
-  instantiation (e.g. during an upgrade boot sequence).
-
-### Security
-
-- `getConfig()` no longer leaks `keypairBytes`. The constructor
-  consumed the secret bytes into a `Keypair` and used to spread the
-  whole input onto `this.config`; `getConfig()`'s shallow-copy return
-  exposed the original `Uint8Array` by reference. `this.config` is now
-  built explicitly without `keypairBytes`/`wallet`/`storage`, and the
-  type system enforces the asymmetry (see "Changed" above).
-- `LocalStorageAdapter` upgrade-time auto-purge (see "Added") removes
-  the now-unredeemable plaintext secrets that pre-0.1.6 versions left
-  in browser localStorage.
-
-### Migration guide
-
-The supported flow for transaction emission is the functional UTXO API.
-
-```ts
-import {
-  transact,
-  fullWithdraw,
-  partialWithdraw,
-  transfer,
-  swapUtxo,
-  createUtxo,
-  createZeroUtxo,
-  generateUtxoKeypair,
-  CLOAK_PROGRAM_ID,
-  NATIVE_SOL_MINT,
-} from "@cloak.dev/sdk";
-import { Connection, Keypair } from "@solana/web3.js";
-
-const connection = new Connection("https://api.mainnet-beta.solana.com");
-const signer = Keypair.fromSecretKey(/* ... */);
-
-// Deposit (positive externalAmount).
-const owner = await generateUtxoKeypair();
-const output = await createUtxo(10_000_000n, owner, NATIVE_SOL_MINT);
-const deposited = await transact(
-  {
-    inputUtxos: [
-      await createZeroUtxo(NATIVE_SOL_MINT),
-      await createZeroUtxo(NATIVE_SOL_MINT),
-    ],
-    outputUtxos: [output, await createZeroUtxo(NATIVE_SOL_MINT)],
-    externalAmount: 10_000_000n,
-    depositor: signer.publicKey,
-  },
-  {
-    connection,
-    programId: CLOAK_PROGRAM_ID,
-    relayUrl: "https://api.cloak.ag",
-    depositorKeypair: signer,
-  },
-);
-
-// Reclaim to a public address.
-await fullWithdraw(deposited.outputUtxos, signer.publicKey, {
-  connection,
-  programId: CLOAK_PROGRAM_ID,
-  relayUrl: "https://api.cloak.ag",
-  depositorKeypair: signer,
-  cachedMerkleTree: deposited.merkleTree,
-});
-```
-
-The `CloakSDK` class is retained as a thin config + read-only helper
-(`getPublicKey`, `getCurrentRoot`, `getMerkleProof`,
-`getTransactionStatus`, `importWalletKeys`, `exportWalletKeys`,
-`getConfig`). Construction is unchanged for new fields.
-
-### Verification
-
-- Mainnet end-to-end smoke (deposit + withdraw cycle) on the patched
-  SDK: deposit signature
-  `5iGmrMYoSucYJ5PzEo5BCWioqTof4KNfjowq14ZYrbQACicaP2tJdJfRUy2CctsQLyNu6xpYXn8gYBg3EefsmXrv`
-  (slot 416038846, leaf 318); withdraw signature
-  `37A4T1KNiZLkmRvLAtui5ZN2VCmzjsZMzzGNwMosFA2UM1NGn7kP28p5APTvKRb51rNaLmWF42TJqK9GSZM5xCxn`
-  (slot 416055377). Net delta on the test wallet matches the expected
-  fee schedule (0.005 fixed + 0.3% var).
-
-[0.1.6]: https://github.com/cloak-ag/sdk/pull/11