@oobe-protocol-labs/synapse-sap-sdk 0.1.0

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

@@ -0,0 +1,126 @@
+/**
+ * @module base
+ * @description Abstract base class for all SDK modules.
+ *
+ * Provides shared access to the Anchor program, provider,
+ * and typed `fetch` / `fetchNullable` helpers.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type AnchorProvider, type Program, BN } from "@coral-xyz/anchor";
+import type { PublicKey, TransactionSignature } from "@solana/web3.js";
+/**
+ * Anchor `Program` instance typed for the Synapse Agent SAP IDL.
+ *
+ * @name SapProgram
+ * @description Alias for `Program<any>` — the Anchor program reference
+ *   used as the backbone of every module in the SDK.
+ * @category Modules
+ * @since v0.1.0
+ */
+export type SapProgram = Program<any>;
+/**
+ * @name SapTransactionResult
+ * @description Instruction builder return type — a ready-to-send transaction.
+ * Contains the finalized transaction signature after RPC submission.
+ * @category Modules
+ * @since v0.1.0
+ */
+export interface SapTransactionResult {
+    /** The base-58 encoded transaction signature returned by the RPC node. */
+    readonly signature: TransactionSignature;
+}
+/**
+ * @name BaseModule
+ * @description Abstract base module inherited by every domain module in the SDK.
+ * Encapsulates the Anchor program reference, provider access, and common
+ * helpers for account fetching and BN construction.
+ *
+ * @abstract
+ * @category Modules
+ * @since v0.1.0
+ *
+ * @example
+ * ```ts
+ * class MyModule extends BaseModule {
+ *   async doSomething() {
+ *     const data = await this.fetchAccount<MyData>("myAccount", pda);
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class BaseModule {
+    protected readonly program: SapProgram;
+    /**
+     * Create a new module instance.
+     *
+     * @param program - The Anchor `Program` instance for the SAP IDL.
+     * @protected
+     */
+    constructor(program: SapProgram);
+    /**
+     * @name methods
+     * @description Instruction method namespace — bypasses `noUncheckedIndexedAccess`
+     *   on `Program<any>` where every property is `T | undefined`.
+     *   Used internally by subclasses to build and send instructions.
+     * @returns The Anchor program `methods` object for chaining instruction builders.
+     * @protected
+     * @since v0.1.0
+     */
+    protected get methods(): any;
+    /**
+     * @name provider
+     * @description The AnchorProvider from the program, giving access to
+     *   the connection and wallet for signing transactions.
+     * @returns {AnchorProvider} The Anchor provider instance.
+     * @protected
+     * @since v0.1.0
+     */
+    protected get provider(): AnchorProvider;
+    /**
+     * @name walletPubkey
+     * @description Convenience accessor for the signer wallet's public key.
+     * @returns {PublicKey} The public key of the connected wallet.
+     * @protected
+     * @since v0.1.0
+     */
+    protected get walletPubkey(): PublicKey;
+    /**
+     * @name fetchAccount
+     * @description Generic account fetch — deserializes the on-chain account
+     *   data into the given type `T`, or throws if the account does not exist.
+     * @typeParam T - The expected deserialized account data type.
+     * @param accountName - The Anchor account discriminator name (e.g. `"agentAccount"`).
+     * @param address - The public key of the account to fetch.
+     * @returns {Promise<T>} The deserialized account data.
+     * @throws Will throw if the account does not exist on-chain.
+     * @protected
+     * @since v0.1.0
+     */
+    protected fetchAccount<T>(accountName: string, address: PublicKey): Promise<T>;
+    /**
+     * @name fetchAccountNullable
+     * @description Generic nullable account fetch — deserializes the on-chain
+     *   account data into type `T`, or returns `null` if the account does not exist.
+     * @typeParam T - The expected deserialized account data type.
+     * @param accountName - The Anchor account discriminator name (e.g. `"agentAccount"`).
+     * @param address - The public key of the account to fetch.
+     * @returns {Promise<T | null>} The deserialized account data, or `null`.
+     * @protected
+     * @since v0.1.0
+     */
+    protected fetchAccountNullable<T>(accountName: string, address: PublicKey): Promise<T | null>;
+    /**
+     * @name bn
+     * @description Create an Anchor `BN` from a number, bigint, or existing BN.
+     *   Passes through values that are already `BN` instances.
+     * @param value - The numeric value to convert.
+     * @returns {BN} An Anchor-compatible big number.
+     * @protected
+     * @since v0.1.0
+     */
+    protected bn(value: number | bigint | BN): BN;
+}
+//# sourceMappingURL=base.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/modules/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvE;;;;;;;;GAQG;AAEH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,UAAU;IAOlB,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU;IANlD;;;;;OAKG;gBAC4B,OAAO,EAAE,UAAU;IAElD;;;;;;;;OAQG;IAEH,SAAS,KAAK,OAAO,IAAI,GAAG,CAG3B;IAED;;;;;;;OAOG;IACH,SAAS,KAAK,QAAQ,IAAI,cAAc,CAEvC;IAED;;;;;;OAMG;IACH,SAAS,KAAK,YAAY,IAAI,SAAS,CAEtC;IAED;;;;;;;;;;;OAWG;cACa,YAAY,CAAC,CAAC,EAC5B,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,SAAS,GACjB,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;;;;;;OAUG;cACa,oBAAoB,CAAC,CAAC,EACpC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,SAAS,GACjB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAKpB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,EAAE,GAAG,EAAE;CAI9C"}

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

@@ -0,0 +1,151 @@
+/**
+ * @module escrow
+ * @description x402 escrow settlement layer — create, deposit,
+ * settle, withdraw, batch settle, and close escrow accounts.
+ *
+ * Supports both SOL and SPL token escrows. SPL operations require
+ * passing additional `AccountMeta[]` via the `splAccounts` parameter.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature, type AccountMeta } from "@solana/web3.js";
+import { BN } from "@coral-xyz/anchor";
+import { BaseModule } from "./base";
+import type { EscrowAccountData, CreateEscrowArgs, Settlement } from "../types";
+/**
+ * @name EscrowModule
+ * @description Manages x402-compatible escrow accounts for agent micropayments.
+ *   Provides methods to create, fund, settle, withdraw, batch-settle, close,
+ *   and fetch escrow PDAs on the Solana Agent Protocol.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * // Create a SOL escrow for an agent
+ * const sig = await sap.escrow.create(agentWallet, {
+ *   pricePerCall: new BN(1_000_000),
+ *   maxCalls: new BN(100),
+ *   initialDeposit: new BN(100_000_000),
+ *   expiresAt: null,
+ *   volumeCurve: null,
+ *   tokenMint: null,
+ *   tokenDecimals: null,
+ * });
+ * ```
+ */
+export declare class EscrowModule extends BaseModule {
+    /**
+     * @name deriveEscrow
+     * @description Derive the `EscrowAccount` PDA for a given agent and depositor.
+     * @param agentPda - The agent account PDA.
+     * @param depositor - The depositor wallet. Defaults to the connected wallet.
+     * @returns A tuple of `[PublicKey, bump]` for the escrow PDA.
+     * @see {@link deriveEscrow} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveEscrow(agentPda: PublicKey, depositor?: PublicKey): readonly [PublicKey, number];
+    /**
+     * @name create
+     * @description Create a new escrow for agent micropayments.
+     *
+     *   For **SOL escrow**: pass `tokenMint: null` and leave `splAccounts` empty.
+     *   For **SPL escrow**: pass `tokenMint`, `tokenDecimals`, and provide
+     *   `splAccounts` with `[depositorAta, escrowAta, tokenMint, tokenProgram]`.
+     *
+     * @param agentWallet - The wallet of the agent to pay.
+     * @param args - Escrow creation parameters (price, max calls, deposit, expiry, volume curve, token info).
+     * @param splAccounts - Remaining accounts for SPL token transfers:
+     *   `[depositorAta, escrowAta, tokenMint, tokenProgram]`. Defaults to `[]`.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    create(agentWallet: PublicKey, args: CreateEscrowArgs, splAccounts?: AccountMeta[]): Promise<TransactionSignature>;
+    /**
+     * @name deposit
+     * @description Deposit additional funds into an existing escrow.
+     * @param agentWallet - The wallet of the agent associated with the escrow.
+     * @param amount - The amount to deposit (lamports for SOL, smallest unit for SPL).
+     * @param splAccounts - Remaining accounts for SPL token transfers. Defaults to `[]`.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    deposit(agentWallet: PublicKey, amount: BN | number | bigint, splAccounts?: AccountMeta[]): Promise<TransactionSignature>;
+    /**
+     * @name settle
+     * @description Agent settles calls — claims earned funds from the escrow.
+     *   Must be called by the agent owner wallet.
+     * @param depositorWallet - The wallet of the client who funded the escrow.
+     * @param callsToSettle - Number of calls to settle payment for.
+     * @param serviceHash - A 32-byte SHA-256 hash identifying the service rendered.
+     * @param splAccounts - Remaining accounts for SPL token transfers. Defaults to `[]`.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    settle(depositorWallet: PublicKey, callsToSettle: BN | number | bigint, serviceHash: number[], splAccounts?: AccountMeta[]): Promise<TransactionSignature>;
+    /**
+     * @name withdraw
+     * @description Client withdraws un-settled funds from their escrow.
+     * @param agentWallet - The wallet of the agent associated with the escrow.
+     * @param amount - The amount to withdraw (lamports for SOL, smallest unit for SPL).
+     * @param splAccounts - Remaining accounts for SPL token transfers. Defaults to `[]`.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    withdraw(agentWallet: PublicKey, amount: BN | number | bigint, splAccounts?: AccountMeta[]): Promise<TransactionSignature>;
+    /**
+     * @name close
+     * @description Close an empty escrow PDA (balance must be 0) and reclaim rent.
+     * @param agentWallet - The wallet of the agent associated with the escrow.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    close(agentWallet: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name settleBatch
+     * @description Batch settlement — process up to 10 settlements in a single
+     *   transaction. Must be called by the agent owner wallet.
+     * @param depositorWallet - The wallet of the client who funded the escrow.
+     * @param settlements - Array of settlement entries (up to 10).
+     * @param splAccounts - Remaining accounts for SPL token transfers. Defaults to `[]`.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    settleBatch(depositorWallet: PublicKey, settlements: Settlement[], splAccounts?: AccountMeta[]): Promise<TransactionSignature>;
+    /**
+     * @name fetch
+     * @description Fetch a deserialized `EscrowAccount`.
+     * @param agentPda - The agent account PDA.
+     * @param depositor - The depositor wallet. Defaults to the connected wallet.
+     * @returns {Promise<EscrowAccountData>} The escrow account data.
+     * @throws Will throw if the escrow account does not exist.
+     * @since v0.1.0
+     */
+    fetch(agentPda: PublicKey, depositor?: PublicKey): Promise<EscrowAccountData>;
+    /**
+     * @name fetchNullable
+     * @description Fetch a deserialized `EscrowAccount`, or `null` if it
+     *   does not exist on-chain.
+     * @param agentPda - The agent account PDA.
+     * @param depositor - The depositor wallet. Defaults to the connected wallet.
+     * @returns {Promise<EscrowAccountData | null>} The escrow data or `null`.
+     * @since v0.1.0
+     */
+    fetchNullable(agentPda: PublicKey, depositor?: PublicKey): Promise<EscrowAccountData | null>;
+    /**
+     * @name fetchByPda
+     * @description Fetch an escrow account by its PDA address directly,
+     *   bypassing PDA derivation.
+     * @param escrowPda - The escrow PDA public key.
+     * @returns {Promise<EscrowAccountData>} The escrow account data.
+     * @throws Will throw if the escrow account does not exist.
+     * @since v0.1.0
+     */
+    fetchByPda(escrowPda: PublicKey): Promise<EscrowAccountData>;
+}
+//# sourceMappingURL=escrow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../../../src/modules/escrow.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,oBAAoB,EACzB,KAAK,WAAW,EACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAMpC,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACX,MAAM,UAAU,CAAC;AAElB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,YAAa,SAAQ,UAAU;IAG1C;;;;;;;;OAQG;IACH,YAAY,CACV,QAAQ,EAAE,SAAS,EACnB,SAAS,CAAC,EAAE,SAAS,GACpB,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAM/B;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,WAAW,EAAE,SAAS,EACtB,IAAI,EAAE,gBAAgB,EACtB,WAAW,GAAE,WAAW,EAAO,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IA0BhC;;;;;;;;OAQG;IACG,OAAO,CACX,WAAW,EAAE,SAAS,EACtB,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC5B,WAAW,GAAE,WAAW,EAAO,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;;;;OAUG;IACG,MAAM,CACV,eAAe,EAAE,SAAS,EAC1B,aAAa,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EACnC,WAAW,EAAE,MAAM,EAAE,EACrB,WAAW,GAAE,WAAW,EAAO,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAkBhC;;;;;;;;OAQG;IACG,QAAQ,CACZ,WAAW,EAAE,SAAS,EACtB,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAC5B,WAAW,GAAE,WAAW,EAAO,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAalE;;;;;;;;;OASG;IACG,WAAW,CACf,eAAe,EAAE,SAAS,EAC1B,WAAW,EAAE,UAAU,EAAE,EACzB,WAAW,GAAE,WAAW,EAAO,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAoBhC;;;;;;;;OAQG;IACG,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKnF;;;;;;;;OAQG;IACG,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAKlG;;;;;;;;OAQG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAGnE"}

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

@@ -0,0 +1,105 @@
+/**
+ * @module feedback
+ * @description Trustless reputation system — give, update, revoke, and close
+ *   on-chain feedback entries for agents.
+ *
+ * Feedback entries are PDA-based reviews tied to an agent and a reviewer wallet,
+ * enabling permissionless, verifiable reputation on Solana.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BaseModule } from "./base";
+import type { FeedbackAccountData, GiveFeedbackArgs, UpdateFeedbackArgs } from "../types";
+/**
+ * @name FeedbackModule
+ * @description Manages on-chain feedback entries for the Solana Agent Protocol.
+ *   Provides methods to give, update, revoke, close, and fetch feedback PDAs
+ *   that form the trustless reputation layer.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * const sig = await sap.feedback.give(agentWallet, {
+ *   score: 5,
+ *   tag: { quality: {} },
+ *   commentHash: null,
+ * });
+ * ```
+ */
+export declare class FeedbackModule extends BaseModule {
+    /**
+     * @name deriveFeedback
+     * @description Derive the `FeedbackAccount` PDA for a given agent and reviewer.
+     * @param agentPda - The agent account PDA to review.
+     * @param reviewer - The reviewer wallet. Defaults to the connected wallet.
+     * @returns A tuple of `[PublicKey, bump]` for the feedback PDA.
+     * @see {@link deriveFeedback} from `pda/` module for the underlying derivation.
+     * @since v0.1.0
+     */
+    deriveFeedback(agentPda: PublicKey, reviewer?: PublicKey): readonly [PublicKey, number];
+    /**
+     * @name give
+     * @description Leave on-chain feedback for an agent. Creates a new
+     *   `FeedbackAccount` PDA owned by the reviewer.
+     * @param agentWallet - The wallet that owns the target agent.
+     * @param args - Feedback parameters (score, tag, optional comment hash).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    give(agentWallet: PublicKey, args: GiveFeedbackArgs): Promise<TransactionSignature>;
+    /**
+     * @name update
+     * @description Update an existing feedback entry. Only the original reviewer
+     *   may update their feedback.
+     * @param agentWallet - The wallet that owns the target agent.
+     * @param args - Updated feedback parameters (new score, optional new tag, optional comment hash).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    update(agentWallet: PublicKey, args: UpdateFeedbackArgs): Promise<TransactionSignature>;
+    /**
+     * @name revoke
+     * @description Revoke a feedback entry, marking it as revoked and excluding
+     *   it from reputation calculations.
+     * @param agentWallet - The wallet that owns the target agent.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    revoke(agentWallet: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name close
+     * @description Close a revoked feedback PDA and reclaim rent to the reviewer.
+     * @param agentWallet - The wallet that owns the target agent.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    close(agentWallet: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name fetch
+     * @description Fetch a deserialized `FeedbackAccount`.
+     * @param agentPda - The agent account PDA.
+     * @param reviewer - The reviewer wallet. Defaults to the connected wallet.
+     * @returns {Promise<FeedbackAccountData>} The feedback account data.
+     * @throws Will throw if the feedback account does not exist.
+     * @since v0.1.0
+     */
+    fetch(agentPda: PublicKey, reviewer?: PublicKey): Promise<FeedbackAccountData>;
+    /**
+     * @name fetchNullable
+     * @description Fetch a deserialized `FeedbackAccount`, or `null` if it
+     *   does not exist on-chain.
+     * @param agentPda - The agent account PDA.
+     * @param reviewer - The reviewer wallet. Defaults to the connected wallet.
+     * @returns {Promise<FeedbackAccountData | null>} The feedback data or `null`.
+     * @since v0.1.0
+     */
+    fetchNullable(agentPda: PublicKey, reviewer?: PublicKey): Promise<FeedbackAccountData | null>;
+}
+//# sourceMappingURL=feedback.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../../src/modules/feedback.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,mBAAmB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAG5C;;;;;;;;OAQG;IACH,cAAc,CACZ,QAAQ,EAAE,SAAS,EACnB,QAAQ,CAAC,EAAE,SAAS,GACnB,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAM/B;;;;;;;;OAQG;IACG,IAAI,CACR,WAAW,EAAE,SAAS,EACtB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,oBAAoB,CAAC;IAiBhC;;;;;;;;OAQG;IACG,MAAM,CACV,WAAW,EAAE,SAAS,EACtB,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;OAOG;IACG,MAAM,CAAC,WAAW,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAcnE;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAelE;;;;;;;;OAQG;IACG,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAKpF;;;;;;;;OAQG;IACG,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAIpG"}

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

@@ -0,0 +1,24 @@
+/**
+ * @module modules
+ * @description Barrel export for all domain modules of the `@synapse-sap/sdk`.
+ *
+ * Re-exports every module class so consumers can import from a single entry point:
+ * ```ts
+ * import { AgentModule, VaultModule } from "@synapse-sap/sdk/modules";
+ * ```
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+export { AgentModule } from "./agent";
+export { FeedbackModule } from "./feedback";
+export { IndexingModule } from "./indexing";
+export { ToolsModule } from "./tools";
+export { VaultModule } from "./vault";
+export { EscrowModule } from "./escrow";
+export { AttestationModule } from "./attestation";
+export { LedgerModule } from "./ledger";
+export { BaseModule } from "./base";
+export type { SapProgram, SapTransactionResult } from "./base";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,YAAY,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC"}

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

@@ -0,0 +1,200 @@
+/**
+ * @module indexing
+ * @description Scalable discovery layer — capability indexes, protocol indexes,
+ * and tool category indexes for the Solana Agent Protocol.
+ *
+ * Indexes are shared PDA-based registries that map agents and tools to
+ * discovery dimensions, enabling efficient on-chain lookups.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @packageDocumentation
+ */
+import { type PublicKey, type TransactionSignature } from "@solana/web3.js";
+import { BaseModule } from "./base";
+import type { CapabilityIndexData, ProtocolIndexData, ToolCategoryIndexData } from "../types";
+/**
+ * @name IndexingModule
+ * @description Manages on-chain discovery indexes for the Solana Agent Protocol.
+ *   Provides methods to create, populate, prune, close, and fetch capability
+ *   indexes, protocol indexes, and tool category indexes.
+ *
+ * @category Modules
+ * @since v0.1.0
+ * @extends BaseModule
+ *
+ * @example
+ * ```ts
+ * const sap = new SapClient(provider);
+ * // Create a capability index and add your agent
+ * await sap.indexing.initCapabilityIndex("text-generation");
+ * // Query agents by capability
+ * const idx = await sap.indexing.fetchCapabilityIndex("text-generation");
+ * ```
+ */
+export declare class IndexingModule extends BaseModule {
+    /**
+     * @name hash
+     * @description Hash a capability or protocol ID string for use as a PDA seed.
+     *   Uses SHA-256 internally.
+     * @param id - The capability or protocol identifier string.
+     * @returns {Uint8Array} The 32-byte SHA-256 hash.
+     * @since v0.1.0
+     */
+    hash(id: string): Uint8Array;
+    /**
+     * @name initCapabilityIndex
+     * @description Create a new capability index and register the caller’s agent.
+     *   The capability ID is hashed to derive the PDA.
+     * @param capabilityId - Human-readable capability identifier (e.g. `"text-generation"`).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    initCapabilityIndex(capabilityId: string): Promise<TransactionSignature>;
+    /**
+     * @name addToCapabilityIndex
+     * @description Add the caller’s agent to an existing capability index.
+     * @param capabilityId - The capability identifier string.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    addToCapabilityIndex(capabilityId: string): Promise<TransactionSignature>;
+    /**
+     * @name removeFromCapabilityIndex
+     * @description Remove the caller’s agent from a capability index.
+     * @param capabilityId - The capability identifier string.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    removeFromCapabilityIndex(capabilityId: string): Promise<TransactionSignature>;
+    /**
+     * @name closeCapabilityIndex
+     * @description Close an empty capability index PDA and reclaim rent.
+     * @param capabilityId - The capability identifier string.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeCapabilityIndex(capabilityId: string): Promise<TransactionSignature>;
+    /**
+     * @name initProtocolIndex
+     * @description Create a new protocol index and register the caller’s agent.
+     *   The protocol ID is hashed to derive the PDA.
+     * @param protocolId - Human-readable protocol identifier (e.g. `"mcp-v1"`).
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    initProtocolIndex(protocolId: string): Promise<TransactionSignature>;
+    /**
+     * @name addToProtocolIndex
+     * @description Add the caller’s agent to an existing protocol index.
+     * @param protocolId - The protocol identifier string.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    addToProtocolIndex(protocolId: string): Promise<TransactionSignature>;
+    /**
+     * @name removeFromProtocolIndex
+     * @description Remove the caller’s agent from a protocol index.
+     * @param protocolId - The protocol identifier string.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    removeFromProtocolIndex(protocolId: string): Promise<TransactionSignature>;
+    /**
+     * @name closeProtocolIndex
+     * @description Close an empty protocol index PDA and reclaim rent.
+     * @param protocolId - The protocol identifier string.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeProtocolIndex(protocolId: string): Promise<TransactionSignature>;
+    /**
+     * @name initToolCategoryIndex
+     * @description Create a new tool category index PDA.
+     * @param category - Numeric tool category enum value.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    initToolCategoryIndex(category: number): Promise<TransactionSignature>;
+    /**
+     * @name addToToolCategory
+     * @description Add a tool to its matching category index.
+     * @param category - Numeric tool category enum value.
+     * @param toolPda - The tool descriptor PDA to add.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    addToToolCategory(category: number, toolPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name removeFromToolCategory
+     * @description Remove a tool from a category index.
+     * @param category - Numeric tool category enum value.
+     * @param toolPda - The tool descriptor PDA to remove.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    removeFromToolCategory(category: number, toolPda: PublicKey): Promise<TransactionSignature>;
+    /**
+     * @name closeToolCategoryIndex
+     * @description Close an empty tool category index PDA and reclaim rent.
+     * @param category - Numeric tool category enum value.
+     * @returns {Promise<TransactionSignature>} The transaction signature.
+     * @since v0.1.0
+     */
+    closeToolCategoryIndex(category: number): Promise<TransactionSignature>;
+    /**
+     * @name fetchCapabilityIndex
+     * @description Fetch a deserialized `CapabilityIndex` account by capability ID.
+     * @param capabilityId - The capability identifier string.
+     * @returns {Promise<CapabilityIndexData>} The capability index data.
+     * @throws Will throw if the capability index does not exist.
+     * @since v0.1.0
+     */
+    fetchCapabilityIndex(capabilityId: string): Promise<CapabilityIndexData>;
+    /**
+     * @name fetchCapabilityIndexNullable
+     * @description Fetch a deserialized `CapabilityIndex` account, or `null`
+     *   if it does not exist on-chain.
+     * @param capabilityId - The capability identifier string.
+     * @returns {Promise<CapabilityIndexData | null>} The capability index data or `null`.
+     * @since v0.1.0
+     */
+    fetchCapabilityIndexNullable(capabilityId: string): Promise<CapabilityIndexData | null>;
+    /**
+     * @name fetchProtocolIndex
+     * @description Fetch a deserialized `ProtocolIndex` account by protocol ID.
+     * @param protocolId - The protocol identifier string.
+     * @returns {Promise<ProtocolIndexData>} The protocol index data.
+     * @throws Will throw if the protocol index does not exist.
+     * @since v0.1.0
+     */
+    fetchProtocolIndex(protocolId: string): Promise<ProtocolIndexData>;
+    /**
+     * @name fetchProtocolIndexNullable
+     * @description Fetch a deserialized `ProtocolIndex` account, or `null`
+     *   if it does not exist on-chain.
+     * @param protocolId - The protocol identifier string.
+     * @returns {Promise<ProtocolIndexData | null>} The protocol index data or `null`.
+     * @since v0.1.0
+     */
+    fetchProtocolIndexNullable(protocolId: string): Promise<ProtocolIndexData | null>;
+    /**
+     * @name fetchToolCategoryIndex
+     * @description Fetch a deserialized `ToolCategoryIndex` account by category number.
+     * @param category - Numeric tool category enum value.
+     * @returns {Promise<ToolCategoryIndexData>} The tool category index data.
+     * @throws Will throw if the tool category index does not exist.
+     * @since v0.1.0
+     */
+    fetchToolCategoryIndex(category: number): Promise<ToolCategoryIndexData>;
+    /**
+     * @name fetchToolCategoryIndexNullable
+     * @description Fetch a deserialized `ToolCategoryIndex` account, or `null`
+     *   if it does not exist on-chain.
+     * @param category - Numeric tool category enum value.
+     * @returns {Promise<ToolCategoryIndexData | null>} The tool category index data or `null`.
+     * @since v0.1.0
+     */
+    fetchToolCategoryIndexNullable(category: number): Promise<ToolCategoryIndexData | null>;
+}
+//# sourceMappingURL=indexing.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"indexing.d.ts","sourceRoot":"","sources":["../../../src/modules/indexing.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;AAQpC,OAAO,KAAK,EACV,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAGlB;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAG5C;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU;IAM5B;;;;;;;OAOG;IACG,mBAAmB,CACvB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAkBhC;;;;;;OAMG;IACG,oBAAoB,CACxB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;OAMG;IACG,yBAAyB,CAC7B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;OAMG;IACG,oBAAoB,CACxB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,oBAAoB,CAAC;IAiBhC;;;;;;;OAOG;IACG,iBAAiB,CACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAkBhC;;;;;;OAMG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;OAMG;IACG,uBAAuB,CAC3B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;OAMG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAiBhC;;;;;;OAMG;IACG,qBAAqB,CACzB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,CAAC;IAahC;;;;;;;OAOG;IACG,iBAAiB,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,SAAS,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;;OAOG;IACG,sBAAsB,CAC1B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,SAAS,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;;;;;OAMG;IACG,sBAAsB,CAC1B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;OAOG;IACG,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAK9E;;;;;;;OAOG;IACG,4BAA4B,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAK7F;;;;;;;OAOG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKxE;;;;;;;OAOG;IACG,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAKvF;;;;;;;OAOG;IACG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAK9E;;;;;;;OAOG;IACG,8BAA8B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;CAI9F"}