Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
@opensea/stream-js
Advanced tools
Readme
A Javascript SDK for receiving updates from the OpenSea Stream API - pushed over websockets. We currently support the following event types on a per-collection basis:
This is a best effort delivery messaging system. Messages that are not received due to connection errors will not be re-sent. Messages may be delivered out of order. This SDK is offered as a beta experience as we work with developers in the ecosystem to make this a more robust and reliable system.
Documentation: https://docs.opensea.io/reference/stream-api-overview
We recommend switching to Node.js version 16 to make sure common crypto dependencies work. Our minimum supported version is 16.11.0.
npm install @opensea/stream-js
npm install ws
npm install --save-dev @types/phoenix
In order to make onboarding easy, we've integrated the OpenSea Stream API with our existing API key system. The API keys you have been using for the REST API should work here as well. If you don't already have one, request an API key from us here.
import { OpenSeaStreamClient } from '@opensea/stream-js';
const client = new OpenSeaStreamClient({
token: 'openseaApiKey'
});
import { OpenSeaStreamClient } from '@opensea/stream-js';
import { WebSocket } from 'ws';
const client = new OpenSeaStreamClient({
token: 'openseaApiKey',
connectOptions: {
transport: WebSocket
}
});
You can also optionally pass in:
network
if you would like to access testnet networks.
Network.MAINNET
, which represents the following blockchains: Ethereum, Polygon mainnet, Klaytn mainnet, and Solana mainnetNetwork.TESTNET
, which represents the following blockchains: Rinkeby, Polygon testnet (Mumbai), and Klaytn testnet (Baobab).apiUrl
if you would like to access another OpenSea Stream API endpoint. Not needed if you provide a network or use the default values.onError
callback to handle errors. The default behavior is to console.error
the error.logLevel
to set the log level. The default is LogLevel.INFO
.The OpenSea Stream API is available on the following networks:
wss://stream.openseabeta.com/socket
Mainnet supports events from the following blockchains: Ethereum, Polygon mainnet, Klaytn mainnet, and Solana mainnet.
wss://testnets-stream.openseabeta.com/socket
Testnet supports events from the following blockchains: Rinkeby, Polygon testnet (Mumbai), and Klaytn testnet (Baobab).
To create testnet instance of the client, you can create it with the following arguments:
import { OpenSeaStreamClient, Network } from '@opensea/stream-js';
const client = new OpenSeaStreamClient({
network: Network.TESTNET,
token: 'openseaApiKey'
});
The client will automatically connect to the socket as soon as you subscribe to the first channel. If you would like to connect to the socket manually (before that), you can do so:
client.connect();
After successfully connecting to our websocket it is time to listen to specific events you're interested in!
We will only send out metadata updates when we detect that the metadata provided in tokenURI
has changed from what OpenSea has previously cached.
client.onItemMetadataUpdated('collection-slug', (event) => {
// handle event
});
client.onItemListed('collection-slug', (event) => {
// handle event
});
client.onItemSold('collection-slug', (event) => {
// handle event
});
client.onItemTransferred('collection-slug', (event) => {
// handle event
});
client.onItemReceivedBid('collection-slug', (event) => {
// handle event
});
client.onItemReceivedOffer('collection-slug', (event) => {
// handle event
});
client.onEvents(
'collection-slug',
[EventType.ITEM_RECEIVED_OFFER, EventType.ITEM_TRANSFERRED],
(event) => {
// handle event
}
);
client.onItemCancelled('collection-slug', (event) => {
// handle event
});
If you'd like to listen to an event from all collections use wildcard *
for the collectionSlug
parameter.
Types are included to make working with our event payload objects easier.
All subscription methods return a callback function that will unsubscribe from a stream when invoked.
const unsubscribe = client.onItemMetadataUpdated('collection-slug', noop);
unsubscribe();
client.disconnect();
See the contributing guide for detailed instructions on how to get started with this project.
MIT Copyright 2022 Ozone Networks, Inc.
FAQs
An SDK to receive pushed updates from OpenSea over websocket
The npm package @opensea/stream-js receives a total of 705 weekly downloads. As such, @opensea/stream-js popularity was classified as not popular.
We found that @opensea/stream-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.