Skip to content
This repository has been archived by the owner on Nov 5, 2023. It is now read-only.

Add documentation for aggregator env vars #357

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Conversation

jacque006
Copy link
Collaborator

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

  • I have manually tested these changes
  • Post a link to the PR in the group chat

Guidelines

  • If your PR is not ready, mark it as a draft
  • The resolve conversation button is for reviewers, not authors
    • (But add a 'done' comment or similar)

@github-actions github-actions bot added aggregator Aggregator backend related documentation Improvements or additions to documentation labels Oct 20, 2022
Copy link
Contributor

@blakecduncan blakecduncan left a 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!

| 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 |
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: typo in network

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

| 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 |
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: typo in queries

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

@jacque006
Copy link
Collaborator Author

@voltrevo can take a look when he's back online, happy to make changes. Will merge and update then if needed.

@jacque006 jacque006 merged commit 6a3df55 into main Oct 20, 2022
@jacque006 jacque006 deleted the docs/agg-env-vars branch October 20, 2022 16:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
aggregator Aggregator backend related documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants