diff options
Diffstat (limited to 'packages/deployer/src/compiler.ts')
-rw-r--r-- | packages/deployer/src/compiler.ts | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/packages/deployer/src/compiler.ts b/packages/deployer/src/compiler.ts index 712169c89..1f521dca1 100644 --- a/packages/deployer/src/compiler.ts +++ b/packages/deployer/src/compiler.ts @@ -33,6 +33,10 @@ import { utils } from './utils/utils'; const ALL_CONTRACTS_IDENTIFIER = '*'; +/** + * The Compiler facilitates compiling Solidity smart contracts and saves the results + * to artifact files. + */ export class Compiler { private _contractsDir: string; private _networkId: number; @@ -96,7 +100,7 @@ export class Compiler { this._specifiedContracts = opts.specifiedContracts; } /** - * Compiles selected Solidity files and writes JSON artifacts to artifactsDir. + * Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`. */ public async compileAsync(): Promise<void> { await createArtifactsDirIfDoesNotExistAsync(this._artifactsDir); |