Releases: ProjectOpenSea/stream-js
v0.3.0
Minor changes
Every stream event now includes a numeric version field that is monotonically increasing per source entity. Use it to handle out-of-order event delivery: when two events arrive for the same entity, the one with the higher version is newer state.
Version scale depends on event type
| Event types | version semantic |
|---|---|
item_listed, item_cancelled, item_received_offer, item_received_bid, collection_offer, trait_offer, order_invalidate, order_revalidate |
Order revision counter (small monotonic integer per order) |
item_transferred, item_sold, item_metadata_updated |
Epoch milliseconds of the event's source timestamp |
Both representations are monotonic and sufficient for resolving out-of-order delivery, but the two scales are not comparable to each other. Compare version only for the same entity within the same event family. See the Event Versioning section of the README for usage examples.
Notes
- This is an additive change:
BaseStreamMessage<Payload>gains a requiredversion: numberfield. - No code changes required for existing consumers — events previously continued to work without the field at runtime; upgrading picks up the new typed field for those who want to use it.
v0.2.3
What's Changed
- Add trait criteria types by @BCLeFevre in #495
New Contributors
- @BCLeFevre made their first contribution in #495
Full Changelog: v0.2.2...v0.2.3
v0.2.2
v0.2.1
What's Changed
v0.2.0 was missing dist folder, added prepublish build step.
Full Changelog: v0.2.0...v0.2.1
v0.2.0
v0.1.3
v0.1.2
Adding chain to event payload type.
v0.1.1
v0.1.0
Added 2 New Event Types:
- Invalidation Events
- Revalidation Events
An order can become invalidated for a number of reasons. For example, if the offerer WETH balance falls below the offer. In order to allow users to keep a copy of the order book up to date, OpenSea is planning to begin rolling out events being emitted for both invalidation and revalidation events.