Commit 898eddf4 authored by Cédric Moreau's avatar Cédric Moreau

Update Protocol.md: add keychain/parameters & contract/parameters methods

parent 59f20f55
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
* [lookup](#pkslookup) * [lookup](#pkslookup)
* [all](#pksall) * [all](#pksall)
* [keychain/](#keychain) * [keychain/](#keychain)
* [parameters](#parameters)
* [membership](#keychainmembership) * [membership](#keychainmembership)
* [keyblock](#keychainkeyblock) * [keyblock](#keychainkeyblock)
* [keyblock/[number]](#keychainkeyblocknumber) * [keyblock/[number]](#keychainkeyblocknumber)
...@@ -30,7 +31,7 @@ ...@@ -30,7 +31,7 @@
* [wallet (POST)](#networkwallet-post) * [wallet (POST)](#networkwallet-post)
* [wallet/[PGP_FINGERPRINT]](#networkwalletpgp_fingerprint) * [wallet/[PGP_FINGERPRINT]](#networkwalletpgp_fingerprint)
* [contract/](#contract) * [contract/](#contract)
* [parameters](#parameters) * [parameters](#parameters1)
* [am/[AMENDMENT_NUMBER]](#amamendment_number) * [am/[AMENDMENT_NUMBER]](#amamendment_number)
* [tx/](#tx) * [tx/](#tx)
* [process](#process) * [process](#process)
...@@ -327,6 +328,32 @@ Merkle URL leaf: public key ...@@ -327,6 +328,32 @@ Merkle URL leaf: public key
### keychain/* ### keychain/*
#### `parameters`
**Goal**
GET the keychain parameters used by this node.
**Parameters**
*None*.
**Returns**
The synchronization parameters.
```json
{
"sigDelay": 157680000,
"sigValidity": 31536000,
"sigQty": 5,
"stepMax": 3,
"powZeroMin": 4,
"powPeriod": 10
}
```
Parameters meaning is described under [Protocol parameters](./Protocol.md#protocol-parameters).
#### `keychain/membership` #### `keychain/membership`
...@@ -859,11 +886,9 @@ In a general way, those URLs return HTTP **200** code on success, HTTP **501** i ...@@ -859,11 +886,9 @@ In a general way, those URLs return HTTP **200** code on success, HTTP **501** i
#### `parameters` #### `parameters`
> TODO: rewrite this method
**Goal** **Goal**
GET the synchronization parameters used by this node. GET the monetary parameters used by this node.
**Parameters** **Parameters**
...@@ -871,30 +896,16 @@ GET the synchronization parameters used by this node. ...@@ -871,30 +896,16 @@ GET the synchronization parameters used by this node.
**Returns** **Returns**
The synchronization parameters. The monetary parameters.
```json ```json
{ {
"AMStart": 1388530800, "c": 0.737826,
"AMFrequency": 86400, "dt": 2629800,
"UDFrequency": 2629800, "ud0": 100
"UD0": 100,
"UDPercent": 0.007376575,
"CoinAlgo": "Base2Draft",
"Consensus": 0.6666666666666666
} }
``` ```
Below are parameters meaning: Parameters meaning is described under [Protocol parameters](./Protocol.md#protocol-parameters).
Parameter | Meaning
----------------- | ------------
AMStart | Root amendment starting timestamp (in seconds)
AMFrequency | Amendment frequency (in seconds)
UDFrequency | Universal Dividend frequency (in seconds)
UD0 | Universal Dividend initial value
UDPercent | Universal Dividend % of monetary mass growth
CoinAlgo | Algorithm used for generating coins (this also gives interpretation of coins' value in each amendment)
Consensus | Percent of voters required to valid an Amendment
#### `am/[AMENDMENT_NUMBER]` #### `am/[AMENDMENT_NUMBER]`
**Goal** **Goal**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment