Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: renamed sdkCoin functions to camelCase #50

Closed
wants to merge 3 commits into from
Closed

refactor: renamed sdkCoin functions to camelCase #50

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9e71ad
refactor: renamed sdkCoin functions to camelCase
MukulKolpe Aug 20, 2024
af6666c
refactor: renamed sdkCoin functions to camelCase
MukulKolpe Aug 21, 2024
1f3ba25
Merge branch 'main' into refactor_sdkCoin
srdtrk Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/SdkICS20Transfer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ contract SdkICS20Transfer is IIBCApp, IICS20Transfer, IICS20Errors, Ownable, Ree
// Use the _sdkCoinAmount to populate the packetData with a uint256 representation of the uint64 supported
// in the cosmos world that consider the proper decimals conversions.
// Since we just transfer the converted amount, we discard the remainder as it stays in the users account
(uint64 _sdkCoinAmount,) = SdkCoin._ERC20ToSdkCoin_ConvertAmount(contractAddress, msg_.amount);
(uint64 _sdkCoinAmount,) = SdkCoin.convertAmountERC20ToSdkCoin(contractAddress, msg_.amount);

if (_sdkCoinAmount == 0) {
revert ICS20InvalidAmountAfterConversion(msg_.amount, _sdkCoinAmount);
Expand Down Expand Up @@ -95,9 +95,9 @@ contract SdkICS20Transfer is IIBCApp, IICS20Transfer, IICS20Errors, Ownable, Ree

(address erc20Address, bool originatorChainIsSource) = getSendERC20AddressAndSource(msg_.packet, packetData);

// Use SdkCoin._SdkCoinToERC20_ConvertAmount to consider the proper decimals conversions.
// Use SdkCoin.convertAmountSdkCoinToERC20 to consider the proper decimals conversions.
uint256 _convertedAmount =
SdkCoin._SdkCoinToERC20_ConvertAmount(erc20Address, SafeCast.toUint64(packetData.amount));
SdkCoin.convertAmountSdkCoinToERC20(erc20Address, SafeCast.toUint64(packetData.amount));

// transfer the tokens to us (requires the allowance to be set)
_transferFrom(sender, address(this), erc20Address, _convertedAmount);
Expand Down Expand Up @@ -132,9 +132,9 @@ contract SdkICS20Transfer is IIBCApp, IICS20Transfer, IICS20Errors, Ownable, Ree
return ICS20Lib.errorAck(abi.encodePacked("invalid receiver: ", packetData.receiver));
}

// Use SdkCoin._SdkCoinToERC20_ConvertAmount to consider the proper decimals conversions.
// Use SdkCoin.convertAmountSdkCoinToERC20 to consider the proper decimals conversions.
uint256 _convertedAmount =
SdkCoin._SdkCoinToERC20_ConvertAmount(erc20Address, SafeCast.toUint64(packetData.amount));
SdkCoin.convertAmountSdkCoinToERC20(erc20Address, SafeCast.toUint64(packetData.amount));

// TODO: Implement escrow balance tracking (#6)
if (originatorChainIsSource) {
Expand Down Expand Up @@ -179,9 +179,9 @@ contract SdkICS20Transfer is IIBCApp, IICS20Transfer, IICS20Errors, Ownable, Ree
/// @param erc20Address The address of the ERC20 contract
function _refundTokens(ICS20Lib.PacketDataJSON memory packetData, address erc20Address) private {
address refundee = ICS20Lib.mustHexStringToAddress(packetData.sender);
// Use SdkCoin._SdkCoinToERC20_ConvertAmount to consider the proper decimals conversions.
// Use SdkCoin.convertAmountSdkCoinToERC20 to consider the proper decimals conversions.
(uint256 _convertedAmount) =
SdkCoin._SdkCoinToERC20_ConvertAmount(erc20Address, SafeCast.toUint64(packetData.amount));
SdkCoin.convertAmountSdkCoinToERC20(erc20Address, SafeCast.toUint64(packetData.amount));
IERC20(erc20Address).safeTransfer(refundee, _convertedAmount);
}

Expand Down
4 changes: 2 additions & 2 deletions src/utils/SdkCoin.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ library SdkCoin {
* @return convertedAmount The amount converted to uint64 supported by cosmos coins
* @return remainder The remainder of the conversion
*/
function _ERC20ToSdkCoin_ConvertAmount(
function convertAmountERC20ToSdkCoin(
MukulKolpe marked this conversation as resolved.
Show resolved Hide resolved
address tokenAddress,
uint256 amount
)
Expand Down Expand Up @@ -109,7 +109,7 @@ library SdkCoin {
* @param amount The amount to be converted
* @return convertedAmount The amount converted to uint256 supported by ERC20 tokens
*/
function _SdkCoinToERC20_ConvertAmount(address tokenAddress, uint64 amount) internal view returns (uint256) {
function convertAmountSdkCoinToERC20(address tokenAddress, uint64 amount) internal view returns (uint256) {
MukulKolpe marked this conversation as resolved.
Show resolved Hide resolved
// Get the token decimals
// address input validation perfomed in the _getERC20TokenDecimals
uint8 tokenDecimals = _getERC20TokenDecimals(tokenAddress);
Expand Down
22 changes: 11 additions & 11 deletions test/SdkCoinTest.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
* - The remainder matches the expected remainder after the conversion.
*
*/
function test_ERC20toSdkCoin_ConvertAmount() public view {
function test_convertAmountERC20ToSdkCoin() public view {
ERC20ToSdkCoin_ConvertTestCase[] memory testCases = new ERC20ToSdkCoin_ConvertTestCase[](6);

testCases[0] = ERC20ToSdkCoin_ConvertTestCase({
Expand Down Expand Up @@ -109,7 +109,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
for (uint256 i = 0; i < testCases.length; i++) {
ERC20ToSdkCoin_ConvertTestCase memory tc = testCases[i];
(uint64 convertedAmount, uint256 remainder) =
SdkCoin._ERC20ToSdkCoin_ConvertAmount(address(testERC20), tc.amount);
SdkCoin.convertAmountERC20ToSdkCoin(address(testERC20), tc.amount);

// Assertions
assertEq(
Expand Down Expand Up @@ -195,7 +195,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
ERC20MetadataToSdkCoin_ConvertTestCase memory tc = testCases[i];
TestERC20Metadata mockERC20Metadata = new TestERC20Metadata(tc.decimals);
(uint64 convertedAmount, uint256 remainder) =
SdkCoin._ERC20ToSdkCoin_ConvertAmount(address(mockERC20Metadata), tc.amount);
SdkCoin.convertAmountERC20ToSdkCoin(address(mockERC20Metadata), tc.amount);

// Assertions
assertEq(mockERC20Metadata.decimals(), tc.decimals, string(abi.encodePacked("Decimals mismatch: ", tc.m)));
Expand Down Expand Up @@ -225,7 +225,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
*
* @dev This function tests the conversion process of SdkCoin to ERC20 tokens with various decimals, ensuring that
* the
* conversion function `_SdkCoinToERC20_ConvertAmount` correctly calculates the equivalent ERC20 token amount.
* conversion function `convertAmountSdkCoinToERC20` correctly calculates the equivalent ERC20 token amount.
*
* The test cases cover the following scenarios:
* - 1 SdkCoin to an ERC20 token with MIN_SUPPORTED_DECIMALS
Expand Down Expand Up @@ -271,7 +271,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
for (uint256 i = 0; i < testCases.length; i++) {
SdkCoinToERC20_ConvertTestCase memory tc = testCases[i];
TestERC20Metadata mockERC20Metadata = new TestERC20Metadata(tc.decimals);
uint256 convertedAmount = SdkCoin._SdkCoinToERC20_ConvertAmount(address(mockERC20Metadata), tc.cosmosAmount);
uint256 convertedAmount = SdkCoin.convertAmountSdkCoinToERC20(address(mockERC20Metadata), tc.cosmosAmount);

// Assertions
assertEq(mockERC20Metadata.decimals(), tc.decimals, string(abi.encodePacked("Decimals mismatch: ", tc.m)));
Expand Down Expand Up @@ -315,7 +315,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
*
* The test uses `vm.expectRevert` to check for expected reverts in each scenario. Depending on the input
* parameters,
* it calls either the `_ERC20ToSdkCoin_ConvertAmount` or `_SdkCoinToERC20_ConvertAmount` function and verifies that
* it calls either the `convertAmountERC20ToSdkCoin` or `convertAmountSdkCoinToERC20` function and verifies that
* the correct error is thrown.
*/
function testRevertConditions() public {
Expand Down Expand Up @@ -379,9 +379,9 @@ contract SdkCoinTest is Test, IISdkCoinErrors {

vm.expectRevert(tc.expectedRevertSelector);
if (tc.evmAmount != 0) {
SdkCoin._ERC20ToSdkCoin_ConvertAmount(tc.tokenAddress, tc.evmAmount);
SdkCoin.convertAmountERC20ToSdkCoin(tc.tokenAddress, tc.evmAmount);
} else {
SdkCoin._SdkCoinToERC20_ConvertAmount(tc.tokenAddress, tc.cosmosAmount);
SdkCoin.convertAmountSdkCoinToERC20(tc.tokenAddress, tc.cosmosAmount);
}
}
}
Expand Down Expand Up @@ -548,7 +548,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
}
address tokenAddress = address(new TestERC20Metadata(MIN_SUPPORTED_DECIMALS));
(uint64 convertedAmount, uint256 remainder) =
SdkCoin._ERC20ToSdkCoin_ConvertAmount(address(tokenAddress), amount);
SdkCoin.convertAmountERC20ToSdkCoin(address(tokenAddress), amount);
assertInvariants_ERC20toSdkCoin_EqualDecimals(convertedAmount, amount, remainder);
}

Expand Down Expand Up @@ -576,7 +576,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
uint256 factor = 10 ** (decimals - SdkCoin.DEFAULT_COSMOS_DECIMALS);

(uint64 convertedAmount, uint256 remainder) =
SdkCoin._ERC20ToSdkCoin_ConvertAmount(address(tokenAddress), amount);
SdkCoin.convertAmountERC20ToSdkCoin(address(tokenAddress), amount);
assertInvariants_ERC20toSdkCoin_BiggerDecimals(convertedAmount, amount, remainder, factor);
}

Expand Down Expand Up @@ -611,7 +611,7 @@ contract SdkCoinTest is Test, IISdkCoinErrors {
}
address tokenAddress = address(new TestERC20Metadata(decimals));

uint256 convertedAmount = SdkCoin._SdkCoinToERC20_ConvertAmount(address(tokenAddress), amount);
uint256 convertedAmount = SdkCoin.convertAmountSdkCoinToERC20(address(tokenAddress), amount);
invariant_SdkCointoERC20_ConvertedAmountBiggerOrEqualThanInput(convertedAmount, amount);
}

Expand Down
Loading