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

Document roles and configuration parameters #287

Draft
wants to merge 4 commits into
base: pools-v2
Choose a base branch
from

Conversation

sporejack
Copy link
Contributor

Issue

Closes #279

Changes

  • Add docs directory
  • Add Configuring Perpetual Pools document

@sporejack sporejack added the documentation Improvements or additions to documentation label Dec 15, 2021
@sporejack sporejack self-assigned this Dec 15, 2021
@Paul4912
Copy link
Contributor

Maybe instead of calling fee receiver call it primary fee receiver. This way when people bring up fee receiver they are forced to specify which one so its more clear.


These are the configurable parameters of an individual pool:

| Name | Type | Deployment Only? | Who? | Description |
Copy link
Contributor

Choose a reason for hiding this comment

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

Think you should specify Deployment only? means that they cannot be modified adhoc post deployment. Might be not obvious to non technical readers.


| Name | Type | Deployment Only? | Who? | Description |
| --- | --- | --- | --- | --- |
| Oracle | `address` | True | Deployer | Address of the associated Chainlink oracle to wrap |
Copy link
Contributor

Choose a reason for hiding this comment

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

think you shud add deployer address as param.
Its an important param that the factory only allows pools to be deployed from same deployer
and you can also set it as another address when creating oraclewrappers, not neccesarily default the deployer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discovery Discussion: LeveragedPool Owner Modifiable Parameters
2 participants