Add Support for Scaled UI Amount Extension to JS Library #427
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joncinque
reviewed
May 13, 2025
Comment on lines
173
to
185
| test('should return the correct UiAmount with scale factor of 3', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(10, true, { multiplier: 3 }), | ||
| }); | ||
|
|
||
| const result = await amountToUiAmountForMintWithoutSimulation( | ||
| rpc, | ||
| mint, | ||
| BigInt(10000000000) | ||
| ); | ||
| t.is(result, '3'); | ||
| }); |
There was a problem hiding this comment.
nit: it's fine to keep this, but it seems a bit redundant given the previous test is almost exactly the same thing, but more complete
Comment on lines
187
to
205
| test('should return the correct amount with scale factor of 2', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(0, true, { multiplier: 2 }), | ||
| }); | ||
|
|
||
| const result = await uiAmountToAmountForMintWithoutSimulation(rpc, mint, '2'); | ||
| t.is(result, 1n); | ||
| }); | ||
|
|
||
| test('should return the correct amount with scale factor of 3', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(10, true, { multiplier: 3 }), | ||
| }); | ||
|
|
||
| const result = await uiAmountToAmountForMintWithoutSimulation(rpc, mint, '3'); | ||
| t.is(result, 10000000000n); | ||
| }); |
There was a problem hiding this comment.
nit: I liked how the other test cases were grouped, so can we have the same for these two?
Comment on lines
208
to
248
| test('should handle decimal multiplier of 0.5', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(2, true, { multiplier: 0.5 }), | ||
| }); | ||
|
|
||
| const result = await amountToUiAmountForMintWithoutSimulation( | ||
| rpc, | ||
| mint, | ||
| BigInt(100) | ||
| ); | ||
| t.is(result, '0.5'); | ||
| }); | ||
|
|
||
| test('should handle decimal multiplier of 1.5', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(2, true, { multiplier: 1.5 }), | ||
| }); | ||
|
|
||
| const result = await amountToUiAmountForMintWithoutSimulation( | ||
| rpc, | ||
| mint, | ||
| BigInt(100) | ||
| ); | ||
| t.is(result, '1.5'); | ||
| }); | ||
|
|
||
| test('should handle decimal multiplier of 0.001', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(3, true, { multiplier: 0.001 }), | ||
| }); | ||
|
|
||
| const result = await amountToUiAmountForMintWithoutSimulation( | ||
| rpc, | ||
| mint, | ||
| BigInt(1000) | ||
| ); | ||
| t.is(result, '0.001'); | ||
| }); |
There was a problem hiding this comment.
These can probably be grouped too
Comment on lines
250
to
268
| test('should convert UI amount with decimal multiplier of 0.5', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(2, true, { multiplier: 0.5 }), | ||
| }); | ||
|
|
||
| const result = await uiAmountToAmountForMintWithoutSimulation(rpc, mint, '1'); | ||
| t.is(result, 200n); // 1 * 100(for 2 decimals) / 0.5 | ||
| }); | ||
|
|
||
| test('should convert UI amount with decimal multiplier of 1.5', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(2, true, { multiplier: 1.5 }), | ||
| }); | ||
|
|
||
| const result = await uiAmountToAmountForMintWithoutSimulation(rpc, mint, '3'); | ||
| t.is(result, 200n); // 3 * 100(for 2 decimals) / 1.5 | ||
| }); |
Comment on lines
339
to
373
| test('should handle multiplier changes from decimal to decimal', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(2, true, { | ||
| multiplier: 0.5, | ||
| newMultiplier: 1.5, | ||
| newMultiplierEffectiveTimestamp: ONE_YEAR_IN_SECONDS, | ||
| }), | ||
| }); | ||
|
|
||
| const result = await amountToUiAmountForMintWithoutSimulation( | ||
| rpc, | ||
| mint, | ||
| BigInt(100) | ||
| ); | ||
| t.is(result, '1.5'); | ||
| }); | ||
|
|
||
| test('should handle multiplier changes from decimal to decimal for UI to amount conversion', async (t) => { | ||
| const rpc = getMockRpc({ | ||
| [CLOCK]: createMockClockAccountInfo(ONE_YEAR_IN_SECONDS * 2), | ||
| [mint]: createMockMintAccountInfo(2, true, { | ||
| multiplier: 0.5, | ||
| newMultiplier: 1.5, | ||
| newMultiplierEffectiveTimestamp: ONE_YEAR_IN_SECONDS, | ||
| }), | ||
| }); | ||
|
|
||
| const result = await uiAmountToAmountForMintWithoutSimulation( | ||
| rpc, | ||
| mint, | ||
| '1.5' | ||
| ); | ||
| t.is(result, 100n); // 1.5 * 100(for 2 decimals) / 1.5 | ||
| }); |
There was a problem hiding this comment.
nit: not sure if these are needed given the other ones
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Support for Scaled UI Amount Extension to JS Library
This PR adds support for the Scaled UI Amount extension to the js ibrary, enabling conversion between raw token amounts and UI representation based on a configurable multiplier.
Changes
Client Library
amountToUiAmountForScaledUiAmountMintWithoutSimulationfunction to convert raw amounts to UI amounts using a configurable multiplieruiAmountToAmountForScaledUiAmountMintWithoutSimulationfunction for reverse conversionTests