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.

Sign up for GitHub

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
Draft

Document roles and configuration parameters #287

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d1c2708
Create documentation directory
sporejack Dec 15, 2021
9f963b5
Add configuration docs
sporejack Dec 15, 2021
ac5e4f5
Add roles and parameters
sporejack Dec 15, 2021
bb8a341
Add oracle parameters
sporejack Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added docs/.gitkeep
View file
Open in desktop
Empty file.
56 changes: 56 additions & 0 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Configuring Perpetual Pools #

Any given instance of a Perpetual Pools deployment consists of various
parameters that govern various aspects of the system's behaviour. Broadly, these
are divisible into two categories: factory parameters and pool parameters. The
latter category consists of the parameters responsible for a given pool and thus
do not affect the values of the former category.

## Roles ##

These are the *externally-facing* roles in an instance of a Perpetual Pools
system:

| Name | Description |
| --- | --- |
| Fee receiver | TODO |
| Secondary fee receiver | TODO |
| Factory owner | TODO |
| Pool owner | TODO |

## Parameters ##

### Pools ###

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.

| --- | --- | --- | --- | --- |
| Pool Governor | `address` | False | Pool Governor | Essentially the owner of the pool |
| Secondary Fee Receiver | `address` | False | Secondary fee receiver | Receipient of secondary fee revenue |
| Fee Receiver | `address` | False | Pool Governor | Receipient of primary fee revenue |
| Oracle Wrapper | `address` | True | Deployer | TODO |
| Settlement ETH Oracle | `address` | True | Deployer | TODO |
| Long Token | `address` | True | Deployer | TODO |
| Short Token | `address` | True | Deployer | TODO |
| Pool Committer | `address` | True | Deployer | TODO |
| Invariant Checker | `address` | True | Deployer | TODO |
| Pool Name | `string` | True | Deployer | TODO |
| Frontrunning Interval | `uint32` | True | Deployer | TODO |
| Update Interval | `uint32` | True | Deployer | TODO |
| Leverage | `uint16` | True | Deployer | TODO |
| Fee | `uint256` | True | Deployer | TODO |
| Quote Token | `address` | True | Depoyer | TODO |

### Factory ###

| Name | Type | Deployment Only? | Who? | Description |
| --- | --- | --- | --- | --- |
| Factory Owner | `address` | False | Factory Owner | TODO |
| Mint/Burn Fee | `uint256` | False | Factory Owner | TODO |
| Primary Fee | `uint256` | False | Factory Owner | TODO |
| Secondary Fee | `uint256` | False | Factory Owner | TODO |
| Maximum Leverage | `uint256` | False | Factory Owner | TODO |
| Autoclaimer | `address` | False | Factory Owner | TODO |
| Pool Keeper | `address` | False | Factory Owner | TODO |