Skip to content

feat(docs): fix feeOut calculation example and unify calculation format #320

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(docs): fix feeOut calculation example and unify calculation format #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions whats-new/psm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ To protect the value of VAI and consider the USD value of the paired stablecoin,

* Input: The user wishes to receive 1 USDT.
* Calculation: The conversion rate to consider is max(1, 0.9) => 1 USDT = $1 = 1 VAI.
* The user needs to send (1 USDT \* 1 $/USDT) 1 VAI + fees.
* The user needs to send 1 VAI (1 USDT \* 1 $/USDT) + fees.
* Assuming feeOut = 10%, 0.10 VAI will be sent to the treasury, and 1 VAI will be burnt, resulting in a total of 1.1 VAI provided by the user.
* The fee is calculated considering the "principal" VAI amount that we are to burn (1 VAI = $1).
{% endhint %}
Expand All @@ -95,8 +95,8 @@ To protect the value of VAI and consider the USD value of the paired stablecoin,

* Input: The user desires to receive 10 USDT.
* Calculation: The conversion rate to consider is max(1, 1.1) => 1 USDT = $1.1 = 1.1 VAI.
* The user needs to send (10 USDT \* 1.1 $/USDT) 11 VAI + fees.
* Assuming feeOut = 10%, 1.1 VAI will be sent to the treasury, and 10 VAI will be burnt, resulting in a total of 11.1 VAI provided by the user.
* The user needs to send 11 VAI (10 USDT \* 1.1 $/USDT) + fees.
* Assuming feeOut = 10%, 1.1 VAI will be sent to the treasury, and 10 VAI will be burnt, resulting in a total of 12.1 VAI provided by the user.
* The fee is calculated considering the "principal" VAI amount that we are to burn (11 VAI = $11).
{% endhint %}

Expand All @@ -109,7 +109,7 @@ To protect the value of VAI and consider the USD value of the paired stablecoin,

* Input: The user wishes to send 10 USDT to the PSM.
* Calculation: The conversion rate to consider is min(1, 0.9) => 10 USDT = $9 = 9 VAI.
* The user will receive 10 USDT \* 0.9 = 9 VAI (- fees).
* The user will receive 9 VAI (10 USDT \* 0.9) - fees.
* Assuming feeIn = 10%, 0.9 VAI will be sent to the treasury, and 8.1 VAI will be sent to the user.
* The fee is calculated considering the "principal" VAI amount (9 VAI = $9).
{% endhint %}
Expand All @@ -122,7 +122,7 @@ To protect the value of VAI and consider the USD value of the paired stablecoin,
* 1 USDT = $1.1 (conversion rate according to our oracles)
* Input: The user wishes to send 10 USDT to the PSM.
* Calculation: The conversion rate to consider is min(1, 1.1) => 10 USDT = $10 = 10 VAI.
* The user will receive 10 USDT \* 1.0 = 10 VAI (- fees).
* The user will receive 10 VAI (10 USDT \* 1.0) - fees.
* Assuming feeIn = 10%, 1 VAI will be sent to the treasury, and 9 VAI will be sent to the user.
* The fee is calculated considering the "principal" VAI amount (10 VAI = $10).
{% endhint %}
Expand Down