Record total minted API v2 #1769

wgr523 · 2025-11-12T03:56:52Z

Proposed changes

Record total minted API with additional parameter epoch number. Record both minted and burned. Renamed to getTokenSupply.

Types of changes

What types of changes does your code introduce to XDC network?
Put an ✅ in the boxes that apply

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation Update (if none of the other choices apply)
Regular KTLO or any of the maintaince work. e.g code style
CICD Improvement

Impacted Components

Which part of the codebase this PR will touch base on,

Put an ✅ in the boxes that apply

Checklist

Put an ✅ in the boxes once you have confirmed below actions (or provide reasons on not doing so) that

This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage
Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet.
Tested the backwards compatibility.
Tested with XDC nodes running this version co-exist with those running the previous version.
Relevant documentation has been updated as part of this PR
N/A

…tions

gzliudan · 2025-11-12T05:54:58Z

core/state/statedb_utils.go

+	slotMintedRecordOnsetBlock             = common.HexToHash("0000000000000000000000000000000000000000000000000000000000000002")
+	slotMintedRecordPostTotalMintedBase, _ = new(big.Int).SetString("0100000000000000000000000000000000000000000000000000000000000000", 16)
+	slotMintedRecordPostTotalBurnedBase, _ = new(big.Int).SetString("0200000000000000000000000000000000000000000000000000000000000000", 16)
+	slotMintedRecordPostRewardBlockBase, _ = new(big.Int).SetString("0300000000000000000000000000000000000000000000000000000000000000", 16)


Can we add 0x prefix in string ? I think it's more clear

common.HexToHash can. done.
new(big.Int).SetString cannot.

https://github.com/ethereum/go-ethereum/blob/master/crypto/secp256k1/curve.go#L267-L271:

func init() { // See SEC 2 section 2.7.1 // curve parameters taken from: // http://www.secg.org/sec2-v2.pdf theCurve.P, _ = new(big.Int).SetString("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEFFFFFC2F", 0) theCurve.N, _ = new(big.Int).SetString("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141", 0) theCurve.B, _ = new(big.Int).SetString("0x0000000000000000000000000000000000000000000000000000000000000007", 0) theCurve.Gx, _ = new(big.Int).SetString("0x79BE667EF9DCBBAC55A06295CE870B07029BFCDB2DCE28D959F2815B16F81798", 0) theCurve.Gy, _ = new(big.Int).SetString("0x483ADA7726A3C4655DA4FBFC0E1108A8FD17B448A68554199C47D08FFB10D4B8", 0) theCurve.BitSize = 256 }

gzliudan · 2025-11-12T05:58:17Z

eth/hooks/engine_v2_hooks.go

-				// calculate the tokens before TIPUpgradeReward and set to totalMinted
-				// for now no-do
+			totalMinted := big.NewInt(0)
+			totalBurned := big.NewInt(0)


new(big.Int) is better than big.NewInt(0)

gzliudan · 2025-11-12T06:02:32Z

eth/hooks/engine_v2_hooks.go

+				for epochNumIter > 0 {
+					totalMinted = state.GetPostTotalMinted(stateBlock, epochNumIter-1).Big()
+					totalBurned = state.GetPostTotalBurned(stateBlock, epochNumIter-1).Big()
+					if totalMinted.BitLen() != 0 || totalBurned.BitLen() != 0 {


should use Sign() to compare with 0

gzliudan · 2025-11-12T06:07:06Z

internal/ethapi/api.go

+func (s *BlockChainAPI) GetTokenSupply(ctx context.Context, epochNr rpc.EpochNumber) (*tokenSupply, error) {
+	engine, ok := s.b.Engine().(*XDPoS.XDPoS)
+	if !ok {
+		return nil, errors.New("Undefined XDPoS consensus engine")


error string should started with lowercase, use undefined instead of Undefined

gzliudan · 2025-11-12T06:08:30Z

internal/web3ext/web3ext.go

-			call: 'eth_getCurrentTotalMinted',
-			params: 0,
+			name: 'getTokenSupply',
+			call: 'eth_getTokenSupply',


name is not precise, which token ?

XDC token. I think token is enough, no need xdc token.

gzliudan · 2025-11-12T06:11:37Z

core/state/statedb_utils.go

+func GetPostTotalMinted(statedb *StateDB, epoch uint64) common.Hash {
+	hash := common.BigToHash(new(big.Int).Add(slotMintedRecordPostTotalMintedBase, new(big.Int).SetUint64(epoch)))
+	v := statedb.GetState(common.MintedRecordAddressBinary, hash)
+	return v


why not use return statedb.GetState(common.MintedRecordAddressBinary, hash)

gzliudan · 2025-11-12T06:17:31Z

eth/hooks/engine_v2_hooks.go

 			}
 			totalMinted.Add(totalMinted, rewardSum)
 			bigPower256 := new(big.Int).Lsh(big.NewInt(1), 256)
 			bigMaxU256 := new(big.Int).Sub(bigPower256, big.NewInt(1))


You can use MaxUint256 in abi package, or define a package level variable:

MaxUint256 = new(big.Int).Sub(new(big.Int).Lsh(common.Big1, 256), common.Big1)

No need to create bigPower256 and bigMaxU256 each time.

or use math.MaxBig256

gzliudan · 2025-11-12T06:22:30Z

internal/ethapi/api.go

+	statedb, header, err := s.b.StateAndHeaderByNumber(ctx, rpc.LatestBlockNumber)
+	nonce := statedb.GetNonce(common.MintedRecordAddressBinary)
+	if nonce == 0 {
+		return nil, errors.New("MintedRecordAddress is not initialized due to Reward Upgrade is not applied")


error strings should not be capitalized

gzliudan · 2025-11-12T06:27:37Z

eth/hooks/engine_v2_hooks.go

 			// if overflow, set to maxU256 and log a warning
-			if totalMinted.Cmp(bigMaxU256) >= 0 {
+			if totalMinted.Cmp(bigMaxU256) > 0 {
 				totalMinted.Set(bigMaxU256)


I think totalMinted and totalBurned will be greater than bigMaxU256 one day.

I think that will be very long time in the future. this PR can skip that.

gzliudan · 2025-11-12T06:29:06Z

internal/ethapi/api.go

+	preEpochMinted := new(big.Int).Mul(new(big.Int).SetUint64(config.Reward), new(big.Int).SetUint64(params.Ether))
+	onsetEpochMinus := onsetEpoch
+	if onsetEpochMinus > 0 {
+		onsetEpochMinus -= 1


onsetEpochMinus--

gzliudan · 2025-11-12T06:31:56Z

internal/ethapi/api.go

+	if onsetEpochMinus > 0 {
+		onsetEpochMinus -= 1
+	} else {
+		log.Warn("onsetEpoch is 0 which could not happen", epochNum)


log message string should be capitalized

gzliudan · 2025-11-12T06:40:37Z

internal/web3ext/web3ext.go

+			call: 'eth_getTokenSupply',
+			params: 1,
 		}),
 	],


Shall we define command in gethclient ?

if it is useful, then we shall do it

benjamin202410 · 2025-11-13T16:07:15Z

internal/ethapi/api.go

+	PostUpgradeTotalMinted *hexutil.Big `json:"postUpgradeTotalMinted"`
+	PreUpgradeTotalMinted  *hexutil.Big `json:"preUpgradeTotalMinted"`
+	PostUpgradeTotalBurned *hexutil.Big `json:"postUpgradeTotalBurned"`
+	TotalMinted            *hexutil.Big `json:"totalMinted"`


can you

remove Total for all variables as it always represents total

create like sub object like

rewardV2.minted

rewardV2.burned

rewardV1.minted

PostUpgrade and PreUpgrade. I think reward v1 v2 is more easier understand

wgr523 added 4 commits November 10, 2025 21:40

feat: GetTokenSupply API, total minted and burned

f2ba9a4

feat: token supply API finish burned token. rename minted record func…

0206cca

…tions

fix(api): handle edge case about minus 1 for epoch in token supply

f300935

fix: check both total minted and burned before breaking loop

fe408d6

gzliudan reviewed Nov 12, 2025

View reviewed changes

gzliudan requested review from AnilChinchawale, benjamin202410, gzliudan, liam-lai and wanwiset25 November 12, 2025 07:19

benjamin202410 reviewed Nov 13, 2025

View reviewed changes

style: modify minor style

cd0542d

Record total minted API v2 #1769

Are you sure you want to change the base?

Record total minted API v2 #1769

Uh oh!

Conversation

wgr523 commented Nov 12, 2025

Proposed changes

Types of changes

Impacted Components

Checklist

Uh oh!

gzliudan Nov 12, 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!

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!

gzliudan Nov 12, 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!

Choose a reason for hiding this comment

Uh oh!

gzliudan Nov 12, 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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gzliudan Nov 12, 2025 •

edited

Loading

gzliudan Nov 12, 2025 •

edited

Loading

gzliudan Nov 12, 2025 •

edited

Loading