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

docs(callbacks): added godocs for defensive send packet validation #4358

Merged
merged 8 commits into from
Aug 23, 2023
Prev Previous commit
Next Next commit
docs(callbacks): improved godocs
  • Loading branch information
srdtrk committed Aug 16, 2023
commit 5e43a5908ed171057d4e1e7507492ad67833dcb3
8 changes: 4 additions & 4 deletions modules/apps/callbacks/types/expected_keepers.go
Original file line number Diff line number Diff line change
@@ -31,8 +31,8 @@ type ContractKeeper interface {
// the sender is unknown or undefined. The contract is expected to handle the callback within the
// user defined gas limit, and handle any errors, or panics gracefully.
// If an error is returned, state will be reverted by the callbacks middleware.
// NOTE: Performing the SendPacket validation in this acknowledgement callback is recommended in
// case the callbacks middleware is not wired properly.
// NOTE: Performing the SendPacket validation defensively in this acknowledgement callback is
// recommended in case the callbacks middleware is not wired properly.
IBCOnAcknowledgementPacketCallback(
ctx sdk.Context,
packet channeltypes.Packet,
@@ -46,8 +46,8 @@ type ContractKeeper interface {
// empty if the sender is unknown or undefined. The contract is expected to handle the callback
// within the user defined gas limit, and handle any error, out of gas, or panics gracefully.
// If an error is returned, state will be reverted by the callbacks middleware.
// NOTE: Performing the SendPacket validation in this timeout callback is recommended in case the
// callbacks middleware is not wired properly.
// NOTE: Performing the SendPacket validation defensively in this timeout callback is recommended
// in case the callbacks middleware is not wired properly.
IBCOnTimeoutPacketCallback(
ctx sdk.Context,
packet channeltypes.Packet,