Skip to content

Commit

Permalink
add ricardian contracts for wevotethefee
Browse files Browse the repository at this point in the history
  • Loading branch information
sergioyuhjtman committed Aug 25, 2020
1 parent b06605a commit d43ccb9
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 0 deletions.
6 changes: 6 additions & 0 deletions wevotethefee/wevotethefee.clauses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<h1 class="clause">UserAgreement</h1>

The contract wevotethefee is designed to govern the fee values of those pair tokens from the contract evolutiondex that have wevotethefee as their fee_contract.
Users in possession of such pair tokens can vote for one of the following values:
1,2,3,5,7,10,15,20,30,50,75,100,150,200,300. One unit of fee value is equal to 0.01%.
The contract wevotethefee will change the fee value of a valid pair token when the action updatefee is applied by anyone. The new fee will be equal to the weighted median of the votes. The weight of each vote is the corresponding balance of the pair token. Note: evolutiondex notifies the fee_contract each time a user's pair token balance is modified.
96 changes: 96 additions & 0 deletions wevotethefee/wevotethefee.contracts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<h1 class="contract">openfeetable</h1>

---
spec_version: "0.2.0"
title: Open fee table
summary: 'Open a fee table for a given pair token'
---

{{user}} initializes a table for registering votes for the pair token
{{pair_token}} of the contract evolutiondex.

The authorization of {{user}} is required, who will pay for the RAM required.


<h1 class="contract">closefeetable</h1>

---
spec_version: "0.2.0"
title: Close fee table
summary: 'Close a fee table for a given pair token'
---

This action closes the fee table corresponding to {{pair_token}}. It will fail if the table is storing at least one vote.
In case it succeeds, the corresponding RAM will be liberated.


<h1 class="contract">votefee</h1>

---
spec_version: "0.2.0"
title: Vote fee
summary: 'Vote fee value for a specific pair token'
---

{{user}} votes a fee value for {{pair_token}} of evolutiondex.
The exact value voted will be equal to the least of the numbers
1,2,3,5,7,10,15,20,30,50,75,100,150,200,300 that is greater than or equal to {{fee_voted}}. One unit of fee value is equal to 0.01%.

The authorization of {{user}} is required, who will pay for the RAM required.

<h1 class="contract">closevote</h1>

---
spec_version: "0.2.0"
title: Close vote
summary: 'Close vote for a specific pair token'
---

{{user}} closes its vote corresponding to {{pair_token}} of evolutiondex.
The corresponding RAM will be liberated.

The authorization of {{user}} is required.


<h1 class="contract">updatefee</h1>

---
spec_version: "0.2.0"
title: Update fee
summary: 'Updates the fee value of a specific pair token'
---

This actions executes the action changefee from evolutiondex with inputs {{pair_token}} and a fee value that is computed as the weighted median of the current votes in the corresponding fee table.
The weights of the votes are the balances of the pair token of each voter.


<h1 class="contract">onaddliquidity</h1>

---
spec_version: "0.2.0"
title: On add liquidity
summary: 'Updates the weight of a vote when adding liquidity'
---

When evolutiondex notifies that {{user}} has added liquidity to the pair token {{asset_to_symbol_code to_buy}}, the weight of the vote of {{user}} is updated accordingly.

<h1 class="contract">onremliquidity</h1>

---
spec_version: "0.2.0"
title: On remove liquidity
summary: 'Updates the weight of a vote when removing liquidity'
---

When evolutiondex notifies that {{user}} has removed liquidity from the pair token {{asset_to_symbol_code to_sell}}, the weight of the vote of {{user}} is updated accordingly.


<h1 class="contract">ontransfer</h1>

---
spec_version: "0.2.0"
title: On transfer
summary: 'Updates the weight of a vote on a transfer by the contract evolutiondex'
---

When evolutiondex notifies that {{from}} has transferred {{quantity}} to {{to}}, the weights of the votes of {{from}} and {{to}} are updated accordingly.

0 comments on commit d43ccb9

Please sign in to comment.