Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent variable naming #198

Merged
merged 91 commits into from
Sep 13, 2019
Merged

Consistent variable naming #198

merged 91 commits into from
Sep 13, 2019

Conversation

rzadp
Copy link
Contributor

@rzadp rzadp commented Sep 5, 2019

CONFIGURATION.md Outdated
MONITOR_FOREIGN_START_BLOCK | The app will monitor transactions starting from this block | integer
MONITOR_VALIDATOR_HOME_TX_LIMIT | | integer
MONITOR_VALIDATOR_FOREIGN_TX_LIMIT | | integer
MONITOR_TX_NUMBER_THRESHOLD | | integer
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These 3 variables need some description, it was not described in any documentation before, and I'm not exactly sure what is the purpose for these.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MONITOR_VALIDATOR_HOME_TX_LIMIT - average gas usage of a transaction sent by a validator, it is used to estimate the number of transaction that can be paid by the validator.
MONITOR_VALIDATOR_FOREIGN_TX_LIMIT - average gas usage of a transaction sent by a validator, it is used to estimate the number of transaction that can be paid by the validator.
MONITOR_TX_NUMBER_THRESHOLD - if estimated number of transaction is equal to or below this value, the monitor will report that the validator has less funds than it is required.

@rzadp rzadp changed the title [WIP] Consistent variable naming Consistent variable naming Sep 6, 2019
@rzadp rzadp marked this pull request as ready for review September 6, 2019 16:26
@rzadp rzadp requested review from patitonar and akolotov September 6, 2019 16:26
@@ -254,14 +227,10 @@ When running the processes, the following commands can be used to test functiona

| Variable | Description |
|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `HOME_RPC_URL` | The HTTPS URL(s) used to communicate to the RPC nodes in the Home network. |
| `FOREIGN_RPC_URL` | The HTTPS URL(s) used to communicate to the RPC nodes in the Foreign network. |
| `USER_ADDRESS` | An account - the current owner of coins/tokens. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These parameters are for scripts that are using for testing. So, a separate .env file could be used there - cut copy of the .env file used to run the bridge. That's why it is important either to list the corresponding parameters here one more time or to have its own set of parameters that will be used only for testing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done - I have rolled back the removal of these lines, only updating with proper prefix.

CONFIGURATION.md Outdated
MONITOR_FOREIGN_START_BLOCK | The app will monitor transactions starting from this block | integer
MONITOR_VALIDATOR_HOME_TX_LIMIT | | integer
MONITOR_VALIDATOR_FOREIGN_TX_LIMIT | | integer
MONITOR_TX_NUMBER_THRESHOLD | | integer
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MONITOR_VALIDATOR_HOME_TX_LIMIT - average gas usage of a transaction sent by a validator, it is used to estimate the number of transaction that can be paid by the validator.
MONITOR_VALIDATOR_FOREIGN_TX_LIMIT - average gas usage of a transaction sent by a validator, it is used to estimate the number of transaction that can be paid by the validator.
MONITOR_TX_NUMBER_THRESHOLD - if estimated number of transaction is equal to or below this value, the monitor will report that the validator has less funds than it is required.

- REACT_APP_FOREIGN_GAS_PRICE_FALLBACK=5000000000
- REACT_APP_FOREIGN_GAS_PRICE_UPDATE_INTERVAL=15000
- REACT_APP_FOREIGN_GAS_PRICE_FACTOR=1
- REACT_APP_COMMON_HOME_BRIDGE_ADDRESS=0x32198D570fffC7033641F8A9094FFDCaAEF42624
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible by somehow avoid usage of the REACT_APP_ prefix here? For example - to refer to an .env file here instead of the variables and use pre-processing before running docker-compose to generate proper variables with correct prefix?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Achieved in #207

@rzadp
Copy link
Contributor Author

rzadp commented Sep 11, 2019

@akolotov All the requested changes are addressed now. Do you have anything more to ask or change?

@akolotov
Copy link
Collaborator

the PR has been approved for the merge

@rzadp rzadp merged commit 8b010f8 into master Sep 13, 2019
@rzadp rzadp deleted the configuration branch September 13, 2019 07:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consistent variable naming across components and deployment
2 participants