@pushchain/core 6.0.27-alpha.3 → 6.0.27-alpha.5

package/src/lib/job-spec/schema.d.ts

@@ -0,0 +1,290 @@
+export declare const READ_FIELDS: readonly [{
+    readonly name: "chainNamespace";
+    readonly type: "string";
+}, {
+    readonly name: "chainId";
+    readonly type: "string";
+}, {
+    readonly name: "minConfirmations";
+    readonly type: "uint16";
+}, {
+    readonly name: "target";
+    readonly type: "address";
+}, {
+    readonly name: "selector";
+    readonly type: "bytes4";
+}, {
+    readonly name: "args";
+    readonly type: "bytes";
+}, {
+    readonly name: "outputs";
+    readonly type: "bytes";
+}, {
+    readonly name: "field";
+    readonly type: "uint8[]";
+}];
+export declare const FILL_FIELDS: readonly [{
+    readonly name: "word";
+    readonly type: "uint8";
+}, {
+    readonly name: "source";
+    readonly type: "uint8";
+}, {
+    readonly name: "param";
+    readonly type: "uint8";
+}];
+export declare const TEMPLATE_READ_FIELDS: readonly ({
+    readonly name: "chainNamespace";
+    readonly type: "string";
+} | {
+    readonly name: "chainId";
+    readonly type: "string";
+} | {
+    readonly name: "minConfirmations";
+    readonly type: "uint16";
+} | {
+    readonly name: "target";
+    readonly type: "address";
+} | {
+    readonly name: "selector";
+    readonly type: "bytes4";
+} | {
+    readonly name: "args";
+    readonly type: "bytes";
+} | {
+    readonly name: "outputs";
+    readonly type: "bytes";
+} | {
+    readonly name: "field";
+    readonly type: "uint8[]";
+} | {
+    readonly name: "fills";
+    readonly type: "tuple[]";
+    readonly components: readonly [{
+        readonly name: "word";
+        readonly type: "uint8";
+    }, {
+        readonly name: "source";
+        readonly type: "uint8";
+    }, {
+        readonly name: "param";
+        readonly type: "uint8";
+    }];
+})[];
+export declare const CHECK_FIELDS: readonly [{
+    readonly name: "read";
+    readonly type: "uint8";
+}, {
+    readonly name: "evaluation";
+    readonly type: "uint8";
+}, {
+    readonly name: "operation";
+    readonly type: "uint8";
+}, {
+    readonly name: "target";
+    readonly type: "int256";
+}];
+export declare const TEMPLATE_CHECK_FIELDS: readonly [...({
+    readonly name: "read";
+    readonly type: "uint8";
+} | {
+    readonly name: "evaluation";
+    readonly type: "uint8";
+} | {
+    readonly name: "operation";
+    readonly type: "uint8";
+} | {
+    readonly name: "target";
+    readonly type: "int256";
+})[], {
+    readonly name: "source";
+    readonly type: "uint8";
+}, {
+    readonly name: "value";
+    readonly type: "int256";
+}];
+export declare const LOGIC_FIELDS: readonly [{
+    readonly name: "kind";
+    readonly type: "uint8";
+}, {
+    readonly name: "checks";
+    readonly type: "uint8[]";
+}, {
+    readonly name: "children";
+    readonly type: "uint8[]";
+}, {
+    readonly name: "k";
+    readonly type: "uint8";
+}];
+export declare const JOB_SPEC_PARAM: {
+    readonly type: "tuple";
+    readonly components: readonly [{
+        readonly name: "reads";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "chainNamespace";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "string";
+        }, {
+            readonly name: "minConfirmations";
+            readonly type: "uint16";
+        }, {
+            readonly name: "target";
+            readonly type: "address";
+        }, {
+            readonly name: "selector";
+            readonly type: "bytes4";
+        }, {
+            readonly name: "args";
+            readonly type: "bytes";
+        }, {
+            readonly name: "outputs";
+            readonly type: "bytes";
+        }, {
+            readonly name: "field";
+            readonly type: "uint8[]";
+        }];
+    }, {
+        readonly name: "checks";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "read";
+            readonly type: "uint8";
+        }, {
+            readonly name: "evaluation";
+            readonly type: "uint8";
+        }, {
+            readonly name: "operation";
+            readonly type: "uint8";
+        }, {
+            readonly name: "target";
+            readonly type: "int256";
+        }];
+    }, {
+        readonly name: "logic";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "kind";
+            readonly type: "uint8";
+        }, {
+            readonly name: "checks";
+            readonly type: "uint8[]";
+        }, {
+            readonly name: "children";
+            readonly type: "uint8[]";
+        }, {
+            readonly name: "k";
+            readonly type: "uint8";
+        }];
+    }, {
+        readonly name: "allowedMutability";
+        readonly type: "uint8";
+    }, {
+        readonly name: "origin";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "executeBy";
+        readonly type: "uint64";
+    }, {
+        readonly name: "failFinalAt";
+        readonly type: "uint64";
+    }];
+};
+export declare const JOB_TEMPLATE_PARAM: {
+    readonly type: "tuple";
+    readonly components: readonly [{
+        readonly name: "reads";
+        readonly type: "tuple[]";
+        readonly components: readonly ({
+            readonly name: "chainNamespace";
+            readonly type: "string";
+        } | {
+            readonly name: "chainId";
+            readonly type: "string";
+        } | {
+            readonly name: "minConfirmations";
+            readonly type: "uint16";
+        } | {
+            readonly name: "target";
+            readonly type: "address";
+        } | {
+            readonly name: "selector";
+            readonly type: "bytes4";
+        } | {
+            readonly name: "args";
+            readonly type: "bytes";
+        } | {
+            readonly name: "outputs";
+            readonly type: "bytes";
+        } | {
+            readonly name: "field";
+            readonly type: "uint8[]";
+        } | {
+            readonly name: "fills";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "word";
+                readonly type: "uint8";
+            }, {
+                readonly name: "source";
+                readonly type: "uint8";
+            }, {
+                readonly name: "param";
+                readonly type: "uint8";
+            }];
+        })[];
+    }, {
+        readonly name: "checks";
+        readonly type: "tuple[]";
+        readonly components: readonly [...({
+            readonly name: "read";
+            readonly type: "uint8";
+        } | {
+            readonly name: "evaluation";
+            readonly type: "uint8";
+        } | {
+            readonly name: "operation";
+            readonly type: "uint8";
+        } | {
+            readonly name: "target";
+            readonly type: "int256";
+        })[], {
+            readonly name: "source";
+            readonly type: "uint8";
+        }, {
+            readonly name: "value";
+            readonly type: "int256";
+        }];
+    }, {
+        readonly name: "logic";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "kind";
+            readonly type: "uint8";
+        }, {
+            readonly name: "checks";
+            readonly type: "uint8[]";
+        }, {
+            readonly name: "children";
+            readonly type: "uint8[]";
+        }, {
+            readonly name: "k";
+            readonly type: "uint8";
+        }];
+    }, {
+        readonly name: "allowedMutability";
+        readonly type: "uint8";
+    }, {
+        readonly name: "params";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "min";
+            readonly type: "int256";
+        }, {
+            readonly name: "max";
+            readonly type: "int256";
+        }];
+    }];
+};

package/src/lib/job-spec/schema.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JOB_TEMPLATE_PARAM = exports.JOB_SPEC_PARAM = exports.LOGIC_FIELDS = exports.TEMPLATE_CHECK_FIELDS = exports.CHECK_FIELDS = exports.TEMPLATE_READ_FIELDS = exports.FILL_FIELDS = exports.READ_FIELDS = void 0;
+exports.READ_FIELDS = [
+    { name: 'chainNamespace', type: 'string' },
+    { name: 'chainId', type: 'string' },
+    { name: 'minConfirmations', type: 'uint16' },
+    { name: 'target', type: 'address' },
+    { name: 'selector', type: 'bytes4' },
+    { name: 'args', type: 'bytes' },
+    { name: 'outputs', type: 'bytes' },
+    { name: 'field', type: 'uint8[]' },
+];
+exports.FILL_FIELDS = [
+    { name: 'word', type: 'uint8' },
+    { name: 'source', type: 'uint8' },
+    { name: 'param', type: 'uint8' },
+];
+exports.TEMPLATE_READ_FIELDS = [
+    ...exports.READ_FIELDS.slice(0, 6),
+    { name: 'fills', type: 'tuple[]', components: exports.FILL_FIELDS },
+    ...exports.READ_FIELDS.slice(6),
+];
+exports.CHECK_FIELDS = [
+    { name: 'read', type: 'uint8' },
+    { name: 'evaluation', type: 'uint8' },
+    { name: 'operation', type: 'uint8' },
+    { name: 'target', type: 'int256' },
+];
+exports.TEMPLATE_CHECK_FIELDS = [
+    ...exports.CHECK_FIELDS.slice(0, 3),
+    { name: 'source', type: 'uint8' },
+    { name: 'value', type: 'int256' },
+];
+exports.LOGIC_FIELDS = [
+    { name: 'kind', type: 'uint8' },
+    { name: 'checks', type: 'uint8[]' },
+    { name: 'children', type: 'uint8[]' },
+    { name: 'k', type: 'uint8' },
+];
+exports.JOB_SPEC_PARAM = {
+    type: 'tuple',
+    components: [
+        { name: 'reads', type: 'tuple[]', components: exports.READ_FIELDS },
+        { name: 'checks', type: 'tuple[]', components: exports.CHECK_FIELDS },
+        { name: 'logic', type: 'tuple[]', components: exports.LOGIC_FIELDS },
+        { name: 'allowedMutability', type: 'uint8' },
+        { name: 'origin', type: 'bytes32' },
+        { name: 'executeBy', type: 'uint64' },
+        { name: 'failFinalAt', type: 'uint64' },
+    ],
+};
+exports.JOB_TEMPLATE_PARAM = {
+    type: 'tuple',
+    components: [
+        { name: 'reads', type: 'tuple[]', components: exports.TEMPLATE_READ_FIELDS },
+        { name: 'checks', type: 'tuple[]', components: exports.TEMPLATE_CHECK_FIELDS },
+        { name: 'logic', type: 'tuple[]', components: exports.LOGIC_FIELDS },
+        { name: 'allowedMutability', type: 'uint8' },
+        {
+            name: 'params',
+            type: 'tuple[]',
+            components: [
+                { name: 'min', type: 'int256' },
+                { name: 'max', type: 'int256' },
+            ],
+        },
+    ],
+};
+//# sourceMappingURL=schema.js.map

package/src/lib/job-spec/types.d.ts

@@ -0,0 +1,139 @@
+import type { Abi, Address, Hex } from 'viem';
+import type { ArgumentPath, WalletMarker } from '../agentic/agentic.types';
+import type { JOB_VOCABULARY, PRINCIPAL } from './constants';
+import type { PushChain } from '../push-chain/push-chain';
+import type { ReadCallback, UniversalReadResponse } from '../read-state/read-state.types';
+import type { ReadExecuteOptions } from '../read-state/read-params';
+import type { ReadOptions } from '../read-state/read-params';
+export type Evaluation = (typeof JOB_VOCABULARY.EVALUATION)[keyof typeof JOB_VOCABULARY.EVALUATION];
+export type Operation = (typeof JOB_VOCABULARY.OPERATION)[keyof typeof JOB_VOCABULARY.OPERATION];
+export type LogicKind = (typeof JOB_VOCABULARY.LOGIC)[keyof typeof JOB_VOCABULARY.LOGIC];
+export type AllowedMutability = (typeof JOB_VOCABULARY.ALLOWED_MUTABILITY)[keyof typeof JOB_VOCABULARY.ALLOWED_MUTABILITY];
+export type PrincipalMarker = typeof PRINCIPAL;
+export interface JobFill {
+    word: number;
+    source: 'WALLET' | 'PARAM';
+    param?: number;
+}
+export interface PreparedJobRead {
+    chainNamespace: string;
+    chainId: string;
+    target: Address;
+    selector: Hex;
+    args: Hex;
+    outputs: Hex;
+    /** Placeholder positions are explicit; zero argument values are never treated as holes. */
+    fills?: JobFill[];
+}
+export interface JobRead extends PreparedJobRead {
+    minConfirmations: number;
+    field: number[];
+}
+export interface PrepareJobReadOptions {
+    chain: string;
+    target: Address;
+    abi: Abi;
+    functionName: string;
+    args?: readonly unknown[];
+}
+export type ExecuteJobReadOptions = Pick<ReadOptions, 'callback' | 'minConfirmations' | 'blockNumber' | 'expiryBlocks' | 'maxFee' | 'refundTo' | 'waitForCompletion' | 'progressHook' | 'advanced'>;
+export interface JobReadInput {
+    read: PreparedJobRead;
+    minConfirmations?: number;
+    field?: number[];
+}
+export interface JobCheck {
+    read: number;
+    evaluation: Evaluation;
+    operation: Operation;
+    target: bigint;
+}
+export interface JobCheckTemplate extends Omit<JobCheck, 'target'> {
+    target: bigint | PrincipalMarker | WalletMarker | {
+        principalBps: bigint;
+    } | {
+        param: number;
+    };
+}
+export interface LogicTree {
+    kind: LogicKind;
+    of: (number | LogicTree)[];
+    k?: number;
+}
+export interface JobSpec {
+    reads: JobRead[];
+    checks: JobCheck[];
+    logic: LogicTree;
+    allowedMutability: AllowedMutability;
+    origin: Hex;
+    executeBy: number;
+    failFinalAt: number;
+}
+export interface JobSpecTemplate {
+    reads: JobRead[];
+    checks: JobCheckTemplate[];
+    logic: LogicTree;
+    allowedMutability: AllowedMutability;
+    params: {
+        min: bigint;
+        max: bigint;
+    }[];
+}
+export interface BuildJobSpecOptions {
+    reads: (PreparedJobRead | JobReadInput)[];
+    checks: JobCheck[];
+    logic: 'ALL' | 'ANY' | LogicTree;
+    allowedMutability?: AllowedMutability;
+    executeBy: number;
+    failFinalAt: number;
+    expiredAt?: number;
+    origin?: Hex;
+}
+export interface BuildJobSpecTemplateOptions extends Omit<BuildJobSpecOptions, 'checks' | 'executeBy' | 'failFinalAt' | 'expiredAt' | 'origin'> {
+    checks: JobCheckTemplate[];
+    params?: {
+        min: bigint;
+        max: bigint;
+    }[];
+}
+export interface PreviewJobSpecOptions {
+    client: Pick<PushChain, 'universal'>;
+    wallet?: Address;
+    principal?: bigint;
+    params?: bigint[];
+    /** Explicit destination accounts override CEA derivation from wallet on a real SDK client. */
+    accounts?: Record<string, Address>;
+    /** Optional baseline per read for NUMBER/PERCENTAGE. Missing baselines remain unknown. */
+    baseline?: readonly (bigint | null)[];
+    /** Existing universal-read registry is used by default. */
+    callback?: ReadCallback;
+    /** Maximum sum of prepared read request values, checked before any payment. */
+    maxTotalFee?: bigint;
+    expiryBlocks?: bigint;
+    refundTo?: Address;
+    progressHook?: ReadExecuteOptions['progressHook'];
+    advanced?: ReadExecuteOptions['advanced'];
+    /** One existing request ID per read, in read order. Validated against the resolved call; no new fees. */
+    resume?: readonly Hex[];
+}
+export interface JobSpecPreview {
+    /** A preview is a paid observation, never an evaluator verdict. */
+    reads: {
+        value: Hex | null;
+        decoded: bigint | null;
+        error?: string;
+        response: UniversalReadResponse;
+    }[];
+    checks: {
+        pass: boolean | null;
+        value: bigint | null;
+        reason?: string;
+    }[];
+    pass: boolean | null;
+    fees: {
+        quoted: bigint;
+        paid: bigint;
+        newlyPaid: bigint;
+    };
+}
+export type JobArgumentPath = ArgumentPath;

package/src/lib/job-spec/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map