Skip to content

Commit 38ca316

Browse files
authored
docs(wrapper): clarify confidential supply limit (#261)
1 parent 0ca6b12 commit 38ca316

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/confidential-wrapper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -547,8 +547,6 @@ The unwrap mechanism stores requests in a mapping keyed by ciphertext and the cu
547547

548548
The maximum number of decimals `_maxDecimals()` for the confidential token is currently set to **6 decimals** only. This is due to FHE limitations as confidential balances must be represented by the euint64 encrypted datatype.
549549

550-
It is possible that future implementations of the wrapper set a higher `_maxDecimals()` value to better suit the needs of the underlying token. For example, cWBTC might require 8 decimals since using only 6 would make the smallest unit impractically expensive.
551-
552550
At deployment, the confidential wrapper sets its number of decimals as:
553551

554552
* the number of decimals of the underlying token if it is less than `_maxDecimals()`
@@ -572,6 +570,8 @@ wrapper.decimals();
572570

573571
The maximum total supply for the confidential token is currently set to `type(uint64).max` (`2^64 - 1`) due to FHE limitations.
574572

573+
Avoid wrapping tokens with a very large total supply. Because the limit applies to the confidential token's smallest units, a wrapper with the default 6 decimals can represent at most approximately 18.4 trillion whole tokens. For example, this is only about 3% of SHIB's approximately 590 trillion-token supply, so the wrapper cannot accommodate the entire supply.
574+
575575
### Non-standard token types
576576

577577
The wrapper assumes the full transfer amount is received when minting. Tokens that deviate from this assumption, or whose supply changes independently of wrap/unwrap operations, are not supported and may result in undercollateralization or loss of yield.

0 commit comments

Comments
 (0)