=== Orvyn Feeds ===
Contributors: orvyn
Tags: data, oracle, price, feed, shortcode
Requires at least: 6.0
Tested up to: 6.9
Requires PHP: 7.4
Stable tag: 0.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Shows a number from an Orvyn data feed on any page, with the time it was observed and a link to check the signed report.

== Description ==

Orvyn is a marketplace of data feeds: prices, rates, economic releases, weather and more, each report signed by its provider and checkable on Robinhood Chain. This plugin puts one of those numbers on a page with a shortcode.

`[orvyn feed="orvyn/sgov-etf-price"]`

Without a key the plugin shows the feed's delayed public preview and says so. With an API key from your Orvyn dashboard it shows the latest signed report from the packs you bought, and links to a page where anyone can check the signature.

* `show="value"` prints only the number.
* `show="line"` (the default) prints the number, when it was observed, whether it is signed or delayed, and a link.
* `show="card"` adds the feed's name, its provider and its source.
* `signed="no"` shows the free preview even when a key is saved.

The plugin reads each feed at most once per heartbeat, whatever the traffic, and keeps the last number on the page, marked stale, if the feed or the gateway is briefly away.

The key is stored in your site's options and sent only to the Orvyn gateway. Make it with the read scope only: a read key can spend the calls you already bought and nothing more, and you can revoke it from the dashboard at any time.

This plugin talks to `https://orvyn.me/gw`. See https://orvyn.me/privacy and https://orvyn.me/terms.

== Installation ==

1. Upload the `orvyn-feeds` folder to `/wp-content/plugins/`, or install the zip from Plugins > Add New.
2. Activate the plugin.
3. Put `[orvyn feed="provider/slug"]` in a page or post. Feed addresses are on https://orvyn.me/explore.
4. Optional: paste an API key under Settings > Orvyn feeds to show signed reports.

== Frequently Asked Questions ==

= Is the number live? =

Without a key it is the feed's public preview, delayed by the time the feed sets, usually minutes. With a key it is the latest signed report, read at most once per heartbeat.

= What does "check" open? =

A page on orvyn.me that checks the report's signature against the signer the feed registered on chain. The report travels in the link itself; nothing about your site is sent.

= What can a leaked key do? =

Spend the calls already bought on your packs, if it has the read scope only. Revoke it from the Orvyn dashboard and paste a new one.

= Does it send anything about my visitors? =

No. Requests go from your server to the gateway, and carry the plugin's name and version so Orvyn can see which tools are used. Nothing about a visitor is sent.

== Changelog ==

= 0.1.0 =
* First release: the shortcode, the settings page, one read per heartbeat.
