@pulseai/sdk 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -16,7 +16,7 @@ declare const TESTNET_ADDRESSES: PulseAddresses;
 /** Full Pulse contract addresses on MegaETH Mainnet. */
 declare const MAINNET_ADDRESSES: PulseAddresses;
 /** Platform buyer agent ID on MegaETH Mainnet (owned by BuyerRelay). */
-declare const PLATFORM_BUYER_AGENT_ID = 8154n;
+declare const PLATFORM_BUYER_AGENT_ID = 8155n;
 /** Default indexer URLs by network. */
 declare const DEFAULT_INDEXER_URLS: {
     readonly testnet: "https://pulse-indexer.up.railway.app";
@@ -95,6 +95,7 @@ type JobOffering = {
     serviceType: ServiceType;
     priceUSDm: bigint;
     slaMinutes: number;
+    name: string;
     description: string;
     requirementsSchemaURI: string;
     active: boolean;
@@ -138,6 +139,7 @@ type ListOfferingParams = {
     serviceType: ServiceType;
     priceUSDm: bigint;
     slaMinutes: number;
+    name: string;
     description: string;
     requirementsSchemaURI?: string;
 };
@@ -147,7 +149,9 @@ declare function listOffering(client: PulseClient, params: ListOfferingParams):
     txHash: Hash;
 }>;
 /** Update mutable fields of an offering. */
-declare function updateOffering(client: PulseClient, offeringId: bigint, priceUSDm: bigint, slaMinutes: number, description: string): Promise<Hash>;
+declare function updateOffering(client: PulseClient, offeringId: bigint, priceUSDm: bigint, slaMinutes: number, name: string, description: string): Promise<Hash>;
+/** Update the requirements schema URI of an offering. */
+declare function updateOfferingSchema(client: PulseClient, offeringId: bigint, requirementsSchemaURI: string): Promise<Hash>;
 /** Deactivate an offering. */
 declare function deactivateOffering(client: PulseClient, offeringId: bigint): Promise<Hash>;
 /** Activate a previously deactivated offering. */
@@ -163,8 +167,8 @@ type CreateJobParams = {
     warrenTermsHash: Hex;
 };
 /**
- * Create a job: approve USDm + call createJob.
- * Reads the offering price automatically.
+ * Create a job: approve USDm (if needed) + call createJob.
+ * Reads the offering price automatically and skips approve if allowance is sufficient.
  */
 declare function createJob(client: PulseClient, params: CreateJobParams): Promise<{
     jobId: bigint;
@@ -223,15 +227,15 @@ declare function deployJobTerms(client: PulseClient, agentId: bigint, params: Jo
     hash: Hex;
     txHash: Hash;
 }>;
-/** Deploy deliverable to WARREN + submit on-chain + register with indexer. */
-declare function deployDeliverable(client: PulseClient, agentId: bigint, jobId: bigint, params: DeliverableParams, indexerUrl?: string): Promise<{
-    masterAddress: Address;
-    pageAddress: Address;
+/** Submit deliverable hash on-chain and store content in indexer.
+ *  Previously deployed to SSTORE2 (WARREN) but removed to save provider gas costs.
+ *  Integrity is guaranteed by on-chain deliverableHash in JobEngine. */
+declare function deployDeliverable(client: PulseClient, jobId: bigint, params: DeliverableParams, indexerUrl?: string): Promise<{
     hash: Hex;
     txHash: Hash;
 }>;
-/** Read deliverable from WARREN via indexer lookup. */
-declare function readDeliverable(client: PulseClient, jobId: bigint, indexerUrl: string): Promise<DeliverableData>;
+/** Read deliverable from indexer and verify content hash. */
+declare function readDeliverable(jobId: bigint, indexerUrl: string): Promise<DeliverableData>;
 /** Deploy requirements to WARREN + register with indexer (link_type='requirements'). */
 declare function deployRequirements(client: PulseClient, agentId: bigint, jobId: bigint, params: RequirementsParams, indexerUrl?: string): Promise<{
     masterAddress: Address;
@@ -321,6 +325,32 @@ declare function createRequirements(params: RequirementsParams): {
     hash: Hex;
 };
 
+type JsonSchema = {
+    type: 'object';
+    properties: Record<string, {
+        type: 'string' | 'number' | 'boolean' | 'object' | 'array';
+        description?: string;
+        enum?: unknown[];
+        items?: {
+            type: string;
+        };
+    }>;
+    required?: string[];
+};
+/** Pulse offering schema document (JSON Schema-based). */
+type OfferingSchema = {
+    version: number;
+    serviceRequirements: JsonSchema;
+    deliverableRequirements: JsonSchema;
+};
+/** Default schemas by service type (Custom/5 intentionally omitted). */
+declare const DEFAULT_SCHEMAS: Record<number, OfferingSchema>;
+/** Validate runtime data against a compact JSON Schema object definition. */
+declare function validateAgainstSchema(data: Record<string, unknown> | undefined, schema: JsonSchema): {
+    valid: boolean;
+    reason?: string;
+};
+
 type JobContext = {
     jobId: bigint;
     offeringId: bigint;
@@ -336,6 +366,11 @@ type ExecuteJobResult = {
     content?: string;
     url?: string;
     mimeType?: string;
+    usage?: {
+        provider: string;
+        inputTokens: number;
+        outputTokens: number;
+    };
 };
 type ValidationResult = {
     valid: boolean;
@@ -344,6 +379,7 @@ type ValidationResult = {
 interface OfferingHandler {
     offeringId: number;
     autoAccept?: boolean;
+    schema?: OfferingSchema;
     validateRequirements?(context: JobContext): Promise<ValidationResult>;
     executeJob(context: JobContext): Promise<ExecuteJobResult>;
 }
@@ -360,6 +396,7 @@ type SiteModifierConfig = {
 declare class SiteModifierHandler implements OfferingHandler {
     readonly offeringId: number;
     readonly autoAccept?: boolean;
+    readonly schema: OfferingSchema;
     private readonly config;
     constructor(offeringId: number, config: SiteModifierConfig, options?: {
         autoAccept?: boolean;
@@ -370,6 +407,24 @@ declare class SiteModifierHandler implements OfferingHandler {
     private fetchHtmlWithTimeout;
 }
 
+type PromptHandlerConfig = {
+    systemPrompt: string;
+    aiProvider: 'anthropic' | 'google' | 'openai';
+    aiModel?: string;
+    maxTokens?: number;
+    getApiKey: (provider: string) => Promise<string | null>;
+};
+declare class PromptHandler implements OfferingHandler {
+    readonly offeringId: number;
+    readonly autoAccept = true;
+    readonly schema: OfferingSchema;
+    private readonly config;
+    constructor(offeringId: number, config: PromptHandlerConfig);
+    validateRequirements(context: JobContext): Promise<ValidationResult>;
+    executeJob(context: JobContext): Promise<ExecuteJobResult>;
+    private parseRequirements;
+}
+
 /**
  * EIP-712 type definition matching MemoLib.sol MEMO_TYPEHASH:
  * "Memo(uint256 jobId,address signer,bytes32 contentHash,uint64 timestamp,uint256 nonce)"
@@ -423,18 +478,12 @@ declare function parseUsdm(value: string): bigint;
 declare function formatUsdm(amount: bigint): string;
 
 declare const megaethTestnet: {
-    blockExplorers?: {
-        [key: string]: {
-            name: string;
-            url: string;
-            apiUrl?: string | undefined;
-        };
-        default: {
-            name: string;
-            url: string;
-            apiUrl?: string | undefined;
+    blockExplorers: {
+        readonly default: {
+            readonly name: "Blockscout";
+            readonly url: "https://megaeth-testnet-v2.blockscout.com";
         };
-    } | undefined | undefined;
+    };
     blockTime?: number | undefined | undefined;
     contracts?: {
         [x: string]: viem.ChainContract | {
@@ -476,18 +525,12 @@ declare const megaethTestnet: {
     verifyHash?: ((client: viem.Client, parameters: viem.VerifyHashActionParameters) => Promise<viem.VerifyHashActionReturnType>) | undefined;
 };
 declare const megaethMainnet: {
-    blockExplorers?: {
-        [key: string]: {
-            name: string;
-            url: string;
-            apiUrl?: string | undefined;
-        };
-        default: {
-            name: string;
-            url: string;
-            apiUrl?: string | undefined;
+    blockExplorers: {
+        readonly default: {
+            readonly name: "Blockscout";
+            readonly url: "https://megaeth.blockscout.com";
         };
-    } | undefined | undefined;
+    };
     blockTime?: number | undefined | undefined;
     contracts?: {
         [x: string]: viem.ChainContract | {
@@ -542,10 +585,15 @@ type CallAIParams = {
     maxTokens?: number;
     signal?: AbortSignal;
 };
+type AIUsage = {
+    inputTokens: number;
+    outputTokens: number;
+};
 type CallAIResult = {
     content: string;
     truncated: boolean;
     raw: unknown;
+    usage?: AIUsage;
 };
 type AICallOptions = CallAIParams;
 type AICallResult = CallAIResult;
@@ -588,6 +636,7 @@ interface IndexerOffering {
     priceUsdm: string;
     slaMinutes: number | null;
     description: string | null;
+    requirementsSchemaUri?: string;
     active: boolean;
     blockNumber: number | null;
     txHash: string | null;
@@ -720,6 +769,7 @@ declare class HandlerProviderRuntime {
     private running;
     private processedJobs;
     private failedJobs;
+    private schemaCache;
     private readonly maxRetries;
     private onError?;
     constructor(client: PulseClient, agentId: bigint, options: HandlerProviderRuntimeOptions);
@@ -734,6 +784,11 @@ declare class HandlerProviderRuntime {
     private canProcess;
     private markProcessed;
     private markFailed;
+    private validateSchemaRequirements;
+    private resolveOfferingSchemaFromUri;
+    private parseDataUriJson;
+    private isOfferingSchema;
+    private isJsonSchema;
     private getRemainingSlaMs;
 }
 
@@ -965,6 +1020,10 @@ declare const serviceMarketplaceAbi: readonly [{
             readonly name: "slaMinutes";
             readonly type: "uint32";
             readonly internalType: "uint32";
+        }, {
+            readonly name: "name";
+            readonly type: "string";
+            readonly internalType: "string";
         }, {
             readonly name: "description";
             readonly type: "string";
@@ -1019,6 +1078,10 @@ declare const serviceMarketplaceAbi: readonly [{
         readonly name: "slaMinutes";
         readonly type: "uint32";
         readonly internalType: "uint32";
+    }, {
+        readonly name: "name";
+        readonly type: "string";
+        readonly internalType: "string";
     }, {
         readonly name: "description";
         readonly type: "string";
@@ -1059,6 +1122,10 @@ declare const serviceMarketplaceAbi: readonly [{
         readonly name: "slaMinutes";
         readonly type: "uint32";
         readonly internalType: "uint32";
+    }, {
+        readonly name: "name";
+        readonly type: "string";
+        readonly internalType: "string";
     }, {
         readonly name: "description";
         readonly type: "string";
@@ -1066,6 +1133,20 @@ declare const serviceMarketplaceAbi: readonly [{
     }];
     readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "updateOfferingSchema";
+    readonly inputs: readonly [{
+        readonly name: "offeringId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "requirementsSchemaURI";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "event";
     readonly name: "OfferingActivated";
@@ -1111,6 +1192,21 @@ declare const serviceMarketplaceAbi: readonly [{
         readonly internalType: "uint256";
     }];
     readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "OfferingSchemaUpdated";
+    readonly inputs: readonly [{
+        readonly name: "offeringId";
+        readonly type: "uint256";
+        readonly indexed: true;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "requirementsSchemaURI";
+        readonly type: "string";
+        readonly indexed: false;
+        readonly internalType: "string";
+    }];
+    readonly anonymous: false;
 }, {
     readonly type: "event";
     readonly name: "OfferingUpdated";
@@ -1520,6 +1616,16 @@ declare const jobEngineAbi: readonly [{
         readonly internalType: "contract IServiceMarketplace";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setServiceMarketplace";
+    readonly inputs: readonly [{
+        readonly name: "newMarketplace";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
     readonly name: "settle";
@@ -1738,6 +1844,21 @@ declare const jobEngineAbi: readonly [{
         readonly internalType: "address";
     }];
     readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "ServiceMarketplaceUpdated";
+    readonly inputs: readonly [{
+        readonly name: "oldMarketplace";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "newMarketplace";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
 }, {
     readonly type: "event";
     readonly name: "Upgraded";
@@ -3629,4 +3750,4 @@ declare const masterAbi: readonly [{
     readonly anonymous: false;
 }];
 
-export { ACCEPT_TIMEOUT, type AICallOptions, type AICallResult, type AIMessage, type AIProvider, type AgentCardParams, BPS_DENOMINATOR, type BuyerCallbacks, BuyerRuntime, type BuyerRuntimeOptions, type CreateJobParams, type CreatePresetPulseClientOptions, type CreatePulseClientOptions, DEFAULT_INDEXER_URLS, type DeliverableData, type DeliverableParams, EVALUATION_TIMEOUT, type ExecuteJobResult, FEE_BPS, HandlerProviderRuntime, type HandlerProviderRuntimeOptions, type IndexerAgent, IndexerClient, IndexerClientError, type IndexerClientOptions, type IndexerJob, type IndexerJobsFilter, type IndexerOffering, type IndexerOfferingsFilter, type IndexerWarrenLink, type IndexerWarrenLinks, type Job, type JobContext, type JobOffering, JobStatus, type JobTermsParams, type ListOfferingParams, MAINNET_ADDRESSES, MEMO_TYPES, type OfferingHandler, PLATFORM_BUYER_AGENT_ID, PULSE_DOMAIN, type PresetPulseClient, type ProviderCallbacks, ProviderRuntime, type ProviderRuntimeOptions, type PulseAddresses, type PulseAgentData, type PulseClient, RISK_POOL_BPS, type RequirementsData, type RequirementsParams, ServiceType, type SignMemoParams, type SiteModifierConfig, SiteModifierHandler, TESTNET_ADDRESSES, TREASURY_BPS, USDM_MAINNET, type ValidationResult, acceptJob, activateOffering, buyerRelayAbi, callAI, cancelJob, createAgentCard, createDeliverable, createJob, createJobTerms, createMainnetClient, createPulseClient, createRequirements, createTestnetClient, deactivateOffering, deployAgentCard, deployDeliverable, deployJobTerms, deployRequirements, deployWarrenMaster, deployWarrenPage, erc20Abi, erc8004IdentityAbi, erc8004ReputationAbi, evaluate, feeDistributorAbi, formatUsdm, getAgent, getJob, getJobCount, getOffering, getOfferingCount, initAgent, jobEngineAbi, listOffering, mainnetERC8004, masterAbi, megaethMainnet, megaethTestnet, pageAbi, parseUsdm, pulseExtensionAbi, readDeliverable, readRequirements, readWarrenMaster, readWarrenPage, registerAgent, rejectJob, resolveDispute, serviceMarketplaceAbi, setOperator, setWarrenContract, settle, signMemo, submitDeliverable, testnetERC8004, updateOffering, verifyContentHash };
+export { ACCEPT_TIMEOUT, type AICallOptions, type AICallResult, type AIMessage, type AIProvider, type AIUsage, type AgentCardParams, BPS_DENOMINATOR, type BuyerCallbacks, BuyerRuntime, type BuyerRuntimeOptions, type CreateJobParams, type CreatePresetPulseClientOptions, type CreatePulseClientOptions, DEFAULT_INDEXER_URLS, DEFAULT_SCHEMAS, type DeliverableData, type DeliverableParams, EVALUATION_TIMEOUT, type ExecuteJobResult, FEE_BPS, HandlerProviderRuntime, type HandlerProviderRuntimeOptions, type IndexerAgent, IndexerClient, IndexerClientError, type IndexerClientOptions, type IndexerJob, type IndexerJobsFilter, type IndexerOffering, type IndexerOfferingsFilter, type IndexerWarrenLink, type IndexerWarrenLinks, type Job, type JobContext, type JobOffering, JobStatus, type JobTermsParams, type JsonSchema, type ListOfferingParams, MAINNET_ADDRESSES, MEMO_TYPES, type OfferingHandler, type OfferingSchema, PLATFORM_BUYER_AGENT_ID, PULSE_DOMAIN, type PresetPulseClient, PromptHandler, type PromptHandlerConfig, type ProviderCallbacks, ProviderRuntime, type ProviderRuntimeOptions, type PulseAddresses, type PulseAgentData, type PulseClient, RISK_POOL_BPS, type RequirementsData, type RequirementsParams, ServiceType, type SignMemoParams, type SiteModifierConfig, SiteModifierHandler, TESTNET_ADDRESSES, TREASURY_BPS, USDM_MAINNET, type ValidationResult, acceptJob, activateOffering, buyerRelayAbi, callAI, cancelJob, createAgentCard, createDeliverable, createJob, createJobTerms, createMainnetClient, createPulseClient, createRequirements, createTestnetClient, deactivateOffering, deployAgentCard, deployDeliverable, deployJobTerms, deployRequirements, deployWarrenMaster, deployWarrenPage, erc20Abi, erc8004IdentityAbi, erc8004ReputationAbi, evaluate, feeDistributorAbi, formatUsdm, getAgent, getJob, getJobCount, getOffering, getOfferingCount, initAgent, jobEngineAbi, listOffering, mainnetERC8004, masterAbi, megaethMainnet, megaethTestnet, pageAbi, parseUsdm, pulseExtensionAbi, readDeliverable, readRequirements, readWarrenMaster, readWarrenPage, registerAgent, rejectJob, resolveDispute, serviceMarketplaceAbi, setOperator, setWarrenContract, settle, signMemo, submitDeliverable, testnetERC8004, updateOffering, updateOfferingSchema, validateAgainstSchema, verifyContentHash };