Token pools#756
Draft
krebernisak wants to merge 16 commits into
Draft
Conversation
|
👋 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! |
Contributor
There was a problem hiding this comment.
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, andBurnMintTokenPool, 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.
Comment on lines
+280
to
+292
| 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(), | ||
| }) |
Comment on lines
+31
to
+36
|
|
||
| RateLimiter_refillBucket(mutate bucket); | ||
| // TODO: should be RateLimiter error | ||
| // assert(bucket.tokens >= amount, TokenPool_Error.RateLimitExceeded); | ||
| bucket.tokens -= amount; | ||
| } |
Comment on lines
+92
to
+96
| remoteChainSelector: request.remoteChainSelector, | ||
| details: TokenPool_LockedOrBurnedDetails { | ||
| token: request.localToken, | ||
| sender: transferInitiator, | ||
| amount: prepared.destTokenAmount, |
Comment on lines
+145
to
+160
| 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, | ||
| })) |
Comment on lines
+162
to
+177
| 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, | ||
| })) |
| const GAS_CONSUMPTION_BurnNotification = 3855 | ||
|
|
||
|
|
||
| fun calculateJettonWalletMinStorageFee() { |
Collaborator
There was a problem hiding this comment.
You can use @stdlib/reflection here:
Suggested change
| fun calculateJettonWalletMinStorageFee() { | |
| val (minBits, maxBits, minRefs, maxRefs) =reflect.estimateSerializationOf<WalletStorage>(); |
See docs
This file contains hidden or 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
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.
No description provided.