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

Document the transaction object with examples for onTransaction #832

Open
Montoya opened this issue Jun 22, 2023 · 0 comments
Open

Document the transaction object with examples for onTransaction #832

Montoya opened this issue Jun 22, 2023 · 0 comments
Assignees
Labels
snaps Related to Snaps content. team-snaps-platform tech-writing Requires updates to documentation content.

Comments

@Montoya
Copy link
Collaborator

Montoya commented Jun 22, 2023

We have received feedback about the onTransaction export: I was looking into a Snap that uses the "transaction" object returned by the "onTransaction" hook. The Snap accesses several properties of this object, but does not check if they are defined. Thus, I was wondering whether these properties were guaranteed to be defined by MM. I wasn't able to find any reference in the doc, but maybe I haven't looked in the right place.

To be clear, we do not document the transaction object and it isn't documented elsewhere. We should explain what to expect from it and provide examples. As far as I know, it differs depending on the type of transaction, and nothing is guaranteed to be there, but we should at least give examples.

@alexandratran alexandratran added tech-writing Requires updates to documentation content. team-snaps-platform labels Jul 9, 2023
@alexandratran alexandratran added the snaps Related to Snaps content. label Jul 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
snaps Related to Snaps content. team-snaps-platform tech-writing Requires updates to documentation content.
Projects
None yet
Development

No branches or pull requests

3 participants