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

package/dist/esm/modules/feedback.js

@@ -0,0 +1,162 @@
+/**
+ * @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 { SystemProgram } from "@solana/web3.js";
+import { BaseModule } from "./base";
+import { deriveAgent, deriveFeedback, deriveGlobalRegistry } from "../pda";
+/**
+ * @name FeedbackModule
+ * @description Manages on-chain feedback entries for the Synapse 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 class FeedbackModule extends BaseModule {
+    // ── PDA helpers ──────────────────────────────────────
+    /**
+     * @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, reviewer) {
+        return deriveFeedback(agentPda, reviewer ?? this.walletPubkey);
+    }
+    // ── Instructions ─────────────────────────────────────
+    /**
+     * @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
+     */
+    async give(agentWallet, args) {
+        const [agentPda] = deriveAgent(agentWallet);
+        const [feedbackPda] = this.deriveFeedback(agentPda);
+        const [globalPda] = deriveGlobalRegistry();
+        return this.methods
+            .giveFeedback(args.score, args.tag, args.commentHash ?? null)
+            .accounts({
+            reviewer: this.walletPubkey,
+            agent: agentPda,
+            feedback: feedbackPda,
+            globalRegistry: globalPda,
+            systemProgram: SystemProgram.programId,
+        })
+            .rpc();
+    }
+    /**
+     * @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
+     */
+    async update(agentWallet, args) {
+        const [agentPda] = deriveAgent(agentWallet);
+        const [feedbackPda] = this.deriveFeedback(agentPda);
+        return this.methods
+            .updateFeedback(args.newScore, args.newTag ?? null, args.commentHash ?? null)
+            .accounts({
+            reviewer: this.walletPubkey,
+            agent: agentPda,
+            feedback: feedbackPda,
+        })
+            .rpc();
+    }
+    /**
+     * @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
+     */
+    async revoke(agentWallet) {
+        const [agentPda] = deriveAgent(agentWallet);
+        const [feedbackPda] = this.deriveFeedback(agentPda);
+        return this.methods
+            .revokeFeedback()
+            .accounts({
+            reviewer: this.walletPubkey,
+            agent: agentPda,
+            feedback: feedbackPda,
+        })
+            .rpc();
+    }
+    /**
+     * @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
+     */
+    async close(agentWallet) {
+        const [agentPda] = deriveAgent(agentWallet);
+        const [feedbackPda] = this.deriveFeedback(agentPda);
+        return this.methods
+            .closeFeedback()
+            .accounts({
+            reviewer: this.walletPubkey,
+            feedback: feedbackPda,
+        })
+            .rpc();
+    }
+    // ── Fetchers ─────────────────────────────────────────
+    /**
+     * @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
+     */
+    async fetch(agentPda, reviewer) {
+        const [pda] = this.deriveFeedback(agentPda, reviewer);
+        return this.fetchAccount("feedbackAccount", pda);
+    }
+    /**
+     * @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
+     */
+    async fetchNullable(agentPda, reviewer) {
+        const [pda] = this.deriveFeedback(agentPda, reviewer);
+        return this.fetchAccountNullable("feedbackAccount", pda);
+    }
+}
+//# sourceMappingURL=feedback.js.map

package/dist/esm/modules/feedback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.js","sourceRoot":"","sources":["../../../src/modules/feedback.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,aAAa,EAA6C,MAAM,iBAAiB,CAAC;AAC3F,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAG3E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IAC5C,wDAAwD;IAExD;;;;;;;;OAQG;IACH,cAAc,CACZ,QAAmB,EACnB,QAAoB;QAEpB,OAAO,cAAc,CAAC,QAAQ,EAAE,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IACjE,CAAC;IAED,wDAAwD;IAExD;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CACR,WAAsB,EACtB,IAAsB;QAEtB,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,CAAC,SAAS,CAAC,GAAG,oBAAoB,EAAE,CAAC;QAE3C,OAAO,IAAI,CAAC,OAAO;aAChB,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;aAC5D,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,WAAW;YACrB,cAAc,EAAE,SAAS;YACzB,aAAa,EAAE,aAAa,CAAC,SAAS;SACvC,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,WAAsB,EACtB,IAAwB;QAExB,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEpD,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;aAC5E,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,WAAW;SACtB,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,WAAsB;QACjC,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEpD,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,EAAE;aAChB,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,WAAW;SACtB,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,WAAsB;QAChC,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEpD,OAAO,IAAI,CAAC,OAAO;aAChB,aAAa,EAAE;aACf,QAAQ,CAAC;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,QAAQ,EAAE,WAAW;SACtB,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAED,wDAAwD;IAExD;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,QAAmB,EAAE,QAAoB;QACnD,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,YAAY,CAAsB,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CAAC,QAAmB,EAAE,QAAoB;QAC3D,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,oBAAoB,CAAsB,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAChF,CAAC;CACF"}

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

@@ -0,0 +1,28 @@
+/**
+ * @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 { EscrowV2Module } from "./escrow-v2";
+export { ReceiptModule } from "./receipt";
+export { StakingModule } from "./staking";
+export { SubscriptionModule } from "./subscription";
+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/esm/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,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,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/esm/modules/index.js

@@ -0,0 +1,27 @@
+/**
+ * @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 { EscrowV2Module } from "./escrow-v2";
+export { ReceiptModule } from "./receipt";
+export { StakingModule } from "./staking";
+export { SubscriptionModule } from "./subscription";
+export { AttestationModule } from "./attestation";
+export { LedgerModule } from "./ledger";
+export { BaseModule } from "./base";
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","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,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC"}

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

@@ -0,0 +1,200 @@
+/**
+ * @module indexing
+ * @description Scalable discovery layer — capability indexes, protocol indexes,
+ * and tool category indexes for the Synapse 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 Synapse 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/esm/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"}