summaryrefslogtreecommitdiff
path: root/bip-0171.mediawiki
diff options
context:
space:
mode:
Diffstat (limited to 'bip-0171.mediawiki')
-rw-r--r--bip-0171.mediawiki11
1 files changed, 10 insertions, 1 deletions
diff --git a/bip-0171.mediawiki b/bip-0171.mediawiki
index 237d233..11eb109 100644
--- a/bip-0171.mediawiki
+++ b/bip-0171.mediawiki
@@ -26,7 +26,7 @@ All matching parameters may be specified with multiple comma-separated values, w
Each result is always in JSON format, with a line-feed (never a carriage-return) separating multiple results.
Authentication for subscription-based services MAY be supported using standard HTTP authentication.
-It is recommended to use TLS (HTTPS), so that MITM attackers cannot deceive the client.
+It is recommended to use TLS (HTTPS) and/or Linked Data Signatures, so that MITM attackers cannot deceive the client.
To be BIP 171 compatible, servers MUST support at least one currency-pair compared to XBT.
All inquiries for bitcoin amounts MUST be specified in XBT, even if the presentation to the end user is in another unit.
@@ -59,6 +59,7 @@ Each currency-pair will receive a separate result, a JSON Object, with the follo
* ''base'' - The currency code for the base currency.
* ''locale'' - If provided, a String with the applicable Unicode CLDR locale.
* ''desc'' - Optional description. For example, it could be "Based on Florida BTM prices." or any other short String that provides information useful to the user. SHOULD be shorter than 45 characters.
+* ''signature'' - Optional. May be used for Linked Data Signatures.
Example:
@@ -92,6 +93,7 @@ Each currency-pair will receive a separate result, a JSON Object, with the follo
* ''longpoll'' - If provided and true, indicates longpolling is supported by the server.
* ''history'' - If provided, indicates the server has historical records going back no earlier than the POSIX timestamp provided as a value.
* ''archive'' - If provided, indicates the server no longer has current rates, and has no historical rates more recent than the POSIX timestamp provided as a value.
+* ''signature'' - Optional. May be used for Linked Data Signatures.
Example:
@@ -108,12 +110,15 @@ Parameters:
* ''cp'' - Currency pair(s) for which rate is requested.
* ''type'' - Type of exchange rate data being requested. May be "high", "low", "average", "typical", or any other arbitrary name. If omitted, the server may provide any rates it deems appropriate.
* ''minrate'', ''maxrate'' - If specified, indicates this request is a longpoll. The server should not send a response until the rate(s) fall below or above (respectively) the provided value.
+* ''nonce'' - If specified, the server SHOULD return it in each result.
Each currency-pair receives a separate result (a JSON Object) with all requested rate types:
* ''cp'' - The currency-pair token.
* ''time'' - The time (as a POSIX timestamp) the rate information is applicable to (should be approximately the request time).
* ''rates'' - A JSON Object with each rate type provided as a key, and a Number as the value specifying the rate.
+* ''nonce'' - Only if the request specified a nonce, the server SHOULD include it here as a JSON String.
+* ''signature'' - Optional. May be used for Linked Data Signatures.
Example:
@@ -189,3 +194,7 @@ While this new standard is adopted, software and providers can continue to use a
==Reference implementation==
TODO
+
+==See also==
+
+* [https://w3c-dvcg.github.io/ld-signatures/ Draft W3c Linked Data Signatures specification]