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

package/dist/types/types/enums.d.ts

@@ -0,0 +1,353 @@
+/**
+ * @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}
+ */
+/**
+ * @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 declare const TokenType: {
+    readonly Sol: {
+        readonly sol: {};
+    };
+    readonly Usdc: {
+        readonly usdc: {};
+    };
+    readonly Spl: {
+        readonly spl: {};
+    };
+};
+/**
+ * @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];
+/**
+ * @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 declare const PluginType: {
+    readonly Memory: {
+        readonly memory: {};
+    };
+    readonly Validation: {
+        readonly validation: {};
+    };
+    readonly Delegation: {
+        readonly delegation: {};
+    };
+    readonly Analytics: {
+        readonly analytics: {};
+    };
+    readonly Governance: {
+        readonly governance: {};
+    };
+    readonly Custom: {
+        readonly custom: {};
+    };
+};
+/**
+ * @name PluginTypeKind
+ * @description Union of all {@link PluginType} variant shapes.
+ */
+export type PluginTypeKind = (typeof PluginType)[keyof typeof PluginType];
+/**
+ * @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 declare const SettlementMode: {
+    readonly Instant: {
+        readonly instant: {};
+    };
+    readonly Escrow: {
+        readonly escrow: {};
+    };
+    readonly Batched: {
+        readonly batched: {};
+    };
+    readonly X402: {
+        readonly x402: {};
+    };
+};
+/**
+ * @name SettlementModeKind
+ * @description Union of all {@link SettlementMode} variant shapes.
+ */
+export type SettlementModeKind = (typeof SettlementMode)[keyof typeof SettlementMode];
+/**
+ * @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 declare const ToolHttpMethod: {
+    readonly Get: {
+        readonly get: {};
+    };
+    readonly Post: {
+        readonly post: {};
+    };
+    readonly Put: {
+        readonly put: {};
+    };
+    readonly Delete: {
+        readonly delete: {};
+    };
+    readonly Compound: {
+        readonly compound: {};
+    };
+};
+/**
+ * @name ToolHttpMethodKind
+ * @description Union of all {@link ToolHttpMethod} variant shapes.
+ */
+export type ToolHttpMethodKind = (typeof ToolHttpMethod)[keyof typeof ToolHttpMethod];
+/**
+ * @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 declare const ToolCategory: {
+    readonly Swap: {
+        readonly swap: {};
+    };
+    readonly Lend: {
+        readonly lend: {};
+    };
+    readonly Stake: {
+        readonly stake: {};
+    };
+    readonly Nft: {
+        readonly nft: {};
+    };
+    readonly Payment: {
+        readonly payment: {};
+    };
+    readonly Data: {
+        readonly data: {};
+    };
+    readonly Governance: {
+        readonly governance: {};
+    };
+    readonly Bridge: {
+        readonly bridge: {};
+    };
+    readonly Analytics: {
+        readonly analytics: {};
+    };
+    readonly Custom: {
+        readonly custom: {};
+    };
+};
+/**
+ * @name ToolCategoryKind
+ * @description Union of all {@link ToolCategory} variant shapes.
+ */
+export type ToolCategoryKind = (typeof ToolCategory)[keyof typeof ToolCategory];
+/**
+ * @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 declare const SettlementSecurity: {
+    /** @deprecated Removed in v0.7 — returns SelfReportDeprecated error */
+    readonly SelfReport: {
+        readonly selfReport: {};
+    };
+    readonly CoSigned: {
+        readonly coSigned: {};
+    };
+    readonly DisputeWindow: {
+        readonly disputeWindow: {};
+    };
+};
+export type SettlementSecurityKind = (typeof SettlementSecurity)[keyof typeof SettlementSecurity];
+/**
+ * @name DisputeOutcome
+ * @description Anchor-compatible enum variants for dispute resolution outcomes.
+ *
+ * @category Types
+ * @since v0.5.0
+ */
+export declare const DisputeOutcome: {
+    readonly Pending: {
+        readonly pending: {};
+    };
+    readonly AutoReleased: {
+        readonly autoReleased: {};
+    };
+    readonly DepositorWins: {
+        readonly depositorWins: {};
+    };
+    readonly AgentWins: {
+        readonly agentWins: {};
+    };
+    /** @since v0.7.0 — Proportional refund based on proven vs claimed calls */
+    readonly PartialRefund: {
+        readonly partialRefund: {};
+    };
+    /** @since v0.7.0 — 50/50 split for irresolvable quality disputes */
+    readonly Split: {
+        readonly split: {};
+    };
+};
+export type DisputeOutcomeKind = (typeof DisputeOutcome)[keyof typeof DisputeOutcome];
+/**
+ * @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 declare const DisputeType: {
+    readonly NonDelivery: 0;
+    readonly PartialDelivery: 1;
+    readonly Overcharge: 2;
+    readonly Quality: 3;
+};
+export type DisputeTypeValue = (typeof DisputeType)[keyof typeof DisputeType];
+/**
+ * @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 declare const ResolutionLayer: {
+    readonly Pending: {
+        readonly pending: {};
+    };
+    readonly Auto: {
+        readonly auto: {};
+    };
+    readonly Governance: {
+        readonly governance: {};
+    };
+};
+export type ResolutionLayerKind = (typeof ResolutionLayer)[keyof typeof ResolutionLayer];
+/**
+ * @name BillingInterval
+ * @description Anchor-compatible enum variants for subscription billing intervals.
+ *
+ * @category Types
+ * @since v0.5.0
+ */
+export declare const BillingInterval: {
+    readonly Daily: {
+        readonly daily: {};
+    };
+    readonly Weekly: {
+        readonly weekly: {};
+    };
+    readonly Monthly: {
+        readonly monthly: {};
+    };
+};
+export type BillingIntervalKind = (typeof BillingInterval)[keyof typeof BillingInterval];
+//# sourceMappingURL=enums.d.ts.map

package/dist/types/types/enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/types/enums.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAMH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;CAIZ,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAMvE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;CAOb,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAM1E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;CAKjB,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAMvD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;CAMjB,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAMvD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWf,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAMnD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB;IAC7B,uEAAuE;;;;;;;;;;CAI/D,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAChC,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAM/D;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;IAKzB,2EAA2E;;;;IAE3E,oEAAoE;;;;CAE5D,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAMvD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW;;;;;CAKd,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAM9E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;CAIlB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAMzD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;CAIlB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC"}

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

@@ -0,0 +1,29 @@
+/**
+ * @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";
+ * ```
+ */
+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";
+export type { Capability, VolumeCurveBreakpoint, PricingTier, PluginRef, Settlement, } from "./common";
+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, AgentPricingMenuData, SettlementReceiptData, } from "./accounts";
+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";
+export type { EndpointDescriptor, HealthCheckDescriptor, ToolManifestEntry, AgentManifest, EndpointValidationResult, } from "./endpoint";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,OAAO,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,WAAW,EACX,eAAe,GAChB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,SAAS,CAAC;AAGjB,YAAY,EACV,UAAU,EACV,qBAAqB,EACrB,WAAW,EACX,SAAS,EACT,UAAU,GACX,MAAM,UAAU,CAAC;AAGlB,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AAGpB,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAGxB,YAAY,EACV,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,GACzB,MAAM,YAAY,CAAC"}