slotdiff 0.1.0-alpha.1 → 0.2.0-alpha.1

package/dist/cli.js

@@ -0,0 +1,363 @@
+/**
+ * `slotdiff <old> <new>`: each side is a contract in the project's build info
+ * or an address: a proxy (read as the implementation it runs now) or an
+ * implementation.
+ *
+ * Exit codes: 0 every check ran and passed (or was skipped with --no-safety),
+ * 1 a check failed, 2 something could not be checked. Failing to check is
+ * never reported as compatible.
+ */
+import { readFile } from "node:fs/promises";
+import { relative, resolve } from "node:path";
+import { parseArgs, styleText } from "node:util";
+import { findBuildInfo } from "./build-info.js";
+import { readCode, readProxy } from "./chain.js";
+import { diffLayouts } from "./diff.js";
+import { checkNamespaces } from "./erc7201.js";
+import { checkLines, namespaceLines, plain } from "./report.js";
+import { errorCode, LayoutUnavailableError } from "./errors.js";
+import { canQueryExplorer } from "./explorer.js";
+import { rebuild } from "./resolve.js";
+import { analyzeSource, SAFETY_ERROR_KINDS, } from "./reconstruct.js";
+import { getSolc } from "./solc.js";
+const USAGE = `Usage: slotdiff <old> <new> [options]
+
+Checks that <new> can replace <old> behind a proxy: OpenZeppelin's storage layout
+rules, that each ERC-7201 namespace stays in the slot the code really uses, and
+OpenZeppelin's safety rules for <new> (constructors, initializers, selfdestruct...).
+Each side is either:
+  a contract in this project's build info   src/Vault.sol:Vault, or Vault when unique
+  an address                                a proxy (the implementation it runs now),
+                                            or an implementation
+
+Options:
+  --rpc <url>                 JSON-RPC endpoint, required when a side is an address
+  --root <dir>                Project root (default: the current directory)
+  --build-info <file>         Read local sides from this build-info file, as is
+                              (not compared with the sources on disk)
+  --explorer-url <url>        Another Etherscan-compatible API, such as Blockscout
+  --unsafe-allow-renames      Accept renames without @custom:oz-renamed-from
+  --unsafe-allow <kinds>      Comma-separated safety errors to accept, e.g. constructor;
+                              prefer @custom:oz-upgrades-unsafe-allow in the source
+  --no-safety                 Skip the safety rules
+  -h, --help                  Show this help
+  -v, --version               Show the version
+
+An address needs verified source: set ETHERSCAN_API_KEY once (one key covers every
+chain), or use --explorer-url, with that explorer's key in its query if it needs one
+(ETHERSCAN_API_KEY is sent only to Etherscan). --rpc picks the chain for each run.
+
+Exit codes: 0 every check passed (or was skipped with --no-safety), 1 a check
+failed, 2 something could not be checked.
+
+A pass means these checks found no problem, not that an upgrade is safe in every
+way. No warranty; see LICENSE.`;
+const HELP_HINT = "Run slotdiff --help for usage.";
+// "slot" and "diff" in block letters, split where the two words meet.
+const BANNER = [
+    ["     _       _  ", "    _ _  __  __"],
+    [" ___| | ___ | |_", " __| (_)/ _|/ _|"],
+    ["/ __| |/ _ \\| __", "/ _` | | |_| |_"],
+    ["\\__ \\ | (_) | |", "| (_| | |  _|  _|"],
+    ["|___/_|\\___/ \\__", "\\__,_|_|_| |_|"],
+];
+const ADDRESS = /^0x[0-9a-fA-F]{40}$/;
+/** Runs the CLI and resolves to its exit code. */
+export async function run(argv, io) {
+    let parsed;
+    try {
+        parsed = parseArgs({
+            args: argv,
+            allowPositionals: true,
+            options: {
+                rpc: { type: "string" },
+                root: { type: "string" },
+                "build-info": { type: "string" },
+                "explorer-url": { type: "string" },
+                "unsafe-allow-renames": { type: "boolean" },
+                "unsafe-allow": { type: "string" },
+                "no-safety": { type: "boolean" },
+                help: { type: "boolean", short: "h" },
+                version: { type: "boolean", short: "v" },
+            },
+        });
+    }
+    catch (e) {
+        // Node's text for an unknown option runs on about `--`; the option is enough.
+        const message = e.message;
+        const unknown = /^Unknown option '([^']+)'/.exec(message)?.[1];
+        const text = unknown !== undefined ? `Unknown option ${unknown}` : message;
+        io.stderr(`${text.replace(/\.?$/, ".")} ${HELP_HINT}`);
+        return 2;
+    }
+    const { values, positionals } = parsed;
+    const paint = io.color
+        ? (format, text) => styleText(format, text, { validateStream: false })
+        : plain;
+    // Only for a person at a terminal: never in a pipe, a log or CI.
+    const banner = async () => [
+        ...BANNER.map(([slot, diff]) => paint("blueBright", slot) + paint("magenta", diff)),
+        ` ${paint("dim", `storage layout diff for upgradeable contracts · ${await packageVersion()}`)}`,
+    ].join("\n");
+    if (values.help) {
+        io.stdout(io.tty ? `${await banner()}\n\n${USAGE}` : USAGE);
+        return 0;
+    }
+    if (values.version) {
+        io.stdout(io.tty ? await banner() : await packageVersion());
+        return 0;
+    }
+    if (positionals.length !== 2) {
+        io.stderr(`Expected <old> and <new>, got ${positionals.length} argument(s). ${HELP_HINT}`);
+        return 2;
+    }
+    if (positionals.some((p) => p.includes("://"))) {
+        // Not echoed: an RPC URL usually carries an API key.
+        io.stderr("A side looks like a URL. Pass the endpoint with --rpc <url>.");
+        return 2;
+    }
+    const short = positionals.find((p) => /^0x[0-9a-fA-F]*$/.test(p) && !ADDRESS.test(p));
+    if (short !== undefined) {
+        io.stderr(`${short} is not an address: an address is 0x and 40 hex digits.`);
+        return 2;
+    }
+    const hasAddress = positionals.some((p) => ADDRESS.test(p));
+    if (values.rpc === undefined && hasAddress) {
+        io.stderr("An address needs --rpc <url>.");
+        return 2;
+    }
+    const safety = !values["no-safety"];
+    if (!safety && values["unsafe-allow"] !== undefined) {
+        io.stderr("--unsafe-allow does nothing with --no-safety.");
+        return 2;
+    }
+    const unsafeAllow = (values["unsafe-allow"]?.split(",") ?? [])
+        .map((k) => k.trim())
+        .filter((k) => k !== "");
+    const unknownKind = unsafeAllow.find((k) => !SAFETY_ERROR_KINDS.includes(k));
+    if (unknownKind !== undefined) {
+        io.stderr(`--unsafe-allow: unknown error kind "${unknownKind}". Known: ${SAFETY_ERROR_KINDS.join(", ")}.`);
+        return 2;
+    }
+    // Neither URL is ever echoed: endpoints often carry an API key.
+    let rpcUrl;
+    try {
+        rpcUrl = values.rpc !== undefined ? httpUrl(values.rpc, "--rpc") : undefined;
+        const explorerUrl = values["explorer-url"];
+        if (explorerUrl !== undefined && hasCredentials(httpUrl(explorerUrl, "--explorer-url"))) {
+            throw new Error("--explorer-url must not include a user name or password.");
+        }
+    }
+    catch (e) {
+        io.stderr(e.message);
+        return 2;
+    }
+    const cwd = io.cwd ?? process.cwd();
+    const root = resolve(cwd, values.root ?? ".");
+    const buildInfoFile = values["build-info"] !== undefined ? resolve(cwd, values["build-info"]) : undefined;
+    const env = io.env ?? process.env;
+    // The Etherscan key goes to Etherscan only, never to another explorer's URL.
+    const explorer = values["explorer-url"] !== undefined
+        ? { apiUrl: values["explorer-url"] }
+        : { apiKey: env.ETHERSCAN_API_KEY };
+    const provider = rpcUrl !== undefined ? jsonRpcProvider(rpcUrl, io.fetch ?? fetch) : undefined;
+    if (io.tty)
+        io.stdout(`${await banner()}\n`);
+    const readSide = async (spec) => {
+        if (ADDRESS.test(spec)) {
+            // A proxy stands for what it runs now; any other address is an implementation.
+            const proxy = await readProxy(provider, spec);
+            const implementation = proxy?.implementation ?? spec.toLowerCase();
+            if (!canQueryExplorer(explorer)) {
+                await readCode(provider, implementation); // a wrong address is reported as such first
+                throw new Error(`${implementation} needs an explorer key to fetch its verified source: set ` +
+                    "ETHERSCAN_API_KEY (or use --explorer-url for another explorer).");
+            }
+            const { record, analysis } = await rebuild(provider, implementation, { explorer });
+            return {
+                description: [
+                    proxy === undefined
+                        ? `${implementation} (implementation)`
+                        : `${spec.toLowerCase()} → implementation ${implementation}` +
+                            (proxy.beacon !== undefined ? ` (via beacon ${proxy.beacon})` : ""),
+                    `${record.contract} (verified source, ${record.bytecodeMatch} match)`,
+                ],
+                kind: proxy?.beacon !== undefined ? "beacon" : analysis.kind,
+                analysis,
+            };
+        }
+        const build = await findBuildInfo(root, spec, { file: buildInfoFile });
+        const solc = await getSolc(build.solcVersion);
+        const analysis = await analyzeSource(build.input, solc, build.contract);
+        return {
+            description: [
+                build.contract,
+                relative(root, build.file) +
+                    (buildInfoFile !== undefined ? " (as given, not compared with the sources on disk)" : ""),
+            ],
+            kind: analysis.kind,
+            analysis,
+        };
+    };
+    let old;
+    let next;
+    try {
+        old = await readSide(positionals[0]);
+        // The same side twice (e.g. a proxy against itself) is fetched and compiled once.
+        next = positionals[1] === positionals[0] ? old : await readSide(positionals[1]);
+    }
+    catch (e) {
+        io.stderr(`Could not check: ${e.message}`);
+        return 2;
+    }
+    for (const [label, side] of [
+        ["old", old],
+        ["new", next],
+    ]) {
+        io.stdout(`${paint("bold", label)}  ${side.description[0]}\n     ${paint("dim", side.description[1])}`);
+    }
+    // OpenZeppelin matches namespaces by annotation; slotdiff pairs them by the
+    // slot the code uses, and OpenZeppelin then compares the structs of each pair.
+    const namespaces = checkNamespaces(old.analysis, next.analysis);
+    const grid = namespaceLines(namespaces.pairs, paint);
+    if (grid.length > 0)
+        io.stdout(`\n${grid.join("\n")}`);
+    const report = diffLayouts(namespaces.layout, next.analysis.layout, {
+        unsafeAllowRenames: values["unsafe-allow-renames"],
+    });
+    const renames = values["unsafe-allow-renames"] ? " (renames accepted)" : "";
+    const checks = [
+        report.ok
+            ? { name: "Storage layout", status: "pass", summary: `compatible${renames}` }
+            : {
+                name: "Storage layout",
+                status: "fail",
+                summary: `incompatible${renames}`,
+                details: report.explain(),
+            },
+    ];
+    if (namespaces.pairs.length > 0) {
+        checks.push({
+            name: "ERC-7201 slots",
+            ...(namespaces.result === "fail"
+                ? { status: "fail", summary: "problems found in <new> (see above)" }
+                : namespaces.result === "unread"
+                    ? { status: "skip", summary: "not checked: some slots could not be read (see above)" }
+                    : grid.length > 0
+                        ? { status: "pass", summary: "compared by the slot in code (see above)" }
+                        : { status: "pass", summary: "match their annotations" }),
+        });
+    }
+    // The kind comes from <old>, the proxy being upgraded: inferring it from <new>
+    // would miss a UUPS implementation that lost its upgrade function.
+    const accepted = unsafeAllow.length > 0 ? `; accepted: ${unsafeAllow.join(", ")}` : "";
+    const safetyCheck = safety ? next.analysis.safety({ kind: old.kind, unsafeAllow }) : undefined;
+    checks.push(safetyCheck === undefined
+        ? { name: "Safety rules", status: "skip", summary: "skipped (--no-safety)" }
+        : safetyCheck.ok
+            ? {
+                name: "Safety rules",
+                status: "pass",
+                summary: `no problems found (${old.kind} proxy${accepted})`,
+            }
+            : {
+                name: "Safety rules",
+                status: "fail",
+                summary: `problems found (${old.kind} proxy${accepted})`,
+                details: safetyCheck.explain(),
+            });
+    io.stdout(`\n${checkLines(checks, paint).join("\n")}`);
+    // One verdict, so a passing check next to a failing one is never read as safe.
+    const problems = [
+        ...(report.ok ? [] : ["the storage layout is incompatible"]),
+        ...(namespaces.result === "fail" ? ["an ERC-7201 namespace fails the slot check"] : []),
+        ...(safetyCheck?.ok === false ? ["<new> breaks the safety rules"] : []),
+    ];
+    if (problems.length > 0) {
+        io.stdout(`\n${paint(["bold", "red"], "Not safe to upgrade:")} ${problems.join(" and ")}.`);
+        return 1;
+    }
+    if (namespaces.result === "unread") {
+        io.stdout(`\n${paint(["bold", "yellow"], "Could not check:")} some ERC-7201 slots could not be read.`);
+        return 2;
+    }
+    io.stdout(safetyCheck === undefined
+        ? `\n${paint("yellow", "Storage layout compatible; safety rules not checked (--no-safety).")}`
+        : `\n${paint(["bold", "green"], "Safe to upgrade.")}`);
+    return 0;
+}
+function httpUrl(value, flag) {
+    let url;
+    try {
+        url = new URL(value);
+    }
+    catch {
+        throw new Error(`${flag} is not a valid URL; it needs a scheme, such as https://.`);
+    }
+    if (url.protocol !== "http:" && url.protocol !== "https:") {
+        throw new Error(`${flag} must be an http or https URL.`);
+    }
+    return url;
+}
+function hasCredentials(url) {
+    return url.username !== "" || url.password !== "";
+}
+/**
+ * A minimal JSON-RPC client. Errors never include the URL: endpoints often
+ * carry an API key in the path or query. Credentials in the URL, which fetch
+ * refuses, are sent as basic auth instead.
+ */
+function jsonRpcProvider(url, fetchImpl) {
+    const headers = { "content-type": "application/json" };
+    if (hasCredentials(url)) {
+        const user = `${decodeURIComponent(url.username)}:${decodeURIComponent(url.password)}`;
+        headers.authorization = `Basic ${Buffer.from(user).toString("base64")}`;
+        url = new URL(url);
+        url.username = "";
+        url.password = "";
+    }
+    const endpoint = url.href;
+    let id = 0;
+    return {
+        async send(method, params) {
+            let response;
+            try {
+                response = await fetchImpl(endpoint, {
+                    method: "POST",
+                    headers,
+                    body: JSON.stringify({ jsonrpc: "2.0", id: ++id, method, params }),
+                });
+            }
+            catch (e) {
+                throw new LayoutUnavailableError(`Cannot reach the RPC endpoint (${errorCode(e)}).`);
+            }
+            if (!response.ok) {
+                throw new LayoutUnavailableError(`The RPC endpoint answered HTTP ${response.status}.`);
+            }
+            let body;
+            try {
+                body = (await response.json());
+            }
+            catch {
+                body = {};
+            }
+            if (typeof body !== "object" || body === null || !("result" in body || "error" in body)) {
+                throw new LayoutUnavailableError(`The RPC endpoint did not answer JSON-RPC.`);
+            }
+            if (body.error !== undefined) {
+                // The server's text, without control characters (terminal escapes) and capped.
+                const message = String(body.error.message ?? "unknown error")
+                    // eslint-disable-next-line no-control-regex
+                    .replace(/[\u0000-\u001f\u007f-\u009f]/g, " ")
+                    .slice(0, 300);
+                throw new Error(`RPC ${method} failed: ${message}`);
+            }
+            return body.result;
+        },
+    };
+}
+async function packageVersion() {
+    const pkg = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8"));
+    return pkg.version;
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAoB,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAA0B,MAAM,aAAa,CAAC;AACxF,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EACL,aAAa,EACb,kBAAkB,GAInB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,KAAK,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BA+BiB,CAAC;AAEhC,MAAM,SAAS,GAAG,gCAAgC,CAAC;AAEnD,sEAAsE;AACtE,MAAM,MAAM,GAA4B;IACtC,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;IACvC,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IACxC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;IACxC,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAC1C,CAAC,oBAAoB,EAAE,iBAAiB,CAAC;CAC1C,CAAC;AAEF,MAAM,OAAO,GAAG,qBAAqB,CAAC;AAwBtC,kDAAkD;AAClD,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,IAAc,EAAE,EAAS;IACjD,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;YACjB,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,OAAO,EAAE;gBACP,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACvB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACxB,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAChC,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClC,sBAAsB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC3C,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClC,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAChC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;gBACrC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;aACzC;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,8EAA8E;QAC9E,MAAM,OAAO,GAAI,CAAW,CAAC,OAAO,CAAC;QACrC,MAAM,OAAO,GAAG,2BAA2B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QAC3E,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC;QACvD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IACvC,MAAM,KAAK,GAAU,EAAE,CAAC,KAAK;QAC3B,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;QACtE,CAAC,CAAC,KAAK,CAAC;IACV,iEAAiE;IACjE,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,CACxB;QACE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QACnF,IAAI,KAAK,CAAC,KAAK,EAAE,mDAAmD,MAAM,cAAc,EAAE,EAAE,CAAC,EAAE;KAChG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,MAAM,EAAE,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5D,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,cAAc,EAAE,CAAC,CAAC;QAC5D,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,EAAE,CAAC,MAAM,CAAC,iCAAiC,WAAW,CAAC,MAAM,iBAAiB,SAAS,EAAE,CAAC,CAAC;QAC3F,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC/C,qDAAqD;QACrD,EAAE,CAAC,MAAM,CAAC,8DAA8D,CAAC,CAAC;QAC1E,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACtF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,EAAE,CAAC,MAAM,CAAC,GAAG,KAAK,yDAAyD,CAAC,CAAC;QAC7E,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,UAAU,EAAE,CAAC;QAC3C,EAAE,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC;QAC3C,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE,CAAC;QACpD,EAAE,CAAC,MAAM,CAAC,+CAA+C,CAAC,CAAC;QAC3D,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,WAAW,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SAC3D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAsB,CAAC;IAChD,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,kBAAwC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC9D,CAAC;IACF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,EAAE,CAAC,MAAM,CACP,uCAAuC,WAAW,aAAa,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAChG,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,gEAAgE;IAChE,IAAI,MAAuB,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7E,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;QAC3C,IAAI,WAAW,KAAK,SAAS,IAAI,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC;YACxF,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,EAAE,CAAC,MAAM,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC;QAChC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;IAC9C,MAAM,aAAa,GACjB,MAAM,CAAC,YAAY,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtF,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAClC,6EAA6E;IAC7E,MAAM,QAAQ,GACZ,MAAM,CAAC,cAAc,CAAC,KAAK,SAAS;QAClC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE;QACpC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAC;IACxC,MAAM,QAAQ,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE/F,IAAI,EAAE,CAAC,GAAG;QAAE,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,MAAM,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAY,EAAiB,EAAE;QACrD,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,+EAA+E;YAC/E,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,QAAS,EAAE,IAAI,CAAC,CAAC;YAC/C,MAAM,cAAc,GAAG,KAAK,EAAE,cAAc,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAChC,MAAM,QAAQ,CAAC,QAAS,EAAE,cAAc,CAAC,CAAC,CAAC,4CAA4C;gBACvF,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,2DAA2D;oBAC1E,iEAAiE,CACpE,CAAC;YACJ,CAAC;YACD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,QAAS,EAAE,cAAc,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YACpF,OAAO;gBACL,WAAW,EAAE;oBACX,KAAK,KAAK,SAAS;wBACjB,CAAC,CAAC,GAAG,cAAc,mBAAmB;wBACtC,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,qBAAqB,cAAc,EAAE;4BAC1D,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvE,GAAG,MAAM,CAAC,QAAQ,sBAAsB,MAAM,CAAC,aAAa,SAAS;iBACtE;gBACD,IAAI,EAAE,KAAK,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBAC5D,QAAQ;aACT,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QACvE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxE,OAAO;YACL,WAAW,EAAE;gBACX,KAAK,CAAC,QAAQ;gBACd,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;oBACxB,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,oDAAoD,CAAC,CAAC,CAAC,EAAE,CAAC;aAC5F;YACD,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,QAAQ;SACT,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,GAAS,CAAC;IACd,IAAI,IAAU,CAAC;IACf,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,kFAAkF;QAClF,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,EAAE,CAAC,MAAM,CAAC,oBAAqB,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QACtD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI;QAC1B,CAAC,KAAK,EAAE,GAAG,CAAC;QACZ,CAAC,KAAK,EAAE,IAAI,CAAC;KACL,EAAE,CAAC;QACX,EAAE,CAAC,MAAM,CACP,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,+EAA+E;IAC/E,MAAM,UAAU,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,cAAc,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACrD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEvD,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;QAClE,kBAAkB,EAAE,MAAM,CAAC,sBAAsB,CAAC;KACnD,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5E,MAAM,MAAM,GAAY;QACtB,MAAM,CAAC,EAAE;YACP,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,OAAO,EAAE,EAAE;YAC7E,CAAC,CAAC;gBACE,IAAI,EAAE,gBAAgB;gBACtB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,eAAe,OAAO,EAAE;gBACjC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;aAC1B;KACN,CAAC;IAEF,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,gBAAgB;YACtB,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,MAAM;gBAC9B,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,qCAAqC,EAAE;gBACpE,CAAC,CAAC,UAAU,CAAC,MAAM,KAAK,QAAQ;oBAC9B,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,uDAAuD,EAAE;oBACtF,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;wBACf,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,0CAA0C,EAAE;wBACzE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,EAAE,CAAC;SAChE,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IAC/E,mEAAmE;IACnE,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvF,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/F,MAAM,CAAC,IAAI,CACT,WAAW,KAAK,SAAS;QACvB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,EAAE;QAC5E,CAAC,CAAC,WAAW,CAAC,EAAE;YACd,CAAC,CAAC;gBACE,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,sBAAsB,GAAG,CAAC,IAAI,SAAS,QAAQ,GAAG;aAC5D;YACH,CAAC,CAAC;gBACE,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,mBAAmB,GAAG,CAAC,IAAI,SAAS,QAAQ,GAAG;gBACxD,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE;aAC/B,CACR,CAAC;IACF,EAAE,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEvD,+EAA+E;IAC/E,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,oCAAoC,CAAC,CAAC;QAC5D,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,4CAA4C,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACxE,CAAC;IACF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,sBAAsB,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5F,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACnC,EAAE,CAAC,MAAM,CACP,KAAK,KAAK,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC,yCAAyC,CAC5F,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,EAAE,CAAC,MAAM,CACP,WAAW,KAAK,SAAS;QACvB,CAAC,CAAC,KAAK,KAAK,CAAC,QAAQ,EAAE,oEAAoE,CAAC,EAAE;QAC9F,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,CAAC,EAAE,CACxD,CAAC;IACF,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,OAAO,CAAC,KAAa,EAAE,IAAY;IAC1C,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,2DAA2D,CAAC,CAAC;IACtF,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,cAAc,CAAC,GAAQ;IAC9B,OAAO,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,GAAQ,EAAE,SAAoB;IACrD,MAAM,OAAO,GAA2B,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;IAC/E,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvF,OAAO,CAAC,aAAa,GAAG,SAAS,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxE,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC;QAClB,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC;IACpB,CAAC;IACD,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC;IAC1B,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,OAAO;QACL,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM;YACvB,IAAI,QAAkB,CAAC;YACvB,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE;oBACnC,MAAM,EAAE,MAAM;oBACd,OAAO;oBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;iBACnE,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,sBAAsB,CAAC,kCAAkC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACvF,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,sBAAsB,CAAC,kCAAkC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;YACzF,CAAC;YACD,IAAI,IAAwD,CAAC;YAC7D,IAAI,CAAC;gBACH,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAgB,CAAC;YAChD,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,GAAG,EAAE,CAAC;YACZ,CAAC;YACD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,IAAI,IAAI,IAAI,OAAO,IAAI,IAAI,CAAC,EAAE,CAAC;gBACxF,MAAM,IAAI,sBAAsB,CAAC,2CAA2C,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC7B,+EAA+E;gBAC/E,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,eAAe,CAAC;oBAC3D,4CAA4C;qBAC3C,OAAO,CAAC,+BAA+B,EAAE,GAAG,CAAC;qBAC7C,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,OAAO,MAAM,YAAY,OAAO,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,cAAc;IAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAEzF,CAAC;IACF,OAAO,GAAG,CAAC,OAAO,CAAC;AACrB,CAAC"}

package/dist/erc7201.d.ts

@@ -0,0 +1,72 @@
+/**
+ * ERC-7201 namespaces by the slot the code really uses.
+ *
+ * OpenZeppelin matches namespaces by their `@custom:storage-location
+ * erc7201:<id>` annotation and never checks the `bytes32` slot the code assigns
+ * (`assembly { $.slot := LOCATION }`). The two can disagree. A changed
+ * constant behind an unchanged annotation moves the storage while the layout
+ * check passes; a corrected annotation over an unchanged constant leaves the
+ * storage in place while the check reports a deleted namespace. Reading the
+ * slot from the AST catches the first and fixes the second.
+ */
+import type { SolcOutput, StorageLayout } from "@openzeppelin/upgrades-core";
+export interface NamespaceSlot {
+    /** `erc7201:<id>`, as annotated. */
+    namespace: string;
+    /** The slot the annotation implies. */
+    expected: string;
+    /** The slot the code assigns, when it could be read and is unique. */
+    actual?: string;
+    /**
+     * `match`: the code uses the annotated slot. `mismatch`: it uses `actual`
+     * instead. `conflict`: it assigns different slots in different places.
+     * `unread`: no assignment was found, or one could not be evaluated.
+     */
+    status: "match" | "mismatch" | "conflict" | "unread";
+}
+/**
+ * How each of `namespaces` (`erc7201:<id>` keys of `contract`'s layout,
+ * `source.sol:Name`) is assigned in `output`. Only structs declared in the
+ * contract or its bases count, as for OpenZeppelin: a sibling contract in the
+ * same build (a V1 next to its V2, a test copy) may declare the same id.
+ */
+export declare function namespaceSlots(output: SolcOutput, contract: string, namespaces: string[]): NamespaceSlot[];
+export interface NamespacePair {
+    old?: NamespaceSlot;
+    next?: NamespaceSlot;
+    /**
+     * Why this pair fails the check: `<new>` assigns several slots (`conflict`),
+     * leaves the old data behind (`moved`), or keeps the data in place under an
+     * annotation that does not match (`mismatch`). `unread`: a slot could not be
+     * read, so the pair could not be checked.
+     */
+    problem?: "conflict" | "moved" | "mismatch" | "unread";
+}
+export interface NamespaceCheck {
+    /**
+     * `old`'s layout with each paired namespace under its name in `<new>`, for
+     * `diffLayouts`: OpenZeppelin then compares the structs of the same storage.
+     * An unpaired namespace keeps its name, so one that is really gone is still
+     * reported as deleted.
+     */
+    layout: StorageLayout;
+    /** Every namespace of either side, old and new paired when they are the same storage. */
+    pairs: NamespacePair[];
+    /** `fail` when any pair has a problem other than `unread`; `unread` when a slot could not be read. */
+    result: "pass" | "fail" | "unread";
+}
+/**
+ * Checks ERC-7201 namespaces by the slot the code uses, not the annotation
+ * OpenZeppelin goes by. An old and a new namespace are the same storage when
+ * the code uses the same slot (under the same annotation first), failing that
+ * when they share an annotation, and failing that when the new annotation
+ * names the slot where the old data is.
+ * Pass `layout` to `diffLayouts` in place of `old.layout`.
+ */
+export declare function checkNamespaces(old: {
+    layout: StorageLayout;
+    namespaces: NamespaceSlot[];
+}, next: {
+    namespaces: NamespaceSlot[];
+}): NamespaceCheck;
+//# sourceMappingURL=erc7201.d.ts.map

package/dist/erc7201.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"erc7201.d.ts","sourceRoot":"","sources":["../src/erc7201.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAW7E,MAAM,WAAW,aAAa;IAC5B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC;CACtD;AAQD;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAAE,GACnB,aAAa,EAAE,CA6FjB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,CAAC;CACxD;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,EAAE,aAAa,CAAC;IACtB,yFAAyF;IACzF,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,sGAAsG;IACtG,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,UAAU,EAAE,aAAa,EAAE,CAAA;CAAE,EAC3D,IAAI,EAAE;IAAE,UAAU,EAAE,aAAa,EAAE,CAAA;CAAE,GACpC,cAAc,CAmDhB"}