aboutsummaryrefslogtreecommitdiffstats
path: root/packages/migrations/src/migration.ts
diff options
context:
space:
mode:
authorSteve Klebanoff <steve.klebanoff@gmail.com>2018-11-22 06:14:27 +0800
committerSteve Klebanoff <steve.klebanoff@gmail.com>2018-11-22 06:14:27 +0800
commit0adc8f5053894de7df85aacb6a8bf8714f989f0a (patch)
tree24ddf4531ef472739b276711a4b85e9a3017b156 /packages/migrations/src/migration.ts
parenteca63b1a5815c61901453837f9c2b737fa82eb20 (diff)
parentf46a49fd13c88dd86c9661d76bace18844642c04 (diff)
downloaddexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.tar
dexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.tar.gz
dexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.tar.bz2
dexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.tar.lz
dexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.tar.xz
dexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.tar.zst
dexon-sol-tools-0adc8f5053894de7df85aacb6a8bf8714f989f0a.zip
Merge branch 'development' into feature/header-tweaks
Diffstat (limited to 'packages/migrations/src/migration.ts')
-rw-r--r--packages/migrations/src/migration.ts11
1 files changed, 5 insertions, 6 deletions
diff --git a/packages/migrations/src/migration.ts b/packages/migrations/src/migration.ts
index 86c76a54b..61ac56938 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> {
@@ -159,8 +158,8 @@ let _cachedContractAddresses: ContractAddresses;
* Exactly like runMigrationsAsync but will only run the migrations the first
* time it is called. Any subsequent calls will return the cached contract
* addresses.
- * @param provider Web3 provider instance.
- * @param txDefaults Default transaction values to use when deploying contracts.
+ * @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 runMigrationsOnceAsync(