fix(developerDocs): incorrect MatchOrders event payload in SDK events…#1941
Merged
ryanio merged 1 commit intoProjectOpenSea:mainfrom Mar 18, 2026
Merged
Conversation
… example
## Description
The `MatchOrders` event listener example in `developerDocs/advanced-use-cases.md` uses an incorrect payload structure.
### Changes:
- Updated handler signature:
- `({ buy, sell, accountAddress })` → `({ transactionHash, event })`
### Reason:
`MatchOrders` is dispatched through the internal `_confirmTransaction` method in `sdk.ts`, which emits transaction-related events using a unified payload:
```ts
{ transactionHash, event }
```
There is no dispatch in the SDK that provides `buy`, `sell`, or `accountAddress` fields for `MatchOrders`. The previous example could lead to undefined values and mislead developers.
ryanio
approved these changes
Mar 18, 2026
Collaborator
ryanio
left a comment
ryanio
left a comment
There was a problem hiding this comment.
Good catch — _confirmTransaction emits { transactionHash, event }, not { buy, sell, accountAddress }. The doc example now matches the actual payload. LGTM!
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
MatchOrdersevent listener example indeveloperDocs/advanced-use-cases.mduses an incorrect payload structure.Changes:
({ buy, sell, accountAddress })→({ transactionHash, event })Reason:
MatchOrdersis dispatched through the internal_confirmTransactionmethod insdk.ts, which emits transaction-related events using a unified payload:There is no dispatch in the SDK that provides
buy,sell, oraccountAddressfields forMatchOrders. The previous example could lead to undefined values and mislead developers.