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

feat(graphql)!: deprecate tx signer filters #19430

Merged
merged 4 commits into from
Sep 18, 2024
Merged

feat(graphql)!: deprecate tx signer filters #19430

merged 4 commits into from
Sep 18, 2024

Conversation

amnn
Copy link
Contributor

@amnn amnn commented Sep 18, 2024

Description

TransactionBlockFilter.signAddress and AddressTransactionBlockFilter.SIGN both claim to support filtering by sender and sponsor, but this is not true, they only support sender, and they should not be adapted to also filter by sponsor because we rely on the there being only one sender per transaction to ensure filters that combine sender with something else remain both space and time efficient.

Test plan

Existing tests and CI, plus some new tests to make sure the new filter options work, and interactions between the old and new filters work.

sui$ cargo nextest run -p sui-graphql-rpc
sui$ cargo nextest run -p sui-graphql-e2e-tests

Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL: Deprecates TransactionBlockFilter.signAddress, replacing it with TransactionBlockFilter.sentAddress which behaves identically. Similarly AddressTransactionBlockRelationship.SIGN is deprecated and replaced by AddressTransactionBlockRelationship.SENT.
  • CLI:
  • Rust SDK:
  • REST API:

Copy link

vercel bot commented Sep 18, 2024

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

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2024 9:03pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Sep 18, 2024 9:03pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Sep 18, 2024 9:03pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Sep 18, 2024 9:03pm

@amnn
Copy link
Contributor Author

amnn commented Sep 18, 2024

Note that I am going through the deprecation process mostly to try it out, not because we need to.

Base automatically changed from amnn/tx-affected-gql to main September 18, 2024 15:59
## Description

`TransactionBlockFilter.signAddress` and
`AddressTransactionBlockFilter.SIGN` both claim to support filtering by
sender and sponsor, but this is not true, they only support sender, and
they should not be adapted to also filter by sponsor because we rely on
the there being only one sender per transaction to ensure filters that
combine sender with something else remain both space and time efficient.

## Test plan

Existing tests and CI, plus some new tests to make sure the new filter
options work, and interactions between the old and new filters work.

```
sui$ cargo nextest run -p sui-graphql-rpc
sui$ cargo nextest run -p sui-graphql-e2e-tests
```
This reverts commit f47be8b10a9801be261fc94b06bfd7e73179702d.
Copy link
Contributor

@stefan-mysten stefan-mysten left a comment

Choose a reason for hiding this comment

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

👍

@amnn amnn merged commit 81e9fdb into main Sep 18, 2024
47 of 48 checks passed
@amnn amnn deleted the amnn/tx-no-signer branch September 18, 2024 22:00
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