@miden-sdk/miden-sdk 0.15.1 → 0.15.2

package/dist/st/api-types.d.ts

@@ -32,6 +32,7 @@ import type {
   NoteScript,
   AdviceInputs,
   FeltArray,
+  PswapLineageRecord,
 } from "./crates/miden_client_web.js";
 
 // Import the full namespace for the MidenArrayConstructors type
@@ -426,6 +427,18 @@ export interface PswapCancelOptions extends TransactionOptions {
   note: NoteInput;
 }
 
+export interface PswapCancelByOrderOptions extends TransactionOptions {
+  /**
+   * Stable order id of the lineage to cancel, as reported by
+   * {@link PswapLineageRecord.orderId}. Accepts the decimal string or a
+   * `bigint`. `number` is rejected: a PSWAP order id is `u64`-shaped and
+   * routinely exceeds `Number.MAX_SAFE_INTEGER`, which a JS `number` cannot
+   * represent without silent precision loss. The creator account and current
+   * tip note are resolved from the tracked lineage.
+   */
+  orderId: string | bigint;
+}
+
 export interface ExecuteOptions extends TransactionOptions {
   /** Account executing the custom script. */
   account: AccountRef;
@@ -810,6 +823,46 @@ export interface TransactionsResource {
   waitFor(txId: string | TransactionId, options?: WaitOptions): Promise<void>;
 }
 
+export interface PswapResource {
+  /**
+   * Returns every partial-swap (PSWAP) lineage tracked by this client. A
+   * lineage records how a PSWAP note has been filled round by round, from the
+   * original note through each remainder to the current tip.
+   */
+  lineages(): Promise<PswapLineageRecord[]>;
+  /**
+   * Returns the PSWAP lineages created by a specific local account.
+   *
+   * @param account - Creator account (hex, bech32, `Account`, or `AccountId`).
+   */
+  lineagesFor(account: AccountRef): Promise<PswapLineageRecord[]>;
+  /**
+   * Returns the lineage for a single order, or `null` if this client is not
+   * tracking it — either because the order was not created by this client, or
+   * because tracking did not register when it was created. Registration runs as
+   * a transaction observer at create time and does not block the create
+   * transaction if it fails.
+   *
+   * @param orderId - Stable order id (decimal string or bigint). `number` is
+   *   rejected: a PSWAP order id is `u64`-shaped and routinely exceeds
+   *   `Number.MAX_SAFE_INTEGER`, which a JS `number` cannot represent without
+   *   silent precision loss.
+   */
+  lineage(orderId: string | bigint): Promise<PswapLineageRecord | null>;
+  /**
+   * Reclaim the unfilled offered asset on the current tip of an active
+   * lineage, identified by its stable order id. Builds the cancel transaction,
+   * resolves the creator account from the tracked lineage, and submits it
+   * through the same prove/submit path as the other transaction helpers.
+   * Throws if no lineage is tracked for the order.
+   *
+   * @param options - Order id and optional transaction options.
+   */
+  cancelByOrder(
+    options: PswapCancelByOrderOptions
+  ): Promise<TransactionSubmitResult>;
+}
+
 export interface NotesResource {
   /**
    * List received (input) notes, optionally filtered by status or IDs.
@@ -1046,6 +1099,7 @@ export declare class MidenClient {
   readonly settings: SettingsResource;
   readonly compile: CompilerResource;
   readonly keystore: KeystoreResource;
+  readonly pswap: PswapResource;
 
   /** Syncs the client: fetches private notes from the Note Transport Layer, then syncs on-chain state. Fails fast on either. */
   sync(): Promise<SyncSummary>;

package/dist/st/crates/miden_client_web.d.ts

@@ -3274,6 +3274,67 @@ export class ProvenTransaction {
     serialize(): Uint8Array;
 }
 
+/**
+ * Read-only view of one PSWAP order's chain state, exposed to JavaScript.
+ * The mutable fields (remaining amounts, depth, tip, state) advance
+ * round-by-round as fills are discovered during sync.
+ */
+export class PswapLineageRecord {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Account that created the order and receives every payback.
+     */
+    creatorAccountId(): AccountId;
+    /**
+     * Depth of the current tip: 0 for the original PSWAP, +1 per fill round.
+     */
+    currentDepth(): number;
+    /**
+     * Note id of the current tip in the chain.
+     */
+    currentTipNoteId(): NoteId;
+    /**
+     * Stable identifier shared by every note in the chain, as a decimal string.
+     */
+    orderId(): string;
+    /**
+     * Offered amount still unfilled on the current tip. The offered faucet is
+     * chain-invariant and recovered from the original PSWAP note when needed.
+     */
+    remainingOffered(): bigint;
+    /**
+     * Requested amount still outstanding on the current tip. The requested
+     * faucet is recovered from the original PSWAP note when needed.
+     */
+    remainingRequested(): bigint;
+    /**
+     * Lifecycle state of the order.
+     */
+    state(): PswapLineageState;
+}
+
+/**
+ * Lifecycle state of a PSWAP order.
+ *
+ * Discriminants match the on-disk encoding in the store.
+ */
+export enum PswapLineageState {
+    /**
+     * Still fillable and reclaimable.
+     */
+    Active = 0,
+    /**
+     * Fully filled. Terminal.
+     */
+    FullyFilled = 1,
+    /**
+     * Reclaimed by the creator. Terminal.
+     */
+    Reclaimed = 2,
+}
+
 export class PublicKey {
     private constructor();
     free(): void;
@@ -4050,6 +4111,10 @@ export class TransactionRequest {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Returns a copy of the advice map carried by this request.
+     */
+    adviceMap(): AdviceMap;
     /**
      * Returns the authentication argument if present.
      */
@@ -4066,6 +4131,14 @@ export class TransactionRequest {
      * Returns output notes created by the sender account.
      */
     expectedOutputOwnNotes(): Note[];
+    /**
+     * Returns a copy of this request with `advice_map` merged into its advice map.
+     *
+     * Entries are merged with last-write-wins semantics: a key already present in the request is
+     * overwritten by the value from `advice_map`. Use this to inject advice (e.g. a signature
+     * produced by an external signer) after the request has already been built.
+     */
+    extendAdviceMap(advice_map: AdviceMap): TransactionRequest;
     /**
      * Returns the transaction script argument if present.
      */
@@ -4370,7 +4443,22 @@ export class WebClient {
     accountReader(account_id: AccountId): Promise<AccountReader>;
     addAccountSecretKeyToWebStore(account_id: AccountId, secret_key: AuthSecretKey): Promise<void>;
     addTag(tag: string): Promise<void>;
+    /**
+     * Persists a submitted transaction and returns its pre-apply
+     * [`TransactionStoreUpdate`]. Routes through the high-level
+     * `Client::apply_transaction` so registered observers (e.g. PSWAP
+     * tracking) fire.
+     */
     applyTransaction(transaction_result: TransactionResult, submission_height: number): Promise<TransactionStoreUpdate>;
+    /**
+     * Builds a transaction reclaiming the unfilled offered asset on the current
+     * tip of an Active lineage.
+     *
+     * `order_id` is the order's stable identifier as a decimal string. The
+     * returned request flows into the same submit path as the other PSWAP
+     * cancel transactions.
+     */
+    buildPswapCancelByOrder(order_id: string): Promise<TransactionRequest>;
     static buildSwapTag(note_type: NoteType, offered_asset_faucet_id: AccountId, offered_asset_amount: bigint, requested_asset_faucet_id: AccountId, requested_asset_amount: bigint): NoteTag;
     /**
      * Creates a new `WebClient` instance with the specified configuration.
@@ -4496,6 +4584,20 @@ export class WebClient {
     getInputNotes(filter: NoteFilter): Promise<InputNoteRecord[]>;
     getOutputNote(note_id: string): Promise<OutputNoteRecord>;
     getOutputNotes(filter: NoteFilter): Promise<OutputNoteRecord[]>;
+    /**
+     * Returns the lineage for one order, or `null` if not tracked.
+     *
+     * `order_id` is the order's stable identifier as a decimal string.
+     */
+    getPswapLineage(order_id: string): Promise<PswapLineageRecord | undefined>;
+    /**
+     * Returns every PSWAP lineage tracked by this client.
+     */
+    getPswapLineages(): Promise<PswapLineageRecord[]>;
+    /**
+     * Returns lineages created by a specific local account.
+     */
+    getPswapLineagesFor(creator: AccountId): Promise<PswapLineageRecord[]>;
     /**
      * Returns all public key commitments associated with the given account ID.
      *

package/dist/st/docs-entry.d.ts

@@ -12,6 +12,7 @@ export {
   AccountHeader,
   AccountId,
   AccountStorage,
+  AdviceMap,
   AssetVault,
   Felt,
   InputNoteRecord,
@@ -20,6 +21,8 @@ export {
   NoteFile,
   NoteId,
   NoteTag,
+  PswapLineageRecord,
+  PswapLineageState,
   RawOutputNote,
   OutputNoteRecord,
   SyncSummary,

package/dist/st/eager.js

@@ -1,6 +1,6 @@
 import { getWasmOrThrow } from './index.js';
 export { AccountType, AuthScheme, CompilerResource, Linking, MidenArrays, MidenClient, MockWasmWebClient, MockWasmWebClient as MockWebClient, NoteVisibility, StorageMode, StorageResult, StorageView, WasmWebClient, buildSwapTag, createP2IDENote, createP2IDNote, withSyncLock, wordToBigInt } from './index.js';
-export { Account, AccountArray, AccountBuilder, AccountBuilderResult, AccountCode, AccountComponent, AccountComponentCode, AccountDelta, AccountFile, AccountHeader, AccountId, AccountIdArray, AccountInterface, AccountProof, AccountReader, AccountStatus, AccountStorage, AccountStorageDelta, AccountStorageMode, AccountStorageRequirements, AccountVaultDelta, Address, AdviceInputs, AdviceMap, AssetVault, AuthFalcon512RpoMultisigConfig, AuthSecretKey, BasicFungibleFaucetComponent, BlockHeader, CodeBuilder, CommittedNote, ConsumableNoteRecord, Endpoint, ExecutedTransaction, Felt, FeltArray, FetchedAccount, FetchedNote, FlattenedU8Vec, ForeignAccount, ForeignAccountArray, FungibleAsset, FungibleAssetDelta, FungibleAssetDeltaItem, GetProceduresResultItem, InputNote, InputNoteRecord, InputNoteState, InputNotes, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, JsAccountUpdate, JsSettingMutation, JsStateSyncUpdate, JsStorageMapEntry, JsStorageSlot, JsVaultAsset, Library, MerklePath, NetworkId, NetworkNoteStatusInfo, NetworkType, Note, NoteAndArgs, NoteAndArgsArray, NoteArray, NoteAssets, NoteAttachment, NoteAttachmentScheme, NoteConsumability, NoteConsumptionStatus, NoteDetails, NoteDetailsAndTag, NoteDetailsAndTagArray, NoteExecutionHint, NoteExportFormat, NoteFile, NoteFilter, NoteFilterTypes, NoteHeader, NoteId, NoteIdAndArgs, NoteIdAndArgsArray, NoteInclusionProof, NoteLocation, NoteMetadata, NoteRecipient, NoteRecipientArray, NoteScript, NoteStorage, NoteSyncBlock, NoteSyncInfo, NoteTag, NoteType, OutputNote, OutputNoteArray, OutputNoteRecord, OutputNoteState, OutputNotes, Package, PartialNote, Poseidon2, ProcedureThreshold, Program, ProvenTransaction, PublicKey, RpcClient, Rpo256, SerializedInputNoteData, SerializedOutputNoteData, SerializedTransactionData, Signature, SigningInputs, SigningInputsType, SlotAndKeys, SparseMerklePath, StorageMap, StorageMapEntry, StorageMapEntryJs, StorageMapInfo, StorageMapUpdate, StorageSlot, StorageSlotArray, SyncSummary, TestUtils, TokenSymbol, TransactionArgs, TransactionFilter, TransactionId, TransactionProver, TransactionRecord, TransactionRequest, TransactionRequestBuilder, TransactionResult, TransactionScript, TransactionScriptInputPair, TransactionScriptInputPairArray, TransactionStatus, TransactionStoreUpdate, TransactionSummary, WebClient, WebKeystoreApi, Word, createAuthFalcon512RpoMultisig, exportStore, importStore, initSync, sequentialSumBench, setupLogging } from './Cargo-LzqxI7kL.js';
+export { Account, AccountArray, AccountBuilder, AccountBuilderResult, AccountCode, AccountComponent, AccountComponentCode, AccountDelta, AccountFile, AccountHeader, AccountId, AccountIdArray, AccountInterface, AccountProof, AccountReader, AccountStatus, AccountStorage, AccountStorageDelta, AccountStorageMode, AccountStorageRequirements, AccountVaultDelta, Address, AdviceInputs, AdviceMap, AssetVault, AuthFalcon512RpoMultisigConfig, AuthSecretKey, BasicFungibleFaucetComponent, BlockHeader, CodeBuilder, CommittedNote, ConsumableNoteRecord, Endpoint, ExecutedTransaction, Felt, FeltArray, FetchedAccount, FetchedNote, FlattenedU8Vec, ForeignAccount, ForeignAccountArray, FungibleAsset, FungibleAssetDelta, FungibleAssetDeltaItem, GetProceduresResultItem, InputNote, InputNoteRecord, InputNoteState, InputNotes, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, JsAccountUpdate, JsSettingMutation, JsStateSyncUpdate, JsStorageMapEntry, JsStorageSlot, JsVaultAsset, Library, MerklePath, NetworkId, NetworkNoteStatusInfo, NetworkType, Note, NoteAndArgs, NoteAndArgsArray, NoteArray, NoteAssets, NoteAttachment, NoteAttachmentScheme, NoteConsumability, NoteConsumptionStatus, NoteDetails, NoteDetailsAndTag, NoteDetailsAndTagArray, NoteExecutionHint, NoteExportFormat, NoteFile, NoteFilter, NoteFilterTypes, NoteHeader, NoteId, NoteIdAndArgs, NoteIdAndArgsArray, NoteInclusionProof, NoteLocation, NoteMetadata, NoteRecipient, NoteRecipientArray, NoteScript, NoteStorage, NoteSyncBlock, NoteSyncInfo, NoteTag, NoteType, OutputNote, OutputNoteArray, OutputNoteRecord, OutputNoteState, OutputNotes, Package, PartialNote, Poseidon2, ProcedureThreshold, Program, ProvenTransaction, PswapLineageRecord, PswapLineageState, PublicKey, RpcClient, Rpo256, SerializedInputNoteData, SerializedOutputNoteData, SerializedTransactionData, Signature, SigningInputs, SigningInputsType, SlotAndKeys, SparseMerklePath, StorageMap, StorageMapEntry, StorageMapEntryJs, StorageMapInfo, StorageMapUpdate, StorageSlot, StorageSlotArray, SyncSummary, TestUtils, TokenSymbol, TransactionArgs, TransactionFilter, TransactionId, TransactionProver, TransactionRecord, TransactionRequest, TransactionRequestBuilder, TransactionResult, TransactionScript, TransactionScriptInputPair, TransactionScriptInputPairArray, TransactionStatus, TransactionStoreUpdate, TransactionSummary, WebClient, WebKeystoreApi, Word, createAuthFalcon512RpoMultisig, exportStore, importStore, initSync, sequentialSumBench, setupLogging } from './Cargo-Dlo4tWNG.js';
 import './wasm.js';
 
 // Eager entry point for @miden-sdk/miden-sdk (browser builds).

package/dist/st/index.js

@@ -1,5 +1,5 @@
 import loadWasm from './wasm.js';
-export { Account, AccountArray, AccountBuilder, AccountBuilderResult, AccountCode, AccountComponent, AccountComponentCode, AccountDelta, AccountFile, AccountHeader, AccountId, AccountIdArray, AccountInterface, AccountProof, AccountReader, AccountStatus, AccountStorage, AccountStorageDelta, AccountStorageMode, AccountStorageRequirements, AccountVaultDelta, Address, AdviceInputs, AdviceMap, AssetVault, AuthFalcon512RpoMultisigConfig, AuthSecretKey, BasicFungibleFaucetComponent, BlockHeader, CodeBuilder, CommittedNote, ConsumableNoteRecord, Endpoint, ExecutedTransaction, Felt, FeltArray, FetchedAccount, FetchedNote, FlattenedU8Vec, ForeignAccount, ForeignAccountArray, FungibleAsset, FungibleAssetDelta, FungibleAssetDeltaItem, GetProceduresResultItem, InputNote, InputNoteRecord, InputNoteState, InputNotes, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, JsAccountUpdate, JsSettingMutation, JsStateSyncUpdate, JsStorageMapEntry, JsStorageSlot, JsVaultAsset, Library, MerklePath, NetworkId, NetworkNoteStatusInfo, NetworkType, Note, NoteAndArgs, NoteAndArgsArray, NoteArray, NoteAssets, NoteAttachment, NoteAttachmentScheme, NoteConsumability, NoteConsumptionStatus, NoteDetails, NoteDetailsAndTag, NoteDetailsAndTagArray, NoteExecutionHint, NoteExportFormat, NoteFile, NoteFilter, NoteFilterTypes, NoteHeader, NoteId, NoteIdAndArgs, NoteIdAndArgsArray, NoteInclusionProof, NoteLocation, NoteMetadata, NoteRecipient, NoteRecipientArray, NoteScript, NoteStorage, NoteSyncBlock, NoteSyncInfo, NoteTag, NoteType, OutputNote, OutputNoteArray, OutputNoteRecord, OutputNoteState, OutputNotes, Package, PartialNote, Poseidon2, ProcedureThreshold, Program, ProvenTransaction, PublicKey, RpcClient, Rpo256, SerializedInputNoteData, SerializedOutputNoteData, SerializedTransactionData, Signature, SigningInputs, SigningInputsType, SlotAndKeys, SparseMerklePath, StorageMap, StorageMapEntry, StorageMapEntryJs, StorageMapInfo, StorageMapUpdate, StorageSlot, StorageSlotArray, SyncSummary, TestUtils, TokenSymbol, TransactionArgs, TransactionFilter, TransactionId, TransactionProver, TransactionRecord, TransactionRequest, TransactionRequestBuilder, TransactionResult, TransactionScript, TransactionScriptInputPair, TransactionScriptInputPairArray, TransactionStatus, TransactionStoreUpdate, TransactionSummary, WebClient, WebKeystoreApi, Word, createAuthFalcon512RpoMultisig, exportStore, importStore, initSync, sequentialSumBench, setupLogging } from './Cargo-LzqxI7kL.js';
+export { Account, AccountArray, AccountBuilder, AccountBuilderResult, AccountCode, AccountComponent, AccountComponentCode, AccountDelta, AccountFile, AccountHeader, AccountId, AccountIdArray, AccountInterface, AccountProof, AccountReader, AccountStatus, AccountStorage, AccountStorageDelta, AccountStorageMode, AccountStorageRequirements, AccountVaultDelta, Address, AdviceInputs, AdviceMap, AssetVault, AuthFalcon512RpoMultisigConfig, AuthSecretKey, BasicFungibleFaucetComponent, BlockHeader, CodeBuilder, CommittedNote, ConsumableNoteRecord, Endpoint, ExecutedTransaction, Felt, FeltArray, FetchedAccount, FetchedNote, FlattenedU8Vec, ForeignAccount, ForeignAccountArray, FungibleAsset, FungibleAssetDelta, FungibleAssetDeltaItem, GetProceduresResultItem, InputNote, InputNoteRecord, InputNoteState, InputNotes, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, JsAccountUpdate, JsSettingMutation, JsStateSyncUpdate, JsStorageMapEntry, JsStorageSlot, JsVaultAsset, Library, MerklePath, NetworkId, NetworkNoteStatusInfo, NetworkType, Note, NoteAndArgs, NoteAndArgsArray, NoteArray, NoteAssets, NoteAttachment, NoteAttachmentScheme, NoteConsumability, NoteConsumptionStatus, NoteDetails, NoteDetailsAndTag, NoteDetailsAndTagArray, NoteExecutionHint, NoteExportFormat, NoteFile, NoteFilter, NoteFilterTypes, NoteHeader, NoteId, NoteIdAndArgs, NoteIdAndArgsArray, NoteInclusionProof, NoteLocation, NoteMetadata, NoteRecipient, NoteRecipientArray, NoteScript, NoteStorage, NoteSyncBlock, NoteSyncInfo, NoteTag, NoteType, OutputNote, OutputNoteArray, OutputNoteRecord, OutputNoteState, OutputNotes, Package, PartialNote, Poseidon2, ProcedureThreshold, Program, ProvenTransaction, PswapLineageRecord, PswapLineageState, PublicKey, RpcClient, Rpo256, SerializedInputNoteData, SerializedOutputNoteData, SerializedTransactionData, Signature, SigningInputs, SigningInputsType, SlotAndKeys, SparseMerklePath, StorageMap, StorageMapEntry, StorageMapEntryJs, StorageMapInfo, StorageMapUpdate, StorageSlot, StorageSlotArray, SyncSummary, TestUtils, TokenSymbol, TransactionArgs, TransactionFilter, TransactionId, TransactionProver, TransactionRecord, TransactionRequest, TransactionRequestBuilder, TransactionResult, TransactionScript, TransactionScriptInputPair, TransactionScriptInputPairArray, TransactionStatus, TransactionStoreUpdate, TransactionSummary, WebClient, WebKeystoreApi, Word, createAuthFalcon512RpoMultisig, exportStore, importStore, initSync, sequentialSumBench, setupLogging } from './Cargo-Dlo4tWNG.js';
 
 const WorkerAction = Object.freeze({
   INIT: "init",
@@ -1524,6 +1524,137 @@ class KeystoreResource {
   }
 }
 
+/**
+ * Coerce an `orderId` (string | bigint) to a decimal string for the WASM
+ * `u64` parse on the other side.
+ *
+ * A PSWAP `orderId` is `u64`-shaped and routinely exceeds
+ * `Number.MAX_SAFE_INTEGER` (`2^53 - 1`). JS `number` cannot represent the
+ * full u64 range without silent precision loss, so it is not accepted — pass
+ * `orderId` as a `bigint` or `string` instead.
+ *
+ * @param {string | bigint} orderId
+ * @returns {string}
+ */
+function normalizeOrderId(orderId) {
+  if (typeof orderId === "bigint") return orderId.toString();
+  if (typeof orderId === "string") return orderId;
+  throw new TypeError(
+    `PSWAP orderId must be a string or bigint; got ${typeof orderId}`
+  );
+}
+
+/**
+ * PswapResource surfaces partial-swap (PSWAP) lineage tracking and creator-side
+ * cancellation keyed by a lineage's stable order id.
+ *
+ * A PSWAP note can be filled by many consumers; each fill advances the lineage
+ * to a new remainder note. The client persists that chain locally as it syncs,
+ * and the reader methods here expose it. {@link PswapResource#cancelByOrder}
+ * reclaims the unfilled offered asset on the current tip of an active lineage,
+ * resolving the creator account from the tracked record so the caller only
+ * needs the order id.
+ */
+class PswapResource {
+  #inner;
+  #getWasm;
+  #client;
+
+  constructor(inner, getWasm, client) {
+    this.#inner = inner;
+    this.#getWasm = getWasm;
+    this.#client = client;
+  }
+
+  /**
+   * Returns every PSWAP lineage tracked by this client.
+   *
+   * @returns {Promise<PswapLineageRecord[]>} All tracked lineages.
+   */
+  async lineages() {
+    this.#client.assertNotTerminated();
+    return await this.#inner.getPswapLineages();
+  }
+
+  /**
+   * Returns lineages created by a specific local account.
+   *
+   * @param {AccountRef} account - Creator account (hex, bech32, Account, or AccountId).
+   * @returns {Promise<PswapLineageRecord[]>} Lineages created by the account.
+   */
+  async lineagesFor(account) {
+    this.#client.assertNotTerminated();
+    const wasm = await this.#getWasm();
+    const accountId = resolveAccountRef(account, wasm);
+    return await this.#inner.getPswapLineagesFor(accountId);
+  }
+
+  /**
+   * Returns the lineage for one order, or null if not tracked.
+   *
+   * @param {string | bigint} orderId - Stable order id. Pass as a `string` or
+   *   `bigint` for the full `u64` range; `number` is rejected because it cannot
+   *   represent ids above `Number.MAX_SAFE_INTEGER` without precision loss.
+   * @returns {Promise<PswapLineageRecord | null>} The lineage, or null.
+   */
+  async lineage(orderId) {
+    this.#client.assertNotTerminated();
+    const result = await this.#inner.getPswapLineage(normalizeOrderId(orderId));
+    return result ?? null;
+  }
+
+  /**
+   * Builds and submits a transaction reclaiming the unfilled offered asset on
+   * the current tip of an Active lineage. The creator account is resolved from
+   * the tracked lineage, so only the order id is required. Runs through the
+   * same execute/prove/submit path as the other transaction helpers.
+   *
+   * Throws before submitting any transaction when:
+   *   - no lineage is tracked for `orderId`, OR
+   *   - the lineage is in a terminal state (`FullyFilled` or `Reclaimed`,
+   *     guarded by the `buildPswapCancelByOrder` binding).
+   *
+   * Concurrency: the lineage-read, build, and submit steps below are not
+   * atomic against external fills. If another consumer — or this client's own
+   * in-flight tx — advances the lineage tip between the build and submit, the
+   * cancel will target an already-consumed note and the kernel will reject
+   * it with a "note already nullified" error. Treat that as a signal to
+   * re-read the lineage and retry against the new tip.
+   *
+   * @param {PswapCancelByOrderOptions} opts - Order id and optional tx options.
+   * @returns {Promise<TransactionSubmitResult>} The submitted transaction.
+   */
+  async cancelByOrder(opts) {
+    this.#client.assertNotTerminated();
+    const orderId = normalizeOrderId(opts.orderId);
+
+    // Fetch the lineage for the creator account (the cancel's submitter).
+    // The terminal-state guard is authoritative in the `buildPswapCancelByOrder`
+    // binding below, so it is not repeated here.
+    const lineage = await this.#inner.getPswapLineage(orderId);
+    if (!lineage) {
+      throw new Error(`No PSWAP lineage tracked for order ${orderId}`);
+    }
+    const accountId = lineage.creatorAccountId();
+
+    const request = await this.#inner.buildPswapCancelByOrder(orderId);
+
+    const { txId, result } = await this.#client.transactions.submit(
+      accountId,
+      request,
+      { prover: opts.prover }
+    );
+
+    if (opts.waitForConfirmation) {
+      await this.#client.transactions.waitFor(txId.toHex(), {
+        timeout: opts.timeout,
+      });
+    }
+
+    return { txId, result };
+  }
+}
+
 /**
  * MidenClient wraps the existing proxy-wrapped WebClient with a resource-based API.
  *
@@ -1554,6 +1685,7 @@ class MidenClient {
     this.settings = new SettingsResource(inner, getWasm, this);
     this.compile = new CompilerResource(inner, getWasm, this);
     this.keystore = new KeystoreResource(inner, this);
+    this.pswap = new PswapResource(inner, getWasm, this);
   }
 
   /**
@@ -2503,6 +2635,7 @@ const Linking = Object.freeze({
 // (e.g. newSwapTransactionRequest, newPswapCreateTransactionRequest) are
 // `async fn` in Rust because they take the client's RNG via an async lock.
 const SYNC_METHODS = new Set([
+  "buildPswapCancelByOrder",
   "buildSwapTag",
   "createCodeBuilder",
   "lastAuthError",