feat: connector native minting cap #248
Conversation
WalkthroughThe recent changes to the Changes
Sequence Diagram(s)sequenceDiagram
participant TSS as Trusted Service Supplier
participant Contract as ZetaConnectorNonNative
participant User as User
User->>TSS: Request minting
TSS->>Contract: Check maxSupply
alt Sufficient supply available
Contract-->>TSS: Proceed with minting
TSS-->>User: Tokens minted successfully
else Max supply reached
Contract-->>TSS: Revert with ExceedsMaxSupply
TSS-->>User: Minting failed
end
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #248 +/- ##
==========================================
+ Coverage 60.91% 61.40% +0.48%
==========================================
Files 16 16
Lines 394 399 +5
Branches 103 106 +3
==========================================
+ Hits 240 245 +5
Misses 154 154 ☔ View full report in Codecov by Sentry. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
skosito
requested review from
andresaiello,
brewmaster012,
CharlieMc0 and
fadeev
as code owners
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (3)
pkg/contracts/prototypes/evm/zetaconnectornonnative.sol/zetaconnectornonnative.gois excluded by!pkg/**typechain-types/contracts/prototypes/evm/ZetaConnectorNonNative.tsis excluded by!typechain-types/**typechain-types/factories/contracts/prototypes/evm/ZetaConnectorNonNative__factory.tsis excluded by!typechain-types/**
Files selected for processing (4)
- contracts/prototypes/evm/ZetaConnectorNonNative.sol (3 hunks)
- testFoundry/GatewayEVM.t.sol (1 hunks)
- testFoundry/ZetaConnectorNative.t.sol (1 hunks)
- testFoundry/ZetaConnectorNonNative.t.sol (6 hunks)
Additional context used
Path-based instructions (1)
contracts/prototypes/evm/ZetaConnectorNonNative.sol (1)
Pattern
contracts/**: Review the Solidity contracts for security vulnerabilities and best practices.
Additional comments not posted (13)
contracts/prototypes/evm/ZetaConnectorNonNative.sol (7)
10-10: Addition ofmaxSupplyvariable approved.The
maxSupplyvariable is appropriately initialized to the maximum value foruint256, ensuring the cap is effectively unlimited until explicitly set.
14-14: Addition ofMaxSupplyUpdatedevent approved.The
MaxSupplyUpdatedevent provides necessary transparency and traceability for changes to the minting limit.
15-15: Addition ofExceedsMaxSupplyerror approved.The
ExceedsMaxSupplyerror is crucial for enforcing constraints on the token supply.
24-27:setMaxSupplyfunction approved.The function correctly sets the new maximum supply and emits the
MaxSupplyUpdatedevent. However, the parameter_maxSupplyshould be renamed tomaxSupplyto conform to Solidity naming conventions.- function setMaxSupply(uint256 _maxSupply) external onlyTSS() { - maxSupply = _maxSupply; - emit MaxSupplyUpdated(_maxSupply); + function setMaxSupply(uint256 maxSupply) external onlyTSS() { + maxSupply = maxSupply; + emit MaxSupplyUpdated(maxSupply);
31-31: Modification towithdrawfunction approved.The addition of the check against
maxSupplyensures that the function adheres to the maximum supply constraint.
39-39: Modification towithdrawAndCallfunction approved.The addition of the check against
maxSupplyensures that the function adheres to the maximum supply constraint.
52-52: Modification towithdrawAndRevertfunction approved.The addition of the check against
maxSupplyensures that the function adheres to the maximum supply constraint.testFoundry/ZetaConnectorNative.t.sol (1)
60-60: Addition ofvm.deal(tssAddress, 1 ether);approved.This change ensures that the
tssAddresshas a sufficient balance to interact with the contract, enhancing the test setup.testFoundry/ZetaConnectorNonNative.t.sol (4)
35-36: Addition ofExceedsMaxSupplyerror andMaxSupplyUpdatedevent approved.These additions are crucial for enforcing supply limits and providing transparency for changes to the minting limit.
84-99: Addition oftestWithdrawFailsIfMaxSupplyReachedfunction approved.This test ensures that the
withdrawfunction adheres to the maximum supply constraint, enhancing the contract's robustness.
155-169: Addition oftestWithdrawAndCallReceiveERC20FailsIfMaxSupplyReachedfunction approved.This test ensures that the
withdrawAndCallfunction adheres to the maximum supply constraint, enhancing the contract's robustness.
288-302: Addition oftestWithdrawAndRevertFailsIfMaxSupplyReachedfunction approved.This test ensures that the
withdrawAndRevertfunction adheres to the maximum supply constraint, enhancing the contract's robustness.testFoundry/GatewayEVM.t.sol (1)
61-62: LGTM! The change enhances the test setup.The addition of
vm.deal(tssAddress, 1 ether);ensures that thetssAddresshas sufficient ether for subsequent operations, improving the robustness of the test setup.
closes #236
Summary by CodeRabbit
New Features
Bug Fixes
Tests