feat: Gateway methods and Solana deposit #179
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import { ethers } from "ethers"; | ||
|
|
||
| import GatewayABI from "./abi/GatewayEVM.sol/GatewayEVM.json"; | ||
| import { ZetaChainClient } from "./client"; | ||
|
|
||
| export const evmCall = async function ( | ||
| this: ZetaChainClient, | ||
| args: { | ||
| callOnRevert: boolean; | ||
| gasLimit: number; | ||
| gasPrice: ethers.BigNumber; | ||
| gatewayEvm: string; | ||
| onRevertGasLimit: number; | ||
| receiver: string; | ||
| revertAddress: string; | ||
| revertMessage: string; | ||
| types: string; | ||
| values: any[]; | ||
| } | ||
| ) { | ||
| const signer = this.signer; | ||
| const { utils } = ethers; | ||
| const gateway = new ethers.Contract(args.gatewayEvm, GatewayABI.abi, signer); | ||
|
|
||
| const encodedParameters = utils.defaultAbiCoder.encode( | ||
| JSON.parse(args.types), | ||
| args.values | ||
| ); | ||
| const tx = await gateway[ | ||
| "call(address,bytes,(address,bool,address,bytes,uint256))" | ||
| ]( | ||
| args.receiver, | ||
| encodedParameters, | ||
| { | ||
| abortAddress: "0x0000000000000000000000000000000000000000", | ||
| callOnRevert: args.callOnRevert, | ||
| onRevertGasLimit: args.onRevertGasLimit, | ||
| revertAddress: args.revertAddress, | ||
| revertMessage: utils.hexlify(utils.toUtf8Bytes(args.revertMessage)), | ||
| }, | ||
| { | ||
| gasLimit: args.gasLimit, | ||
| gasPrice: args.gasPrice, | ||
| } | ||
| ); | ||
|
|
||
| return tx; | ||
| }; | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| import ERC20_ABI from "@openzeppelin/contracts/build/contracts/ERC20.json"; | ||
| import { ethers } from "ethers"; | ||
|
|
||
| import GatewayABI from "./abi/GatewayEVM.sol/GatewayEVM.json"; | ||
| import { ZetaChainClient } from "./client"; | ||
|
|
||
| export const evmDeposit = async function ( | ||
| this: ZetaChainClient, | ||
| args: { | ||
| amount: string; | ||
| callOnRevert: boolean; | ||
| erc20: string; | ||
| gasLimit: number; | ||
| gasPrice: ethers.BigNumber; | ||
| gatewayEvm: string; | ||
| onRevertGasLimit: number; | ||
| receiver: string; | ||
| revertAddress: string; | ||
| revertMessage: string; | ||
| } | ||
| ) { | ||
| const signer = this.signer; | ||
| const { utils } = ethers; | ||
| const gateway = new ethers.Contract(args.gatewayEvm, GatewayABI.abi, signer); | ||
|
|
||
| const revertOptions = { | ||
| abortAddress: "0x0000000000000000000000000000000000000000", | ||
| callOnRevert: args.callOnRevert, | ||
| onRevertGasLimit: args.onRevertGasLimit, | ||
| revertAddress: args.revertAddress, | ||
| // not used | ||
| revertMessage: utils.hexlify(utils.toUtf8Bytes(args.revertMessage)), | ||
| }; | ||
|
|
||
| const txOptions = { | ||
| gasLimit: args.gasLimit, | ||
| gasPrice: args.gasPrice, | ||
| }; | ||
| let tx; | ||
| if (args.erc20) { | ||
| const erc20Contract = new ethers.Contract( | ||
| args.erc20, | ||
| ERC20_ABI.abi, | ||
| signer | ||
| ); | ||
| const decimals = await erc20Contract.decimals(); | ||
| const value = utils.parseUnits(args.amount, decimals); | ||
| await erc20Contract.connect(signer).approve(args.gatewayEvm, value); | ||
| const method = | ||
| "deposit(address,uint256,address,(address,bool,address,bytes,uint256))"; | ||
| tx = await gateway[method]( | ||
| args.receiver, | ||
| value, | ||
| args.erc20, | ||
| revertOptions, | ||
| txOptions | ||
| ); | ||
| } else { | ||
| const value = utils.parseEther(args.amount); | ||
| const method = "deposit(address,(address,bool,address,bytes,uint256))"; | ||
| tx = await gateway[method](args.receiver, revertOptions, { | ||
| ...txOptions, | ||
| value, | ||
| }); | ||
| } | ||
|
|
||
| return tx; | ||
| }; | ||
|
Comment on lines
+7
to
+68
There was a problem hiding this comment. Review of
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import ERC20_ABI from "@openzeppelin/contracts/build/contracts/ERC20.json"; | ||
| import { ethers } from "ethers"; | ||
|
|
||
| import GatewayABI from "./abi/GatewayEVM.sol/GatewayEVM.json"; | ||
| import { ZetaChainClient } from "./client"; | ||
|
|
||
| export const evmDepositAndCall = async function ( | ||
| this: ZetaChainClient, | ||
| args: { | ||
| amount: string; | ||
| callOnRevert: boolean; | ||
| erc20: string; | ||
| gasLimit: number; | ||
| gasPrice: ethers.BigNumber; | ||
| gatewayEvm: string; | ||
| onRevertGasLimit: number; | ||
| receiver: string; | ||
| revertAddress: string; | ||
| revertMessage: string; | ||
| types: string; | ||
| values: any[]; | ||
| } | ||
| ) { | ||
| const signer = this.signer; | ||
| const { utils } = ethers; | ||
| const gateway = new ethers.Contract(args.gatewayEvm, GatewayABI.abi, signer); | ||
|
|
||
| const revertOptions = { | ||
| abortAddress: "0x0000000000000000000000000000000000000000", | ||
| callOnRevert: args.callOnRevert, | ||
| onRevertGasLimit: args.onRevertGasLimit, | ||
| revertAddress: args.revertAddress, | ||
| // not used | ||
| revertMessage: utils.hexlify(utils.toUtf8Bytes(args.revertMessage)), | ||
| }; | ||
|
|
||
| const txOptions = { | ||
| gasLimit: args.gasLimit, | ||
| gasPrice: args.gasPrice, | ||
| }; | ||
|
|
||
| const encodedParameters = utils.defaultAbiCoder.encode( | ||
| JSON.parse(args.types), | ||
| args.values | ||
| ); | ||
| let tx; | ||
| if (args.erc20) { | ||
| const erc20Contract = new ethers.Contract( | ||
| args.erc20, | ||
| ERC20_ABI.abi, | ||
| signer | ||
| ); | ||
| const decimals = await erc20Contract.decimals(); | ||
| const value = utils.parseUnits(args.amount, decimals); | ||
| await erc20Contract.connect(signer).approve(args.gatewayEvm, value); | ||
| const method = | ||
| "depositAndCall(address,uint256,address,bytes,(address,bool,address,bytes,uint256))"; | ||
| tx = await gateway[method]( | ||
| args.receiver, | ||
| value, | ||
| args.erc20, | ||
| encodedParameters, | ||
| revertOptions, | ||
| txOptions | ||
| ); | ||
| } else { | ||
| const value = utils.parseEther(args.amount); | ||
| const method = | ||
| "depositAndCall(address,bytes,(address,bool,address,bytes,uint256))"; | ||
| tx = await gateway[method]( | ||
| args.receiver, | ||
| encodedParameters, | ||
| revertOptions, | ||
| { | ||
| ...txOptions, | ||
| value, | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| return tx; | ||
| }; | ||
|
Comment on lines
+7
to
+82
There was a problem hiding this comment. Review of
Enhance validation of token addresses and amounts. Optimize transaction options for cost-efficiency. Improve error handling to manage exceptions and reverts more effectively. |
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review of
evmCallfunction: Potential security and maintainability concerns.Security Concern: JSON Parsing in Transaction Call
Direct use of
JSON.parse(args.types)in the transaction setup could lead to security vulnerabilities if the input is not properly validated. Consider validating or sanitizing the input before parsing to ensure it does not introduce code injection risks.Hardcoded Address Usage
The
abortAddressis hardcoded, which might limit flexibility. If this address might need to change based on the network or other conditions, consider making it a configurable parameter.Dynamic Method Access
Accessing the contract method using a string key (
gateway["call(address,bytes,(address,bool,address,bytes,uint256))"]) assumes the method name is stable. This could lead to maintenance issues if the ABI changes. Consider defining these method names as constants or ensuring they are updated when the ABI changes.Error Handling
The function does not explicitly handle errors that could occur during the transaction call. Consider adding try-catch blocks around the transaction call to handle possible rejections or failures gracefully.