aboutsummaryrefslogtreecommitdiffstats
path: root/packages/deployer/src/utils/compiler.ts
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-03-22 01:06:50 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-03-22 01:06:50 +0800
commite31ba2e12e90cca10037d2f6bf8ae17fe42e1991 (patch)
tree8d3e9ad5e90c07efbd53d5e6ad0126f7c313f460 /packages/deployer/src/utils/compiler.ts
parent73f8ae9a47b151d518d759d0d7cf79f6bea794d3 (diff)
downloaddexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.tar
dexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.tar.gz
dexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.tar.bz2
dexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.tar.lz
dexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.tar.xz
dexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.tar.zst
dexon-0x-contracts-e31ba2e12e90cca10037d2f6bf8ae17fe42e1991.zip
Add missing param comments
Diffstat (limited to 'packages/deployer/src/utils/compiler.ts')
-rw-r--r--packages/deployer/src/utils/compiler.ts3
1 files changed, 3 insertions, 0 deletions
diff --git a/packages/deployer/src/utils/compiler.ts b/packages/deployer/src/utils/compiler.ts
index d8b5f78c9..9c8fef26d 100644
--- a/packages/deployer/src/utils/compiler.ts
+++ b/packages/deployer/src/utils/compiler.ts
@@ -9,6 +9,7 @@ import { ContractArtifact, ContractSources } from './types';
/**
* Gets contract data on network or returns if an artifact does not exist.
+ * @param artifactsDir Path to the artifacts directory.
* @param fileName Name of contract file.
* @return Contract data on network or undefined.
*/
@@ -34,6 +35,7 @@ export async function getContractArtifactIfExistsAsync(
/**
* Creates the artifacts directory if it does not already exist.
+ * @param artifactsDir Path to the artifacts directory.
*/
export async function createArtifactsDirIfDoesNotExistAsync(artifactsDir: string): Promise<void> {
if (!fsWrapper.doesPathExistSync(artifactsDir)) {
@@ -104,6 +106,7 @@ export function parseDependencies(source: string): string[] {
/**
* Callback to resolve dependencies with `solc.compile`.
* Throws error if contractSources not yet initialized.
+ * @param contractSources Source codes of contracts.
* @param importPath Path to an imported dependency.
* @return Import contents object containing source code of dependency.
*/