Skip to content

Commit

Permalink
imp: replace Sender/ReceiverChainIsSource with HasPrefix (#6705)
Browse files Browse the repository at this point in the history
* Adding proto files for ics20-v2 (#6110)

* chore: adding proto files for ics20-v2

* chore: add newline

* update amount -> string (#6120)

* Update MsgTransfer to accept sdk.Coins instead of sdk.Coin (#6113)

* fix: allow base denom with trailing slash (#6148)

* imp: add CurrentVersion, EscrowVersion (#6160)

* add CurrentVersion, EscrowVersion, update tests

* update hardcoded transfer channel version from interchaintest

* chore: add function for converting packet data from v1 to v3 (#6116)

---------

Co-authored-by: Charly <charly@interchain.berlin>

* chore: implement required `FungibleTokenPacketData` v3 interface methods (#6126)

* imp: `getMultiDenomFungibleTokenPacketData`to be used in packet unmarshalling/conversion (#6226)

* chore: adding proto files for ics20-v2

* chore: add newline

* chore: modify MsgTransfer to accept coins instead of coin

* chore: reverted unintentional comment changes

* chore: reverted unintentional comment changes

* chore: adding test for conversion fn

* chore: fix e2e linter

* chore: adding docs

* chore: addressing PR feedback

* chore: remove duplicate import

* chore: addressing PR feedback

* chore: moved extration logic into internal package

* chore: commented out failing test

* chore: adding link to issue

* chore: remove duplicate import

* chore: fix linting errors

* FungibleTokenPacketData interface methods + tests

* linter

* wip: token validation

* update trace identifier validation in Token + tests

* rm Printf

* update with pr review

* add CurrentVersion, EscrowVersion, update tests

* pr review

* fix e2e tests

* pr review

* update e2e test version

* linter

* update hardcoded transfer channel version from interchaintest

* update hardcoded transfer channel version from interchaintest

* wip packet unmarshaller

* wip

* wip testing

* update test

* linter

* rm unnecessary version changes

* rm unnecessary artifacts

* update callbacks test

* update comment

* pr review

* rename getMultiDenomFungibleTokenPacketData to unmarshalPacketDataBytesToICS20V2

---------

Co-authored-by: chatton <github.qpeyb@simplelogin.fr>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* chore: implement version checking for channel handshake application callbacks (#6175)

* add SupportedVersions array for different ics20 versions, add version checking on channel handshake application callbacks

* add tests

* update pr review

* pr review

* last few pr review nits

* linter

* add version counter proposing

* fix missing app versino

* update code + tests to return our proposed version if counterparty version is invalid

* remove if statement

* address review comments: return ics20-2 if counterparty version is not supported

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* imp: update transfer authz implementation to account for multi denom transfers (#6252)

* add transfer authz code + tests

* linter

* address review comments

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* ics20-v2: backwards compatibility for transfer rpc and packet callbacks (#6189)

* chore: adding proto files for ics20-v2

* chore: add newline

* chore: modify MsgTransfer to accept coins instead of coin

* chore: reverted unintentional comment changes

* chore: reverted unintentional comment changes

* chore: adding test for conversion fn

* chore: fix e2e linter

* chore: adding docs

* chore: addressing PR feedback

* chore: remove duplicate import

* chore: addressing PR feedback

* chore: moved extration logic into internal package

* chore: commented out failing test

* chore: adding link to issue

* chore: remove duplicate import

* chore: fix linting errors

* FungibleTokenPacketData interface methods + tests

* linter

* wip: token validation

* update trace identifier validation in Token + tests

* rm Printf

* update with pr review

* pr review

* linter

* rm unused function: linter

* wip pr feedback

* fix test

* pr review

* lintttttt

* wip: backwards compatibility for transfer rpc

* implement changes for ics20-v2 packet data for onRecvPacket, onAcknowledgePacket and onTimeoutPacket

* fix callbacks tests

* lint

---------

Co-authored-by: chatton <github.qpeyb@simplelogin.fr>
Co-authored-by: Charly <charly@interchain.berlin>

* add v3 packet proto

* fix protos

* fixes

* test fixes

* add forwardPath keys and memo check in sendTransfer

* wip onRecvPacket logic

* minor fixes

* changes to transfer tx CLI to support multiple denoms

* import renaming

* onRecv logic completed

* add revertInFlights function

* add onAck && onTimeout logic

* fix interchain accounts test

* basic unit test for path forwarding

* fix test unsuccessful refund from source

* wip test fix

* fix mbt test - need more investigation

* revert test fix

* add assertions

* add support for async ack

* wip test forwarding happy path

* icsv20(path forwarding): use nil as default forwarding path when not set, use sequence in key to store forwarded packet (#6325)

* use nil forwarding path as default when not set, use sequence in key to store forwarded packet

* lint

* add forwarding happy path tests

* fix merge

* Use type with V2 suffix for package data (#6330)

* Adding additional comments and changing version variable names (#6345)

* chore: correctly claim capability

* lint

* imp: change ics20 events to emit token set (#6348)

* refactor: quick change to tokens event attribute

* fix: various tests

* lint

* lint:fixeroni

* imp: remove events variable in favour of direct event emission

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* imp: check length tokens array against maximum allowed (#6349)

* check length of tokens array against maximum allowed

* chore: add note on arbitrary selection

---------

Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

* Modify UnmarshalPacketData interface to allow additional args (#6341)

* api(port)!: Allow passing of context, port and channel identifier to unmarshal packet data interface as disussed.

This allows us to grab the app version in transfer and unmarshal the packet based on that instead of a hacky unmarshal v2 then v1 and whatever happens.

* lint: as we do

* callbacks: fix signature of UnmarshalPacketData as per changes, make refactors to hopefully simplify signatures.

* chore: lint and remove some todos.

* review: address feedback.

* Refactor packet data unmarshalling to use specific version (#6354)

* chore: specifically unmarshal v1 or v2 without brute force

* chore: fix TestPacketDataUnmarshalerInterface test in transfer module

* Pass dest values OnRecv, refactor GetExpectedEvents

* chore: fixing TestGetCallbackData test

* chore: fixed remaining tests in callbacks module

* test: simplify callbacks test, revert back to previous behaviour

* chore: fix test case name

* chore: addressing PR feedback

* chore: added docstring for unmarshalPacketDataBytesToICS20V2

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

* chore: fixing tests

* imp: self review comments for ics20-v2 (#6360)

* refactor: address various self review comments

* revert: unnecessary change

* lint

* imp: self review on ics20-v2 part 2 (#6364)

* refactor: apply review suggestions

* imp: additional updates

* refactor: make ValidateIBCDenom private

* Update modules/apps/transfer/types/msgs.go

Co-authored-by: Cian Hatton <cian@interchain.io>

* apply review suggestions

---------

Co-authored-by: Cian Hatton <cian@interchain.io>

* chore: move functions from internal/denom back to trace.go (#6368)

* chore: move functions from internal/denom to trace.go

* lint

* lint: the comeback

* imp: ics20 v2 self review part 3 (#6373)

* imp: self review items

* apply jim's suggestion

* Update modules/apps/transfer/keeper/msg_server_test.go

* Update modules/apps/transfer/ibc_module.go

* Update modules/apps/transfer/ibc_module.go

* chore: remove duplicate test case

* chore: address minor nits (#6374)

* fix lint warning, add extra godocs, and some other small fixes and cleanup

* fix finalReceiver address bug

* wip - ack test scenario5

* add FungibleTokenPacketDataV2 test for ValidateBasic (#6398)

* fix linter complaints

* add test - currently faling on middle hop revert

* add test comments

* fixes

* retrieve channel capability only if there is a previous packet in store

* add missing parameter

* fix: e2e build failures.

* Use Transfer instead of sendTransfer when forwarding. (#6564)

Pass nil as the next forwarding path if at final hop.
Use consistent timeout for all hops.

* lint: fix linter issues.

* tests(transfer): move forwarding tests to separate file. (#6568)

* chore: rename ForwardingInfo to Forwarding

* Revert "chore: rename ForwardingInfo to Forwarding"

This reverts commit e483b9a.

* nit(transfer): Mark hops as non nullable. (#6566)

* nit(transfer): Mark hops as non nullable.

* lint: fix additional linting issues

* feat(transfer): add forwarding info validation to token packet (#6571)

* feat(transfer): add forwarding info validation to token packet

* Added NewForwardingInfo constructor

* Removed redundant check

* Clean up tests per cr comments

* Back to Validate and use NewDenom

* feat(transfer): add validation for forwarding info in msg transfer validate basic (#6583)

* Fix and simplify reverts of forwarding state (#6574)

* refactor: initial simplification attempt

* refactor: further organize

* fix: all tests fixed

* docs: improved godocs

* fix: logic and testing error

* style: self suggestion

* docs: suggestion

* docs: spellcheck

* style: suggestions

* style: renamed to revertForwardedPacket

* style: suggestion

* docs: remove docs

* docs: godoc suggestion

* style: suggestion

* docs: colin suggestions

* chore: rename ForwardingInfo to Forwarding (#6576)

* chore: rename ForwardingInfo to Forwarding

* chore: rename forwarding_path field to forwarding

* chore: make lint-fix

* chore: rename forwarding info -> forwarding

* chore: renaming fixes before merge

* Refactor packet forward functions (#6575)

* feat(transfer): validate forwarding memo in transfer authorization (#6591)

* Add func convert token to coin ibc (#6584)

* add func convert token to coin ibc

* fix command: change func to ToCoin and add godoc

* add unit test

* Revert using ToCoin on Recv where trace manipulation occurs.
Use ToCoin while forwarding.
Update tests as per Carlos's review.

* rename variable

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* transfer: Disallow a forwarding object specified with zero hops and a memo (#6599)

* transfer: Disallow a forwarding object specified with zero hops and a memo.

* Apply suggestions from code review

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>

* feat(transfer): move async decision and handling to the ibc module onrecv callback (#6592)

* refactor: initial simplification attempt

* refactor: further organize

* fix: all tests fixed

* chore: refactor packet forward functions

* chore: use receiver address directly in msg transfer

* feat(transfer): move async to ibc_module for onrecv

* chore: fix linter

* fix: logic and testing error

* style: self suggestion

* docs: suggestion

* docs: spellcheck

* style: suggestions

* style: renamed to revertForwardedPacket

* style: suggestion

* docs: remove docs

* Added tests for transfer OnRecv

* Use new names and methods from feature branch

* Apply suggestions from code review

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* Clean up test from cr feedback

* move vars to beginning of function

* lint

* Update modules/apps/transfer/ibc_module.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* lint

---------

Co-authored-by: srdtrk <srdtrk@hotmail.com>
Co-authored-by: chatton <cian@interchain.io>
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* chore: use NewForwarding instead of direct init (#6605)

* Reduce max forwarding to 16 (#6610)

* feat(transfer): use single byte ack for successful forward (#6604)

Co-authored-by: Nikolas De Giorgis <bznein@gmail.com>

* chore(transfer/cli): add forwarding flag to tx cli (#6609)

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* chore(transfer): make Forwarding non-null (#6618)

* chore(transfer): make Forwarding non-null

* chore(transfer): always validate forwarding.

* chore: restructure functions with logical ordering (#6638)

* test: Add tests for OnTimeoutPacket when middle chain times out packet  (#6596)

* Create ontimeoutpacket test for forwarding

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* feat(transfer): add ShouldBeForwarded convenience method to msg transfer (#6595)

* feat(transfer): add should-be-forwarded convenience method to msg transfer

* Clean up packet and transfer msg validation for forwarding logic

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* disallow timeout height usage when forwarding packets (#6641)

* disallow non-zero timeout height when forwarding tokens

* typo

* move constant

* use time to create default timeout timestamp delta

* Apply suggestions from code review

* refactor: add GetTimeoutTimestamp helper fn to the testing pkg

* lint

---------

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* nit: make set forwarded packet unexported (#6637)

Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* feat(transfer): use registered error code for error acks in token forwarding (#6648)

* Add typed errors to packet forwarding

* Use forward errors in tests

* Make ack construction consistent

* chore(transfer): emit forwarding information in events. (#6647)

* chore(transfer): emit forwarding information in events.

* nit: rename as per Carlos's suggestion

* Fix e2e test

* Refactor forwarding messages for Transfer and Packet (#6655)

* feat(transfer): add unwind, refactor proto structure. gen-all

* tests(transfer/types): fix test failures in types tests.

* tests(transfer/keeper): fix test failures in keeper tests.

* cli(transfer): fix cli usage. pending flag for unwind.

* tests(callbacks): fix failing tests in callbacks.

* tests(transfer/internal): fix failures in internal package.

* tests(transfer): fix test failures in top level tranfer package.

* tests(ica/host/keeper): fix repr of msg transfer in ica host msg execution.

* lint(all): lint this bad boy

* chore(transfer/types): amend validation for MsgTransfer's ShouldBeForwarded, add tests for ForwardedPacketData, minor nits.

* nit(self): only pass relevant fields to create packet data; minor comment improvement.

* Apply suggestions from code review

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* chore(merge): fix merge issues.

* chore(proto): mention optional nature of fields.

* memo: do not drop it

* validation: drop requirement on memo being empty on msg transfer.

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* feat: allow authz granters to specify forwarding info for token transfer (#6661)

* First attempt to modify proto and validation.

* Fmt

* Make it compile

* Proto

* Add basic validation

* Added tests

* Fix nil check and remove redundant code.

* Move "forwarding" to non-pointer

* Added one test case.

* Moved error and changed method name.

* PR Feedback.

* Add nullable=false

* Added test and fixed test names

* Run make proto-all

* Change pointer to non-pointer

* Change Yet Another Pointer

* More pointers

* Comments and naming

* Reintroduce brace removed while merging

* Remove accidentally reintroduced tests

* feat: delete forwarded packet when it is not needed anymore  (#6621)

* Create ontimeoutpacket test for forwarding

* Propagate ack on A

* Refactoring

* Minor changes

* Added comments

* Fix type name.

* Gofumpt

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Add godoc to test.

* Changed trace construction

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* remove error msg parameter from helper function

* Add test for forwarded packet

* Delete packet when not needed anymore.

* Move deletion of packet in a single place.

* Reintroduce newline

* Do not ignore error.

* PR feedback.

* Construct packet for B ack check.

* PR feedback

* Pass packet to acknowledgeforwardedpacket

* revert unwanted change

* Another unwanted change

* Better signature and fix source/dest

* Added one more test.

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>

* test(transfer): forwarding acknowledgment errors in middle hop (#6659)

* test(transfer): forwarding where middle chaind is source for receive and send

* Fix errors after merge

* Finish up the test

* Update some out-of-date comments

* test(transfer): multi-hop ack failure with middle chain NOT being source

* Fix tests after height change

* Fix tests after height change

* Fix test after #6586

* Rename tests to not use scenario numbers

* Rename test

* address self-review comments

* use boolean in NewForwarding parameter

* some more review comments

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* test(transfer): last chain in forwarding packet is ICS20 v1 (#6622)

* test(transfer): last chain in forwarding being ICS20 v1

* Finish TestForwarding_WithLastChainBeingICS20v1_Succeeds

* Update CreateNewPath signature

Co-authored-by: Nikolas De Giorgis <bznein@gmail.com>

* Fix PR review comments

---------

Co-authored-by: Nikolas De Giorgis <bznein@gmail.com>

* refactor: rename SetupPath to SetupPaths (#6674)

* chore: add flag for unwind in transfer cli (#6680)

* add flag for unwind in transfer cli

* update long description of cli

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* feat: impl check reject transfer if len(hops) > 0 and ics20-1 (#6675)

* impl check reject transfer if len(hops) > 0 and ics20-1

* add test case hops is not empty with ics20-2

* address review comments

* reorder variable declaration

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>

* feat(transfer): add unwinding ability (#6656)

* Create ontimeoutpacket test for forwarding

* Propagate ack on A

* Refactoring

* Minor changes

* Added comments

* Fix type name.

* Gofumpt

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* Add godoc to test.

* Changed trace construction

* Update modules/apps/transfer/keeper/relay_forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* remove error msg parameter from helper function

* Add test for forwarded packet

* Construct packet for B ack check.

* PR feedback

* feat(transfer): add unwind, refactor proto structure. gen-all

* tests(transfer/types): fix test failures in types tests.

* tests(transfer/keeper): fix test failures in keeper tests.

* cli(transfer): fix cli usage. pending flag for unwind.

* tests(callbacks): fix failing tests in callbacks.

* tests(transfer/internal): fix failures in internal package.

* tests(transfer): fix test failures in top level tranfer package.

* tests(ica/host/keeper): fix repr of msg transfer in ica host msg execution.

* lint(all): lint this bad boy

* chore(transfer/types): amend validation for MsgTransfer's ShouldBeForwarded, add tests for ForwardedPacketData, minor nits.

* nit(self): only pass relevant fields to create packet data; minor comment improvement.

* Apply suggestions from code review

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* chore(merge): fix merge issues.

* chore(proto): mention optional nature of fields.

* memo: do not drop it

* validation: drop requirement on memo being empty on msg transfer.

* feat(transfer): add unwinding ability, wip.

* Added unwind to allocation forwarding.

* Add tests and move some validation

* Missing import

* Fixed validation and added test

* PR Feedback

* Return nil when returning an error.

* Cleaner comment

* Add test case for multiple hos

---------

Co-authored-by: bznein <nikolas.degiorgis@interchain.io>
Co-authored-by: Nikolas De Giorgis <bznein@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* fix typo

* remove unnecessary wrapping of function

* Revert "remove unnecessary wrapping of function"

This reverts commit c2a6bc6.

* fix usage of function

* imp: replace sender/receiver chain is source with has prefix

* (chore) replace reflect.DeepEqual with slices.Equal (#6697)

* Replace reflect.DeepEqual with slices.Equal

* Nit formatting

* chore: comment hop slicing for clarity (#6702)

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* chore: cleanup forwarding tests (#6691)

* chore: cleanup forwarding tests

* lint

* fix

---------

Co-authored-by: Nikolas De Giorgis <nikolas.degiorgis@interchain.io>
Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>

* chore: pull out hop validation and consolidate for transfer+packet (#6695)

* chore: pull out hop validation and consolidate transfer+packet

* Update modules/apps/transfer/types/forwarding_test.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* cr fixes

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* lint

* Remove unwind field in authz (#6701)

* chore: remove unwind field in authz

* chore: remove duplicate test

* Update modules/apps/transfer/types/transfer_authorization.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* chore: add packet data validation back (#6704)

* (chore) Refactor code around forwarding validation (#6706)

* Refactor validation

* Fixed verification logic, added two tests

* Fix check for unwind

* removed unneeded indirection

* Update modules/apps/transfer/types/msgs.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Add docstring.

---------

Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>
Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* use setupForwardingPaths in test

* address review comments

* feat(transfer): allow non-cosmos-sdk AccAddress in final receiver for forwarded packets (#6709)

* allow non-cosmos-sdk AccAddress for forwarded packets

* cr fixes

* chore: pass only hops to sendTransfer + events rename (#6703)

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

* test: forwarding test that verifies forwarded memo (#6707)

* test: forwarding with memo

* fix test

* cr fixes

* chore: update godoc for relay forwarding tests

* chore: use module account instead of custom forward address (#6688)

* chore: use module account instead of custom forward address

* pull blocked addr checker into keeper method

* lint

* clean up IsBlockedAddr

* chore: replace continue with if/else (#6700)

Co-authored-by: Nikolas De Giorgis <nikolas.degiorgis@interchain.io>

* add migration docs

* add changelog

* add test for invalid receiver address

* Update CHANGELOG.md

* Update CHANGELOG.md

* make getForwardedPacket private

* remove auxiliary burn coins function

* nit: rename func method recv args in types/forwarding.go

* chore: rename ShouldBeForwarded to HasFowarding

* e2e: remove template test for three chain setup.

* nit: no generics silly

* nit: add clarifying comment to validate basic call on msg.

* nit: remove unused key.

* nit: clean up cli help text.

* nit: don't export is blocked address helper.

* nit: docustring for e2e test and helper.

* nit: improve documentation for transfer's OnRecv callback.

Co-authored-by: Damian Nolan <damiannolan@gmail.com>

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* delete unused file

---------

Co-authored-by: Cian Hatton <cian@interchain.io>
Co-authored-by: Charly <charly@interchain.io>
Co-authored-by: Charly <charly@interchain.berlin>
Co-authored-by: chatton <github.qpeyb@simplelogin.fr>
Co-authored-by: Stefano Angieri <stefano@interchain.io>
Co-authored-by: sangier <45793271+sangier@users.noreply.github.com>
Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>
Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Hastur <hasturtheyellowking199@gmail.com>
Co-authored-by: Damian Nolan <damiannolan@gmail.com>
Co-authored-by: Gjermund Garaba <bjaanes@gmail.com>
Co-authored-by: srdtrk <59252793+srdtrk@users.noreply.github.com>
Co-authored-by: Maintain <duonghb53@users.noreply.github.com>
Co-authored-by: srdtrk <srdtrk@hotmail.com>
Co-authored-by: Nikolas De Giorgis <bznein@gmail.com>
Co-authored-by: Gjermund Garaba <gjermund@garaba.net>
Co-authored-by: Dzung Do | Decentrio <neitdung@gmail.com>
Co-authored-by: bznein <nikolas.degiorgis@interchain.io>
  • Loading branch information
19 people committed Jun 28, 2024
1 parent f7bdc75 commit b1743e0
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 59 deletions.
4 changes: 4 additions & 0 deletions docs/docs/05-migrations/13-v8-to-v9.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ func AssertEvents(
- `UnmarshalPacketData` now takes in the context, portID, and channelID. This allows the packet data to be unmarshaled based on the channel version.
- `Router` reference has been removed from IBC core keeper: [#6138](https://github.com/cosmos/ibc-go/pull/6138)

### ICS20 - Transfer

The functions [`SenderChainIsSource` and `ReceiverChainIsSource`](https://github.com/cosmos/ibc-go/blob/v8.0.0/modules/apps/transfer/types/coin.go#L12-L32) have been replaced with the function `HasPrefix` of the newly added `Denom` type.

### ICS27 - Interchain Accounts

In [#5785](https://github.com/cosmos/ibc-go/pull/5785) the list of arguments of the `NewKeeper` constructor function of the host submodule was extended with an extra argument for the gRPC query router that the submodule uses when executing a [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to perform queries that are module safe:
Expand Down
14 changes: 6 additions & 8 deletions modules/apps/transfer/keeper/forwarding.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,17 +115,15 @@ func (k Keeper) revertForwardedPacket(ctx sdk.Context, prevPacket channeltypes.P
// check if the token we received originated on the sender
// given that the packet is being reversed, we check the DestinationChannel and DestinationPort
// of the prevPacket to see if a hop was added to the trace during the receive step
if token.Denom.SenderChainIsSource(prevPacket.DestinationPort, prevPacket.DestinationChannel) {
// then send it back to the escrow address
if token.Denom.HasPrefix(prevPacket.DestinationPort, prevPacket.DestinationChannel) {
if err := k.bankKeeper.BurnCoins(ctx, types.ModuleName, sdk.NewCoins(coin)); err != nil {
return err
}
} else {
// send it back to the escrow address
if err := k.escrowCoin(ctx, forwardingAddr, escrow, coin); err != nil {
return err
}

continue
}

if err := k.bankKeeper.BurnCoins(ctx, types.ModuleName, sdk.NewCoins(coin)); err != nil {
return err
}
}
return nil
Expand Down
60 changes: 30 additions & 30 deletions modules/apps/transfer/keeper/relay.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,16 +116,9 @@ func (k Keeper) sendTransfer(
// chain inside the packet data. The receiving chain will perform denom
// prefixing as necessary.

if token.Denom.SenderChainIsSource(sourcePort, sourceChannel) {
labels = append(labels, telemetry.NewLabel(coretypes.LabelSource, "true"))

// obtain the escrow address for the source channel end
escrowAddress := types.GetEscrowAddress(sourcePort, sourceChannel)
if err := k.escrowCoin(ctx, sender, escrowAddress, coin); err != nil {
return 0, err
}

} else {
// if the denom is prefixed by the port and channel on which we are sending
// the token, then we must be returning the token back to the chain they originated from
if token.Denom.HasPrefix(sourcePort, sourceChannel) {
labels = append(labels, telemetry.NewLabel(coretypes.LabelSource, "false"))

// transfer the coins to the module account and burn them
Expand All @@ -143,6 +136,14 @@ func (k Keeper) sendTransfer(
// to burn.
panic(fmt.Errorf("cannot burn coins after a successful send to a module account: %v", err))
}
} else {
labels = append(labels, telemetry.NewLabel(coretypes.LabelSource, "true"))

// obtain the escrow address for the source channel end
escrowAddress := types.GetEscrowAddress(sourcePort, sourceChannel)
if err := k.escrowCoin(ctx, sender, escrowAddress, coin); err != nil {
return 0, err
}
}

tokens = append(tokens, token)
Expand Down Expand Up @@ -204,8 +205,8 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
//
// NOTE: We use SourcePort and SourceChannel here, because the counterparty
// chain would have prefixed with DestPort and DestChannel when originally
// receiving this coin as seen in the "sender chain is the source" condition.
if token.Denom.ReceiverChainIsSource(packet.GetSourcePort(), packet.GetSourceChannel()) {
// receiving this token.
if token.Denom.HasPrefix(packet.GetSourcePort(), packet.GetSourceChannel()) {
// sender chain is not the source, unescrow tokens

// remove prefix added by sender chain
Expand Down Expand Up @@ -356,29 +357,28 @@ func (k Keeper) refundPacketTokens(ctx sdk.Context, packet channeltypes.Packet,
return err
}

if token.Denom.SenderChainIsSource(packet.GetSourcePort(), packet.GetSourceChannel()) {
// if the token we must refund is prefixed by the source port and channel
// then the tokens were burnt when the packet was sent and we must mint new tokens
if token.Denom.HasPrefix(packet.GetSourcePort(), packet.GetSourceChannel()) {
// mint vouchers back to sender
if err := k.bankKeeper.MintCoins(
ctx, types.ModuleName, sdk.NewCoins(coin),
); err != nil {
return err
}

if k.isBlockedAddr(sender) {
return errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "%s is not allowed to send funds", sender)
}
if err := k.bankKeeper.SendCoins(ctx, moduleAccountAddr, sender, sdk.NewCoins(coin)); err != nil {
panic(fmt.Errorf("unable to send coins from module to account despite previously minting coins to module account: %v", err))
}
} else {
// unescrow tokens back to sender
escrowAddress := types.GetEscrowAddress(packet.GetSourcePort(), packet.GetSourceChannel())
if err := k.unescrowCoin(ctx, escrowAddress, sender, coin); err != nil {
return err
}

// Continue processing rest of tokens in packet data.
continue
}

// mint vouchers back to sender
if err := k.bankKeeper.MintCoins(
ctx, types.ModuleName, sdk.NewCoins(coin),
); err != nil {
return err
}

if k.isBlockedAddr(sender) {
return errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "%s is not allowed to send funds", sender)
}
if err := k.bankKeeper.SendCoins(ctx, moduleAccountAddr, sender, sdk.NewCoins(coin)); err != nil {
panic(fmt.Errorf("unable to send coins from module to account despite previously minting coins to module account: %v", err))
}
}

Expand Down
19 changes: 5 additions & 14 deletions modules/apps/transfer/types/denom.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,15 @@ func (d Denom) IsNative() bool {
return len(d.Trace) == 0
}

// SenderChainIsSource returns false if the denomination originally came
// from the receiving chain and true otherwise.
func (d Denom) SenderChainIsSource(sourcePort, sourceChannel string) bool {
// sender chain is source, if the receiver is not source
return !d.ReceiverChainIsSource(sourcePort, sourceChannel)
}

// ReceiverChainIsSource returns true if the denomination originally came
// from the receiving chain and false otherwise.
func (d Denom) ReceiverChainIsSource(sourcePort, sourceChannel string) bool {
// if the denom is native, then the receiver chain cannot be source
// HasPrefix returns true if the first element of the trace of the denom
// matches the provided portId and channelId.
func (d Denom) HasPrefix(portID, channelID string) bool {
// if the denom is native, then it is not prefixed by any port/channel pair
if d.IsNative() {
return false
}

// if the receiver chain originally sent the token to the sender chain, then the first element of
// the denom's trace (latest trace) will contain the SourcePort and SourceChannel.
return d.Trace[0].PortId == sourcePort && d.Trace[0].ChannelId == sourceChannel
return d.Trace[0].PortId == portID && d.Trace[0].ChannelId == channelID
}

// Denoms defines a wrapper type for a slice of Denom.
Expand Down
13 changes: 6 additions & 7 deletions modules/apps/transfer/types/denom_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ func (suite *TypesTestSuite) TestSort() {

func (suite *TypesTestSuite) TestDenomChainSource() {
testCases := []struct {
name string
denom types.Denom
sourcePort string
sourceChannel string
expReceiverChainIsSource bool
name string
denom types.Denom
sourcePort string
sourceChannel string
expHasPrefix bool
}{
{
"sender chain is source: empty trace",
Expand Down Expand Up @@ -235,8 +235,7 @@ func (suite *TypesTestSuite) TestDenomChainSource() {
for _, tc := range testCases {
tc := tc
suite.Run(tc.name, func() {
suite.Require().Equal(tc.expReceiverChainIsSource, tc.denom.ReceiverChainIsSource(tc.sourcePort, tc.sourceChannel))
suite.Require().Equal(!tc.expReceiverChainIsSource, tc.denom.SenderChainIsSource(tc.sourcePort, tc.sourceChannel))
suite.Require().Equal(tc.expHasPrefix, tc.denom.HasPrefix(tc.sourcePort, tc.sourceChannel))
})
}
}

0 comments on commit b1743e0

Please sign in to comment.