From cb9f0bc4f8426ad12ef50d41fa1b94bb127bdae4 Mon Sep 17 00:00:00 2001 From: linaly Date: Tue, 28 Nov 2023 10:47:10 +0000 Subject: [PATCH] update doc --- docs/api_data.js | 59 ++++++++++++++++++++++++++++++++++++++++++++++ docs/api_data.json | 59 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 118 insertions(+) diff --git a/docs/api_data.js b/docs/api_data.js index 612afe0..21705ae 100644 --- a/docs/api_data.js +++ b/docs/api_data.js @@ -7878,6 +7878,65 @@ define({ "api": [ "filename": "src/apis/apiInstance.js", "groupTitle": "Service" }, + { + "name": "hasHackerAccount", + "group": "Service", + "type": "CONNECT", + "url": "/ws/v3/YOUR-API-KEY", + "title": "hasHackerAccount", + "version": "1.3.0", + "description": "

Check if address list contrains hacker account.

Returns:
«Promise,undefined» Returns undefined if used with callback or a promise otherwise.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "object", + "optional": false, + "field": "object.", + "description": "


  address - The Array of address you want to check.

" + }, + { + "group": "Parameter", + "type": "function", + "optional": true, + "field": "callback", + "description": "

Optional, the callback will receive two parameters:
  err - If an error occurred.
  result - The saved result.

" + } + ] + }, + "examples": [ + { + "title": "JSON-RPC over websocket", + "content": "{\"jsonrpc\":\"2.0\",\"method\":\"hasHackerAccount\",\"params\":{address:[\"0x420000000000000000000000000000000000000a\"]},\"id\":1}", + "type": "string" + } + ] + }, + "examples": [ + { + "title": "Example callback usage:", + "content": " const ApiInstance = require('iwan-sdk');\n let apiTest = new ApiInstance(YOUR-API-KEY, YOUR-SECRET-KEY);\n apiTest.hasHackerAccount([\"0x420000000000000000000000000000000000000a\"]}, (err, result) => {\n console.log(\"Result is \", result);\n apiTest.close();\n });", + "type": "nodejs" + }, + { + "title": "Example promise usage:", + "content": " const ApiInstance = require('iwan-sdk');\n let apiTest = new ApiInstance(YOUR-API-KEY, YOUR-SECRET-KEY);\n let result = await apiTest.hasHackerAccount([\"0x420000000000000000000000000000000000000a\"]);\n console.log(\"Result is \", result);\n apiTest.close();", + "type": "nodejs" + } + ], + "success": { + "examples": [ + { + "title": "Successful Response", + "content": " false", + "type": "json" + } + ] + }, + "filename": "src/apis/apiInstance.js", + "groupTitle": "Service" + }, { "name": "getGasPrice", "group": "Status", diff --git a/docs/api_data.json b/docs/api_data.json index d849ae3..947c218 100644 --- a/docs/api_data.json +++ b/docs/api_data.json @@ -7878,6 +7878,65 @@ "filename": "src/apis/apiInstance.js", "groupTitle": "Service" }, + { + "name": "hasHackerAccount", + "group": "Service", + "type": "CONNECT", + "url": "/ws/v3/YOUR-API-KEY", + "title": "hasHackerAccount", + "version": "1.3.0", + "description": "

Check if address list contrains hacker account.

Returns:
«Promise,undefined» Returns undefined if used with callback or a promise otherwise.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "object", + "optional": false, + "field": "object.", + "description": "


  address - The Array of address you want to check.

" + }, + { + "group": "Parameter", + "type": "function", + "optional": true, + "field": "callback", + "description": "

Optional, the callback will receive two parameters:
  err - If an error occurred.
  result - The saved result.

" + } + ] + }, + "examples": [ + { + "title": "JSON-RPC over websocket", + "content": "{\"jsonrpc\":\"2.0\",\"method\":\"hasHackerAccount\",\"params\":{address:[\"0x420000000000000000000000000000000000000a\"]},\"id\":1}", + "type": "string" + } + ] + }, + "examples": [ + { + "title": "Example callback usage:", + "content": " const ApiInstance = require('iwan-sdk');\n let apiTest = new ApiInstance(YOUR-API-KEY, YOUR-SECRET-KEY);\n apiTest.hasHackerAccount([\"0x420000000000000000000000000000000000000a\"]}, (err, result) => {\n console.log(\"Result is \", result);\n apiTest.close();\n });", + "type": "nodejs" + }, + { + "title": "Example promise usage:", + "content": " const ApiInstance = require('iwan-sdk');\n let apiTest = new ApiInstance(YOUR-API-KEY, YOUR-SECRET-KEY);\n let result = await apiTest.hasHackerAccount([\"0x420000000000000000000000000000000000000a\"]);\n console.log(\"Result is \", result);\n apiTest.close();", + "type": "nodejs" + } + ], + "success": { + "examples": [ + { + "title": "Successful Response", + "content": " false", + "type": "json" + } + ] + }, + "filename": "src/apis/apiInstance.js", + "groupTitle": "Service" + }, { "name": "getGasPrice", "group": "Status",