Support Native ETH in v1 #1354

alistair-singh · 2024-12-12T08:46:45Z

Changes

Use the 0x0000000000000000000000000000000000000000 token address as Native ETH.
When sendToken is called with the 0x00.. an amount of msg.value is locked in asset hub agent.
To avoid clashing with fees/rewards and locked funds, fees/rewards are collected and dispensed from the Gateway Proxy account.
The existing funds in the agents will be migrated on upgrade.
Scripts which mentions FundAgent are now called FundGateway

Related polkadot-sdk: paritytech/polkadot-sdk#6855

TODO

Fix tests
Add tests for the Eth asserting msg.value.
Migrate agent funds to gateway proxy on upgrade

Resolves: https://linear.app/snowfork/issue/SNO-1222

codecov · 2024-12-17T23:00:48Z

Codecov Report

Attention: Patch coverage is 87.80488% with 5 lines in your changes missing coverage. Please review.

Project coverage is 76.58%. Comparing base (24b9d31) to head (bb130a4).
Report is 158 commits behind head on main.

Files with missing lines	Patch %	Lines
contracts/src/Assets.sol	84.21%	3 Missing ⚠️
contracts/src/upgrades/Gateway202410.sol	77.77%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1354      +/-   ##
==========================================
- Coverage   77.83%   76.58%   -1.25%     
==========================================
  Files          14       17       +3     
  Lines         415      739     +324     
  Branches       76      110      +34     
==========================================
+ Hits          323      566     +243     
- Misses         75      162      +87     
+ Partials       17       11       -6

Flag	Coverage Δ
solidity	`76.58% <87.80%> (-1.25%)`	⬇️

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.

contracts/src/Gateway.sol

contracts/src/Types.sol

contracts/src/GatewayProxy.sol

alistair-singh · 2024-12-18T22:31:09Z

@vgeddes we have a Command called TransferNativeFromAgent which is a management-style command, issuable from bridgehub only, that can empty an agent account of ETH. We would need to add a similar command TransferNativeFromGateway to do the same thing for the Gateway. We should also maybe disable TransferNativeFromAgent so that there is no way to remove ETH from an agent other than an Unlock command.

yrong

+1

Changes: 1. Use the 0x0000000000000000000000000000000000000000 token address as Native ETH. 2. Convert it to/from `{ parents: 2, interior: X1(GlobalConsensus(Ethereum{chain_id: 1})) }` when encountered. Onchain changes: This will require a governance request to register native ETH (with the above location) in the foreign assets pallet and make it sufficient. Related solidity changes: Snowfork/snowbridge#1354 TODO: - [x] Emulated Tests --------- Co-authored-by: Vincent Geddes <[email protected]> Co-authored-by: Bastian Köcher <[email protected]> Co-authored-by: Bastian Köcher <[email protected]>

Changes: 1. Use the 0x0000000000000000000000000000000000000000 token address as Native ETH. 2. Convert it to/from `{ parents: 2, interior: X1(GlobalConsensus(Ethereum{chain_id: 1})) }` when encountered. Onchain changes: This will require a governance request to register native ETH (with the above location) in the foreign assets pallet and make it sufficient. Related solidity changes: Snowfork/snowbridge#1354 TODO: - [x] Emulated Tests --------- Co-authored-by: Vincent Geddes <[email protected]> Co-authored-by: Bastian Köcher <[email protected]> Co-authored-by: Bastian Köcher <[email protected]> (cherry picked from commit 4059282)

contracts/src/AgentExecutor.sol

vgeddes · 2025-01-15T11:32:34Z

contracts/src/Assets.sol

@@ -60,7 +62,7 @@ library Assets {
    ) external view returns (Costs memory costs) {
        AssetsStorage.Layout storage $ = AssetsStorage.layout();
        TokenInfo storage info = $.tokenRegistry[token];
-        if (!info.isRegistered) {
+        if (!info.isRegistered && token != address(0)) {


Why not just register ether as a token, so we can avoid the complexity of this check?

Addressed in a3e5aa4

contracts/src/Assets.sol

vgeddes · 2025-01-17T12:44:35Z

contracts/src/Assets.sol

+        payable($.assetHubAgent).safeNativeTransfer(amount);
+        ticket.value = amount;
+
+        ticket.dest = $.assetHubParaID;


It seems that both _sendEther and _sendNativeToken share this ticket/payload creation code. Can we not factor that out?

addressed in 0921ff9

claravanstaden

Awesome feature! 🥳

contracts/src/Assets.sol

contracts/src/Gateway.sol

web/packages/api/src/environment.ts

contracts/src/upgrades/Gateway202410.sol

* do not dispatch transfer from native command * test to make sure the behavior is off * fmt * naming

contracts/src/Assets.sol

vgeddes · 2025-01-27T13:29:08Z

@alistair-singh ready for another round of review - I improved the validation of the passed ether in Gateway.submitOutbound

alistair-singh

Looks good!

github-actions bot added Component: Ethereum Component: Smoke Tests Component: Web labels Dec 12, 2024

alistair-singh mentioned this pull request Dec 12, 2024

Snowbridge: Support bridging native ETH paritytech/polkadot-sdk#6855

Merged

1 task

alistair-singh force-pushed the alistair/support-eth branch 2 times, most recently from c2835dd to b75401c Compare December 17, 2024 19:22

github-actions bot removed the Component: Smoke Tests label Dec 17, 2024

alistair-singh marked this pull request as ready for review December 17, 2024 23:52

yrong reviewed Dec 18, 2024

View reviewed changes

contracts/src/Gateway.sol Outdated Show resolved Hide resolved

vgeddes reviewed Dec 18, 2024

View reviewed changes

contracts/src/Types.sol Outdated Show resolved Hide resolved

contracts/src/GatewayProxy.sol Outdated Show resolved Hide resolved

github-actions bot added Component: Relayer Component: Smoke Tests labels Dec 19, 2024

yrong approved these changes Jan 1, 2025

View reviewed changes

alistair-singh mentioned this pull request Jan 7, 2025

Auto Wrap/Unwrap WETH #1343

Closed

alistair-singh force-pushed the alistair/support-eth branch from c778b96 to 757bcc0 Compare January 10, 2025 09:06

vgeddes reviewed Jan 15, 2025

View reviewed changes

vgeddes reviewed Jan 17, 2025

View reviewed changes

claravanstaden approved these changes Jan 21, 2025

View reviewed changes

contracts/src/Assets.sol Outdated Show resolved Hide resolved

contracts/src/Assets.sol Show resolved Hide resolved

contracts/src/Gateway.sol Outdated Show resolved Hide resolved

web/packages/api/src/environment.ts Show resolved Hide resolved

vgeddes self-assigned this Jan 22, 2025

vgeddes reviewed Jan 22, 2025

View reviewed changes

contracts/src/upgrades/Gateway202410.sol Outdated Show resolved Hide resolved

alistair-singh added 6 commits January 23, 2025 00:09

initial support

2c5e273

add error

3f178ef

fixed tests

5887da7

test legacy and new unlock messages

4677fe7

fix spelling

13b59fb

test registration is blocked

6d6f3fc

alistair-singh added 21 commits January 23, 2025 00:09

fix scripts

182d6ed

update bindings

61c52b0

e2e tests

db45375

fix assert

a44d093

duplicated error removal

9b67398

fix test fixture generator

2b9173e

template fixes

e209869

contract address changes

bb55b2a

contract address change

7359dba

Ignore AgentTransferFromNative bridge command (#1359)

366c457

* do not dispatch transfer from native command * test to make sure the behavior is off * fmt * naming

fmt

3ac9646

merge conflicts

aaa8139

Rename and remove parameter

a12492b

added sendEth sanity check

a149663

register ether on contruction and migration

566f2fb

remove extra branches

6ed7140

simplify math

f86a6d8

separate branches for ether and native tokens

bd1548e

fix comments

e45c9ee

factor out emitting of sendToken

2699ebe

comment

ddad89f

alistair-singh force-pushed the alistair/support-eth branch from 0921ff9 to ddad89f Compare January 22, 2025 22:17

Refactor

b972591

alistair-singh commented Jan 25, 2025

View reviewed changes

contracts/src/Assets.sol Outdated Show resolved Hide resolved

contracts/src/Assets.sol Show resolved Hide resolved

Improve validation of passed ether

eed9eb1

vgeddes merged commit cb05e1f into main Jan 27, 2025
3 checks passed

vgeddes deleted the alistair/support-eth branch January 27, 2025 14:50

vgeddes restored the alistair/support-eth branch January 27, 2025 15:30

alistair-singh commented Jan 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Native ETH in v1 #1354

Support Native ETH in v1 #1354

alistair-singh commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading

alistair-singh commented Dec 18, 2024

yrong left a comment

vgeddes Jan 15, 2025

alistair-singh Jan 16, 2025

vgeddes Jan 17, 2025

alistair-singh Jan 17, 2025

claravanstaden left a comment

vgeddes commented Jan 27, 2025

alistair-singh left a comment

Support Native ETH in v1 #1354

Support Native ETH in v1 #1354

Conversation

alistair-singh commented Dec 12, 2024 • edited Loading

codecov bot commented Dec 17, 2024 • edited Loading

Codecov Report

alistair-singh commented Dec 18, 2024

yrong left a comment

Choose a reason for hiding this comment

vgeddes Jan 15, 2025

Choose a reason for hiding this comment

alistair-singh Jan 16, 2025

Choose a reason for hiding this comment

vgeddes Jan 17, 2025

Choose a reason for hiding this comment

alistair-singh Jan 17, 2025

Choose a reason for hiding this comment

claravanstaden left a comment

Choose a reason for hiding this comment

vgeddes commented Jan 27, 2025

alistair-singh left a comment

Choose a reason for hiding this comment

alistair-singh commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading