@eco-incorp/sauce 0.99.6 → 0.99.8

package/sdk/dist/cli/simulate.js

@@ -0,0 +1,246 @@
+/**
+ * `sauce simulate` on an EVM chain: the cook rehearsed from the Pot's owner with no key and nothing
+ * sent — on a Pot that need not be deployed yet, holding what `--assume-balance` gives it — and what
+ * it did, read back from its logs.
+ *
+ * `rehearse.ts` runs it (`eth_simulateV1`, else `eth_call`), `assume.ts` finds where a token keeps
+ * the Pot's balance, and `effects.ts` decodes the logs. This file decides what to rehearse and
+ * prints it.
+ */
+import { formatUnits, getAddress, parseAbi, } from "viem";
+import { v12EngineAddress } from "../deployments/index.js";
+import { CliError } from "./args.js";
+import { mainReturnType } from "../routes/entry.js";
+import { assumeTokenBalance, mergeOverrides } from "./assume.js";
+import { connectAt, kitchenFee, potState } from "./chain.js";
+import { cookOf, kitchenAddress, priceLimitNotes, valueOf, } from "./commands.js";
+import { addressLabels, effectLines, effectsJson, effectsOf, nativeSymbol, tokenInfo, } from "./effects.js";
+import { baseUnits } from "./funding.js";
+import { rehearse } from "./rehearse.js";
+import { decodeReturned, returnedLine } from "./returned.js";
+const BALANCE_OF = parseAbi(["function balanceOf(address) view returns (uint256)"]);
+const amountText = (balance) => balance.decimals === undefined
+    ? `${balance.amount} ${balance.symbol} (base units)`
+    : `${formatUnits(balance.amount, balance.decimals)} ${balance.symbol}`;
+/**
+ * The balances `--assume-balance` and a keyless `--fund` give the Pot, as state overrides. An
+ * assumed token balance is the Pot's balance outright; a keyless `--fund` adds what its pull would
+ * bring — to the assumed balance, or else to the Pot's balance as it stands.
+ */
+async function potBalances(client, input, pot, credit) {
+    const assumed = [];
+    const overrides = [];
+    const wanted = new Map();
+    for (const request of input.assume) {
+        wanted.set(request.token ?? "native", {
+            request,
+            amount: await baseUnits(client, request),
+            credit: 0n,
+        });
+    }
+    for (const funded of credit) {
+        const before = wanted.get(funded.token);
+        wanted.set(funded.token, { ...before, credit: (before?.credit ?? 0n) + funded.amount });
+    }
+    for (const [key, want] of wanted) {
+        if (key === "native") {
+            overrides.push({ address: pot, balance: want.amount });
+            assumed.push({
+                holder: pot,
+                role: "the Pot",
+                token: "native",
+                symbol: nativeSymbol(input.chain),
+                decimals: 18,
+                amount: want.amount,
+                because: "--assume-balance",
+            });
+            continue;
+        }
+        const token = key;
+        const info = await tokenInfo(client, input.chain, token);
+        const symbol = info.symbol ?? want.request?.label ?? token;
+        const start = want.amount ??
+            (await client
+                .readContract({ address: token, abi: BALANCE_OF, functionName: "balanceOf", args: [pot] })
+                .catch((error) => {
+                throw new CliError(`reading the Pot's ${symbol} balance failed: ` +
+                    (error.shortMessage ?? "the call reverted"));
+            }));
+        const amount = start + want.credit;
+        const found = await assumeTokenBalance(client, token, pot, amount, symbol);
+        overrides.push(found.override);
+        assumed.push({
+            holder: pot,
+            role: "the Pot",
+            token,
+            symbol,
+            ...(info.decimals === undefined ? {} : { decimals: info.decimals }),
+            amount,
+            slot: { slot: found.slot, layout: found.layout },
+            because: want.credit === 0n
+                ? "--assume-balance"
+                : want.amount === undefined
+                    ? "what --fund would pull, credited (no key to sign the pull)"
+                    : "--assume-balance, plus what --fund would pull (no key to sign the pull)",
+        });
+    }
+    return { assumed, overrides };
+}
+/** How the rehearsal ran, for a person. */
+function routeLines(rehearsal, chain, block, owner, pot, deploy, signed) {
+    return [
+        `Rehearsed with ${rehearsal.path} on the state of block ${block}` +
+            (rehearsal.fallback === undefined ? "" : ` (${rehearsal.fallback})`) +
+            (signed
+                ? "; the owner's key signed the pulls, and nothing was sent:"
+                : "; nothing was signed or sent:"),
+        ...(deploy === undefined
+            ? []
+            : [
+                `  1. Kitchen.deployPot(${owner}, ${deploy.salt}): Pot ${pot} is not deployed on ` +
+                    `${chain} yet. Any account may send this; the Pot is the owner's either way.` +
+                    (rehearsal.path === "eth_call"
+                        ? " The Pot it deploys is put in place by state override."
+                        : ""),
+            ]),
+        `  ${deploy === undefined ? "" : "2. "}the cook, from the owner ${owner}`,
+    ];
+}
+/** `sauce simulate`: the cook as a rehearsal from the Pot's owner — no key, nothing sent. */
+export async function simulateCommand(input, files) {
+    const cook = cookOf(input, files);
+    // Every read and the rehearsal itself on one block: what it saw is what it says it saw.
+    const { client, block } = await connectAt(input.rpcUrl, input.chain, input.block);
+    const state = await potState(client, cook.pot);
+    const target = input.target;
+    if (!state.deployed && !("owner" in target)) {
+        throw new CliError(`Pot ${cook.pot} is not deployed on ${input.chain.slug}, and --pot does not say whose it is: ` +
+            "give its --owner (and --salt) instead, and the rehearsal deploys it first");
+    }
+    const owner = state.deployed ? state.owner : target.owner;
+    const deploy = state.deployed ? undefined : { salt: target.salt };
+    const kitchen = kitchenAddress();
+    const funding = input.fund === undefined ? undefined : await input.fund(client, cook.pot, owner);
+    const funded = funding === undefined ? cook : cookOf({ ...input, text: funding.wrap(input.text) }, files);
+    const value = valueOf(input.value, await kitchenFee(client, input.chain), input.chain) +
+        (funding?.value ?? 0n);
+    const { assumed, overrides } = await potBalances(client, input, cook.pot, funding?.credit ?? []);
+    // The owner pays the cook's value. One that holds less is given it for the rehearsal, and told.
+    const held = await client.getBalance({ address: owner });
+    if (held < value) {
+        overrides.push({ address: owner, balance: value });
+        assumed.push({
+            holder: owner,
+            role: "the owner",
+            token: "native",
+            symbol: nativeSymbol(input.chain),
+            decimals: 18,
+            amount: value,
+            because: `the cook's value; it holds ${formatUnits(held, 18)}, and a real cook needs the value ` +
+                "and gas",
+        });
+    }
+    const rehearsal = await rehearse(client, {
+        owner,
+        pot: cook.pot,
+        kitchen,
+        ...(deploy === undefined ? {} : { deploy }),
+        cook: { to: cook.pot, data: funded.data, value },
+        overrides: mergeOverrides(overrides),
+    });
+    const labels = addressLabels(input.chain, [
+        [kitchen, "Kitchen"],
+        [getAddress(v12EngineAddress()), "engine"],
+        [owner, "owner"],
+        [cook.pot, "the Pot"],
+    ]);
+    const effects = rehearsal.ok && rehearsal.logs !== undefined
+        ? await effectsOf(client, input.chain, rehearsal.logs, rehearsal.traced, labels)
+        : undefined;
+    const how = routeLines(rehearsal, input.chain.slug, block, owner, cook.pot, deploy, funding?.signed === true);
+    const assumedLines = assumed.length === 0
+        ? []
+        : [
+            "Assumed for this rehearsal only, by state override:",
+            ...assumed.map((balance) => `  ${balance.role} holds ${amountText(balance)}: ${balance.because}` +
+                (balance.slot === undefined
+                    ? ""
+                    : ` (its balance word ${balance.slot.slot}: ${balance.slot.layout})`)),
+        ];
+    // What main returned, read as the type it declares.
+    const returnType = mainReturnType(input.text);
+    const returned = rehearsal.ok && returnType !== undefined
+        ? decodeReturned(returnType, rehearsal.returns, input.chain)
+        : undefined;
+    const json = {
+        ok: rehearsal.ok,
+        chain: input.chain.slug,
+        block: block.toString(),
+        from: owner,
+        to: cook.pot,
+        value: value.toString(),
+        path: rehearsal.path,
+        ...(rehearsal.fallback === undefined ? {} : { fallback: rehearsal.fallback }),
+        deployPot: deploy === undefined ? null : { kitchen, owner, salt: deploy.salt },
+        assumed: assumed.map((balance) => ({
+            holder: balance.holder,
+            token: balance.token,
+            symbol: balance.symbol,
+            amount: balance.amount.toString(),
+            ...(balance.decimals === undefined
+                ? {}
+                : { formatted: formatUnits(balance.amount, balance.decimals) }),
+            because: balance.because,
+            ...(balance.slot === undefined
+                ? {}
+                : { slot: balance.slot.slot, layout: balance.slot.layout }),
+        })),
+        ...(rehearsal.ok
+            ? {
+                gas: rehearsal.gas === undefined ? null : rehearsal.gas.toString(),
+                gasKind: rehearsal.gasKind,
+                returns: rehearsal.returns,
+                ...(returnType === undefined ? {} : { returnType, returned: returned ?? null }),
+                ...(effects === undefined ? {} : effectsJson(effects)),
+            }
+            : { stage: rehearsal.stage, reason: rehearsal.reason }),
+    };
+    const notes = [
+        ...priceLimitNotes(input, cook.program.entryParams, input.args),
+        ...(funding?.notes ?? []),
+        ...rehearsal.notes,
+    ];
+    if (!rehearsal.ok) {
+        return {
+            text: [
+                rehearsal.stage === "deploy"
+                    ? `Deploying the Pot reverts: ${rehearsal.reason}`
+                    : `The cook reverts: ${rehearsal.reason}`,
+                ...how,
+                ...assumedLines,
+            ].join("\n"),
+            json,
+            notes,
+            exitCode: 1,
+        };
+    }
+    const gas = rehearsal.gas === undefined
+        ? "gas not known"
+        : rehearsal.gasKind === "used"
+            ? `gas used ${rehearsal.gas}`
+            : `gas ${rehearsal.gas} (estimated)`;
+    return {
+        text: [
+            `The cook succeeds from ${owner}: ${gas}, returns ${rehearsal.returns}`,
+            ...(returnType === undefined
+                ? []
+                : [returnedLine(returnType, rehearsal.returns, input.chain)]),
+            ...how,
+            ...assumedLines,
+            ...(effects === undefined ? [] : effectLines(effects)),
+        ].join("\n"),
+        json,
+        notes,
+    };
+}
+//# sourceMappingURL=simulate.js.map

package/sdk/dist/cli/simulate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulate.js","sourceRoot":"","sources":["../../src/cli/simulate.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,WAAW,EACX,UAAU,EACV,QAAQ,GAKT,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EACL,MAAM,EACN,cAAc,EACd,eAAe,EACf,OAAO,GAKR,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,aAAa,EACb,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,GAEV,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAkC,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAkB,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAwB7D,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,oDAAoD,CAAC,CAAC,CAAC;AAEpF,MAAM,UAAU,GAAG,CAAC,OAAgB,EAAU,EAAE,CAC9C,OAAO,CAAC,QAAQ,KAAK,SAAS;IAC5B,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,eAAe;IACpD,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;AAE3E;;;;GAIG;AACH,KAAK,UAAU,WAAW,CACxB,MAAoB,EACpB,KAAoB,EACpB,GAAY,EACZ,MAAsC;IAEtC,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,MAAM,SAAS,GAA4B,EAAE,CAAC;IAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAsE,CAAC;IAC7F,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,QAAQ,EAAE;YACpC,OAAO;YACP,MAAM,EAAE,MAAM,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;YACxC,MAAM,EAAE,EAAE;SACX,CAAC,CAAC;IACL,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,EAAE,CAAC;QACjC,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrB,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,MAAO,EAAE,CAAC,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,QAAQ;gBACf,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC;gBACjC,QAAQ,EAAE,EAAE;gBACZ,MAAM,EAAE,IAAI,CAAC,MAAO;gBACpB,OAAO,EAAE,kBAAkB;aAC5B,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,GAAc,CAAC;QAC7B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,KAAK,CAAC;QAC3D,MAAM,KAAK,GACT,IAAI,CAAC,MAAM;YACX,CAAC,MAAM,MAAM;iBACV,YAAY,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;iBACzF,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;gBACxB,MAAM,IAAI,QAAQ,CAChB,qBAAqB,MAAM,mBAAmB;oBAC5C,CAAE,KAAmC,CAAC,YAAY,IAAI,mBAAmB,CAAC,CAC7E,CAAC;YACJ,CAAC,CAAC,CAAC,CAAC;QACR,MAAM,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QACnC,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3E,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC;YACX,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,SAAS;YACf,KAAK;YACL,MAAM;YACN,GAAG,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnE,MAAM;YACN,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;YAChD,OAAO,EACL,IAAI,CAAC,MAAM,KAAK,EAAE;gBAChB,CAAC,CAAC,kBAAkB;gBACpB,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS;oBACzB,CAAC,CAAC,4DAA4D;oBAC9D,CAAC,CAAC,yEAAyE;SAClF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC;AAED,2CAA2C;AAC3C,SAAS,UAAU,CACjB,SAAoB,EACpB,KAAa,EACb,KAAa,EACb,KAAc,EACd,GAAY,EACZ,MAA0C,EAC1C,MAAe;IAEf,OAAO;QACL,kBAAkB,SAAS,CAAC,IAAI,0BAA0B,KAAK,EAAE;YAC/D,CAAC,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,QAAQ,GAAG,CAAC;YACpE,CAAC,MAAM;gBACL,CAAC,CAAC,2DAA2D;gBAC7D,CAAC,CAAC,+BAA+B,CAAC;QACtC,GAAG,CAAC,MAAM,KAAK,SAAS;YACtB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,0BAA0B,KAAK,KAAK,MAAM,CAAC,IAAI,UAAU,GAAG,sBAAsB;oBAChF,GAAG,KAAK,qEAAqE;oBAC7E,CAAC,SAAS,CAAC,IAAI,KAAK,UAAU;wBAC5B,CAAC,CAAC,wDAAwD;wBAC1D,CAAC,CAAC,EAAE,CAAC;aACV,CAAC;QACN,KAAK,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,4BAA4B,KAAK,EAAE;KAC1E,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,KAAoB,EACpB,KAAe;IAEf,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAClC,wFAAwF;IACxF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClF,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,QAAQ,CAChB,OAAO,IAAI,CAAC,GAAG,uBAAuB,KAAK,CAAC,KAAK,CAAC,IAAI,wCAAwC;YAC5F,2EAA2E,CAC9E,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAE,MAAsC,CAAC,KAAK,CAAC;IAC5F,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAG,MAAiC,CAAC,IAAI,EAAE,CAAC;IAC9F,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IAEjC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjG,MAAM,MAAM,GACV,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC7F,MAAM,KAAK,GACT,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;QACxE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;IACzB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;IACjG,gGAAgG;IAChG,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACzD,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;QACjB,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACnD,OAAO,CAAC,IAAI,CAAC;YACX,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,EAAE;YACZ,MAAM,EAAE,KAAK;YACb,OAAO,EACL,8BAA8B,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,oCAAoC;gBACvF,SAAS;SACZ,CAAC,CAAC;IACL,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE;QACvC,KAAK;QACL,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,OAAO;QACP,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3C,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE;QAChD,SAAS,EAAE,cAAc,CAAC,SAAS,CAAC;KACrC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE;QACxC,CAAC,OAAO,EAAE,SAAS,CAAC;QACpB,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,EAAE,QAAQ,CAAC;QAC1C,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC;KACtB,CAAC,CAAC;IACH,MAAM,OAAO,GACX,SAAS,CAAC,EAAE,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS;QAC1C,CAAC,CAAC,MAAM,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;QAChF,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,GAAG,GAAG,UAAU,CACpB,SAAS,EACT,KAAK,CAAC,KAAK,CAAC,IAAI,EAChB,KAAK,EACL,KAAK,EACL,IAAI,CAAC,GAAG,EACR,MAAM,EACN,OAAO,EAAE,MAAM,KAAK,IAAI,CACzB,CAAC;IACF,MAAM,YAAY,GAChB,OAAO,CAAC,MAAM,KAAK,CAAC;QAClB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;YACE,qDAAqD;YACrD,GAAG,OAAO,CAAC,GAAG,CACZ,CAAC,OAAO,EAAE,EAAE,CACV,KAAK,OAAO,CAAC,IAAI,UAAU,UAAU,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE;gBACpE,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS;oBACzB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,sBAAsB,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAC1E;SACF,CAAC;IACR,oDAAoD;IACpD,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,QAAQ,GACZ,SAAS,CAAC,EAAE,IAAI,UAAU,KAAK,SAAS;QACtC,CAAC,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC;QAC5D,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,IAAI,GAA4B;QACpC,EAAE,EAAE,SAAS,CAAC,EAAE;QAChB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI;QACvB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;QACvB,IAAI,EAAE,KAAK;QACX,EAAE,EAAE,IAAI,CAAC,GAAG;QACZ,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;QACvB,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,GAAG,CAAC,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC7E,SAAS,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;QAC9E,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACjC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE;YACjC,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAChC,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjE,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS;gBAC5B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;SAC9D,CAAC,CAAC;QACH,GAAG,CAAC,SAAS,CAAC,EAAE;YACd,CAAC,CAAC;gBACE,GAAG,EAAE,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE;gBAClE,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,IAAI,IAAI,EAAE,CAAC;gBAC/E,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;aACvD;YACH,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;KAC1D,CAAC;IACF,MAAM,KAAK,GAAG;QACZ,GAAG,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC;QAC/D,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;QACzB,GAAG,SAAS,CAAC,KAAK;KACnB,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;QAClB,OAAO;YACL,IAAI,EAAE;gBACJ,SAAS,CAAC,KAAK,KAAK,QAAQ;oBAC1B,CAAC,CAAC,8BAA8B,SAAS,CAAC,MAAM,EAAE;oBAClD,CAAC,CAAC,qBAAqB,SAAS,CAAC,MAAM,EAAE;gBAC3C,GAAG,GAAG;gBACN,GAAG,YAAY;aAChB,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,IAAI;YACJ,KAAK;YACL,QAAQ,EAAE,CAAC;SACZ,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GACP,SAAS,CAAC,GAAG,KAAK,SAAS;QACzB,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,SAAS,CAAC,OAAO,KAAK,MAAM;YAC5B,CAAC,CAAC,YAAY,SAAS,CAAC,GAAG,EAAE;YAC7B,CAAC,CAAC,OAAO,SAAS,CAAC,GAAG,cAAc,CAAC;IAE3C,OAAO;QACL,IAAI,EAAE;YACJ,0BAA0B,KAAK,KAAK,GAAG,aAAa,SAAS,CAAC,OAAO,EAAE;YACvE,GAAG,CAAC,UAAU,KAAK,SAAS;gBAC1B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/D,GAAG,GAAG;YACN,GAAG,YAAY;YACf,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC,IAAI,CAAC,IAAI,CAAC;QACZ,IAAI;QACJ,KAAK;KACN,CAAC;AACJ,CAAC"}

package/sdk/dist/cli/skills.d.ts

@@ -0,0 +1,77 @@
+/** The agent skills in this package: `skills/` at the package root, three levels above this
+ *  module in `sdk/{src,dist}/cli`. */
+export declare const PACKAGED_SKILLS: string;
+export declare const AGENTS: readonly ["claude", "codex", "cursor", "copilot", "gemini", "agents-md"];
+export type Agent = (typeof AGENTS)[number];
+/** The agents an install serves when none is named, and what `--agent all` means: every agent
+ *  that reads a skills directory. `agents-md`, an index in `AGENTS.md`, is only ever asked for. */
+export declare const DEFAULT_AGENTS: readonly Agent[];
+/** The install record, inside each skills directory. */
+export declare const INSTALL_RECORD = ".sauce-skills.json";
+/** One place skills are kept: a skills directory, or the index block of `AGENTS.md`. */
+export interface Target {
+    readonly kind: "directory" | "index";
+    /** Relative to the project. */
+    readonly path: string;
+    /** The agents it serves, among those asked for. */
+    readonly agents: readonly Agent[];
+}
+/** Which package, at which version, the skills come from, and where they are. */
+export interface SkillsSource {
+    readonly dir: string;
+    readonly packageName: string;
+    readonly version: string;
+    /** The TypeScript range the package itself depends on, for a project `sauce init` writes. */
+    readonly typescript?: string;
+}
+/** `--agent`: names, comma-separated or repeated; `all` is `DEFAULT_AGENTS`, and may be joined
+ *  by `agents-md`. `undefined` when none is given. */
+export declare function parseAgents(raws: readonly string[]): Agent[] | undefined;
+/** The places `agents` read skills from, each once. */
+export declare function targetsFor(agents: readonly Agent[]): Target[];
+/** The targets a project has installed, whichever agents they were for. */
+export declare function installedTargets(project: string): Target[];
+/** `text` with the sauce-skills block taken out — the part of `AGENTS.md` that is the user's. */
+export declare function withoutBlock(text: string): string;
+/**
+ * One file's state. `add`, `update` and `remove` are what `update` will do; `current` needs
+ * nothing; `modified` — changed here since installed, or there before sauce was, or a retired
+ * skill somebody edited — is what `update` keeps unless `--force`.
+ */
+export interface FileStatus {
+    readonly path: string;
+    readonly change: "current" | "add" | "update" | "remove" | "modified";
+    /** For a modified file the package still ships: what differs. */
+    readonly diff?: string;
+}
+export interface TargetStatus {
+    readonly target: Target;
+    readonly state: "not installed" | "up to date" | "outdated" | "modified";
+    /** The version the installed copy came from. */
+    readonly installedVersion?: string;
+    readonly files: readonly FileStatus[];
+}
+/** A few lines around the first difference: what the package has (-) and what is here (+). */
+export declare function shortDiff(packagedText: string, localText: string): string;
+/** Where `target` stands against the package. */
+export declare function statusOf(project: string, source: SkillsSource, target: Target): TargetStatus;
+/** What `install` or `update` did to one target. */
+export interface TargetReport {
+    readonly target: Target;
+    /** One line for the target, then its files. */
+    readonly lines: readonly string[];
+}
+/**
+ * The first install of `target`. Never overwrites: on an installed target it only says where the
+ * project stands, and a file already there that sauce did not write is left as it is.
+ */
+export declare function installTarget(project: string, source: SkillsSource, target: Target): TargetReport;
+/**
+ * Brings an installed `target` to the package: adds new skill files, replaces changed ones and
+ * removes retired ones. A file changed here since it was installed is kept, with what differs,
+ * unless `force`.
+ */
+export declare function updateTarget(project: string, source: SkillsSource, target: Target, force: boolean): TargetReport;
+/** One target's status as lines: its state, then each file that is not current. */
+export declare function describeStatus(status: TargetStatus, source: SkillsSource): string[];
+//# sourceMappingURL=skills.d.ts.map

package/sdk/dist/cli/skills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"skills.d.ts","sourceRoot":"","sources":["../../src/cli/skills.ts"],"names":[],"mappings":"AAmDA;sCACsC;AACtC,eAAO,MAAM,eAAe,QAA8D,CAAC;AAE3F,eAAO,MAAM,MAAM,0EAA2E,CAAC;AAC/F,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5C;mGACmG;AACnG,eAAO,MAAM,cAAc,EAAE,SAAS,KAAK,EAAuD,CAAC;AAEnG,wDAAwD;AACxD,eAAO,MAAM,cAAc,uBAAuB,CAAC;AAgBnD,wFAAwF;AACxF,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC;IACrC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;CACnC;AAED,iFAAiF;AACjF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,6FAA6F;IAC7F,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;sDACsD;AACtD,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,SAAS,CAUxE;AAED,uDAAuD;AACvD,wBAAgB,UAAU,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,MAAM,EAAE,CAa7D;AAED,2EAA2E;AAC3E,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAe1D;AA2GD,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUjD;AAMD;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtE,iEAAiE;IACjE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,YAAY,GAAG,UAAU,GAAG,UAAU,CAAC;IACzE,gDAAgD;IAChD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;CACvC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAqBzE;AAyJD,iDAAiD;AACjD,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,CAI5F;AAgBD,oDAAoD;AACpD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAsBD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,CAmCjG;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,OAAO,GACb,YAAY,CAgEd;AAkBD,mFAAmF;AACnF,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,GAAG,MAAM,EAAE,CAiBnF"}