Implement partial transpilation #130
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // SPDX-License-Identifier: UNLICENSED | ||
| pragma solidity ^0.6; | ||
|
|
||
| interface ISomeInterface { | ||
| function someFunction() external returns (bool); | ||
| function someOtherFunction() external returns (bool); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| // SPDX-License-Identifier: UNLICENSED | ||
| pragma solidity ^0.6; | ||
|
|
||
| import { ISomeInterface } from "./ISomeInterface.sol"; | ||
| import { SomeLibrary } from "./SomeLibrary.sol"; | ||
|
|
||
| interface ISomeContract is ISomeInterface {} | ||
|
|
||
| contract SomeContract is ISomeContract { | ||
| function someFunction() public override returns (bool) { | ||
| return false; | ||
| } | ||
|
|
||
| function someOtherFunction() public override returns (bool) { | ||
| return true; | ||
| } | ||
|
|
||
| function test(ISomeInterface other) public returns (bool) { | ||
| return SomeLibrary.bothFunctions(this) && SomeLibrary.bothFunctions(other); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // SPDX-License-Identifier: UNLICENSED | ||
| pragma solidity ^0.6; | ||
|
|
||
| import { ISomeInterface } from "./ISomeInterface.sol"; | ||
|
|
||
| library SomeLibrary { | ||
| function bothFunctions(ISomeInterface instance) internal returns (bool) { | ||
| return instance.someFunction() && instance.someOtherFunction(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| // SPDX-License-Identifier: UNLICENSED | ||
| pragma solidity ^0.6; | ||
|
|
||
| import { ISomeInterface } from "./ISomeInterface.sol"; | ||
| import { SomeLibrary } from "./SomeLibrary.sol"; | ||
| import { ISomeContract, SomeContract } from "./SomeContract.sol"; | ||
|
|
||
| contract SomeOtherContract is SomeContract { | ||
| function extraFunction() public returns (uint256) { | ||
| return 42; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,10 +3,13 @@ import fs from 'fs'; | |
| import { mapValues } from 'lodash'; | ||
| import { minimatch } from 'minimatch'; | ||
|
|
||
| import { findAll } from 'solidity-ast/utils'; | ||
| import { Node } from 'solidity-ast/node'; | ||
|
|
||
| import { matcher } from './utils/matcher'; | ||
| import { renamePath, isRenamed } from './rename'; | ||
| import { SolcOutput, SolcInput } from './solc/input-output'; | ||
| import { Transform, TransformData } from './transform'; | ||
| import { generateWithInit } from './generate-with-init'; | ||
| import { findAlreadyInitializable } from './find-already-initializable'; | ||
|
|
||
|
|
@@ -15,6 +18,7 @@ import { renameIdentifiers } from './transformations/rename-identifiers'; | |
| import { prependInitializableBase } from './transformations/prepend-initializable-base'; | ||
| import { removeStateVarInits } from './transformations/purge-var-inits'; | ||
| import { removeImmutable } from './transformations/remove-immutable'; | ||
| import { removePartial } from './transformations/remove-partial'; | ||
| import { removeInheritanceListArguments } from './transformations/remove-inheritance-list-args'; | ||
| import { renameContractDefinition } from './transformations/rename-contract-definition'; | ||
| import { appendInitializableImport } from './transformations/append-initializable-import'; | ||
|
|
@@ -47,11 +51,14 @@ interface TranspileOptions { | |
| skipWithInit?: boolean; | ||
| namespaced?: boolean; | ||
| namespaceExclude?: string[]; | ||
| peerProject?: string; | ||
| } | ||
|
|
||
| type NodeTransformData = { node: Node; data: Partial<TransformData> }; | ||
|
|
||
| function getExtraOutputPaths( | ||
| paths: Paths, | ||
| options: TranspileOptions = {}, | ||
| ): Record<'initializable' | 'withInit', string> { | ||
| const outputPaths = mapValues( | ||
| { | ||
|
|
@@ -61,50 +68,98 @@ function getExtraOutputPaths( | |
| s => path.relative(paths.root, path.join(paths.sources, s)), | ||
| ); | ||
|
|
||
| if (options.initializablePath) { | ||
| outputPaths.initializable = options.initializablePath; | ||
| } | ||
|
|
||
| return outputPaths; | ||
| } | ||
|
|
||
| function getExcludeAndImportPathsForPeer( | ||
| solcOutput: SolcOutput, | ||
| peerProject: string, | ||
| ): [Set<string>, NodeTransformData[]] { | ||
| const data: NodeTransformData[] = []; | ||
| const exclude: Set<string> = new Set(); | ||
|
|
||
| for (const [source, { ast }] of Object.entries(solcOutput.sources)) { | ||
| let shouldExclude = true; | ||
| for (const node of findAll('ContractDefinition', ast)) { | ||
| if (node.contractKind === 'contract') { | ||
|
||
| shouldExclude = false; | ||
| } else { | ||
| const importFromPeer = path.join(peerProject, source); | ||
| data.push({ node, data: { importFromPeer } }); | ||
| } | ||
| } | ||
| if (shouldExclude) { | ||
| exclude.add(source); | ||
| } | ||
| } | ||
|
|
||
| return [exclude, data]; | ||
| } | ||
|
|
||
| export async function transpile( | ||
| solcInput: SolcInput, | ||
| solcOutput: SolcOutput, | ||
| paths: Paths, | ||
| options: TranspileOptions = {}, | ||
| ): Promise<OutputFile[]> { | ||
| const nodeData: NodeTransformData[] = []; | ||
|
|
||
| const outputPaths = getExtraOutputPaths(paths, options); | ||
| const alreadyInitializable = findAlreadyInitializable(solcOutput, options.initializablePath); | ||
|
|
||
| const excludeSet = new Set([...alreadyInitializable, ...Object.values(outputPaths)]); | ||
| const softExcludeSet = new Set(); | ||
| const excludeMatch = matcher(options.exclude ?? []); | ||
|
|
||
| const namespaceInclude = (source: string) => { | ||
| const namespaced = options.namespaced ?? false; | ||
| const namespaceExclude = options.namespaceExclude ?? []; | ||
| return namespaced && !namespaceExclude.some(p => minimatch(source, p)); | ||
| }; | ||
|
|
||
| // if partial transpilation, extract the list of soft exclude, and the peer import paths. | ||
| if (options.peerProject !== undefined) { | ||
| const [peerSoftExcludeSet, importFromPeerData] = getExcludeAndImportPathsForPeer( | ||
| solcOutput, | ||
| options.peerProject, | ||
| ); | ||
| peerSoftExcludeSet.forEach(source => softExcludeSet.add(source)); | ||
| nodeData.push(...importFromPeerData); | ||
| } | ||
|
|
||
| const transform = new Transform(solcInput, solcOutput, { | ||
| exclude: source => | ||
| excludeSet.has(source) || (excludeMatch(source) ?? isRenamed(source)) | ||
| ? 'hard' | ||
| : softExcludeSet.has(source) | ||
| ? 'soft' | ||
| : false, | ||
| }); | ||
|
|
||
| for (const { node, data } of nodeData) { | ||
| Object.assign(transform.getData(node), data); | ||
| } | ||
|
|
||
| transform.apply(renameIdentifiers); | ||
| transform.apply(renameContractDefinition); | ||
| transform.apply(renameInheritdoc); | ||
| transform.apply(prependInitializableBase); | ||
| transform.apply(fixImportDirectives(!!options.peerProject)); | ||
| transform.apply(appendInitializableImport(outputPaths.initializable)); | ||
| transform.apply(fixNewStatement); | ||
| transform.apply(transformConstructor(namespaceInclude)); | ||
| transform.apply(removeLeftoverConstructorHead); | ||
| transform.apply(addRequiredPublicInitializer(options.publicInitializers)); | ||
| transform.apply(removeInheritanceListArguments); | ||
| transform.apply(removeStateVarInits); | ||
| transform.apply(removeImmutable); | ||
| transform.apply(removePartial); | ||
|
|
||
| if (options.namespaced) { | ||
| transform.apply(addNamespaceStruct(namespaceInclude)); | ||
| } else { | ||
| transform.apply(addStorageGaps); | ||
|
|
@@ -126,8 +181,11 @@ export async function transpile( | |
| } | ||
|
|
||
| const initializableSource = | ||
| options.initializablePath !== undefined | ||
| ? transpileInitializable(solcInput, solcOutput, paths, { | ||
| ...options, | ||
| initializablePath: options.initializablePath, | ||
| }) | ||
| : fs.readFileSync(require.resolve('../Initializable.sol'), 'utf8'); | ||
|
|
||
| outputFiles.push({ | ||
|
|
@@ -136,9 +194,9 @@ export async function transpile( | |
| fileName: path.basename(outputPaths.initializable), | ||
| }); | ||
|
|
||
| if (!options.skipWithInit) { | ||
| outputFiles.push({ | ||
| source: generateWithInit(transform, outputPaths.withInit, options.solcVersion), | ||
| path: outputPaths.withInit, | ||
| fileName: path.basename(outputPaths.withInit), | ||
| }); | ||
|
|
@@ -151,16 +209,16 @@ function transpileInitializable( | |
| solcInput: SolcInput, | ||
| solcOutput: SolcOutput, | ||
| paths: Paths, | ||
| options: TranspileOptions & Required<Pick<TranspileOptions, 'initializablePath'>>, | ||
| ): string { | ||
| const transform = new Transform(solcInput, solcOutput); | ||
|
|
||
| transform.apply(function* (ast, tools) { | ||
| if (ast.absolutePath === options.initializablePath) { | ||
| yield* renameIdentifiers(ast, tools); | ||
| yield* fixImportDirectives(!!options.peerProject)(ast, tools); | ||
| } | ||
| }); | ||
|
|
||
| return transform.results()[options.initializablePath]; | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.