@openzeppelin/upgrades-core 1.45.0 → 1.47.0

package/dist/storage-struct-member-renamed-retyped.test.js

@@ -0,0 +1,256 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const hardhat_1 = require("hardhat");
+const utils_1 = require("solidity-ast/utils");
+const validate_1 = require("./validate");
+const overrides_1 = require("./validate/overrides");
+const src_decoder_1 = require("./src-decoder");
+const storage_1 = require("./storage");
+const layout_1 = require("./storage/layout");
+const stabilize_layout_1 = require("./utils/stabilize-layout");
+const source = 'contracts/test/StructMemberRenamedRetyped.sol';
+const test = ava_1.default;
+test.before(async (t) => {
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`${source}:StructMemberRenamedRetypedV1`);
+    if (buildInfo === undefined) {
+        throw new Error('Build info not found');
+    }
+    t.context.buildInfo = buildInfo;
+    // The source decoder always uses the original build info, since the tests below only modify the input in ways
+    // that keep line numbers unchanged.
+    const decodeSrc = (0, src_decoder_1.solcInputOutputDecoder)(buildInfo.input, buildInfo.output);
+    t.context.validate = (solcInput = buildInfo.input, solcOutput = buildInfo.output) => (0, validate_1.validate)(solcOutput, decodeSrc, buildInfo.solcVersion, solcInput);
+    const validation = t.context.validate();
+    t.context.layout = contract => validation[`${source}:${contract}`].layout;
+});
+function getStructMembers(layout, label) {
+    const members = Object.values(layout.types).find(type => type.label === label)?.members;
+    if (members === undefined || !(0, layout_1.isStructMembers)(members)) {
+        throw new Error(`Struct members not found for ${label}`);
+    }
+    return members;
+}
+/**
+ * Replaces the given comment inside a struct body with code of the same length, so that the AST offsets still line up
+ * but the text between two members is not whitespace or comments, as it would be with syntax that is not supported.
+ */
+function withUnexpectedStructSyntax(solcInput, comment) {
+    const content = solcInput.sources[source].content;
+    if (content === undefined || !content.includes(comment)) {
+        throw new Error(`Comment ${comment} not found in ${source}`);
+    }
+    const code = 'uint256 q;'.padEnd(comment.length);
+    return { ...solcInput, sources: { ...solcInput.sources, [source]: { content: content.replace(comment, code) } } };
+}
+test('layout', t => {
+    t.snapshot((0, stabilize_layout_1.stabilizeStorageLayout)(t.context.layout('StructMemberRenamedRetypedV2')));
+});
+test('upgrade ok', t => {
+    const v1 = t.context.layout('StructMemberRenamedRetypedV1');
+    const v2 = t.context.layout('StructMemberRenamedRetypedV2');
+    t.deepEqual((0, storage_1.getStorageUpgradeErrors)(v1, v2), []);
+});
+test('exact map', t => {
+    const members = getStructMembers(t.context.layout('StructMemberExactMap'), 'struct StructMemberExactMap.S');
+    t.is(members.length, 5);
+    for (const member of members) {
+        t.is(member.renamedFrom, `old_${member.label}`);
+        t.is(member.retypedFrom, undefined);
+    }
+});
+test('wrong retype', t => {
+    const v1 = t.context.layout('StructMemberBadV1');
+    const v2 = t.context.layout('StructMemberWrongRetypeV2');
+    t.like((0, storage_1.getStorageUpgradeErrors)(v1, v2), {
+        length: 1,
+        0: {
+            kind: 'typechange',
+            change: {
+                kind: 'struct members',
+                ops: {
+                    length: 1,
+                    0: { kind: 'typechange', original: { label: 'x' }, updated: { label: 'x', retypedFrom: 'address' } },
+                },
+            },
+            original: { label: 's' },
+            updated: { label: 's' },
+        },
+    });
+});
+test('retype with layout change', t => {
+    // A retype annotation that names the original type does not allow the member's size to change
+    const v1 = t.context.layout('StructMemberRetypeLayoutChangeV1');
+    const v2 = t.context.layout('StructMemberRetypeLayoutChangeV2');
+    t.like((0, storage_1.getStorageUpgradeErrors)(v1, v2), {
+        length: 1,
+        0: {
+            kind: 'typechange',
+            change: {
+                kind: 'struct members',
+                ops: {
+                    length: 1,
+                    0: {
+                        kind: 'layoutchange',
+                        original: { label: 'y' },
+                        updated: { label: 'y', retypedFrom: 'uint256' },
+                        change: { bytes: { from: '32', to: '16' } },
+                    },
+                },
+            },
+            original: { label: 's' },
+            updated: { label: 's' },
+        },
+    });
+});
+test('annotation on the wrong member', t => {
+    // The annotation makes `x` match the original `y` with a different type, and `x` and `z` are left unmatched
+    const v1 = t.context.layout('StructMemberBadV1');
+    const v2 = t.context.layout('StructMemberWrongMemberV2');
+    t.like((0, storage_1.getStorageUpgradeErrors)(v1, v2), {
+        length: 1,
+        0: {
+            kind: 'typechange',
+            change: {
+                kind: 'struct members',
+                ops: {
+                    length: 3,
+                    0: { kind: 'delete', original: { label: 'x' } },
+                    1: { kind: 'typechange', original: { label: 'y' }, updated: { label: 'x', renamedFrom: 'y' } },
+                    2: { kind: 'insert', updated: { label: 'z' } },
+                },
+            },
+            original: { label: 's' },
+            updated: { label: 's' },
+        },
+    });
+});
+test('stale rename annotation', t => {
+    const v1 = t.context.layout('StructMemberBadV1');
+    const v2 = t.context.layout('StructMemberStaleRenameV2');
+    t.like((0, storage_1.getStorageUpgradeErrors)(v1, v2), {
+        length: 1,
+        0: {
+            kind: 'typechange',
+            change: {
+                kind: 'struct members',
+                ops: {
+                    length: 1,
+                    0: { kind: 'rename', original: { label: 'y' }, updated: { label: 'y', renamedFrom: 'q' } },
+                },
+            },
+            original: { label: 's' },
+            updated: { label: 's' },
+        },
+    });
+});
+test('unannotated rename and retype', t => {
+    const v1 = t.context.layout('StructMemberBadV1');
+    const v2 = t.context.layout('StructMemberUnannotatedV2');
+    t.like((0, storage_1.getStorageUpgradeErrors)(v1, v2), {
+        length: 1,
+        0: {
+            kind: 'typechange',
+            change: {
+                kind: 'struct members',
+                ops: {
+                    length: 2,
+                    0: { kind: 'typechange', original: { label: 'x' }, updated: { label: 'x' } },
+                    1: { kind: 'rename', original: { label: 'y' }, updated: { label: 'z' } },
+                },
+            },
+            original: { label: 's' },
+            updated: { label: 's' },
+        },
+    });
+});
+test('annotated members without layout info', t => {
+    // Without the compiler's storage layout, members have no slots. A retype that is not known to be compatible is then uncertain.
+    const solcOutput = JSON.parse(JSON.stringify(t.context.buildInfo.output));
+    for (const contracts of Object.values(solcOutput.contracts)) {
+        for (const contract of Object.values(contracts)) {
+            delete contract.storageLayout;
+        }
+    }
+    const validation = t.context.validate(undefined, solcOutput);
+    const v1 = validation[`${source}:StructMemberRenamedRetypedV1`].layout;
+    const v2 = validation[`${source}:StructMemberRenamedRetypedV2`].layout;
+    const report = (0, storage_1.getStorageUpgradeReport)(v1, v2, (0, overrides_1.withValidationDefaults)({}));
+    t.false(report.ok);
+    t.like(report.ops, {
+        length: 4,
+        0: { kind: 'typechange', original: { label: 's' } },
+        1: { kind: 'typechange', original: { label: 'm' } },
+        2: { kind: 'typechange', original: { label: 'arr' } },
+        3: { kind: 'typechange', original: { label: 'other' } },
+    });
+    t.true(report.explain().includes('Layout could have changed for `x` (bytes32 -> struct TransientSlot.TBytes32)'), report.explain());
+    t.snapshot(report.explain());
+});
+test('annotations are not read without source content', t => {
+    const { input } = t.context.buildInfo;
+    const sources = Object.fromEntries(Object.keys(input.sources).map(path => [path, {}]));
+    const validation = t.context.validate({ ...input, sources });
+    const v1 = validation[`${source}:StructMemberRenamedRetypedV1`].layout;
+    const v2 = validation[`${source}:StructMemberRenamedRetypedV2`].layout;
+    t.like((0, storage_1.getStorageUpgradeErrors)(v1, v2), {
+        length: 5,
+        0: { kind: 'typechange', original: { label: 's' } },
+        1: { kind: 'typechange', original: { label: 'm' } },
+        2: { kind: 'typechange', original: { label: 'arr' } },
+        3: { kind: 'typechange', original: { label: 'outer' } },
+        4: { kind: 'typechange', original: { label: 'other' } },
+    });
+});
+test('unexpected syntax in struct with annotations', t => {
+    const { input, output } = t.context.buildInfo;
+    const structDef = [...(0, utils_1.findAll)('StructDefinition', output.sources[source].ast)].find(s => s.canonicalName === 'StructMemberUnreadableAnnotated.S');
+    if (structDef === undefined) {
+        throw new Error('Struct not found');
+    }
+    const structSrc = (0, src_decoder_1.solcInputOutputDecoder)(input, output)(structDef);
+    const error = t.throws(() => t.context.validate(withUnexpectedStructSyntax(input, '// 12345678')));
+    t.true(error?.message.includes(`${structSrc}: Could not read storage annotations on members of struct \`StructMemberUnreadableAnnotated.S\``), error?.message);
+    t.true(error?.message.includes('Please report this at https://zpl.in/upgrades/report and include the struct definition from your contract.'), error?.message);
+});
+test('unexpected syntax in struct without annotations', t => {
+    const validation = t.context.validate(withUnexpectedStructSyntax(t.context.buildInfo.input, '// 87654321'));
+    const layout = validation[`${source}:StructMemberUnreadableUnannotated`].layout;
+    t.like(getStructMembers(layout, 'struct StructMemberUnreadableUnannotated.S'), {
+        length: 2,
+        0: { label: 'b', renamedFrom: undefined, retypedFrom: undefined },
+        1: { label: 'c', renamedFrom: undefined, retypedFrom: undefined },
+    });
+    // Other structs are unaffected
+    const v1 = validation[`${source}:StructMemberRenamedRetypedV1`].layout;
+    const v2 = validation[`${source}:StructMemberRenamedRetypedV2`].layout;
+    t.deepEqual((0, storage_1.getStorageUpgradeErrors)(v1, v2), []);
+});
+test('unexpected syntax in struct with other annotations', t => {
+    const validation = t.context.validate(withUnexpectedStructSyntax(t.context.buildInfo.input, '// 13572468'));
+    const layout = validation[`${source}:StructMemberUnreadableOtherAnnotation`].layout;
+    t.like(getStructMembers(layout, 'struct StructMemberUnreadableOtherAnnotation.S'), {
+        length: 2,
+        0: { label: 'b', renamedFrom: undefined, retypedFrom: undefined },
+        1: { label: 'c', renamedFrom: undefined, retypedFrom: undefined },
+    });
+});
+test('multiple annotations in a doc block without line prefixes', t => {
+    const layout = t.context.layout('StateVariableDocBlock');
+    t.like(layout.storage, { length: 1, 0: { label: 'x', renamedFrom: 'a', retypedFrom: 'uint8' } });
+});
+test('stale rename annotation report', t => {
+    const v1 = t.context.layout('StructMemberBadV1');
+    const v2 = t.context.layout('StructMemberStaleRenameV2');
+    const report = (0, storage_1.getStorageUpgradeReport)(v1, v2, (0, overrides_1.withValidationDefaults)({}));
+    t.false(report.ok);
+    t.is(report.explain(), `${v2.storage[0].src}: Upgraded \`s\` to an incompatible type\n` +
+        '  - Bad upgrade from struct StructMemberBadV1.S to struct StructMemberStaleRenameV2.S\n' +
+        '  - In struct StructMemberStaleRenameV2.S\n' +
+        "    - `y` has a '@custom:oz-renamed-from q' annotation, but it was not renamed\n" +
+        '      > If the annotation is left over from an earlier upgrade, remove it.');
+});
+//# sourceMappingURL=storage-struct-member-renamed-retyped.test.js.map

package/dist/storage-struct-member-renamed-retyped.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-struct-member-renamed-retyped.test.js","sourceRoot":"","sources":["../src/storage-struct-member-renamed-retyped.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAoC;AACpC,qCAAoC;AAEpC,8CAA6C;AAG7C,yCAAyD;AACzD,oDAA8D;AAC9D,+CAAuD;AACvD,uCAA6E;AAC7E,6CAAkE;AAClE,+DAAkE;AAElE,MAAM,MAAM,GAAG,+CAA+C,CAAC;AAQ/D,MAAM,IAAI,GAAG,aAAwB,CAAC;AAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;IACpB,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC;IACzF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IACD,CAAC,CAAC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAChC,8GAA8G;IAC9G,oCAAoC;IACpC,MAAM,SAAS,GAAG,IAAA,oCAAsB,EAAC,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC5E,CAAC,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,CAClF,IAAA,mBAAQ,EAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACxC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,SAAS,gBAAgB,CAAC,MAAqB,EAAE,KAAa;IAC5D,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,OAAO,CAAC;IACxF,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,IAAA,wBAAe,EAAC,OAAO,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,0BAA0B,CAAC,SAAoB,EAAE,OAAe;IACvE,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;IAClD,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,iBAAiB,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,OAAO,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC;AACpH,CAAC;AAED,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE;IACjB,CAAC,CAAC,QAAQ,CAAC,IAAA,yCAAsB,EAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC;AACvF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE;IACrB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC;IAC5D,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC;IAC5D,CAAC,CAAC,SAAS,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;IACpB,MAAM,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE,+BAA+B,CAAC,CAAC;IAC5G,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACxB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAChD,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACtC,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE;IACvB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC;IACzD,CAAC,CAAC,IAAI,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACtC,MAAM,EAAE,CAAC;QACT,CAAC,EAAE;YACD,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,gBAAgB;gBACtB,GAAG,EAAE;oBACH,MAAM,EAAE,CAAC;oBACT,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;iBACrG;aACF;YACD,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACxB,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACxB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAC,EAAE;IACpC,8FAA8F;IAC9F,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAC;IAChE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAC;IAChE,CAAC,CAAC,IAAI,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACtC,MAAM,EAAE,CAAC;QACT,CAAC,EAAE;YACD,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,gBAAgB;gBACtB,GAAG,EAAE;oBACH,MAAM,EAAE,CAAC;oBACT,CAAC,EAAE;wBACD,IAAI,EAAE,cAAc;wBACpB,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;wBACxB,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE;wBAC/C,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;qBAC5C;iBACF;aACF;YACD,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACxB,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACxB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gCAAgC,EAAE,CAAC,CAAC,EAAE;IACzC,4GAA4G;IAC5G,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC;IACzD,CAAC,CAAC,IAAI,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACtC,MAAM,EAAE,CAAC;QACT,CAAC,EAAE;YACD,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,gBAAgB;gBACtB,GAAG,EAAE;oBACH,MAAM,EAAE,CAAC;oBACT,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;oBAC/C,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE;oBAC9F,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;iBAC/C;aACF;YACD,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACxB,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACxB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yBAAyB,EAAE,CAAC,CAAC,EAAE;IAClC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC;IACzD,CAAC,CAAC,IAAI,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACtC,MAAM,EAAE,CAAC;QACT,CAAC,EAAE;YACD,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,gBAAgB;gBACtB,GAAG,EAAE;oBACH,MAAM,EAAE,CAAC;oBACT,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE;iBAC3F;aACF;YACD,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACxB,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACxB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+BAA+B,EAAE,CAAC,CAAC,EAAE;IACxC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC;IACzD,CAAC,CAAC,IAAI,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACtC,MAAM,EAAE,CAAC;QACT,CAAC,EAAE;YACD,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,gBAAgB;gBACtB,GAAG,EAAE;oBACH,MAAM,EAAE,CAAC;oBACT,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;oBAC5E,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;iBACzE;aACF;YACD,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACxB,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACxB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uCAAuC,EAAE,CAAC,CAAC,EAAE;IAChD,+HAA+H;IAC/H,MAAM,UAAU,GAAe,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IACtF,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5D,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAChD,OAAO,QAAQ,CAAC,aAAa,CAAC;QAChC,CAAC;IACH,CAAC;IACD,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC7D,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC,MAAM,CAAC;IACvE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC,MAAM,CAAC;IACvE,MAAM,MAAM,GAAG,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,EAAE,IAAA,kCAAsB,EAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACjB,MAAM,EAAE,CAAC;QACT,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACnD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACnD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;QACrD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;KACxD,CAAC,CAAC;IACH,CAAC,CAAC,IAAI,CACJ,MAAM,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,8EAA8E,CAAC,EACzG,MAAM,CAAC,OAAO,EAAE,CACjB,CAAC;IACF,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iDAAiD,EAAE,CAAC,CAAC,EAAE;IAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IACtC,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACvF,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7D,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC,MAAM,CAAC;IACvE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC,MAAM,CAAC;IACvE,CAAC,CAAC,IAAI,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACtC,MAAM,EAAE,CAAC;QACT,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACnD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACnD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;QACrD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACvD,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;KACxD,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8CAA8C,EAAE,CAAC,CAAC,EAAE;IACvD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC9C,MAAM,SAAS,GAAG,CAAC,GAAG,IAAA,eAAO,EAAC,kBAAkB,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CACjF,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,mCAAmC,CAC7D,CAAC;IACF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,SAAS,GAAG,IAAA,oCAAsB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;IAEnE,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC,CAAC,IAAI,CACJ,KAAK,EAAE,OAAO,CAAC,QAAQ,CACrB,GAAG,SAAS,iGAAiG,CAC9G,EACD,KAAK,EAAE,OAAO,CACf,CAAC;IACF,CAAC,CAAC,IAAI,CACJ,KAAK,EAAE,OAAO,CAAC,QAAQ,CACrB,4GAA4G,CAC7G,EACD,KAAK,EAAE,OAAO,CACf,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iDAAiD,EAAE,CAAC,CAAC,EAAE;IAC1D,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAC5G,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,MAAM,oCAAoC,CAAC,CAAC,MAAM,CAAC;IAChF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,4CAA4C,CAAC,EAAE;QAC7E,MAAM,EAAE,CAAC;QACT,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE;QACjE,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE;KAClE,CAAC,CAAC;IACH,+BAA+B;IAC/B,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC,MAAM,CAAC;IACvE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC,MAAM,CAAC;IACvE,CAAC,CAAC,SAAS,CAAC,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oDAAoD,EAAE,CAAC,CAAC,EAAE;IAC7D,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAC5G,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,MAAM,wCAAwC,CAAC,CAAC,MAAM,CAAC;IACpF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,gDAAgD,CAAC,EAAE;QACjF,MAAM,EAAE,CAAC;QACT,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE;QACjE,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE;KAClE,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2DAA2D,EAAE,CAAC,CAAC,EAAE;IACpE,MAAM,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;IACzD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;AACnG,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gCAAgC,EAAE,CAAC,CAAC,EAAE;IACzC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAA,iCAAuB,EAAC,EAAE,EAAE,EAAE,EAAE,IAAA,kCAAsB,EAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC,EAAE,CACF,MAAM,CAAC,OAAO,EAAE,EAChB,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,4CAA4C;QAC9D,yFAAyF;QACzF,6CAA6C;QAC7C,kFAAkF;QAClF,4EAA4E,CAC/E,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/utils/annotations.d.ts

@@ -1,4 +1,5 @@
 import { Node } from 'solidity-ast/node';
+export declare const ANNOTATION_REGEX: RegExp;
 /**
  * Whether the given doc string has an annotation tag.
  */

package/dist/utils/annotations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../src/utils/annotations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAEzC;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAGlE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,YAuB5F;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,UAM1C"}
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../src/utils/annotations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAGzC,eAAO,MAAM,gBAAgB,QAAqF,CAAC;AAEnH;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAGlE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,YAoB5F;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,UAM1C"}

package/dist/utils/annotations.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ANNOTATION_REGEX = void 0;
 exports.hasAnnotationTag = hasAnnotationTag;
 exports.getAnnotationArgs = getAnnotationArgs;
 exports.getDocumentation = getDocumentation;
 const execall_1 = require("./execall");
+// Matches one NatSpec tag: `@title:tag args`, where the args run until the next line that starts with a tag
+exports.ANNOTATION_REGEX = /^\s*(?:@(?<title>\w+)(?::(?<tag>[a-z][a-z-]*))? )?(?<args>(?:(?!^\s*@\w+)[^])*)/m;
 /**
  * Whether the given doc string has an annotation tag.
  */
@@ -20,7 +23,7 @@ function hasAnnotationTag(doc, tag) {
  */
 function getAnnotationArgs(doc, tag, supportedArgs) {
     const result = [];
-    for (const { groups } of (0, execall_1.execall)(/^\s*(?:@(?<title>\w+)(?::(?<tag>[a-z][a-z-]*))? )?(?<args>(?:(?!^\s*@\w+)[^])*)/m, doc)) {
+    for (const { groups } of (0, execall_1.execall)(exports.ANNOTATION_REGEX, doc)) {
         if (groups && groups.title === 'custom' && groups.tag === tag) {
             const trimmedArgs = groups.args.trim();
             if (trimmedArgs.length > 0) {

package/dist/utils/annotations.js.map

@@ -1 +1 @@
-{"version":3,"file":"annotations.js","sourceRoot":"","sources":["../../src/utils/annotations.ts"],"names":[],"mappings":";;AAMA,4CAGC;AASD,8CAuBC;AAOD,4CAMC;AAtDD,uCAAoC;AAGpC;;GAEG;AACH,SAAgB,gBAAgB,CAAC,GAAW,EAAE,GAAW;IACvD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,iBAAiB,GAAG,UAAU,EAAE,GAAG,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,GAAW,EAAE,GAAW,EAAE,aAAiC;IAC3F,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAA,iBAAO,EAC9B,kFAAkF,EAClF,GAAG,CACJ,EAAE,CAAC;QACF,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YAC9D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACvC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACnB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,6BAA6B,GAAG,EAAE,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAU;IACzC,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACxG,CAAC;SAAM,CAAC;QACN,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}
+{"version":3,"file":"annotations.js","sourceRoot":"","sources":["../../src/utils/annotations.ts"],"names":[],"mappings":";;;AASA,4CAGC;AASD,8CAoBC;AAOD,4CAMC;AAtDD,uCAAoC;AAGpC,4GAA4G;AAC/F,QAAA,gBAAgB,GAAG,kFAAkF,CAAC;AAEnH;;GAEG;AACH,SAAgB,gBAAgB,CAAC,GAAW,EAAE,GAAW;IACvD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,iBAAiB,GAAG,UAAU,EAAE,GAAG,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,GAAW,EAAE,GAAW,EAAE,aAAiC;IAC3F,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,IAAA,iBAAO,EAAC,wBAAgB,EAAE,GAAG,CAAC,EAAE,CAAC;QACxD,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YAC9D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACvC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACnB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,6BAA6B,GAAG,EAAE,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAU;IACzC,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACxG,CAAC;SAAM,CAAC;QACN,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/utils/erc7201-builtin.d.ts

@@ -0,0 +1,24 @@
+import { Expression } from 'solidity-ast';
+/**
+ * Recognizes the Solidity 0.8.35+ `erc7201(string)` comptime builtin, which evaluates the ERC-7201
+ * storage location for a namespace id and can be used in a compile-time context such as a `layout at`
+ * specifier (e.g. `contract C layout at erc7201("example.main")`).
+ *
+ * The builtin compiles to an ordinary `FunctionCall` node, so it is matched by its shape rather than
+ * by a dedicated AST node type.
+ *
+ * @param node The expression to check.
+ * @returns The namespace id passed to the builtin (without the `erc7201:` prefix), or undefined if the
+ *   expression is not a call to the `erc7201` builtin with a single string literal argument.
+ */
+export declare function getErc7201BuiltinNamespaceId(node: Expression): string | undefined;
+/**
+ * Resolves an expression to its base slot as a normalized uint256 hex string, for either a numeric
+ * literal or an `erc7201(...)` builtin call.
+ *
+ * @param node The expression to resolve.
+ * @returns The normalized base slot hex string, or undefined if the expression is neither a numeric
+ *   literal nor a resolvable `erc7201(...)` builtin call.
+ */
+export declare function resolveBaseSlot(node: Expression): string | undefined;
+//# sourceMappingURL=erc7201-builtin.d.ts.map

package/dist/utils/erc7201-builtin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"erc7201-builtin.d.ts","sourceRoot":"","sources":["../../src/utils/erc7201-builtin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAW,MAAM,cAAc,CAAC;AAKnD;;;;;;;;;;;GAWG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAmCjF;AAUD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAWpE"}

package/dist/utils/erc7201-builtin.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErc7201BuiltinNamespaceId = getErc7201BuiltinNamespaceId;
+exports.resolveBaseSlot = resolveBaseSlot;
+const erc7201_1 = require("./erc7201");
+const integer_literals_1 = require("./integer-literals");
+const error_1 = require("../error");
+/**
+ * Recognizes the Solidity 0.8.35+ `erc7201(string)` comptime builtin, which evaluates the ERC-7201
+ * storage location for a namespace id and can be used in a compile-time context such as a `layout at`
+ * specifier (e.g. `contract C layout at erc7201("example.main")`).
+ *
+ * The builtin compiles to an ordinary `FunctionCall` node, so it is matched by its shape rather than
+ * by a dedicated AST node type.
+ *
+ * @param node The expression to check.
+ * @returns The namespace id passed to the builtin (without the `erc7201:` prefix), or undefined if the
+ *   expression is not a call to the `erc7201` builtin with a single string literal argument.
+ */
+function getErc7201BuiltinNamespaceId(node) {
+    // Check that this is a function call to an identifier named `erc7201`. Return undefined for
+    // anything else so the caller can fall through to other base-slot forms.
+    if (node.nodeType !== 'FunctionCall' || node.kind !== 'functionCall') {
+        return undefined;
+    }
+    const callee = node.expression;
+    if (callee.nodeType !== 'Identifier' || callee.name !== 'erc7201') {
+        return undefined;
+    }
+    // Beyond this point, the call is to `erc7201(...)`. Check its expected shape — one string-literal
+    // argument with no user-defined declaration shadowing the builtin — and throw if anything is off.
+    // Valid Solidity 0.8.35+ cannot produce these mismatches in a call to the builtin:
+    //   - User-defined `erc7201` (`referencedDeclaration >= 0`): solc resolves the call to the builtin
+    //     when both are in scope, so this shape doesn't reach a successful compile.
+    //   - Wrong number of arguments: enforced by the builtin's signature.
+    //   - Non-`Literal` argument or non-string literal `kind`: the builtin's signature requires a
+    //     comptime-constant string literal. `hex"..."` is type `bytes` and wouldn't typecheck.
+    // We throw instead of returning undefined so a future solc emitting one of these surfaces loudly.
+    if (typeof callee.referencedDeclaration === 'number' && callee.referencedDeclaration >= 0) {
+        throw unexpectedErc7201BuiltinAst('callee resolves to a user-defined declaration');
+    }
+    if (node.arguments.length !== 1) {
+        throw unexpectedErc7201BuiltinAst(`expected 1 argument, got ${node.arguments.length}`);
+    }
+    const arg = node.arguments[0];
+    if (arg.nodeType !== 'Literal') {
+        throw unexpectedErc7201BuiltinAst(`argument is ${arg.nodeType}, expected Literal`);
+    }
+    if (arg.kind !== 'string' && arg.kind !== 'unicodeString') {
+        throw unexpectedErc7201BuiltinAst(`argument literal kind is ${arg.kind}, expected string or unicodeString`);
+    }
+    return getStringLiteralValue(arg);
+}
+function unexpectedErc7201BuiltinAst(detail) {
+    return new error_1.UpgradesError(`Unexpected AST for \`erc7201(...)\` builtin call: ${detail}`, () => 'Please report this at https://zpl.in/upgrades/report and include the `erc7201(...)` expression from your contract.');
+}
+/**
+ * Resolves an expression to its base slot as a normalized uint256 hex string, for either a numeric
+ * literal or an `erc7201(...)` builtin call.
+ *
+ * @param node The expression to resolve.
+ * @returns The normalized base slot hex string, or undefined if the expression is neither a numeric
+ *   literal nor a resolvable `erc7201(...)` builtin call.
+ */
+function resolveBaseSlot(node) {
+    if (node.nodeType === 'Literal') {
+        return (0, integer_literals_1.normalizeUint256Literal)(node.value);
+    }
+    const id = getErc7201BuiltinNamespaceId(node);
+    if (id !== undefined) {
+        return (0, erc7201_1.calculateERC7201StorageLocation)(id);
+    }
+    return undefined;
+}
+function getStringLiteralValue(literal) {
+    // solc populates `value` for `kind: 'string'`/`'unicodeString'` literals; throw defensively if
+    // a future solc ever produces a null/missing `value` for such a literal.
+    if (literal.value === undefined || literal.value === null) {
+        throw unexpectedErc7201BuiltinAst('string literal `value` is null or missing');
+    }
+    return literal.value;
+}
+//# sourceMappingURL=erc7201-builtin.js.map

package/dist/utils/erc7201-builtin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"erc7201-builtin.js","sourceRoot":"","sources":["../../src/utils/erc7201-builtin.ts"],"names":[],"mappings":";;AAiBA,oEAmCC;AAkBD,0CAWC;AAhFD,uCAA4D;AAC5D,yDAA6D;AAC7D,oCAAyC;AAEzC;;;;;;;;;;;GAWG;AACH,SAAgB,4BAA4B,CAAC,IAAgB;IAC3D,4FAA4F;IAC5F,yEAAyE;IACzE,IAAI,IAAI,CAAC,QAAQ,KAAK,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;IAC/B,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,kGAAkG;IAClG,kGAAkG;IAClG,mFAAmF;IACnF,mGAAmG;IACnG,gFAAgF;IAChF,sEAAsE;IACtE,8FAA8F;IAC9F,2FAA2F;IAC3F,kGAAkG;IAClG,IAAI,OAAO,MAAM,CAAC,qBAAqB,KAAK,QAAQ,IAAI,MAAM,CAAC,qBAAqB,IAAI,CAAC,EAAE,CAAC;QAC1F,MAAM,2BAA2B,CAAC,+CAA+C,CAAC,CAAC;IACrF,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,2BAA2B,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,2BAA2B,CAAC,eAAe,GAAG,CAAC,QAAQ,oBAAoB,CAAC,CAAC;IACrF,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAC1D,MAAM,2BAA2B,CAAC,4BAA4B,GAAG,CAAC,IAAI,oCAAoC,CAAC,CAAC;IAC9G,CAAC;IAED,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,2BAA2B,CAAC,MAAc;IACjD,OAAO,IAAI,qBAAa,CACtB,qDAAqD,MAAM,EAAE,EAC7D,GAAG,EAAE,CACH,oHAAoH,CACvH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,IAAgB;IAC9C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,IAAA,0CAAuB,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,EAAE,GAAG,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,IAAA,yCAA+B,EAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAgB;IAC7C,+FAA+F;IAC/F,yEAAyE;IACzE,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1D,MAAM,2BAA2B,CAAC,2CAA2C,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC;AACvB,CAAC"}

package/dist/utils/erc7201.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"erc7201.d.ts","sourceRoot":"","sources":["../../src/utils/erc7201.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB,aAAa,CAAC;AAEjD;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAalE"}
+{"version":3,"file":"erc7201.d.ts","sourceRoot":"","sources":["../../src/utils/erc7201.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,sBAAsB,aAAa,CAAC;AAEjD;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAalE"}

package/dist/utils/erc7201.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ERC7201_FORMULA_PREFIX = void 0;
 exports.calculateERC7201StorageLocation = calculateERC7201StorageLocation;
 const ethereumjs_util_1 = require("ethereumjs-util");
+const integer_literals_1 = require("./integer-literals");
 exports.ERC7201_FORMULA_PREFIX = 'erc7201:';
 /**
  * Returns the ERC-7201 storage location hash for a given namespace id using formula:
@@ -14,11 +15,12 @@ exports.ERC7201_FORMULA_PREFIX = 'erc7201:';
 function calculateERC7201StorageLocation(id) {
     const firstHash = (0, ethereumjs_util_1.keccak256)(Buffer.from(id));
     const minusOne = BigInt(`0x${firstHash.toString('hex')}`) - 1n;
-    const minusOneBuffer = Buffer.from(minusOne.toString(16), 'hex');
+    // Pad to 64 hex chars so that `Buffer.from` doesn't silently truncate odd-length input;
+    // `abi.encode(uint256)` is always 32 bytes.
+    const minusOneBuffer = Buffer.from(minusOne.toString(16).padStart(64, '0'), 'hex');
     const secondHash = (0, ethereumjs_util_1.keccak256)(minusOneBuffer);
     const mask = BigInt('0xff');
     const masked = BigInt(`0x${secondHash.toString('hex')}`) & ~mask;
-    const padded = masked.toString(16).padStart(64, '0');
-    return `0x${padded}`;
+    return (0, integer_literals_1.toBytes32Hex)(masked);
 }
 //# sourceMappingURL=erc7201.js.map

package/dist/utils/erc7201.js.map

@@ -1 +1 @@
-{"version":3,"file":"erc7201.js","sourceRoot":"","sources":["../../src/utils/erc7201.ts"],"names":[],"mappings":";;;AAWA,0EAaC;AAxBD,qDAA4C;AAE/B,QAAA,sBAAsB,GAAG,UAAU,CAAC;AAEjD;;;;;;GAMG;AACH,SAAgB,+BAA+B,CAAC,EAAU;IACxD,MAAM,SAAS,GAAG,IAAA,2BAAS,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IAC/D,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAEjE,MAAM,UAAU,GAAG,IAAA,2BAAS,EAAC,cAAc,CAAC,CAAC;IAE7C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;IAEjE,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAErD,OAAO,KAAK,MAAM,EAAE,CAAC;AACvB,CAAC"}
+{"version":3,"file":"erc7201.js","sourceRoot":"","sources":["../../src/utils/erc7201.ts"],"names":[],"mappings":";;;AAaA,0EAaC;AA1BD,qDAA4C;AAE5C,yDAAkD;AAErC,QAAA,sBAAsB,GAAG,UAAU,CAAC;AAEjD;;;;;;GAMG;AACH,SAAgB,+BAA+B,CAAC,EAAU;IACxD,MAAM,SAAS,GAAG,IAAA,2BAAS,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IAC/D,wFAAwF;IACxF,4CAA4C;IAC5C,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAEnF,MAAM,UAAU,GAAG,IAAA,2BAAS,EAAC,cAAc,CAAC,CAAC;IAE7C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;IAEjE,OAAO,IAAA,+BAAY,EAAC,MAAM,CAAC,CAAC;AAC9B,CAAC"}

package/dist/utils/erc7201.test.js

@@ -8,4 +8,14 @@ const erc7201_1 = require("./erc7201");
 (0, ava_1.default)('calculateERC7201StorageLocation', t => {
     t.is((0, erc7201_1.calculateERC7201StorageLocation)('example.main'), '0x183a6125c38840424c4a85fa12bab2ab606c4b6d0e7cc73c0c06ba5300eab500');
 });
+// `keccak256("ns2") - 1` is 63 hex chars (odd-length), which must be zero-padded to 32 bytes
+// before hashing. Regression test for truncation of the intermediate buffer.
+(0, ava_1.default)('calculateERC7201StorageLocation - odd-length intermediate hash', t => {
+    t.is((0, erc7201_1.calculateERC7201StorageLocation)('ns2'), '0xa61069020885c09e922542fb3fa98c8d50e6481fc1251ff86c3319a70f0f7d00');
+});
+// `keccak256("ns297") - 1` is 62 hex chars (i.e., its top byte is `0x00`). Without zero-padding,
+// `Buffer.from('hex')` would interpret it as a 31-byte buffer rather than 32, producing the wrong hash.
+(0, ava_1.default)('calculateERC7201StorageLocation - leading-zero-byte intermediate hash', t => {
+    t.is((0, erc7201_1.calculateERC7201StorageLocation)('ns297'), '0xe06f9faa11c8032ea604e1764972c1a5594987f1678d8fabf921c28d1a7a4c00');
+});
 //# sourceMappingURL=erc7201.test.js.map

package/dist/utils/erc7201.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"erc7201.test.js","sourceRoot":"","sources":["../../src/utils/erc7201.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AAEvB,uCAA4D;AAE5D,IAAA,aAAI,EAAC,iCAAiC,EAAE,CAAC,CAAC,EAAE;IAC1C,CAAC,CAAC,EAAE,CACF,IAAA,yCAA+B,EAAC,cAAc,CAAC,EAC/C,oEAAoE,CACrE,CAAC;AACJ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"erc7201.test.js","sourceRoot":"","sources":["../../src/utils/erc7201.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AAEvB,uCAA4D;AAE5D,IAAA,aAAI,EAAC,iCAAiC,EAAE,CAAC,CAAC,EAAE;IAC1C,CAAC,CAAC,EAAE,CACF,IAAA,yCAA+B,EAAC,cAAc,CAAC,EAC/C,oEAAoE,CACrE,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,6FAA6F;AAC7F,6EAA6E;AAC7E,IAAA,aAAI,EAAC,gEAAgE,EAAE,CAAC,CAAC,EAAE;IACzE,CAAC,CAAC,EAAE,CAAC,IAAA,yCAA+B,EAAC,KAAK,CAAC,EAAE,oEAAoE,CAAC,CAAC;AACrH,CAAC,CAAC,CAAC;AAEH,iGAAiG;AACjG,wGAAwG;AACxG,IAAA,aAAI,EAAC,uEAAuE,EAAE,CAAC,CAAC,EAAE;IAChF,CAAC,CAAC,EAAE,CAAC,IAAA,yCAA+B,EAAC,OAAO,CAAC,EAAE,oEAAoE,CAAC,CAAC;AACvH,CAAC,CAAC,CAAC"}

package/dist/utils/integer-literals.d.ts

@@ -1,15 +1,28 @@
 /**
- * Converts a Solidity unsigned integer literal according to https://docs.soliditylang.org/en/latest/types.html#rational-literals
- * to a 64-byte padded hex string.
+ * Encodes a bigint as a 0x-prefixed, 64-char lowercase hex string — the canonical text encoding of
+ * a `bytes32` value, used throughout this package for storage slots and similar 256-bit identifiers.
+ * Throws if the value is outside the 0..2^256-1 range, since that almost certainly indicates a bug
+ * upstream (overflow, wrong hash, etc.) and would silently produce a string longer than 64 chars.
  *
- * Accepts decimal, hexadecimal, and scientific notation formats.
+ * @param value bigint value to encode
+ * @returns 0x-prefixed, 64-char lowercase hex string
+ */
+export declare function toBytes32Hex(value: bigint): string;
+/**
+ * Parses a Solidity unsigned integer literal source string (per
+ * https://docs.soliditylang.org/en/latest/types.html#rational-literals) and returns it in the
+ * canonical hex form produced by {@link toBytes32Hex}.
+ *
+ * Parsing is delegated to {@link BigNumber}, which accepts decimal (`1000`), hex (`0x1f`), and
+ * scientific notation (`1e18`). Underscore separators and uppercase digits, which BigNumber rejects
+ * but Solidity allows, are stripped/lowercased first. Non-integer results (e.g. `1.5e3`) are rejected.
  *
- * If the input is null or undefined, returns '0x0000000000000000000000000000000000000000000000000000000000000000'.
+ * If the input is null or undefined, returns the canonical hex form of zero.
  *
  * Assumes the input is a valid uint256-compatible literal for Solidity, and only performs minimal validation.
  *
- * @param literal Integer literal to convert
- * @returns Hex string with 0x prefix, padded to 64 bytes with leading zeroes
+ * @param literal Integer literal source string to parse
+ * @returns 0x-prefixed, 64-char lowercase hex string
  */
 export declare function normalizeUint256Literal(literal: string | null | undefined): string;
 //# sourceMappingURL=integer-literals.d.ts.map

package/dist/utils/integer-literals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"integer-literals.d.ts","sourceRoot":"","sources":["../../src/utils/integer-literals.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAalF"}
+{"version":3,"file":"integer-literals.d.ts","sourceRoot":"","sources":["../../src/utils/integer-literals.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAKlD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAWlF"}

package/dist/utils/integer-literals.js

@@ -3,32 +3,50 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBytes32Hex = toBytes32Hex;
 exports.normalizeUint256Literal = normalizeUint256Literal;
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const MAX_UINT256 = (1n << 256n) - 1n;
 /**
- * Converts a Solidity unsigned integer literal according to https://docs.soliditylang.org/en/latest/types.html#rational-literals
- * to a 64-byte padded hex string.
+ * Encodes a bigint as a 0x-prefixed, 64-char lowercase hex string — the canonical text encoding of
+ * a `bytes32` value, used throughout this package for storage slots and similar 256-bit identifiers.
+ * Throws if the value is outside the 0..2^256-1 range, since that almost certainly indicates a bug
+ * upstream (overflow, wrong hash, etc.) and would silently produce a string longer than 64 chars.
  *
- * Accepts decimal, hexadecimal, and scientific notation formats.
+ * @param value bigint value to encode
+ * @returns 0x-prefixed, 64-char lowercase hex string
+ */
+function toBytes32Hex(value) {
+    if (value < 0n || value > MAX_UINT256) {
+        throw new Error(`Value out of uint256 range: ${value}`);
+    }
+    return `0x${value.toString(16).padStart(64, '0')}`;
+}
+/**
+ * Parses a Solidity unsigned integer literal source string (per
+ * https://docs.soliditylang.org/en/latest/types.html#rational-literals) and returns it in the
+ * canonical hex form produced by {@link toBytes32Hex}.
+ *
+ * Parsing is delegated to {@link BigNumber}, which accepts decimal (`1000`), hex (`0x1f`), and
+ * scientific notation (`1e18`). Underscore separators and uppercase digits, which BigNumber rejects
+ * but Solidity allows, are stripped/lowercased first. Non-integer results (e.g. `1.5e3`) are rejected.
  *
- * If the input is null or undefined, returns '0x0000000000000000000000000000000000000000000000000000000000000000'.
+ * If the input is null or undefined, returns the canonical hex form of zero.
  *
  * Assumes the input is a valid uint256-compatible literal for Solidity, and only performs minimal validation.
  *
- * @param literal Integer literal to convert
- * @returns Hex string with 0x prefix, padded to 64 bytes with leading zeroes
+ * @param literal Integer literal source string to parse
+ * @returns 0x-prefixed, 64-char lowercase hex string
  */
 function normalizeUint256Literal(literal) {
     if (!literal) {
-        return '0x0000000000000000000000000000000000000000000000000000000000000000';
+        return toBytes32Hex(0n);
     }
     const lowercaseNoUnderscores = literal.replace(/_/g, '').toLowerCase();
     const parsed = new bignumber_js_1.default(lowercaseNoUnderscores);
     if (!parsed.isInteger()) {
         throw new Error(`Invalid integer literal: ${literal}`);
     }
-    const calculatedValueAsHex = parsed.toString(16);
-    const padded = calculatedValueAsHex.padStart(64, '0');
-    return `0x${padded}`;
+    return toBytes32Hex(BigInt(parsed.toFixed()));
 }
 //# sourceMappingURL=integer-literals.js.map

package/dist/utils/integer-literals.js.map

@@ -1 +1 @@
-{"version":3,"file":"integer-literals.js","sourceRoot":"","sources":["../../src/utils/integer-literals.ts"],"names":[],"mappings":";;;;;AAeA,0DAaC;AA5BD,gEAAqC;AAErC;;;;;;;;;;;;GAYG;AACH,SAAgB,uBAAuB,CAAC,OAAkC;IACxE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,oEAAoE,CAAC;IAC9E,CAAC;IACD,MAAM,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAEvE,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC,sBAAsB,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,oBAAoB,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACtD,OAAO,KAAK,MAAM,EAAE,CAAC;AACvB,CAAC"}
+{"version":3,"file":"integer-literals.js","sourceRoot":"","sources":["../../src/utils/integer-literals.ts"],"names":[],"mappings":";;;;;AAaA,oCAKC;AAkBD,0DAWC;AA/CD,gEAAqC;AAErC,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AAEtC;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,KAAa;IACxC,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,WAAW,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,uBAAuB,CAAC,OAAkC;IACxE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,YAAY,CAAC,EAAE,CAAC,CAAC;IAC1B,CAAC;IACD,MAAM,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAEvE,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC,sBAAsB,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AAChD,CAAC"}