@openzeppelin/upgrades-core 1.40.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/utils/make-namespaced.d.ts +13 -2
- package/dist/utils/make-namespaced.d.ts.map +1 -1
- package/dist/utils/make-namespaced.js +47 -48
- package/dist/utils/make-namespaced.js.map +1 -1
- package/dist/utils/make-namespaced.test.js +4 -1
- package/dist/utils/make-namespaced.test.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +1 -1
- package/src/utils/make-namespaced.test.ts +5 -6
- package/src/utils/make-namespaced.ts +54 -51
- package/dist/utils/slang/trivia.d.ts +0 -9
- package/dist/utils/slang/trivia.d.ts.map +0 -1
- package/dist/utils/slang/trivia.js +0 -23
- package/dist/utils/slang/trivia.js.map +0 -1
- package/src/utils/slang/trivia.ts +0 -23
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.41.0 (2024-11-25)
|
|
4
|
+
|
|
5
|
+
- Update Slang dependency to 0.18.3. ([#1102](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1102))
|
|
6
|
+
- Improves reliability of Hardhat compilation step for namespaced storage layout validations when using Solidity versions 0.8.27 and 0.8.28.
|
|
7
|
+
|
|
3
8
|
## 1.40.0 (2024-10-10)
|
|
4
9
|
|
|
5
10
|
- Fix Hardhat compile error when overriding interface functions with public constant variables. ([#1091](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1091))
|
package/dist/index.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export { addProxyToManifest } from './add-proxy-to-manifest';
|
|
|
22
22
|
export { BeaconProxyUnsupportedError, LoadProxyUnsupportedError, PrepareUpgradeUnsupportedError, DeployBeaconProxyUnsupportedError, DeployBeaconProxyImplUnknownError, DeployBeaconProxyKindError, ForceImportUnsupportedError, NoContractImportError, ValidateUpdateRequiresKindError, PrepareUpgradeRequiresKindError, InitialOwnerUnsupportedKindError, assertNotProxy, } from './usage-error';
|
|
23
23
|
export { ValidateUpgradeSafetyOptions, validateUpgradeSafety, ProjectReport, ReferenceContractNotFound } from './cli';
|
|
24
24
|
export { getUpgradeInterfaceVersion } from './upgrade-interface-version';
|
|
25
|
-
export { makeNamespacedInput } from './utils/make-namespaced';
|
|
25
|
+
export { makeNamespacedInput, trySanitizeNatSpec } from './utils/make-namespaced';
|
|
26
26
|
export { isNamespaceSupported } from './storage/namespace';
|
|
27
27
|
export { inferProxyAdmin } from './infer-proxy-admin';
|
|
28
28
|
export { assertUnreachable } from './utils/assert';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC7F,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,qBAAqB,EACrB,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,QAAQ,EACR,eAAe,EACf,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE,cAAc,kCAAkC,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAE,kCAAkC,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,8BAA8B,EAC9B,iCAAiC,EACjC,iCAAiC,EACjC,0BAA0B,EAC1B,2BAA2B,EAC3B,qBAAqB,EACrB,+BAA+B,EAC/B,+BAA+B,EAC/B,gCAAgC,EAChC,cAAc,GACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,OAAO,CAAC;AAEtH,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC7F,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,qBAAqB,EACrB,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,QAAQ,EACR,eAAe,EACf,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE,cAAc,kCAAkC,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAE,kCAAkC,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,8BAA8B,EAC9B,iCAAiC,EACjC,iCAAiC,EACjC,0BAA0B,EAC1B,2BAA2B,EAC3B,qBAAqB,EACrB,+BAA+B,EAC/B,+BAA+B,EAC/B,gCAAgC,EAChC,cAAc,GACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,OAAO,CAAC;AAEtH,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.assertUnreachable = exports.inferProxyAdmin = exports.isNamespaceSupported = exports.makeNamespacedInput = exports.getUpgradeInterfaceVersion = exports.ReferenceContractNotFound = exports.ProjectReport = exports.validateUpgradeSafety = exports.assertNotProxy = exports.InitialOwnerUnsupportedKindError = exports.PrepareUpgradeRequiresKindError = exports.ValidateUpdateRequiresKindError = exports.NoContractImportError = exports.ForceImportUnsupportedError = exports.DeployBeaconProxyKindError = exports.DeployBeaconProxyImplUnknownError = exports.DeployBeaconProxyUnsupportedError = exports.PrepareUpgradeUnsupportedError = exports.LoadProxyUnsupportedError = exports.BeaconProxyUnsupportedError = exports.addProxyToManifest = exports.isBeacon = exports.getImplementationAddressFromProxy = exports.getImplementationAddressFromBeacon = exports.isTransparentProxy = exports.isBeaconProxy = exports.isTransparentOrUUPSProxy = exports.UpgradeableContract = exports.detectProxyKind = exports.processProxyKind = exports.setProxyKind = exports.logWarning = exports.getStorageLayoutForAddress = exports.DeploymentNotFound = exports.migrateManifest = exports.Manifest = exports.isEmptySlot = exports.toFallbackEip1967Hash = exports.toEip1967Hash = exports.getImplementationAddress = exports.getBeaconAddress = exports.getAdminAddress = exports.EIP1967ImplementationNotFound = exports.EIP1967BeaconNotFound = exports.fetchOrDeployGetDeployment = exports.fetchOrDeployAdmin = exports.fetchOrDeploy = void 0;
|
|
17
|
+
exports.assertUnreachable = exports.inferProxyAdmin = exports.isNamespaceSupported = exports.trySanitizeNatSpec = exports.makeNamespacedInput = exports.getUpgradeInterfaceVersion = exports.ReferenceContractNotFound = exports.ProjectReport = exports.validateUpgradeSafety = exports.assertNotProxy = exports.InitialOwnerUnsupportedKindError = exports.PrepareUpgradeRequiresKindError = exports.ValidateUpdateRequiresKindError = exports.NoContractImportError = exports.ForceImportUnsupportedError = exports.DeployBeaconProxyKindError = exports.DeployBeaconProxyImplUnknownError = exports.DeployBeaconProxyUnsupportedError = exports.PrepareUpgradeUnsupportedError = exports.LoadProxyUnsupportedError = exports.BeaconProxyUnsupportedError = exports.addProxyToManifest = exports.isBeacon = exports.getImplementationAddressFromProxy = exports.getImplementationAddressFromBeacon = exports.isTransparentProxy = exports.isBeaconProxy = exports.isTransparentOrUUPSProxy = exports.UpgradeableContract = exports.detectProxyKind = exports.processProxyKind = exports.setProxyKind = exports.logWarning = exports.getStorageLayoutForAddress = exports.DeploymentNotFound = exports.migrateManifest = exports.Manifest = exports.isEmptySlot = exports.toFallbackEip1967Hash = exports.toEip1967Hash = exports.getImplementationAddress = exports.getBeaconAddress = exports.getAdminAddress = exports.EIP1967ImplementationNotFound = exports.EIP1967BeaconNotFound = exports.fetchOrDeployGetDeployment = exports.fetchOrDeployAdmin = exports.fetchOrDeploy = void 0;
|
|
18
18
|
__exportStar(require("./validate"), exports);
|
|
19
19
|
var impl_store_1 = require("./impl-store");
|
|
20
20
|
Object.defineProperty(exports, "fetchOrDeploy", { enumerable: true, get: function () { return impl_store_1.fetchOrDeploy; } });
|
|
@@ -84,6 +84,7 @@ var upgrade_interface_version_1 = require("./upgrade-interface-version");
|
|
|
84
84
|
Object.defineProperty(exports, "getUpgradeInterfaceVersion", { enumerable: true, get: function () { return upgrade_interface_version_1.getUpgradeInterfaceVersion; } });
|
|
85
85
|
var make_namespaced_1 = require("./utils/make-namespaced");
|
|
86
86
|
Object.defineProperty(exports, "makeNamespacedInput", { enumerable: true, get: function () { return make_namespaced_1.makeNamespacedInput; } });
|
|
87
|
+
Object.defineProperty(exports, "trySanitizeNatSpec", { enumerable: true, get: function () { return make_namespaced_1.trySanitizeNatSpec; } });
|
|
87
88
|
var namespace_1 = require("./storage/namespace");
|
|
88
89
|
Object.defineProperty(exports, "isNamespaceSupported", { enumerable: true, get: function () { return namespace_1.isNamespaceSupported; } });
|
|
89
90
|
var infer_proxy_admin_1 = require("./infer-proxy-admin");
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,2CAA6F;AAApF,2GAAA,aAAa,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AAAE,wHAAA,0BAA0B,OAAA;AACtE,4CAA0B;AAC1B,4CAA0B;AAC1B,uCASoB;AARlB,iHAAA,qBAAqB,OAAA;AACrB,yHAAA,6BAA6B,OAAA;AAC7B,2GAAA,eAAe,OAAA;AACf,4GAAA,gBAAgB,OAAA;AAChB,oHAAA,wBAAwB,OAAA;AACxB,yGAAA,aAAa,OAAA;AACb,iHAAA,qBAAqB,OAAA;AACrB,uGAAA,WAAW,OAAA;AAEb,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,0CAAwB;AAExB,uCAOoB;AAHlB,oGAAA,QAAQ,OAAA;AACR,2GAAA,eAAe,OAAA;AACf,8GAAA,kBAAkB,OAAA;AAGpB,qEAAuE;AAA9D,qIAAA,0BAA0B,OAAA;AAEnC,mEAAiD;AAEjD,mCAAyC;AAAhC,iGAAA,UAAU,OAAA;AACnB,2CAA+E;AAAtE,0GAAA,YAAY,OAAA;AAAE,8GAAA,gBAAgB,OAAA;AAAE,6GAAA,eAAe,OAAA;AAExD,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAE5B,iDAA8F;AAArF,yHAAA,wBAAwB,OAAA;AAAE,8GAAA,aAAa,OAAA;AAAE,mHAAA,kBAAkB,OAAA;AACpE,+CAAuG;AAA9F,kIAAA,kCAAkC,OAAA;AAAE,iIAAA,iCAAiC,OAAA;AAC9E,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA;AACjB,iEAA6D;AAApD,2HAAA,kBAAkB,OAAA;AAE3B,6CAauB;AAZrB,0HAAA,2BAA2B,OAAA;AAC3B,wHAAA,yBAAyB,OAAA;AACzB,6HAAA,8BAA8B,OAAA;AAC9B,gIAAA,iCAAiC,OAAA;AACjC,gIAAA,iCAAiC,OAAA;AACjC,yHAAA,0BAA0B,OAAA;AAC1B,0HAAA,2BAA2B,OAAA;AAC3B,oHAAA,qBAAqB,OAAA;AACrB,8HAAA,+BAA+B,OAAA;AAC/B,8HAAA,+BAA+B,OAAA;AAC/B,+HAAA,gCAAgC,OAAA;AAChC,6GAAA,cAAc,OAAA;AAGhB,6BAAsH;AAA/E,4GAAA,qBAAqB,OAAA;AAAE,oGAAA,aAAa,OAAA;AAAE,gHAAA,yBAAyB,OAAA;AAEtG,yEAAyE;AAAhE,uIAAA,0BAA0B,OAAA;AACnC,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,2CAA6F;AAApF,2GAAA,aAAa,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AAAE,wHAAA,0BAA0B,OAAA;AACtE,4CAA0B;AAC1B,4CAA0B;AAC1B,uCASoB;AARlB,iHAAA,qBAAqB,OAAA;AACrB,yHAAA,6BAA6B,OAAA;AAC7B,2GAAA,eAAe,OAAA;AACf,4GAAA,gBAAgB,OAAA;AAChB,oHAAA,wBAAwB,OAAA;AACxB,yGAAA,aAAa,OAAA;AACb,iHAAA,qBAAqB,OAAA;AACrB,uGAAA,WAAW,OAAA;AAEb,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,0CAAwB;AAExB,uCAOoB;AAHlB,oGAAA,QAAQ,OAAA;AACR,2GAAA,eAAe,OAAA;AACf,8GAAA,kBAAkB,OAAA;AAGpB,qEAAuE;AAA9D,qIAAA,0BAA0B,OAAA;AAEnC,mEAAiD;AAEjD,mCAAyC;AAAhC,iGAAA,UAAU,OAAA;AACnB,2CAA+E;AAAtE,0GAAA,YAAY,OAAA;AAAE,8GAAA,gBAAgB,OAAA;AAAE,6GAAA,eAAe,OAAA;AAExD,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAE5B,iDAA8F;AAArF,yHAAA,wBAAwB,OAAA;AAAE,8GAAA,aAAa,OAAA;AAAE,mHAAA,kBAAkB,OAAA;AACpE,+CAAuG;AAA9F,kIAAA,kCAAkC,OAAA;AAAE,iIAAA,iCAAiC,OAAA;AAC9E,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA;AACjB,iEAA6D;AAApD,2HAAA,kBAAkB,OAAA;AAE3B,6CAauB;AAZrB,0HAAA,2BAA2B,OAAA;AAC3B,wHAAA,yBAAyB,OAAA;AACzB,6HAAA,8BAA8B,OAAA;AAC9B,gIAAA,iCAAiC,OAAA;AACjC,gIAAA,iCAAiC,OAAA;AACjC,yHAAA,0BAA0B,OAAA;AAC1B,0HAAA,2BAA2B,OAAA;AAC3B,oHAAA,qBAAqB,OAAA;AACrB,8HAAA,+BAA+B,OAAA;AAC/B,8HAAA,+BAA+B,OAAA;AAC/B,+HAAA,gCAAgC,OAAA;AAChC,6GAAA,cAAc,OAAA;AAGhB,6BAAsH;AAA/E,4GAAA,qBAAqB,OAAA;AAAE,oGAAA,aAAa,OAAA;AAAE,gHAAA,yBAAyB,OAAA;AAEtG,yEAAyE;AAAhE,uIAAA,0BAA0B,OAAA;AACnC,2DAAkF;AAAzE,sHAAA,mBAAmB,OAAA;AAAE,qHAAA,kBAAkB,OAAA;AAChD,iDAA2D;AAAlD,iHAAA,oBAAoB,OAAA;AAC7B,yDAAsD;AAA7C,oHAAA,eAAe,OAAA;AACxB,yCAAmD;AAA1C,2GAAA,iBAAiB,OAAA"}
|
|
@@ -21,8 +21,19 @@ import { SolcInput, SolcOutput } from '../solc-api';
|
|
|
21
21
|
*
|
|
22
22
|
* @param input The original solc input.
|
|
23
23
|
* @param output The original solc output.
|
|
24
|
-
* @param
|
|
24
|
+
* @param _solcVersion The version of the solc compiler that was originally used to compile the input. This argument is no longer used and is kept for backwards compatibility.
|
|
25
25
|
* @returns The modified solc input with storage layout that includes namespaced type information.
|
|
26
26
|
*/
|
|
27
|
-
export declare function makeNamespacedInput(input: SolcInput, output: SolcOutput,
|
|
27
|
+
export declare function makeNamespacedInput(input: SolcInput, output: SolcOutput, _solcVersion?: string): SolcInput;
|
|
28
|
+
/**
|
|
29
|
+
* Attempts to remove all NatSpec comments that do not precede a struct definition from the input source contents.
|
|
30
|
+
* Directly modifies the input source contents, and also returns the modified input.
|
|
31
|
+
*
|
|
32
|
+
* If the solc version is not supported by the parser, the original content is kept.
|
|
33
|
+
*
|
|
34
|
+
* @param solcInput Solc input.
|
|
35
|
+
* @param solcVersion The version of the solc compiler that was originally used to compile the input.
|
|
36
|
+
* @returns The modified solc input with NatSpec comments removed where they do not precede a struct definition.
|
|
37
|
+
*/
|
|
38
|
+
export declare function trySanitizeNatSpec(solcInput: SolcInput, solcVersion: string): Promise<SolcInput>;
|
|
28
39
|
//# sourceMappingURL=make-namespaced.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"make-namespaced.d.ts","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAYpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,
|
|
1
|
+
{"version":3,"file":"make-namespaced.d.ts","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAYpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAkI1G;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAOtG"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.makeNamespacedInput = makeNamespacedInput;
|
|
4
|
+
exports.trySanitizeNatSpec = trySanitizeNatSpec;
|
|
4
5
|
const utils_1 = require("solidity-ast/utils");
|
|
5
6
|
const namespace_1 = require("../storage/namespace");
|
|
6
7
|
const assert_1 = require("./assert");
|
|
@@ -32,10 +33,10 @@ const OUTPUT_SELECTION = {
|
|
|
32
33
|
*
|
|
33
34
|
* @param input The original solc input.
|
|
34
35
|
* @param output The original solc output.
|
|
35
|
-
* @param
|
|
36
|
+
* @param _solcVersion The version of the solc compiler that was originally used to compile the input. This argument is no longer used and is kept for backwards compatibility.
|
|
36
37
|
* @returns The modified solc input with storage layout that includes namespaced type information.
|
|
37
38
|
*/
|
|
38
|
-
function makeNamespacedInput(input, output,
|
|
39
|
+
function makeNamespacedInput(input, output, _solcVersion) {
|
|
39
40
|
const modifiedSources = {};
|
|
40
41
|
for (const [sourcePath] of Object.entries(input.sources)) {
|
|
41
42
|
const source = input.sources[sourcePath];
|
|
@@ -149,64 +150,62 @@ function makeNamespacedInput(input, output, solcVersion) {
|
|
|
149
150
|
}
|
|
150
151
|
}
|
|
151
152
|
}
|
|
152
|
-
|
|
153
|
-
modifiedSources[sourcePath] = { ...source, content: modifiedSource };
|
|
153
|
+
modifiedSources[sourcePath] = { ...source, content: getModifiedSource(orig, modifications) };
|
|
154
154
|
}
|
|
155
155
|
return { ...input, sources: modifiedSources, settings: { ...input.settings, outputSelection: OUTPUT_SELECTION } };
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
159
|
-
*
|
|
158
|
+
* Attempts to remove all NatSpec comments that do not precede a struct definition from the input source contents.
|
|
159
|
+
* Directly modifies the input source contents, and also returns the modified input.
|
|
160
160
|
*
|
|
161
|
-
*
|
|
161
|
+
* If the solc version is not supported by the parser, the original content is kept.
|
|
162
|
+
*
|
|
163
|
+
* @param solcInput Solc input.
|
|
164
|
+
* @param solcVersion The version of the solc compiler that was originally used to compile the input.
|
|
165
|
+
* @returns The modified solc input with NatSpec comments removed where they do not precede a struct definition.
|
|
162
166
|
*/
|
|
163
|
-
function
|
|
164
|
-
const
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
const { Language } = require('@nomicfoundation/slang/language');
|
|
168
|
-
const { NonterminalKind, TerminalKind } = require('@nomicfoundation/slang/kinds');
|
|
169
|
-
const { TerminalNode } = require('@nomicfoundation/slang/cst');
|
|
170
|
-
const { isTrivia } = require('./slang/trivia');
|
|
171
|
-
/* eslint-enable @typescript-eslint/no-var-requires */
|
|
172
|
-
const language = new Language(solcVersion);
|
|
173
|
-
const parseOutput = language.parse(NonterminalKind.SourceUnit, origContent);
|
|
174
|
-
const cursor = parseOutput.createTreeCursor();
|
|
175
|
-
while (cursor.goToNextTerminalWithKinds([TerminalKind.MultiLineNatSpecComment, TerminalKind.SingleLineNatSpecComment])) {
|
|
176
|
-
// Lookahead to determine if the next non-trivia node is the struct keyword.
|
|
177
|
-
// If so, this NatSpec is part of the struct definition and should not be removed.
|
|
178
|
-
const lookaheadCursor = cursor.clone();
|
|
179
|
-
while (lookaheadCursor.goToNextTerminal() && isTrivia(lookaheadCursor.node())) {
|
|
180
|
-
// skip over trivia nodes
|
|
181
|
-
}
|
|
182
|
-
if (lookaheadCursor.node().kind === TerminalKind.StructKeyword) {
|
|
183
|
-
continue;
|
|
184
|
-
}
|
|
185
|
-
const triviaNode = cursor.node();
|
|
186
|
-
(0, assert_1.assert)(triviaNode instanceof TerminalNode);
|
|
187
|
-
natSpecRemovals.push(makeDeleteRange(cursor.textRange.start.utf8, cursor.textRange.end.utf8));
|
|
167
|
+
async function trySanitizeNatSpec(solcInput, solcVersion) {
|
|
168
|
+
for (const [sourcePath, source] of Object.entries(solcInput.sources)) {
|
|
169
|
+
if (source.content !== undefined) {
|
|
170
|
+
solcInput.sources[sourcePath].content = await tryRemoveNonStructNatSpec(source.content, solcVersion);
|
|
188
171
|
}
|
|
189
|
-
return getModifiedSource(Buffer.from(origContent, 'utf8'), natSpecRemovals);
|
|
190
172
|
}
|
|
191
|
-
|
|
173
|
+
return solcInput;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* If Slang is supported for the current compiler version, use Slang to parse and remove all NatSpec comments
|
|
177
|
+
* that do not precede a struct definition and return the modified content.
|
|
178
|
+
*
|
|
179
|
+
* Otherwise, return the original content.
|
|
180
|
+
*/
|
|
181
|
+
async function tryRemoveNonStructNatSpec(origContent, solcVersion) {
|
|
182
|
+
if (solcVersion === undefined) {
|
|
192
183
|
return origContent;
|
|
193
184
|
}
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
require(id);
|
|
198
|
-
return true;
|
|
185
|
+
const { Parser } = await import('@nomicfoundation/slang/parser');
|
|
186
|
+
if (!Parser.supportedVersions().includes(solcVersion)) {
|
|
187
|
+
return origContent;
|
|
199
188
|
}
|
|
200
|
-
|
|
201
|
-
|
|
189
|
+
const { TerminalKind, TerminalKindExtensions } = await import('@nomicfoundation/slang/cst');
|
|
190
|
+
const parser = Parser.create(solcVersion);
|
|
191
|
+
const parseOutput = parser.parse(Parser.rootKind(), origContent);
|
|
192
|
+
const cursor = parseOutput.createTreeCursor();
|
|
193
|
+
const natSpecRemovals = [];
|
|
194
|
+
while (cursor.goToNextTerminalWithKinds([TerminalKind.MultiLineNatSpecComment, TerminalKind.SingleLineNatSpecComment])) {
|
|
195
|
+
// Lookahead to determine if the next non-trivia node is the struct keyword.
|
|
196
|
+
// If so, this NatSpec is part of the struct definition and should not be removed.
|
|
197
|
+
const lookaheadCursor = cursor.clone();
|
|
198
|
+
while (lookaheadCursor.goToNextTerminal() &&
|
|
199
|
+
lookaheadCursor.node.isTerminalNode() &&
|
|
200
|
+
TerminalKindExtensions.isTrivia(lookaheadCursor.node.kind)) {
|
|
201
|
+
// skip over trivia nodes
|
|
202
|
+
}
|
|
203
|
+
if (lookaheadCursor.node.kind === TerminalKind.StructKeyword) {
|
|
204
|
+
continue;
|
|
205
|
+
}
|
|
206
|
+
natSpecRemovals.push(makeDeleteRange(cursor.textRange.start.utf8, cursor.textRange.end.utf8));
|
|
202
207
|
}
|
|
203
|
-
return
|
|
204
|
-
}
|
|
205
|
-
function slangSupportsVersion(solcVersion) {
|
|
206
|
-
/* eslint-disable @typescript-eslint/no-var-requires */
|
|
207
|
-
const { Language } = require('@nomicfoundation/slang/language');
|
|
208
|
-
/* eslint-enable @typescript-eslint/no-var-requires */
|
|
209
|
-
return Language.supportedVersions().includes(solcVersion);
|
|
208
|
+
return getModifiedSource(Buffer.from(origContent, 'utf8'), natSpecRemovals);
|
|
210
209
|
}
|
|
211
210
|
function toDummyEnumWithName(name) {
|
|
212
211
|
return `enum ${name} { dummy }`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"make-namespaced.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":";;AAuCA,
|
|
1
|
+
{"version":3,"file":"make-namespaced.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":";;AAuCA,kDAkIC;AAYD,gDAOC;AA5LD,8CAAgD;AAGhD,oDAAoE;AACpE,qCAAqD;AAGrD,MAAM,gBAAgB,GAAG;IACvB,GAAG,EAAE;QACH,GAAG,EAAE,CAAC,eAAe,CAAC;QACtB,EAAE,EAAE,CAAC,KAAK,CAAC;KACZ;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,mBAAmB,CAAC,KAAgB,EAAE,MAAkB,EAAE,YAAqB;IAC7F,MAAM,eAAe,GAAyC,EAAE,CAAC;IAEjE,KAAK,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAEzC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,eAAe,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;YACrC,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAmB,EAAE,CAAC;QAEzC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACxD,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACtB,KAAK,oBAAoB,CAAC,CAAC,CAAC;oBAC1B,MAAM,WAAW,GAAG,IAAI,CAAC;oBAEzB,iFAAiF;oBACjF,4EAA4E;oBAC5E,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;wBACrE,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;oBACjE,CAAC;oBAED,oEAAoE;oBACpE,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;oBAC3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;4BACrC,IAAA,eAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;4BAC5C,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;wBACxE,CAAC;oBACH,CAAC;oBAED,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC;oBACxC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;wBACzC,QAAQ,YAAY,CAAC,QAAQ,EAAE,CAAC;4BAC9B,KAAK,oBAAoB,CAAC,CAAC,CAAC;gCAC1B,eAAe,CAAC,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;gCAChE,MAAM;4BACR,CAAC;4BACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;gCAC3B,4EAA4E;gCAC5E,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;oCAC1B,MAAM;gCACR,CAAC;gCACD,mDAAmD;4BACrD,CAAC;4BACD,KAAK,iBAAiB,CAAC;4BACvB,KAAK,iBAAiB,CAAC;4BACvB,KAAK,oBAAoB,CAAC;4BAC1B,KAAK,mBAAmB,CAAC,CAAC,CAAC;gCACzB,2GAA2G;gCAC3G,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gCAC3F,MAAM;4BACR,CAAC;4BACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gCACxB,6FAA6F;gCAC7F,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;oCAC5C,SAAS;gCACX,CAAC;gCACD,MAAM,eAAe,GAAG,IAAA,wCAA4B,EAAC,YAAY,CAAC,CAAC;gCACnE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oCAClC,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC;oCACrC,MAAM,YAAY,GAAG,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;oCAC1E,MAAM,UAAU,GAAG,IAAI,UAAU,IAAI,YAAY,GAAG,CAAC;oCAErD,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;gCAChE,CAAC;gCACD,MAAM;4BACR,CAAC;4BACD,KAAK,gBAAgB,CAAC;4BACtB,KAAK,gCAAgC,CAAC;4BACtC,OAAO,CAAC,CAAC,CAAC;gCACR,oEAAoE;gCACpE,oFAAoF;gCACpF,kDAAkD;gCAClD,MAAM;4BACR,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,MAAM;gBACR,CAAC;gBAED,KAAK,oBAAoB,CAAC,CAAC,CAAC;oBAC1B,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;oBAC3C,MAAM;gBACR,CAAC;gBAED,yGAAyG;gBACzG,sFAAsF;gBACtF,qEAAqE;gBACrE,KAAK,qBAAqB,CAAC,CAAC,CAAC;oBAC3B,4EAA4E;oBAC5E,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAClB,MAAM;oBACR,CAAC;oBACD,mDAAmD;gBACrD,CAAC;gBACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;oBACvB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC5E,MAAM;gBACR,CAAC;gBACD,8GAA8G;gBAC9G,iFAAiF;gBACjF,KAAK,mBAAmB;oBACtB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC3E,MAAM;gBACR,KAAK,gBAAgB,CAAC;gBACtB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB,CAAC;gBACxB,KAAK,gCAAgC,CAAC;gBACtC,OAAO,CAAC,CAAC,CAAC;oBACR,oEAAoE;oBACpE,+EAA+E;oBAC/E,iDAAiD;oBACjD,sEAAsE;oBACtE,oFAAoF;oBACpF,mFAAmF;oBACnF,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;IAC/F,CAAC;IAED,OAAO,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,eAAe,EAAE,gBAAgB,EAAE,EAAE,CAAC;AACpH,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,kBAAkB,CAAC,SAAoB,EAAE,WAAmB;IAChF,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QACrE,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,GAAG,MAAM,yBAAyB,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACvG,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,yBAAyB,CAAC,WAAmB,EAAE,WAAmB;IAC/E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC,CAAC;IACjE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACtD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,EAAE,YAAY,EAAE,sBAAsB,EAAE,GAAG,MAAM,MAAM,CAAC,4BAA4B,CAAC,CAAC;IAE5F,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC1C,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,WAAW,CAAC,gBAAgB,EAAE,CAAC;IAE9C,MAAM,eAAe,GAAmB,EAAE,CAAC;IAE3C,OACE,MAAM,CAAC,yBAAyB,CAAC,CAAC,YAAY,CAAC,uBAAuB,EAAE,YAAY,CAAC,wBAAwB,CAAC,CAAC,EAC/G,CAAC;QACD,4EAA4E;QAC5E,kFAAkF;QAClF,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;QACvC,OACE,eAAe,CAAC,gBAAgB,EAAE;YAClC,eAAe,CAAC,IAAI,CAAC,cAAc,EAAE;YACrC,sBAAsB,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAC1D,CAAC;YACD,yBAAyB;QAC3B,CAAC;QAED,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7D,SAAS;QACX,CAAC;QAED,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAChG,CAAC;IAED,OAAO,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,eAAe,CAAC,CAAC;AAC9E,CAAC;AAQD,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,QAAQ,IAAI,YAAY,CAAC;AAClC,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,eAAe,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC;AAC9E,CAAC;AAED,SAAS,eAAe,CACtB,IAAwB,EACxB,IAAY,EACZ,aAA6B,EAC7B,WAAgC;IAEhC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,cAAc,CAAC;QACpB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAE3B,IACE,WAAW,KAAK,SAAS;gBACzB,WAAW,CAAC,YAAY,KAAK,UAAU;gBACvC,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC7B,CAAC,OAAO,EACR,CAAC;gBACD,IAAA,eAAM,EAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;gBAErC,oGAAoG;gBACpG,wGAAwG;gBACxG,0DAA0D;gBAC1D,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;gBAClE,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;YAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9B,mBAAmB;gBACnB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACtC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,cAAc;gBACd,IAAI,OAAO,EAAE,CAAC;oBACZ,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;gBACxD,CAAC;qBAAM,CAAC;oBACN,6FAA6F;oBAC7F,IAAA,eAAM,EAAC,WAAW,EAAE,YAAY,KAAK,WAAW,CAAC,CAAC;oBAClD,qIAAqI;oBACrI,IAAA,eAAM,EAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAExB,mGAAmG;oBACnG,gHAAgH;oBAChH,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAChD,aAAa,CAAC,IAAI,CAChB,WAAW,CACT,IAAI,CAAC,gBAAgB,EACrB,IAAI,EACJ,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrG,CACF,CAAC;oBACJ,CAAC;oBACD,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;gBACzD,CAAC;YACH,CAAC;YAED,MAAM;QACR,CAAC;QACD,KAAK,aAAa,CAAC;QACnB,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3E,MAAM;QACR,CAAC;QACD;YACE,OAAO,IAAA,0BAAiB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;AACH,CAAC;AAED,SAAS,4BAA4B,CAAC,KAA0B;IAC9D,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU;IAC9B,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;IAC3B,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED,SAAS,WAAW,CAAC,IAAU,EAAE,IAAY,EAAE,IAAY;IACzD,iCAAiC;IACjC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAU,EAAE,IAAY;IAChD,MAAM,EAAE,KAAK,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,eAAe,CAAC,IAAU,EAAE,IAAY;IAC/C,MAAM,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CAAC,IAAU,EAAE,IAAY;IAC1C,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC;IACxB,+DAA+D;IAC/D,IAAI,IAAA,kBAAU,EAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE,CAAC;QAC5C,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClF,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACzE,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,OAAO,eAAe,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,eAAe,CAAC,KAAa,EAAE,GAAW;IACjD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY,EAAE,aAA6B;IACpE,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,IAAA,eAAM,EAAC,YAAY,CAAC,KAAK,IAAI,aAAa,CAAC,CAAC;QAC5C,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAEnE,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC;QAC9B,CAAC;QAED,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC;IACnC,CAAC;IAED,IAAA,eAAM,EAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -26,7 +26,10 @@ async function testMakeNamespaced(origBuildInfo, t, solcVersion, keepAllNatSpec
|
|
|
26
26
|
}
|
|
27
27
|
// Inefficient, but we want to test that we don't actually modify the original input object
|
|
28
28
|
const origInput = JSON.parse(JSON.stringify(origBuildInfo.input));
|
|
29
|
-
|
|
29
|
+
let modifiedInput = (0, make_namespaced_1.makeNamespacedInput)(origBuildInfo.input, origBuildInfo.output, origBuildInfo.solcVersion);
|
|
30
|
+
if (!keepAllNatSpec) {
|
|
31
|
+
modifiedInput = await (0, make_namespaced_1.trySanitizeNatSpec)(modifiedInput, origBuildInfo.solcVersion);
|
|
32
|
+
}
|
|
30
33
|
// Run hardhat compile on the modified input and make sure it has no errors
|
|
31
34
|
const modifiedOutput = await hardhatCompile(modifiedInput, solcVersion);
|
|
32
35
|
t.is(modifiedOutput.errors, undefined, JSON.stringify(modifiedInput.sources, null, 2));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"make-namespaced.test.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA6C;AAC7C,qCAAyC;AACzC,iEAI0C;AAE1C,
|
|
1
|
+
{"version":3,"file":"make-namespaced.test.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA6C;AAC7C,qCAAyC;AACzC,iEAI0C;AAE1C,uDAA4E;AAK5E,IAAA,aAAI,EAAC,uBAAuB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACtC,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,uDAAuD,CAAC,CAAC;IAC5G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,0CAA0C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACzD,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,uDAAuD,CAAC,CAAC;IAC5G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC7D,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,kCAAkC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjD,6JAA6J;IAC7J,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,qDAAqD,CAAC,CAAC;IAC1G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,kBAAkB,CAC/B,aAAoC,EACpC,CAA4B,EAC5B,WAAmB,EACnB,cAAc,GAAG,KAAK;IAEtB,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,2FAA2F;IAC3F,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAElE,IAAI,aAAa,GAAG,IAAA,qCAAmB,EAAC,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IAC9G,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,aAAa,GAAG,MAAM,IAAA,oCAAkB,EAAC,aAAa,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IAED,2EAA2E;IAC3E,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACxE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvF,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACpC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAE1B,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAgB;IAC5C,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAClD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;iBAC5B,OAAO,CAAC,wBAAwB,EAAE,qBAAqB,CAAC;iBACxD,OAAO,CAAC,6BAA6B,EAAE,0BAA0B,CAAC;iBAClE,OAAO,CAAC,+BAA+B,EAAE,4BAA4B,CAAC;iBACtE,OAAO,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,KAAgB,EAAE,WAAmB;IACjE,MAAM,SAAS,GAAc,MAAM,IAAA,aAAG,EAAC,iDAAoC,EAAE;QAC3E,KAAK,EAAE,IAAI;QACX,WAAW;KACZ,CAAC,CAAC;IAEH,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;QACvB,OAAO,MAAM,IAAA,aAAG,EAAC,6CAAgC,EAAE;YACjD,KAAK;YACL,UAAU,EAAE,SAAS,CAAC,YAAY;SACnC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,IAAA,aAAG,EAAC,2CAA8B,EAAE;YAC/C,KAAK;YACL,QAAQ,EAAE,SAAS,CAAC,YAAY;SACjC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openzeppelin/upgrades-core",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.41.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
|
|
6
6
|
"license": "MIT",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"typescript": "^5.0.0"
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
|
-
"@nomicfoundation/slang": "^0.
|
|
64
|
+
"@nomicfoundation/slang": "^0.18.3",
|
|
65
65
|
"cbor": "^9.0.0",
|
|
66
66
|
"chalk": "^4.1.0",
|
|
67
67
|
"compare-versions": "^6.0.0",
|
package/src/index.ts
CHANGED
|
@@ -60,7 +60,7 @@ export {
|
|
|
60
60
|
export { ValidateUpgradeSafetyOptions, validateUpgradeSafety, ProjectReport, ReferenceContractNotFound } from './cli';
|
|
61
61
|
|
|
62
62
|
export { getUpgradeInterfaceVersion } from './upgrade-interface-version';
|
|
63
|
-
export { makeNamespacedInput } from './utils/make-namespaced';
|
|
63
|
+
export { makeNamespacedInput, trySanitizeNatSpec } from './utils/make-namespaced';
|
|
64
64
|
export { isNamespaceSupported } from './storage/namespace';
|
|
65
65
|
export { inferProxyAdmin } from './infer-proxy-admin';
|
|
66
66
|
export { assertUnreachable } from './utils/assert';
|
|
@@ -6,7 +6,7 @@ import {
|
|
|
6
6
|
TASK_COMPILE_SOLIDITY_RUN_SOLCJS,
|
|
7
7
|
} from 'hardhat/builtin-tasks/task-names';
|
|
8
8
|
|
|
9
|
-
import { makeNamespacedInput } from './make-namespaced';
|
|
9
|
+
import { makeNamespacedInput, trySanitizeNatSpec } from './make-namespaced';
|
|
10
10
|
import { SolcBuild } from 'hardhat/types/builtin-tasks';
|
|
11
11
|
import { SolcInput, SolcOutput } from '../solc-api';
|
|
12
12
|
import { BuildInfo } from 'hardhat/types';
|
|
@@ -40,11 +40,10 @@ async function testMakeNamespaced(
|
|
|
40
40
|
// Inefficient, but we want to test that we don't actually modify the original input object
|
|
41
41
|
const origInput = JSON.parse(JSON.stringify(origBuildInfo.input));
|
|
42
42
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
origBuildInfo.
|
|
46
|
-
|
|
47
|
-
);
|
|
43
|
+
let modifiedInput = makeNamespacedInput(origBuildInfo.input, origBuildInfo.output, origBuildInfo.solcVersion);
|
|
44
|
+
if (!keepAllNatSpec) {
|
|
45
|
+
modifiedInput = await trySanitizeNatSpec(modifiedInput, origBuildInfo.solcVersion);
|
|
46
|
+
}
|
|
48
47
|
|
|
49
48
|
// Run hardhat compile on the modified input and make sure it has no errors
|
|
50
49
|
const modifiedOutput = await hardhatCompile(modifiedInput, solcVersion);
|
|
@@ -34,10 +34,10 @@ const OUTPUT_SELECTION = {
|
|
|
34
34
|
*
|
|
35
35
|
* @param input The original solc input.
|
|
36
36
|
* @param output The original solc output.
|
|
37
|
-
* @param
|
|
37
|
+
* @param _solcVersion The version of the solc compiler that was originally used to compile the input. This argument is no longer used and is kept for backwards compatibility.
|
|
38
38
|
* @returns The modified solc input with storage layout that includes namespaced type information.
|
|
39
39
|
*/
|
|
40
|
-
export function makeNamespacedInput(input: SolcInput, output: SolcOutput,
|
|
40
|
+
export function makeNamespacedInput(input: SolcInput, output: SolcOutput, _solcVersion?: string): SolcInput {
|
|
41
41
|
const modifiedSources: Record<string, { content?: string }> = {};
|
|
42
42
|
|
|
43
43
|
for (const [sourcePath] of Object.entries(input.sources)) {
|
|
@@ -163,74 +163,77 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput, solcVe
|
|
|
163
163
|
}
|
|
164
164
|
}
|
|
165
165
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
modifiedSources[sourcePath] = { ...source, content: modifiedSource };
|
|
166
|
+
modifiedSources[sourcePath] = { ...source, content: getModifiedSource(orig, modifications) };
|
|
169
167
|
}
|
|
170
168
|
|
|
171
169
|
return { ...input, sources: modifiedSources, settings: { ...input.settings, outputSelection: OUTPUT_SELECTION } };
|
|
172
170
|
}
|
|
173
171
|
|
|
174
172
|
/**
|
|
175
|
-
*
|
|
176
|
-
*
|
|
173
|
+
* Attempts to remove all NatSpec comments that do not precede a struct definition from the input source contents.
|
|
174
|
+
* Directly modifies the input source contents, and also returns the modified input.
|
|
175
|
+
*
|
|
176
|
+
* If the solc version is not supported by the parser, the original content is kept.
|
|
177
|
+
*
|
|
178
|
+
* @param solcInput Solc input.
|
|
179
|
+
* @param solcVersion The version of the solc compiler that was originally used to compile the input.
|
|
180
|
+
* @returns The modified solc input with NatSpec comments removed where they do not precede a struct definition.
|
|
181
|
+
*/
|
|
182
|
+
export async function trySanitizeNatSpec(solcInput: SolcInput, solcVersion: string): Promise<SolcInput> {
|
|
183
|
+
for (const [sourcePath, source] of Object.entries(solcInput.sources)) {
|
|
184
|
+
if (source.content !== undefined) {
|
|
185
|
+
solcInput.sources[sourcePath].content = await tryRemoveNonStructNatSpec(source.content, solcVersion);
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
return solcInput;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* If Slang is supported for the current compiler version, use Slang to parse and remove all NatSpec comments
|
|
193
|
+
* that do not precede a struct definition and return the modified content.
|
|
177
194
|
*
|
|
178
195
|
* Otherwise, return the original content.
|
|
179
196
|
*/
|
|
180
|
-
function tryRemoveNonStructNatSpec(origContent: string, solcVersion: string
|
|
181
|
-
|
|
197
|
+
async function tryRemoveNonStructNatSpec(origContent: string, solcVersion: string): Promise<string> {
|
|
198
|
+
if (solcVersion === undefined) {
|
|
199
|
+
return origContent;
|
|
200
|
+
}
|
|
182
201
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
/* eslint-enable @typescript-eslint/no-var-requires */
|
|
202
|
+
const { Parser } = await import('@nomicfoundation/slang/parser');
|
|
203
|
+
if (!Parser.supportedVersions().includes(solcVersion)) {
|
|
204
|
+
return origContent;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
const { TerminalKind, TerminalKindExtensions } = await import('@nomicfoundation/slang/cst');
|
|
190
208
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
209
|
+
const parser = Parser.create(solcVersion);
|
|
210
|
+
const parseOutput = parser.parse(Parser.rootKind(), origContent);
|
|
211
|
+
const cursor = parseOutput.createTreeCursor();
|
|
212
|
+
|
|
213
|
+
const natSpecRemovals: Modification[] = [];
|
|
194
214
|
|
|
215
|
+
while (
|
|
216
|
+
cursor.goToNextTerminalWithKinds([TerminalKind.MultiLineNatSpecComment, TerminalKind.SingleLineNatSpecComment])
|
|
217
|
+
) {
|
|
218
|
+
// Lookahead to determine if the next non-trivia node is the struct keyword.
|
|
219
|
+
// If so, this NatSpec is part of the struct definition and should not be removed.
|
|
220
|
+
const lookaheadCursor = cursor.clone();
|
|
195
221
|
while (
|
|
196
|
-
|
|
222
|
+
lookaheadCursor.goToNextTerminal() &&
|
|
223
|
+
lookaheadCursor.node.isTerminalNode() &&
|
|
224
|
+
TerminalKindExtensions.isTrivia(lookaheadCursor.node.kind)
|
|
197
225
|
) {
|
|
198
|
-
//
|
|
199
|
-
|
|
200
|
-
const lookaheadCursor = cursor.clone();
|
|
201
|
-
while (lookaheadCursor.goToNextTerminal() && isTrivia(lookaheadCursor.node())) {
|
|
202
|
-
// skip over trivia nodes
|
|
203
|
-
}
|
|
204
|
-
if (lookaheadCursor.node().kind === TerminalKind.StructKeyword) {
|
|
205
|
-
continue;
|
|
206
|
-
}
|
|
226
|
+
// skip over trivia nodes
|
|
227
|
+
}
|
|
207
228
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
natSpecRemovals.push(makeDeleteRange(cursor.textRange.start.utf8, cursor.textRange.end.utf8));
|
|
229
|
+
if (lookaheadCursor.node.kind === TerminalKind.StructKeyword) {
|
|
230
|
+
continue;
|
|
211
231
|
}
|
|
212
|
-
return getModifiedSource(Buffer.from(origContent, 'utf8'), natSpecRemovals);
|
|
213
|
-
} else {
|
|
214
|
-
return origContent;
|
|
215
|
-
}
|
|
216
|
-
}
|
|
217
232
|
|
|
218
|
-
|
|
219
|
-
try {
|
|
220
|
-
require(id);
|
|
221
|
-
return true;
|
|
222
|
-
} catch (e: any) {
|
|
223
|
-
// do nothing
|
|
233
|
+
natSpecRemovals.push(makeDeleteRange(cursor.textRange.start.utf8, cursor.textRange.end.utf8));
|
|
224
234
|
}
|
|
225
|
-
return false;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
function slangSupportsVersion(solcVersion: string): boolean {
|
|
229
|
-
/* eslint-disable @typescript-eslint/no-var-requires */
|
|
230
|
-
const { Language } = require('@nomicfoundation/slang/language');
|
|
231
|
-
/* eslint-enable @typescript-eslint/no-var-requires */
|
|
232
235
|
|
|
233
|
-
return
|
|
236
|
+
return getModifiedSource(Buffer.from(origContent, 'utf8'), natSpecRemovals);
|
|
234
237
|
}
|
|
235
238
|
|
|
236
239
|
interface Modification {
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { Node } from '@nomicfoundation/slang/cst';
|
|
2
|
-
/**
|
|
3
|
-
* Returns true if the node is a trivia terminal (whitespace or comment or NatSpec)
|
|
4
|
-
*
|
|
5
|
-
* CAUTION: This must be imported dynamically.
|
|
6
|
-
* Only import this file if Slang is supported on the current platform, otherwise an error will be thrown on import.
|
|
7
|
-
*/
|
|
8
|
-
export declare function isTrivia(node: Node): boolean;
|
|
9
|
-
//# sourceMappingURL=trivia.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"trivia.d.ts","sourceRoot":"","sources":["../../../src/utils/slang/trivia.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAgB,MAAM,4BAA4B,CAAC;AAEhE;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,WAElC"}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isTrivia = isTrivia;
|
|
4
|
-
const kinds_1 = require("@nomicfoundation/slang/kinds");
|
|
5
|
-
const cst_1 = require("@nomicfoundation/slang/cst");
|
|
6
|
-
/**
|
|
7
|
-
* Returns true if the node is a trivia terminal (whitespace or comment or NatSpec)
|
|
8
|
-
*
|
|
9
|
-
* CAUTION: This must be imported dynamically.
|
|
10
|
-
* Only import this file if Slang is supported on the current platform, otherwise an error will be thrown on import.
|
|
11
|
-
*/
|
|
12
|
-
function isTrivia(node) {
|
|
13
|
-
return node instanceof cst_1.TerminalNode && isTriviaKind(node.kind);
|
|
14
|
-
}
|
|
15
|
-
function isTriviaKind(kind) {
|
|
16
|
-
return (kind === kinds_1.TerminalKind.EndOfLine ||
|
|
17
|
-
kind === kinds_1.TerminalKind.MultiLineComment ||
|
|
18
|
-
kind === kinds_1.TerminalKind.MultiLineNatSpecComment ||
|
|
19
|
-
kind === kinds_1.TerminalKind.SingleLineComment ||
|
|
20
|
-
kind === kinds_1.TerminalKind.SingleLineNatSpecComment ||
|
|
21
|
-
kind === kinds_1.TerminalKind.Whitespace);
|
|
22
|
-
}
|
|
23
|
-
//# sourceMappingURL=trivia.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"trivia.js","sourceRoot":"","sources":["../../../src/utils/slang/trivia.ts"],"names":[],"mappings":";;AASA,4BAEC;AAXD,wDAA4D;AAC5D,oDAAgE;AAEhE;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAU;IACjC,OAAO,IAAI,YAAY,kBAAY,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,YAAY,CAAC,IAAkB;IACtC,OAAO,CACL,IAAI,KAAK,oBAAY,CAAC,SAAS;QAC/B,IAAI,KAAK,oBAAY,CAAC,gBAAgB;QACtC,IAAI,KAAK,oBAAY,CAAC,uBAAuB;QAC7C,IAAI,KAAK,oBAAY,CAAC,iBAAiB;QACvC,IAAI,KAAK,oBAAY,CAAC,wBAAwB;QAC9C,IAAI,KAAK,oBAAY,CAAC,UAAU,CACjC,CAAC;AACJ,CAAC"}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { TerminalKind } from '@nomicfoundation/slang/kinds';
|
|
2
|
-
import { Node, TerminalNode } from '@nomicfoundation/slang/cst';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Returns true if the node is a trivia terminal (whitespace or comment or NatSpec)
|
|
6
|
-
*
|
|
7
|
-
* CAUTION: This must be imported dynamically.
|
|
8
|
-
* Only import this file if Slang is supported on the current platform, otherwise an error will be thrown on import.
|
|
9
|
-
*/
|
|
10
|
-
export function isTrivia(node: Node) {
|
|
11
|
-
return node instanceof TerminalNode && isTriviaKind(node.kind);
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
function isTriviaKind(kind: TerminalKind) {
|
|
15
|
-
return (
|
|
16
|
-
kind === TerminalKind.EndOfLine ||
|
|
17
|
-
kind === TerminalKind.MultiLineComment ||
|
|
18
|
-
kind === TerminalKind.MultiLineNatSpecComment ||
|
|
19
|
-
kind === TerminalKind.SingleLineComment ||
|
|
20
|
-
kind === TerminalKind.SingleLineNatSpecComment ||
|
|
21
|
-
kind === TerminalKind.Whitespace
|
|
22
|
-
);
|
|
23
|
-
}
|