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

2596 oxfrod rpc returned type update #2652

Merged
merged 9 commits into from
Sep 18, 2023

Conversation

hui-an-yang
Copy link
Collaborator

@hui-an-yang hui-an-yang commented Sep 12, 2023

  • removed unsupported rpc getTxRollupState & getTxRollupInbox
  • updated rpc entry points getBlock, getBlockMetadata, preapplyOperations, runOperation, simulateOperation with RPCOptions version . Default { version: '0' } will show kind endorsement; { version: '1' } will show kind attestation.
  • updated rpc entrypoint getPendingOperation with RPCOptions version. Default { version: '1' } will show { applied: { kind: 'endorsement' } }; { version: '2 } will show { validated: { kind: 'attestation' } }

closes #2596
Thank you for your contribution to Taquito.

Before submitting this PR, please make sure:

  • Your code builds cleanly without any errors or warnings
  • You have run the linter against the changes
  • You have added unit tests (if relevant/appropriate)
  • You have added integration tests (if relevant/appropriate)
  • All public methods or types have TypeDoc coverage with a complete description, and ideally an @example
  • You have added or updated corresponding documentation
  • If relevant, you have written a first draft summary describing the change for inclusion in Release Notes.

In this PR, please also make sure:

  • You have linked this PR to the issue by putting closes #TICKETNUMBER in the description box (when applicable)
  • You have added a concise description on your changes

Release Note Draft Snippet

If relevant, please write a summary of your change that will be suitable for
inclusion in the Release Notes for the next Taquito release.

@hui-an-yang hui-an-yang linked an issue Sep 12, 2023 that may be closed by this pull request
6 tasks
@github-actions
Copy link

github-actions bot commented Sep 12, 2023

New packages have been deployed to the preview repository at https://npm.preview.tezostaquito.io/.

Published packages:

npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/

*/
async getBlock({ block }: RPCOptions = defaultRPCOptions): Promise<BlockResponse> {
async getBlock({ block, version }: RPCOptions = defaultRPCOptions): Promise<BlockResponse> {
Copy link
Contributor

Choose a reason for hiding this comment

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

There can be a design decision here: If we go with the current design, the calls to getBlock will need to have a version included forever. Another design might be to have an RPC_VERSION setting somewhere that affects this. Then the dapp can set that in one place and forget about it.

@hui-an-yang hui-an-yang marked this pull request as ready for review September 14, 2023 16:10
@hui-an-yang hui-an-yang merged commit 1cdaf6a into oxford Sep 18, 2023
4 of 7 checks passed
@hui-an-yang hui-an-yang deleted the 2596-oxfrod-rpc-returned-type-update branch September 18, 2023 20:24
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.

Update return types coming from the RPC
2 participants