Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement ICS-721 NFT transfer #1020

Merged

Conversation

yito88
Copy link
Contributor

@yito88 yito88 commented Dec 28, 2023

Closes: #346

Description

Implement ICS-721
Depends on ibc-proto-rs with proto imported from https://github.com/bianjieai/nft-transfer


PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests.
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

Copy link

codecov bot commented Dec 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (feat/ics721-impl@c609f7e). Click here to learn what that means.

❗ Current head 8dfda81 differs from pull request most recent head 8f213ed. Consider uploading reports for the commit 8f213ed to get more accurate results

Additional details and impacted files
@@                 Coverage Diff                 @@
##             feat/ics721-impl    #1020   +/-   ##
===================================================
  Coverage                    ?   67.23%           
===================================================
  Files                       ?      196           
  Lines                       ?    19908           
  Branches                    ?        0           
===================================================
  Hits                        ?    13386           
  Misses                      ?     6522           
  Partials                    ?        0           

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

Copy link
Member

@Farhad-Shabani Farhad-Shabani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @yito88. This is fantastic! Thanks a bunch for this awesome contribution. I have dropped some comments. Let me know if you needed any clarification.

ibc-apps/ics721-nft-transfer/types/src/msgs/transfer.rs Outdated Show resolved Hide resolved
ibc-apps/ics721-nft-transfer/types/src/msgs/transfer.rs Outdated Show resolved Hide resolved
ibc-apps/ics721-nft-transfer/types/src/class.rs Outdated Show resolved Hide resolved
ibc-apps/ics721-nft-transfer/types/src/class.rs Outdated Show resolved Hide resolved
ibc-apps/ics721-nft-transfer/types/src/class.rs Outdated Show resolved Hide resolved
ibc-apps/ics721-nft-transfer/types/Cargo.toml Outdated Show resolved Hide resolved
ibc-apps/ics721-nft-transfer/src/module.rs Show resolved Hide resolved
Comment on lines +210 to +217
let transfer_event = TransferEvent {
sender: packet_data.sender,
receiver: packet_data.receiver,
class: packet_data.class_id,
tokens: packet_data.token_ids,
memo: packet_data.memo,
};
send_packet_ctx_a.emit_ibc_event(ModuleEvent::from(transfer_event).into())?;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This TransferEvent does not align with the one here. While ours looks better and is more descriptive, I am concerned that this discrepancy could pose challenges for relayers getting varying transfer events. wdyt?

ibc-apps/ics721-nft-transfer/src/context.rs Outdated Show resolved Hide resolved
@yito88
Copy link
Contributor Author

yito88 commented Jan 4, 2024

@Farhad-Shabani Thank you for reviewing!
I'm integrating this ibc-rs into Namada for testing. Your questions about no_std and the transfer event will be checked in the integration.

@Farhad-Shabani Farhad-Shabani merged commit 7e8c98f into cosmos:feat/ics721-impl Jan 4, 2024
8 of 11 checks passed
@adizere adizere linked an issue Jan 5, 2024 that may be closed by this pull request
5 tasks
Farhad-Shabani pushed a commit that referenced this pull request Jan 6, 2024
* WIP: add types and contexts

* WIP: add events

* WIP: implement modules

* add send_transfer

* add recv and refund handlers

* add tests

* fix send and recv

* fix context and add tests

* fix fmt

* fix for CI

* fix messages and serde

* fix comments
Farhad-Shabani added a commit that referenced this pull request Jan 24, 2024
* feat: establish ICS-721 boilerplate, ready for new additions (#1012)

* chore: establish ics721 boilerplate, ready for new additions

* nit

* Implement ICS-721 NFT transfer (#1020)

* WIP: add types and contexts

* WIP: add events

* WIP: implement modules

* add send_transfer

* add recv and refund handlers

* add tests

* fix send and recv

* fix context and add tests

* fix fmt

* fix for CI

* fix messages and serde

* fix comments

* Add (de)serialization tests for `DataValue`, `TokenUri`, and `ClassUri` types (#1027)

* WIP: add types and contexts

* WIP: add events

* WIP: implement modules

* add send_transfer

* add recv and refund handlers

* add tests

* fix send and recv

* fix context and add tests

* fix fmt

* fix for CI

* fix messages and serde

* fix comments

* Stub out DataValue Borsh unit test

* Add basic borsh (de)ser roundtrip tests

* Add basic serde roundtrip tests for DataValue

* Add json (de)serialization tests

* Add roundtrip tests for TokenUri

* Add roundtrip tests for ClassUri

* Remove ignore statement on a test

* Resolve clippy warning

* Change packet data dummy json strings to use camel case

* Configure nft-transfer app under std feature flag

* Move cfg statement

* Add nft-transfer feature

* Add nft-transfer feature

* Remove nft-transfer feature from default features

* Remove `optional = true` from `http` dependency

---------

Co-authored-by: yito88 <[email protected]>

* fix: calculate trace hash from both class ID and token ID (#1032)

* trace hash with class ID and token ID

* add serde flag

* Fix ClassData and TokenData encoding in NonFungiblePacketData (#1038)

* fix encoding for ClassData and TokenData

* fix Cargo.toml

* Support ClassData and TokenData not according to ICS-721 spec (#1039)

* skip validation, make some data optional

* check the length of token_uri and token_data

* fix to set TokenData and TokenUri at once

* imp: add validate_basic method for PacketData

* imp: allow any format for Data + define parse_as_ics721_data method

* fmt and clippy

* custom serde packet data with option

* add a test

* restore conversions

---------

Co-authored-by: Farhad Shabani <[email protected]>

* chore: add unclog

* nit: fix docstrings

---------

Co-authored-by: Yuji Ito <[email protected]>
Co-authored-by: Sean Chen <[email protected]>
Co-authored-by: yito88 <[email protected]>
Farhad-Shabani added a commit that referenced this pull request Sep 9, 2024
* feat: establish ICS-721 boilerplate, ready for new additions (#1012)

* chore: establish ics721 boilerplate, ready for new additions

* nit

* Implement ICS-721 NFT transfer (#1020)

* WIP: add types and contexts

* WIP: add events

* WIP: implement modules

* add send_transfer

* add recv and refund handlers

* add tests

* fix send and recv

* fix context and add tests

* fix fmt

* fix for CI

* fix messages and serde

* fix comments

* Add (de)serialization tests for `DataValue`, `TokenUri`, and `ClassUri` types (#1027)

* WIP: add types and contexts

* WIP: add events

* WIP: implement modules

* add send_transfer

* add recv and refund handlers

* add tests

* fix send and recv

* fix context and add tests

* fix fmt

* fix for CI

* fix messages and serde

* fix comments

* Stub out DataValue Borsh unit test

* Add basic borsh (de)ser roundtrip tests

* Add basic serde roundtrip tests for DataValue

* Add json (de)serialization tests

* Add roundtrip tests for TokenUri

* Add roundtrip tests for ClassUri

* Remove ignore statement on a test

* Resolve clippy warning

* Change packet data dummy json strings to use camel case

* Configure nft-transfer app under std feature flag

* Move cfg statement

* Add nft-transfer feature

* Add nft-transfer feature

* Remove nft-transfer feature from default features

* Remove `optional = true` from `http` dependency

---------

Co-authored-by: yito88 <[email protected]>

* fix: calculate trace hash from both class ID and token ID (#1032)

* trace hash with class ID and token ID

* add serde flag

* Fix ClassData and TokenData encoding in NonFungiblePacketData (#1038)

* fix encoding for ClassData and TokenData

* fix Cargo.toml

* Support ClassData and TokenData not according to ICS-721 spec (#1039)

* skip validation, make some data optional

* check the length of token_uri and token_data

* fix to set TokenData and TokenUri at once

* imp: add validate_basic method for PacketData

* imp: allow any format for Data + define parse_as_ics721_data method

* fmt and clippy

* custom serde packet data with option

* add a test

* restore conversions

---------

Co-authored-by: Farhad Shabani <[email protected]>

* chore: add unclog

* nit: fix docstrings

---------

Co-authored-by: Yuji Ito <[email protected]>
Co-authored-by: Sean Chen <[email protected]>
Co-authored-by: yito88 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Implement ICS 721: NFT transfer on ibc-rs
2 participants