The Guild Rapid Alert System Stream (GRASS) provides a constant real-time stream of all updates to the Structs game state.
GRASS, built on NATS, can be consumed by any supported library or client.
<aside> 🔥
GRASS can be expanded by Guilds to stream additional data unique to their players.
</aside>
subject
and payload
.json
format.category
attribute within the payload signals what data can be expected.stub
attribute with a boolean value of true
signals that the payload was too large to include all details. An API call may be needed to retrieve the full information.https://github.com/playstructs/structs-grass
https://github.com/playstructs/docker-structs-grass
This article on Subject-Based Messaging through NATS best described how the subjects can be used to stream only the exact data needed for your purpose.
Subscribing to structs.consensus
will provide you with a constant stream of block height updates.
{
"subject": "structs.consensus",
"category": "block",
"height": 105911,
"updated_at": "2024-11-08T17:34:19.860779+00:00"
}
The following list outlines the stock stream subjects available through GRASS, including detailed descriptions of each category message type.
Subject: structs.consensus