[framework] don't emit event on purchase with PurchaseCap #12821
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 6 Ignored Deployments
|
amnn
approved these changes
Jul 4, 2023
|
@damirka, we're trying out an extra step in the release process for user facing changes, where we ping @randall-Mysten / @ronny-mysten on the docs channel to review the release notes before the change lands as well -- could you do that before landing please? Change looks good! |
|
I updated the Release notes section. Let me know if something doesn't make sense. |
ronny-mysten
approved these changes
Jul 4, 2023
damirka
force-pushed
the
ds-kiosk-dont-emit-event-on-pcap
branch
from
8504574 to
2bef4a8
Compare
longbowlu
pushed a commit
that referenced
this pull request
Jul 6, 2023
## Motivation PurchaseCap functionality is created specifically for extensions and logic which may or may not be considered trading. And emitting an event when "purchasing" with the Cap breaks indexers and makes little sense - ItemListed is not emitted, ItemDelisted as well. Currently, all extensions rely on custom events for this purpose. ## Description Changes the body of the `kiosk::purchase_with_cap` to NOT emit the ItemPurchased event. Everything else is left intact. ## Test Plan Current tests pass. ### Type of Change (Check all that apply) - [ ] protocol change - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes - The `kiosk::purchase_with_cap` method for [Sui Kiosk](https://docs.sui.io/build/sui-kiosk) no longer emits the `ItemPurchased` event. This is a network optimization update that should have minimal impact. If the logic of your application does rely on this event, you must change it to leverage custom events instead.
ebmifa
pushed a commit
that referenced
this pull request
Jul 12, 2023
## Motivation PurchaseCap functionality is created specifically for extensions and logic which may or may not be considered trading. And emitting an event when "purchasing" with the Cap breaks indexers and makes little sense - ItemListed is not emitted, ItemDelisted as well. Currently, all extensions rely on custom events for this purpose. ## Description Changes the body of the `kiosk::purchase_with_cap` to NOT emit the ItemPurchased event. Everything else is left intact. ## Test Plan Current tests pass. ### Type of Change (Check all that apply) - [ ] protocol change - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes - The `kiosk::purchase_with_cap` method for [Sui Kiosk](https://docs.sui.io/build/sui-kiosk) no longer emits the `ItemPurchased` event. This is a network optimization update that should have minimal impact. If the logic of your application does rely on this event, you must change it to leverage custom events instead.
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.
Motivation
PurchaseCap functionality is created specifically for extensions and logic which may or may not be considered trading. And emitting an event when "purchasing" with the Cap breaks indexers and makes little sense - ItemListed is not emitted, ItemDelisted as well.
Currently, all extensions rely on custom events for this purpose.
Description
Changes the body of the
kiosk::purchase_with_capto NOT emit the ItemPurchased event. Everything else is left intact.Test Plan
Current tests pass.
Type of Change (Check all that apply)
Release notes
kiosk::purchase_with_capmethod for Sui Kiosk no longer emits theItemPurchasedevent. This is a network optimization update that should have minimal impact. If the logic of your application does rely on this event, you must change it to leverage custom events instead.