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

package/src/core/client.ts

@@ -1,583 +0,0 @@
-/**
- * @module core/client
- * @description Core SapClient — thin wrapper around the Anchor program
- * that wires up provider, IDL, and exposes typed module accessors.
- *
- * This is the primary entry point for the `@synapse-sap/sdk` package.
- * All protocol domains (agent lifecycle, reputation, vault, escrow, etc.)
- * are available as lazily-instantiated, strongly-typed module accessors.
- *
- * @since v0.1.0
- * @category Core
- *
- * @example
- * ```ts
- * import { SapClient } from "@synapse-sap/sdk";
- *
- * const client = SapClient.from(provider);          // auto-IDL
- * const client = SapClient.fromProgram(program);    // existing program
- *
- * // Use domain modules:
- * await client.agent.register({ ... });
- * await client.vault.initVault(vaultNonce);
- * const escrow = await client.escrow.fetch(escrowPda);
- * ```
- */
-
-import { type AnchorProvider, Program } from "@coral-xyz/anchor";
-import type { PublicKey } from "@solana/web3.js";
-import { SAP_PROGRAM_ID } from "../constants";
-import { AgentModule } from "../modules/agent";
-import { FeedbackModule } from "../modules/feedback";
-import { IndexingModule } from "../modules/indexing";
-import { ToolsModule } from "../modules/tools";
-import { VaultModule } from "../modules/vault";
-import { EscrowModule } from "../modules/escrow";
-import { EscrowV2Module } from "../modules/escrow-v2";
-import { ReceiptModule } from "../modules/receipt";
-import { StakingModule } from "../modules/staking";
-import { SubscriptionModule } from "../modules/subscription";
-import { AttestationModule } from "../modules/attestation";
-import { LedgerModule } from "../modules/ledger";
-import { EventParser } from "../events";
-import { TransactionParser } from "../parser/client";
-import { DiscoveryRegistry } from "../registries/discovery";
-import { X402Registry } from "../registries/x402";
-import { SessionManager } from "../registries/session";
-import { AgentBuilder } from "../registries/builder";
-import { MetaplexBridge } from "../registries/metaplex-bridge";
-import { FairScaleRegistry, type FairScaleConfig } from "../registries/fairscale";
-
-// IDL is embedded inside the SDK — no external workspace dependency
-import idl from "../idl/synapse_agent_sap.json";
-
-/** Re-usable Anchor program type (untyped — SDK provides its own types). */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type SapProgram = Program<any>;
-
-/**
- * @name SapClient
- * @description Root entry point for the Synapse Agent Protocol v2 TypeScript SDK.
- *
- * Each protocol domain is exposed as a lazily-instantiated module:
- * `agent`, `feedback`, `indexing`, `tools`, `vault`, `escrow`,
- * `attestation`, `ledger`, `events`.
- *
- * Higher-level abstractions (`discovery`, `x402`, `session`, `builder`)
- * compose the low-level modules into ergonomic workflows.
- *
- * Instantiate via the static factory methods {@link SapClient.from} or
- * {@link SapClient.fromProgram} — the constructor is private.
- *
- * @category Core
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import { SapClient } from "@synapse-sap/sdk";
- * import { AnchorProvider } from "@coral-xyz/anchor";
- *
- * const provider = AnchorProvider.env();
- * const client = SapClient.from(provider);
- *
- * // Register an agent
- * await client.agent.register({
- *   name: "SwapBot",
- *   description: "AI-powered swap agent",
- * });
- *
- * // Discover agents
- * const agents = await client.discovery.findAgentsByProtocol("jupiter");
- * ```
- */
-export class SapClient {
-  /**
-   * @name program
-   * @description The underlying Anchor `Program` instance used for all RPC
-   * calls and account deserialization.
-   * @readonly
-   * @category Core
-   * @since v0.1.0
-   */
-  readonly program: SapProgram;
-
-  /**
-   * @name walletPubkey
-   * @description The provider wallet's public key, extracted from the
-   * Anchor provider for convenience. This is the default authority /
-   * payer used by module instructions unless overridden.
-   * @readonly
-   * @category Core
-   * @since v0.1.0
-   */
-  readonly walletPubkey: PublicKey;
-
-  // ── Lazy module singletons ────────────────────────
-  #agent?: AgentModule;
-  #feedback?: FeedbackModule;
-  #indexing?: IndexingModule;
-  #tools?: ToolsModule;
-  #vault?: VaultModule;
-  #escrow?: EscrowModule;
-  #escrowV2?: EscrowV2Module;
-  #receipt?: ReceiptModule;
-  #staking?: StakingModule;
-  #subscription?: SubscriptionModule;
-  #attestation?: AttestationModule;
-  #ledger?: LedgerModule;
-  #events?: EventParser;
-
-  // ── Lazy parser singleton ─────────────────────
-  #parser?: TransactionParser;
-
-  // ── Lazy registry singletons ──────────────────────
-  #discovery?: DiscoveryRegistry;
-  #x402?: X402Registry;
-  #session?: SessionManager;
-  #metaplex?: MetaplexBridge;
-  #fairscale?: FairScaleRegistry;
-  #fairscaleConfig?: FairScaleConfig;
-
-  private constructor(program: SapProgram) {
-    this.program = program;
-    this.walletPubkey = (program.provider as AnchorProvider).wallet.publicKey;
-  }
-
-  // ═════════════════════════════════════════════
-  //  Factory Methods
-  // ═════════════════════════════════════════════
-
-  /**
-   * @name from
-   * @description Create a {@link SapClient} from an `AnchorProvider`.
-   * Automatically loads the embedded IDL shipped with the SDK.
-   *
-   * @param provider - A configured `AnchorProvider` with wallet and connection.
-   * @param programId - Optional override for the SAP program ID.
-   *   Defaults to `SAP_PROGRAM_ID` from `@synapse-sap/sdk/constants`.
-   * @returns A fully-initialised `SapClient` ready for use.
-   *
-   * @category Core
-   * @since v0.1.0
-   * @see {@link SapClient.fromProgram} for an alternative accepting a pre-built `Program`.
-   *
-   * @example
-   * ```ts
-   * import { SapClient } from "@synapse-sap/sdk";
-   * import { AnchorProvider } from "@coral-xyz/anchor";
-   *
-   * const provider = AnchorProvider.env();
-   * const client = SapClient.from(provider);
-   * ```
-   *
-   * @example Custom program ID (e.g. localnet)
-   * ```ts
-   * const client = SapClient.from(provider, myLocalProgramId);
-   * ```
-   */
-  static from(
-    provider: AnchorProvider,
-    programId: PublicKey = SAP_PROGRAM_ID,
-  ): SapClient {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const program = new Program(idl as any, provider);
-    // Override program ID if non-default
-    if (!programId.equals(SAP_PROGRAM_ID)) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (program as any).programId = programId;
-    }
-    return new SapClient(program);
-  }
-
-  /**
-   * @name fromProgram
-   * @description Create a {@link SapClient} from an existing Anchor `Program`
-   * instance. Useful when the caller already has a configured program or
-   * needs full control over IDL resolution.
-   *
-   * @param program - A pre-built Anchor `Program` targeting the SAP program.
-   * @returns A fully-initialised `SapClient` wrapping the supplied program.
-   *
-   * @category Core
-   * @since v0.1.0
-   * @see {@link SapClient.from} for the convenience factory that auto-loads the IDL.
-   *
-   * @example
-   * ```ts
-   * import { Program } from "@coral-xyz/anchor";
-   * import { SapClient } from "@synapse-sap/sdk";
-   *
-   * const program = new Program(idl, provider);
-   * const client = SapClient.fromProgram(program);
-   * ```
-   */
-  static fromProgram(program: SapProgram): SapClient {
-    return new SapClient(program);
-  }
-
-  // ═════════════════════════════════════════════
-  //  Module Accessors (lazy singletons)
-  // ═════════════════════════════════════════════
-
-  /**
-   * @name agent
-   * @description Agent lifecycle: register, update, deactivate, close, and
-   * query agent metrics on-chain.
-   * @returns {AgentModule} The lazily-instantiated `AgentModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link AgentModule}
-   */
-  get agent(): AgentModule {
-    return (this.#agent ??= new AgentModule(this.program));
-  }
-
-  /**
-   * @name feedback
-   * @description Trustless reputation: give, update, revoke, and close
-   * on-chain feedback entries for agents.
-   * @returns {FeedbackModule} The lazily-instantiated `FeedbackModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link FeedbackModule}
-   */
-  get feedback(): FeedbackModule {
-    return (this.#feedback ??= new FeedbackModule(this.program));
-  }
-
-  /**
-   * @name indexing
-   * @description Scalable discovery: capability, protocol, and tool-category
-   * on-chain indexes for agent search.
-   * @returns {IndexingModule} The lazily-instantiated `IndexingModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link IndexingModule}
-   */
-  get indexing(): IndexingModule {
-    return (this.#indexing ??= new IndexingModule(this.program));
-  }
-
-  /**
-   * @name tools
-   * @description Tool schema registry: publish, inscribe, update, and close
-   * on-chain tool definitions.
-   * @returns {ToolsModule} The lazily-instantiated `ToolsModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link ToolsModule}
-   */
-  get tools(): ToolsModule {
-    return (this.#tools ??= new ToolsModule(this.program));
-  }
-
-  /**
-   * @name vault
-   * @description Encrypted memory vault: initialise vaults, manage sessions,
-   * inscribe data, and delegate access.
-   * @returns {VaultModule} The lazily-instantiated `VaultModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link VaultModule}
-   */
-  get vault(): VaultModule {
-    return (this.#vault ??= new VaultModule(this.program));
-  }
-
-  /**
-   * @name escrow
-   * @description x402 escrow settlement: create escrow accounts, deposit
-   * funds, settle payments, and withdraw balances.
-   * @returns {EscrowModule} The lazily-instantiated `EscrowModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link EscrowModule}
-   */
-  get escrow(): EscrowModule {
-    return (this.#escrow ??= new EscrowModule(this.program));
-  }
-
-  /**
-   * @name escrowV2
-   * @description V2 escrow settlement with dispute windows, co-signing,
-   * pending settlements, and migration from V1.
-   * @returns {EscrowV2Module} The lazily-instantiated `EscrowV2Module` singleton.
-   * @category Modules
-   * @since v0.7.0
-   * @see {@link EscrowV2Module}
-   */
-  get escrowV2(): EscrowV2Module {
-    return (this.#escrowV2 ??= new EscrowV2Module(this.program));
-  }
-
-  /**
-   * @name receipt
-   * @description Receipt batch inscriptions and automatic dispute resolution (v0.7).
-   * @returns {ReceiptModule} The lazily-instantiated `ReceiptModule` singleton.
-   * @category Modules
-   * @since v0.7.0
-   * @see {@link ReceiptModule}
-   */
-  get receipt(): ReceiptModule {
-    return (this.#receipt ??= new ReceiptModule(this.program));
-  }
-
-  /**
-   * @name staking
-   * @description Agent staking: init stake, deposit, request unstake,
-   * and complete unstake.
-   * @returns {StakingModule} The lazily-instantiated `StakingModule` singleton.
-   * @category Modules
-   * @since v0.7.0
-   * @see {@link StakingModule}
-   */
-  get staking(): StakingModule {
-    return (this.#staking ??= new StakingModule(this.program));
-  }
-
-  /**
-   * @name subscription
-   * @description Recurring subscriptions: create, fund, cancel, and close
-   * subscriber-agent subscription accounts.
-   * @returns {SubscriptionModule} The lazily-instantiated `SubscriptionModule` singleton.
-   * @category Modules
-   * @since v0.7.0
-   * @see {@link SubscriptionModule}
-   */
-  get subscription(): SubscriptionModule {
-    return (this.#subscription ??= new SubscriptionModule(this.program));
-  }
-
-  /**
-   * @name attestation
-   * @description Web of trust: create, revoke, and close on-chain
-   * attestations between agents.
-   * @returns {AttestationModule} The lazily-instantiated `AttestationModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link AttestationModule}
-   */
-  get attestation(): AttestationModule {
-    return (this.#attestation ??= new AttestationModule(this.program));
-  }
-
-  /**
-   * @name ledger
-   * @description Unified on-chain memory: initialise ledger accounts, write
-   * entries, seal pages, and close ledgers.
-   * @returns {LedgerModule} The lazily-instantiated `LedgerModule` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link LedgerModule}
-   */
-  get ledger(): LedgerModule {
-    return (this.#ledger ??= new LedgerModule(this.program));
-  }
-
-  /**
-   * @name events
-   * @description Decode SAP protocol events from on-chain transaction logs.
-   * @returns {EventParser} The lazily-instantiated `EventParser` singleton.
-   * @category Modules
-   * @since v0.1.0
-   * @see {@link EventParser}
-   */
-  get events(): EventParser {
-    return (this.#events ??= new EventParser(this.program));
-  }
-
-  /**
-   * @name parser
-   * @description Transaction parser: decode instruction names, arguments,
-   * accounts, inner CPI calls, and protocol events from raw transaction
-   * responses. Designed for indexers and explorers.
-   * @returns {TransactionParser} The lazily-instantiated `TransactionParser` singleton.
-   * @category Modules
-   * @since v0.5.0
-   * @see {@link TransactionParser}
-   *
-   * @example
-   * ```ts
-   * const tx = await connection.getTransaction(sig, { ... });
-   * const parsed = client.parser.parseTransaction(tx);
-   * console.log(parsed?.instructions.map(i => i.name));
-   * ```
-   */
-  get parser(): TransactionParser {
-    return (this.#parser ??= new TransactionParser(this.program));
-  }
-
-  // ═════════════════════════════════════════════
-  //  Registry Accessors (high-level abstractions)
-  // ═════════════════════════════════════════════
-
-  /**
-   * @name discovery
-   * @description Agent & tool discovery across the SAP network.
-   * Provides high-level queries for locating agents by capability,
-   * protocol, or wallet address.
-   *
-   * @returns {DiscoveryRegistry} The lazily-instantiated `DiscoveryRegistry` singleton.
-   * @category Registries
-   * @since v0.1.0
-   * @see {@link DiscoveryRegistry}
-   *
-   * @example
-   * ```ts
-   * const agents = await client.discovery.findAgentsByProtocol("jupiter");
-   * const profile = await client.discovery.getAgentProfile(wallet);
-   * ```
-   */
-  get discovery(): DiscoveryRegistry {
-    return (this.#discovery ??= new DiscoveryRegistry(this.program));
-  }
-
-  /**
-   * @name x402
-   * @description x402 micropayment lifecycle — pricing, escrow, headers,
-   * and settlement. Orchestrates the full pay-per-call flow between
-   * consumer and agent.
-   *
-   * @returns {X402Registry} The lazily-instantiated `X402Registry` singleton.
-   * @category Registries
-   * @since v0.1.0
-   * @see {@link X402Registry}
-   *
-   * @example
-   * ```ts
-   * const ctx = await client.x402.preparePayment(agentWallet, { ... });
-   * const headers = client.x402.buildPaymentHeaders(ctx);
-   * const receipt = await client.x402.settle(depositor, 5, serviceData);
-   * ```
-   */
-  get x402(): X402Registry {
-    return (this.#x402 ??= new X402Registry(this.program));
-  }
-
-  /**
-   * @name session
-   * @description Unified memory session lifecycle — vault, session, and
-   * ledger management. Provides a single interface for starting
-   * conversations, writing messages, and reading back history.
-   *
-   * @returns {SessionManager} The lazily-instantiated `SessionManager` singleton.
-   * @category Registries
-   * @since v0.1.0
-   * @see {@link SessionManager}
-   *
-   * @example
-   * ```ts
-   * const ctx = await client.session.start("conversation-123");
-   * await client.session.write(ctx, "Hello from agent");
-   * const msgs = await client.session.readLatest(ctx);
-   * ```
-   */
-  get session(): SessionManager {
-    return (this.#session ??= new SessionManager(this.program));
-  }
-
-  /**
-   * @name builder
-   * @description Fluent agent registration builder.
-   * Returns a **new** `AgentBuilder` on every access — use for one-shot
-   * registration flows. Chain configuration calls and finalise with
-   * `.register()`.
-   *
-   * @returns {AgentBuilder} A fresh `AgentBuilder` instance.
-   * @category Registries
-   * @since v0.1.0
-   * @see {@link AgentBuilder}
-   *
-   * @example
-   * ```ts
-   * await client.builder
-   *   .agent("SwapBot")
-   *   .description("AI-powered swap agent")
-   *   .x402Endpoint("https://api.example.com/x402")
-   *   .addCapability("jupiter:swap", { protocol: "jupiter" })
-   *   .addPricingTier({ tierId: "standard", pricePerCall: 1000, rateLimit: 60 })
-   *   .register();
-   * ```
-   */
-  get builder(): AgentBuilder {
-    return new AgentBuilder(this.program);
-  }
-
-  /**
-   * @name metaplex
-   * @description Bridge between SAP and the Metaplex Agent Kit
-   * (MPL Core Asset + AgentIdentity plugin). Read-side merges SAP
-   * `AgentAccount` with MPL Core asset metadata; write-side composes
-   * atomic dual-protocol delegation instructions.
-   *
-   * Requires the optional peer dependencies
-   * `@metaplex-foundation/mpl-core` and
-   * `@metaplex-foundation/umi-bundle-defaults`. They are imported lazily
-   * the first time a method that needs them is called, so consumers that
-   * do not use the bridge incur zero overhead.
-   *
-   * @returns {MetaplexBridge} The lazily-instantiated `MetaplexBridge` singleton.
-   * @category Registries
-   * @since v0.9.0
-   * @see {@link MetaplexBridge}
-   *
-   * @example
-   * ```ts
-   * const profile = await client.metaplex.getUnifiedProfile({
-   *   wallet: agentWallet,
-   *   rpcUrl: "https://api.mainnet-beta.solana.com",
-   * });
-   * ```
-   */
-  get metaplex(): MetaplexBridge {
-    return (this.#metaplex ??= new MetaplexBridge(this.program));
-  }
-
-  /**
-   * @name configureFairScale
-   * @description Set FairScale credentials / endpoints before the first
-   *   `client.fairscale` access. Calling after the registry is built has
-   *   no effect — set the API key here or via `FAIRSCALE_API_KEY` env.
-   *
-   * @param config - FairScale config (apiKey, baseUrl, humanBaseUrl, timeoutMs, fetch).
-   * @returns `this` for chaining.
-   * @category Registries
-   * @since v0.11.0
-   *
-   * @example
-   * ```ts
-   * SapClient.from(provider).configureFairScale({ apiKey: process.env.FAIRSCALE_API_KEY });
-   * ```
-   */
-  configureFairScale(config: FairScaleConfig): this {
-    this.#fairscaleConfig = config;
-    return this;
-  }
-
-  /**
-   * @name fairscale
-   * @description FairScale reputation aggregator — wraps both FairScale
-   *   REST APIs (Agent & Credit + Human Score) and exposes
-   *   `aggregate()` to merge SAP on-chain reputation with FairScale into
-   *   a single weighted signal.
-   *
-   * @returns {FairScaleRegistry} The lazily-instantiated `FairScaleRegistry` singleton.
-   * @category Registries
-   * @since v0.11.0
-   * @see {@link FairScaleRegistry}
-   *
-   * @example
-   * ```ts
-   * const merged = await client.fairscale.aggregate(agentWallet, {
-   *   weights: { sap: 0.4, fairscale: 0.6 },
-   * });
-   * if (merged.combined.tier === "elite") accept();
-   * ```
-   */
-  get fairscale(): FairScaleRegistry {
-    return (this.#fairscale ??= new FairScaleRegistry(
-      this.program,
-      this.#fairscaleConfig,
-    ));
-  }
-}