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

graphql: Remove TransactionBlockFilter.signAddress and AddressTransactionBlockRelationship.SIGN #19804

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

amnn
Copy link
Member

@amnn amnn commented Oct 10, 2024

Description

Formally remove

  • TransactionBlockFilter.signAddress and
  • AddressTransactionBlockRelationship.SIGN

which were deprecated two releases ago. They have been replaced by

  • TransactionBlockFilter.sentAddress and
  • AddressTransactionBlockRelationship.SENT

which offer the same features under clearer names.

Test plan

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

Stack


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: Formally remove TransactionBlockFilter.signAddress and AddressTransactionBlockRelationship.SIGN which were deprecated two releases ago. They have been replaced by TransactionBlockFilter.sentAddress and AddressTransactionBlockRelationship.SENT which offer the same features under clearer names.
  • CLI:
  • Rust SDK:
  • REST API:

@amnn amnn requested review from lxfind, bmwill and gegaowp October 10, 2024 20:38
@amnn amnn self-assigned this Oct 10, 2024
Copy link

vercel bot commented Oct 10, 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 Oct 11, 2024 3:29pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2024 3:29pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2024 3:29pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2024 3:29pm

Copy link
Contributor

@wlmyng wlmyng left a comment

Choose a reason for hiding this comment

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

signed sealed delivered

Base automatically changed from amnn/gql-rm-tx-send to main October 11, 2024 11:40
…tionBlockRelationship.SIGN

## Description

Formally remove

- `TransactionBlockFilter.signAddress` and
- `AddressTransactionBlockRelationship.SIGN`

which were deprecated two releases ago. They have been replaced by

- `TransactionBlockFilter.sentAddress` and
- `AddressTransactionBlockRelationship.SENT`

which offer the same features under clearer names.

## Test plan

```
sui$ cargo nextest run -p sui-graphql-rpc
sui$ cargo nextest run -p sui-graphql-rpc --features staging
sui$ cargo nextest run -p sui-graphql-e2e-tests
```
@amnn amnn requested a review from a team as a code owner October 11, 2024 15:27
@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Oct 11, 2024
@amnn amnn merged commit af39b6a into main Oct 11, 2024
49 checks passed
@amnn amnn deleted the amnn/gql-rm-sign-addr branch October 11, 2024 22:08
amnn added a commit that referenced this pull request Oct 11, 2024
…tionBlockRelation.RECV (#19805)

## Description

These fields were flagged for deprecation in 1.34 and have been replaced
in 1.35 by

- `TransactionBlockFilter.affectedAddress` and
- `AddressTransactionBlockRelation.AFFECTED`

Which offer a similar (but not exactly the same) semantics, but without
confusion around the sender address which was often also an implicit
recipient of a transaction.

## Test plan

```
sui$ cargo nextest run -p sui-graphql-rpc
sui$ cargo nextest run -p sui-graphql-rpc --features staging
sui$ cargo nextest run -p sui-graphql-e2e-tests
```

## Stack

- #19708 
- #19802 
- #19803 
- #19804 

---

## 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: 
- [x] GraphQL: `TransactionBlockFilter.recvAddress` and
`AddressTransactionBlockRelation.RECV` have been replace by
`TransactionBlockFilter.affectedAddress` and
`AddressTransactionBlockRelation.AFFECTED` which offer similar
semantics, but without confusion around the sender address which was
also often (but not always) an implicit recipient. Now we don't
distinguish between senders and recipients -- we only have senders and
"affected" addresses which were touched by the transaction in some way.
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
amnn added a commit that referenced this pull request Oct 14, 2024
## Description

All references to these fields have been removed from readers, so we can
stop keeping it up-to-date. Once this change lands, we can also clean
these tables from the schema.

## Test plan

```
sui$ cargo nextest run -p sui-indexer
```

## Stack

- #19708 
- #19802 
- #19803 
- #19804 
- #19805 

---

## 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): 
- [x] Indexer: Indexer no longer fills the `tx_sender` and
`tx_recipient` tables.
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants