Skip to content

Create docs for the TS SDK's queryEvents and queryTransactionBlocks #6802

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Create docs for the TS SDK's queryEvents and queryTransactionBlocks #6802

wants to merge 5 commits into from

Conversation

vivekjain23
Copy link
Contributor

Description of change

This PR brings up usages example of queryEvent and query.

Links to any relevant issues

fixes #5169

Type of change

  • Enhancement (a non-breaking change which adds functionality)

How the change has been tested

changes were built locally.

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@vercel Vercel
Copy link

vercel bot commented May 8, 2025 •
edited
Loading

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

4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
apps-backend ⬜️ Ignored (Inspect) Visit Preview May 20, 2025 11:11am
apps-ui-kit ⬜️ Ignored (Inspect) Visit Preview May 20, 2025 11:11am
rebased-explorer ⬜️ Ignored (Inspect) Visit Preview May 20, 2025 11:11am
wallet-dashboard ⬜️ Ignored (Inspect) Visit Preview May 20, 2025 11:11am

@vivekjain23 vivekjain23 marked this pull request as ready for review May 8, 2025 07:55
@vivekjain23 vivekjain23 requested a review from a team as a code owner May 8, 2025 07:55
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 8, 2025
@iota-ci iota-ci added the devx Issues related to the DevX team label May 8, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 8, 2025

✅ Vercel Preview Deployment is ready!

View Preview

@github-project-automation github-project-automation bot moved this to Product Backlog in Developer Experience May 15, 2025
@vivekjain23 vivekjain23 moved this from Product Backlog to Under Review in Developer Experience May 15, 2025
Ginowine
Ginowine approved these changes May 15, 2025
View reviewed changes
Copy link
Contributor

@Ginowine Ginowine left a comment

Choose a reason for hiding this comment

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

Great explanation and examples. LGTM.

@vivekjain23 vivekjain23 requested a review from Thoralf-M May 19, 2025 10:49
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Thoralf-M
Thoralf-M reviewed May 19, 2025
View reviewed changes
docs/content/developer/iota-101/using-events.mdx
Comment on lines +297 to +300
MoveModule: {
package: '0x0000000000000000000000000000000000000000000000000000000000000002',
module: 'display',
},
Copy link
Member

@Thoralf-M Thoralf-M May 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Testnet doesn't seem to have an event with display, would be good to actually have something in the output and not just an empty array

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I checked it here
https://explorer.iota.org/object/0x0000000000000000000000000000000000000000000000000000000000000002?module=display&network=testnet

Copy link
Member

Choose a reason for hiding this comment

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

What did you check there? The transactions listed there interacted with the iota framework, but there is none that created a move event with the display module

Copy link
Member

Choose a reason for hiding this comment

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

If you use module: 'kiosk', you get some actual events

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@vivekjain23 vivekjain23 requested a review from Thoralf-M May 20, 2025 09:52
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Thoralf-M
Thoralf-M reviewed May 20, 2025
View reviewed changes
docs/content/developer/iota-101/using-events.mdx
query: {
MoveModule: {
package: '0x0000000000000000000000000000000000000000000000000000000000000002',
module: 'display',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
module: 'display',
module: 'kiosk',

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Thoralf-M Thoralf-M Thoralf-M left review comments

@Ginowine Ginowine Ginowine approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation
Projects
Developer Experience
Status: Under Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create docs for the TS SDK's queryEvents and queryTransactionBlocks
4 participants
@vivekjain23 @Ginowine @Thoralf-M @iota-ci