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.

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

feat: implement deposit v3 events #337

Closed
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
13 changes: 11 additions & 2 deletions src/modules/configuration/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export const configValues = () => ({
324: process.env.WEB3_NODE_URL_324,
8453: process.env.WEB3_NODE_URL_8453,
84531: process.env.WEB3_NODE_URL_84531,
84532: process.env.WEB3_NODE_URL_84532,
11155420: process.env.WEB3_NODE_URL_11155420,
11155111: process.env.WEB3_NODE_URL_11155111,
},
Expand Down Expand Up @@ -179,10 +180,18 @@ export const configValues = () => ({
acrossVersion: AcrossContractsVersion.V2_5,
},
],
[ChainIds.baseSepolia]: [
{
address: "0x82B564983aE7274c86695917BBf8C99ECb6F0F8F",
startBlockNumber: 6082004,
abi: JSON.stringify(SpokePoolV3Abi),
acrossVersion: AcrossContractsVersion.V3,
},
],
[ChainIds.sepolia]: [
{
address: "0x622d59F3dbD28fcFE746E0d2f83ebdC286E89A3c",
startBlockNumber: 5146129,
address: "0x5ef6C01E11889d86803e0B23e3cB3F9E9d97B662",
startBlockNumber: 5288470,
abi: JSON.stringify(SpokePoolV3Abi),
acrossVersion: AcrossContractsVersion.V3,
},
Expand Down
6 changes: 3 additions & 3 deletions src/modules/deposit/model/deposit.entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -208,13 +208,13 @@ export class Deposit {
acxUsdPrice?: string;

@Column({ nullable: true })
fillDeadline: Date;
fillDeadline?: Date;

@Column({ nullable: true })
exclusivityDeadline: Date;
exclusivityDeadline?: Date;

@Column({ nullable: true })
relayer: string;
relayer?: string;

@CreateDateColumn()
createdAt: Date;
Expand Down
6 changes: 4 additions & 2 deletions src/modules/scraper/adapter/messaging/BlocksEventsConsumer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@

for (const event of events) {
const { address } = event;
const { acrossVersion } = this.appConfig.values.web3.spokePoolContracts[chainId].filter(

Check warning on line 233 in src/modules/scraper/adapter/messaging/BlocksEventsConsumer.ts

View workflow job for this annotation

GitHub Actions / lint-build

'acrossVersion' is assigned a value but never used

Check warning on line 233 in src/modules/scraper/adapter/messaging/BlocksEventsConsumer.ts

View workflow job for this annotation

GitHub Actions / lint-build

'acrossVersion' is assigned a value but never used
(contract) => contract.address === address,
)[0];

Expand Down Expand Up @@ -392,6 +392,9 @@

const wei = BigNumber.from(10).pow(18);
const feePct = outputAmount.mul(wei).div(inputAmount);
let exclusivityDeadlineDate = undefined;

if (exclusivityDeadline > 0) exclusivityDeadlineDate = new Date(exclusivityDeadline * 1000);

return this.depositRepository.create({
depositId,
Expand All @@ -407,14 +410,13 @@
depositorAddr: depositor,
recipientAddr: recipient,
depositRelayerFeePct: feePct.toString(),
// what happens with relayer fee?
initialRelayerFeePct: feePct.toString(),
//relayerFeePct = realizedLpFeePct + (gasFeePct + capitalCostFeePct)(old usage of relayerFeePct)
// v3 properties
outputAmount: outputAmount.toString(),
outputTokenAddress: outputToken,
fillDeadline: new Date(fillDeadline * 1000),
exclusivityDeadline: new Date(exclusivityDeadline * 1000),
exclusivityDeadline: exclusivityDeadlineDate,
relayer,
});
}
Expand Down
17 changes: 10 additions & 7 deletions src/modules/scraper/adapter/messaging/FeeBreakdownConsumer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { GasFeesService } from "../gas-fees/gas-fees-service";
import { ScraperQueuesService } from "../../service/ScraperQueuesService";
import { FeeBreakdownQueueMessage, OpRebateRewardMessage, ScraperQueue } from ".";
import { Deposit, DepositFillTx, DepositFillTx2, DepositFillTxV3 } from "../../../deposit/model/deposit.entity";
import { deriveRelayerFeeComponents, makePctValuesCalculator, toWeiPct } from "../../utils";
import { deriveRelayerFeeComponents, fixedPointAdjustment, makePctValuesCalculator, toWeiPct } from "../../utils";
import { AcrossContractsVersion } from "../../../web3/model/across-version";

@Processor(ScraperQueue.FeeBreakdown)
Expand Down Expand Up @@ -74,17 +74,20 @@ export class FeeBreakdownConsumer {

const { feeUsd, fee } = await this.gasFeesService.getFillTxNetworkFee(deposit.destinationChainId, fillTx.hash);
const relayGasFeeUsd = feeUsd;
const relayGasFeeAmount = fee;
const relayGasFeeAmount = fixedPointAdjustment.multipliedBy(fee).toFixed(0);

// Bridge fee computation
const wei = new BigNumber(10).pow(18);
const outputWeiPct = toWeiPct(new BigNumber(fillTx.updatedOutputAmount).dividedBy(deposit.amount).toString());
const bridgeFeePct = wei.minus(outputWeiPct);
const inputAmountUsd = new BigNumber(deposit.amount).multipliedBy(deposit.price.usd);
const outputAmountUsd = new BigNumber(deposit.outputAmount).multipliedBy(deposit.outputTokenPrice.usd);
const inputAmountUsd = new BigNumber(deposit.amount)
.multipliedBy(deposit.price.usd)
.dividedBy(new BigNumber(10).pow(deposit.token.decimals));
const outputAmountUsd = new BigNumber(deposit.outputAmount)
.multipliedBy(deposit.outputTokenPrice.usd)
.dividedBy(new BigNumber(10).pow(deposit.outputToken.decimals));
const bridgeFeeUsd = inputAmountUsd.minus(outputAmountUsd);
const bridgeFeeAmount = bridgeFeeUsd.dividedBy(deposit.price.usd);
const relayGasFeePct = new BigNumber(relayGasFeeAmount).dividedBy(deposit.amount);
const bridgeFeeAmount = bridgeFeeUsd.multipliedBy(fixedPointAdjustment).dividedBy(deposit.price.usd);
const feeBreakdown = {
lpFeeUsd: undefined,
lpFeePct: undefined,
Expand All @@ -93,7 +96,7 @@ export class FeeBreakdownConsumer {
relayCapitalFeePct: undefined,
relayCapitalFeeAmount: undefined,
relayGasFeeUsd,
relayGasFeePct: relayGasFeePct.toString(),
relayGasFeePct: undefined,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, why did we have to remove this?

const relayGasFeePct = new BigNumber(relayGasFeeAmount).dividedBy(deposit.amount);

doesn't work?

relayGasFeeAmount,
totalBridgeFeeUsd: bridgeFeeUsd.toString(),
totalBridgeFeePct: bridgeFeePct.toString(),
Expand Down
30 changes: 23 additions & 7 deletions src/modules/scraper/adapter/messaging/TokenDetailsConsumer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@ import { Logger } from "@nestjs/common";
import { Job } from "bull";
import { InjectRepository } from "@nestjs/typeorm";
import { Repository } from "typeorm";
import { ethers } from "ethers";

import { ScraperQueue, TokenDetailsQueueMessage, TokenPriceQueueMessage } from ".";
import { Deposit } from "../../../deposit/model/deposit.entity";
import { EthProvidersService } from "../../../web3/services/EthProvidersService";
import { ScraperQueuesService } from "../../service/ScraperQueuesService";
import { Token } from "../../../web3/model/token.entity";
import { ChainIds } from "../../../web3/model/ChainId";

@Processor(ScraperQueue.TokenDetails)
export class TokenDetailsConsumer {
private logger = new Logger(TokenDetailsConsumer.name);

constructor(
@InjectRepository(Deposit) private depositRepository: Repository<Deposit>,
@InjectRepository(Token) private tokenRepository: Repository<Token>,
private ethProvidersService: EthProvidersService,
private scraperQueuesService: ScraperQueuesService,
) {}
Expand All @@ -25,21 +28,34 @@ export class TokenDetailsConsumer {
const { depositId } = job.data;
const deposit = await this.depositRepository.findOne({ where: { id: depositId } });
if (!deposit) return;
const { sourceChainId, tokenAddr, destinationChainId, outputTokenAddress } = deposit;
const { sourceChainId, tokenAddr, destinationChainId } = deposit;
const inputToken = await this.ethProvidersService.getCachedToken(sourceChainId, tokenAddr);

if (!inputToken) throw new Error(`Input token not found for deposit ${depositId}`);

let outputToken: Token | undefined = undefined;

if (outputTokenAddress === "0x0000000000000000000000000000000000000000") return;
if (outputTokenAddress) {
outputToken = await this.ethProvidersService.getCachedToken(destinationChainId, outputTokenAddress);
if (deposit.outputTokenAddress) {
if (deposit.outputTokenAddress === ethers.constants.AddressZero) {
const outputTokenSymbol =
destinationChainId === ChainIds.base && inputToken.symbol === "USDC" ? "USDbC" : inputToken.symbol;
outputToken = await this.tokenRepository.findOne({
where: { chainId: destinationChainId, symbol: outputTokenSymbol },
});
} else {
outputToken = await this.ethProvidersService.getCachedToken(destinationChainId, deposit.outputTokenAddress);
}
}

if (!inputToken) throw new Error(`Input token not found for deposit ${depositId}`);
if (outputTokenAddress && !outputToken) throw new Error(`Output token not found for deposit ${depositId}`);
if (deposit.outputTokenAddress && !outputToken) throw new Error(`Output token not found for deposit ${depositId}`);

await this.depositRepository.update(
{ id: deposit.id },
{ tokenId: inputToken.id, outputTokenId: outputToken ? outputToken.id : null },
{
tokenId: inputToken.id,
outputTokenId: outputToken ? outputToken.id : null,
outputTokenAddress: outputToken ? outputToken.address : deposit.outputTokenAddress,
},
);
await this.scraperQueuesService.publishMessage<TokenPriceQueueMessage>(ScraperQueue.TokenPrice, {
depositId,
Expand Down
2 changes: 2 additions & 0 deletions src/modules/scraper/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ import { QueueJobCount } from "../monitoring/model/QueueJobCount.entity";
import { MerkleDistributorClaim } from "../airdrop/model/merkle-distributor-claim.entity";
import { MerkleDistributorWindow } from "../airdrop/model/merkle-distributor-window.entity";
import { SpeedUpEventsV3Consumer } from "./adapter/messaging/SpeedUpEventsV3Consumer";
import { Token } from "../web3/model/token.entity";

@Module({})
export class ScraperModule {
Expand Down Expand Up @@ -101,6 +102,7 @@ export class ScraperModule {
QueueJobCount,
MerkleDistributorClaim,
MerkleDistributorWindow,
Token,
]),
MarketPriceModule.forRoot(moduleOptions),
HttpModule,
Expand Down
1 change: 1 addition & 0 deletions src/modules/web3/model/ChainId.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export const ChainIds = {
zkSyncTestnet: 280,
base: 8453,
baseGoerli: 84531,
baseSepolia: 84532,
};

export const ChainIdToName = Object.entries(ChainIds).reduce((idToName, entry) => {
Expand Down
5 changes: 5 additions & 0 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ export const chainIdToInfo = {
chainId: ChainIds.base,
nativeSymbol: "eth",
},
[ChainIds.baseSepolia]: {
name: "Base Sepolia",
chainId: ChainIds.baseSepolia,
nativeSymbol: "eth",
},
[ChainIds.zkSyncMainnet]: {
name: "zkSync",
chainId: ChainIds.zkSyncMainnet,
Expand Down
Loading