token-js: add JS helpers for interest bearing tokens' UIAmounts #7541

gitteri · 2024-11-27T20:36:46Z

This adds four new helper functions to allow developers to better interact with interest bearing tokens.

amountToUiAmountForMintWithoutSimulation - converts a number/bigint amount for a given mint at the current time to a UiAmount
amountToUiAmountWithoutSimulation - converts a given number/bigint amount and detailed information about the mint's interest rates to a UiAmount
uiAmountToAmountForMintWithoutSimulation- converts a given ui amount string for a given mint at the current time to amount
uiAmountToAmountWithoutSimulation - converts a given ui amount string and detailed information about the mint's interest rates to amount

UiAmounts are provided with the token's decimals as its precision and truncated instead of rounded to avoid rounding issues.
Amounts are processed in the base unit of the token (if the token has 2 decimals 1.23 is represented as 123)

gitteri · 2024-11-27T20:38:49Z

token/js/src/extensions/interestBearingMint/state.ts

    preUpdateAverageRate: number;
-    lastUpdateTimestamp: bigint;
+    lastUpdateTimestamp: number;


these were changed because the buffer encoder does not work with bigints. numbers should be fine for timestamps and this doesn't seem to impact any other current usage

Sorry, what do you mean about the buffer encoder not working? We use bigints in a lot of the extensions and they seem to work. I'd prefer to leave this as is

Specifically if you use a bigint it has an issue when trying to encode this state due to this function that's in the buffer encoding library:

function divmodInt64(src) { const hi32 = Math.floor(src / V2E32); // cannot mix bigint and numbers here const lo32 = src - (hi32 * V2E32); return { hi32, lo32 }; }

I believe to fix this we'd have to fix the buffer encoding library. I took a look through all other state type definitions I could find and didn't see any other bigints

joncinque

Really great work! Mostly small things to fixup, but the logic is there and the tests look good

joncinque · 2024-11-27T20:51:59Z

token/js/src/actions/amountToUiAmount.ts

+    connection: Connection,
+    mint: PublicKey,
+    uiAmount: string,
+    programId = TOKEN_PROGRAM_ID,


Up to you, but since this function is taking a mint address, we can just figure out the program id from the mint owner.

yep good call. I'll update this

joncinque · 2024-11-27T20:55:12Z

token/js/src/actions/amountToUiAmount.ts

@@ -1,7 +1,10 @@
+import Decimal from 'decimal.js';


I'm likely missing something about JS math, but JS's native number is a 64-bit float, just like Rust's f64. Why do we need another dependency for it?

floating point math in js is notoriously bad. As an example: 0.1 + 0.2 !== 0.3 (it actually equals 0.30000000000000004). I wish I knew of a better way than importing a new dependency. Any suggestions?

Rust has the same behavior, so maybe that's actually ok?

println!("{}", 0.1 + 0.2);

Gives

0.30000000000000004

joncinque · 2024-11-27T20:56:50Z

token/js/src/actions/amountToUiAmount.ts

+export async function amountToUiAmountForMintWithoutSimulation(
+    connection: Connection,
+    mint: PublicKey,
+    amount: string,


We use bigint in most places in the code to represent a Rust u64 -- can we do the same thing here?

joncinque · 2024-11-27T20:57:32Z

token/js/src/actions/amountToUiAmount.ts

+ */
+
+export function amountToUiAmountWithoutSimulation(
+    amount: string,


Can we use a bigint instead like the rest of the package?

joncinque · 2024-11-27T21:00:12Z

token/js/src/actions/amountToUiAmount.ts

+    connection: Connection,
+    mint: PublicKey,
+    amount: string,
+    programId = TOKEN_PROGRAM_ID,


Up to you, but since this takes the mint's public key, we can use the account owner instead of forcing people to pass this

joncinque · 2024-11-27T21:14:24Z

token/js/src/actions/amountToUiAmount.ts

+    if (programId.equals(TOKEN_PROGRAM_ID)) {
+        return BigInt(uiAmountScaled.trunc().toString());
+    }


Same as with the other function, I think we can remove this

joncinque · 2024-11-27T21:14:52Z

token/js/src/actions/amountToUiAmount.ts

+): Promise<bigint> {
+    Decimal.set({ toExpPos: 24, toExpNeg: -24 })
+    const mintInfo = await getMint(connection, mint, 'confirmed', programId);
+    const uiAmountScaled = new Decimal(uiAmount).mul(new Decimal(10).pow(mintInfo.decimals));


nit: same as with the other function, this can get moved under if (!interestBearingMintConfigState)

joncinque · 2024-11-27T21:15:10Z

token/js/src/actions/amountToUiAmount.ts

+        return BigInt(uiAmountScaled.trunc().toString());
+    }
+
+    const currentTime = Math.floor(Date.now() / 1000); // Convert to seconds


up to you: same here, can fetch the clock for the cluster time

joncinque · 2024-11-27T21:16:15Z

token/js/src/extensions/interestBearingMint/state.ts

    preUpdateAverageRate: number;
-    lastUpdateTimestamp: bigint;
+    lastUpdateTimestamp: number;


Sorry, what do you mean about the buffer encoder not working? We use bigints in a lot of the extensions and they seem to work. I'd prefer to leave this as is

joncinque · 2024-11-27T21:27:09Z

pnpm-lock.yaml

Can you revert any changes that aren't necessary for the PR? It seems like we're just adding sinon and decimal.js currently (although I hope we don't need the second one)

…lpers

joncinque

Looking really close! Once the encoding bit is solved and these nits are fixed, it should be good to go

joncinque · 2024-12-04T12:43:05Z

token/js/src/actions/amountToUiAmount.ts

+ * @param r - The interest rate in basis points.
+ * @returns The calculated exponent.
+ */
+const calculateExponentForTimesAndRate = (t1: number, t2: number, r: number) => {


nit: we don't typically use arrow functions in this package -- can this be updated to a function(...)?

joncinque · 2024-12-04T12:53:50Z

token/js/src/actions/amountToUiAmount.ts

+ * @returns A promise that resolves to the current timestamp in seconds.
+ * @throws An error if the sysvar clock cannot be fetched or parsed.
+ */
+const getSysvarClockTimestamp = async (connection: Connection): Promise<number> => {


nit: same here, let's avoid the arrow function

joncinque · 2024-12-04T18:38:08Z

token/js/src/actions/amountToUiAmount.ts

+ * @param connection     Connection to use
+ * @param mint           Mint to use for calculations
+ * @param amount         Amount of tokens to be converted to Ui Amount
+ * @param programId      SPL Token program account (default: TOKEN_PROGRAM_ID)


nit: this param doesn't exist

Suggested change

* @param programId SPL Token program account (default: TOKEN_PROGRAM_ID)

joncinque · 2024-12-04T18:38:54Z

token/js/src/actions/amountToUiAmount.ts

+
+    // Calculate post-update exponent
+    // e^(currentRate * (currentTimestamp - lastUpdateTimestamp) / (SECONDS_PER_YEAR * ONE_IN_BASIS_POINTS))
+    const postUpdateExp = calculateExponentForTimesAndRate(lastUpdateTimestamp, Number(currentTimestamp), currentRate)


nit: Number shouldn't be needed, unless I've missed something

Suggested change

const postUpdateExp = calculateExponentForTimesAndRate(lastUpdateTimestamp, Number(currentTimestamp), currentRate)

const postUpdateExp = calculateExponentForTimesAndRate(lastUpdateTimestamp, currentTimestamp, currentRate)

joncinque · 2024-12-04T18:44:50Z

token/js/src/actions/amountToUiAmount.ts

+    const totalScale = preUpdateExp * postUpdateExp;
+
+    // Calculate original principle by dividing the UI amount (principle + interest) by the total scale
+    const originalPrinciple = uiAmountScaled / totalScale;


nit: If we want to use the term, it's principal, not principle https://www.merriam-webster.com/dictionary/principal

joncinque · 2024-12-04T18:45:47Z

token/js/src/actions/amountToUiAmount.ts

+
+    // Calculate original principle by dividing the UI amount (principle + interest) by the total scale
+    const originalPrinciple = uiAmountScaled / totalScale;
+    return BigInt(Math.floor(originalPrinciple)); 


nit: is there a reason to use floor over trunc like with the other one?

joncinque · 2024-12-04T18:46:26Z

token/js/src/actions/amountToUiAmount.ts

+ * @param programId      SPL Token program account (default: TOKEN_PROGRAM_ID)
+ * 


nit: since the param was removed

Suggested change

* @param programId SPL Token program account (default: TOKEN_PROGRAM_ID)

*

joncinque · 2024-12-04T18:46:57Z

token/js/src/actions/amountToUiAmount.ts

+        throw new Error('Invalid program ID');
+    }
+
+    const mintInfo = await getMint(connection, mint, 'confirmed', programId);


This causes a second network call to fetch the account again, so let's do unpackMint like with the other function

joncinque

One last one, then we can merge!

token/js/src/actions/amountToUiAmount.ts

Co-authored-by: Jon C <[email protected]>

joncinque

Thanks for all your patience and your work! Once it passes CI, I'll merge it in

…ogram-library into igitter/ibe-js-helpers

Pull request has been modified.

add JS helpers for interest bearing tokens' UIAmounts

ab09a86

mergify bot added the community Community contribution label Nov 27, 2024

gitteri commented Nov 27, 2024

View reviewed changes

gitteri added 3 commits November 27, 2024 14:40

reorder imports

39c40e7

update comments to provide formulas

0ef4859

merge upstream

83cf986

joncinque reviewed Nov 27, 2024

View reviewed changes

gitteri added 8 commits December 2, 2024 18:05

working with sys clock

35df63b

remove sinon

12a380c

use number instead of decimal.js and remove deps

2e7c15d

update pnpm

d0ea366

Merge remote-tracking branch 'upstream/master' into igitter/ibe-js-he…

1cb2f80

…lpers

use upstream pnpm-lock

bd426ed

remove unnecessary math

807ae7a

prettier fix

1a914b3

joncinque reviewed Dec 4, 2024

View reviewed changes

gitteri added 2 commits December 4, 2024 11:58

restore timestamps as bigints

463eefb

address comments

c16944f

joncinque reviewed Dec 4, 2024

View reviewed changes

token/js/src/actions/amountToUiAmount.ts Outdated Show resolved Hide resolved

Update token/js/src/actions/amountToUiAmount.ts

35ce02f

Co-authored-by: Jon C <[email protected]>

joncinque previously approved these changes Dec 4, 2024

View reviewed changes

gitteri added 2 commits December 4, 2024 12:27

fix eslint import issues

24a8d37

Merge branch 'igitter/ibe-js-helpers' of github.com:gitteri/solana-pr…

613701f

…ogram-library into igitter/ibe-js-helpers

joncinque approved these changes Dec 4, 2024

View reviewed changes

joncinque merged commit 96a1575 into solana-labs:master Dec 4, 2024
24 checks passed

joncinque changed the title ~~add JS helpers for interest bearing tokens' UIAmounts~~ token-js: add JS helpers for interest bearing tokens' UIAmounts Dec 4, 2024

joncinque mentioned this pull request Dec 4, 2024

token-js: Support InterestBearingMint amount conversions #3265

Closed

gitteri mentioned this pull request Dec 10, 2024

client-js: add JS helpers for interest bearing tokens' UIAmounts solana-program/token-2022#53

Merged

	const postUpdateExp = calculateExponentForTimesAndRate(lastUpdateTimestamp, Number(currentTimestamp), currentRate)
	const postUpdateExp = calculateExponentForTimesAndRate(lastUpdateTimestamp, currentTimestamp, currentRate)

		* @param programId SPL Token program account (default: TOKEN_PROGRAM_ID)
		*

token-js: add JS helpers for interest bearing tokens' UIAmounts #7541

token-js: add JS helpers for interest bearing tokens' UIAmounts #7541

Uh oh!

Conversation

gitteri commented Nov 27, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gitteri Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joncinque left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joncinque left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joncinque left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joncinque left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gitteri Nov 27, 2024 •

edited

Loading