@eco-incorp/sauce 0.99.3 → 0.99.5

package/sdk/dist/routes/intent-sugar.d.ts

@@ -0,0 +1,97 @@
+import { type Hex } from "viem";
+import type { CanonicalChain } from "../chains/canonical.js";
+import type { AddressInput, Intent } from "./types.js";
+export declare const childCaptureSentinel: (index: number) => bigint;
+/** What a caller must supply because the SDK cannot correctly guess it, plus what it may override. */
+export interface IntentSugarDefaults {
+    /** Absolute Unix seconds. Required: a deadline is a policy decision, and a wrong one either
+     *  strands the reward or makes the intent unfulfillable. */
+    readonly deadline: bigint;
+    /** Defaults to `route.deadline`. */
+    readonly rewardDeadline?: bigint;
+    /** Who may reclaim the reward after `rewardDeadline`. Defaults to the executing Pot, which is
+     *  correct when the program itself funded the reward and wrong when a user did — supply it
+     *  explicitly in that case. */
+    readonly creator?: AddressInput;
+    /** Defaults to the prover the deployment registry records for this source/destination pair. */
+    readonly prover?: AddressInput;
+    /** Overrides the source-chain Portal the program publishes through. */
+    readonly sourcePortal?: AddressInput;
+    /** Overrides the destination-chain Portal recorded in the child's route. */
+    readonly destinationPortal?: AddressInput;
+    /** Route salt, defaulting to 32 zero bytes. Two structurally identical children collapse into one
+     *  intent without distinct salts. */
+    readonly salt?: Hex;
+    /** Passed to `publishAndFund`. Default `false`. */
+    readonly allowPartial?: boolean;
+    /** Overrides the destination Pot a cook-based child runs on. Derived by default: the solver's
+     *  shared Pot for the recorded Portal's `executor()`, salt zero — see `routes/intent-pot.ts`. It
+     *  must exist before the child is fulfilled. */
+    readonly pot?: AddressInput;
+    /** The interpreter that Pot cooks on. Defaults to the released engine address. */
+    readonly engine?: AddressInput;
+    /** The destination Kitchen's current execution fee, in wei, paid on every cook. Required for a
+     *  cook-based child: it is read from the chain and it changes. */
+    readonly executionFee?: bigint;
+}
+/** Everything the rewrite needs that is not in the source text. */
+export interface IntentSugarContext {
+    /** The chain the ENCLOSING program runs on — the child's source chain. */
+    readonly source: CanonicalChain;
+    /** Chain accessor name (`Base`) -> canonical chain. Only these names open an intent. */
+    readonly chains: ReadonlyMap<string, CanonicalChain>;
+    /**
+     * Compile-time scalars in scope, PER CHAIN: the caller's own defines plus that chain's token
+     * symbols.
+     *
+     * Per chain because a symbol is not an address. `USDC` inside `Arbitrum(() => ...)` is Arbitrum's
+     * USDC, and resolving it against the enclosing program's chain would put a Base address in a
+     * route that executes on Arbitrum — most likely not a token at all, and a transfer to it is
+     * funds gone. The enclosing program's own names resolve against `source`.
+     */
+    readonly definesFor: (chain: CanonicalChain) => ReadonlyMap<string, bigint>;
+    /** Resolves the Portal for a chain, and the prover for a pair. Throws with its own diagnostic. */
+    readonly portalOf: (chain: CanonicalChain) => AddressInput;
+    readonly proverFor: (source: CanonicalChain, destination: CanonicalChain) => AddressInput;
+    readonly defaults: Partial<IntentSugarDefaults>;
+    /**
+     * Compiles a program for `chain`, re-entering the whole route pipeline — token and protocol
+     * rewrites for THAT chain, and this same lowering, which is what makes a nested intent work
+     * without a second implementation. Supplied by `sauce-route.ts`; a callback rather than an import
+     * because this module is one of the passes that pipeline runs.
+     */
+    readonly compileChild: (chain: CanonicalChain, source: string, captures: readonly string[], 
+    /** The destination Portal the child's route records — whose Executor must own the Pot. */
+    destinationPortal: AddressInput) => CompiledChild;
+}
+export interface CompiledChild {
+    /** `cook(engine, bytecode ++ arguments)` calldata, with a sentinel per capture in the argument
+     *  tail. `undefined` captures means the program takes none. */
+    readonly call: {
+        readonly target: Hex;
+        readonly data: Hex;
+        readonly value: bigint;
+    };
+    /** The sentinel each capture occupies, in the order the program declares them. */
+    readonly captureSentinels: readonly bigint[];
+}
+export interface IntentSugarResult {
+    readonly source: string;
+    readonly rewrote: boolean;
+    /** One per lowered `Chain(...).reward(...)` site, in source order. */
+    readonly intents: readonly LoweredIntent[];
+}
+export interface LoweredIntent {
+    /** The child as encoded, with a sentinel wherever a captured value belongs. */
+    readonly intent: Intent;
+    /** Enclosing locals spliced into it, in slot order. */
+    readonly captures: readonly string[];
+    readonly destination: CanonicalChain;
+}
+declare class SugarError extends Error {
+}
+/** Lowers every `Chain(() => { ... }).reward({ ... })` in `source`. Purely textual surgery driven by
+ *  acorn ranges, so everything else survives byte for byte. */
+export declare function rewriteIntentSugar(source: string, context: IntentSugarContext): IntentSugarResult;
+export { SugarError };
+//# sourceMappingURL=intent-sugar.d.ts.map

package/sdk/dist/routes/intent-sugar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intent-sugar.d.ts","sourceRoot":"","sources":["../../src/routes/intent-sugar.ts"],"names":[],"mappings":"AAqCA,OAAO,EAAsB,KAAK,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAQ7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAoBvD,eAAO,MAAM,oBAAoB,GAAI,OAAO,MAAM,KAAG,MACqC,CAAC;AAI3F,sGAAsG;AACtG,MAAM,WAAW,mBAAmB;IAClC;gEAC4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,oCAAoC;IACpC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC;;mCAE+B;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAChC,+FAA+F;IAC/F,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B,uEAAuE;IACvE,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC,4EAA4E;IAC5E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,YAAY,CAAC;IAC1C;yCACqC;IACrC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;IACpB,mDAAmD;IACnD,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC;;oDAEgD;IAChD,QAAQ,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B;sEACkE;IAClE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,mEAAmE;AACnE,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,wFAAwF;IACxF,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACrD;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5E,kGAAkG;IAClG,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,YAAY,CAAC;IAC3D,QAAQ,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,cAAc,KAAK,YAAY,CAAC;IAC1F,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChD;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,CACrB,KAAK,EAAE,cAAc,EACrB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,SAAS,MAAM,EAAE;IAC3B,0FAA0F;IAC1F,iBAAiB,EAAE,YAAY,KAC5B,aAAa,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B;mEAC+D;IAC/D,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACpF,kFAAkF;IAClF,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,sEAAsE;IACtE,QAAQ,CAAC,OAAO,EAAE,SAAS,aAAa,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;CACtC;AAED,cAAM,UAAW,SAAQ,KAAK;CAAG;AAoXjC;+DAC+D;AAC/D,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CAqPjG;AAiCD,OAAO,EAAE,UAAU,EAAE,CAAC"}