Token pools by krebernisak · Pull Request #756 · smartcontractkit/chainlink-ton

krebernisak · 2026-06-09T10:47:08Z

No description provided.

github-actions · 2026-06-09T10:47:24Z

👋 krebernisak, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

Copilot

Pull request overview

Adds CCIP “token pool” support by introducing a shared TokenPool core (rate limiting, chain/ramp config, cursed subjects) plus two concrete pool contracts (Lock/Release and Burn/Mint), along with TypeScript wrappers and sandbox tests.

Changes:

Introduces new Tolk contracts for TokenPool, LockReleaseTokenPool, and BurnMintTokenPool, including messages/events/types/rate-limiter logic.
Adds CCIP CCT Jetton contracts (minter/wallet) and TS wrappers for deployment and interactions.
Adds TS wrapper utilities and new sandbox test suites for both pool variants.

Reviewed changes

Copilot reviewed 38 out of 38 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
contracts/wrappers/gen/ccip/pools/TokenPool.ts	Auto-generated TypeScript wrapper for TokenPool contract types/messages.
contracts/wrappers/ccip/TokenPool.ts	Handwritten TS codec/opcodes and helper senders for pool messages.
contracts/wrappers/ccip/LockReleaseTokenPool.ts	TS wrapper for LockReleaseTokenPool deployment, sends, and get-methods.
contracts/wrappers/ccip/BurnMintTokenPool.ts	TS wrapper for BurnMintTokenPool deployment, sends, and get-methods.
contracts/wrappers/ccip/CCTJettonMinter.ts	TS wrapper for CCIP CCT Jetton minter (deploy/mint/admin/wallet addr).
contracts/wrappers/ccip/CCTJettonCode.ts	Helper functions to load compiled CCT Jetton minter/wallet code.
contracts/wrappers/ccip.pools.LockReleaseTokenPool.compile.ts	Blueprint compile config for LockReleaseTokenPool Tolk entrypoint.
contracts/wrappers/ccip.pools.BurnMintTokenPool.compile.ts	Blueprint compile config for BurnMintTokenPool Tolk entrypoint.
contracts/wrappers/ccip.cct.JettonWallet.compile.ts	Blueprint compile config for CCT JettonWallet Tolk entrypoint.
contracts/wrappers/ccip.cct.JettonMinter.compile.ts	Blueprint compile config for CCT JettonMinter Tolk entrypoint.
contracts/tests/ccip/pools/TokenPool.behavior.ts	Shared behavioral test suite for token-pool ramp/curse/chain behaviors.
contracts/tests/ccip/pools/LockReleaseTokenPool.spec.ts	LockReleaseTokenPool integration tests using Jettons and behavior suite.
contracts/tests/ccip/pools/BurnMintTokenPool.spec.ts	BurnMintTokenPool integration tests using CCT jettons and behavior suite.
contracts/contracts/ccip/pools/types.tolk	TokenPool-related structs/constants (configs, fee config, v1 IO types).
contracts/contracts/ccip/pools/messages.tolk	Opcode-tagged internal message types for TokenPool operations.
contracts/contracts/ccip/pools/events.tolk	Shared TokenPool event structs/topics.
contracts/contracts/ccip/pools/errors.tolk	TokenPool error codes/enum.
contracts/contracts/ccip/pools/rate_limiter.tolk	Rate limiter config/bucket structs and refill/consume logic.
contracts/contracts/ccip/pools/token_pool.tolk	Core TokenPool logic: chain config, ramps, cursed subjects, rate limiting, fees.
contracts/contracts/ccip/pools/token_pool_contract.tolk	TokenPool contract template entrypoint for bindings (non-deployable stub).
contracts/contracts/ccip/pools/lock_release_token_pool/types.tolk	LockReleaseTokenPool-specific constants and pending-release structs.
contracts/contracts/ccip/pools/lock_release_token_pool/storage.tolk	LockReleaseTokenPool storage layout and initialization.
contracts/contracts/ccip/pools/lock_release_token_pool/messages.tolk	LockReleaseTokenPool custom inbound/bounced message types.
contracts/contracts/ccip/pools/lock_release_token_pool/events.tolk	LockReleaseTokenPool-specific event structs/topics.
contracts/contracts/ccip/pools/lock_release_token_pool/errors.tolk	LockReleaseTokenPool-specific error enum/facility identifiers.
contracts/contracts/ccip/pools/lock_release_token_pool/contract.tolk	LockReleaseTokenPool contract implementation (lock via transfer notify, release via off-ramp).
contracts/contracts/ccip/pools/burn_mint_token_pool/types.tolk	BurnMintTokenPool-specific constants and pending burn/mint structs.
contracts/contracts/ccip/pools/burn_mint_token_pool/storage.tolk	BurnMintTokenPool storage layout and initialization.
contracts/contracts/ccip/pools/burn_mint_token_pool/messages.tolk	BurnMintTokenPool custom inbound message types (incl. claim-minter-admin).
contracts/contracts/ccip/pools/burn_mint_token_pool/errors.tolk	BurnMintTokenPool-specific error enum/facility identifiers.
contracts/contracts/ccip/pools/burn_mint_token_pool/contract.tolk	BurnMintTokenPool contract implementation (burn on lock, mint on release).
contracts/contracts/ccip/fee_quoter/types.tolk	Removes duplicated constant now defined under pools types.
contracts/contracts/ccip/cct/JettonWallet.tolk	CCT jetton wallet contract implementation (receive/transfer/burn + bounce handling).
contracts/contracts/ccip/cct/JettonMinter.tolk	CCT jetton minter contract implementation (mint/admin lifecycle + wallet address).
contracts/contracts/ccip/cct/fees-management.tolk	Fee/gas/storage estimation utilities for CCT jetton contracts.
contracts/Acton.toml	Registers new pool contracts (and TokenPool template) in Acton config.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+export async function sendUpdateCursedSubjects(
+  provider: ContractProvider,
+  via: Sender,
+  value: bigint,
+  cursedSubjects: bigint[],
+) {
+  const dict = Dictionary.empty(Dictionary.Keys.BigInt(128), Dictionary.Values.Bool())
+  cursedSubjects.forEach((subject) => dict.set(subject, true))
+  await provider.internal(via, {
+    value,
+    sendMode: SendMode.PAY_GAS_SEPARATELY,
+    body: beginCell().storeUint(opcodes.in.updateCursedSubjects, 32).storeDict(dict).endCell(),
+  })


+
+    RateLimiter_refillBucket(mutate bucket);
+    // TODO: should be RateLimiter error
+    // assert(bucket.tokens >= amount, TokenPool_Error.RateLimitExceeded);
+    bucket.tokens -= amount;
+}


+        remoteChainSelector: request.remoteChainSelector,
+        details: TokenPool_LockedOrBurnedDetails {
+            token: request.localToken,
+            sender: transferInitiator,
+            amount: prepared.destTokenAmount,


+  runTokenPoolBehaviorTests('LockReleaseTokenPool', async () => ({
+    pool: lockReleasePool,
+    deployer,
+    offRamp,
+    altOffRamp: deployer,
+    unauthorized: recipient,
+    recipient,
+    remoteChainSelector,
+    unsupportedChainSelector: remoteChainSelector + 1n,
+    unknownSourcePoolAddress: poolCodec.crossChainAddressFromBuffer(Buffer.from('unknown-source-pool')),
+    remoteTokenAddress: destTokenAddress,
+    onRampAddress: jettonSender.address,
+    destTokenAddress,
+    sourcePoolAddress,
+    localToken: jettonMinter.address,
+  }))


+  runTokenPoolBehaviorTests('BurnMintTokenPool', async () => ({
+    pool: burnMintPool,
+    deployer,
+    offRamp,
+    altOffRamp: deployer,
+    unauthorized,
+    recipient,
+    remoteChainSelector,
+    unsupportedChainSelector: remoteChainSelector + 1n,
+    unknownSourcePoolAddress: poolCodec.crossChainAddressFromBuffer(Buffer.from('unknown-source-pool')),
+    remoteTokenAddress: destTokenAddress,
+    onRampAddress: deployer.address,
+    destTokenAddress,
+    sourcePoolAddress,
+    localToken: cctMinter.address,
+  }))


patricios-space · 2026-06-10T13:09:17Z

+const GAS_CONSUMPTION_BurnNotification  = 3855
+
+
+fun calculateJettonWalletMinStorageFee() {


You can use @stdlib/reflection here:

Suggested change

fun calculateJettonWalletMinStorageFee() {

val (minBits, maxBits, minRefs, maxRefs) =reflect.estimateSerializationOf<WalletStorage>();

See docs

vicentevieytes · 2026-06-25T01:21:43Z

+    // We either get this transfer from the Router, in which case we trust the transfer is valid;
+    // Or for a different sender (e.g., per-user deposit account), we need to validate the transfer,
+    // which we can only do with context -> recover from ContextExecutor.
+    // 
+    // The context contains info about the sender, the amount, etc. that we can use to validate the transfer.
+    // If we can't validate the transfer, we try to return the funds.
+


So we have these two options:

Transfer comes from Router Wallet, and it's address is configured in the Pool:

SendExecutor initializes LockOrBurn: SendExecutor -> OnRamp -> Router --[LockOrBurn]-> TokenPool

TokenPool initiates withdraw: TokenPool -> SendExecutor -> OnRamp -> Router

Router withdraws from user deposit account and sends it to the pool: Router -> UserAccount -> UserAccountWallet -> RouterWallet -> Router -> RouterWallet -> TokenPool Wallet -> TokenPool

Transfer comes from user account:

SendExecutor initializes LockOrBurn: SendExecutor -> OnRamp -> Router --[LockOrBurn]-> TokenPool

TokenPool initiates withdraw: TokenPool -> SendExecutor -> OnRamp -> Router

Router indicates the user account to transfer to the pool directly: Router -> UserAccount -> UserAccountWallet -> TokenPool

Token pool verifies the transfer comes from the user wallet

The second option is simpler when it comes to how many messages and handlers we need, but we need the context_executor or some similar way to store the account wallet address. How far away are we from having the executor deployments/access wired in here?

Yes, that is basically it.

How far away are we from having the executor deployments/access wired in here?

The contract is roughly implemented, just need to start deploying/using it. Probably ready by end of next week, focusing on getting Lockbox + LockReleaseLockboxPool ready, then connect the executor.

Sounds good 👍
Probably a good idea to leave that integration for a follow up PR

patricios-space · 2026-06-26T14:29:18Z

+
+CCIP per-message sharded contracts which manage the context and state of the on-ramp and off-ramp flows.
+
+## TODO


We should move this documentation to the docs directory

patricios-space · 2026-06-26T14:51:01Z

+    val handled = executor.onInternalMessage(ContextExecutor_InMessageForward {
+        senderAddress: in.senderAddress,
+        valueCoins: in.valueCoins,
+        valueExtra: in.valueExtra,
+        originalForwardFee: in.originalForwardFee,
+        createdLt: in.createdLt,
+        createdAt: in.createdAt,
+        body: in.body.toCell(),
+    });


Why not just pass InMessage?

I see, InMessage cannot be serialized:

contracts/ccip/executors/context_executor/contract.tolk:16:23: error: `outgoingMessages` can not be serialized: type `ContextExecutor_OutMessage<cell>` because alias `ContextExecutor_OutMessage<cell>` expands to `ContextExecutor_Reply<cell> | ContextExecutor_ForwardNotification<cell>` because variant #2 of type `ContextExecutor_ForwardNotification<cell>` can't be serialized because field `ContextExecutor_ForwardNotification<cell>.message` of type `Cell<InMessage>` can't be serialized because field `InMessage.body` of type `slice` can't be serialized because type `slice` can not be used for reading, it doesn't define binary width hint: replace `slice` with `address` if it's an address, actually hint: replace `slice` with `bits128` and similar if it represents fixed-width data without refs 16 | outgoingMessages: ContextExecutor_OutMessage<cell> | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

krebernisak added 3 commits June 9, 2026 10:41

Init commit - token pools

0f500c8

Merge branch 'main' into feat/token-pool

ed11c95

Rename as ccip/pools, add gen wrappers

1461c96

krebernisak requested a review from a team as a code owner June 9, 2026 10:47

Copilot AI review requested due to automatic review settings June 9, 2026 10:47

krebernisak marked this pull request as draft June 9, 2026 10:47

Copilot started reviewing on behalf of krebernisak June 9, 2026 10:47 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

krebernisak added 5 commits June 9, 2026 12:55

yarn fmt

16365de

Add docs, polish, add SetRMNProxy msg

1437e06

Add getRMNProxy getters, regenerate bindings

a6a62f5

Update RateLimiter lib

a1d947b

abigen

1f7ddf7

patricios-space reviewed Jun 10, 2026

View reviewed changes

krebernisak added 11 commits June 11, 2026 10:45

Use abigen - init

37fa92f

Unify gen bindings setup

193641a

Update metadata

5b5f44c

Update opcodes

811c7b0

Use wrappers/gen/ccip/pools/BurnMintTokenPool.ts

44767d2

Remove non-generated token pool bindings

bd6e8f3

Polish applyChainUpdates fn

07f97eb

Move pow10(n) to math.tolk

454b78c

TokePool share flow structure - init

51c799e

Restructure lockOrBurn flow

bf5b83e

Add shared TP.onLockOrBurnTransferFinalize flow

c53ea4d

krebernisak force-pushed the feat/token-pool branch from 4124e19 to c53ea4d Compare June 16, 2026 12:17

krebernisak added 3 commits June 16, 2026 19:19

Wait on pre/postflight checks

0266a56

Cleanup, add missing msgs and metadata

6820d99

Polish add/removeRemotePool event/reply

148855f

krebernisak and others added 14 commits June 17, 2026 15:44

Add ContextExecutor lib and contract

c6cb811

Finish ContextExecutor contract

144f5e6

Add events/reply to okenPool<T>.setRateLimitConfig

e32f8e3

Add TokenPool_Hooks<T>.onLockOrBurnTransferContinue hook

528d375

Cleanup TokenPool<T>.onReleaseOrMint hook

56a41ec

Add TokenPool<T>.onReleaseOrMintContinue hook

6c89da1

Add advancedPoolHooks addr to storage + basic ops

cf8fcc4

Add TokenPool_SetAdvancedPoolHooks msg handler

5e42875

Cleanup contract metadata + abigen

b499ef0

Random polish

95d7b7d

Add transferId (ctx id), restructure storage

5f1d492

Merge branch 'main' into feat/token-pool

0d8a2f1

Rename pools sub-folders, add /lock_release_lockbox TODO

d446609

Integrate wiht OnRamp flow post-merge

7433e46

nicolasgnr marked this pull request as ready for review June 23, 2026 13:32

krebernisak force-pushed the feat/token-pool branch from 4c98bef to f6a86fb Compare June 23, 2026 17:55

Add Go bindings, fix burn flow test

5dd214c

krebernisak force-pushed the feat/token-pool branch from f6a86fb to 5dd214c Compare June 23, 2026 18:00

krebernisak added 2 commits June 23, 2026 20:24

Fix opcodes

15abbae

More Go bindings fixes

2de43cd

krebernisak force-pushed the feat/token-pool branch from 3bab02d to 2de43cd Compare June 23, 2026 18:44

krebernisak and others added 5 commits June 24, 2026 10:27

Fix lint

634cb0d

Merge branch 'main' into feat/token-pool

91b9151

Add ccip/pools/lockbox/JettonLockbox.tolk + bindings

89a1754

Add JettonLockbox.spec.ts tests

2211d2c

JettonLockBox more test cases

e31c6ac

vicentevieytes reviewed Jun 25, 2026

View reviewed changes

Fix opcodes, polish lockbox tests

c46ad24

patricios-space reviewed Jun 26, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Token pools#756

Token pools#756
krebernisak wants to merge 46 commits into
mainfrom
feat/token-pool

krebernisak commented Jun 9, 2026

Uh oh!

github-actions Bot commented Jun 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

patricios-space Jun 10, 2026

Uh oh!

Uh oh!

vicentevieytes Jun 25, 2026

Uh oh!

krebernisak Jun 25, 2026 •

edited

Loading

Uh oh!

vicentevieytes Jun 26, 2026

Uh oh!

patricios-space Jun 26, 2026

Uh oh!

patricios-space Jun 26, 2026

Uh oh!

patricios-space Jun 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		const GAS_CONSUMPTION_BurnNotification = 3855


		fun calculateJettonWalletMinStorageFee() {

	fun calculateJettonWalletMinStorageFee() {
	val (minBits, maxBits, minRefs, maxRefs) =reflect.estimateSerializationOf<WalletStorage>();


		CCIP per-message sharded contracts which manage the context and state of the on-ramp and off-ramp flows.

		## TODO

Uh oh!

Conversation

krebernisak commented Jun 9, 2026

Uh oh!

github-actions Bot commented Jun 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

patricios-space Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vicentevieytes Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

krebernisak Jun 25, 2026 • 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!

vicentevieytes Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

patricios-space Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

patricios-space Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

patricios-space Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

krebernisak Jun 25, 2026 •

edited

Loading