diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..75fcab7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +# Pull Request + +## Description + +Please include a summary of the change and which feature was implemented or which issue was fixed. Also, include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +### How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. + +# Checklist: + +- [ ] I have used the proper Node.js version (e.g., using the `.nvmrc` file and the `nvm use` command). +- [ ] I have formatted my code using prettier +- [ ] I have installed [pre-commit](https://pre-commit.com/#installation) and have run `pre-commit install` to install the git hooks + +### Additional context + +Add any other context about the pull request here. diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml new file mode 100644 index 0000000..86c6109 --- /dev/null +++ b/.github/workflows/pre-commit.yaml @@ -0,0 +1,19 @@ +# checks that pre-commit hooks pass before allowing to merge a PR + +name: pre-commit +on: + pull_request: + branches: [main, master, staging, dev, feat/**, fix/**] + +jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v2 + with: + submodules: recursive + - name: Install pre-commit + run: pip install pre-commit + - name: Run pre-commit + run: pre-commit run --all-files diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..736488d --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +package-lock.json +node_modules +.DS_Store \ No newline at end of file diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..25bf17f --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +18 \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..93c84f9 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,12 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: mixed-line-ending + args: ["--fix=lf"] + description: Forces to replace line ending by the UNIX 'lf' character. + - repo: https://github.com/pre-commit/mirrors-prettier + rev: "v3.0.3" + hooks: + - id: prettier + name: Format non solidity files with prettier diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..6e4be40 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,16 @@ +{ + "printWidth": 120, + "tabWidth": 2, + "useTabs": false, + "singleQuote": false, + "bracketSpacing": true, + "trailingComma": "all", + "overrides": [ + { + "files": "*.json", + "options": { + "tabWidth": 4 + } + } + ] +} diff --git a/LICENSE-APACHE.md b/LICENSE-APACHE.md new file mode 100644 index 0000000..038d25d --- /dev/null +++ b/LICENSE-APACHE.md @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT.md b/LICENSE-MIT.md new file mode 100644 index 0000000..f7f7438 --- /dev/null +++ b/LICENSE-MIT.md @@ -0,0 +1,7 @@ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index a62b7d3..1639e7a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,77 @@ -> [!NOTE] -> Interim repository. +# Storage Layout Checker -``` -forge install https://github.com/0xPolygon/storage-layout-checker -``` +The Storage Layout Checker is a tool to inspect changes made to the storage layout between different versions of a smart contract during the development cycle. The tool will compare the storage layout of the contracts in the current commit with the storage layout of the contracts in a specified commit or tag. + +## Requirements + +The script utilizes Node.js to run. We recommend the node version defined in the `.nvmrc` file. +## Installation + +```bash +forge install 0xPolygon/storage-layout-checker ``` + +## Usage Example + +The following command will create `storage_check_report` in your project's root directory: + +```bash bash lib/storage-layout-checker/run.sh -``` \ No newline at end of file +``` + +Contracts with identified differences will be listed as `OLD` and `NEW` table files. To examine a finding, open the two files side by side. + +Additionally, `removed.txt` file will be created, with the names of deleted contracts. + +## Legend + +| Emoji | Meaning | +| ----- | --------------- | +| 🏴 | Dirty | +| đŸŗī¸ | Moved | +| 🏁 | Dirty and Moved | +| đŸĒĻ | Removed | +| 🌱 | New | + +### Dirty + +A variable is considered dirty if the name or type of the variable changes. A dirty variable can also be a new variable that conflicts with the previous storage layout. + +### Moved + +A variable with the same name and type moved to a new storage slot, but it doesn't conflict with the previous storage layout. + +### Dirty and Moved + +When a variable is both dirty and moved, it means that the variable has moved to a new storage slot and is conflicting with the previous storage layout. + +### Removed + +This variable no longer exists in the new version of the contract. + +### New + +This variable is new in the new version of the contract. Note, when a new contract is added that has a private variable as another contract with the same private variable name and type, it will be flagged as potentially moved. + +## Upcoming Features + +- **Support for Special Variables**: Adds support for `__gap` and `__legacy` variables. + +## License + +​ +Licensed under either of +​ + +- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + ​ + +at your option. + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. + +--- + +Š 2023 PT Services DMCC diff --git a/_reporter.js b/_reporter.js index ba143e1..c2f3b49 100644 --- a/_reporter.js +++ b/_reporter.js @@ -1,100 +1,404 @@ -// PREPARE JSONS +const fs = require("fs"); +const path = require("path"); + +// ========== INPUTS ========== + +const oldData = JSON.parse(process.argv[2]); +const newData = JSON.parse(process.argv[3]); +const contractPath = path.parse(process.argv[4]); + +// Skip if same +if (JSON.stringify(oldData) === JSON.stringify(newData)) process.exit(0); + +// ========== VISUALIZE LAYOUTS ========== + +const oldVisualized = createLayout(oldData); +//console.log(JSON.stringify(oldVisualized, null, 2)); + +const newVisualized = createLayout(newData); +//console.log(JSON.stringify(newVisualized, null, 2)); -const oldObject = JSON.parse(process.argv[2]); -const newObject = JSON.parse(process.argv[3]); +const overlayedVisualized = overlayLayouts(oldVisualized, newVisualized); +//console.log(JSON.stringify(overlayedVisualized, null, 2)); -function removeField(jsonArray, fieldToRemove) { - jsonArray.forEach((json) => { - if (json.hasOwnProperty("astId")) { - delete json[fieldToRemove]; +const alignedOverlayedVisualized = alignOverlayedLayout(overlayedVisualized, oldVisualized); +//console.log(JSON.stringify(alignedOverlayedVisualized, null, 2)); + +const alignedOldVisualized = alignOldLayout(oldVisualized, alignedOverlayedVisualized); +//console.log(JSON.stringify(alignedOldVisualized, null, 2)); + +if (alignedOldVisualized.length !== alignedOverlayedVisualized.length) { + console.warn( + "Error: Lengths do not match.\nThis is a bug. Please, submit a new issue: https://github.com/0xPolygon/storage-layout-checker/issues.", + ); + process.exit(1); +} + +// ========== ANALYZE ========== + +let reportOld = ""; +let reportNew = ""; +let i = 0; + +for (; i < alignedOldVisualized.length; i++) { + const oldItem = alignedOldVisualized[i]; + const overlayedItem = alignedOverlayedVisualized[i]; + + // overlayedItem can be undefined, "dirty", or a storage item + // oldItem can be undefined or a storage item + + // Emojis: + // 🏴 - Dirty + // đŸŗī¸ - Moved + // 🏁 - Dirty and moved + // đŸĒĻ - Removed + // 🌱 - New + + // Same start + if (checkStart(overlayedItem, oldItem) === 1) { + // auto + if (overlayedItem.label === "dirty") { + printNew(false, "đŸĒĻ"); + printOld(true); + continue; + } + if (!isSame(overlayedItem, oldItem)) { + if (!hasExisted(overlayedItem, oldVisualized)) { + printNew(true, "🏴"); + printOld(true); + } else { + printNew(true, "🏁"); + printOld(true); + } + } else { + printNew(true, " "); + printOld(true); + } + } else if (checkStart(overlayedItem, oldItem) === 0) { + if (overlayedItem.label === "dirty") { + const diff = overlayedItem.end - overlayedItem.start; + const s = diff === 1 ? "" : "s"; + + reportNew += " " + diff + " dirty byte" + s + "\n"; + printOld(false); + continue; + } + if (!isClean(overlayedItem, oldVisualized)) { + if (!hasExisted(overlayedItem, oldVisualized)) { + printNew(true, "🏴"); + printOld(false); + } else { + printNew(true, "🏁"); + printOld(false); + } + } else { + if (!hasExisted(overlayedItem, oldVisualized)) { + printNew(true, "🌱"); + printOld(false); + } else { + printNew(true, "đŸŗī¸"); + printOld(false); + } } - }); + } else if (checkStart(overlayedItem, oldItem) === -1) { + // auto + printNew(false, "đŸĒĻ"); + printOld(true); + } +} + +// ========== REPORT FINDINGS ========== + +// remove \n from end of report +reportOld = reportOld.slice(0, -1); +reportNew = reportNew.slice(0, -1); + +const directoryPath = path.join("./storage_check_report", contractPath.dir); + +// Create directories recursively +try { + fs.mkdirSync(directoryPath, { recursive: true }); +} catch (err) { + if (err.code !== "EEXIST") throw err; } -removeField(oldObject.storage, "astId"); -removeField(newObject.storage, "astId"); +const reportOldPath = path.join(directoryPath, contractPath.name + "-OLD"); +const reportNewPath = path.join(directoryPath, contractPath.name + "-NEW"); + +// Write files +fs.writeFileSync(reportOldPath, reportOld); +fs.writeFileSync(reportNewPath, reportNew); + +// ========== HELPERS ========== -function jsonsSame(json1, json2) { - return JSON.stringify(json1) === JSON.stringify(json2); +// IN: Storage layout JSON +// OUT: Easy to read storage layout JSON +function createLayout(data) { + const result = []; + + function calcStart(item) { + let slot = parseInt(item.slot); + let offset = parseInt(item.offset); + let result = slot * 32 + offset; + if (slot + offset === 0) result = 0; + return result; + } + + for (const item of data.storage) { + const start = calcStart(item); + const end = start + parseInt(data.types[item.type].numberOfBytes); + const json = { + label: item.label, + start: start, + end: end, + type: processType(data.types[item.type]), + slot: item.slot, + offset: item.offset, + }; + result.push(json); + } + + return result; } -if (jsonsSame(oldObject, newObject)) { - process.exit(0); +// IN: JSON for "type" +// OUT: JSON of "type" with "astId" and "contract" removed from each "member" +// Note: For shallow comparison. TODO: Deep comparison +function processType(type) { + if (type && type.members && Array.isArray(type.members)) { + // Iterate through each member of the type + type.members.forEach((member) => { + // Delete the "astId" and "contract" properties from the member + delete member.astId; + delete member.contract; + }); + } + return type; } -let oldStorage = oldObject.storage; -let newStorage = newObject.storage; +// IN: Old storage layout JSON, new storage layout JSON +// OUT: New storage layout JSON with dirty bytes visible +function overlayLayouts(oldJSON, newJSON) { + // Step 1: Process old items and mark them as "dirty" + const processedOldJSON = oldJSON.map((item) => ({ + label: "dirty", + start: item.start, + end: item.end, + })); -// COMPARE + const result = []; -let reportOld = ""; -let reportNew = ""; + let newIndex = 0; + let currentNewItem = newJSON[newIndex]; + + for (let oldItem of processedOldJSON) { + // Step 2: Overlay the items from the new JSON + while (currentNewItem && currentNewItem.end <= oldItem.start) { + // Add completely non-overlapping new items + result.push({ ...currentNewItem }); + newIndex++; + currentNewItem = newJSON[newIndex]; + } + + if (currentNewItem && currentNewItem.start < oldItem.end) { + // There is an overlap between the old and new items + if (currentNewItem.start > oldItem.start) { + // Add the portion of the old item before the overlap + result.push({ label: "dirty", start: oldItem.start, end: currentNewItem.start }); + oldItem.start = currentNewItem.start; + } + if (currentNewItem.end >= oldItem.end) { + // The new item completely covers the old item + oldItem = null; // Old item is entirely overlapped + } else { + // The new item partially overlaps the old item + oldItem.start = currentNewItem.end; + } + } + + if (oldItem) { + // Add any remaining portion of the old item + result.push({ ...oldItem }); + } + } + + // Add any remaining new items that do not overlap with old items + while (currentNewItem) { + result.push({ ...currentNewItem }); + newIndex++; + currentNewItem = newJSON[newIndex]; + } + + // Sort the result by the "start" property to ensure the order + result.sort((a, b) => a.start - b.start); -function calcStart(item) { - let slot = parseInt(item.slot); - let offset = item.offset; - let result = slot * 256 + 1 + offset * 8; - if (slot + offset == 0) result = 0; return result; } -function startsSame(item1, item2) { - return calcStart(item1) === calcStart(item2); +// IN: Overlayed storage layout +// OUT: Aligned overlayed storage layout +function alignOverlayedLayout(overlayedVisualized, oldArray) { + const result = []; + let overlayIndex = 0; + let newIndex = 0; + + while (overlayIndex < overlayedVisualized.length && newIndex < oldArray.length) { + const overlayItem = overlayedVisualized[overlayIndex]; + const oldItem = oldArray[newIndex]; + + if (overlayItem.start === oldItem.start) { + // Copy overlayed item when there's a match + result.push({ ...overlayItem }); + overlayIndex++; + newIndex++; + } else if (overlayItem.start < oldItem.start) { + // Copy overlayed item when it precedes the old item + result.push({ ...overlayItem }); + overlayIndex++; + } else { + // Insert undefined when oldItem.start is missing in overlayedVisualized + result.push(undefined); + newIndex++; + } + } + + // Add any remaining overlayed items + while (overlayIndex < overlayedVisualized.length) { + result.push({ ...overlayedVisualized[overlayIndex] }); + overlayIndex++; + } + + // Add undefined for any remaining old items + while (newIndex < oldArray.length) { + result.push(undefined); + newIndex++; + } + + return result; } -function startsBefore(item1, item2) { - return calcStart(item1) < calcStart(item2); +// IN: Old storage layout, aligned overlayed storage layout +// OUT: Aligned old storage layout +function alignOldLayout(oldArray, alignedOverlayedVisualized) { + const result = []; + let overlayIndex = 0; + let oldIndex = 0; + + while (overlayIndex < alignedOverlayedVisualized.length) { + const alignedOverlayedItem = alignedOverlayedVisualized[overlayIndex]; + + if (alignedOverlayedItem) { + if (oldIndex < oldArray.length) { + const oldItem = oldArray[oldIndex]; + + if (alignedOverlayedItem.start === oldItem.start) { + // Copy old item when there's a match + result.push({ ...oldItem }); + overlayIndex++; + oldIndex++; + } else if (alignedOverlayedItem.start < oldItem.start) { + // Insert undefined when oldItem.start is missing in oldArray + result.push(undefined); + overlayIndex++; + } else { + // Copy old item when it precedes the aligned overlayed item + result.push({ ...oldItem }); + oldIndex++; + } + } else { + // No old item to compare, so insert undefined + result.push(undefined); + overlayIndex++; + } + } else { + // Skip undefined item in alignedOverlayedVisualized + overlayIndex++; + } + } + + // Handle remaining items in oldArray, if any + while (oldIndex < oldArray.length) { + result.push({ ...oldArray[oldIndex] }); + oldIndex++; + } + + return result; } +// IN: Storage item, storage item +// OUT: True or false function isSame(item1, item2) { - return ( - item1.label === item2.label && - item1.type === item2.type && - jsonsSame(oldObject.types[item1.type], newObject.types[item2.type]) - ); + // Compare items by label and type + if (item1.label === item2.label && JSON.stringify(item1.type) === JSON.stringify(item2.type)) { + return true; // Items are equal + } else { + return false; // Items are not equal + } } -let o = 0; -let n = 0; +// IN: Item from aligned overlayed storage layout, old storage layout +// OUT: True or false +// Note: Check for dirty bytes. +function isClean(item, oldLayout) { + for (const oldItem of oldLayout) { + // Check for overlap between the given item and oldItem + if (item.start < oldItem.end && item.end > oldItem.start) { + return false; // There is an overlap, not clean + } + } + return true; // No overlaps found, clean +} -while (true) { - const item1 = oldStorage[o]; - const item2 = newStorage[n]; +// IN: Item from aligned overlayed storage layout, old storage layout +// OUT: True or false +function hasExisted(item, oldLayout) { + for (const oldItem of oldLayout) { + if (isSame(item, oldItem)) { + return true; // The item exists in oldLayout + } + } + return false; // The item does not exist in oldLayout +} - if (item1 && item2 && startsSame(item1, item2)) { - printOld(true); - printNew(true, isSame(item1, item2) ? " " : "❗ī¸"); - o++; - n++; - } else if (item1 && (!item2 || startsBefore(item1, item2))) { - printOld(true); - printNew(false, "🗑ī¸"); - o++; - } else if (item2 && (!item1 || startsBefore(item2, item1))) { - printOld(false); - printNew(true, "✨"); - n++; +// IN: Item from aligned overlayed storage layout, old storage layout +// OUT: -1 if no start, 0 diff/gt start, 1 if same start +function checkStart(newItem, oldItem) { + if (newItem === undefined && oldItem !== undefined) { + return -1; // "new" is undefined + } else if (newItem !== undefined && oldItem === undefined) { + return 0; // "old" is undefined } else { - break; + if (newItem.start !== oldItem.start) { + console.warn( + "Error: Starts are different.\nThis is a bug. Please, submit a new issue: https://github.com/0xPolygon/storage-layout-checker/issues.", + ); + process.exit(1); + } + return 1; // Both "new" and "old" are defined } } +// IN: Whether line should be empty +// Notes: Adds line to old report. function printOld(notEmpty) { if (!notEmpty) reportOld += "\n"; - else reportOld += formatLine(" ", oldStorage[o]); + else reportOld += formatLine(" ", alignedOldVisualized[i]); } +// IN: Whether line should be empty, finding indicator +// Notes: Adds line to new report. function printNew(notEmpty, emoji) { if (!notEmpty) reportNew += emoji + "\n"; - else reportNew += formatLine(emoji, newStorage[n]); + else reportNew += formatLine(emoji, alignedOverlayedVisualized[i]); } +// IN: Finding indicator, storage item function formatLine(emoji, item) { emoji = emoji.padEnd(1, " "); let slot = item.slot; - let offset = item.offset.toString().padEnd(2, " "); + let offset = item.offset.toString().padEnd(5, " "); let label = item.label.padEnd(25, " "); - let type = item.type; + let type = item.type.label; if (item.offset == 0) { slot = slot.padEnd(8, " "); @@ -103,31 +407,5 @@ function formatLine(emoji, item) { slot += ": "; } - return `${emoji} ${slot}${offset} ${label} ${type}\n`; -} - -// REPORT - -// remove \n from end of report -reportOld = reportOld.slice(0, -1); -reportNew = reportNew.slice(0, -1); - -const fs = require("fs"); -const path = require("path"); - -const filePath = path.parse(process.argv[4]); -const directoryPath = path.join("./storage_check_report", filePath.dir); - -// Create directories recursively -try { - fs.mkdirSync(directoryPath, { recursive: true }); -} catch (err) { - if (err.code !== "EEXIST") throw err; + return `${emoji} ${slot}${offset} ${label} ${type}\n`; } - -const reportOldPath = path.join(directoryPath, filePath.name + "-OLD"); -const reportNewPath = path.join(directoryPath, filePath.name + "-NEW"); - -// Write files -fs.writeFileSync(reportOldPath, reportOld); -fs.writeFileSync(reportNewPath, reportNew); diff --git a/package.json b/package.json new file mode 100644 index 0000000..ac80eca --- /dev/null +++ b/package.json @@ -0,0 +1,7 @@ +{ + "name": "storage-layout-checker", + "version": "0.1.0", + "main": "index.js", + "author": "Polygon Labs", + "license": "(Apache-2.0 OR MIT)" +} diff --git a/run.sh b/run.sh index 672a7d6..9a2d8c8 100644 --- a/run.sh +++ b/run.sh @@ -17,7 +17,7 @@ if [ -d "$old_version" ]; then # Check if the current commit matches the target commit hash prev_dir=$(pwd) cd "$old_version" - if [ "$(git rev-parse HEAD)" = "$1" ]; then + if [ "$(git rev-parse --short HEAD)" = "${1:0:7}" ]; then exists=1 fi cd "$prev_dir"