@oobe-protocol-labs/synapse-sap-sdk 0.1.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/tools.d.ts

@@ -0,0 +1,182 @@
+/**
+ * @module tools
+ * @description Tool schema registry and session checkpoints for the
+ * Solana 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
+ *   Solana 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 reportInvocations
+     * @description Report tool invocation count. Updates the on-chain counter
+     *   for analytics and discovery ranking.
+     * @param toolName - The human-readable tool name.
+     * @param invocations - The number of invocations to report.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    reportInvocations(toolName: string, invocations: number | bigint): 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;AAGlB;;;;;;;;;;;;;;;;;;;;;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;IA6BnE;;;;;;;;;;;;;;;;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;IAgBhC;;;;;;;;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,iBAAiB,CACrB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAgBhC;;;;;;;;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"}

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

@@ -0,0 +1,240 @@
+/**
+ * @module vault
+ * @description Encrypted memory vault — init, session management, inscribe,
+ * delegate access, nonce rotation, and close operations.
+ *
+ * Vaults provide encrypted, session-scoped memory storage for agents,
+ * with support for epoch-based pagination and hot-wallet delegation.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BaseModule } from "./base";
+import type { MemoryVaultData, SessionLedgerData, EpochPageData, VaultDelegateData, InscribeMemoryArgs, CompactInscribeArgs } from "../types";
+/**
+ * @name VaultModule
+ * @description Manages encrypted memory vaults for the Solana Agent Protocol.
+ *   Provides methods to initialise vaults, open/close sessions, inscribe
+ *   encrypted data, manage delegates (hot wallets), rotate nonces, and
+ *   fetch all related account types.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * // Initialize a vault
+ * await sap.vault.initVault([...nonce]);
+ * // Open a session and inscribe data
+ * await sap.vault.openSession([...sessionHash]);
+ * ```
+ */
+export declare class VaultModule extends BaseModule {
+    /**
+     * @name deriveVault
+     * @description Derive the `MemoryVault` PDA for a given agent.
+     * @param agentPda - The agent account PDA.
+     * @returns A tuple of `[PublicKey, bump]` for the vault PDA.
+     * @see {@link deriveVault} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveVault(agentPda: PublicKey): readonly [PublicKey, number];
+    /**
+     * @name deriveSession
+     * @description Derive the `SessionLedger` PDA for a given vault and session hash.
+     * @param vaultPda - The memory vault PDA.
+     * @param sessionHash - A unique session identifier (32 bytes).
+     * @returns A tuple of `[PublicKey, bump]` for the session PDA.
+     * @see {@link deriveSession} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveSession(vaultPda: PublicKey, sessionHash: Uint8Array): readonly [PublicKey, number];
+    /**
+     * @name initVault
+     * @description Initialize an encrypted memory vault for the caller's agent.
+     *   Creates the `MemoryVault` PDA and sets the initial encryption nonce.
+     * @param vaultNonce - The initial encryption nonce (byte array).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    initVault(vaultNonce: number[]): Promise<TransactionSignature>;
+    /**
+     * @name openSession
+     * @description Open a new session within a vault. Creates a `SessionLedger`
+     *   PDA identified by the session hash.
+     * @param sessionHash - A unique session identifier (byte array).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    openSession(sessionHash: number[]): Promise<TransactionSignature>;
+    /**
+     * @name inscribe
+     * @description Inscribe encrypted data into the transaction log.
+     *   Account resolution is handled by Anchor via remaining accounts.
+     * @param args - Inscription parameters (sequence, encrypted data, nonce, content hash, fragments, compression, epoch).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    inscribe(args: InscribeMemoryArgs): Promise<TransactionSignature>;
+    /**
+     * @name inscribeWithAccounts
+     * @description Full inscribe with explicit session and epoch page PDAs.
+     *   Use this when you need manual control over account resolution.
+     * @param sessionPda - The session ledger PDA.
+     * @param epochPagePda - The epoch page PDA for the target epoch.
+     * @param vaultPda - The memory vault PDA.
+     * @param args - Inscription parameters.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    inscribeWithAccounts(sessionPda: PublicKey, epochPagePda: PublicKey, vaultPda: PublicKey, args: InscribeMemoryArgs): Promise<TransactionSignature>;
+    /**
+     * @name compactInscribe
+     * @description Simplified inscription (4 args vs 8) for single-fragment writes.
+     * @param sessionPda - The session ledger PDA.
+     * @param vaultPda - The memory vault PDA.
+     * @param args - Compact inscription parameters (sequence, encrypted data, nonce, content hash).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    compactInscribe(sessionPda: PublicKey, vaultPda: PublicKey, args: CompactInscribeArgs): Promise<TransactionSignature>;
+    /**
+     * @name closeSession
+     * @description Close a session — no more inscriptions will be allowed.
+     * @param vaultPda - The memory vault PDA.
+     * @param sessionPda - The session ledger PDA to close.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeSession(vaultPda: PublicKey, sessionPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name closeVault
+     * @description Close the `MemoryVault` PDA and reclaim rent to the owner wallet.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeVault(): Promise<TransactionSignature>;
+    /**
+     * @name closeSessionPda
+     * @description Close a `SessionLedger` PDA (session must be closed first).
+     *   Reclaims rent to the owner wallet.
+     * @param vaultPda - The memory vault PDA.
+     * @param sessionPda - The session ledger PDA to close.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeSessionPda(vaultPda: PublicKey, sessionPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name closeEpochPage
+     * @description Close an `EpochPage` PDA and reclaim rent.
+     * @param sessionPda - The session ledger PDA that owns this epoch page.
+     * @param epochIndex - The zero-based epoch index.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeEpochPage(sessionPda: PublicKey, epochIndex: number): Promise<TransactionSignature>;
+    /**
+     * @name rotateNonce
+     * @description Rotate the vault encryption nonce. All future inscriptions
+     *   will use the new nonce.
+     * @param newNonce - The replacement nonce (byte array).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    rotateNonce(newNonce: number[]): Promise<TransactionSignature>;
+    /**
+     * @name addDelegate
+     * @description Authorize a delegate (hot wallet) for vault operations.
+     *   Creates a `VaultDelegate` PDA with the specified permissions and expiry.
+     * @param delegatePubkey - The public key of the delegate wallet to authorize.
+     * @param permissions - Bitmask of permitted operations.
+     * @param expiresAt - Unix timestamp when delegation expires.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    addDelegate(delegatePubkey: PublicKey, permissions: number, expiresAt: number | bigint): Promise<TransactionSignature>;
+    /**
+     * @name revokeDelegate
+     * @description Revoke a delegate’s authorization, closing their `VaultDelegate` PDA.
+     * @param delegatePubkey - The public key of the delegate wallet to revoke.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    revokeDelegate(delegatePubkey: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name inscribeDelegated
+     * @description Inscribe data via an authorized delegate (hot wallet).
+     *   The transaction is signed by the delegate instead of the vault owner.
+     * @param delegateWallet - The delegate wallet public key.
+     * @param vaultPda - The memory vault PDA.
+     * @param sessionPda - The session ledger PDA.
+     * @param epochPagePda - The epoch page PDA.
+     * @param args - Inscription parameters.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    inscribeDelegated(delegateWallet: PublicKey, vaultPda: PublicKey, sessionPda: PublicKey, epochPagePda: PublicKey, args: InscribeMemoryArgs): Promise<TransactionSignature>;
+    /**
+     * @name fetchVault
+     * @description Fetch a deserialized `MemoryVault` account.
+     * @param agentPda - The agent account PDA.
+     * @returns {Promise<MemoryVaultData>} The vault account data.
+     * @throws Will throw if the vault account does not exist.
+     * @since v0.1.0
+     */
+    fetchVault(agentPda: PublicKey): Promise<MemoryVaultData>;
+    /**
+     * @name fetchVaultNullable
+     * @description Fetch a deserialized `MemoryVault` account, or `null`
+     *   if it does not exist on-chain.
+     * @param agentPda - The agent account PDA.
+     * @returns {Promise<MemoryVaultData | null>} The vault data or `null`.
+     * @since v0.1.0
+     */
+    fetchVaultNullable(agentPda: PublicKey): Promise<MemoryVaultData | null>;
+    /**
+     * @name fetchSession
+     * @description Fetch a deserialized `SessionLedger` account by vault and session hash.
+     * @param vaultPda - The memory vault PDA.
+     * @param sessionHash - The session identifier used during creation.
+     * @returns {Promise<SessionLedgerData>} The session ledger data.
+     * @throws Will throw if the session does not exist.
+     * @since v0.1.0
+     */
+    fetchSession(vaultPda: PublicKey, sessionHash: Uint8Array): Promise<SessionLedgerData>;
+    /**
+     * @name fetchSessionByPda
+     * @description Fetch a deserialized `SessionLedger` account by its PDA directly,
+     *   bypassing PDA derivation.
+     * @param sessionPda - The session ledger PDA.
+     * @returns {Promise<SessionLedgerData>} The session ledger data.
+     * @throws Will throw if the session does not exist.
+     * @since v0.1.0
+     */
+    fetchSessionByPda(sessionPda: PublicKey): Promise<SessionLedgerData>;
+    /**
+     * @name fetchEpochPage
+     * @description Fetch a deserialized `EpochPage` account.
+     * @param sessionPda - The session ledger PDA.
+     * @param epochIndex - The zero-based epoch index.
+     * @returns {Promise<EpochPageData>} The epoch page data.
+     * @throws Will throw if the epoch page does not exist.
+     * @since v0.1.0
+     */
+    fetchEpochPage(sessionPda: PublicKey, epochIndex: number): Promise<EpochPageData>;
+    /**
+     * @name fetchDelegate
+     * @description Fetch a deserialized `VaultDelegate` account.
+     * @param vaultPda - The memory vault PDA.
+     * @param delegatePubkey - The delegate wallet public key.
+     * @returns {Promise<VaultDelegateData>} The delegate account data.
+     * @throws Will throw if the delegate does not exist.
+     * @since v0.1.0
+     */
+    fetchDelegate(vaultPda: PublicKey, delegatePubkey: PublicKey): Promise<VaultDelegateData>;
+}
+//# sourceMappingURL=vault.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../../src/modules/vault.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;AASpC,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAElB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,WAAY,SAAQ,UAAU;IAGzC;;;;;;;OAOG;IACH,WAAW,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAI9D;;;;;;;;OAQG;IACH,aAAa,CACX,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,UAAU,GACtB,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAM/B;;;;;;;OAOG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAiBpE;;;;;;;OAOG;IACG,WAAW,CACf,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAgBhC;;;;;;;OAOG;IACG,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAkBvE;;;;;;;;;;OAUG;IACG,oBAAoB,CACxB,UAAU,EAAE,SAAS,EACrB,YAAY,EAAE,SAAS,EACvB,QAAQ,EAAE,SAAS,EACnB,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAsBhC;;;;;;;;OAQG;IACG,eAAe,CACnB,UAAU,EAAE,SAAS,EACrB,QAAQ,EAAE,SAAS,EACnB,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,oBAAoB,CAAC;IAgBhC;;;;;;;OAOG;IACG,YAAY,CAChB,QAAQ,EAAE,SAAS,EACnB,UAAU,EAAE,SAAS,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAWhC;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAcjD;;;;;;;;OAQG;IACG,eAAe,CACnB,QAAQ,EAAE,SAAS,EACnB,UAAU,EAAE,SAAS,GACpB,OAAO,CAAC,oBAAoB,CAAC;IAWhC;;;;;;;OAOG;IACG,cAAc,CAClB,UAAU,EAAE,SAAS,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAahC;;;;;;;OAOG;IACG,WAAW,CACf,QAAQ,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;;OASG;IACG,WAAW,CACf,cAAc,EAAE,SAAS,EACzB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAAG,MAAM,GACzB,OAAO,CAAC,oBAAoB,CAAC;IAiBhC;;;;;;OAMG;IACG,cAAc,CAClB,cAAc,EAAE,SAAS,GACxB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;;;;OAWG;IACG,iBAAiB,CACrB,cAAc,EAAE,SAAS,EACzB,QAAQ,EAAE,SAAS,EACnB,UAAU,EAAE,SAAS,EACrB,YAAY,EAAE,SAAS,EACvB,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,oBAAoB,CAAC;IA2BhC;;;;;;;OAOG;IACG,UAAU,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC;IAK/D;;;;;;;OAOG;IACG,kBAAkB,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAK9E;;;;;;;;OAQG;IACG,YAAY,CAChB,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,UAAU,GACtB,OAAO,CAAC,iBAAiB,CAAC;IAK7B;;;;;;;;OAQG;IACG,iBAAiB,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI1E;;;;;;;;OAQG;IACG,cAAc,CAClB,UAAU,EAAE,SAAS,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,aAAa,CAAC;IAKzB;;;;;;;;OAQG;IACG,aAAa,CACjB,QAAQ,EAAE,SAAS,EACnB,cAAc,EAAE,SAAS,GACxB,OAAO,CAAC,iBAAiB,CAAC;CAI9B"}