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

feat: search for deposit id by chain #1122

Merged
merged 3 commits into from
Dec 22, 2023
Merged

feat: search for deposit id by chain #1122

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a041d3b
feat: search for deposit id by chain
james-a-morris Dec 16, 2023
155e134
Merge branch 'master' into pxrl/findDeposit
pxrl Dec 22, 2023
e205d01
Document findDeposit constraint
pxrl Dec 22, 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
68 changes: 53 additions & 15 deletions scripts/spokepool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,20 @@ import { Contract, ethers, Signer } from "ethers";
import { LogDescription } from "@ethersproject/abi";
import { constants as sdkConsts, utils as sdkUtils } from "@across-protocol/sdk-v2";
import { ExpandedERC20__factory as ERC20 } from "@across-protocol/contracts-v2";
import { BigNumber, formatFeePct, getNetworkName, getSigner, isDefined, resolveTokenSymbols, toBN } from "../src/utils";
import {
BigNumber,
formatFeePct,
getDeploymentBlockNumber,
getNetworkName,
getSigner,
isDefined,
resolveTokenSymbols,
toBN,
} from "../src/utils";
import * as utils from "./utils";

type Log = ethers.providers.Log;

type relayerFeeQuery = {
originChainId: number;
destinationChainId: number;
Expand Down Expand Up @@ -215,23 +226,26 @@ async function dumpConfig(args: Record<string, number | string>, _signer: Signer
return true;
}

// eslint-disable-next-line @typescript-eslint/no-unused-vars
async function fetchTxn(args: Record<string, number | string>, _signer: Signer): Promise<boolean> {
const { txnHash } = args;
const chainId = Number(args.chainId);

if (!utils.validateChainIds([chainId])) {
usage(); // no return
async function _fetchDeposit(spokePool: Contract, _depositId: number | string): Promise<Log[]> {
const depositId = parseInt(_depositId.toString());
if (isNaN(depositId)) {
throw new Error("No depositId specified");
}

const { chainId } = await spokePool.provider.getNetwork();
const deploymentBlockNumber = getDeploymentBlockNumber("SpokePool", chainId);
const latestBlockNumber = await spokePool.provider.getBlockNumber();
console.log(`Searching for depositId ${depositId} between ${deploymentBlockNumber} and ${latestBlockNumber}.`);
const filter = spokePool.filters.FundsDeposited(null, null, null, null, depositId);
return await spokePool.queryFilter(filter, deploymentBlockNumber, latestBlockNumber);
pxrl marked this conversation as resolved.
Show resolved Hide resolved
}

async function _fetchTxn(spokePool: Contract, txnHash: string): Promise<{ deposits: Log[]; fills: Log[] }> {
if (txnHash === undefined || typeof txnHash !== "string" || txnHash.length != 66 || !txnHash.startsWith("0x")) {
throw new Error(`Missing or malformed transaction hash: ${txnHash}`);
}

const provider = new ethers.providers.StaticJsonRpcProvider(utils.getProviderUrl(chainId));
const spokePool = await utils.getSpokePoolContract(chainId);

const txn = await provider.getTransactionReceipt(txnHash);
const txn = await spokePool.provider.getTransactionReceipt(txnHash);
const fundsDeposited = spokePool.interface.getEventTopic("FundsDeposited");
const filledRelay = spokePool.interface.getEventTopic("FilledRelay");
const logs = txn.logs.filter(({ address }) => address === spokePool.address);
Expand All @@ -244,6 +258,29 @@ async function fetchTxn(args: Record<string, number | string>, _signer: Signer):
}
});

return { deposits, fills };
}

// eslint-disable-next-line @typescript-eslint/no-unused-vars
async function fetchTxn(args: Record<string, number | string>, _signer: Signer): Promise<boolean> {
const { txnHash } = args;
const chainId = Number(args.chainId);

if (!utils.validateChainIds([chainId])) {
usage(); // no return
pxrl marked this conversation as resolved.
Show resolved Hide resolved
}

const provider = new ethers.providers.StaticJsonRpcProvider(utils.getProviderUrl(chainId));
const spokePool = (await utils.getSpokePoolContract(chainId)).connect(provider);

let deposits: Log[] = [];
let fills: Log[] = [];
if (args.depositId) {
deposits = await _fetchDeposit(spokePool, args.depositId);
} else if (txnHash) {
({ deposits, fills } = await _fetchTxn(spokePool, txnHash as string));
}

deposits.forEach((deposit) => {
printDeposit(spokePool.interface.parseLog(deposit));
});
Expand All @@ -262,7 +299,7 @@ function usage(badInput?: string): boolean {
"--from <originChainId> --to <destinationChainId>" +
" --token <tokenSymbol> --amount <amount> [--recipient <recipient>] [--decimals]";
const dumpConfigArgs = "--chainId";
const fetchArgs = "--chainId <chainId> --txnHash <txnHash>";
const fetchArgs = "--chainId <chainId> [--depositId <depositId> | --txnHash <txnHash>]";
const fillArgs = "--from <originChainId> --hash <depositHash>";

const pad = "deposit".length;
Expand All @@ -283,10 +320,11 @@ function usage(badInput?: string): boolean {
async function run(argv: string[]): Promise<boolean> {
const configOpts = ["chainId"];
const depositOpts = ["from", "to", "token", "amount", "recipient", "relayerFeePct", "message"];
const fetchOpts = ["chainId", "transactionHash"];
const fetchOpts = ["chainId", "transactionHash", "depositId"];
const fillOpts = [];
const fetchDepositOpts = ["chainId", "depositId"];
const opts = {
string: ["wallet", ...configOpts, ...depositOpts, ...fetchOpts, ...fillOpts],
string: ["wallet", ...configOpts, ...depositOpts, ...fetchOpts, ...fillOpts, ...fetchDepositOpts],
boolean: ["decimals"], // @dev tbd whether this is good UX or not...may need to change.
default: {
wallet: "mnemonic",
Expand Down