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: rewards has own bridge router and adapters #226

Merged
merged 4 commits into from
Feb 12, 2025
Merged

refactor: rewards has own bridge router and adapters #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f42a42
refactor: rewards has own bridge router and adapters
gidonkatten Feb 8, 2025
7a0c337
refactor: update spoke address
gidonkatten Feb 8, 2025
5db39db
refactor: update contracts
gidonkatten Feb 9, 2025
47b54fc
Merge branch 'rewards-v2' into rewards-messaging
gidonkatten Feb 12, 2025
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
22 changes: 19 additions & 3 deletions src/chains/evm/hub/constants/chain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,10 +252,11 @@ export const HUB_CHAIN: Record<NetworkType, HubChain> = {
},
} satisfies Record<MainnetFolksTokenId, HubTokenData>,
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {},
[REWARDS_TYPE.V1]: {
hubAddress: convertToGenericAddress("0x7c532A6209350cF27EfC3D06E82E35ACFd362C7C" as EvmAddress, ChainType.EVM),
},
// TODO rewards: add deployed contracts
[REWARDS_TYPE.V2]: {
hubAddress: convertToGenericAddress("0x" as EvmAddress, ChainType.EVM),
spokeManagerAddress: convertToGenericAddress("0x" as EvmAddress, ChainType.EVM),
Expand Down Expand Up @@ -399,13 +400,28 @@ export const HUB_CHAIN: Record<NetworkType, HubChain> = {
},
} satisfies Record<TestnetFolksTokenId, HubTokenData>,
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {
[AdapterType.HUB]: convertToGenericAddress(
"0x1fb4d24C5fB0807d5EC338dEa276e88B13cB48dE" as EvmAddress,
ChainType.EVM,
),
[AdapterType.WORMHOLE_DATA]: convertToGenericAddress(
"0x73FC90E2cEcED235D23C8B54d17Ba54d8516d689" as EvmAddress,
ChainType.EVM,
),
[AdapterType.CCIP_DATA]: convertToGenericAddress(
"0x5c9d6C2202F214f3f8B879eaE3e16C6675338D4E" as EvmAddress,
ChainType.EVM,
),
},
[REWARDS_TYPE.V1]: {
hubAddress: convertToGenericAddress("0xB8Aa9782d5922B00fC63e7def85F276059B4aCd0" as EvmAddress, ChainType.EVM),
},
[REWARDS_TYPE.V2]: {
hubAddress: convertToGenericAddress("0x41e178f4d6561160f3E1376b6a8324EED293a1bb" as EvmAddress, ChainType.EVM),
hubAddress: convertToGenericAddress("0xD962d5198A170bAf75da57C7C408e6EE7d912086" as EvmAddress, ChainType.EVM),
spokeManagerAddress: convertToGenericAddress(
"0x26D5dfb79E54aDF2e67Efe12CefB7835A6646894" as EvmAddress,
"0x9c78F1c73B3C21917624e0e6e78bB37bf0b8Ce91" as EvmAddress,
ChainType.EVM,
),
tokens: {
Expand Down
13 changes: 10 additions & 3 deletions src/chains/evm/hub/modules/folks-hub-gmp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { increaseByPercent } from "../../../../common/utils/math-lib.js";
import { RETRY_REVERSE_GAS_LIMIT_SLIPPAGE } from "../../common/constants/contract.js";
import { getEvmSignerAccount } from "../../common/utils/chain.js";
import { buildMessageParams, buildSendTokenExtraArgsWhenRemoving } from "../../common/utils/message.js";
import { getHubChainBridgeRouterAddress } from "../utils/chain.js";
import { getBridgeRouterHubContract } from "../utils/contract.js";

import type { EvmAddress } from "../../../../common/types/address.js";
Expand All @@ -27,11 +28,13 @@ export const prepare = {
extraArgs: Hex,
value: bigint,
hubChain: HubChain,
isRewards = false,
transactionOptions: EstimateGasParameters = {
account: sender,
},
): Promise<PrepareRetryMessageCall> {
const bridgeRouter = getBridgeRouterHubContract(provider, hubChain.bridgeRouterAddress);
const bridgeRouterAddress = getHubChainBridgeRouterAddress(hubChain, isRewards);
const bridgeRouter = getBridgeRouterHubContract(provider, bridgeRouterAddress);

const gasLimit = await bridgeRouter.estimateGas.retryMessage([adapterId, messageId, message, extraArgs], {
...transactionOptions,
Expand All @@ -57,11 +60,13 @@ export const prepare = {
extraArgs: Hex,
value: bigint,
hubChain: HubChain,
isRewards = false,
transactionOptions: EstimateGasParameters = {
account: sender,
},
): Promise<PrepareRetryMessageCall> {
const bridgeRouter = getBridgeRouterHubContract(provider, hubChain.bridgeRouterAddress);
const bridgeRouterAddress = getHubChainBridgeRouterAddress(hubChain, isRewards);
const bridgeRouter = getBridgeRouterHubContract(provider, bridgeRouterAddress);

const gasLimit = await bridgeRouter.estimateGas.reverseMessage([adapterId, messageId, message, extraArgs], {
...transactionOptions,
Expand Down Expand Up @@ -126,8 +131,10 @@ export async function getSendMessageFee(
gasLimit: bigint,
hubChain: HubChain,
hubTokenData: HubTokenData,
isRewards = false,
): Promise<bigint> {
const hubBridgeRouter = getBridgeRouterHubContract(provider, hubChain.bridgeRouterAddress);
const bridgeRouterAddress = getHubChainBridgeRouterAddress(hubChain, isRewards);
const hubBridgeRouter = getBridgeRouterHubContract(provider, bridgeRouterAddress);

// construct return message
const message: MessageToSend = {
Expand Down
2 changes: 2 additions & 0 deletions src/chains/evm/hub/types/chain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ type HubRewardsV2 = {
};

export type HubRewardsMap = {
bridgeRouterAddress: GenericAddress;
adapters: Partial<Record<AdapterType, GenericAddress>>;
[REWARDS_TYPE.V1]: HubRewardsV1;
[REWARDS_TYPE.V2]: HubRewardsV2;
};
Expand Down
12 changes: 10 additions & 2 deletions src/chains/evm/hub/utils/chain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,15 @@ export function assertLoanTypeSupported(loanType: LoanTypeId, folksTokenId: Folk
throw new Error(`Loan type ${loanType} is not supported for folksTokenId: ${folksTokenId}`);
}

export function getHubChainAdapterAddress(network: NetworkType, adapterType: AdapterType) {
export function getHubChainAdapterAddress(network: NetworkType, adapterType: AdapterType, isRewards = false) {
const hubChain = getHubChain(network);
return hubChain.adapters[adapterType];
const { adapters } = isRewards ? hubChain.rewards : hubChain;
const adapterAddress = adapters[adapterType];
if (adapterAddress) return adapterAddress;
throw new Error(`Adapter ${adapterType} not found for hub chain ${hubChain.folksChainId}`);
}

export function getHubChainBridgeRouterAddress(hubChain: HubChain, isRewards = false) {
const { bridgeRouterAddress } = isRewards ? hubChain.rewards : hubChain;
return bridgeRouterAddress;
}
13 changes: 10 additions & 3 deletions src/chains/evm/spoke/modules/folks-evm-gmp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
getRandomGenericAddress,
} from "../../../../common/utils/address.js";
import { getRandomBytes } from "../../../../common/utils/bytes.js";
import { getSpokeChainBridgeRouterAddress } from "../../../../common/utils/chain.js";
import { getWormholeData } from "../../../../common/utils/gmp.js";
import { GAS_LIMIT_ESTIMATE_INCREASE } from "../../common/constants/contract.js";
import { getEvmSignerAccount } from "../../common/utils/chain.js";
Expand Down Expand Up @@ -37,11 +38,13 @@ export const prepare = {
extraArgs: Hex,
value: bigint,
spokeChain: SpokeChain,
isRewards = false,
transactionOptions: EstimateGasParameters = {
account: sender,
},
): Promise<PrepareRetryMessageCall> {
const bridgeRouter = getBridgeRouterSpokeContract(provider, spokeChain.bridgeRouterAddress);
const bridgeRouterAddress = getSpokeChainBridgeRouterAddress(spokeChain, isRewards);
const bridgeRouter = getBridgeRouterSpokeContract(provider, bridgeRouterAddress);

const gasLimit = await bridgeRouter.estimateGas.retryMessage([adapterId, messageId, message, extraArgs], {
...transactionOptions,
Expand All @@ -67,11 +70,13 @@ export const prepare = {
extraArgs: Hex,
value: bigint,
spokeChain: SpokeChain,
isRewards = false,
transactionOptions: EstimateGasParameters = {
account: sender,
},
): Promise<PrepareRetryMessageCall> {
const bridgeRouter = getBridgeRouterSpokeContract(provider, spokeChain.bridgeRouterAddress);
const bridgeRouterAddress = getSpokeChainBridgeRouterAddress(spokeChain, isRewards);
const bridgeRouter = getBridgeRouterSpokeContract(provider, bridgeRouterAddress);

const gasLimit = await bridgeRouter.estimateGas.reverseMessage([adapterId, messageId, message, extraArgs], {
...transactionOptions,
Expand Down Expand Up @@ -219,8 +224,10 @@ export async function getSendMessageFee(
hubChain: HubChain,
spokeChain: SpokeChain,
spokeTokenData?: SpokeTokenData,
isRewards = false,
): Promise<bigint> {
const bridgeRouter = getBridgeRouterSpokeContract(provider, spokeChain.bridgeRouterAddress);
const bridgeRouterAddress = getSpokeChainBridgeRouterAddress(spokeChain, isRewards);
const bridgeRouter = getBridgeRouterSpokeContract(provider, bridgeRouterAddress);

// construct return message
const message: MessageToSend = {
Expand Down
108 changes: 96 additions & 12 deletions src/common/constants/chain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,10 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
),
},
},
rewards: {},
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {},
},
},
[FOLKS_CHAIN_ID.ETHEREUM]: {
folksChainId: FOLKS_CHAIN_ID.ETHEREUM,
Expand Down Expand Up @@ -330,7 +333,10 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
),
},
},
rewards: {},
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {},
},
},
[FOLKS_CHAIN_ID.BASE]: {
folksChainId: FOLKS_CHAIN_ID.BASE,
Expand Down Expand Up @@ -415,7 +421,10 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
),
},
},
rewards: {},
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {},
},
},
[FOLKS_CHAIN_ID.BSC]: {
folksChainId: FOLKS_CHAIN_ID.BSC,
Expand Down Expand Up @@ -495,7 +504,10 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
),
},
},
rewards: {},
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {},
},
},
[FOLKS_CHAIN_ID.ARBITRUM]: {
folksChainId: FOLKS_CHAIN_ID.ARBITRUM,
Expand Down Expand Up @@ -580,7 +592,10 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
),
},
},
rewards: {},
rewards: {
bridgeRouterAddress: convertToGenericAddress("" as EvmAddress, ChainType.EVM),
adapters: {},
},
},
} satisfies Record<MainnetFolksChainId, SpokeChain>,
[NetworkType.TESTNET]: {
Expand Down Expand Up @@ -643,16 +658,26 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
},
},
rewards: {
bridgeRouterAddress: convertToGenericAddress(
"0x2DF7822E986CAE57812d6d9066c25784428a14C0" as EvmAddress,
ChainType.EVM,
),
adapters: {
[AdapterType.HUB]: convertToGenericAddress(
"0x1fb4d24C5fB0807d5EC338dEa276e88B13cB48dE" as EvmAddress,
ChainType.EVM,
),
},
[REWARDS_TYPE.V2]: {
spokeRewardsCommonAddress: convertToGenericAddress(
"0x5b3c96DE3D22dAd94fffCfb22FE9625A3C2146d3" as EvmAddress,
"0xAe211B8A06B8dc57D0E5b14C16eF3c12aA170655" as EvmAddress,
ChainType.EVM,
),
tokens: {
[TESTNET_REWARDS_TOKEN_ID.AVAX]: {
rewardTokenId: TESTNET_REWARDS_TOKEN_ID.AVAX,
spokeAddress: convertToGenericAddress(
"0x6aeB4b6f3d16E9bcDdC20c371458E0561F0638dB" as EvmAddress,
"0x0bB61Da4F8745e583DE90874FeB0De2837E15986" as EvmAddress,
ChainType.EVM,
),
token: {
Expand Down Expand Up @@ -748,9 +773,23 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
},
},
rewards: {
bridgeRouterAddress: convertToGenericAddress(
"0xDdcaDA3cE87f3f8931213112CD01a4A4572D4e75" as EvmAddress,
ChainType.EVM,
),
adapters: {
[AdapterType.WORMHOLE_DATA]: convertToGenericAddress(
"0x399A4E09CF13957c9cA6c22162ae58cd5a79cdE1" as EvmAddress,
ChainType.EVM,
),
[AdapterType.CCIP_DATA]: convertToGenericAddress(
"0x5863280149769578be34e9c42E7a8Af56dBbADB9" as EvmAddress,
ChainType.EVM,
),
},
[REWARDS_TYPE.V2]: {
spokeRewardsCommonAddress: convertToGenericAddress(
"0xA1FeE444c6a77C2D5d81dE09631e1D26c70ee465" as EvmAddress,
"0x2c9aa9B8B720f067920bea5c486B3653D713fEd3" as EvmAddress,
ChainType.EVM,
),
tokens: {},
Expand Down Expand Up @@ -828,13 +867,30 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
},
},
rewards: {
bridgeRouterAddress: convertToGenericAddress(
"0x5bA921BC78218305de1D021DE1d0F80a5730e5A9" as EvmAddress,
ChainType.EVM,
),
adapters: {
[AdapterType.WORMHOLE_DATA]: convertToGenericAddress(
"0x6C31cF2D9D6596A1bd3E0ea45c6886f155F7a191" as EvmAddress,
ChainType.EVM,
),
[AdapterType.CCIP_DATA]: convertToGenericAddress(
"0x46821415b965a3e47721312294A084097e81EB5f" as EvmAddress,
ChainType.EVM,
),
},
[REWARDS_TYPE.V2]: {
spokeRewardsCommonAddress: convertToGenericAddress("0x" as EvmAddress, ChainType.EVM),
spokeRewardsCommonAddress: convertToGenericAddress(
"0x1562649E83838CC3EA2F4742cB32A49BCE8E8086" as EvmAddress,
ChainType.EVM,
),
tokens: {
[TESTNET_REWARDS_TOKEN_ID.USDC_base_sep]: {
rewardTokenId: TESTNET_REWARDS_TOKEN_ID.USDC_base_sep,
spokeAddress: convertToGenericAddress(
"0x7eF21BaBB8e0b30B89e3159955c7136549B2813B" as EvmAddress,
"0x0857b8B30B420Eb843c519370cA1AF5FC101a114" as EvmAddress,
ChainType.EVM,
),
token: {
Expand Down Expand Up @@ -903,9 +959,23 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
},
},
rewards: {
bridgeRouterAddress: convertToGenericAddress(
"0x1D459CfA522472c47c6171B96561cE93B327d2F2" as EvmAddress,
ChainType.EVM,
),
adapters: {
[AdapterType.WORMHOLE_DATA]: convertToGenericAddress(
"0x054DD1f0697aDC2E092b712F05829Ebdbc9bbdcb" as EvmAddress,
ChainType.EVM,
),
[AdapterType.CCIP_DATA]: convertToGenericAddress(
"0xfB29aa4e30908Babb022cc397444b9d5bBa06bAd" as EvmAddress,
ChainType.EVM,
),
},
[REWARDS_TYPE.V2]: {
spokeRewardsCommonAddress: convertToGenericAddress(
"0xE2306f63993B71Fb670a3796e31c164d6Ced1695" as EvmAddress,
"0x2c92177c2a8B2dFcA61B804C970CBD311090293e" as EvmAddress,
ChainType.EVM,
),
tokens: {},
Expand Down Expand Up @@ -983,9 +1053,23 @@ export const SPOKE_CHAIN: Record<NetworkType, Partial<Record<FolksChainId, Spoke
},
},
rewards: {
bridgeRouterAddress: convertToGenericAddress(
"0xa56798Dd11460401dECFBfc95A6Ae812f61Adcb4" as EvmAddress,
ChainType.EVM,
),
adapters: {
[AdapterType.WORMHOLE_DATA]: convertToGenericAddress(
"0x1780FA2d5695d0BD3DDbc789682a0392e9FE9666" as EvmAddress,
ChainType.EVM,
),
[AdapterType.CCIP_DATA]: convertToGenericAddress(
"0x35C90ECa2Ac6dc34526370A799415902e3961467" as EvmAddress,
ChainType.EVM,
),
},
[REWARDS_TYPE.V2]: {
spokeRewardsCommonAddress: convertToGenericAddress(
"0x4B17D9f2365DC22a1809132b155f9Ff90C93dA5d" as EvmAddress,
"0x8dD1AD0Febe4768c673d9488D01E356E93366656" as EvmAddress,
ChainType.EVM,
),
tokens: {},
Expand Down
4 changes: 2 additions & 2 deletions src/common/constants/reward.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ export const MAINNET_REWARDS_TOKEN_ID = {
} as const;

export const TESTNET_REWARDS_TOKEN_ID = {
AVAX: 1,
USDC_base_sep: 2,
AVAX: 128,
USDC_base_sep: 129,
} as const;

export const REWARDS_TYPE = {
Expand Down
2 changes: 2 additions & 0 deletions src/common/types/chain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export type SpokeRewardsV2 = {
};

export type SpokeRewardsMap = {
bridgeRouterAddress: GenericAddress;
adapters: Partial<Record<AdapterType, GenericAddress>>;
[REWARDS_TYPE.V1]?: undefined;
[REWARDS_TYPE.V2]?: SpokeRewardsV2;
};
Expand Down
Loading