feat: Onboarding IBC middleware #103

poorphd · 2023-04-27T12:52:52Z

Description

IBC onboarding middleware for Canto Onboarding UX Improvement

Related Forum post: https://forum.canto.build/t/canto-onboarding-ux-improvement-feature/64
Spec: https://github.com/b-harvest/Canto/tree/onboarding-middleware/x/onboarding/spec

When users transfer assets to the Canto network through Gravity Bridge, the IBC transfer automatically triggers swap and conversion to Canto ERC20 via IBC middleware. Auto swap is triggered based on the recipient's Canto balance, and the remaining transferred balance is converted to Canto ERC20. The conversion process is independent of the result of the swap. It attempts to convert all assets transferred via IBC to ERC20 tokens, provided that the transferred asset is registered in the ERC20 token pairs. This applies even if the swap fails or is not triggered.
onboarding middleware always returns original ACK from previous middleware stack meaning that even if the swap or conversion fails, it does not revert IBC transfer and the asset transferred to the Canto network will still remain in the Canto network

For auto swap function, Coinswap module is also added.

Spec: https://github.com/b-harvest/Canto/tree/onboarding-middleware/x/coinswap/spec

This module is a forked modification of IRISNET's Coinswap module v1.6. Several modifications have been made to ensure that the liquidity pools are only used for onboarding. The modifications are as follows:

Remove double swap functionality
Limit the quantity of max standard coin (Canto) in the liquidity pool
Limit the quantity of swappable coins

IBC Testing package issue

There have been issues with onboarding middleware testing due to the low version of IBC-go currently used in Canto. When using ibc-go/testing, there were cases where EVM configuration loading failed because the proposer was not set in the block header, or the EVM call failed due to gas shortage caused by a low DefaultGenTxGas value. To resolve these issues, a custom version of ibc-go/testing is implemented in ibc/testing and used.

Tasks

Add onboarding module
Add coinswap module
Write unit tests and integration tests
Package name change v6 -> v7
Add v7 upgrade handler
Testing with Canto local chain
Testing with mainnet state based local chains

After this pull request is merged, a follow-up pull request will be created to change the package name from v6 to v7.

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
included the necessary unit and integration tests
reviewed "Files changed" and left comments if necessary

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed all author checklist items have been addressed
reviewed state machine logic
reviewed API design and naming
reviewed documentation is accurate
reviewed tests and test coverage
manually tested (if applicable)

Resolving Security Audit Findings

All security audit findings are resolved in this PR.

(cherry picked from commit 4b2176a)

…lt params

poorphd · 2023-04-28T09:47:09Z

@zscole Please review the PR. Thanks.

tkkwon1998

Some changes required regarding module versioning. Canto is currently on v5, and the next state-breaking upgrade should be v6.

app/app.go

app/upgrades/v7/constants.go

app/upgrades/v7/upgrades.go

app/upgrades/v7/upgrades_test.go

tkkwon1998

Approved!

reference github issue: code-423n4/2023-06-canto-findings#36

reference github issue: code-423n4/2023-06-canto-findings#71

poorphd · 2023-07-20T01:29:03Z

With the recent v6 upgrade, there are conflicts that need to be resolved in the onboarding PR.

#106
It looks like we may have to repeat the conflict resolve for the onboarding module if there is an upgrade coming soon that removes the vesting module.
@tkkwon1998 Can you give us an idea of the features that will be included in the v7 upgrade?

Option 1: Remove modules in v7 + onboarding merge
Option 2: Remove module from v7 + onboarding merge in v8

Once we have confirmation of the above, we will modify the upgrade handler to the version that will include onboarding.

tkkwon1998 · 2023-07-21T14:10:13Z

Let's go with option 1, remove modules in v7 + onboarding merge.

I'll merge #106, then we can go ahead with resolving conflicts for onboarding PR.

…re-conflict-resolve # Conflicts: # app/app.go # app/upgrades/v6/upgrades.go

…resolve Onboarding middleware conflict resolve

tkkwon1998 · 2023-07-31T04:40:22Z

@poorphd #109 has been merged into main branch now

poorphd · 2023-07-31T12:14:54Z

We will resolve the conflicts once this PR is merged.

…leware-conflict-resolve # Conflicts: # app/app.go # x/recovery/keeper/ibc_callbacks.go # x/recovery/keeper/ibc_callbacks_integration_suite_test.go (cherry picked from commit 4d45df7)

…re-conflict-resolve # Conflicts: # app/app.go # app/app_test.go # app/test_helpers.go (cherry picked from commit ec76588)

(cherry picked from commit 5ac28de)

(cherry picked from commit ca2307f)

(cherry picked from commit ba5685f)

…ng-middleware-conflict-resolve * commit 'd780d52648475e8887cacce73acec93ae59fb34b': chore: add branches rule for workflow fix: simulation seed randomness was removed to make the ci/cd result deterministic fix: remove recovery from storeKeysPrefixes add placeholder for ICS4wrapper in transferKeeper init remove recovery imports in app.go remove recovery proto remove x/recovery fix: update simulation target modules, refactor duplicated struct fix: removing unused keeper from handler options fix: simulation workflow, update sims.yml, add GOPATH on makefile fix: simulation errors fix: seperate antehandler for simulation feat: add workflow to build, test, codecov for ci/cd # Conflicts: # app/app.go # app/test_helpers.go # proto/canto/onboarding/v1/query.proto # x/onboarding/client/cli/query.go # x/onboarding/genesis.go # x/onboarding/genesis_test.go # x/onboarding/ibc_middleware.go # x/onboarding/keeper/grpc_query.go # x/onboarding/keeper/grpc_query_test.go # x/onboarding/keeper/keeper.go # x/onboarding/keeper/keeper_test.go # x/onboarding/keeper/params.go # x/onboarding/keeper/utils_test.go # x/onboarding/module.go # x/onboarding/types/errors.go # x/onboarding/types/genesis.go # x/onboarding/types/genesis.pb.go # x/onboarding/types/genesis_test.go # x/onboarding/types/keys.go # x/onboarding/types/params_test.go # x/onboarding/types/query.pb.go # x/onboarding/types/query.pb.gw.go

…resolve Onboarding middleware conflict resolve

dongsam · 2023-08-04T02:09:23Z

The update related to swagger will be carried out after the #112 is reviewed/merged or will be updated together on the PR depending on the merge order

tkkwon1998 · 2023-08-04T09:27:00Z

@dongsam #112 has been reviewed & merged now

* commit '3ea39d93546596c018f88d1802e91fbc8645ff76': docs: update swagger, statik fix: re-generate proto pb.go files chore: formatting proto files build: fix proto gen, swagger script docs: remove deprecated module's on swagger config chore: remove deprecated fee, vesting module's proto files

tkkwon1998 · 2023-08-06T03:18:30Z

LGTM

poorphd added 21 commits April 27, 2023 17:48

feat: onboarding IBC middleware

37612b4

fix: recovery test to use ibc/testing

a44264e

refactor: package name change v6 -> v7

12a1caf

docs: module specs

ba99a5b

feat: proto for coinswap module

00b81a6

feat: swap event emit in ibc callback

c61b8b0

test: convert fail test case added

8ddce2a

(cherry picked from commit 4b2176a)

feat: WIP coinswap module

305aee3

refactor: delete migration code

81e8fd6

refactor: coinswap module for Canto

31f6c9d

fix: allowing vesting account

4f07331

fix: use ethsecp256k address for Canto address

06746d5

fix: emit swap event fix

73ff366

test: IBC transfer to a blocked addr

1a9e72b

refactor: remove unnecessary test case

ef781ae

fix: default params for coinswap and upgrade handler to use the defau…

a137619

…lt params

refactor: package name v7 -> v6

8f7d8be

refactor: remove ibc/testing/simapp

9953db6

fix: go mod

ba3e0ea

fix: proto for coinswap

da6194f

refactor: sort imports and revert unnecessary changes

cadf019

poorphd changed the title ~~Onboarding middleware~~ feat: Onboarding IBC middleware Apr 27, 2023

poorphd marked this pull request as ready for review April 28, 2023 09:46

zsystm mentioned this pull request May 2, 2023

feat: liquidstaking module b-harvest/Canto#2

Open

19 tasks

tkkwon1998 requested changes May 3, 2023

View reviewed changes

poorphd added 3 commits May 3, 2023 18:09

fix: package name change v7 -> v6

4bb9024

fix: bug in AmountOf

266930b

fix: validate params

2b1b03e

poorphd requested a review from tkkwon1998 May 9, 2023 23:04

tkkwon1998 approved these changes May 12, 2023

View reviewed changes

gyousuf assigned zscole May 18, 2023

gyousuf requested a review from zscole May 18, 2023 20:14

gyousuf unassigned zscole May 18, 2023

poorphd added 2 commits July 13, 2023 23:12

fix: default max sawp amount

653d35b

reference github issue: code-423n4/2023-06-canto-findings#36

fix: swappedAmount in error case

2aafb8e

reference github issue: code-423n4/2023-06-canto-findings#71

dongsam mentioned this pull request Jul 21, 2023

build(deps): rebase upstream branch b-harvest/Canto#10

Closed

poorphd and others added 3 commits July 24, 2023 18:35

Merge remote-tracking branch 'upstream/main' into onboarding-middlewa…

b186460

…re-conflict-resolve # Conflicts: # app/app.go # app/upgrades/v6/upgrades.go

fix: resolve conflicts

b79a715

Merge pull request #22 from b-harvest/onboarding-middleware-conflict-…

4caeaf2

…resolve Onboarding middleware conflict resolve

poorphd requested a review from tkkwon1998 July 26, 2023 12:03

poorphd mentioned this pull request Jul 26, 2023

Canto Core Devs Meeting 6 Agenda Canto-Network/pm#6

Closed

tkkwon1998 mentioned this pull request Jul 28, 2023

feat: remove recovery module #109

Merged

10 tasks

poorphd and others added 7 commits August 3, 2023 16:54

Merge remote-tracking branch 'origin/canto-main' into onboarding-midd…

9e54c11

…leware-conflict-resolve # Conflicts: # app/app.go # x/recovery/keeper/ibc_callbacks.go # x/recovery/keeper/ibc_callbacks_integration_suite_test.go (cherry picked from commit 4d45df7)

Merge remote-tracking branch 'upstream/main' into onboarding-middlewa…

9bcebc8

…re-conflict-resolve # Conflicts: # app/app.go # app/app_test.go # app/test_helpers.go (cherry picked from commit ec76588)

fix: SetupTestingCantoApp

13f26e8

(cherry picked from commit 5ac28de)

fix: coinswap module is added to simulation manager

b9e47d5

(cherry picked from commit ca2307f)

fix: bug in coinswap module's param change simulation

6626290

(cherry picked from commit ba5685f)

Merge pull request #25 from b-harvest/onboarding-middleware-conflict-…

57b9208

…resolve Onboarding middleware conflict resolve

dongsam added 2 commits August 4, 2023 18:38

fix: update swagger for onboarding, coinswap module

c497110

tkkwon1998 merged commit 7ebb314 into Canto-Network:main Aug 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Onboarding IBC middleware #103

feat: Onboarding IBC middleware #103

poorphd commented Apr 27, 2023 •

edited

Loading

poorphd commented Apr 28, 2023

tkkwon1998 left a comment

tkkwon1998 left a comment

poorphd commented Jul 20, 2023 •

edited

Loading

tkkwon1998 commented Jul 21, 2023

tkkwon1998 commented Jul 31, 2023

poorphd commented Jul 31, 2023

dongsam commented Aug 4, 2023 •

edited

Loading

tkkwon1998 commented Aug 4, 2023

tkkwon1998 commented Aug 6, 2023

feat: Onboarding IBC middleware #103

feat: Onboarding IBC middleware #103

Conversation

poorphd commented Apr 27, 2023 • edited Loading

Description

IBC Testing package issue

Tasks

Author Checklist

Reviewers Checklist

Resolving Security Audit Findings

poorphd commented Apr 28, 2023

tkkwon1998 left a comment

Choose a reason for hiding this comment

tkkwon1998 left a comment

Choose a reason for hiding this comment

poorphd commented Jul 20, 2023 • edited Loading

tkkwon1998 commented Jul 21, 2023

tkkwon1998 commented Jul 31, 2023

poorphd commented Jul 31, 2023

dongsam commented Aug 4, 2023 • edited Loading

tkkwon1998 commented Aug 4, 2023

tkkwon1998 commented Aug 6, 2023

poorphd commented Apr 27, 2023 •

edited

Loading

poorphd commented Jul 20, 2023 •

edited

Loading

dongsam commented Aug 4, 2023 •

edited

Loading