aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-11-21 19:48:07 +0800
committerFabio Berger <me@fabioberger.com>2018-11-21 19:48:07 +0800
commita90be44c9fe8dd64d4d5d182658deb7b740504f8 (patch)
tree3f618037fb537afe4e07644be70d3372b2de486a
parentfb7ac819456c86f9e5f8d2bef3127f21727f486d (diff)
downloaddexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.tar
dexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.tar.gz
dexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.tar.bz2
dexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.tar.lz
dexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.tar.xz
dexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.tar.zst
dexon-sol-tools-a90be44c9fe8dd64d4d5d182658deb7b740504f8.zip
Improve comments
-rw-r--r--packages/migrations/src/migration.ts7
1 files changed, 3 insertions, 4 deletions
diff --git a/packages/migrations/src/migration.ts b/packages/migrations/src/migration.ts
index 86c76a54b..570f18408 100644
--- a/packages/migrations/src/migration.ts
+++ b/packages/migrations/src/migration.ts
@@ -11,10 +11,9 @@ import { erc20TokenInfo, erc721TokenInfo } from './utils/token_info';
/**
* Creates and deploys all the contracts that are required for the latest
- * version of the 0x protocol. Custom migrations can be defined here. This will
- * be called with the CLI 'migrate:v2' command.
- * @param provider Web3 provider instance.
- * @param txDefaults Default transaction values to use when deploying contracts.
+ * version of the 0x protocol.
+ * @param provider Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to.
+ * @param txDefaults Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter).
* @returns The addresses of the contracts that were deployed.
*/
export async function runMigrationsAsync(provider: Provider, txDefaults: Partial<TxData>): Promise<ContractAddresses> {