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

Jump to bottom

token-2022: Take decimals into account for UI amount #7540

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

token-2022: Take decimals into account for UI amount #7540

Show file tree
Hide file tree
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
33 changes: 19 additions & 14 deletions token/program-2022/src/extension/interest_bearing_mint/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
#[cfg(feature = "serde-traits")]
use serde::{Deserialize, Serialize};
use {
crate::extension::{Extension, ExtensionType},
crate::{
extension::{Extension, ExtensionType},
trim_ui_amount_string,
},
bytemuck::{Pod, Zeroable},
solana_program::program_error::ProgramError,
spl_pod::{
Expand Down Expand Up @@ -81,7 +84,7 @@ impl InterestBearingConfig {
}

/// Convert a raw amount to its UI representation using the given decimals
/// field Excess zeroes or unneeded decimal point are trimmed.
/// field. Excess zeroes or unneeded decimal point are trimmed.
pub fn amount_to_ui_amount(
&self,
amount: u64,
Expand All @@ -90,7 +93,8 @@ impl InterestBearingConfig {
) -> Option<String> {
let scaled_amount_with_interest =
(amount as f64) * self.total_scale(decimals, unix_timestamp)?;
Some(scaled_amount_with_interest.to_string())
let ui_amount = format!("{scaled_amount_with_interest:.*}", decimals as usize);
Some(trim_ui_amount_string(ui_amount, decimals))
}

/// Try to convert a UI representation of a token amount to its raw amount
Expand Down Expand Up @@ -167,6 +171,7 @@ mod tests {

#[test]
fn specific_amount_to_ui_amount() {
const ONE: u64 = 1_000_000_000_000_000_000;
// constant 5%
let config = InterestBearingConfig {
rate_authority: OptionalNonZeroPubkey::default(),
Expand All @@ -177,25 +182,25 @@ mod tests {
};
// 1 year at 5% gives a total of exp(0.05) = 1.0512710963760241
let ui_amount = config
.amount_to_ui_amount(1, 0, INT_SECONDS_PER_YEAR)
.amount_to_ui_amount(ONE, 18, INT_SECONDS_PER_YEAR)
.unwrap();
assert_eq!(ui_amount, "1.0512710963760241");
assert_eq!(ui_amount, "1.051271096376024117");
// with 1 decimal place
let ui_amount = config
.amount_to_ui_amount(1, 1, INT_SECONDS_PER_YEAR)
.amount_to_ui_amount(ONE, 19, INT_SECONDS_PER_YEAR)
.unwrap();
assert_eq!(ui_amount, "0.10512710963760241");
assert_eq!(ui_amount, "0.1051271096376024117");
// with 10 decimal places
let ui_amount = config
.amount_to_ui_amount(1, 10, INT_SECONDS_PER_YEAR)
.amount_to_ui_amount(ONE, 28, INT_SECONDS_PER_YEAR)
.unwrap();
assert_eq!(ui_amount, "0.00000000010512710963760242"); // different digit at the end!
assert_eq!(ui_amount, "0.0000000001051271096376024175"); // different digits at the end!

// huge amount with 10 decimal places
let ui_amount = config
.amount_to_ui_amount(10_000_000_000, 10, INT_SECONDS_PER_YEAR)
.unwrap();
assert_eq!(ui_amount, "1.0512710963760241");
assert_eq!(ui_amount, "1.0512710964");

// negative
let config = InterestBearingConfig {
Expand All @@ -207,9 +212,9 @@ mod tests {
};
// 1 year at -5% gives a total of exp(-0.05) = 0.951229424500714
let ui_amount = config
.amount_to_ui_amount(1, 0, INT_SECONDS_PER_YEAR)
.amount_to_ui_amount(ONE, 18, INT_SECONDS_PER_YEAR)
.unwrap();
assert_eq!(ui_amount, "0.951229424500714");
assert_eq!(ui_amount, "0.951229424500713905");

// net out
let config = InterestBearingConfig {
Expand All @@ -236,12 +241,12 @@ mod tests {
let ui_amount = config
.amount_to_ui_amount(u64::MAX, 0, INT_SECONDS_PER_YEAR * 2)
.unwrap();
assert_eq!(ui_amount, "20386805083448100000");
assert_eq!(ui_amount, "20386805083448098816");
let ui_amount = config
.amount_to_ui_amount(u64::MAX, 0, INT_SECONDS_PER_YEAR * 10_000)
.unwrap();
// there's an underflow risk, but it works!
assert_eq!(ui_amount, "258917064265813830000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000");
assert_eq!(ui_amount, "258917064265813826192025834755112557504850551118283225815045099303279643822914042296793377611277551888244755303462190670431480816358154467489350925148558569427069926786360814068189956495940285398273555561779717914539956777398245259214848");
}

#[test]
Expand Down
8 changes: 6 additions & 2 deletions token/program-2022/src/extension/scaled_ui_amount/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
#[cfg(feature = "serde-traits")]
use serde::{Deserialize, Serialize};
use {
crate::extension::{Extension, ExtensionType},
crate::{
extension::{Extension, ExtensionType},
trim_ui_amount_string,
},
bytemuck::{Pod, Zeroable},
solana_program::program_error::ProgramError,
spl_pod::{optional_keys::OptionalNonZeroPubkey, primitives::PodI64},
Expand Down Expand Up @@ -72,7 +75,8 @@ impl ScaledUiAmountConfig {
unix_timestamp: i64,
) -> Option<String> {
let scaled_amount = (amount as f64) * self.total_multiplier(decimals, unix_timestamp);
Some(scaled_amount.to_string())
let ui_amount = format!("{scaled_amount:.*}", decimals as usize);
Some(trim_ui_amount_string(ui_amount, decimals))
}

/// Try to convert a UI representation of a token amount to its raw amount
Expand Down
13 changes: 9 additions & 4 deletions token/program-2022/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,17 @@ pub fn amount_to_ui_amount_string(amount: u64, decimals: u8) -> String {
/// Convert a raw amount to its UI representation using the given decimals field
/// Excess zeroes or unneeded decimal point are trimmed.
pub fn amount_to_ui_amount_string_trimmed(amount: u64, decimals: u8) -> String {
let mut s = amount_to_ui_amount_string(amount, decimals);
let s = amount_to_ui_amount_string(amount, decimals);
trim_ui_amount_string(s, decimals)
}

/// Trims a string number by removing excess zeroes or unneeded decimal point
fn trim_ui_amount_string(mut ui_amount: String, decimals: u8) -> String {
if decimals > 0 {
let zeros_trimmed = s.trim_end_matches('0');
s = zeros_trimmed.trim_end_matches('.').to_string();
let zeros_trimmed = ui_amount.trim_end_matches('0');
ui_amount = zeros_trimmed.trim_end_matches('.').to_string();
}
s
ui_amount
}

/// Try to convert a UI representation of a token amount to its raw amount using
Expand Down