feat: Add TrackBeforeSend , BlockBeforeSend hooks. Deprecate BeforeSend hook
#421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattverse
changed the title
TrackBeforeSend , BlockBeforeSend hooks. Deprecate BeforeSend hookTrackBeforeSend , BlockBeforeSend hooks. Deprecate BeforeSend hook
nicolaslara
reviewed
Mar 8, 2023
nicolaslara
reviewed
Mar 8, 2023
| @@ -237,12 +238,14 @@ func (k BaseKeeper) UndelegateCoins(ctx sdk.Context, moduleAccAddr, delegatorAdd | |||
| return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, amt.String()) | |||
| } | |||
|
|
|||
| // call the BeforeSend hooks | |||
| err := k.BeforeSend(ctx, moduleAccAddr, delegatorAddr, amt) | |||
| // call the TrackBeforeSend hooks and the BlockBeforeSend hooks | |||
There was a problem hiding this comment.
Q unrelated to this PR: Do we know why Delegate/UndelegateCoins manages the coins directly instead of using SendCoins under the hood? Seems like it would be a better abstraction and the hooks could just be in SendCoins
There was a problem hiding this comment.
potentially because of security issue, I have no ide. Good point tho
nicolaslara
approved these changes
Mar 8, 2023
There was a problem hiding this comment.
left some minor comments, but this LGTM. I'm not a fan of the imperative in the function names here ("track", "block") as it seems like we're doing the action when that gets called, but couldn't come up with good alternatives. My best idea is "tracking" and "blocking" but still not great
Co-authored-by: Nicolas Lara <nicolaslara@gmail.com>
mattverse
added a commit
that referenced
this pull request
Mar 13, 2023
…oreSend` hook (#421) * Add separated hooks for bank send * Update x/bank/keeper/hooks.go Co-authored-by: Nicolas Lara <nicolaslara@gmail.com> --------- Co-authored-by: Nicolas Lara <nicolaslara@gmail.com>
This was referenced Mar 13, 2023
czarcas7ic
pushed a commit
that referenced
this pull request
Oct 4, 2023
…oreSend` hook (#421) * Add separated hooks for bank send * Update x/bank/keeper/hooks.go Co-authored-by: Nicolas Lara <nicolaslara@gmail.com> --------- Co-authored-by: Nicolas Lara <nicolaslara@gmail.com>
czarcas7ic
pushed a commit
that referenced
this pull request
Oct 30, 2023
…oreSend` hook (#421) * Add separated hooks for bank send * Update x/bank/keeper/hooks.go Co-authored-by: Nicolas Lara <nicolaslara@gmail.com> --------- Co-authored-by: Nicolas Lara <nicolaslara@gmail.com>
czarcas7ic
pushed a commit
that referenced
this pull request
Nov 7, 2023
…oreSend` hook (#421) * Add separated hooks for bank send * Update x/bank/keeper/hooks.go Co-authored-by: Nicolas Lara <nicolaslara@gmail.com> --------- Co-authored-by: Nicolas Lara <nicolaslara@gmail.com>
This was referenced Dec 1, 2023
This was referenced Dec 15, 2023
This was referenced Jan 1, 2024
This was referenced Jan 15, 2024
This was referenced Feb 1, 2024
This was referenced Feb 15, 2024
This was referenced Mar 1, 2024
This was referenced Mar 15, 2024
This was referenced Apr 1, 2024
This was referenced Apr 15, 2024
This was referenced May 1, 2024
czarcas7ic
pushed a commit
that referenced
this pull request
May 9, 2024
…oreSend` hook (#421) * Add separated hooks for bank send * Update x/bank/keeper/hooks.go Co-authored-by: Nicolas Lara <nicolaslara@gmail.com> --------- Co-authored-by: Nicolas Lara <nicolaslara@gmail.com>
This was referenced May 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This PR adds
TrackBeforeSendhook andBlockBeforeSendhook, and deprecatesBeforeSendhook.Each hook, respectively would call the hook that has been registered from a different module.
The difference between the two new hooks being introduced is that
TrackBeforesendhook does not have the ability to cause any effect, as it does not emit errors. Meanwhile,BlockBeforeSenddoes emit errors, allowing connected hooks to stop and block the send.Additional method
SendCoinsWithoutBlockHookhas also been added along with the two hooks, as for module <> module transfers, we want to ensure it does not get blocked by external hooks.Brief Changelog
Add
TrackBeforeSend,BlockBeforeSendhooks. DeprecateBeforeSendhookTesting and Verifying
This change adds tests
Documentation and Release Note
Unreleasedsection inCHANGELOG.md? (yes / no)x/<module>/spec/) / Osmosis docs repo / not documented)