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.

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

Include in docs how to check events #203

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Include in docs how to check events #203

wants to merge 1 commit into from

Conversation

alilloig
Copy link
Member

@alilloig alilloig commented Jan 20, 2023 •
edited

Closes #202

Description

Updates the sendTransaction of the docs to give a more detailed view on the result object that can be captured from the tx execution, giving some hints on how to check events from that

For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@alilloig alilloig added documentation Improvements or additions to documentation SC-Eng labels Jan 20, 2023
@alilloig alilloig self-assigned this Jan 20, 2023
@alilloig alilloig requested a review from a team as a code owner January 20, 2023 16:28
@alilloig alilloig linked an issue Jan 20, 2023 that may be closed by this pull request
Update docs to include how to deal with events #202
Open
@changeset-bot
Copy link

changeset-bot bot commented Jan 20, 2023

⚠️ No Changeset found

Latest commit: 4742546

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@alilloig
Copy link
Member Author

I would like the @onflow/fcl folks to take a look at the array returned by sendTransaction. For the first signature we suggest that it's an array containing result and errors [result, error] , while for the second signature we say it also includes an object call logs [result, error, logs] .

If I use the second signature and log the result I get

    [
      {
        blockId: '',
        status: 4,
        statusString: 'SEALED',
        statusCode: 0,
        errorMessage: '',
        events: [ [Object] ]
      },
      null
    ]

So I'd say the first one is true, but I'd love you folks to confirm that.

@alilloig
Copy link
Member Author

As always for docs a check on use of english from any native speaker will be highly appreciated!!

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

@alilloig alilloig

Labels
documentation Improvements or additions to documentation SC-Eng
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update docs to include how to deal with events
1 participant
@alilloig