aboutsummaryrefslogtreecommitdiffstats
path: root/site/public/transaction-docs
diff options
context:
space:
mode:
authoralpaylan2021-04-16 01:03:21 +0300
committeralpaylan2021-04-16 01:03:21 +0300
commitd248309f8595701a0fddd2462b963bcad55f18c8 (patch)
tree109d4e2809f9f3392612e86ab3d5a47df5830b11 /site/public/transaction-docs
parent711d987b8e060682cf2215f25392415e206b3e8d (diff)
parenta1af17aad7c1308fc714a60595bae07cc8bb8a9a (diff)
downloadgradecoin-d248309f8595701a0fddd2462b963bcad55f18c8.tar.gz
gradecoin-d248309f8595701a0fddd2462b963bcad55f18c8.tar.bz2
gradecoin-d248309f8595701a0fddd2462b963bcad55f18c8.zip
Merge remote-tracking branch 'origin/main'
# Conflicts: # src/schema.rs
Diffstat (limited to 'site/public/transaction-docs')
-rw-r--r--site/public/transaction-docs/index.html164
1 files changed, 164 insertions, 0 deletions
diff --git a/site/public/transaction-docs/index.html b/site/public/transaction-docs/index.html
new file mode 100644
index 0000000..67b9505
--- /dev/null
+++ b/site/public/transaction-docs/index.html
@@ -0,0 +1,164 @@
1<!DOCTYPE html>
2<html lang="en">
3
4<head>
5 <meta charset="UTF-8">
6 <title>Transactions | Gradecoin </title>
7 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
8 <style>
9 :root {
10 /* Primary theme color */
11 --primary-color: #F8D12F;
12 /* Primary theme text color */
13 --primary-text-color: #1E2329;
14 /* Primary theme link color */
15 --primary-link-color: #2F57F7;
16 /* Secondary color: the background body color */
17 --secondary-color: #FAFAFA;
18 --secondary-text-color: #303030;
19 /* Highlight text color of table of content */
20 --toc-highlight-text-color: #d46e13;
21 }
22</style>
23
24 <link href="https://fonts.googleapis.com/css?family=Alfa+Slab+One&display=swap" rel="stylesheet">
25 <link href="https://fonts.googleapis.com/css?family=Fira+Sans:400,500,600&display=swap" rel="stylesheet">
26 <link rel="stylesheet" href="/normalize.css">
27 <link rel="stylesheet" href="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;juice.css">
28
29<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css" />
30
31</head>
32
33<body>
34
35<header class="box-shadow">
36
37
38<a href="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;">
39 <div class="logo">
40 <img src="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;gradecoin.png" alt="logo">
41 Gradecoin
42 </div>
43</a>
44
45<nav>
46
47 <a class="nav-item subtitle-text" href="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;register-docs&#x2F;">Register</a>
48
49 <a class="nav-item subtitle-text" href="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;jwt&#x2F;">JWT</a>
50
51 <a class="nav-item subtitle-text" href="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;transaction-docs&#x2F;">Transactions</a>
52
53 <a class="nav-item subtitle-text" href="https:&#x2F;&#x2F;gradecoin.xyz&#x2F;block-docs&#x2F;">Blocks</a>
54
55
56
57 <a class="nav-item subtitle-text" href="https:&#x2F;&#x2F;github.com&#x2F;zhuowei&#x2F;nft_ptr#why">why?</a>
58
59
60</nav>
61
62</header>
63
64
65 <main>
66
67
68
69
70
71 <div class="toc">
72 <div class="toc-sticky">
73
74 <div class="toc-item">
75 <a class="subtext" href="https://gradecoin.xyz/transaction-docs/#requests">Requests</a>
76 </div>
77
78
79 <div class="toc-item-child">
80 <a class="subtext" href="https://gradecoin.xyz/transaction-docs/#get"><small>- GET</small></a>
81 </div>
82
83 <div class="toc-item-child">
84 <a class="subtext" href="https://gradecoin.xyz/transaction-docs/#post"><small>- POST</small></a>
85 </div>
86
87
88
89 <div class="toc-item">
90 <a class="subtext" href="https://gradecoin.xyz/transaction-docs/#fields">Fields</a>
91 </div>
92
93
94 </div>
95 </div>
96
97
98
99 <div class="content text">
100
101<div class="heading-text">Transaction documentation</div>
102<p>A transaction request between <code>source</code> and <code>target</code> to move <code>amount</code> Gradecoin.</p>
103<h1 id="requests">Requests</h1>
104<h2 id="get">GET</h2>
105<p>A HTTP <code>GET</code> request to <a href="/transaction">/transaction</a> endpoint will return the current list of pending transactions.</p>
106<h2 id="post">POST</h2>
107<p>A HTTP <code>POST</code> request with Authorization using JWT to <a href="/transactions">/transaction</a> will allow you to propose your own transactions.</p>
108<h1 id="fields">Fields</h1>
109<pre style="background-color:#ffffff;">
110<code><span style="color:#545052;">by: Fingerprint
111source: Fingerprint
112target: Fingerprint
113amount: unsigned 16 bit integer
114timestamp: ISO 8601 &lt;date&gt;T&lt;time&gt;
115</span></code></pre>
116
117 </div>
118
119
120
121 </main>
122
123
124<footer>
125Built For ⁂ CENG489 ⁂ Introduction to Computer Security
126</footer>
127
128</body>
129<script>
130 function highlightNav(heading) {
131 let pathname = location.pathname;
132 document.querySelectorAll(".toc a").forEach((item) => {
133 item.classList.remove("active");
134 });
135 document.querySelector(".toc a[href$='" + pathname + "#" + heading + "']").classList.add("active");
136 }
137
138 let currentHeading = "";
139 window.onscroll = function () {
140 let h = document.querySelectorAll("h1,h2,h3,h4,h5,h6");
141 let elementArr = [];
142
143 h.forEach(item => {
144 if (item.id !== "") {
145 elementArr[item.id] = item.getBoundingClientRect().top;
146 }
147 });
148 elementArr.sort();
149 for (let key in elementArr) {
150 if (!elementArr.hasOwnProperty(key)) {
151 continue;
152 }
153 if (elementArr[key] > 0 && elementArr[key] < 300) {
154 if (currentHeading !== key) {
155 highlightNav(key);
156 currentHeading = key;
157 }
158 break;
159 }
160 }
161 }
162</script>
163
164</html>
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2024-11-23 05:18:26 +0000