From 89d1e4821f475caa9e944c86015b724364fa2df3 Mon Sep 17 00:00:00 2001 From: Adrian Li Date: Thu, 16 Apr 2020 17:31:02 -0400 Subject: [PATCH] clarify accounts property in options object --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index abf39638ab..498cf87b73 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,9 @@ server.listen(port, function(err, blockchain) { ... }); Both `.provider()` and `.server()` take a single object which allows you to specify behavior of the Ganache instance. This parameter is optional. Available options are: -* `"accounts"`: `Array` of `Object`'s. Each object should have a `balance` key with a hexadecimal value. The key `secretKey` can also be specified, which represents the account's private key. If no `secretKey`, the address is auto-generated with the given balance. If specified, the key is used to determine the account's address. +* `"accounts"`: `Array` of `Object`'s of the following shape: `{ secretKey: privateKey, balance: HexString }`. + * If `secretKey` is specified, the key is used to determine the account's address. Otherwise, the address is auto-generated. + * The `balance` is a hexadecimal value of the amount of Ether (in Wei) you want the account to be pre-loaded with. * `"debug"`: `boolean` - Output VM opcodes for debugging * `"blockTime"`: `number` - Specify blockTime in seconds for automatic mining. If you don't specify this flag, ganache will instantly mine a new block for every transaction. Using the `blockTime` option is discouraged unless you have tests which require a specific mining interval. * `"logger"`: `Object` - Object, like `console`, that implements a `log()` function.