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

package/src/types/enums.ts

@@ -1,333 +0,0 @@
-/**
- * @module types/enums
- * @description Anchor-compatible enum variant objects for SAP v2.
- *
- * Each enum mirrors the Rust discriminant format used by Anchor:
- * `{ variant: {} }` — e.g. `{ sol: {} }` for `TokenType::Sol`.
- *
- * Use the `*Kind` types for function signatures.
- *
- * @category Types
- * @since v0.1.0
- * @see {@link https://solana.com/docs | Solana Docs}
- */
-
-// ═══════════════════════════════════════════════════════════════════
-//  Token Type
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name TokenType
- * @description Anchor-compatible enum variants for token types accepted by agent pricing and escrow.
- *
- * - `Sol` — Native SOL.
- * - `Usdc` — USDC stablecoin.
- * - `Spl` — Arbitrary SPL token (requires `tokenMint`).
- *
- * @category Types
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import { TokenType } from "@synapse-sap/sdk";
- *
- * const tier = { tokenType: TokenType.Sol };
- * ```
- */
-export const TokenType = {
-  Sol: { sol: {} },
-  Usdc: { usdc: {} },
-  Spl: { spl: {} },
-} as const;
-
-/**
- * @name TokenTypeKind
- * @description Union of all {@link TokenType} variant shapes.
- *   Use this as the type for any parameter that accepts a token type discriminant.
- */
-export type TokenTypeKind = (typeof TokenType)[keyof typeof TokenType];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Plugin Type
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name PluginType
- * @description Anchor-compatible enum variants for plugin extension types.
- *
- * Plugins extend agent functionality and are feature-gated on-chain.
- *
- * - `Memory` — Encrypted memory / vault storage.
- * - `Validation` — Custom validation logic.
- * - `Delegation` — Hot-wallet delegation.
- * - `Analytics` — Metrics & analytics.
- * - `Governance` — DAO / governance participation.
- * - `Custom` — User-defined plugin type.
- *
- * @category Types
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import { PluginType } from "@synapse-sap/sdk";
- *
- * const ref = { pluginType: PluginType.Memory, pda: vaultPda };
- * ```
- */
-export const PluginType = {
-  Memory: { memory: {} },
-  Validation: { validation: {} },
-  Delegation: { delegation: {} },
-  Analytics: { analytics: {} },
-  Governance: { governance: {} },
-  Custom: { custom: {} },
-} as const;
-
-/**
- * @name PluginTypeKind
- * @description Union of all {@link PluginType} variant shapes.
- */
-export type PluginTypeKind = (typeof PluginType)[keyof typeof PluginType];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Settlement Mode
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name SettlementMode
- * @description Anchor-compatible enum variants for payment settlement strategies.
- *
- * - `Instant` — Pay-per-call, settled immediately on invocation.
- * - `Escrow` — Pre-funded escrow account with per-call drawdown.
- * - `Batched` — Aggregated settlement at fixed intervals.
- * - `X402` — HTTP 402-based micropayment protocol settlement.
- *
- * @category Types
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import { SettlementMode } from "@synapse-sap/sdk";
- *
- * const tier = { settlementMode: SettlementMode.Escrow };
- * ```
- */
-export const SettlementMode = {
-  Instant: { instant: {} },
-  Escrow: { escrow: {} },
-  Batched: { batched: {} },
-  X402: { x402: {} },
-} as const;
-
-/**
- * @name SettlementModeKind
- * @description Union of all {@link SettlementMode} variant shapes.
- */
-export type SettlementModeKind =
-  (typeof SettlementMode)[keyof typeof SettlementMode];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Tool HTTP Method
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name ToolHttpMethod
- * @description Anchor-compatible enum variants for the HTTP method exposed by a tool.
- *
- * - `Get` / `Post` / `Put` / `Delete` — Standard REST verbs.
- * - `Compound` — Multi-step tool (calls several sub-operations).
- *
- * @category Types
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import { ToolHttpMethod } from "@synapse-sap/sdk";
- *
- * const args = { httpMethod: ToolHttpMethod.Post };
- * ```
- */
-export const ToolHttpMethod = {
-  Get: { get: {} },
-  Post: { post: {} },
-  Put: { put: {} },
-  Delete: { delete: {} },
-  Compound: { compound: {} },
-} as const;
-
-/**
- * @name ToolHttpMethodKind
- * @description Union of all {@link ToolHttpMethod} variant shapes.
- */
-export type ToolHttpMethodKind =
-  (typeof ToolHttpMethod)[keyof typeof ToolHttpMethod];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Tool Category
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name ToolCategory
- * @description Anchor-compatible enum variants for classifying tools in the on-chain registry.
- *
- * Categories power cross-agent tool discovery via the `ToolCategoryIndex` PDA.
- *
- * - `Swap` — Token swap / DEX tools.
- * - `Lend` — Lending protocol tools.
- * - `Stake` — Staking / validator tools.
- * - `Nft` — NFT minting / marketplace tools.
- * - `Payment` — Payment & invoicing tools.
- * - `Data` — Data feeds / oracles.
- * - `Governance` — DAO & governance tools.
- * - `Bridge` — Cross-chain bridge tools.
- * - `Analytics` — On-chain analytics.
- * - `Custom` — User-defined category.
- *
- * @category Types
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import { ToolCategory } from "@synapse-sap/sdk";
- *
- * const args = { category: ToolCategory.Swap };
- * ```
- */
-export const ToolCategory = {
-  Swap: { swap: {} },
-  Lend: { lend: {} },
-  Stake: { stake: {} },
-  Nft: { nft: {} },
-  Payment: { payment: {} },
-  Data: { data: {} },
-  Governance: { governance: {} },
-  Bridge: { bridge: {} },
-  Analytics: { analytics: {} },
-  Custom: { custom: {} },
-} as const;
-
-/**
- * @name ToolCategoryKind
- * @description Union of all {@link ToolCategory} variant shapes.
- */
-export type ToolCategoryKind =
-  (typeof ToolCategory)[keyof typeof ToolCategory];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Settlement Security (V2.1)
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name SettlementSecurity
- * @description Anchor-compatible enum variants for V2 escrow settlement security levels.
- *
- * - `SelfReport` — **DEPRECATED in v0.7** — Agent settles unilaterally (abuse vector).
- * - `CoSigned` — Agent + client must co-sign every settlement.
- * - `DisputeWindow` — Settlement enters pending state, depositor can dispute.
- *
- * @category Types
- * @since v0.5.0
- */
-export const SettlementSecurity = {
-  /** @deprecated Removed in v0.7 — returns SelfReportDeprecated error */
-  SelfReport: { selfReport: {} },
-  CoSigned: { coSigned: {} },
-  DisputeWindow: { disputeWindow: {} },
-} as const;
-
-export type SettlementSecurityKind =
-  (typeof SettlementSecurity)[keyof typeof SettlementSecurity];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Dispute Outcome (V2.1)
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name DisputeOutcome
- * @description Anchor-compatible enum variants for dispute resolution outcomes.
- *
- * @category Types
- * @since v0.5.0
- */
-export const DisputeOutcome = {
-  Pending: { pending: {} },
-  AutoReleased: { autoReleased: {} },
-  DepositorWins: { depositorWins: {} },
-  AgentWins: { agentWins: {} },
-  /** @since v0.7.0 — Proportional refund based on proven vs claimed calls */
-  PartialRefund: { partialRefund: {} },
-  /** @since v0.7.0 — 50/50 split for irresolvable quality disputes */
-  Split: { split: {} },
-} as const;
-
-export type DisputeOutcomeKind =
-  (typeof DisputeOutcome)[keyof typeof DisputeOutcome];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Dispute Type (v0.7)
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name DisputeType
- * @description Categories of disputes that can be filed against a pending settlement.
- *
- * - `NonDelivery` — Agent took payment but delivered nothing.
- * - `PartialDelivery` — Agent delivered fewer calls than claimed.
- * - `Overcharge` — Agent charged more than the agreed price.
- * - `Quality` — Agent delivered but output quality is disputed.
- *
- * @category Types
- * @since v0.7.0
- */
-export const DisputeType = {
-  NonDelivery: 0,
-  PartialDelivery: 1,
-  Overcharge: 2,
-  Quality: 3,
-} as const;
-
-export type DisputeTypeValue = (typeof DisputeType)[keyof typeof DisputeType];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Resolution Layer (v0.7)
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name ResolutionLayer
- * @description How a dispute was resolved.
- *
- * - `Pending` — Not yet resolved.
- * - `Auto` — Resolved automatically via receipt merkle proofs.
- * - `Governance` — Resolved via protocol governance (quality disputes).
- *
- * @category Types
- * @since v0.7.0
- */
-export const ResolutionLayer = {
-  Pending: { pending: {} },
-  Auto: { auto: {} },
-  Governance: { governance: {} },
-} as const;
-
-export type ResolutionLayerKind =
-  (typeof ResolutionLayer)[keyof typeof ResolutionLayer];
-
-// ═══════════════════════════════════════════════════════════════════
-//  Billing Interval (V2.1)
-// ═══════════════════════════════════════════════════════════════════
-
-/**
- * @name BillingInterval
- * @description Anchor-compatible enum variants for subscription billing intervals.
- *
- * @category Types
- * @since v0.5.0
- */
-export const BillingInterval = {
-  Daily: { daily: {} },
-  Weekly: { weekly: {} },
-  Monthly: { monthly: {} },
-} as const;
-
-export type BillingIntervalKind =
-  (typeof BillingInterval)[keyof typeof BillingInterval];

package/src/types/index.ts

@@ -1,121 +0,0 @@
-/**
- * @module types
- * @description Strongly-typed domain models for SAP v2.
- *
- * Every type mirrors the onchain Rust struct / enum exactly.
- * Types are organized into four layers:
- *
- * - **enums** — Anchor-style enum variant objects (`TokenType`, `ToolCategory`, …)
- * - **common** — Shared helper structs (`Capability`, `PricingTier`, `Settlement`, …)
- * - **accounts** — Deserialized on-chain PDA account data (`AgentAccountData`, …)
- * - **instructions** — Instruction argument DTOs + permission/schema helpers
- *
- * @category Types
- * @since v0.1.0
- *
- * @example
- * ```ts
- * import type { AgentAccountData, RegisterAgentArgs } from "@synapse-sap/sdk/types";
- * import { TokenType, SettlementMode } from "@synapse-sap/sdk/types";
- * ```
- */
-
-// ── Enums ────────────────────────────────────────────
-export {
-  TokenType,
-  PluginType,
-  SettlementMode,
-  ToolHttpMethod,
-  ToolCategory,
-  SettlementSecurity,
-  DisputeOutcome,
-  BillingInterval,
-  DisputeType,
-  ResolutionLayer,
-} from "./enums";
-
-export type {
-  TokenTypeKind,
-  PluginTypeKind,
-  SettlementModeKind,
-  ToolHttpMethodKind,
-  ToolCategoryKind,
-  SettlementSecurityKind,
-  DisputeOutcomeKind,
-  BillingIntervalKind,
-  DisputeTypeValue,
-  ResolutionLayerKind,
-} from "./enums";
-
-// ── Common Structs ───────────────────────────────────
-export type {
-  Capability,
-  VolumeCurveBreakpoint,
-  PricingTier,
-  PluginRef,
-  Settlement,
-} from "./common";
-
-// ── Account Data ─────────────────────────────────────
-export type {
-  AgentAccountData,
-  AgentStatsData,
-  FeedbackAccountData,
-  CapabilityIndexData,
-  ProtocolIndexData,
-  ToolCategoryIndexData,
-  GlobalRegistryData,
-  MemoryVaultData,
-  SessionLedgerData,
-  EpochPageData,
-  VaultDelegateData,
-  SessionCheckpointData,
-  ToolDescriptorData,
-  EscrowAccountData,
-  AgentAttestationData,
-  MemoryLedgerData,
-  LedgerPageData,
-  EscrowAccountV2Data,
-  PendingSettlementData,
-  DisputeRecordData,
-  ReceiptBatchData,
-  AgentStakeData,
-  SubscriptionData,
-  CounterShardData,
-  IndexPageData,
-} from "./accounts";
-
-// ── Instruction Args ─────────────────────────────────
-export type {
-  RegisterAgentArgs,
-  UpdateAgentArgs,
-  GiveFeedbackArgs,
-  UpdateFeedbackArgs,
-  PublishToolArgs,
-  UpdateToolArgs,
-  InscribeToolSchemaArgs,
-  InscribeMemoryArgs,
-  CompactInscribeArgs,
-  CreateEscrowArgs,
-  CreateAttestationArgs,
-  DelegatePermissionBit,
-  SchemaTypeValue,
-  CompressionTypeValue,
-  CreateEscrowV2Args,
-  CreateSubscriptionArgs,
-} from "./instructions";
-
-export {
-  DelegatePermission,
-  SchemaType,
-  CompressionType,
-} from "./instructions";
-
-// ── Endpoint & Manifest Types ────────────────────────
-export type {
-  EndpointDescriptor,
-  HealthCheckDescriptor,
-  ToolManifestEntry,
-  AgentManifest,
-  EndpointValidationResult,
-} from "./endpoint";