From e2b7b072265f29d833f015463d6b0cf02af875f5 Mon Sep 17 00:00:00 2001 From: Yigit Sever Date: Mon, 19 Apr 2021 18:27:11 +0300 Subject: Shed README.md --- README.md | 36 ++---------------------------------- 1 file changed, 2 insertions(+), 34 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index da95cce..daa0b0a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This will sit behind nginx reverse proxy so running at 127.0.0.1:8080 or not using https is not a problem. +It's currently live over at https://gradecoin.xyz. + ``` # Test the project $ cargo test @@ -10,40 +12,6 @@ $ cargo test $ cargo doc --open ``` -# how? -## authentication -> Uses /register endpoint -- Student creates their own 2048 bit RSA `keypair` -- Downloads Gradecoin's Public Key from Moodle -- Encrypts their JSON wrapped Public Key and Student ID using Gradecoin's Public Key -- Sends that to the /register endpoint with a POST request -- Their public key is now in our database and can be used to sign their JWT's during requests - -## transactions -> Uses /transaction endpoint -- offer **a transaction** - POST request - - The request header should have Bearer [JWT.Token signed with Student Public Key] - - The request header should be signed by the Public Key of the `by` field in the transaction -- fetch the list of pending transactions - GET request - - All the pending transactions are returned in a JSON body - - ❓ Does this need to be authenticated as well? - -## blocks - [INCOMPLETE] -> Uses /block endpoint -- Blocks are proposed using `N` transactions - POST request - - ❓ This can be an exact number (=20) or if the last block is *some time* old then small blocks can be proposed. - -- Block proposal: `Block` + some `nonce` is hashed using a *simple* hash function, resulting hash should have some property that will require some computation time (~1 minute? 10 minutes?) to find (=guessing) Proof-of-work scheme. -First proposed valid block is accepted, if assertions hold. -(No consensus, we are the sole authority, there's no blockchain here, only a glorified database and busywork) -- Pending transactions get cleared out after a new block is accepted - - ❓ All or only the used ones? - -## payment -First transaction in the block is called *Coinbase*, the block reward is paid to the *output* (Bitcoin notation, different) of this transaction. -If we do this then the rest of the transactions are just make believe playing. -So banker + block reward approach seems better. - # Big Thank List - https://github.com/blurbyte/restful-rust - https://github.com/zupzup/warp-postgres-example -- cgit v1.2.3-70-g09d2