@oobe-protocol-labs/synapse-sap-sdk 0.14.0 → 0.15.0

package/dist/types/modules/ledger.d.ts

@@ -0,0 +1,150 @@
+/**
+ * @module ledger
+ * @description Unified on-chain memory — init, write, seal, and close ledger.
+ *
+ * The recommended memory system: fixed-cost PDA with 4 KB ring buffer,
+ * automatic TX log persistence, and rolling merkle proof.
+ * Write cost is TX fee only (~0.000005 SOL). ZERO additional rent.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BaseModule } from "./base";
+import type { MemoryLedgerData, LedgerPageData } from "../types";
+/**
+ * @name LedgerModule
+ * @description Manage on-chain memory ledgers for sessions.
+ * Each session can have one MemoryLedger PDA with a 4KB ring buffer for recent entries.
+ * When the ring buffer fills, it can be sealed into a permanent LedgerPage.
+ * Ledgers are designed for high-frequency writes with minimal cost (~0.000005 SOL per write).
+ * Sealed pages are immutable and stored on-chain (~0.031 SOL per page).
+ */
+/**
+ * @name LedgerModule
+ * @description Manages the unified on-chain memory ledger for the Solana Agent
+ *   Protocol. Provides methods to initialise a ledger with a 4 KB ring buffer,
+ *   write data (TX fee only), seal pages permanently, close ledgers, and
+ *   decode ring buffer contents.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * // Init ledger, write data, seal
+ * await sap.ledger.init(sessionPda);
+ * await sap.ledger.write(sessionPda, data, contentHash);
+ * await sap.ledger.seal(sessionPda);
+ * ```
+ */
+export declare class LedgerModule extends BaseModule {
+    /**
+     * @name deriveLedger
+     * @description Derive the `MemoryLedger` PDA for a given session.
+     * @param sessionPda - The session ledger PDA.
+     * @returns A tuple of `[PublicKey, bump]` for the ledger PDA.
+     * @see {@link deriveLedger} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveLedger(sessionPda: PublicKey): readonly [PublicKey, number];
+    /**
+     * @name deriveLedgerPage
+     * @description Derive a `LedgerPage` PDA for a given ledger and page index.
+     * @param ledgerPda - The memory ledger PDA.
+     * @param pageIndex - The zero-based page index.
+     * @returns A tuple of `[PublicKey, bump]` for the page PDA.
+     * @see {@link deriveLedgerPage} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveLedgerPage(ledgerPda: PublicKey, pageIndex: number): readonly [PublicKey, number];
+    /**
+     * @name init
+     * @description Create a `MemoryLedger` with a 4 KB ring buffer (~0.032 SOL rent).
+     * @param sessionPda - The session ledger PDA to attach the ledger to.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    init(sessionPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name write
+     * @description Write data to the ledger (ring buffer + TX log simultaneously).
+     *   Cost: TX fee only (~0.000005 SOL). ZERO additional rent.
+     * @param sessionPda - The session ledger PDA.
+     * @param data - The data payload to write (Buffer or Uint8Array).
+     * @param contentHash - A 32-byte SHA-256 content hash for verification.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    write(sessionPda: PublicKey, data: Buffer | Uint8Array, contentHash: number[]): Promise<TransactionSignature>;
+    /**
+     * @name seal
+     * @description Seal the ring buffer into a permanent `LedgerPage`.
+     *   Pages are WRITE-ONCE, NEVER-DELETE: ~0.031 SOL per page.
+     *   Automatically fetches the current page index from the ledger.
+     * @param sessionPda - The session ledger PDA.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    seal(sessionPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name close
+     * @description Close a ledger PDA and reclaim ~0.032 SOL rent.
+     * @param sessionPda - The session ledger PDA.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    close(sessionPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name fetchLedger
+     * @description Fetch a deserialized `MemoryLedger` account.
+     * @param sessionPda - The session ledger PDA.
+     * @returns {Promise<MemoryLedgerData>} The memory ledger data.
+     * @throws Will throw if the ledger does not exist.
+     * @since v0.1.0
+     */
+    fetchLedger(sessionPda: PublicKey): Promise<MemoryLedgerData>;
+    /**
+     * @name fetchLedgerNullable
+     * @description Fetch a deserialized `MemoryLedger` account, or `null`
+     *   if it does not exist on-chain.
+     * @param sessionPda - The session ledger PDA.
+     * @returns {Promise<MemoryLedgerData | null>} The ledger data or `null`.
+     * @since v0.1.0
+     */
+    fetchLedgerNullable(sessionPda: PublicKey): Promise<MemoryLedgerData | null>;
+    /**
+     * @name fetchPage
+     * @description Fetch a deserialized sealed `LedgerPage` account.
+     * @param ledgerPda - The memory ledger PDA.
+     * @param pageIndex - The zero-based page index.
+     * @returns {Promise<LedgerPageData>} The ledger page data.
+     * @throws Will throw if the page does not exist.
+     * @since v0.1.0
+     */
+    fetchPage(ledgerPda: PublicKey, pageIndex: number): Promise<LedgerPageData>;
+    /**
+     * @name fetchPageNullable
+     * @description Fetch a deserialized sealed `LedgerPage` account, or `null`
+     *   if it does not exist on-chain.
+     * @param ledgerPda - The memory ledger PDA.
+     * @param pageIndex - The zero-based page index.
+     * @returns {Promise<LedgerPageData | null>} The page data or `null`.
+     * @since v0.1.0
+     */
+    fetchPageNullable(ledgerPda: PublicKey, pageIndex: number): Promise<LedgerPageData | null>;
+    /**
+     * @name decodeRingBuffer
+     * @description Decode the ring buffer into individual entries.
+     *   Each entry is stored as `[u16 LE data_len][data bytes]`.
+     *   An entry with `data_len === 0` acts as the empty sentinel.
+     * @param ring - Raw ring buffer data (byte array or Uint8Array).
+     * @returns {Uint8Array[]} Array of decoded data entries.
+     * @since v0.1.0
+     */
+    decodeRingBuffer(ring: number[] | Uint8Array): Uint8Array[];
+}
+//# sourceMappingURL=ledger.d.ts.map

package/dist/types/modules/ledger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger.d.ts","sourceRoot":"","sources":["../../../src/modules/ledger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAiB,KAAK,SAAS,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3F,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEjE;;;;;;;GAOG;AACH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,YAAa,SAAQ,UAAU;IAG1C;;;;;;;OAOG;IACH,YAAY,CAAC,UAAU,EAAE,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAIjE;;;;;;;;OAQG;IACH,gBAAgB,CACd,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,GAChB,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAM/B;;;;;;OAMG;IACG,IAAI,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAchE;;;;;;;;;OASG;IACG,KAAK,CACT,UAAU,EAAE,SAAS,EACrB,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAahC;;;;;;;;OAQG;IACG,IAAI,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAkBhE;;;;;;OAMG;IACG,KAAK,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAejE;;;;;;;OAOG;IACG,WAAW,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKnE;;;;;;;OAOG;IACG,mBAAmB,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAKlF;;;;;;;;OAQG;IACG,SAAS,CACb,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,CAAC;IAK1B;;;;;;;;OAQG;IACG,iBAAiB,CACrB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAKjC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,GAAG,UAAU,EAAE;CAgB5D"}

package/dist/types/modules/receipt.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @module receipt
+ * @description Receipt-based trustless dispute resolution (v0.7).
+ *
+ * Agents inscribe merkle roots of call receipt batches on-chain.
+ * During disputes, agents submit merkle inclusion proofs to prove delivery.
+ * After the proof deadline, anyone can trigger automatic proportional resolution.
+ *
+ * @category Modules
+ * @since v0.7.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BN } from "@coral-xyz/anchor";
+import { BaseModule } from "./base";
+import type { ReceiptBatchData } from "../types";
+/**
+ * @name ReceiptModule
+ * @description Manages receipt batch inscriptions, merkle proof submissions,
+ * and automatic dispute resolution for the v0.7 trustless settlement layer.
+ *
+ * @category Modules
+ * @since v0.7.0
+ * @extends BaseModule
+ */
+export declare class ReceiptModule extends BaseModule {
+    private toNum;
+    deriveReceiptBatch(escrowV2Pda: PublicKey, batchIndex: number): readonly [PublicKey, number];
+    /**
+     * Inscribe a receipt batch merkle root on-chain.
+     *
+     * Called by the **agent** to commit a cryptographic proof of calls delivered.
+     * The `merkleRoot` is the root of a merkle tree whose leaves are individual
+     * call receipt hashes.
+     *
+     * @param depositorWallet - The depositor's wallet (needed for escrow PDA derivation).
+     * @param nonce           - Escrow nonce.
+     * @param batchIndex      - Zero-based batch index (must equal escrow.receipt_batch_count).
+     * @param merkleRoot      - 32-byte merkle root of the receipt batch.
+     * @param callCount       - Number of calls in the batch.
+     * @param periodStart     - Unix timestamp for the start of the covered period.
+     * @param periodEnd       - Unix timestamp for the end of the covered period.
+     */
+    inscribeReceiptBatch(depositorWallet: PublicKey, nonce: BN | number | bigint, batchIndex: number, merkleRoot: number[], callCount: BN | number | bigint, periodStart: BN | number | bigint, periodEnd: BN | number | bigint): Promise<TransactionSignature>;
+    /**
+     * Submit a merkle inclusion proof during a dispute.
+     *
+     * Called by the **agent** to prove delivery of specific calls.
+     * Each proof verifies that a set of receipt hashes are included
+     * in the previously inscribed merkle root.
+     *
+     * @param depositorWallet - The depositor's wallet.
+     * @param nonce           - Escrow nonce.
+     * @param settlementIndex - Index of the disputed pending settlement.
+     * @param batchIndex      - Receipt batch index containing the proof.
+     * @param provenCount     - Number of calls proven in this proof submission.
+     * @param proof           - Array of 32-byte merkle proof hashes.
+     * @param leaf            - The 32-byte leaf hash being proven.
+     */
+    submitReceiptProof(depositorWallet: PublicKey, nonce: BN | number | bigint, settlementIndex: BN | number | bigint, batchIndex: number, provenCount: BN | number | bigint, proof: number[][], leaf: number[]): Promise<TransactionSignature>;
+    /**
+     * Trigger automatic dispute resolution after the proof deadline.
+     *
+     * Permissionless crank — anyone can call this once the deadline has passed.
+     * Resolution is proportional: if the agent proved N of M claimed calls,
+     * N/M of the settlement amount goes to the agent, the rest is refunded.
+     *
+     * @param agentWallet     - The agent's wallet.
+     * @param depositorWallet - The depositor's wallet.
+     * @param nonce           - Escrow nonce.
+     * @param settlementIndex - Index of the disputed pending settlement.
+     */
+    autoResolveDispute(agentWallet: PublicKey, depositorWallet: PublicKey, nonce: BN | number | bigint, settlementIndex: BN | number | bigint): Promise<TransactionSignature>;
+    /**
+     * Submit agent counter-evidence for a pending dispute.
+     *
+     * The agent stores a SHA-256 hash of off-chain counter-evidence on the
+     * `DisputeRecord`. This is used during automatic resolution (via
+     * {@link autoResolveDispute}) together with the depositor's evidence.
+     *
+     * @param agentWallet     - The agent's wallet.
+     * @param depositorWallet - The depositor's wallet.
+     * @param nonce           - Escrow nonce.
+     * @param settlementIndex - Index of the disputed pending settlement.
+     * @param evidenceHash    - SHA-256 hash (32 bytes) of agent evidence.
+     */
+    submitAgentEvidence(agentWallet: PublicKey, depositorWallet: PublicKey, nonce: BN | number | bigint, settlementIndex: BN | number | bigint, evidenceHash: number[]): Promise<TransactionSignature>;
+    fetchReceiptBatch(escrowV2Pda: PublicKey, batchIndex: number): Promise<ReceiptBatchData>;
+    fetchReceiptBatchNullable(escrowV2Pda: PublicKey, batchIndex: number): Promise<ReceiptBatchData | null>;
+}
+//# sourceMappingURL=receipt.d.ts.map

package/dist/types/modules/receipt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receipt.d.ts","sourceRoot":"","sources":["../../../src/modules/receipt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,oBAAoB,EAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAUpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;GAQG;AACH,qBAAa,aAAc,SAAQ,UAAU;IAG3C,OAAO,CAAC,KAAK;IAMb,kBAAkB,CAChB,WAAW,EAAE,SAAS,EACtB,UAAU,EAAE,MAAM,GACjB,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAM/B;;;;;;;;;;;;;;OAcG;IACG,oBAAoB,CACxB,eAAe,EAAE,SAAS,EAC1B,KAAK,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC3B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAAE,EACpB,SAAS,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC/B,WAAW,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EACjC,SAAS,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAuBhC;;;;;;;;;;;;;;OAcG;IACG,kBAAkB,CACtB,eAAe,EAAE,SAAS,EAC1B,KAAK,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC3B,eAAe,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EACrC,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EACjC,KAAK,EAAE,MAAM,EAAE,EAAE,EACjB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,oBAAoB,CAAC;IAyBhC;;;;;;;;;;;OAWG;IACG,kBAAkB,CACtB,WAAW,EAAE,SAAS,EACtB,eAAe,EAAE,SAAS,EAC1B,KAAK,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC3B,eAAe,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,GACpC,OAAO,CAAC,oBAAoB,CAAC;IAyBhC;;;;;;;;;;;;OAYG;IACG,mBAAmB,CACvB,WAAW,EAAE,SAAS,EACtB,eAAe,EAAE,SAAS,EAC1B,KAAK,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC3B,eAAe,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EACrC,YAAY,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,oBAAoB,CAAC;IAkB1B,iBAAiB,CACrB,WAAW,EAAE,SAAS,EACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,gBAAgB,CAAC;IAKtB,yBAAyB,CAC7B,WAAW,EAAE,SAAS,EACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAIpC"}

package/dist/types/modules/staking.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @module staking
+ * @description Agent staking lifecycle — init, deposit, request unstake,
+ * complete unstake, and fetch stake accounts.
+ *
+ * @category Modules
+ * @since v0.7.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BN } from "@coral-xyz/anchor";
+import { BaseModule } from "./base";
+import type { AgentStakeData } from "../types";
+/**
+ * @name StakingModule
+ * @description Manages agent stake accounts — init, deposit, unstake, and fetch.
+ *
+ * @category Modules
+ * @since v0.7.0
+ * @extends BaseModule
+ */
+export declare class StakingModule extends BaseModule {
+    deriveStake(agentPda: PublicKey): readonly [PublicKey, number];
+    initStake(agentWallet: PublicKey, initialDeposit: BN | number | bigint): Promise<TransactionSignature>;
+    deposit(agentWallet: PublicKey, amount: BN | number | bigint): Promise<TransactionSignature>;
+    requestUnstake(agentWallet: PublicKey, amount: BN | number | bigint): Promise<TransactionSignature>;
+    completeUnstake(agentWallet: PublicKey): Promise<TransactionSignature>;
+    fetch(agentPda: PublicKey): Promise<AgentStakeData>;
+    fetchNullable(agentPda: PublicKey): Promise<AgentStakeData | null>;
+    fetchByPda(stakePda: PublicKey): Promise<AgentStakeData>;
+    /**
+     * Compute the maximum amount that can be requested via `requestUnstake`
+     * without breaching the on-chain {@link MIN_AGENT_STAKE_LAMPORTS} floor.
+     *
+     * Returns 0 if the agent is already at (or below) the floor.
+     *
+     * @since v0.11.0
+     */
+    getMaxUnstakeLamports(stake: AgentStakeData): bigint;
+    /**
+     * Returns the lamport delta the agent must `deposit` to satisfy the
+     * per-escrow stake-coverage requirement for `escrowLamports`. 0 if already
+     * sufficient. Useful for a UI "top up to open this escrow" button.
+     *
+     * Mirrors the on-chain check in `create_escrow_v2` (v0.11 H-1).
+     *
+     * @since v0.11.0
+     */
+    getRequiredTopUp(stake: AgentStakeData, escrowLamports: bigint): bigint;
+}
+//# sourceMappingURL=staking.d.ts.map

package/dist/types/modules/staking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../../../src/modules/staking.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,oBAAoB,EAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAO/C;;;;;;;GAOG;AACH,qBAAa,aAAc,SAAQ,UAAU;IAG3C,WAAW,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAMxD,SAAS,CACb,WAAW,EAAE,SAAS,EACtB,cAAc,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,GACnC,OAAO,CAAC,oBAAoB,CAAC;IA6B1B,OAAO,CACX,WAAW,EAAE,SAAS,EACtB,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAyB1B,cAAc,CAClB,WAAW,EAAE,SAAS,EACtB,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAoC1B,eAAe,CACnB,WAAW,EAAE,SAAS,GACrB,OAAO,CAAC,oBAAoB,CAAC;IAmC1B,KAAK,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAKnD,aAAa,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAKlE,UAAU,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAM9D;;;;;;;OAOG;IACH,qBAAqB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;IAMpD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM;CAKxE"}

package/dist/types/modules/subscription.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @module subscription
+ * @description Agent subscription lifecycle — create, fund, cancel,
+ * close, and fetch subscription accounts.
+ *
+ * @category Modules
+ * @since v0.7.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BN } from "@coral-xyz/anchor";
+import { BaseModule } from "./base";
+import type { SubscriptionData, CreateSubscriptionArgs } from "../types";
+/**
+ * @name SubscriptionModule
+ * @description Manages recurring subscriptions between subscribers and agents.
+ *
+ * @category Modules
+ * @since v0.7.0
+ * @extends BaseModule
+ */
+export declare class SubscriptionModule extends BaseModule {
+    private toNum;
+    deriveSubscription(agentPda: PublicKey, subscriber?: PublicKey, subId?: BN | number | bigint): readonly [PublicKey, number];
+    create(agentWallet: PublicKey, args: CreateSubscriptionArgs): Promise<TransactionSignature>;
+    fund(agentWallet: PublicKey, subId: BN | number | bigint, amount: BN | number | bigint): Promise<TransactionSignature>;
+    cancel(agentWallet: PublicKey, subId?: BN | number | bigint): Promise<TransactionSignature>;
+    close(agentWallet: PublicKey, subId?: BN | number | bigint): Promise<TransactionSignature>;
+    fetch(agentPda: PublicKey, subscriber?: PublicKey, subId?: BN | number | bigint): Promise<SubscriptionData>;
+    fetchNullable(agentPda: PublicKey, subscriber?: PublicKey, subId?: BN | number | bigint): Promise<SubscriptionData | null>;
+    fetchByPda(subPda: PublicKey): Promise<SubscriptionData>;
+}
+//# sourceMappingURL=subscription.d.ts.map

package/dist/types/modules/subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../../src/modules/subscription.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,oBAAoB,EAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAGzE;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,UAAU;IAGhD,OAAO,CAAC,KAAK;IAIb,kBAAkB,CAChB,QAAQ,EAAE,SAAS,EACnB,UAAU,CAAC,EAAE,SAAS,EACtB,KAAK,GAAE,EAAE,GAAG,MAAM,GAAG,MAAU,GAC9B,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAUzB,MAAM,CACV,WAAW,EAAE,SAAS,EACtB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAgC1B,IAAI,CACR,WAAW,EAAE,SAAS,EACtB,KAAK,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC3B,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAwB1B,MAAM,CACV,WAAW,EAAE,SAAS,EACtB,KAAK,GAAE,EAAE,GAAG,MAAM,GAAG,MAAU,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAoB1B,KAAK,CACT,WAAW,EAAE,SAAS,EACtB,KAAK,GAAE,EAAE,GAAG,MAAM,GAAG,MAAU,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAqB1B,KAAK,CACT,QAAQ,EAAE,SAAS,EACnB,UAAU,CAAC,EAAE,SAAS,EACtB,KAAK,GAAE,EAAE,GAAG,MAAM,GAAG,MAAU,GAC9B,OAAO,CAAC,gBAAgB,CAAC;IAKtB,aAAa,CACjB,QAAQ,EAAE,SAAS,EACnB,UAAU,CAAC,EAAE,SAAS,EACtB,KAAK,GAAE,EAAE,GAAG,MAAM,GAAG,MAAU,GAC9B,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAK7B,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAG/D"}

package/dist/types/modules/tools.d.ts

@@ -0,0 +1,172 @@
+/**
+ * @module tools
+ * @description Tool schema registry and session checkpoints for the
+ * Synapse Agent Protocol.
+ *
+ * Covers: publish, inscribe schema, update, deactivate/reactivate,
+ * close, report invocations, and session checkpoint management.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BaseModule } from "./base";
+import type { ToolDescriptorData, SessionCheckpointData, PublishToolArgs, UpdateToolArgs, InscribeToolSchemaArgs } from "../types";
+/**
+ * @name ToolsModule
+ * @description Manages tool descriptors and session checkpoints for the
+ *   Synapse Agent Protocol. Provides methods to publish, update, deactivate,
+ *   reactivate, close, and fetch tool descriptors, as well as inscribe
+ *   JSON schemas into TX logs and manage session checkpoints.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * // Publish a tool by name (auto-hashes)
+ * const sig = await sap.tools.publishByName(
+ *   "getWeather", "mcp-v1", "Fetch weather",
+ *   '{"type":"object"}', '{"type":"object"}',
+ *   0, 1, 2, 1, false,
+ * );
+ * ```
+ */
+export declare class ToolsModule extends BaseModule {
+    /**
+     * @name deriveTool
+     * @description Derive the `ToolDescriptor` PDA for a given agent and tool name.
+     *   The tool name is SHA-256 hashed internally.
+     * @param agentPda - The agent account PDA.
+     * @param toolName - The human-readable tool name.
+     * @returns A tuple of `[PublicKey, bump]` for the tool PDA.
+     * @see {@link deriveTool} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveTool(agentPda: PublicKey, toolName: string): readonly [PublicKey, number];
+    /**
+     * @name publish
+     * @description Publish a new tool descriptor for an agent using pre-computed
+     *   hashes. For auto-hashing, prefer {@link publishByName}.
+     * @param args - Tool publication parameters (name, hashes, HTTP method, category, params, etc.).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    publish(args: PublishToolArgs): Promise<TransactionSignature>;
+    /**
+     * @name publishByName
+     * @description Convenience method to publish a tool using string names.
+     *   All string arguments are automatically SHA-256 hashed.
+     * @param toolName - Human-readable tool name.
+     * @param protocolId - Protocol identifier (e.g. `"mcp-v1"`).
+     * @param description - Tool description text.
+     * @param inputSchema - JSON schema string for input validation.
+     * @param outputSchema - JSON schema string for output validation.
+     * @param httpMethod - Numeric HTTP method enum value.
+     * @param category - Numeric tool category enum value.
+     * @param paramsCount - Total number of parameters.
+     * @param requiredParams - Number of required parameters.
+     * @param isCompound - Whether the tool is a compound (multi-step) tool.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    publishByName(toolName: string, protocolId: string, description: string, inputSchema: string, outputSchema: string, httpMethod: number, category: number, paramsCount: number, requiredParams: number, isCompound: boolean): Promise<TransactionSignature>;
+    /**
+     * @name inscribeSchema
+     * @description Inscribe a full JSON schema into the transaction log (zero rent).
+     *   The schema is stored as TX log data, not as PDA account data.
+     * @param toolName - The human-readable tool name.
+     * @param args - Schema inscription parameters (type, data, hash, compression).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    inscribeSchema(toolName: string, args: InscribeToolSchemaArgs): Promise<TransactionSignature>;
+    /**
+     * @name update
+     * @description Update a tool’s schema hashes and bump its version.
+     *   All fields are optional — only non-null values are written.
+     * @param toolName - The human-readable tool name.
+     * @param args - Partial update parameters (hashes, method, category, params).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    update(toolName: string, args: UpdateToolArgs): Promise<TransactionSignature>;
+    /**
+     * @name deactivate
+     * @description Deactivate a tool. The tool remains discoverable but is
+     *   marked as unavailable.
+     * @param toolName - The human-readable tool name.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    deactivate(toolName: string): Promise<TransactionSignature>;
+    /**
+     * @name reactivate
+     * @description Reactivate a previously deactivated tool.
+     * @param toolName - The human-readable tool name.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    reactivate(toolName: string): Promise<TransactionSignature>;
+    /**
+     * @name close
+     * @description Close a tool PDA and reclaim rent to the owner wallet.
+     * @param toolName - The human-readable tool name.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    close(toolName: string): Promise<TransactionSignature>;
+    /**
+     * @name createCheckpoint
+     * @description Create a checkpoint snapshot of the current session state.
+     *   Checkpoints are indexed by session PDA and checkpoint index.
+     * @param sessionPda - The session ledger PDA.
+     * @param checkpointIndex - The zero-based checkpoint index.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    createCheckpoint(sessionPda: PublicKey, checkpointIndex: number): Promise<TransactionSignature>;
+    /**
+     * @name closeCheckpoint
+     * @description Close a checkpoint PDA and reclaim rent.
+     * @param sessionPda - The session ledger PDA.
+     * @param checkpointIndex - The zero-based checkpoint index.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeCheckpoint(sessionPda: PublicKey, checkpointIndex: number): Promise<TransactionSignature>;
+    /**
+     * @name fetch
+     * @description Fetch a deserialized `ToolDescriptor` account.
+     * @param agentPda - The agent account PDA.
+     * @param toolName - The human-readable tool name.
+     * @returns {Promise<ToolDescriptorData>} The tool descriptor data.
+     * @throws Will throw if the tool descriptor does not exist.
+     * @since v0.1.0
+     */
+    fetch(agentPda: PublicKey, toolName: string): Promise<ToolDescriptorData>;
+    /**
+     * @name fetchNullable
+     * @description Fetch a deserialized `ToolDescriptor` account, or `null`
+     *   if it does not exist on-chain.
+     * @param agentPda - The agent account PDA.
+     * @param toolName - The human-readable tool name.
+     * @returns {Promise<ToolDescriptorData | null>} The tool data or `null`.
+     * @since v0.1.0
+     */
+    fetchNullable(agentPda: PublicKey, toolName: string): Promise<ToolDescriptorData | null>;
+    /**
+     * @name fetchCheckpoint
+     * @description Fetch a deserialized `SessionCheckpoint` account by session PDA and index.
+     * @param sessionPda - The session ledger PDA.
+     * @param checkpointIndex - The zero-based checkpoint index.
+     * @returns {Promise<SessionCheckpointData>} The checkpoint data.
+     * @throws Will throw if the checkpoint does not exist.
+     * @since v0.1.0
+     */
+    fetchCheckpoint(sessionPda: PublicKey, checkpointIndex: number): Promise<SessionCheckpointData>;
+}
+//# sourceMappingURL=tools.d.ts.map

package/dist/types/modules/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../../src/modules/tools.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAiB,KAAK,SAAS,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3F,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAOpC,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAIlB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,WAAY,SAAQ,UAAU;IAGzC;;;;;;;;;OASG;IACH,UAAU,CACR,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,MAAM,GACf,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAM/B;;;;;;;OAOG;IACG,OAAO,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAyDnE;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,OAAO,GAClB,OAAO,CAAC,oBAAoB,CAAC;IA8BhC;;;;;;;;OAQG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;;;;;OAQG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,cAAc,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAsBhC;;;;;;;OAOG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAcjE;;;;;;OAMG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAcjE;;;;;;OAMG;IACG,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgB5D;;;;;;;;OAQG;IACG,gBAAgB,CACpB,UAAU,EAAE,SAAS,EACrB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;OAOG;IACG,eAAe,CACnB,UAAU,EAAE,SAAS,EACrB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;OAQG;IACG,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAK/E;;;;;;;;OAQG;IACG,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAK9F;;;;;;;;OAQG;IACG,eAAe,CACnB,UAAU,EAAE,SAAS,EACrB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,qBAAqB,CAAC;CAIlC"}