diff options
Diffstat (limited to 'content/misc_docs.md')
-rw-r--r-- | content/misc_docs.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/content/misc_docs.md b/content/misc_docs.md index 47b5287..222601b 100644 --- a/content/misc_docs.md +++ b/content/misc_docs.md | |||
@@ -14,3 +14,20 @@ A user's finger print is generated via applying SHA256 sum of the user's public | |||
14 | 14 | ||
15 | # Config | 15 | # Config |
16 | The [/config](/config) endpoint will return the current parameters that Gradecoin uses. | 16 | The [/config](/config) endpoint will return the current parameters that Gradecoin uses. |
17 | |||
18 | - `name`: Name of this Gradecoin network. | ||
19 | - `url_prefix`: URL prefix for the network. All API commands will be served under this prefix. | ||
20 | - For example, if url_prefix is `example`, register at `gradecoin.xyz/example/register`. | ||
21 | - It can be empty, in which case the endpoints are accessed directly from `/`. Example: `gradecoin.xyz/register`. | ||
22 | - `preapproved_users`: The name of the CSV file that contains the list of users who can register. This doesn't concern you as an end-user. | ||
23 | - `block_transaction_count`: A valid block should have at least this many transactions. | ||
24 | - `hash_zeros`: Determines the number of zero hexadecimal characters a correct hash should start with. | ||
25 | - `register_bonus`: Initial registration bonus. This will determine your balance after registration. | ||
26 | - `block_reward`: Coinbase reward. When a block is proposed successfully and added to ledger, the proposer will gain this amount of coins. | ||
27 | - `tx_upper_limit`: Upper limit for transaction amount. | ||
28 | - `tx_lower_limit`: Lower limit for transaction amount. | ||
29 | - `tx_traffic_reward`: Transaction traffic reward, used to incentivize users to make transactions. When an account sends money, it will receive this reward. | ||
30 | - `bots`: The configuration of the bots in this network. | ||
31 | - Each key will be the fingerprint of a bot. | ||
32 | - Each value will be another JSON object. Currently, it only contains one self-explanatory field: `starting_balance`. | ||
33 | |||