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.

Sign up for GitHub

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

Jump to bottom

Add documentation for the interfaces required by the callbacks module #3350

Closed
3 tasks
colin-axner opened this issue Mar 27, 2023 · 2 comments · Fixed by #4435
Closed
3 tasks

Add documentation for the interfaces required by the callbacks module #3350

colin-axner opened this issue Mar 27, 2023 · 2 comments · Fixed by #4435
Assignees
@DimitrisJim @colin-axner @srdtrk
Labels
adr8 callbacks middleware Issues for callbacks middleware docs Improvements or additions to documentation
Milestone
callbacks/v1.0.0

Comments

@colin-axner
Copy link
Contributor

Summary

With the CallbacksPacketData interface introduced in #3287 we should add user facing documentation explaining its usage and how it might be implemented by an IBC app

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged/assigned
@colin-axner colin-axner added the docs Improvements or additions to documentation label Mar 27, 2023
@colin-axner colin-axner mentioned this issue Mar 27, 2023
Merged
9 tasks
@crodriguezvega crodriguezvega added this to the v7.3.0 milestone Jul 18, 2023
@crodriguezvega crodriguezvega mentioned this issue Jul 24, 2023
Closed
9 tasks
@colin-axner
Copy link
Contributor Author

I guess we can add docs on how to implement the added interface functions:

  • UnmarshalPacketData,
  • GetSender
  • GetCustomPacketData

@colin-axner colin-axner changed the title Add documentation for implementing the CallbacksPacketData interface Add documentation for the interfaces required by the callbacks module Jul 31, 2023
@colin-axner
Copy link
Contributor Author

Document interfaces callbacks module depends and the interfaces it defines

@srdtrk srdtrk added callbacks middleware Issues for callbacks middleware adr8 labels Aug 15, 2023
@crodriguezvega crodriguezvega mentioned this issue Aug 20, 2023
Merged
9 tasks
@colin-axner colin-axner mentioned this issue Aug 23, 2023
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DimitrisJim DimitrisJim

@colin-axner colin-axner

@srdtrk srdtrk

Labels
adr8 callbacks middleware Issues for callbacks middleware docs Improvements or additions to documentation
Projects
ibc-go
Archived in project
Milestone
callbacks/v1.0.0
5 participants
@crodriguezvega @DimitrisJim @charleenfei @colin-axner @srdtrk