jalin-sdk 0.1.0

package/dist/index.js

@@ -0,0 +1,12 @@
+export * from "./plan.js";
+export * from "./subaccounts.js";
+export * from "./shadow.js";
+export * from "./recipes.js";
+export * from "./disclosure.js";
+export * from "./wallet.js";
+export * from "./crowd.js";
+export * from "./anonymity.js";
+export * from "./rpc-response.js";
+export * from "./share.js";
+export * from "./receipt.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAE3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA"}

package/dist/plan.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Plan encoding for the Jalin router.
+ *
+ * A plan is what the router takes instead of fixed parameters, so encoding it
+ * correctly is the whole integration surface. The layout below is Cairo's
+ * positional Serde for:
+ *
+ *   privacy_invoke(
+ *     pool_address: ContractAddress,
+ *     steps: Array<Step>,
+ *     outputs: Array<Output>,
+ *   ) -> Span<OpenNoteDeposit>
+ *
+ * An `Array<T>` serialises as its length followed by its elements, and a `u128`
+ * occupies a single felt. Nothing here is nested any deeper than that.
+ */
+/** A felt, or a wallet placeholder such as `${openNoteIds[0]}`. */
+export type Felt = string | bigint;
+export interface Approval {
+    /** ERC-20 the step is allowed to move. */
+    token: Felt;
+    /** Allowance granted before the call and reset to zero after it. */
+    amount: bigint;
+}
+export interface Step {
+    target: Felt;
+    /** `selector!("...")` - use `selectorOf()` rather than hand-computing it. */
+    selector: Felt;
+    approvals: Approval[];
+    calldata: Felt[];
+}
+export interface Output {
+    token: Felt;
+    /**
+     * The open note this token is credited into. With the Wallet API this is the
+     * placeholder `${openNoteIds[N]}`, which the wallet resolves at submit time.
+     */
+    noteId: Felt;
+    /** Floor on what is actually received, checked after the protocol fee. */
+    minAmount: bigint;
+}
+export interface Plan {
+    steps: Step[];
+    outputs: Output[];
+}
+/** Placeholder for the Nth open note declared alongside the invoke action. */
+export declare function openNote(index: number): string;
+/** Placeholder the wallet replaces with the pool address. */
+export declare const POOL_ADDRESS = "${poolAddress}";
+/**
+ * The router bounds step count and calldata length on chain, and those bounds
+ * are governed rather than fixed - so anything that has read the governor
+ * should pass what it read. Checking here means a plan fails in the caller
+ * rather than after a proof has been generated.
+ */
+export interface PlanLimits {
+    maxSteps: number;
+    maxCalldata: number;
+}
+/**
+ * What the governor held at deployment. A fallback for callers with no way to
+ * read it, and wrong the moment a vote moves it - which is the whole point of
+ * `limits` being an argument everywhere below.
+ */
+export declare const DEFAULT_LIMITS: PlanLimits;
+export declare function validatePlan(plan: Plan, limits?: PlanLimits): void;
+/** Tokens a step may move but no output claims. Each one must end at zero. */
+export declare function unclaimedTokens(plan: Plan): string[];
+/**
+ * Flattens a plan into router calldata, leaving placeholder strings intact so
+ * the wallet can resolve them.
+ */
+export declare function encodePlan(plan: Plan, poolAddress?: Felt, limits?: PlanLimits): Felt[];
+/** A `u256` argument occupies two felts, low then high. */
+export declare function u256(value: bigint): [bigint, bigint];
+/** Fluent builder. Every method returns a new plan rather than mutating one. */
+export declare class PlanBuilder {
+    readonly plan: Plan;
+    private constructor();
+    static create(): PlanBuilder;
+    /** An arbitrary call. This is the escape hatch that makes the router general. */
+    call(step: Step): PlanBuilder;
+    /** Credit a token back into a shielded note. */
+    creditTo(token: Felt, noteId: Felt, minAmount?: bigint): PlanBuilder;
+    build(): Plan;
+    encode(poolAddress?: Felt): Felt[];
+}
+//# sourceMappingURL=plan.d.ts.map

package/dist/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../src/plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,mEAAmE;AACnE,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;AAElC,MAAM,WAAW,QAAQ;IACvB,0CAA0C;IAC1C,KAAK,EAAE,IAAI,CAAA;IACX,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,IAAI,CAAA;IACZ,6EAA6E;IAC7E,QAAQ,EAAE,IAAI,CAAA;IACd,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,QAAQ,EAAE,IAAI,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,IAAI,CAAA;IACX;;;OAGG;IACH,MAAM,EAAE,IAAI,CAAA;IACZ,0EAA0E;IAC1E,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,8EAA8E;AAC9E,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK9C;AAED,6DAA6D;AAC7D,eAAO,MAAM,YAAY,mBAAmB,CAAA;AAE5C;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,UAA6C,CAAA;AA6B1E,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,GAAE,UAA2B,GAAG,IAAI,CA4ClF;AAED,8EAA8E;AAC9E,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,EAAE,CAMpD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,IAAI,EACV,WAAW,GAAE,IAAmB,EAChC,MAAM,GAAE,UAA2B,GAClC,IAAI,EAAE,CAmBR;AAED,2DAA2D;AAC3D,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAIpD;AAED,gFAAgF;AAChF,qBAAa,WAAW;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IAEnB,OAAO;IAIP,MAAM,CAAC,MAAM,IAAI,WAAW;IAI5B,iFAAiF;IACjF,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,WAAW;IAI7B,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,SAAK,GAAG,WAAW;IAOhE,KAAK,IAAI,IAAI;IAKb,MAAM,CAAC,WAAW,GAAE,IAAmB,GAAG,IAAI,EAAE;CAGjD"}

package/dist/plan.js

@@ -0,0 +1,161 @@
+/**
+ * Plan encoding for the Jalin router.
+ *
+ * A plan is what the router takes instead of fixed parameters, so encoding it
+ * correctly is the whole integration surface. The layout below is Cairo's
+ * positional Serde for:
+ *
+ *   privacy_invoke(
+ *     pool_address: ContractAddress,
+ *     steps: Array<Step>,
+ *     outputs: Array<Output>,
+ *   ) -> Span<OpenNoteDeposit>
+ *
+ * An `Array<T>` serialises as its length followed by its elements, and a `u128`
+ * occupies a single felt. Nothing here is nested any deeper than that.
+ */
+/** Placeholder for the Nth open note declared alongside the invoke action. */
+export function openNote(index) {
+    if (!Number.isInteger(index) || index < 0) {
+        throw new RangeError(`open note index must be a non-negative integer, got ${index}`);
+    }
+    return `\${openNoteIds[${index}]}`;
+}
+/** Placeholder the wallet replaces with the pool address. */
+export const POOL_ADDRESS = '${poolAddress}';
+/**
+ * What the governor held at deployment. A fallback for callers with no way to
+ * read it, and wrong the moment a vote moves it - which is the whole point of
+ * `limits` being an argument everywhere below.
+ */
+export const DEFAULT_LIMITS = { maxSteps: 8, maxCalldata: 64 };
+/** Placeholders the wallet resolves at submit time; everything else is a felt. */
+const PLACEHOLDER = /^\$\{(?:openNoteIds\[[0-9]+\]|poolAddress)\}$/;
+/** The Starknet field prime. A felt is a residue mod this, so 2^251+17*2^192+1. */
+const FIELD_PRIME = 2n ** 251n + 17n * 2n ** 192n + 1n;
+/**
+ * Every value in a plan is eventually a felt on the wire.
+ *
+ * Without this a target of `not-an-address` travelled the whole way through the
+ * composer - a plan, a preview, an enabled submit button - and only failed when
+ * the wallet tried to encode it, which is after the user has been told it is
+ * ready to sign. Failing here names the field.
+ */
+function checkFelt(value, where) {
+    if (typeof value === 'string' && PLACEHOLDER.test(value))
+        return;
+    let felt;
+    try {
+        felt = BigInt(value);
+    }
+    catch {
+        throw new Error(`${where} is not a felt: ${JSON.stringify(String(value))}`);
+    }
+    if (felt < 0n)
+        throw new Error(`${where} is negative, and a felt cannot be`);
+    if (felt >= FIELD_PRIME)
+        throw new Error(`${where} is larger than the field prime`);
+}
+export function validatePlan(plan, limits = DEFAULT_LIMITS) {
+    // Outputs may be empty. The pool accepts an empty Span, which is what makes
+    // fire-and-forget plans expressible: bridging value off Starknet, funding an
+    // escrow, casting a ballot. The residue rule is what keeps that safe.
+    if (plan.steps.length === 0) {
+        throw new Error('a plan needs at least one step, or it does nothing at all');
+    }
+    if (plan.steps.length > limits.maxSteps) {
+        throw new Error(`plan has ${plan.steps.length} steps, the router allows ${limits.maxSteps}`);
+    }
+    const seen = new Set();
+    for (const output of plan.outputs) {
+        const key = String(output.token);
+        if (seen.has(key)) {
+            throw new Error(`output token ${key} is declared twice; the router rejects duplicates`);
+        }
+        seen.add(key);
+        checkFelt(output.token, `output ${key} token`);
+        if (output.minAmount < 0n)
+            throw new Error('minAmount cannot be negative');
+    }
+    for (const [i, step] of plan.steps.entries()) {
+        checkFelt(step.target, `step ${i} target`);
+        checkFelt(step.selector, `step ${i} selector`);
+        step.calldata.forEach((felt, j) => checkFelt(felt, `step ${i} calldata[${j}]`));
+        step.approvals.forEach((approval, j) => {
+            checkFelt(approval.token, `step ${i} approval[${j}] token`);
+        });
+        if (step.calldata.length > limits.maxCalldata) {
+            throw new Error(`step ${i} has ${step.calldata.length} felts of calldata, the router allows ${limits.maxCalldata}`);
+        }
+        for (const approval of step.approvals) {
+            if (approval.amount < 0n)
+                throw new Error(`step ${i} approves a negative amount`);
+        }
+    }
+    // The residue rule bites here more often than anywhere else: a token a step is
+    // allowed to move, that no output claims, must end the transaction at zero.
+    // That is legitimate when a step spends its whole allowance, so this is a
+    // warning surface rather than an error - see docs/threat-model.md.
+}
+/** Tokens a step may move but no output claims. Each one must end at zero. */
+export function unclaimedTokens(plan) {
+    const claimed = new Set(plan.outputs.map((o) => String(o.token)));
+    const touched = new Set(plan.steps.flatMap((s) => s.approvals.map((a) => String(a.token))));
+    return [...touched].filter((t) => !claimed.has(t));
+}
+/**
+ * Flattens a plan into router calldata, leaving placeholder strings intact so
+ * the wallet can resolve them.
+ */
+export function encodePlan(plan, poolAddress = POOL_ADDRESS, limits = DEFAULT_LIMITS) {
+    validatePlan(plan, limits);
+    const calldata = [poolAddress, BigInt(plan.steps.length)];
+    for (const step of plan.steps) {
+        calldata.push(step.target, step.selector, BigInt(step.approvals.length));
+        for (const approval of step.approvals) {
+            calldata.push(approval.token, approval.amount);
+        }
+        calldata.push(BigInt(step.calldata.length), ...step.calldata);
+    }
+    calldata.push(BigInt(plan.outputs.length));
+    for (const output of plan.outputs) {
+        calldata.push(output.token, output.noteId, output.minAmount);
+    }
+    return calldata;
+}
+/** A `u256` argument occupies two felts, low then high. */
+export function u256(value) {
+    if (value < 0n)
+        throw new RangeError('u256 cannot be negative');
+    const MASK = (1n << 128n) - 1n;
+    return [value & MASK, value >> 128n];
+}
+/** Fluent builder. Every method returns a new plan rather than mutating one. */
+export class PlanBuilder {
+    plan;
+    constructor(plan) {
+        this.plan = plan;
+    }
+    static create() {
+        return new PlanBuilder({ steps: [], outputs: [] });
+    }
+    /** An arbitrary call. This is the escape hatch that makes the router general. */
+    call(step) {
+        return new PlanBuilder({ ...this.plan, steps: [...this.plan.steps, step] });
+    }
+    /** Credit a token back into a shielded note. */
+    creditTo(token, noteId, minAmount = 0n) {
+        return new PlanBuilder({
+            ...this.plan,
+            outputs: [...this.plan.outputs, { token, noteId, minAmount }],
+        });
+    }
+    build() {
+        validatePlan(this.plan);
+        return this.plan;
+    }
+    encode(poolAddress = POOL_ADDRESS) {
+        return encodePlan(this.build(), poolAddress);
+    }
+}
+//# sourceMappingURL=plan.js.map

package/dist/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../src/plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAoCH,8EAA8E;AAC9E,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,UAAU,CAAC,uDAAuD,KAAK,EAAE,CAAC,CAAA;IACtF,CAAC;IACD,OAAO,kBAAkB,KAAK,IAAI,CAAA;AACpC,CAAC;AAED,6DAA6D;AAC7D,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAA;AAa5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAe,EAAE,QAAQ,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAA;AAE1E,kFAAkF;AAClF,MAAM,WAAW,GAAG,+CAA+C,CAAA;AAEnE,mFAAmF;AACnF,MAAM,WAAW,GAAG,EAAE,IAAI,IAAI,GAAG,GAAG,GAAG,EAAE,IAAI,IAAI,GAAG,EAAE,CAAA;AAEtD;;;;;;;GAOG;AACH,SAAS,SAAS,CAAC,KAAsB,EAAE,KAAa;IACtD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAM;IAEhE,IAAI,IAAY,CAAA;IAChB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,mBAAmB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAA;IAC7E,CAAC;IACD,IAAI,IAAI,GAAG,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,oCAAoC,CAAC,CAAA;IAC5E,IAAI,IAAI,IAAI,WAAW;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,iCAAiC,CAAC,CAAA;AACrF,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAU,EAAE,SAAqB,cAAc;IAC1E,4EAA4E;IAC5E,6EAA6E;IAC7E,sEAAsE;IACtE,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;IAC9E,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,MAAM,6BAA6B,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC9F,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAC9B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAChC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,gBAAgB,GAAG,mDAAmD,CAAC,CAAA;QACzF,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACb,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,CAAA;QAC9C,IAAI,MAAM,CAAC,SAAS,GAAG,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;IAC5E,CAAC;IAED,KAAK,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC7C,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC1C,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;QAC/E,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;YACrC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CACb,QAAQ,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,yCAAyC,MAAM,CAAC,WAAW,EAAE,CACnG,CAAA;QACH,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,QAAQ,CAAC,MAAM,GAAG,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAA;QACnF,CAAC;IACH,CAAC;IAED,+EAA+E;IAC/E,4EAA4E;IAC5E,0EAA0E;IAC1E,mEAAmE;AACrE,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,eAAe,CAAC,IAAU;IACxC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACjE,MAAM,OAAO,GAAG,IAAI,GAAG,CACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CACnE,CAAA;IACD,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,IAAU,EACV,cAAoB,YAAY,EAChC,SAAqB,cAAc;IAEnC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAE1B,MAAM,QAAQ,GAAW,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IAEjE,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;QACxE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;QAChD,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC/D,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;IAC1C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;IAC9D,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,IAAI,CAAC,KAAa;IAChC,IAAI,KAAK,GAAG,EAAE;QAAE,MAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,CAAA;IAC/D,MAAM,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAA;IAC9B,OAAO,CAAC,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,CAAA;AACtC,CAAC;AAED,gFAAgF;AAChF,MAAM,OAAO,WAAW;IACb,IAAI,CAAM;IAEnB,YAAoB,IAAU;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,WAAW,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;IACpD,CAAC;IAED,iFAAiF;IACjF,IAAI,CAAC,IAAU;QACb,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED,gDAAgD;IAChD,QAAQ,CAAC,KAAW,EAAE,MAAY,EAAE,SAAS,GAAG,EAAE;QAChD,OAAO,IAAI,WAAW,CAAC;YACrB,GAAG,IAAI,CAAC,IAAI;YACZ,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SAC9D,CAAC,CAAA;IACJ,CAAC;IAED,KAAK;QACH,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvB,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,cAAoB,YAAY;QACrC,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAA;IAC9C,CAAC;CACF"}

package/dist/receipt.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Does a transaction count?
+ *
+ * The sprint rules ask four things of every listed transaction: it exists, it
+ * succeeded, it touched the STRK20 pool, and — if the project deployed contracts
+ * — it ran through one of them. All four are decidable from the receipt, so
+ * nobody has to wait for a panel to find out.
+ *
+ * The rules live here rather than in the script that checks the manifest,
+ * because the demo asks the same question of a transaction it just submitted,
+ * and two copies of a rule are two rules.
+ */
+/** The minimum shape of a Starknet receipt this needs. */
+export interface ReceiptLike {
+    execution_status?: string;
+    finality_status?: string;
+    events?: {
+        from_address: string;
+    }[];
+}
+export interface Verdict {
+    exists: boolean;
+    succeeded: boolean;
+    touchedPool: boolean;
+    /** null when no contracts are declared: the rule is conditional on having any. */
+    throughOurs: boolean | null;
+    qualifies: boolean;
+}
+export declare function checkReceipt(receipt: ReceiptLike | null | undefined, context: {
+    pool: string;
+    ours?: string[];
+}): Verdict;
+/** One line a person can read, for a UI that has no room for four booleans. */
+export declare function describeVerdict(verdict: Verdict): string;
+/**
+ * Hashes listed more than once, by value.
+ *
+ * A manifest that names the same transaction three times has one transaction in
+ * it, and a checker that answers "3 of 3 would count" has told the team exactly
+ * the thing that gets them rejected. Compared as felts rather than strings,
+ * because `0x0abc` and `0xabc` are one hash written two ways and the padded
+ * variant is the version somebody pastes without noticing.
+ *
+ * Returns each repeated hash once, in the order it first appeared.
+ */
+export declare function findDuplicates(hashes: string[]): string[];
+/** Distinct transactions in a list, by felt value. */
+export declare function countDistinct(hashes: string[]): number;
+export interface Manifest {
+    transactions: string[];
+    contracts: string[];
+    demoVideo: string;
+    demoUrl: string;
+}
+export type ManifestResult = {
+    ok: true;
+    manifest: Manifest;
+} | {
+    ok: false;
+    reason: string;
+};
+/**
+ * Reads a strk20.json, or says why it cannot.
+ *
+ * Shared by the offline checker and the web one so a team gets the same answer
+ * whichever they use. Pure, because these branches only run when a file is
+ * already wrong, and that is exactly where untested code rots.
+ *
+ * The null case is not hypothetical: `JSON.parse('null')` succeeds and returns
+ * null, so reading a property off the result is a TypeError - a crash for a
+ * file anybody can commit and hand to a public endpoint.
+ */
+export declare function parseManifest(text: string, limits?: {
+    transactions: number;
+    contracts: number;
+}): ManifestResult;
+//# sourceMappingURL=receipt.d.ts.map

package/dist/receipt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receipt.d.ts","sourceRoot":"","sources":["../src/receipt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,0DAA0D;AAC1D,MAAM,WAAW,WAAW;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CACpC;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,kFAAkF;IAClF,WAAW,EAAE,OAAO,GAAG,IAAI,CAAA;IAC3B,SAAS,EAAE,OAAO,CAAA;CACnB;AAoBD,wBAAgB,YAAY,CAC1B,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,EACvC,OAAO,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GACzC,OAAO,CAkBT;AAED,+EAA+E;AAC/E,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAUxD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAyBzD;AAED,sDAAsD;AACtD,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAUtD;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,GAChC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjC;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,MAAM,GAAE;IAAE,YAAY,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAwC,GACxF,cAAc,CA2ChB"}

package/dist/receipt.js

@@ -0,0 +1,164 @@
+/**
+ * Does a transaction count?
+ *
+ * The sprint rules ask four things of every listed transaction: it exists, it
+ * succeeded, it touched the STRK20 pool, and — if the project deployed contracts
+ * — it ran through one of them. All four are decidable from the receipt, so
+ * nobody has to wait for a panel to find out.
+ *
+ * The rules live here rather than in the script that checks the manifest,
+ * because the demo asks the same question of a transaction it just submitted,
+ * and two copies of a rule are two rules.
+ */
+const NOT_FOUND = {
+    exists: false,
+    succeeded: false,
+    touchedPool: false,
+    throughOurs: null,
+    qualifies: false,
+};
+function sameAddress(a, b) {
+    try {
+        // 0x0abc and 0xABC are one address written two ways. Comparing the strings
+        // would report a transaction as missing the pool it plainly touched.
+        return BigInt(a) === BigInt(b);
+    }
+    catch {
+        return false;
+    }
+}
+export function checkReceipt(receipt, context) {
+    if (!receipt)
+        return NOT_FOUND;
+    const succeeded = (receipt.execution_status ?? receipt.finality_status) === 'SUCCEEDED';
+    const emitters = (receipt.events ?? []).map((event) => event.from_address);
+    const touchedPool = emitters.some((address) => sameAddress(address, context.pool));
+    const ours = context.ours ?? [];
+    const throughOurs = ours.length === 0 ? null : emitters.some((a) => ours.some((o) => sameAddress(a, o)));
+    return {
+        exists: true,
+        succeeded,
+        touchedPool,
+        throughOurs,
+        qualifies: succeeded && touchedPool && (throughOurs === null || throughOurs),
+    };
+}
+/** One line a person can read, for a UI that has no room for four booleans. */
+export function describeVerdict(verdict) {
+    if (!verdict.exists)
+        return 'not found on chain yet';
+    if (!verdict.succeeded)
+        return 'reverted';
+    if (!verdict.touchedPool)
+        return 'succeeded, but touched no pool event — it would not count';
+    if (verdict.throughOurs === false) {
+        return 'touched the pool, but not through a contract of ours — it would not count';
+    }
+    return verdict.throughOurs === null
+        ? 'counts: succeeded and touched the pool'
+        : 'counts: succeeded, touched the pool, ran through our contract';
+}
+/**
+ * Hashes listed more than once, by value.
+ *
+ * A manifest that names the same transaction three times has one transaction in
+ * it, and a checker that answers "3 of 3 would count" has told the team exactly
+ * the thing that gets them rejected. Compared as felts rather than strings,
+ * because `0x0abc` and `0xabc` are one hash written two ways and the padded
+ * variant is the version somebody pastes without noticing.
+ *
+ * Returns each repeated hash once, in the order it first appeared.
+ */
+export function findDuplicates(hashes) {
+    const seen = new Set();
+    const repeated = new Set();
+    const order = [];
+    for (const hash of hashes) {
+        let key;
+        try {
+            key = BigInt(hash).toString();
+        }
+        catch {
+            // Not a felt. Whatever else is wrong with it, it is not a duplicate.
+            continue;
+        }
+        if (seen.has(key)) {
+            if (!repeated.has(key)) {
+                repeated.add(key);
+                order.push(hash);
+            }
+            continue;
+        }
+        seen.add(key);
+    }
+    return order;
+}
+/** Distinct transactions in a list, by felt value. */
+export function countDistinct(hashes) {
+    const seen = new Set();
+    for (const hash of hashes) {
+        try {
+            seen.add(BigInt(hash).toString());
+        }
+        catch {
+            // Ignored: an unparseable entry is not a transaction.
+        }
+    }
+    return seen.size;
+}
+/**
+ * Reads a strk20.json, or says why it cannot.
+ *
+ * Shared by the offline checker and the web one so a team gets the same answer
+ * whichever they use. Pure, because these branches only run when a file is
+ * already wrong, and that is exactly where untested code rots.
+ *
+ * The null case is not hypothetical: `JSON.parse('null')` succeeds and returns
+ * null, so reading a property off the result is a TypeError - a crash for a
+ * file anybody can commit and hand to a public endpoint.
+ */
+export function parseManifest(text, limits = { transactions: 20, contracts: 16 }) {
+    let parsed;
+    try {
+        parsed = JSON.parse(text);
+    }
+    catch {
+        return { ok: false, reason: 'that file is not JSON' };
+    }
+    // A string, a number and an array all survive property access and would read
+    // as an empty manifest. Only an object is one.
+    if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
+        return { ok: false, reason: 'strk20.json must be a JSON object' };
+    }
+    const raw = parsed;
+    const felts = (value, limit, field) => {
+        if (value === undefined || value === null)
+            return [];
+        if (!Array.isArray(value))
+            return `${field} must be an array`;
+        if (value.length > limit)
+            return `${field} lists more than ${limit} entries`;
+        for (const entry of value) {
+            if (typeof entry !== 'string' || !/^0x[0-9a-fA-F]{1,64}$/.test(entry)) {
+                return `${field} contains something that is not a felt`;
+            }
+        }
+        return value;
+    };
+    const transactions = felts(raw.transactions, limits.transactions, 'transactions');
+    if (typeof transactions === 'string')
+        return { ok: false, reason: transactions };
+    const contracts = felts(raw.contracts, limits.contracts, 'contracts');
+    if (typeof contracts === 'string')
+        return { ok: false, reason: contracts };
+    return {
+        ok: true,
+        manifest: {
+            transactions,
+            contracts,
+            demoVideo: typeof raw.demo_video === 'string' ? raw.demo_video : '',
+            demoUrl: typeof raw.demo_url === 'string' ? raw.demo_url : '',
+        },
+    };
+}
+//# sourceMappingURL=receipt.js.map

package/dist/receipt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"receipt.js","sourceRoot":"","sources":["../src/receipt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAkBH,MAAM,SAAS,GAAY;IACzB,MAAM,EAAE,KAAK;IACb,SAAS,EAAE,KAAK;IAChB,WAAW,EAAE,KAAK;IAClB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,KAAK;CACjB,CAAA;AAED,SAAS,WAAW,CAAC,CAAS,EAAE,CAAS;IACvC,IAAI,CAAC;QACH,2EAA2E;QAC3E,qEAAqE;QACrE,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAA;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,OAAuC,EACvC,OAA0C;IAE1C,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAA;IAE9B,MAAM,SAAS,GAAG,CAAC,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,eAAe,CAAC,KAAK,WAAW,CAAA;IACvF,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;IAE1E,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IAClF,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAA;IAC/B,MAAM,WAAW,GACf,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IAEtF,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,SAAS;QACT,WAAW;QACX,WAAW;QACX,SAAS,EAAE,SAAS,IAAI,WAAW,IAAI,CAAC,WAAW,KAAK,IAAI,IAAI,WAAW,CAAC;KAC7E,CAAA;AACH,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,eAAe,CAAC,OAAgB;IAC9C,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,OAAO,wBAAwB,CAAA;IACpD,IAAI,CAAC,OAAO,CAAC,SAAS;QAAE,OAAO,UAAU,CAAA;IACzC,IAAI,CAAC,OAAO,CAAC,WAAW;QAAE,OAAO,2DAA2D,CAAA;IAC5F,IAAI,OAAO,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;QAClC,OAAO,2EAA2E,CAAA;IACpF,CAAC;IACD,OAAO,OAAO,CAAC,WAAW,KAAK,IAAI;QACjC,CAAC,CAAC,wCAAwC;QAC1C,CAAC,CAAC,+DAA+D,CAAA;AACrE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,MAAgB;IAC7C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAClC,MAAM,KAAK,GAAa,EAAE,CAAA;IAE1B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,GAAW,CAAA;QACf,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,qEAAqE;YACrE,SAAQ;QACV,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBACjB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;YACD,SAAQ;QACV,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACf,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,aAAa,CAAC,MAAgB;IAC5C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAC9B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,CAAC;QAAC,MAAM,CAAC;YACP,sDAAsD;QACxD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC;AAaD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,SAAsD,EAAE,YAAY,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAEzF,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAA;IACvD,CAAC;IAED,6EAA6E;IAC7E,+CAA+C;IAC/C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,mCAAmC,EAAE,CAAA;IACnE,CAAC;IAED,MAAM,GAAG,GAAG,MAAiC,CAAA;IAE7C,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,KAAa,EAAE,KAAa,EAAqB,EAAE;QAChF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,EAAE,CAAA;QACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,GAAG,KAAK,mBAAmB,CAAA;QAC7D,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK;YAAE,OAAO,GAAG,KAAK,oBAAoB,KAAK,UAAU,CAAA;QAC5E,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtE,OAAO,GAAG,KAAK,wCAAwC,CAAA;YACzD,CAAC;QACH,CAAC;QACD,OAAO,KAAiB,CAAA;IAC1B,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,cAAc,CAAC,CAAA;IACjF,IAAI,OAAO,YAAY,KAAK,QAAQ;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA;IAEhF,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;IACrE,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;IAE1E,OAAO;QACL,EAAE,EAAE,IAAI;QACR,QAAQ,EAAE;YACR,YAAY;YACZ,SAAS;YACT,SAAS,EAAE,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;YACnE,OAAO,EAAE,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;SAC9D;KACF,CAAA;AACH,CAAC"}

package/dist/recipes.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Plan recipes.
+ *
+ * These are conveniences, not capabilities. The router has no idea what a
+ * deposit is - every one of these produces the same `Step` any other call would,
+ * which is the point: a protocol does not need a Jalin adapter to be reachable
+ * from inside a private transaction, it just needs an ABI.
+ *
+ * Only shapes checked against a live mainnet contract live here. A recipe that
+ * encodes a guessed argument order is worse than no recipe: it reads as
+ * supported, and it fails after a proof has already been paid for.
+ */
+import { type Felt, type Plan, type Step } from './plan.ts';
+export interface CallStep {
+    /** Contract to call. */
+    target: Felt;
+    /** `selector!("...")` for the entry point. */
+    selector: Felt;
+    /** Token the step is allowed to move, and how much. */
+    spend?: {
+        token: Felt;
+        amount: bigint;
+    };
+    /** Calldata after any `spend` is approved. Already flattened to felts. */
+    calldata: Felt[];
+}
+/**
+ * The general case, and the one to reach for. Anything with an ABI is reachable
+ * through it, including every venue that has no recipe here.
+ */
+export declare function callStep({ target, selector, spend, calldata }: CallStep): Step;
+/**
+ * A deposit into an ERC-4626 vault: `deposit(assets: u256, receiver: ContractAddress)`.
+ *
+ * Verified against Endur's xSTRK vault on Starknet mainnet
+ * (`0x28d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a`), whose
+ * `asset()` is STRK. ERC-4626 fixes the argument order, which is why this shape
+ * is safe to encode once and reuse - unlike a swap, where every venue differs.
+ *
+ * `receiver` should be the router: the shares have to land somewhere the pool can
+ * pull them from, and the router holds nothing after the transaction ends.
+ */
+export declare function depositStep(args: {
+    market: Felt;
+    selector: Felt;
+    asset: Felt;
+    amount: bigint;
+    receiver: Felt;
+}): Step;
+/**
+ * A plan that credits nothing back.
+ *
+ * Legal, and not an oversight: the pool accepts an empty `Span`, which is what
+ * makes bridging value off Starknet, funding an escrow, or casting a ballot
+ * expressible at all. Invariant I4 is what keeps it honest - every token a step
+ * could move must still end the transaction at zero, so "it all left" is checked
+ * rather than assumed.
+ */
+export declare function oneWay(step: Step): Plan;
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAQ,KAAK,IAAI,EAAE,KAAK,IAAI,EAAE,KAAK,IAAI,EAAE,MAAM,WAAW,CAAA;AAEjE,MAAM,WAAW,QAAQ;IACvB,wBAAwB;IACxB,MAAM,EAAE,IAAI,CAAA;IACZ,8CAA8C;IAC9C,QAAQ,EAAE,IAAI,CAAA;IACd,uDAAuD;IACvD,KAAK,CAAC,EAAE;QAAE,KAAK,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACvC,0EAA0E;IAC1E,QAAQ,EAAE,IAAI,EAAE,CAAA;CACjB;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,QAAQ,GAAG,IAAI,CAO9E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE;IAChC,MAAM,EAAE,IAAI,CAAA;IACZ,QAAQ,EAAE,IAAI,CAAA;IACd,KAAK,EAAE,IAAI,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,IAAI,CAAA;CACf,GAAG,IAAI,CAOP;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAEvC"}

package/dist/recipes.js

@@ -0,0 +1,57 @@
+/**
+ * Plan recipes.
+ *
+ * These are conveniences, not capabilities. The router has no idea what a
+ * deposit is - every one of these produces the same `Step` any other call would,
+ * which is the point: a protocol does not need a Jalin adapter to be reachable
+ * from inside a private transaction, it just needs an ABI.
+ *
+ * Only shapes checked against a live mainnet contract live here. A recipe that
+ * encodes a guessed argument order is worse than no recipe: it reads as
+ * supported, and it fails after a proof has already been paid for.
+ */
+import { u256 } from "./plan.js";
+/**
+ * The general case, and the one to reach for. Anything with an ABI is reachable
+ * through it, including every venue that has no recipe here.
+ */
+export function callStep({ target, selector, spend, calldata }) {
+    return {
+        target,
+        selector,
+        approvals: spend ? [{ token: spend.token, amount: spend.amount }] : [],
+        calldata,
+    };
+}
+/**
+ * A deposit into an ERC-4626 vault: `deposit(assets: u256, receiver: ContractAddress)`.
+ *
+ * Verified against Endur's xSTRK vault on Starknet mainnet
+ * (`0x28d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a`), whose
+ * `asset()` is STRK. ERC-4626 fixes the argument order, which is why this shape
+ * is safe to encode once and reuse - unlike a swap, where every venue differs.
+ *
+ * `receiver` should be the router: the shares have to land somewhere the pool can
+ * pull them from, and the router holds nothing after the transaction ends.
+ */
+export function depositStep(args) {
+    return callStep({
+        target: args.market,
+        selector: args.selector,
+        spend: { token: args.asset, amount: args.amount },
+        calldata: [...u256(args.amount), args.receiver],
+    });
+}
+/**
+ * A plan that credits nothing back.
+ *
+ * Legal, and not an oversight: the pool accepts an empty `Span`, which is what
+ * makes bridging value off Starknet, funding an escrow, or casting a ballot
+ * expressible at all. Invariant I4 is what keeps it honest - every token a step
+ * could move must still end the transaction at zero, so "it all left" is checked
+ * rather than assumed.
+ */
+export function oneWay(step) {
+    return { steps: [step], outputs: [] };
+}
+//# sourceMappingURL=recipes.js.map

package/dist/recipes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.js","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,IAAI,EAAmC,MAAM,WAAW,CAAA;AAajE;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAY;IACtE,OAAO;QACL,MAAM;QACN,QAAQ;QACR,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;QACtE,QAAQ;KACT,CAAA;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,IAM3B;IACC,OAAO,QAAQ,CAAC;QACd,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;QACjD,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;KAChD,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAAC,IAAU;IAC/B,OAAO,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAA;AACvC,CAAC"}