From c1540dc2eaedfbf14915becc276baac7c371892e Mon Sep 17 00:00:00 2001 From: Jonathan Rainville Date: Mon, 18 Jun 2018 15:40:06 -0400 Subject: [PATCH] add comments in blockchain configs --- templates/boilerplate/config/blockchain.js | 45 ++++++++++++---------- templates/demo/config/blockchain.js | 45 ++++++++++++---------- 2 files changed, 48 insertions(+), 42 deletions(-) diff --git a/templates/boilerplate/config/blockchain.js b/templates/boilerplate/config/blockchain.js index b37632082..322754ee2 100644 --- a/templates/boilerplate/config/blockchain.js +++ b/templates/boilerplate/config/blockchain.js @@ -1,28 +1,31 @@ module.exports = { development: { enabled: true, - networkType: "custom", - networkId: "1337", - isDev: true, - genesisBlock: "config/development/genesis.json", - datadir: ".embark/development/datadir", - mineWhenNeeded: true, - nodiscover: true, - maxpeers: 0, - rpcHost: "localhost", - rpcPort: 8545, - rpcCorsDomain: "auto", - proxy: true, + networkType: "custom", // Can be: testnet, rinkeby, livenet or custom, in which case, it will use the specified networkId + networkId: "1337", // Network id used when networkType is custom + isDev: true, // Uses and ephemeral proof-of-authority network with a pre-funded developer account, mining enabled + genesisBlock: "config/development/genesis.json", // Genesis block to initiate on first creation of a development node + datadir: ".embark/development/datadir", // Data directory for the databases and keystore + mineWhenNeeded: true, // Uses our custom script (if isDev is false) to mine only when needed + nodiscover: true, // Disables the peer discovery mechanism (manual peer addition) + maxpeers: 0, // Maximum number of network peers (network disabled if set to 0) (default: 25) + rpcHost: "localhost", // HTTP-RPC server listening interface (default: "localhost") + rpcPort: 8545, // HTTP-RPC server listening port (default: 8545) + rpcCorsDomain: "auto", // Comma separated list of domains from which to accept cross origin requests (browser enforced) + // When set to "auto", Embark will automatically set the cors to the address of the webserver + proxy: true, // Proxy is used to present meaningful information about transactions account: { - password: "config/development/password" + // "address": "", // When specified, uses that address instead of the default one for the network + password: "config/development/password" // Password to unlock the account }, - targetGasLimit: 8000000, - wsOrigins: "auto", - wsRPC: true, - wsHost: "localhost", - wsPort: 8546, - simulatorMnemonic: "example exile argue silk regular smile grass bomb merge arm assist farm", - simulatorBlocktime: 0 + targetGasLimit: 8000000, // Target gas limit sets the artificial target gas floor for the blocks to mine + wsRPC: true, // Enable the WS-RPC server + wsOrigins: "auto", // Origins from which to accept websockets requests + // When set to "auto", Embark will automatically set the cors to the address of the webserver + wsHost: "localhost", // WS-RPC server listening interface (default: "localhost") + wsPort: 8546, // WS-RPC server listening port (default: 8546) + simulatorMnemonic: "example exile argue silk regular smile grass bomb merge arm assist farm", // Mnemonic used by the simulator to generate a wallet + simulatorBlocktime: 0 // Specify blockTime in seconds for automatic mining. Default is 0 and no auto-mining. }, testnet: { enabled: true, @@ -56,4 +59,4 @@ module.exports = { networkId: "123", bootnodes: "" } -} +}; diff --git a/templates/demo/config/blockchain.js b/templates/demo/config/blockchain.js index b37632082..322754ee2 100644 --- a/templates/demo/config/blockchain.js +++ b/templates/demo/config/blockchain.js @@ -1,28 +1,31 @@ module.exports = { development: { enabled: true, - networkType: "custom", - networkId: "1337", - isDev: true, - genesisBlock: "config/development/genesis.json", - datadir: ".embark/development/datadir", - mineWhenNeeded: true, - nodiscover: true, - maxpeers: 0, - rpcHost: "localhost", - rpcPort: 8545, - rpcCorsDomain: "auto", - proxy: true, + networkType: "custom", // Can be: testnet, rinkeby, livenet or custom, in which case, it will use the specified networkId + networkId: "1337", // Network id used when networkType is custom + isDev: true, // Uses and ephemeral proof-of-authority network with a pre-funded developer account, mining enabled + genesisBlock: "config/development/genesis.json", // Genesis block to initiate on first creation of a development node + datadir: ".embark/development/datadir", // Data directory for the databases and keystore + mineWhenNeeded: true, // Uses our custom script (if isDev is false) to mine only when needed + nodiscover: true, // Disables the peer discovery mechanism (manual peer addition) + maxpeers: 0, // Maximum number of network peers (network disabled if set to 0) (default: 25) + rpcHost: "localhost", // HTTP-RPC server listening interface (default: "localhost") + rpcPort: 8545, // HTTP-RPC server listening port (default: 8545) + rpcCorsDomain: "auto", // Comma separated list of domains from which to accept cross origin requests (browser enforced) + // When set to "auto", Embark will automatically set the cors to the address of the webserver + proxy: true, // Proxy is used to present meaningful information about transactions account: { - password: "config/development/password" + // "address": "", // When specified, uses that address instead of the default one for the network + password: "config/development/password" // Password to unlock the account }, - targetGasLimit: 8000000, - wsOrigins: "auto", - wsRPC: true, - wsHost: "localhost", - wsPort: 8546, - simulatorMnemonic: "example exile argue silk regular smile grass bomb merge arm assist farm", - simulatorBlocktime: 0 + targetGasLimit: 8000000, // Target gas limit sets the artificial target gas floor for the blocks to mine + wsRPC: true, // Enable the WS-RPC server + wsOrigins: "auto", // Origins from which to accept websockets requests + // When set to "auto", Embark will automatically set the cors to the address of the webserver + wsHost: "localhost", // WS-RPC server listening interface (default: "localhost") + wsPort: 8546, // WS-RPC server listening port (default: 8546) + simulatorMnemonic: "example exile argue silk regular smile grass bomb merge arm assist farm", // Mnemonic used by the simulator to generate a wallet + simulatorBlocktime: 0 // Specify blockTime in seconds for automatic mining. Default is 0 and no auto-mining. }, testnet: { enabled: true, @@ -56,4 +59,4 @@ module.exports = { networkId: "123", bootnodes: "" } -} +};