Merge pull request #25 from nolash/cleanup-depth-bump

Cleanup test formatting, subsectioning of implementation
This commit is contained in:
WillRuddick 2020-03-16 12:50:26 +03:00 committed by GitHub
commit 6bd0056e04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,7 +1,8 @@
# Depth Bump - Add new tokens to reserve and supply with a specified price
Author: Will Ruddick
Version: 0.0.1
Date: 2020.03.16
Version: 0.0.2
## Rationale
@ -18,12 +19,14 @@ The idea would be to keep the price 1:1 with reserve and increase both reserve a
## Implementation
### Workflow
* return ownership of the token to a person (not the converter)
* mint more tokens (off the curve)'
* give ownership back to the converter
* add more virtual reserve to the converter
## Variables
### Variables
* Amount of supply to add S2 16,000,000
* Amount of Reserve to add R2 8,000,000
@ -33,21 +36,29 @@ The idea would be to keep the price 1:1 with reserve and increase both reserve a
* Existing Reserve: R1 ~2,000,000
* Existing Price: P1 ~1.0
### Interface
cmd: depthbump <-s targetsupply> <-p price>
## Testing
```
cmd: depthbump targetsupply=16000000.0 price=1.0
You are creating (16000000.0 - S1) new tokens? (yes/no/quit)
You are creating ((16000000.0)/4-R1)*P2 new reserve tokens? (yes/no/quit)
....
the new supply of CIC should be: 16,000,000
the new reserve should be: 4,000,000
(error if P2 != 4(R1+R2)/(S1+S2)) (where 4 is 1/cw from converter contract)
(warning if P2 != P1 and confirmation)
```
## Changelog
* 0.1: Created initial stub
* 0.0.2: Clean up formatting, subsection implementation
* 0.0.1: Created initial stub