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

Jump to bottom

WT-1734 Add fees to swap and bridge routes #944

Merged
merged 5 commits into from
Oct 6, 2023
Merged

WT-1734 Add fees to swap and bridge routes #944

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bf4d288
Add fees to bridge route
imx-mikhala Oct 5, 2023
43e014e
swap route fees
imx-mikhala Oct 5, 2023
86ac507
remove fees from top level
imx-mikhala Oct 5, 2023
78294b7
add token to bridge fee
imx-mikhala Oct 5, 2023
fce29b0
Merge branch 'main' into WT-1734
imx-mikhala Oct 6, 2023
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
105 changes: 51 additions & 54 deletions packages/checkout/sdk/src/smartCheckout/routing/bridge/bridgeRoute.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Environment } from '@imtbl/config';
import { JsonRpcProvider } from '@ethersproject/providers';
import { BigNumber } from 'ethers';
import { BigNumber, utils } from 'ethers';
import {
BridgeRequirement,
bridgeRoute,
Expand All @@ -12,6 +12,7 @@ import { CheckoutConfiguration } from '../../../config';
import {
BridgeRouteFeeEstimate,
ChainId,
DEFAULT_TOKEN_DECIMALS,
FundingRouteFeeEstimate,
FundingStepType,
ItemType,
Expand Down Expand Up @@ -47,22 +48,22 @@ describe('bridgeRoute', () => {
{
type: FundingStepType.BRIDGE,
gasFee: {
estimatedAmount: BigNumber.from(1),
estimatedAmount: BigNumber.from(2),
token: {
name: 'Ethereum',
symbol: 'ETH',
decimals: 18,
},
},
bridgeFee: {
estimatedAmount: BigNumber.from(1),
estimatedAmount: BigNumber.from(3),
token: {
name: 'Ethereum',
symbol: 'ETH',
decimals: 18,
},
},
totalFees: BigNumber.from(2),
totalFees: BigNumber.from(5),
},
],
]);
Expand Down Expand Up @@ -110,8 +111,8 @@ describe('bridgeRoute', () => {
},
},
{
balance: BigNumber.from(13),
formattedBalance: '13',
balance: BigNumber.from(16),
formattedBalance: '16',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down Expand Up @@ -144,8 +145,8 @@ describe('bridgeRoute', () => {
formattedAmount: '10',
},
userBalance: {
balance: BigNumber.from(13),
formattedBalance: '13',
balance: BigNumber.from(16),
formattedBalance: '16',
},
token: {
name: 'Ethereum',
Expand All @@ -154,19 +155,18 @@ describe('bridgeRoute', () => {
address: undefined,
},
},
// WT-1734 - Add fees
fees: {
approvalGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
formattedAmount: utils.formatUnits(BigNumber.from(0), DEFAULT_TOKEN_DECIMALS),
},
bridgeGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(2),
formattedAmount: utils.formatUnits(BigNumber.from(2), DEFAULT_TOKEN_DECIMALS),
},
bridgeFees: [{
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(3),
formattedAmount: utils.formatUnits(BigNumber.from(3), DEFAULT_TOKEN_DECIMALS),
}],
},
});
Expand All @@ -178,8 +178,8 @@ describe('bridgeRoute', () => {
success: true,
balances: [
{
balance: BigNumber.from(12),
formattedBalance: '12',
balance: BigNumber.from(15),
formattedBalance: '15',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down Expand Up @@ -212,8 +212,8 @@ describe('bridgeRoute', () => {
formattedAmount: '10',
},
userBalance: {
balance: BigNumber.from(12),
formattedBalance: '12',
balance: BigNumber.from(15),
formattedBalance: '15',
},
token: {
name: 'Ethereum',
Expand All @@ -222,19 +222,18 @@ describe('bridgeRoute', () => {
address: undefined,
},
},
// WT-1734 - Add fees
fees: {
approvalGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
formattedAmount: utils.formatUnits(BigNumber.from(0), DEFAULT_TOKEN_DECIMALS),
},
bridgeGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(2),
formattedAmount: utils.formatUnits(BigNumber.from(2), DEFAULT_TOKEN_DECIMALS),
},
bridgeFees: [{
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(3),
formattedAmount: utils.formatUnits(BigNumber.from(3), DEFAULT_TOKEN_DECIMALS),
}],
},
});
Expand All @@ -246,8 +245,8 @@ describe('bridgeRoute', () => {
success: true,
balances: [
{
balance: BigNumber.from(11),
formattedBalance: '11',
balance: BigNumber.from(14),
formattedBalance: '14',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down Expand Up @@ -289,8 +288,8 @@ describe('bridgeRoute', () => {
},
},
{
balance: BigNumber.from(12),
formattedBalance: '12',
balance: BigNumber.from(20),
formattedBalance: '20',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down Expand Up @@ -353,17 +352,17 @@ describe('bridgeRoute', () => {
success: true,
balances: [
{
balance: BigNumber.from(10),
formattedBalance: '10',
balance: BigNumber.from(7),
formattedBalance: '7',
token: {
name: 'Ethereum',
symbol: 'ETH',
decimals: 18,
},
},
{
balance: BigNumber.from(11),
formattedBalance: '11',
balance: BigNumber.from(10),
formattedBalance: '10',
token: {
name: '0xERC20',
symbol: '0xERC20',
Expand Down Expand Up @@ -397,8 +396,8 @@ describe('bridgeRoute', () => {
formattedAmount: '10',
},
userBalance: {
balance: BigNumber.from(11),
formattedBalance: '11',
balance: BigNumber.from(10),
formattedBalance: '10',
},
token: {
name: '0xERC20',
Expand All @@ -407,19 +406,18 @@ describe('bridgeRoute', () => {
decimals: 18,
},
},
// WT-1734 - Add fees
fees: {
approvalGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(1),
formattedAmount: utils.formatUnits(BigNumber.from(1), DEFAULT_TOKEN_DECIMALS),
},
bridgeGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(2),
formattedAmount: utils.formatUnits(BigNumber.from(2), DEFAULT_TOKEN_DECIMALS),
},
bridgeFees: [{
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(3),
formattedAmount: utils.formatUnits(BigNumber.from(3), DEFAULT_TOKEN_DECIMALS),
}],
},
});
Expand All @@ -431,8 +429,8 @@ describe('bridgeRoute', () => {
success: true,
balances: [
{
balance: BigNumber.from(2),
formattedBalance: '2',
balance: BigNumber.from(6),
formattedBalance: '6',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down Expand Up @@ -485,19 +483,18 @@ describe('bridgeRoute', () => {
decimals: 18,
},
},
// WT-1734 - Add fees
fees: {
approvalGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(1),
formattedAmount: utils.formatUnits(BigNumber.from(1), DEFAULT_TOKEN_DECIMALS),
},
bridgeGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(2),
formattedAmount: utils.formatUnits(BigNumber.from(2), DEFAULT_TOKEN_DECIMALS),
},
bridgeFees: [{
amount: BigNumber.from(0),
formattedAmount: '0',
amount: BigNumber.from(3),
formattedAmount: utils.formatUnits(BigNumber.from(3), DEFAULT_TOKEN_DECIMALS),
}],
},
});
Expand All @@ -509,8 +506,8 @@ describe('bridgeRoute', () => {
success: true,
balances: [
{
balance: BigNumber.from(2),
formattedBalance: '2',
balance: BigNumber.from(10),
formattedBalance: '10',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down Expand Up @@ -552,8 +549,8 @@ describe('bridgeRoute', () => {
success: true,
balances: [
{
balance: BigNumber.from(1),
formattedBalance: '1',
balance: BigNumber.from(4),
formattedBalance: '4',
token: {
name: 'Ethereum',
symbol: 'ETH',
Expand Down
63 changes: 45 additions & 18 deletions packages/checkout/sdk/src/smartCheckout/routing/bridge/bridgeRoute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { BigNumber, ethers } from 'ethers';
import { BigNumber, ethers, utils } from 'ethers';
import {
BridgeFundingStep,
ChainId,
Expand All @@ -9,6 +9,9 @@ import {
AvailableRoutingOptions,
BridgeRouteFeeEstimate,
FundingRouteFeeEstimate,
BridgeFees,
TokenInfo,
DEFAULT_TOKEN_DECIMALS,
} from '../../../types';
import { CheckoutConfiguration, getL1ChainId } from '../../../config';
import {
Expand Down Expand Up @@ -58,11 +61,37 @@ export const getBridgeGasEstimate = async (
return bridgeFeeEstimate;
};

const constructFees = (
approvalGasFees: BigNumber,
bridgeGasFees: BigNumber,
bridgeFee: {
estimatedAmount: BigNumber,
token?: TokenInfo,
},
): BridgeFees => {
const bridgeFeeDecimals = bridgeFee.token?.decimals ?? DEFAULT_TOKEN_DECIMALS;
return {
approvalGasFees: {
amount: approvalGasFees,
formattedAmount: utils.formatUnits(approvalGasFees, DEFAULT_TOKEN_DECIMALS),
},
bridgeGasFees: {
amount: bridgeGasFees,
formattedAmount: utils.formatUnits(bridgeGasFees, DEFAULT_TOKEN_DECIMALS),
},
bridgeFees: [{
amount: bridgeFee.estimatedAmount,
formattedAmount: utils.formatUnits(bridgeFee.estimatedAmount, bridgeFeeDecimals),
}],
};
};

const constructBridgeFundingRoute = (
chainId: ChainId,
balance: GetBalanceResult,
bridgeRequirement: BridgeRequirement,
itemType: ItemType.NATIVE | ItemType.ERC20,
fees: BridgeFees,
): BridgeFundingStep => ({
type: FundingStepType.BRIDGE,
chainId,
Expand All @@ -83,21 +112,7 @@ const constructBridgeFundingRoute = (
decimals: balance.token.decimals,
},
},
// WT-1734 - Add fees
fees: {
approvalGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
},
bridgeGasFees: {
amount: BigNumber.from(0),
formattedAmount: '0',
},
bridgeFees: [{
amount: BigNumber.from(0),
formattedAmount: '0',
}],
},
fees,
});

export const isNativeEth = (address: string | undefined): boolean => {
Expand Down Expand Up @@ -183,24 +198,36 @@ export const bridgeRoute = async (
if (nativeETHBalance && nativeETHBalance.balance.gte(
bridgeRequirement.amount.add(totalFees),
)) {
return constructBridgeFundingRoute(chainId, nativeETHBalance, bridgeRequirement, ItemType.NATIVE);
const bridgeFees = constructFees(
gasForApproval,
bridgeFeeEstimate.gasFee.estimatedAmount,
bridgeFeeEstimate.bridgeFee,
);
return constructBridgeFundingRoute(chainId, nativeETHBalance, bridgeRequirement, ItemType.NATIVE, bridgeFees);
}

return undefined;
}

totalFees.add(gasForApproval).add(bridgeFeeEstimate.gasFee.estimatedAmount);

if (!hasSufficientL1Eth(
tokenBalanceResult,
totalFees,
)) return undefined;

// Find the balance of the L1 representation of the token and check if the balance covers the delta
const erc20balance = tokenBalanceResult.balances.find((balance) => balance.token.address === l1address);

if (erc20balance && erc20balance.balance.gte(
bridgeRequirement.amount,
)) {
return constructBridgeFundingRoute(chainId, erc20balance, bridgeRequirement, ItemType.ERC20);
const bridgeFees = constructFees(
gasForApproval,
bridgeFeeEstimate.gasFee.estimatedAmount,
bridgeFeeEstimate.bridgeFee,
);
return constructBridgeFundingRoute(chainId, erc20balance, bridgeRequirement, ItemType.ERC20, bridgeFees);
}

return undefined;
Expand Down
Loading
Loading