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

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

Merged
merged 8 commits into from
Aug 23, 2023
+15 −0
Merged

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

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d53c5e2
docs(callbacks): added godocs for send packet validation
srdtrk Aug 16, 2023
5e43a59
docs(callbacks): improved godocs
srdtrk Aug 16, 2023
a8723b7
Merge branch 'main' into serdar/issue#4326-add-godoc-for-callback-val…
srdtrk Aug 17, 2023
be000d1
Merge branch 'main' into serdar/issue#4326-add-godoc-for-callback-val…
srdtrk Aug 21, 2023
a48432b
merge: branch 'main' into serdar/issue#4326-add-godoc-for-callback-va…
srdtrk Aug 22, 2023
f7972ae
docs(callbacks): used colin and damian suggested doc string
srdtrk Aug 22, 2023
58b40cd
docs(callbacks): fixed typo
srdtrk Aug 22, 2023
0e1aebd
docs(callbacks): improved a minor typo
srdtrk Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions modules/apps/callbacks/types/expected_keepers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ type ContractKeeper interface {
// gas limit, and handle any errors, or panics gracefully.
// If an error is returned, the transaction will be reverted by the callbacks middleware, and the
// packet will not be sent.
//
// Implementations are provided with the packetSendAddress and MAY choose to use this to perform
// validation on the origin of a given packet. It is recommended to perform the same validation
// on all source chain callbacks (SendPacket, AcknowledgementPacket, TimeoutPacket). This
// defensively guards against exploits due to incorrectly wired SendPacket ordering in IBC stacks.
IBCSendPacketCallback(
ctx sdk.Context,
sourcePort string,
Expand All @@ -31,6 +36,11 @@ 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.
//
// Implementations are provided with the packetSendAddress and MAY choose to use this to perform
// validation on the origin of a given packet. It is recommended to perform the same validation
// on all source chain callbacks (SendPacket, AcknowledgementPacket, TimeoutPacket). This
// defensively guards against exploits due to incorrectly wired SendPacket ordering in IBC stacks.
IBCOnAcknowledgementPacketCallback(
ctx sdk.Context,
packet channeltypes.Packet,
Expand All @@ -44,6 +54,11 @@ 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.
//
// Implementations are provided with the packetSendAddress and MAY choose to use this to perform
// validation on the origin of a given packet. It is recommended to perform the same validation
// on all source chain callbacks (SendPacket, AcknowledgementPacket, TimeoutPacket). This
// defensively guards against exploits due to incorrectly wired SendPacket ordering in IBC stacks.
IBCOnTimeoutPacketCallback(
ctx sdk.Context,
packet channeltypes.Packet,
Expand Down