Crate opensea_stream

Crate for receiving updates from the OpenSea Stream API. This crate is a thin wrapper over phyllo with a few convenience functions and struct definitions for the event schema. It is recommended that you also read the documentation of phyllo to understand the Phoenix protocol which delivers these messages.

Events that happen on Solana (and thus carry Solana addresses) are not supported for now.

Example

The following example prints all listings of items in the wandernauts collection as they are created.

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let mut client = client(Network::Mainnet, "YOUR_API_KEY_HERE").await;

    // Subscribe to a collection. Note that you must all subscribe to all events
    // in the collection; filtering is your responsibility (see below).
    let (handler, mut subscription) = subscribe_to(
        &mut client,
        Collection::Collection("wandernauts".to_string()),
    )
    .await?;

    // To unsubscribe:
    // handler.close().await?;

    loop {
        // The message received from the channel is a raw message of the Phoenix protocol.
        // It may or may not contain a payload.
        let event = match subscription.recv().await?.into_custom_payload() {
            Some(v) => v,
            None => {
                eprintln!("unexpected message");
                continue;
            }
        };

        // Only print item listing events.
        if let schema::Payload::ItemListed(listing) = event.payload {
            println!("{:?}", listing);
        }
    }
}

Features

rustls-tls-native-roots (which uses rustls-native-certs for root certificates) is enabled by default. To use rustls-tls-webpki-roots (webpki-roots) instead, include this in your Cargo.toml:

opensea-stream = { version = "0.1", default-features = false, features = ["rustls-tls-webpki-roots"] }

Re-exports

pub use phyllo;

Modules

schema

Payload schema for messages received from the websocket.

Enums

Collection

A collection whose events can be subscribed to.

Event

Receivable events from the websocket.

Network

The websocket to connect to.

Functions

client

Creates a client.

subscribe_to

Subscribes to all the events of a particular Collection.

subscribe_to_with_config

Subscribes to all the events of a particular Collection using a custom configuration.