feat(sudt-demo): add api doc

ckb-js · Sep 26, 2023 · 9040a1b · 9040a1b
1 parent 49bac61
commit 9040a1b
Showing 1 changed file with 186 additions and 0 deletions.
diff --git a/packages/samples/sudt/README.md b/packages/samples/sudt/README.md
@@ -9,3 +9,189 @@ npm run build
 
 node ./dist/src/main.js
 ```
+
+## API Doc
+
+### Create Token
+
+path: /token
+
+method: POST
+
+#### Request
+
+```javascript
+{
+  "symbol": "USDT",
+  "name": "USDT",
+  "amount": "100000",
+  "decimal": "18",
+  "description": "",
+  "website": "",
+  "icon": ""
+}
+```
+
+#### Reponse
+
+```javascript
+{
+  "code": 201,
+  "data": {
+    "url": "" // direct to explorer to the transaction to issue the token
+  }
+}
+```
+
+### Update Token
+
+path: /token
+
+method: PUT
+
+#### Request
+
+```javascript
+{
+  "symbol": "USDT",
+  "name": "USDT",
+  "amount": "100000",
+  "decimal": "18",
+  "description": "",
+  "website": "",
+  "icon": "",
+  "args": "", // sudt args
+  "signature": ""
+}
+```
+
+#### Response
+
+```javascript
+{
+  "code": 201,
+  "data": {}
+}
+```
+
+### Transfer Token
+
+path: /token/transfer
+
+method: POST
+
+#### Request
+
+```javascript
+{
+  "token": "", // token args
+  "amount": "",
+  "to": ""
+}
+```
+
+### Token List
+
+path: /token
+
+#### Request
+
+| param   | type   | position | description  |
+| ------- | ------ | -------- | ------------ |
+| address | string | query    | user address |
+
+method: GET
+
+#### Response
+
+```javascript
+[
+  {
+    symbol: 'USDT',
+    name: 'USDT',
+    amount: '100000',
+    decimal: '18',
+    description: '',
+    website: '',
+    icon: '',
+  },
+];
+```
+
+### Token Detail
+
+path: /token/:args
+
+method: GET
+
+#### Response
+
+```javascript
+{
+  "code": 200,
+  "data": {
+    "symbol": "USDT",
+    "name": "USDT",
+    "amount": "100000",
+    "decimal": "18",
+    "description": "",
+    "website": "",
+    "icon": "",
+    "url": "",
+    "issuser": ""
+  }
+}
+```
+
+### Asset List
+
+path: /assets
+
+method: GET
+
+#### Request
+
+| param   | type   | position | description  |
+| ------- | ------ | -------- | ------------ |
+| address | string | query    | user address |
+
+#### Response
+
+```javascript
+{
+  "code": 200,
+  "data": [
+      {
+        "symbol": "USDT",
+        "name": "USDT",
+        "amount": ""
+      }
+    ]
+}
+```
+
+### Token Transfer History
+
+path: /token/transfer/history
+
+method: GET
+
+#### Response
+
+```javascript
+{
+  "code": 200,
+  "data": [
+    {
+      "txHash": "",
+      "from": "",
+      "to": "",
+      "time": "",
+      "status": "",
+      "sudtAmount": "",
+      "CKBAmount": "",
+      "url": "",
+    }
+  ]
+}
+```