From 79b0d66ec091501b063d35976db2347fc10a39d1 Mon Sep 17 00:00:00 2001 From: necrashter Date: Sun, 24 Apr 2022 21:37:26 +0300 Subject: More information about /config --- content/_index.md | 4 ++++ content/misc_docs.md | 17 +++++++++++++++++ 2 files changed, 21 insertions(+) (limited to 'content') diff --git a/content/_index.md b/content/_index.md index e41dd2c..da3b751 100644 --- a/content/_index.md +++ b/content/_index.md @@ -71,6 +71,10 @@ Programming a bot is absolutely fine as long as it's not aggressively sending re 🤖👋 are bots who are very eager to transact with you. I've trained them personally using state-of-the-art neural networks running on thousands of TPUs. +## /config +- Making a GET request to this auxiliary endpoint will provide the current configuration of the Gradecoin network in JSON form. +- The information about the individual fields can be found in the [misc Page](@/misc_docs.md). + # Questions ## This all sound complicated! - I've drawn inspiration from [actual Bitcoin transactions](https://explorer.bitcoin.com/btc) and [warp](https://github.com/seanmonstar/warp/blob/master/examples/todos.rs). The system has only 3 interfaces. It's simple once you read everything over a couple of times. 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 # Config The [/config](/config) endpoint will return the current parameters that Gradecoin uses. + +- `name`: Name of this Gradecoin network. +- `url_prefix`: URL prefix for the network. All API commands will be served under this prefix. + - For example, if url_prefix is `example`, register at `gradecoin.xyz/example/register`. + - It can be empty, in which case the endpoints are accessed directly from `/`. Example: `gradecoin.xyz/register`. +- `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. +- `block_transaction_count`: A valid block should have at least this many transactions. +- `hash_zeros`: Determines the number of zero hexadecimal characters a correct hash should start with. +- `register_bonus`: Initial registration bonus. This will determine your balance after registration. +- `block_reward`: Coinbase reward. When a block is proposed successfully and added to ledger, the proposer will gain this amount of coins. +- `tx_upper_limit`: Upper limit for transaction amount. +- `tx_lower_limit`: Lower limit for transaction amount. +- `tx_traffic_reward`: Transaction traffic reward, used to incentivize users to make transactions. When an account sends money, it will receive this reward. +- `bots`: The configuration of the bots in this network. + - Each key will be the fingerprint of a bot. + - Each value will be another JSON object. Currently, it only contains one self-explanatory field: `starting_balance`. + -- cgit v1.2.3-70-g09d2