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

add option to return raw txn effects on fullnode #15729

Merged
merged 2 commits into from
Jan 18, 2024
Merged

Conversation

emmazzz
Copy link
Contributor

@emmazzz emmazzz commented Jan 16, 2024

Description

Add an option to return raw transaction effects via transaction execution api on fullnode so that graphql can use it. See discussion on the gql PR #15717.

Test Plan

Existing tests

If your changes are not user-facing and do not break anything, you can skip the following section. Otherwise, please briefly describe what has changed under the Release Notes section.

Type of Change (Check all that apply)

  • protocol change
  • 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

Adds an option to SuiTransactionBlockResponseOptions to return the raw transaction effects.

Copy link

vercel bot commented Jan 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
mysten-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 18, 2024 0:19am
sui-core ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 18, 2024 0:19am
sui-typescript-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 18, 2024 0:19am
3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
explorer ⬜️ Ignored (Inspect) Visit Preview Jan 18, 2024 0:19am
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Jan 18, 2024 0:19am
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Jan 18, 2024 0:19am

@emmazzz emmazzz marked this pull request as ready for review January 16, 2024 21:21
@@ -120,6 +122,7 @@ impl SuiTransactionBlockResponseOptions {
show_events: true,
show_object_changes: true,
show_balance_changes: true,
show_raw_effects: true,
Copy link
Contributor

@longbowlu longbowlu Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will break existing clients that use full_content, because they will get unexpected raw_effects?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you recommend then? To have show_raw_effects: false here? Then it's not longer full content..

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah this wasn't written in a way that is future proof unfortunately. But from (existing) users' perspective, if they don't expect this field, it's fine to mark it as false. We can add a special comment explaining it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in the latest commit.

@emmazzz emmazzz merged commit e96898c into main Jan 18, 2024
41 checks passed
@emmazzz emmazzz deleted the emma/add-raw-fx branch January 18, 2024 00:56
wlmyng pushed a commit that referenced this pull request Jan 19, 2024
## Description 

Add an option to return raw transaction effects via transaction
execution api on fullnode so that graphql can use it. See discussion on
the gql PR #15717.

## Test Plan 

Existing tests
---
If your changes are not user-facing and do not break anything, you can
skip the following section. Otherwise, please briefly describe what has
changed under the Release Notes section.

### 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

Add an option to SuiTransactionBlockResponseOptions to return the raw
transaction effects.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants