DEVREL-833 check Solana local decimals when creating OFT #1763

nazreen · 2025-10-16T16:16:59Z

Changes

introduce two new utils: localDecimalsToMaxSupply (Solana) and formatTokenAmountCompact in packages (added unit tests)
createOFT and createOFTAdapter scripts in oft-solana and lzapp-migration: added prompt to confirm that states what max supply will be based on local decimals
introduce 'ci' flag for consistency with wire task

Example runs

examples/oft-solana $ pnpm hardhat lz:oft:solana:create --eid 40168 --program-id $PROGRAM_ID --only-oft-store true --local-decimals 18 --ci
info:    Using Solana keypair from SOLANA_PRIVATE_KEY => <PUBLIC_KEY_REDACTED>

? You have chosen 18 local decimals. The maximum supply of your Solana OFT token will be 18 (~18).

examples/oft-solana $ pnpm hardhat lz:oft:solana:create --eid 40168 --program-id $PROGRAM_ID --only-oft-store true --local-decimals 10 --ci
info:    Using Solana keypair from SOLANA_PRIVATE_KEY => <PUBLIC_KEY_REDACTED>

? You have chosen 10 local decimals. The maximum supply of your Solana OFT token will be 1,844,674,407 (~1.8B). Continue ?

Testing

run pnpm hardhat lz:oft:solana:create --eid 40168 --program-id <PROGRAM_ID> --only-oft-store true --local-decimals 7 and view the confirmation prompt.
rerun the above with varying values for --local-decimals to see the varying max supply

For ease of testing you can use export PROGRAM_ID= 9j9Wp46t7GyDSU3NVV8AmYMdXZHoiZmAzVuDSVDY2jy

nazreen · 2025-10-17T00:28:08Z

will be updating this PR to remove the concept of 'max recommended local decimals' and just prompt for confirmation every single time to ensure the dev is aware of the max total supply given the local decimals value

nazreen · 2025-10-17T05:29:22Z

updated

examples/lzapp-migration/tasks/solana/utils.ts

shankars99

more documentation on the maxSupplyHuman part would help

the rest seems good

nazreen · 2025-10-22T11:18:58Z

@shankars99 pushed changes to address your feedback

examples/lzapp-migration/tasks/solana/utils.ts

shankars99

i = 1 is billion and 1000 * billion is trillion which is i = 0 right?

Yes, that's correct. But also yeah this part is buggy as it doesn't turn 1000M into 1B (or 1000K into 1M). Will fix.

Im thinking we can do something like

export function formatAmount(rawAmt: bigint, maxDisplayDecimals = 1): string {
    const maxAmt = localDecimalsToMaxSupply(Number(rawAmt))
    if (!Number.isInteger(maxDisplayDecimals) || maxDisplayDecimals < 0 || maxDisplayDecimals > 6) {
        throw new Error('precision must be an integer between 0 and 6')
    }

    // Find the appropriate unit (largest unit that maxAmt is >= to)
    const i = UNITS.findIndex((unit) => maxAmt >= unit.base)

    if (i !== -1) {
        const { base, suffix } = UNITS[i]
        const pow = 10n ** BigInt(maxDisplayDecimals)
        const scaled = (maxAmt * pow + base / 2n) / base /// half up
        const quotient = scaled / pow
        const rem = scaled % pow
        const decimals =
            maxDisplayDecimals === 0 ? '' : rem.toString().padStart(maxDisplayDecimals, '0').replace(/0+$/, '')
        return `${quotient}${decimals ? `.${decimals}` : ''}${suffix}`
    }

    return maxAmt.toString()
}

which i think is a lot cleaner? not sure if it has the same issue that you mentioned but it could be a good starting point

nazreen · 2025-10-27T17:13:03Z

@shankars99 I think for debtools, correctness should be sufficient. I don't really want to spend too much time on optimizing implementations. For correctness, I've added unit tests. You can check them out and see if any cases are missed.

shankars99 · 2025-10-27T19:02:55Z

not really optimizations but it makes it easier to port these tooling to the new one. the new monorepo internal would not have all of these scripts that we have and its upto us to port them over.

we also do not know when devtools will be out on public launch. its safer and better to keep our current implementations the best they can be even if it takes some extra time to compensate for a doomsday case

TRileySchwarz · 2025-10-27T22:23:39Z

This formatter shouldnt show rounded numbers.

"... Solana OFT token will be 1.8B tokens..."

This is misleading and not true, should simply show the number formatted with decimals and commas to the actual maximum value.

packages/devtools-solana/src/common/numbers.ts

TRileySchwarz · 2025-10-27T22:40:38Z

packages/devtools/src/common/numbers.ts

+    { base: BigInt(1000), suffix: 'K' },
+]
+
+export function formatTokenAmount(whole: bigint, maxDisplayDecimals = 1): string {


Why not use a builtin:

export const formatTokenAmount = (whole: bigint, maxDecimals = 1): string => new Intl.NumberFormat('en-US', { notation: 'compact', maximumFractionDigits: maxDecimals, roundingMode: 'floor' }).format(Number(whole))

updated to use this suggestion

packages/devtools/test/formatAmount.test.ts

TRileySchwarz · 2025-10-27T22:42:20Z

packages/devtools/test/formatAmount.test.ts

+
+    it('throws on invalid precision values', () => {
+        expect(() => formatTokenAmount(BigInt(1_000), -1 as unknown as number)).toThrow()
+        expect(() => formatTokenAmount(BigInt(1_000), 7)).toThrow()


Why should this throw? if I want to round to 7 decimals of precision, and it doesn't exist in that numeration, just dont include them?

amended per your suggestion.

TRileySchwarz · 2025-10-27T22:43:20Z

examples/oft-solana/tasks/solana/createOFTAdapter.ts

            const mintPDA = await getMint(connection, new PublicKey(mintStr), undefined, new PublicKey(tokenProgramStr))
+            const mintDecimals = mintPDA.decimals
+
+            const maxSupply = formatTokenAmount(localDecimalsToMaxSupply(mintDecimals))


This isnt the MaxSupply, its the maxSupplyFloor, or maxSupplyRounded etc.

These lines have now been amended to

const maxSupplyRaw = localDecimalsToMaxWholeTokens(decimals) const maxSupplyFormatted = new Intl.NumberFormat('en-US').format(maxSupplyRaw) const maxSupplyCompacted = formatTokenAmountCompact(maxSupplyRaw)

@TRileySchwarz can you confirm whether this thread can be resolved?

examples/lzapp-migration/test/scripts/solanaUtils.script.test.ts

TRileySchwarz · 2025-10-31T17:26:50Z

examples/oft-solana/tasks/solana/createOFT.ts

            // EOF: Validate combination of parameters

+            const maxSupplyRaw = localDecimalsToMaxWholeTokens(decimals)
+            const maxSupplyFormatted = new Intl.NumberFormat('en-US').format(maxSupplyRaw)


I would probably just have this formateTokenAmounts return all these values, so its not expensive or inefficient to always do the calcaultions, and that way there is one helper vs. multiple

I'm assuming you meant there should be one helper to serve these 2 lines:

const maxSupplyFormatted = new Intl.NumberFormat('en-US').format(maxSupplyRaw) const maxSupplyCompacted = formatTokenAmountCompact(maxSupplyRaw)

rather than absorbing what localDecimalsToMaxWholeTokens does into formateTokenAmounts as I think these two functions do 2 separate things

pushed:

export function formatTokenAmount(rawAmount: bigint, maxDisplayDecimals = 1): { full: string; compact: string } { if (!Number.isInteger(maxDisplayDecimals) || maxDisplayDecimals < 0) { throw new Error('maxDisplayDecimals must be an integer between 0 and 6') } const full = new Intl.NumberFormat('en-US').format(rawAmount) const compact = new Intl.NumberFormat('en-US', { notation: 'compact', maximumFractionDigits: maxDisplayDecimals, roundingMode: 'floor', }).format(Number(rawAmount)) return { full, compact, } }

@St0rmBr3w had to dismiss your review to make this change, do review again when you can 🙏

St0rmBr3w

LGTM!

shankars99 · 2025-11-04T17:01:07Z

examples/oft-solana/tasks/solana/utils.ts

+export { localDecimalsToMaxWholeTokens } from '@layerzerolabs/devtools-solana'
+export { formatTokenAmount } from '@layerzerolabs/devtools'


why not just import it in createOFT and createOFTAdapter

shankars99 · 2025-11-04T17:04:01Z

examples/oft-solana/tasks/solana/createOFTAdapter.ts

+            const maxSupplyStatement = `You have chosen ${mintDecimals} local decimals. The maximum supply of your Solana OFT token will be ${maxSupplyFormatted.full} (~${maxSupplyFormatted.compact}).\n`
+            const confirmMaxSupply = await promptToContinue(maxSupplyStatement)
+            if (!confirmMaxSupply) {
+                return
+            }


do adapters on solana define the max supply?

Not the adapters themselves, but figured it would be good to point out to the partner dev what the max supply would be given the Solana token (Mint Account) that they supply to this command.

nazreen added 5 commits October 16, 2025 18:12

ci flag

8e5a8a9

max total supply better warning

c176cd1

extract into utils

87caae3

apply to createOFTAdapter too

b1cfbca

changeset

d2ec9f4

nazreen marked this pull request as draft October 17, 2025 00:27

remove max recommended local decimals

dbc1c13

nazreen marked this pull request as ready for review October 17, 2025 05:29

Merge branch 'main' into oft-solana-create-oft-guardrails

ca73466

nazreen requested a review from St0rmBr3w October 21, 2025 17:03

nazreen assigned shankars99 and ravinagill15 Oct 21, 2025

shankars99 reviewed Oct 21, 2025

View reviewed changes

examples/lzapp-migration/tasks/solana/utils.ts Outdated Show resolved Hide resolved

shankars99 reviewed Oct 21, 2025

View reviewed changes

examples/lzapp-migration/tasks/solana/utils.ts Outdated Show resolved Hide resolved

shankars99 requested changes Oct 21, 2025

View reviewed changes

examples/lzapp-migration/tasks/solana/utils.ts Outdated Show resolved Hide resolved

shankars99 requested changes Oct 21, 2025

View reviewed changes

nazreen added 2 commits October 22, 2025 19:10

PR feedback

8ad0453

rename function

849e953

nazreen added 4 commits October 23, 2025 00:18

split functions

1ab88cd

remove wrapper

b431511

Merge branch 'main' into oft-solana-create-oft-guardrails

253c44f

Update six-dots-occur.md

2ad6f57

shankars99 removed their assignment Oct 22, 2025

shankars99 self-requested a review October 22, 2025 19:00

shankars99 reviewed Oct 22, 2025

View reviewed changes

examples/lzapp-migration/tasks/solana/utils.ts Outdated Show resolved Hide resolved

shankars99 reviewed Oct 22, 2025

View reviewed changes

examples/lzapp-migration/tasks/solana/utils.ts Outdated Show resolved Hide resolved

test

1e11730

shankars99 reviewed Oct 27, 2025

View reviewed changes

TRileySchwarz reviewed Oct 27, 2025

View reviewed changes

packages/devtools-solana/src/common/numbers.ts Outdated Show resolved Hide resolved

TRileySchwarz reviewed Oct 27, 2025

View reviewed changes

packages/devtools/test/formatAmount.test.ts Outdated Show resolved Hide resolved

TRileySchwarz reviewed Oct 27, 2025

View reviewed changes

examples/lzapp-migration/test/scripts/solanaUtils.script.test.ts Outdated Show resolved Hide resolved

nazreen added 8 commits October 28, 2025 07:51

rm unused

ee2b551

rename

3c03471

rename param

c8ccfb4

rename function

85cbd4d

rename

be1c8c6

update message to print whole raw value

952a92e

rename test file

ed5c0bd

amend

b4ae439

nazreen requested review from TRileySchwarz and shankars99 October 31, 2025 10:59

TRileySchwarz reviewed Oct 31, 2025

View reviewed changes

St0rmBr3w previously approved these changes Oct 31, 2025

View reviewed changes

amend formatTokenAmount

1da4389

nazreen dismissed St0rmBr3w’s stale review via 1da4389 November 2, 2025 10:57

Merge branch 'main' into oft-solana-create-oft-guardrails

d41d2a8

nazreen requested review from St0rmBr3w and TRileySchwarz November 4, 2025 16:16

shankars99 reviewed Nov 4, 2025

View reviewed changes

Merge branch 'main' into oft-solana-create-oft-guardrails

583cc72

		export { localDecimalsToMaxWholeTokens } from '@layerzerolabs/devtools-solana'
		export { formatTokenAmount } from '@layerzerolabs/devtools'

DEVREL-833 check Solana local decimals when creating OFT #1763

Are you sure you want to change the base?

DEVREL-833 check Solana local decimals when creating OFT #1763

Conversation

nazreen commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Example runs

Testing

Uh oh!

nazreen commented Oct 17, 2025

Uh oh!

nazreen commented Oct 17, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shankars99 left a comment

Choose a reason for hiding this comment

Uh oh!

nazreen commented Oct 22, 2025

Uh oh!

Uh oh!

Uh oh!

shankars99 left a comment

Choose a reason for hiding this comment

Uh oh!

nazreen commented Oct 27, 2025

Uh oh!

shankars99 commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TRileySchwarz commented Oct 27, 2025

Uh oh!

Uh oh!

TRileySchwarz Oct 27, 2025 • 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!

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!

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!

St0rmBr3w 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

nazreen commented Oct 16, 2025 •

edited

Loading

shankars99 commented Oct 27, 2025 •

edited

Loading

TRileySchwarz Oct 27, 2025 •

edited

Loading