TokenPool V2 Billing #1268

0xsuryansh · 2025-10-09T10:33:29Z

No description provided.

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/contracts/test/offRamp/OffRamp/OffRamp.executeSingleMessage.t.sol # chains/evm/gobindings/generation/generated-wrapper-dependency-versions-do-not-edit.txt # chains/evm/scripts/compile_all

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/gobindings/generation/generated-wrapper-dependency-versions-do-not-edit.txt

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/contracts/pools/TokenPool.sol # chains/evm/gobindings/generated/latest/burn_from_mint_token_pool/burn_from_mint_token_pool.go # chains/evm/gobindings/generated/latest/burn_mint_token_pool/burn_mint_token_pool.go # chains/evm/gobindings/generated/latest/burn_mint_with_lock_release_flag_token_pool/burn_mint_with_lock_release_flag_token_pool.go # chains/evm/gobindings/generated/latest/burn_to_address_mint_token_pool/burn_to_address_mint_token_pool.go # chains/evm/gobindings/generated/latest/burn_with_from_mint_token_pool/burn_with_from_mint_token_pool.go # chains/evm/gobindings/generated/latest/lock_release_token_pool/lock_release_token_pool.go # chains/evm/gobindings/generated/latest/mock_lbtc_token_pool/mock_lbtc_token_pool.go # chains/evm/gobindings/generated/latest/siloed_lock_release_token_pool/siloed_lock_release_token_pool.go # chains/evm/gobindings/generated/latest/siloed_usdc_token_pool/siloed_usdc_token_pool.go # chains/evm/gobindings/generated/latest/token_pool/token_pool.go # chains/evm/gobindings/generated/latest/usdc_token_pool/usdc_token_pool.go # chains/evm/gobindings/generated/latest/usdc_token_pool_cctp_v2/usdc_token_pool_cctp_v2.go # chains/evm/gobindings/generation/generated-wrapper-dependency-versions-do-not-edit.txt

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/contracts/pools/TokenPool.sol # chains/evm/contracts/test/pools/TokenPool/TokenPool.setFastTransferRateLimitConfig.t.sol # chains/evm/contracts/test/pools/TokenPool/TokenPool.validateReleaseOrMint.t.sol # chains/evm/gobindings/generated/latest/burn_from_mint_token_pool/burn_from_mint_token_pool.go # chains/evm/gobindings/generated/latest/usdc_token_pool/usdc_token_pool.go # chains/evm/gobindings/generated/latest/usdc_token_pool_cctp_v2/usdc_token_pool_cctp_v2.go

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/gobindings/generated/latest/usdc_token_pool/usdc_token_pool.go # chains/evm/gobindings/generated/latest/usdc_token_pool_cctp_v2/usdc_token_pool_cctp_v2.go # chains/evm/gobindings/generation/generated-wrapper-dependency-versions-do-not-edit.txt

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/contracts/pools/TokenPool.sol # chains/evm/contracts/test/helpers/TokenPoolV2Helper.sol # chains/evm/contracts/test/pools/TokenPool/TokenPool.applyFee.t.sol # chains/evm/contracts/test/pools/TokenPool/TokenPool.applyFinalityConfigUpdates.t.sol # chains/evm/contracts/test/pools/TokenPool/TokenPool.validateLockOrBurn.t.sol # chains/evm/contracts/test/pools/TokenPool/TokenPool.validateReleaseOrMint.t.sol

0xsuryansh · 2025-10-09T11:18:23Z

base will change to develop when rename and lockOrBurn split PRs are merged

github-actions · 2025-10-09T11:25:35Z

Metric	`new-token-pool-billing`	`lockOrBurn-split`
Coverage	69.4%	69.0%

kylesmartin · 2025-10-09T12:15:21Z

chains/evm/contracts/pools/TokenPool.sol

  event InboundRateLimitConsumed(uint64 indexed remoteChainSelector, address token, uint256 amount);
  event CCVConfigUpdated(uint64 indexed remoteChainSelector, address[] outboundCCVs, address[] inboundCCVs);
-  event FinalityConfigUpdated(uint16 finalityConfig, uint16 customFinalityTransferFeeBps);
+  event FinalityThresholdUpdated(uint16 finalityConfig);


Suggested change

event FinalityThresholdUpdated(uint16 finalityConfig);

event FinalityThresholdUpdated(uint16 finalityThreshold);

Also, useful to emit the previous one?

kylesmartin · 2025-10-09T12:16:39Z

chains/evm/contracts/pools/TokenPool.sol

-    //                                       | 0 means the default finality.
-    uint16 customFinalityTransferFeeBps; // ─╯ Fee in basis points for custom finality transfers [0-10_000].
+    // 0 means the default finality.
+    uint16 finalityThreshold; // Minimum block depth on the source chain that token issuers consider sufficiently secure


Haven't seen this comment pattern before, should we just keep everything in-line?

Suggested change

uint16 finalityThreshold; // Minimum block depth on the source chain that token issuers consider sufficiently secure

uint16 finalityThreshold; // Minimum block depth on the source chain that token issuers consider sufficiently secure (0 means default finality)

kylesmartin · 2025-10-09T12:19:25Z

chains/evm/contracts/pools/TokenPool.sol

-      destAmount -= (lockOrBurnIn.amount * s_finalityConfig.customFinalityTransferFeeBps) / BPS_DIVIDER;
-    }
-    // TODO : default finality transfer fee
+    uint256 feeBps = finality != WAIT_FOR_FINALITY


WAIT_FOR_FINALITY terminology doesn't seem correct given that we changed the name to "custom finality". Because even using a custom finality, you are still waiting for a measure of finality, just a custom one instead of the default. Would DEFAULT_FINALITY work better? We use the term "default finality" in comments already, so it is clear to understand what this is referring to.

Suggested change

uint256 feeBps = finality != WAIT_FOR_FINALITY

uint256 feeBps = finality != DEFAULT_FINALITY

kylesmartin · 2025-10-09T12:22:04Z

chains/evm/contracts/pools/TokenPool.sol

    EnumerableSet.Bytes32Set remotePools; // Set of remote pool hashes, ABI encoded in the case of a remote EVM chain.
  }

  struct CustomFinalityConfig {


We could just have finalityThreshold as a storage variable now.

0xsuryansh added 30 commits October 7, 2025 18:05

remove fast transfer pool

8117ac5

Merge pools

8ba3bcf

merge tests

c0a1cba

remove FTF pool BnM impl

85a81ed

merge test

bc49680

fix remaining

d0300dd

remove ftf pool from wrapper generation

e919508

update wrappers

ec91525

comments fix

e6a45f5

remove fast transfer wrapper

ed51697

coverage fix + remove ftf gen

c16168b

Merge branch 'develop' into pool-v1-v2-merge

59334ce

snap + cov

bbde648

rename to custom

a444ba9

rename in test

d0c547b

update wrappers

9ea376c

Merge branch 'develop' into pool-v1-v2-merge

5139868

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/contracts/test/offRamp/OffRamp/OffRamp.executeSingleMessage.t.sol # chains/evm/gobindings/generation/generated-wrapper-dependency-versions-do-not-edit.txt # chains/evm/scripts/compile_all

merge fix

08caa35

merge fix

9b41b35

Merge branch 'pool-v1-v2-merge' into fast-custom-finality-rename

121ecda

# Conflicts: # chains/evm/.gas-snapshot # chains/evm/gobindings/generation/generated-wrapper-dependency-versions-do-not-edit.txt

merge fix

45497da

Update TokenTransferFeeConfig

0781acf

use lib function _assertNoDuplicates

2da7584

comment fixes

9a91b2e

wrappers update

c98d1d9

use WAIT_FOR_FINALITY

383b083

add + fix test

d27d058

fix test name

8ec58b8

0xsuryansh added 13 commits October 8, 2025 19:07

fix test name

841d019

fix minor comments + wrappers

4ac5e29

remove maxTransferAmount + minor comment fixes

38f1e69

wrappers update

49ed19f

comment fix + lint fix + merge fix

604cb2f

split legacy and new lockOrBurn

de95f16

add placeholder test

f48a40e

update wrappers + snap

bb83a65

merge fix + event rename

d4fdbb5

minor fixes

2cb4a0d

0xsuryansh force-pushed the new-token-pool-billing branch from 6c28681 to 2cb4a0d Compare October 9, 2025 11:15

kylesmartin reviewed Oct 9, 2025

View reviewed changes

Base automatically changed from lockOrBurn-split to develop October 13, 2025 13:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

TokenPool V2 Billing #1268

TokenPool V2 Billing #1268

Uh oh!

0xsuryansh commented Oct 9, 2025

Uh oh!

0xsuryansh commented Oct 9, 2025

Uh oh!

github-actions bot commented Oct 9, 2025

Uh oh!

kylesmartin Oct 9, 2025

Uh oh!

kylesmartin Oct 9, 2025

Uh oh!

kylesmartin Oct 9, 2025

Uh oh!

kylesmartin Oct 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	event FinalityThresholdUpdated(uint16 finalityConfig);
	event FinalityThresholdUpdated(uint16 finalityThreshold);

	uint16 finalityThreshold; // Minimum block depth on the source chain that token issuers consider sufficiently secure
	uint16 finalityThreshold; // Minimum block depth on the source chain that token issuers consider sufficiently secure (0 means default finality)

	uint256 feeBps = finality != WAIT_FOR_FINALITY
	uint256 feeBps = finality != DEFAULT_FINALITY

TokenPool V2 Billing #1268

Are you sure you want to change the base?

TokenPool V2 Billing #1268

Uh oh!

Conversation

0xsuryansh commented Oct 9, 2025

Uh oh!

0xsuryansh commented Oct 9, 2025

Uh oh!

github-actions bot commented Oct 9, 2025

Uh oh!

kylesmartin Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

kylesmartin Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

kylesmartin Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

kylesmartin Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants