-
Notifications
You must be signed in to change notification settings - Fork 46
Add documentation for aggregator env vars #357
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably good for someone with more aggregator experience to review but this all sounds good to me. Thanks for adding!
aggregator/README.md
Outdated
| USE_TEST_NET | false | Whether to set all transaction's `gasPrice` to 0. Workaround for some networks | | ||
| ORIGIN | http://localhost:3000 | The origin for the aggregator client. Used only in manual tests | | ||
| PORT | 3000 | The port to bind the aggregator to | | ||
| NETWORK_CONFIG_PATH | ../contracts/networks/local.json | Path to the netowrk config file, which contains information on deployed BLS Wallet contracts | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: typo in network
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
aggregator/README.md
Outdated
| MAX_AGGREGATION_SIZE | 12 | Maximum number of actions from bundles which will be aggregated together for submission on chain | | ||
| MAX_AGGREGATION_DELAY_MILLIS | 5000 | Maximum amount of time in milliseconds aggregator will wait before submitting bundles on chain | | ||
| MAX_UNCONFIRMED_AGGREGATIONS | 3 | Maximum unconfirmed bundle aggregations that will be submitted on chain. Multiplied with `MAX_AGGREGATION_SIZE` to determine maximum of unconfirmed on chain actions | | ||
| LOG_QUERIES | false | Whether to print Postgres quries in event log.`TEST_LOGGING` must be enabled | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: typo in queries
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
249628a
to
2007188
Compare
@voltrevo can take a look when he's back online, happy to make changes. Will merge and update then if needed. |
What is this PR doing?
Adding documentation for aggregator env vars
How can these changes be manually tested?
👀
Does this PR resolve or contribute to any issues?
No
Checklist
Guidelines
resolve conversation
button is for reviewers, not authors