From 69e26be0b379dbddb847dae57a8650c97b9d09c1 Mon Sep 17 00:00:00 2001 From: Yigit Sever Date: Sat, 17 Apr 2021 20:11:28 +0300 Subject: Update docs --- site/content/_index.md | 11 ++++++++++- site/content/block_docs.md | 12 ++++++++++-- site/public/block-docs/index.html | 19 ++++++++++++++++--- site/public/index.html | 21 ++++++++++++++++++++- site/public/search_index.en.js | 2 +- site/public/site.css | 4 +++- site/static/site.css | 4 +++- site/templates/shortcodes/exp.html | 1 + 8 files changed, 64 insertions(+), 10 deletions(-) create mode 100644 site/templates/shortcodes/exp.html diff --git a/site/content/_index.md b/site/content/_index.md index 28700df..d0be673 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -57,14 +57,23 @@ Gradecoin uses 2048 bit RSA keypairs. `Authorization`: The request header should have Bearer JWT.Token signed with Student Public Key +## /user +- Meant to be used in the browser, you can see the current list of users and their balance here + # 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 simplicity of the system is how little interfaces it has. - Don't know where to start? Gradecoin uses RESTful API; simple `curl` commands or even your browser will work! [This website can help as well](https://curl.trillworks.com/). -- [JWT Debugger](https://jwt.io) and the corresponding [RFC](https://tools.ietf.org/html/rfc7519) +- [JWT Debugger](https://jwt.io) and the corresponding [RFC](https://tools.ietf.org/html/rfc7519). - Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair? - Check out [misc](@/misc_docs.md) for everything else you might be curious about. +## How do you actually earn Gradecoin? +- Register yourself to at [/register](@/register_docs.md) +- Create transactions at [/transaction](@/transaction_docs.md) +- Create blocks to commit transactions at [/block](@/block_docs.md) +- See how everyone is doing and find people to trade with at [/user](/user) + ## I found a bug! Thank you! Please [let me know](mailto:yigit@ceng.metu.edu.tr) so we can solve it. diff --git a/site/content/block_docs.md b/site/content/block_docs.md index bb1b44c..92880b6 100644 --- a/site/content/block_docs.md +++ b/site/content/block_docs.md @@ -8,7 +8,7 @@ A block that was proposed to commit Transactions in `transaction_list` to the ledger with a nonce that made `hash` valid; 6 zeroes at the left hand side of the hash (24 bytes). -We are _mining_ using [blake2s](https://www.blake2.net/) algorithm, which produces 256 bit hashes. Hash/second is roughly 20x10^3 on my machine, a new block can be mined in around 4-6 minutes. +We are _mining_ using [blake2s](https://www.blake2.net/) algorithm, which produces 256 bit hashes. Hash/second is roughly {{ exp(num="20x10", exponent="3") }} on my machine, a new block can be mined in around 4-6 minutes. # Requests @@ -27,9 +27,17 @@ timestamp: ISO 8601 T