Feat: Eth wallet contract implementation #10850

birchmd · 2024-03-21T13:26:56Z

This PR adds the eth wallet contract implementation which will be automatically deployed with eth implicit accounts. This is as per the design outlined in near/NEPs#518 .

It is intentional that the wallet contract implementation is isolated as its own crate and not contained in the broader nearcore workspace. This allows it to be reviewed, tested and audited independently from the rest of the Near code. The crate includes integration tests written using near-workspaces. However, the nearcore integration test related to the wallet contract has also been updated to check that the contract is automatically deployed when creating an eth address and that it works as expected.

This will not be the last PR in this project because I am only adding the logic for the implementation. It still remains to setup the reproducible build pipeline and update the tests which check the contract hashes. Additionally, there are still a few details which need to be finalized: (1) the Ethereum chain ID that will be associated with Near and (2) the Near account ID that will have the eth address registrar contract deployed. The eth address registrar contract stores a reverse lookup of Ethereum-like address to Near account IDs. It is necessary for the wallet contract to detect faulty relayers.

However this (relatively large) PR can be reviewed and merged, and the points above will be addressed in much more manageable follow-up PRs.

nagisa · 2024-03-21T13:39:25Z

Cargo.toml

@@ -121,6 +121,8 @@ arbitrary = { version = "1.2.3", features = ["derive"] }
 arc-swap = "1.5"
 assert_matches = "1.5.0"
 async-trait = "0.1.58"
+aurora-engine-transactions = { git = "https://github.com/aurora-is-near/aurora-engine.git", tag = "3.6.1" }


Is there a reason these are a git dependency?

We should avoid git dependencies where possible. The fact that this is referencing a tag suggests to me that these should be on crates.io.

Aurora doesn't have a regular process for releasing crates to crates.io. So for now a git dep is required to use the crate. But this is easy to update in the future if Aurora does start releasing crates.

I think it should really be a not "if Aurora starts", but rather "integrating with the rest of the ecosystem ought to be a very strong incentive for Aurora to start releasing crates."

We can't really audit git tags, they are not reproducible and might just make the build process slower every time as cargo can't cache git repositories globally.

Does it block this PR? Probably not. But waiting for Aurora to realize these problems on their own before an action is taken is also not great.

codecov · 2024-03-21T13:52:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.39%. Comparing base (b2c82f9) to head (37175d3).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #10850      +/-   ##
==========================================
+ Coverage   71.37%   71.39%   +0.02%     
==========================================
  Files         760      760              
  Lines      152772   152772              
  Branches   152772   152772              
==========================================
+ Hits       109039   109075      +36     
+ Misses      39207    39172      -35     
+ Partials     4526     4525       -1

Flag	Coverage Δ
backward-compatibility	`0.24% <ø> (ø)`
db-migration	`0.24% <ø> (ø)`
genesis-check	`1.43% <ø> (ø)`
integration-tests	`37.08% <ø> (+0.11%)`	⬆️
linux	`69.84% <ø> (+<0.01%)`	⬆️
linux-nightly	`70.86% <ø> (+0.02%)`	⬆️
macos	`54.41% <ø> (+<0.01%)`	⬆️
pytests	`1.65% <ø> (ø)`
sanity-checks	`1.44% <ø> (ø)`
unittests	`67.02% <ø> (+<0.01%)`	⬆️
upgradability	`0.29% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

staffik · 2024-03-25T14:28:23Z

I started reviewing this but it might take a while. I plan to send feedback tomorrow.

nagisa

Q for Adam: do we need to have the contract checked-in? Why aren't we building it on demand and e.g. verifying its reproducibility through “other” means?

For wallet tests lets see if we can (re-)use the infrastructure in near-test-contracts. At least that way all the relevant stuff stays in the same spot. Ideally these contracts would get built on the fly like test-contract-rs is, but its not a too big of a deal if doing so is really difficult.

I don't feel qualified to review the contract itself, and I don't think I have the capacity at the moment to become able. It looks like Adam is already on the hook for that anyhow, but please definitely talk with N1 EMs to prioritize it accordingly if that's not the case.

nagisa · 2024-03-26T09:44:11Z

Cargo.lock

@@ -805,6 +897,16 @@ dependencies = [
 "hashbrown 0.11.2",
 ]

+[[package]]
+name = "borsh"
+version = "0.10.3"


Please investigate upgrading this dependency.

This has been done on the Aurora side. But it hasn't been released as a tag yet on GitHub. This will be resolved when we next upgrade the Aurora dependency.

nagisa · 2024-03-26T09:48:34Z

Cargo.lock

@@ -6526,6 +7068,19 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ae1a47186c03a32177042e55dbc5fd5aee900b8e0069a8d70fba96a9375cd012"

+[[package]]
+name = "sha2"
+version = "0.9.9"


Hmph. I know we don't do a best job of keeping nearcore's dependencies up-to-date ourselves, but this was one merge button away…

bowenwang1996 · 2024-04-01T23:17:58Z

@staffik any updates on the review?

staffik

Great work, looks impressive!
Apologies for delay, we are absorbed in statelessnet issues.
I did not check test code yet and will look into the issue of checking-in the contract.
I am not qualified to review the contract too, but I heard there will be a proper audit later.

runtime/near-wallet-contract/implementation/address-registrar/src/lib.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/eth_emulation.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/internal.rs

integration-tests/src/tests/client/features/wallet_contract.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/internal.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/near_action.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/lib.rs

birchmd · 2024-04-03T15:14:02Z

Thanks for the review @staffik ! I think I have addressed all your comments now.

the issue of checking-in the contract

I started working on this here. I was planning on pushing the commit in another PR after this one is merged.

staffik · 2024-04-03T17:16:07Z

Thanks for the review @staffik ! I think I have addressed all your comments now.

the issue of checking-in the contract

I started working on this here. I was planning on pushing the commit in another PR after this one is merged.

There are 3 comments left and I will quickly look at test-related code now.

staffik · 2024-04-03T22:16:35Z

Thanks for the review @staffik ! I think I have addressed all your comments now.

the issue of checking-in the contract

I started working on this here. I was planning on pushing the commit in another PR after this one is merged.

There are 3 comments left and I will quickly look at test-related code now.

Sorry, I underestimated, will finish tomorrow morning.
We will need an approval from near code owner to be able to merge.

staffik

Second part of review.

runtime/near-wallet-contract/implementation/wallet-contract/src/tests/emulation.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/tests/relayer.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/tests/caller_error.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/tests/user_error.rs

runtime/near-wallet-contract/implementation/wallet-contract/src/tests/utils/test_context.rs

staffik

LGTM, amazing work!

akhi3030

approving to unblock.

birchmd added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-core Team: issues relevant to the core team T-Aurora Team: issues relevant to the Aurora team rust Pull requests that update Rust code labels Mar 21, 2024

birchmd requested review from nagisa, bowenwang1996 and staffik March 21, 2024 13:26

birchmd requested a review from a team as a code owner March 21, 2024 13:26

nagisa reviewed Mar 21, 2024

View reviewed changes

birchmd added 2 commits March 25, 2024 13:48

feat: eth wallet contract implementation

1079258

Integration test for wallet contract on eth implicit accounts

abfc04b

birchmd force-pushed the eth-wallet-contract branch from c37b4d6 to abfc04b Compare March 25, 2024 12:49

nagisa reviewed Mar 26, 2024

View reviewed changes

staffik reviewed Apr 2, 2024

View reviewed changes

birchmd added 5 commits April 3, 2024 15:02

Merge branch 'master' into eth-wallet-contract

8ae8cb7

cargo fmt

54992b1

Add doc comments to public contract methods

447feef

Remove unused Near actions

9bb90c0

Rename hash_to_address -> account_id_to_address; add test

7ed4741

birchmd added 2 commits April 3, 2024 19:44

Add comment about account suffix

ee16f2b

Update TODO comments

fc96b2e

staffik reviewed Apr 4, 2024

View reviewed changes

staffik approved these changes Apr 4, 2024

View reviewed changes

Remove usage of git in tests

b900f78

birchmd added 3 commits April 4, 2024 17:48

Fix typo

24bd574

Merge branch 'master' into eth-wallet-contract

3eacedc

Merge branch 'master' into eth-wallet-contract

fd8e664

akhi3030 approved these changes Apr 8, 2024

View reviewed changes

Merge branch 'master' into eth-wallet-contract

37175d3

birchmd enabled auto-merge April 8, 2024 13:55

birchmd added this pull request to the merge queue Apr 8, 2024

Merged via the queue into near:master with commit ce68b7c Apr 8, 2024
29 checks passed

birchmd deleted the eth-wallet-contract branch April 8, 2024 14:38

rasfies mentioned this pull request Apr 15, 2024

[TASK] Wallet Contract NEAR-DevHub/Infra-Committee#53

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Eth wallet contract implementation #10850

Feat: Eth wallet contract implementation #10850

birchmd commented Mar 21, 2024

nagisa Mar 21, 2024

birchmd Mar 21, 2024

nagisa Mar 26, 2024 •

edited

Loading

codecov bot commented Mar 21, 2024 •

edited

Loading

staffik commented Mar 25, 2024

nagisa left a comment

nagisa Mar 26, 2024

birchmd Mar 26, 2024

nagisa Mar 26, 2024

bowenwang1996 commented Apr 1, 2024

staffik left a comment •

edited

Loading

birchmd commented Apr 3, 2024

staffik commented Apr 3, 2024 •

edited

Loading

staffik commented Apr 3, 2024

staffik left a comment

staffik left a comment

akhi3030 left a comment

Feat: Eth wallet contract implementation #10850

Feat: Eth wallet contract implementation #10850

Conversation

birchmd commented Mar 21, 2024

nagisa Mar 21, 2024

Choose a reason for hiding this comment

birchmd Mar 21, 2024

Choose a reason for hiding this comment

nagisa Mar 26, 2024 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Mar 21, 2024 • edited Loading

Codecov Report

staffik commented Mar 25, 2024

nagisa left a comment

Choose a reason for hiding this comment

nagisa Mar 26, 2024

Choose a reason for hiding this comment

birchmd Mar 26, 2024

Choose a reason for hiding this comment

nagisa Mar 26, 2024

Choose a reason for hiding this comment

bowenwang1996 commented Apr 1, 2024

staffik left a comment • edited Loading

Choose a reason for hiding this comment

birchmd commented Apr 3, 2024

staffik commented Apr 3, 2024 • edited Loading

staffik commented Apr 3, 2024

staffik left a comment

Choose a reason for hiding this comment

staffik left a comment

Choose a reason for hiding this comment

akhi3030 left a comment

Choose a reason for hiding this comment

nagisa Mar 26, 2024 •

edited

Loading

codecov bot commented Mar 21, 2024 •

edited

Loading

staffik left a comment •

edited

Loading

staffik commented Apr 3, 2024 •

edited

Loading