aboutsummaryrefslogtreecommitdiffstats
path: root/site/public/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'site/public/index.html')
-rw-r--r--site/public/index.html33
1 files changed, 19 insertions, 14 deletions
diff --git a/site/public/index.html b/site/public/index.html
index 8dcb1d0..3ac7d8e 100644
--- a/site/public/index.html
+++ b/site/public/index.html
@@ -211,39 +211,44 @@ The server is programmed in <a href="https://www.service-architecture.com/articl
211<h1 id="coinbase">Coinbase</h1> 211<h1 id="coinbase">Coinbase</h1>
212<p>The first transactions of a block is called the <code>coinbase</code>. They are the <strong>author</strong> of the block proposal and if the block is accepted then they get compensated for their efforts with some Gradecoin.</p> 212<p>The first transactions of a block is called the <code>coinbase</code>. They are the <strong>author</strong> of the block proposal and if the block is accepted then they get compensated for their efforts with some Gradecoin.</p>
213<h1 id="public-key-signatures">Public Key Signatures</h1> 213<h1 id="public-key-signatures">Public Key Signatures</h1>
214<p>Gradecoin uses 2048 bit RSA keyspairs.</p> 214<p>Gradecoin uses 2048 bit RSA keypairs.</p>
215<h1 id="services">Services</h1> 215<h1 id="services">Services</h1>
216<h2 id="register">/register</h2> 216<h2 id="register">/register</h2>
217<p>-Create your own 2048 bit RSA <code>keypair</code></p>
217<ul> 218<ul>
218<li>Student creates their own 2048 bit RSA <code>keypair</code></li> 219<li>Download <code>Gradecoin</code>'s Public Key from <a href="https://odtuclass.metu.edu.tr/my/">Moodle</a></li>
219<li>Downloads <code>Gradecoin</code>'s Public Key from <a href="https://odtuclass.metu.edu.tr/my/">Moodle</a></li> 220<li>Encrypt your <a href="https://www.json.org/json-en.html">JSON</a> wrapped <code>Public Key</code>, <code>Student ID</code> and one time <code>passwd</code> using Gradecoin's Public Key</li>
220<li>Encrypts their <a href="https://www.json.org/json-en.html">JSON</a> wrapped <code>Public Key</code>, <code>Student ID</code> and one time <code>passwd</code> using Gradecoin's Public Key</li> 221<li>Your public key is now in our database and can be used to sign your JWT's during requests</li>
221<li>Their public key is now in our database and can be used to sign their JWT's during requests</li> 222<li>For more information, check the <a href="https://gradecoin.xyz/register-docs/">register</a> page</li>
222<li>For more information, check our <a href="https://gradecoin.xyz/register-docs/">register</a> page.</li>
223</ul> 223</ul>
224<h2 id="transaction">/transaction</h2> 224<h2 id="transaction">/transaction</h2>
225<ul> 225<ul>
226<li>You can offer a <a href="https://gradecoin.xyz/transaction-docs/">Transaction</a> - POST request 226<li>You can offer a <a href="https://gradecoin.xyz/transaction-docs/">Transaction</a> with a POST request
227<ul> 227<ul>
228<li>The request should have <code>Authorization</code></li> 228<li>The request should have <code>Authorization</code></li>
229<li>The request header should be signed by the Public Key of the <code>by</code> field in the transaction</li> 229<li>The request header should be signed by the Public Key of the <code>by</code> field in the transaction</li>
230</ul> 230</ul>
231</li> 231</li>
232<li>fetch the list of <code>Transaction</code>s - GET request</li> 232<li>Fetch the list of <code>Transaction</code>s with a GET request</li>
233<li>For more information, check our <a href="https://gradecoin.xyz/transaction-docs/">transaction</a> page.</li> 233<li>For more information, check our <a href="https://gradecoin.xyz/transaction-docs/">transaction</a> page</li>
234</ul> 234</ul>
235<h2 id="block">/block</h2> 235<h2 id="block">/block</h2>
236<ul> 236<ul>
237<li>offer a <a href="https://gradecoin.xyz/block-docs/">Block</a> - POST request 237<li>
238<p>Offer a <a href="https://gradecoin.xyz/block-docs/">Block</a> with a POST request</p>
238<ul> 239<ul>
239<li>The request should have <code>Authorization</code></li> 240<li>The request should have <code>Authorization</code></li>
240<li>The [<code>schema::Block::transaction_list</code>] of the block should be a subset of [<code>schema::Db::pending_transactions</code>]</li> 241<li>The <code>transaction_list</code> of the block should be a subset of pending transactions, available on <a href="/transaction">/transaction</a></li>
241</ul> 242</ul>
242</li> 243</li>
243<li>fetch the last accepted [<code>schema::Block</code>] - GET request</li> 244<li>
244<li>For more information, check our <a href="https://gradecoin.xyz/block-docs/">block</a> page.</li> 245<p>Fetch the last accepted <code>Block</code> with a GET request</p>
245</ul> 246</li>
247<li>
248<p>For more information, check our <a href="https://gradecoin.xyz/block-docs/">block</a> page</p>
246<p><code>Authorization</code>: The request header should have Bearer JWT.Token signed with Student Public Key</p> 249<p><code>Authorization</code>: The request header should have Bearer JWT.Token signed with Student Public Key</p>
250</li>
251</ul>
247<h1 id="questions">Questions</h1> 252<h1 id="questions">Questions</h1>
248<h2 id="this-all-sound-complicated">This all sound complicated!</h2> 253<h2 id="this-all-sound-complicated">This all sound complicated!</h2>
249<ul> 254<ul>