Fix Decimals Handling #93
Open
+97
−44
Conversation
This file contains 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
packages/core/src/jpyc.ts
Outdated
Comment on lines
33
to
47
| /** | ||
| * Helper functions for decimal handling | ||
| */ | ||
|
|
||
| private fromOnChainValue(value: bigint): Uint256 { | ||
| const adjustedValue = value / BigInt(10 ** this.DECIMALS); | ||
| return Uint256.from(adjustedValue.toString()); | ||
| } | ||
|
|
||
| private toOnChainValue(value: Uint256): Uint256 { | ||
| const rawValue = BigInt(value.toString()); | ||
| const adjustedValue = rawValue * BigInt(10 ** this.DECIMALS); | ||
| return Uint256.from(adjustedValue.toString()); | ||
| } | ||
|
|
There was a problem hiding this comment.
こちらの処理は今後他のコントラクトの SDK でも使用できるものなので、インスタンスメソッドとしてではなく、独立したヘルパー関数として実装するのが良いと思います。
Comment on lines
+10
to
+16
| export const removeDecimals = (value: number): Uint256 => { | ||
| return toUint256(BigInt(value * DECIMALS_QUANTIFIER)); | ||
| }; | ||
|
|
||
| export const addDecimals = (value: Uint256): number => { | ||
| return Number(value.toString()) / DECIMALS_QUANTIFIER; | ||
| }; |
There was a problem hiding this comment.
decimal 変換処理を行う部分を外部に切り出し、to/from-onChainValue よりもより具体的な関数名に修正しています。
また、それぞれの引数のタイプについても適切なものにしました。
There was a problem hiding this comment.
ありがとうございます。挙動の意味をユーザーにわかるようにコメント（意味と例）をつけると良いと思いました。
例：
/**
* Converts a user-specified "integer JPYC value" into a Uint256 format that can be used on-chain.
* Example: 100 JPYC → 100000000000000000000 (multiplied by 10^18)
* @param value The numeric value provided by the user (number)
* @returns A Uint256 value with decimal places removed
*/
export const removeDecimals = (value: number): Uint256 => {
return toUint256(BigInt(value * DECIMALS_QUANTIFIER));
};
/**
* Converts the smallest on-chain unit of JPYC (wei-level integer value) into a user-friendly numeric value.
* Example: 1000000000000000000 (wei) → 1 JPYC
* @param value The Uint256 value used on-chain
* @returns A number with decimal places restored
*/
export const addDecimals = (value: Uint256): number => {
return Number(value.toString()) / DECIMALS_QUANTIFIER;
};There was a problem hiding this comment.
この関数は既存の JPYC コントラクトだけでなく、今後 JPYC で開発するコントラクトに対しても適用したいので、コメント内容は検討しますがコメント自体は追加しますね
| @@ -22,22 +22,22 @@ export interface IJPYC { | |||
| * @param minter - Minter address | |||
| * @returns minter allowance | |||
| */ | |||
| minterAllowance(params: { minter: Address }): Promise<Uint256>; | |||
| minterAllowance(params: { minter: Address }): Promise<number>; | |||
There was a problem hiding this comment.
各種 SDK インターフェースの変更が必要になったので、そちらも修正しています。
|
|
||
| import { toUint256, removeDecimals, addDecimals } from './math'; | ||
|
|
||
| describe('Unit tests of toUint256()', () => { |
There was a problem hiding this comment.
今回追加した関数のユニットテストも追加しました
SeiyaKobayashi
changed the title
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.
🎨 Overview
Fixed the decimal handling when transferring JPYC tokens to ensure that the intended amount is accurately sent. This fix resolves the discrepancy between the user-specified amount and the actual transfer amount on the blockchain.
🌈 Details
DECIMALSconstant to support JPYC's 18 decimal placesbalanceOfmethod to convert on-chain values to human-readable formattransfermethod to adjust user-specified values by 18 decimal places for on-chain transactionstransferFrom,mint,approve, etc.) in the futureBigIntfor accurate numerical calculations in the SDKThis fix resolves the issue where attempting to send 100 JPYC previously resulted in only 0.0000000000000001 JPYC being transferred, ensuring that the intended 100 JPYC is now correctly sent.
📚 References
When transfer below code
https://sepolia.etherscan.io/tx/0x8ce14ea33b9f2f43a89c9bf2e05ea160fa1bc335e07f972b1bda076ee6bcb7bb
https://sepolia.etherscan.io/tx/0x009c5970ff0db05a120fcb9cd2d4b004fe460d84fe7080808a067eb4497d22e7