fix: fix in the exit_to_eth precompile #834

aleksuss · 2023-09-05T18:38:19Z

Description

The PR fixes the exit to ethereum precompile.

Performance / NEAR gas cost considerations

There are no changes in performance.

Testing

There are no tests for testing this part of the code, but it would be nice to have.

birchmd · 2023-09-05T19:13:05Z

engine-precompiles/src/native.rs

@@ -537,7 +533,7 @@ impl<I: IO> Precompile for ExitToEthereum<I> {
                    .try_into()
                    .map_err(|_| ExitError::Other(Cow::from("ERR_INVALID_RECIPIENT_ADDRESS")))?;
                (
-                    self.current_account_id.clone(),
+                    get_eth_connector_contract_account(&self.io)?,
                    // There is no way to inject json, given the encoding of both arguments
                    // as decimal and hexadecimal respectively.
                    WithdrawCallArgs {


One more change is needed here. As @karim-en pointed out in our call, the Engine Withdraw used Borsh serialization for the arguments and so does the new eth-connector, however regular NEP-141 tokens use JSON (see ERC-20 implementation below).

I think there are two options for what to do:

Change the eth-connector to use JSON args for withdraw, thus making it consistent with the other bridged NEP-141 tokens, and then make the corresponding change here.

Add another config to the Engine to say what format the withdraw arguments are supposed to be in.

I personally think 1 is the better solution.

I also like the first option, but this change should be backward compatible, because this change can break any services or contracts that interact with the engine contract.
To make it backward compatible I think we can try to deserialise the input twice, as an borsh, and then try to deserialise it as a json if it was failed here

PS: I've considered just the scenario where the eth-base silo points to the current build-in eth connector, not the separate/new one. For the new connector we can support just the json input.

@birchmd what existing problem or business goal is it to solve by introducing changes that break the existing API? I do not have enough context to understand the essence of such a controversial proposal.

@karim-en, what is the JSON format for this message should be?

@karim-en Backwards compatibility is maintained by the main Aurora Engine withdraw (which delegates to the new connector's engine_withdraw) remaining borsh-encoded. I don't think we need fallback serialization on the new withdraw method of the new connector.

@aleksuss the format will be identical to the ERC-20 case.

@mrLSD This is not a breaking change to the existing API because the Aurora Engine maintains backwards compatibility. The reason to API of the new contract to be different from Aurora Engine is because then it is consistent with all other bridged NEP-141 tokens (i.e. all ERC-20 tokens bridged from Ethereum). All NEP-141 tokens having a consistent interface allows us to use any bridged token as the base token for a silo, not just ETH. Having alternate base tokens is a business requirement.

@birchmd don't we need to support both versions of deserialization in the main aurora contract in the withdraw function? In case we will use the main contract as an eth-connector for using ETH as the base token in silo?

Good point! Yes, we may need to do that in the short term. Maybe then option 2 from my initial comment is the better solution for now. In the future I still think it would be good for there to be one consistent withdraw API.

mrLSD · 2023-09-06T10:52:43Z

engine-precompiles/src/native.rs

@@ -537,7 +533,7 @@ impl<I: IO> Precompile for ExitToEthereum<I> {
                    .try_into()
                    .map_err(|_| ExitError::Other(Cow::from("ERR_INVALID_RECIPIENT_ADDRESS")))?;
                (
-                    self.current_account_id.clone(),
+                    get_eth_connector_contract_account(&self.io)?,
                    // There is no way to inject json, given the encoding of both arguments
                    // as decimal and hexadecimal respectively.
                    WithdrawCallArgs {


@birchmd what existing problem or business goal is it to solve by introducing changes that break the existing API? I do not have enough context to understand the essence of such a controversial proposal.

birchmd

LGTM

engine-types/src/parameters/connector.rs

karim-en

LGTM

@aleksuss

## Release 3.2.0 ### Changes - Changed structure `SetEthConnectorContractAccountArgs` for setting eth connector account. It was extended with additional field: `withdraw_serialize_type` for defining serialization type for withdraw arguments by [@aleksuss]. ([#834]) - Updated rocksdb up to 0.21.0 by [@aleksuss]. ([#840]) ### Additions - Added a possibility of mirroring deployed ERC-20 contracts in the main Aurora contract in Silo mode by [@aleksuss]. ([#844]) - Allow to initialize hashchain directly with the `new` method by [@birchmd]. ([#846]) - Added a silo logic which allows to set fixed gas costs per transaction by [@aleksuss]. ([#746]) - Added a new type of transaction which allows to add full access key into account of the smart contract by [@aleksuss]. ([#847]) [#746]: #746 [#834]: #834 [#840]: #840 [#844]: #844 [#846]: #846 [#847]: #847 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: i-fix-typos <146758284+i-fix-typos@users.noreply.github.com> Co-authored-by: Evgeny Ukhanov <evgeny@aurora.dev> Co-authored-by: Michael Birch <michael.birch@aurora.dev> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Karim <karim@aurora.dev> Co-authored-by: Joshua J. Bouw <joshua@aurora.dev> Co-authored-by: ForwardSlashBack <142098649+ForwardSlashBack@users.noreply.github.com>

@aleksuss

## Release 3.2.0 ### Changes - Changed structure `SetEthConnectorContractAccountArgs` for setting eth connector account. It was extended with additional field: `withdraw_serialize_type` for defining serialization type for withdraw arguments by [@aleksuss]. ([#834]) - Updated rocksdb up to 0.21.0 by [@aleksuss]. ([#840]) ### Additions - Added a possibility of mirroring deployed ERC-20 contracts in the main Aurora contract in Silo mode by [@aleksuss]. ([#844]) - Allow to initialize hashchain directly with the `new` method by [@birchmd]. ([#846]) - Added a silo logic which allows to set fixed gas costs per transaction by [@aleksuss]. ([#746]) - Added a new type of transaction which allows to add full access key into account of the smart contract by [@aleksuss]. ([#847]) [#746]: #746 [#834]: #834 [#840]: #840 [#844]: #844 [#846]: #846 [#847]: #847 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: i-fix-typos <146758284+i-fix-typos@users.noreply.github.com> Co-authored-by: Evgeny Ukhanov <evgeny@aurora.dev> Co-authored-by: Michael Birch <michael.birch@aurora.dev> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Karim <karim@aurora.dev> Co-authored-by: Joshua J. Bouw <joshua@aurora.dev> Co-authored-by: ForwardSlashBack <142098649+ForwardSlashBack@users.noreply.github.com>

fix: fix in the exit_to_eth precompile

4d629db

aleksuss requested review from mrLSD, karim-en and birchmd September 5, 2023 18:38

aleksuss requested a review from vimpunk as a code owner September 5, 2023 18:38

birchmd requested changes Sep 5, 2023

View reviewed changes

mrLSD approved these changes Sep 6, 2023

View reviewed changes

chore: serialize withdraw message with json

bb97a7d

aleksuss requested a review from birchmd September 6, 2023 12:56

aleksuss requested a review from joshuajbouw as a code owner September 6, 2023 15:38

aleksuss force-pushed the fix/aleksuss/fix_exit_to_eth branch from d222146 to d3baec9 Compare September 6, 2023 16:44

aleksuss requested a review from RomanHodulak as a code owner September 6, 2023 16:44

chore: serialize withdraw message with json

3b0b713

aleksuss force-pushed the fix/aleksuss/fix_exit_to_eth branch from d3baec9 to 3b0b713 Compare September 6, 2023 16:52

birchmd approved these changes Sep 6, 2023

View reviewed changes

engine-types/src/parameters/connector.rs Show resolved Hide resolved

chore: use default borsh if serialize type wasn't set before

30b2dff

birchmd approved these changes Sep 7, 2023

View reviewed changes

karim-en approved these changes Sep 7, 2023

View reviewed changes

aleksuss merged commit ed31dfe into feat/aleksuss/silo Sep 7, 2023
18 checks passed

aleksuss deleted the fix/aleksuss/fix_exit_to_eth branch September 7, 2023 12:52

aleksuss mentioned this pull request Oct 17, 2023

Release 3.2.0 #852

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: fix in the exit_to_eth precompile #834

fix: fix in the exit_to_eth precompile #834

aleksuss commented Sep 5, 2023

birchmd Sep 5, 2023

karim-en Sep 5, 2023 •

edited

mrLSD Sep 6, 2023

aleksuss Sep 6, 2023

birchmd Sep 6, 2023

aleksuss Sep 6, 2023

birchmd Sep 6, 2023

mrLSD Sep 6, 2023

birchmd left a comment

karim-en left a comment

fix: fix in the exit_to_eth precompile #834

fix: fix in the exit_to_eth precompile #834

Conversation

aleksuss commented Sep 5, 2023

Description

Performance / NEAR gas cost considerations

Testing

birchmd Sep 5, 2023

Choose a reason for hiding this comment

karim-en Sep 5, 2023 • edited

Choose a reason for hiding this comment

mrLSD Sep 6, 2023

Choose a reason for hiding this comment

aleksuss Sep 6, 2023

Choose a reason for hiding this comment

birchmd Sep 6, 2023

Choose a reason for hiding this comment

aleksuss Sep 6, 2023

Choose a reason for hiding this comment

birchmd Sep 6, 2023

Choose a reason for hiding this comment

mrLSD Sep 6, 2023

Choose a reason for hiding this comment

birchmd left a comment

Choose a reason for hiding this comment

karim-en left a comment

Choose a reason for hiding this comment

karim-en Sep 5, 2023 •

edited