Stork Documentation
Ask or search…
K

Release Notes

Version 3 (5/22/23)

Our primary objective with this update is to streamline the process of launching new feeds, reducing both the time and complexity involved. We have also made provisions for improved support of custom feeds, allowing custom feeds to be launched across multiple publishers. The majority of existing users should not be affected by these changes, and the v3 endpoint can seamlessly replace or be used concurrently with v2 as long as v2 remains available.
Here's a rundown of additional updates and changes:
  • Metadata Fields Support: Stork now includes support for optional metadata fields generated by publishers. This feature proves valuable for publishers to demonstrate their calculations, particularly when used for custom feeds. Any numeric metadata fields are also aggregated into an (unsigned) median across all publishers included in a response.
{
"oracle_prices": {
"BTCUSDCMARK": {
"price": "26884656459964371000000",
"signed_prices": {
"0xcc85afe4ca87f9628370c432c447e569a01dc96d160015c8039959db8521c4": {
"external_asset_id": "0x425443555344434f4b5800000000000053746f726b",
"price": "26884656459964371000000",
"timestamped_signature": {
"signature": {
"r": "0x6e2c8660967045016614b06d526c86bbbadd66a9ab75b87a6688fd6ac36a1a2",
"s": "0x6bf9b6c641492fcfce724b537fc1d171ea362df04bc12f2b9225572da1364f1"
},
"timestamp": "1684771186",
"msg_hash": "0x6bd1ea67fbf07181786ea5374542a0564e5a5d27103e5a2d2388a27d8360a98"
},
"metadata": {
"usd_index_price": "26877935295849380000000",
"usdc_index_price": "26884656459964371000000"
}
},
"metadata": {
"usd_index_price": "26881664200000000000000",
"usdc_index_price": "26884656459964371000000"
}
}
},
"timestamp": "1684771187",
"type": "ORACLE_PRICES_TICK"
}
  • Request Types Correction: There was a misrepresentation in v2 where it sent ORACLES_PRICE_TICK request types. We've rectified this in V3, now correctly denoting them as ORACLE_PRICES_TICK.
  • Response Status Code Addition: We have added statusCode in the response to subscribe/unsubscribe requests.
> {"action":"subscribe", "assets":["ETHUSD"]}
< {"statusCode":200,"message":"Successfully subscribed to ['ETHUSD']."}
  • Ping/Pong Support: The server now responds to ping requests.