feat: Script for interacting with SpokePools #854

pxrl · 2023-08-07T12:32:34Z

This is useful for various SpokePool-related activities:

Make a deposit
Retrieve information about deposit(s) and/or fill(s) from a transaction.
Dump basic SpokePool configuration information.

This is especially handy with the new zkSync SpokePool, because zkSync's block explorer doesn't yet support making transactions via proxy contracts, and doesn't decode Across SpokePool events properly either.

Example:

# Deposit .001 WETH on Ethereum Görli, destined for zkSync era Görli. 
$ yarn ts-node ./scripts/spokepool.ts deposit --wallet mnemonic --from 5 --to 280 --token weth --amount 0.001

This is useful for making deposits to the zkSync SpokePool(s) because zkSync's block explorer doesn't yet support making transactions via proxy contracts.

pxrl · 2023-08-07T12:35:37Z

Example output:

Submitting deposit on chain ID 5
        originChainId       : 5
        destinationChainId  : 280
        depositor           : 0x9A8f92a830A5cB89a3816e3D267CB7791c16b04D
        recipient           : 0x9A8f92a830A5cB89a3816e3D267CB7791c16b04D
        relayerFeePct       : 0
        quoteTimestamp      : 1691411700

Submitted deposit:
        depositId           : 100019
        transactionHash     : 0x1fa909fea87e41c865555559719ff25a5e6c3cd4e1af61da7d4ed02c6f3f3322

Done in 25.11s.

james-a-morris

Left a few nits

scripts/spokepool.ts

nicholaspai

High level comment: can we make this script's name more clear (or do you intend to add other helper SpokePool related functions in here?) or add a helpful comment at the top explaining why this would be used?

pxrl · 2023-08-07T16:36:43Z

High level comment: can we make this script's name more clear (or do you intend to add other helper SpokePool related functions in here?) or add a helpful comment at the top explaining why this would be used?

Generally yes - I'd like to support something like the following:

spokepool.ts deposit <deposit-args>
spokepool.ts fill --origin <chainId> --hash <depositHash>
spokepool.ts request-refund <refund-args>

I left a placeholder in the code for adding fill support, but I didn't want to spend any time on actually implementing it now given other priorities: https://github.com/across-protocol/relayer-v2/blob/4b1bb8a633f87a6f34ee2602cf217d3a80a29c45/scripts/spokepool.ts#L165

As general background, it's occurred to me that I miss a good set of cmdline utilities for interacting with our contracts, since it should be possible to execute (or query) standard operations against them without a block explorer (a la zkSync at the moment), and without having to modify code or .env configs.

nicholaspai · 2023-08-07T19:49:49Z

High level comment: can we make this script's name more clear (or do you intend to add other helper SpokePool related functions in here?) or add a helpful comment at the top explaining why this would be used?

Generally yes - I'd like to support something like the following:

spokepool.ts deposit <deposit-args> spokepool.ts fill --origin <chainId> --hash <depositHash> spokepool.ts request-refund <refund-args>

I left a placeholder in the code for adding fill support, but I didn't want to spend any time on actually implementing it now given other priorities:

https://github.com/across-protocol/relayer-v2/blob/4b1bb8a633f87a6f34ee2602cf217d3a80a29c45/scripts/spokepool.ts#L165

As general background, it's occurred to me that I miss a good set of cmdline utilities for interacting with our contracts, since it should be possible to execute (or query) standard operations against them without a block explorer (a la zkSync at the moment), and without having to modify code or .env configs.

This would be a good interface yes

james-a-morris

Two more comments

scripts/spokepool.ts

Not all tokens are defined on all chains, so don't try to drop case unless the token actually exists on a chain.

Currently limitations: - Does not display updated values (i.e. after a speed-up). - Does not display message data. - Should normalise from the token decimals for better readability. - Does not gracefully handle when the txnHash is not found.

src/utils/AddressUtils.ts

Have made some tweaks to the proposals, but the main point is that the script now accepts native decimals.

Much nicer to use after recent changes by James.

mrice32

Great place to start! Always todos and things to add/change, but this is great!

mrice32 · 2023-08-31T03:20:59Z

scripts/spokepool.ts

+const padLeft = 20;
+const padRight = 25;
+
+function formatAddress(address: string, maxWidth = 18): string {


Why not just display full addresses?

Maybe this is just my OCD, but it looks really awkward to have a long address alongside a bunch of significantly shorter values. Some of the values look best right-justified (especially fields with a numerical relationship to each other - i.e. relayerFeePct and amount). Making these right-justified alongside the address means that the values end up very far away from the keys/field names, and that can make it difficult to visually connect them.

I was thinking about adding a -v flag to allow the caller to force the address to be displayed in full.

I ended up scrapping the custom formatting and reverted to "raw" dumping of the event. This removes some of the (imo) nice features like grouping related fields, which the SpokePool event data doesn't always do. However, it's very simple and generic, and ensures that all the fields are dumped. Maybe in future I'll introduce a way of ordering the fields, but that's not worth prioritising now.

caccd7b

mrice32 · 2023-08-31T03:28:33Z

scripts/spokepool.ts

+  const depositor = await signer.getAddress();
+  const fromChainId = Number(args.from);
+  const toChainId = Number(args.to);
+  const recipient = args.recipient ?? depositor;
+  const baseAmount = Number(args.amount);


Should we validate args here and throw if they aren't provided as expected?

Implemented: ea24ac1

scripts/spokepool.ts

This addresses a few nits in the code, but also makes it simpler.

pxrl requested review from mrice32, nicholaspai and james-a-morris as code owners August 7, 2023 12:32

feat: Script for automating SpokePool deposits

4b1bb8a

This is useful for making deposits to the zkSync SpokePool(s) because zkSync's block explorer doesn't yet support making transactions via proxy contracts.

pxrl force-pushed the pxrl/depositScript branch from 692477b to 4b1bb8a Compare August 7, 2023 12:33

james-a-morris reviewed Aug 7, 2023

View reviewed changes

scripts/spokepool.ts Outdated Show resolved Hide resolved

scripts/spokepool.ts Show resolved Hide resolved

scripts/spokepool.ts Show resolved Hide resolved

nicholaspai reviewed Aug 7, 2023

View reviewed changes

nicholaspai and others added 3 commits August 7, 2023 15:49

Merge branch 'master' into pxrl/depositScript

94485f3

Merge branch 'master' into pxrl/depositScript

4f51071

Add yarn script target + tweak usage

df18bf9

pxrl requested a review from james-a-morris August 7, 2023 20:40

nicholaspai and others added 5 commits August 7, 2023 18:06

Merge branch 'master' into pxrl/depositScript

fdd9ad4

Add basic support for dumping SpokePool config

b453813

Merge remote-tracking branch 'origin/master' into pxrl/depositScript

7f05ce7

Merge remote-tracking branch 'origin/master' into pxrl/depositScript

ac72c69

lint

b566bcd

james-a-morris reviewed Aug 16, 2023

View reviewed changes

scripts/spokepool.ts Show resolved Hide resolved

scripts/spokepool.ts Outdated Show resolved Hide resolved

pxrl added 2 commits August 16, 2023 16:07

fix: Gracefully handle token searches where token missing

bb4a867

Not all tokens are defined on all chains, so don't try to drop case unless the token actually exists on a chain.

pxrl changed the title ~~feat: Script for automating SpokePool deposits~~ feat: Script for interacting with SpokePools Aug 16, 2023

pxrl added 2 commits August 16, 2023 16:11

Merge branch 'master' into pxrl/depositScript

f50266c

lint

dbfc262

james-a-morris reviewed Aug 16, 2023

View reviewed changes

src/utils/AddressUtils.ts Show resolved Hide resolved

pxrl added 4 commits August 16, 2023 16:37

fix conflict

6be22a3

lint

9c16a31

Merge branch 'master' into pxrl/depositScript

bbfb153

Merge branch 'master' into pxrl/depositScript

b5dba90

nicholaspai and others added 7 commits August 22, 2023 10:03

Merge branch 'master' into pxrl/depositScript

e38356e

Merge branch 'master' into pxrl/depositScript

0a398f7

Merge branch 'master' into pxrl/depositScript

1554efb

Tweak padding

94378ed

improve: Incorporate James' feedback

731786d

Have made some tweaks to the proposals, but the main point is that the script now accepts native decimals.

Use getSigner()

8c1c29d

Much nicer to use after recent changes by James.

lint

6d7e5ad

mrice32 approved these changes Aug 31, 2023

View reviewed changes

pxrl added 4 commits September 4, 2023 16:13

improve: Add input validation

ea24ac1

improve: Overhaul print formatting

caccd7b

This addresses a few nits in the code, but also makes it simpler.

Merge branch 'master' into pxrl/depositScript

44badfc

lint + additional formatting improvements

081f860

pxrl merged commit 87a704c into master Sep 4, 2023
2 checks passed

pxrl deleted the pxrl/depositScript branch September 4, 2023 15:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Script for interacting with SpokePools #854

feat: Script for interacting with SpokePools #854

pxrl commented Aug 7, 2023 •

edited

Loading

pxrl commented Aug 7, 2023

james-a-morris left a comment

nicholaspai left a comment

pxrl commented Aug 7, 2023

nicholaspai commented Aug 7, 2023

james-a-morris left a comment

mrice32 left a comment

mrice32 Aug 31, 2023

pxrl Sep 4, 2023 •

edited

Loading

pxrl Sep 4, 2023

mrice32 Aug 31, 2023

pxrl Sep 4, 2023

feat: Script for interacting with SpokePools #854

feat: Script for interacting with SpokePools #854

Conversation

pxrl commented Aug 7, 2023 • edited Loading

pxrl commented Aug 7, 2023

james-a-morris left a comment

Choose a reason for hiding this comment

nicholaspai left a comment

Choose a reason for hiding this comment

pxrl commented Aug 7, 2023

nicholaspai commented Aug 7, 2023

james-a-morris left a comment

Choose a reason for hiding this comment

mrice32 left a comment

Choose a reason for hiding this comment

mrice32 Aug 31, 2023

Choose a reason for hiding this comment

pxrl Sep 4, 2023 • edited Loading

Choose a reason for hiding this comment

pxrl Sep 4, 2023

Choose a reason for hiding this comment

mrice32 Aug 31, 2023

Choose a reason for hiding this comment

pxrl Sep 4, 2023

Choose a reason for hiding this comment

pxrl commented Aug 7, 2023 •

edited

Loading

pxrl Sep 4, 2023 •

edited

Loading