aboutsummaryrefslogtreecommitdiffstats
path: root/packages/migrations/src
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-11-22 05:19:31 +0800
committerFabio Berger <me@fabioberger.com>2018-11-22 05:19:31 +0800
commit83a043e6397421db0d1d5b8059341b84eeb1e1a7 (patch)
treeb7685c0285283ebce73786a2e8b0ff0996eeb243 /packages/migrations/src
parent8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c (diff)
parentf46a49fd13c88dd86c9661d76bace18844642c04 (diff)
downloaddexon-sol-tools-master.tar
dexon-sol-tools-master.tar.gz
dexon-sol-tools-master.tar.bz2
dexon-sol-tools-master.tar.lz
dexon-sol-tools-master.tar.xz
dexon-sol-tools-master.tar.zst
dexon-sol-tools-master.zip
Merge branch 'development'master
* development: (81 commits) Publish Updated CHANGELOGS print out error message and stack immediately return the patch incremented version if no changelog entries exist Put python package above TS/JS packages Reduce title size reduce text side in README Improve top-level README Fix prettier remove unused flag Add CHANGELOG entry Fix additional comments Improve comments Add migrations, contract-addresses and contract-artifacts to Developers home Create migrations doc reference page Add additional CHANGELOG to types package Add CHANGELOG entry Fix prettier Fix `SimpleContractArtifact` type Update abi-gen-wrappers ...
Diffstat (limited to 'packages/migrations/src')
-rw-r--r--packages/migrations/src/index.ts10
-rw-r--r--packages/migrations/src/migration.ts11
2 files changed, 15 insertions, 6 deletions
diff --git a/packages/migrations/src/index.ts b/packages/migrations/src/index.ts
index 8f629a24b..4f22c30b9 100644
--- a/packages/migrations/src/index.ts
+++ b/packages/migrations/src/index.ts
@@ -1 +1,11 @@
+export {
+ Provider,
+ TxData,
+ JSONRPCRequestPayload,
+ JSONRPCErrorCallback,
+ TxDataPayable,
+ JSONRPCResponsePayload,
+ JSONRPCResponseError,
+} from 'ethereum-types';
+export { ContractAddresses } from '@0x/contract-addresses';
export { runMigrationsAsync, runMigrationsOnceAsync } from './migration';
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(