feat(staking): add BTC support #60
Conversation
|
@andresaiello can you, please, take a look and see if this look right? |
|
Will merge after I check it out on the real testnet. |
|
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
|
👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎ This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. Ignoring: Next stepsTake a deeper look at the dependencyTake a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev. Remove the packageIf you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency. Mark a package as acceptable riskTo ignore an alert, reply with a comment starting with |
|
@SocketSecurity ignore [email protected] |
| SystemContract public immutable systemContract; | ||
| uint256 public immutable chainID; |
There was a problem hiding this comment.
I think immutable could be written in full uppercase.
There was a problem hiding this comment.
that's not the solidity standard and is not the one with use. is more important to be consistent with all the contracts.
|
|
||
| SystemContract public immutable systemContract; | ||
| uint256 public immutable chainID; | ||
| uint256 public rewardRate = 1; | ||
| uint256 constant BITCOIN = 18332; |
There was a problem hiding this comment.
I think it would be more visual grouping immutable and constant together, no public between
| mapping(address => address) public beneficiaries; | ||
| mapping(address => uint256) public lastStakeTime; | ||
| uint256 public rewardRate = 1; | ||
|
|
||
| constructor( | ||
| string memory name_, |
There was a problem hiding this comment.
| string memory name_, | |
| string memory _name, |
Same comment for variables below
There was a problem hiding this comment.
that's the old standard. in current solidity standard _ at the end means avoid name collision and at the beginning is only for private names
There was a problem hiding this comment.
Ok, didn't know that, I've never seen this standard
| mapping(address => uint256) public stakes; | ||
| mapping(address => bytes) public withdrawAddresses; | ||
| mapping(address => address) public beneficiaries; | ||
| mapping(address => uint256) public lastStakeTime; |
There was a problem hiding this comment.
The usage of singulare/plural is not consistent.
We might want to have lastStakeTimes or using stake, etc..
Since these are maps I would tend to say singular makes more sense
| _; | ||
| } | ||
|
|
||
| function bytesToBech32Bytes( |
There was a problem hiding this comment.
It looks like this one could be internal
| @@ -9,15 +9,17 @@ import "@zetachain/toolkit/contracts/BytesHelperLib.sol"; | |||
| contract Staking is ERC20, zContract { | |||
| error SenderNotSystemContract(); | |||
| error WrongChain(); | |||
| error NotAuthorizedToClaim(); | |||
| error UnknownAction(); | |||
There was a problem hiding this comment.
I think you can set attributes to error, UnknownAction(uint action). In practice this allows to have a more explicit error, this might be a good thing to show in the tutorial
|
Thanks for all the comments, @lumtis! Really appreciate it! |
| beneficiaries[staker] = beneficiary; | ||
| } | ||
| lastStakeTime[staker] = block.timestamp; | ||
| require(stakes[staker] >= amount, "Overflow detected"); |
There was a problem hiding this comment.
change it to custom errors like the others
| IZRC20(zrc20).withdraw(abi.encodePacked(msg.sender), amount - gasFee); | ||
| IZRC20(zrc20).withdraw(recipient, amount - gasFee); | ||
|
|
||
| stakes[staker] = 0; |
There was a problem hiding this comment.
to be aligned with check then do pattern, move this before the withdrawal
|
Thanks for reviewing, @andresaiello & @lumtis! |
Mofidied the contract to work with EVM and Bitcoin.