@openzeppelin/miden-multisig-client 0.18.1 → 0.18.3

package/README.md

@@ -17,7 +17,7 @@ Miden multisig accounts store their authentication logic on-chain, but **their s
 ## Installation
 
 ```bash
-npm install @openzeppelin/miden-multisig-client@0.18.1 @miden-sdk/miden-sdk@0.17.3
+npm install @openzeppelin/miden-multisig-client@0.18.3 @miden-sdk/miden-sdk@0.17.3
 ```
 
 Miden 0.17 requires a new client database: a store created under 0.16 does not
@@ -94,6 +94,59 @@ symptoms and recovery are in
 [TROUBLESHOOTING.md](https://github.com/OpenZeppelin/guardian/blob/main/docs/TROUBLESHOOTING.md#account-data-wasnt-found-or-incomplete-storage-map-in-a-browser).
 Node.js has no worker and is unaffected.
 
+### Cedar
+
+`@miden-sdk/miden-sdk` 0.17.3 has no Cedar preset and no `'cedar'` shorthand,
+so a Cedar client names its endpoints explicitly:
+
+```typescript
+const midenClient = await MidenClient.create({
+  rpcUrl: 'https://rpc.cedar.miden.io',
+  proverUrl: 'https://tx-prover.cedar.miden.io',
+  noteTransportUrl: 'https://transport.cedar.miden.io',
+  autoSync: true,
+  useWorker: false,
+});
+
+const client = new MultisigClient(midenClient, {
+  guardianEndpoint: 'https://your-guardian-host',
+  midenRpcEndpoint: 'https://rpc.cedar.miden.io',
+});
+```
+
+Cedar addresses use the `mm` prefix, today the same as mainnet's. In Rust,
+`MidenCedar::endpoint()` selects the Cedar prover and note transport automatically.
+
+### Mainnet
+
+`@miden-sdk/miden-sdk` 0.17.3 has no `createMainnet()` preset and no
+`'mainnet'` shorthand for `rpcUrl`, `proverUrl`, or `noteTransportUrl` either,
+so a mainnet client names its endpoints the same way:
+
+```typescript
+const midenClient = await MidenClient.create({
+  rpcUrl: 'https://rpc.mainnet.miden.io',
+  proverUrl: 'https://tx-prover.mainnet.miden.io',
+  noteTransportUrl: 'https://transport.mainnet.miden.io',
+  autoSync: true,
+  useWorker: false,
+});
+
+const client = new MultisigClient(midenClient, {
+  guardianEndpoint: 'https://your-guardian-host',
+  midenRpcEndpoint: 'https://rpc.mainnet.miden.io',
+  prover: {
+    retry: { maxAttempts: 4 },
+  },
+});
+```
+
+`createTestnet` and `createDevnet` set exactly these three endpoints plus
+`autoSync`, so the explicit Cedar and mainnet forms are equivalent. Without
+`noteTransportUrl`, private notes cannot be relayed between cosigners. Leave
+`prover.url` unset so the SDK keeps the Cedar or mainnet prover injected into
+the `MidenClient`; a `url` there overrides it.
+
 For an ECDSA cosigner using an EIP-1193 wallet (including Ledger), call
 `Eip712Signer.connect(provider)` once to select the Ethereum address and
 recover its secp256k1 public key from a dedicated key-discovery signature.
@@ -184,12 +237,20 @@ The full cross-SDK reference, including the Rust equivalents, is
 
 ### Get GUARDIAN Public Key
 
-Before creating a multisig, get the GUARDIAN server's public key commitment:
+Before creating a multisig, get the GUARDIAN server's ACK commitment for the
+account's signature scheme:
 
 ```typescript
-const guardianCommitment = await client.guardianClient.getPubkey();
+const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
 ```
 
+`getPubkey` returns `{ commitment, pubkey }` for one signature scheme and
+defaults to Falcon when no scheme is passed, including on a Guardian that only
+admits ECDSA accounts (`GUARDIAN_ALLOWED_ACCOUNT_SCHEMES=ecdsa`): both ACK keys
+stay loaded for existing accounts. Always pass the scheme of the account you
+are creating, usually `signer.scheme`. A Falcon commitment in an ECDSA account
+is refused at registration with an authorization error, not a scheme mismatch.
+
 ### Create a Multisig Account
 
 ```typescript

package/dist/client.d.ts

@@ -69,8 +69,8 @@ export interface RecoveredAccount {
  *   },
  * });
  *
- * // Get GUARDIAN pubkey for config
- * const guardianCommitment = await client.guardianClient.getPubkey();
+ * // Get GUARDIAN's ACK commitment for the account's signature scheme
+ * const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
  *
  * // Create multisig
  * const config = { threshold: 2, signerCommitments: [...], guardianCommitment };

package/dist/client.js

@@ -49,8 +49,8 @@ async function bindSignerAccountKey(signer, midenClient, accountId) {
  *   },
  * });
  *
- * // Get GUARDIAN pubkey for config
- * const guardianCommitment = await client.guardianClient.getPubkey();
+ * // Get GUARDIAN's ACK commitment for the account's signature scheme
+ * const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
  *
  * // Create multisig
  * const config = { threshold: 2, signerCommitments: [...], guardianCommitment };

package/dist/index.d.ts

@@ -31,8 +31,8 @@
  *   },
  * });
  *
- * // Get GUARDIAN pubkey for config
- * const guardianCommitment = await client.guardianClient.getPubkey();
+ * // Get GUARDIAN's ACK commitment for the account's signature scheme
+ * const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
  *
  * // Create multisig account
  * const config = { threshold: 2, signerCommitments: [signer.commitment, ...], guardianCommitment };

package/dist/index.js

@@ -31,8 +31,8 @@
  *   },
  * });
  *
- * // Get GUARDIAN pubkey for config
- * const guardianCommitment = await client.guardianClient.getPubkey();
+ * // Get GUARDIAN's ACK commitment for the account's signature scheme
+ * const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
  *
  * // Create multisig account
  * const config = { threshold: 2, signerCommitments: [signer.commitment, ...], guardianCommitment };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/miden-multisig-client",
-  "version": "0.18.1",
+  "version": "0.18.3",
   "description": "TypeScript SDK for Miden multisig accounts with GUARDIAN integration",
   "repository": {
     "type": "git",
@@ -45,10 +45,10 @@
     "@miden-sdk/miden-sdk": "0.17.3",
     "@noble/curves": "^1.9.7",
     "@noble/hashes": "^2.0.1",
-    "@openzeppelin/guardian-client": "^0.18.1"
+    "@openzeppelin/guardian-client": "^0.18.3"
   },
   "devDependencies": {
-    "@openzeppelin/guardian-operator-client": "^0.18.1",
+    "@openzeppelin/guardian-operator-client": "^0.18.3",
     "@playwright/test": "^1.60.0",
     "@types/node": "^24.13.5",
     "fake-indexeddb": "^6.2.5",

package/src/client.ts

@@ -107,8 +107,8 @@ export interface RecoveredAccount {
  *   },
  * });
  *
- * // Get GUARDIAN pubkey for config
- * const guardianCommitment = await client.guardianClient.getPubkey();
+ * // Get GUARDIAN's ACK commitment for the account's signature scheme
+ * const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
  *
  * // Create multisig
  * const config = { threshold: 2, signerCommitments: [...], guardianCommitment };

package/src/index.ts

@@ -31,8 +31,8 @@
  *   },
  * });
  *
- * // Get GUARDIAN pubkey for config
- * const guardianCommitment = await client.guardianClient.getPubkey();
+ * // Get GUARDIAN's ACK commitment for the account's signature scheme
+ * const { commitment: guardianCommitment } = await client.guardianClient.getPubkey(signer.scheme);
  *
  * // Create multisig account
  * const config = { threshold: 2, signerCommitments: [signer.commitment, ...], guardianCommitment };