Add AMB-ERC-TO-ERC example config

deploy/README.md

@@ -515,3 +515,112 @@ REQUIRED_NUMBER_OF_VALIDATORS=1
 # correctly to the Foreign network.
 VALIDATORS="0x 0x 0x"
 ```
+
+## `AMB-ERC-TO-ERC` Bridge Mode Configuration Example. 
+
+This example of an `.env` file for the `AMB-ERC-TO-ERC` bridge mode includes comments describing each parameter.
+
+```bash
+# The type of bridge. Defines set of contracts to be deployed.
+BRIDGE_MODE=AMB_ERC_TO_ERC
+
+# If Home network does not support byzantium fork, should use contracts compiled for spuriousDragon
+# Default value is byzantium
+#HOME_EVM_VERSION=spuriousDragon
+
+# If Foreign network does not support byzantium fork, should use contracts compiled for spuriousDragon
+# Default value is byzantium
+#FOREIGN_EVM_VERSION=spuriousDragon
+
+# The private key hex value of the account responsible for contracts
+# deployments and initial configuration. The account's balance must contain
+# funds from both networks.
+DEPLOYMENT_ACCOUNT_PRIVATE_KEY=67..14
+# Extra gas added to the estimated gas of a particular deployment/configuration transaction
+# E.g. if estimated gas returns 100000 and the parameter is 0.2, 
+# the transaction gas limit will be (100000 + 100000 * 0.2) = 120000
+DEPLOYMENT_GAS_LIMIT_EXTRA=0.2
+# The "gasPrice" parameter set in every deployment/configuration transaction on
+# Home network (in Wei).
+HOME_DEPLOYMENT_GAS_PRICE=10000000000
+# The "gasPrice" parameter set in every deployment/configuration transaction on
+# Foreign network (in Wei).
+FOREIGN_DEPLOYMENT_GAS_PRICE=10000000000
+# The timeout limit to wait for receipt of the deployment/configuration
+# transaction.
+GET_RECEIPT_INTERVAL_IN_MILLISECONDS=3000
+
+# The name of the ERC677 token to be deployed on the Home network.
+BRIDGEABLE_TOKEN_NAME=Your New Bridged Token
+# The symbol name of the ERC677 token to be deployed on the Home network.
+BRIDGEABLE_TOKEN_SYMBOL=TEST
+# The number of supportable decimal digits after the "point" in the ERC677 token
+# to be deployed on the Home network.
+BRIDGEABLE_TOKEN_DECIMALS=18
+# The flag defining whether to use ERC677BridgeTokenRewardable contract instead of
+# ERC677BridgeToken on Home network.
+DEPLOY_REWARDABLE_TOKEN=false
+# The address of Staking contract used by ERC677BridgeTokenRewardable contract.
+# Makes sense only when DEPLOY_REWARDABLE_TOKEN=true
+DPOS_STAKING_ADDRESS=0x
+# The address of BlockReward contract used by ERC677BridgeTokenRewardable contract.
+# Makes sense only when DEPLOY_REWARDABLE_TOKEN=true
+BLOCK_REWARD_ADDRESS=0x
+
+# The RPC channel to a Home node able to handle deployment/configuration
+# transactions.
+HOME_RPC_URL=https://core.poa.network
+# Address on Home network with permissions to change parameters of the bridge contract.
+# For extra security we recommended using a multi-sig wallet contract address here.
+HOME_BRIDGE_OWNER=0x
+# Address on Home network with permissions to upgrade the bridge contract
+HOME_UPGRADEABLE_ADMIN=0x
+# The daily transaction limit in Wei. As soon as this limit is exceeded, any
+# transaction which requests to relay assets will fail.
+HOME_DAILY_LIMIT=30000000000000000000000000
+# The maximum limit for one transaction in Wei. If a single transaction tries to
+# relay funds exceeding this limit it will fail. HOME_MAX_AMOUNT_PER_TX must be 
+# less than HOME_DAILY_LIMIT.
+HOME_MAX_AMOUNT_PER_TX=1500000000000000000000000
+# The minimum limit for one transaction in Wei. If a transaction tries to relay
+# funds below this limit it will fail. This is required to prevent dryout
+# validator accounts. 
+HOME_MIN_AMOUNT_PER_TX=500000000000000000
+
+# The RPC channel to a Foreign node able to handle deployment/configuration
+# transactions.
+FOREIGN_RPC_URL=https://mainnet.infura.io
+# Address on Foreign network with permissions to change parameters of the bridge contract.
+# For extra security we recommended using a multi-sig wallet contract address here.
+FOREIGN_BRIDGE_OWNER=0x
+# Address on Foreign network with permissions to change parameters of bridge validator contract.
+FOREIGN_VALIDATORS_OWNER=0x
+# Address on Foreign network with permissions to upgrade the bridge contract and the 
+# bridge validator contract.
+FOREIGN_UPGRADEABLE_ADMIN=0x
+# The daily limit in Wei. As soon as this limit is exceeded, any transaction
+# requesting to relay assets will fail.
+FOREIGN_DAILY_LIMIT=15000000000000000000000000
+# The maximum limit per one transaction in Wei. If a transaction tries to relay
+# funds exceeding this limit it will fail. FOREIGN_MAX_AMOUNT_PER_TX must be less
+# than FOREIGN_DAILY_LIMIT.
+FOREIGN_MAX_AMOUNT_PER_TX=750000000000000000000000
+# The minimum limit for one transaction in Wei. If a transaction tries to relay
+# funds below this limit it will fail.
+FOREIGN_MIN_AMOUNT_PER_TX=500000000000000000
+# The address of the existing ERC20/ERC677 compatible token in the Foreign network to
+# be exchanged to the ERC20/ERC677 token deployed on Home.
+ERC20_TOKEN_ADDRESS=0x
+# The address of the existing AMB bridge in the Home network that will be used to pass messages
+# to the Foreign network.
+HOME_AMB_BRIDGE=0x
+# The address of the existing AMB bridge in the Foreign network that will be used to pass messages
+# to the Home network.
+FOREIGN_AMB_BRIDGE=0x
+# The gas limit that will be used in the execution of the message passed to the mediator contract
+# in the Foreign network.
+HOME_MEDIATOR_REQUEST_GAS_LIMIT=2000000
+# The gas limit that will be used in the execution of the message passed to the mediator contract
+# in the Home network.
+FOREIGN_MEDIATOR_REQUEST_GAS_LIMIT=2000000
+```