Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@gao623
gao623 committed Dec 5, 2023
1 parent c20b67f commit 0aae9b8
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 0 deletions.
66 changes: 66 additions & 0 deletions docs/api_data.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2859,6 +2859,72 @@ define({ "api": [
"filename": "src/apis/apiInstance.js",
"groupTitle": "CrossChain"
},
{
"name": "getChainParameters",
"group": "CrossChain",
"type": "CONNECT",
"url": "/ws/v3/YOUR-API-KEY",
"title": "getChainParameters",
"version": "1.3.0",
"description": "<p>Get the parameters of the blockchain used for witnessses to create a proposal. <br><br><strong>Returns:</strong> <br><font color=&#39;blue&#39;>«Promise,undefined»</font> Returns undefined if used with callback or a promise otherwise.</p> ",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "chainType",
"description": "<p>The chain being queried. Currently supports <code>&quot;TRX&quot;</code>.</p> "
},
{
"group": "Parameter",
"type": "object",
"optional": true,
"field": "options",
"description": ""
},
{
"group": "Parameter",
"type": "function",
"optional": true,
"field": "callback",
"description": "<p>Optional, the callback will receive two parameters: <br>&nbsp;&nbsp;<code>err</code> - If an error occurred. <br>&nbsp;&nbsp;<code>result</code> - The saved result.</p> "
}
]
},
"examples": [
{
"title": "JSON-RPC over websocket",
"content": "{\"jsonrpc\":\"2.0\",\"method\":\"getChainParameters\",\"params\":{\"chainType\":\"TRX\"},\"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.getChainParameters(\"TRX\", (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.getChainParameters(\"TRX\");\n console.log(\"Result is \", result);\n apiTest.close();",
"type": "nodejs"
}
],
"success": {
"examples": [
{
"title": "Successful Response",
"content": " [ { key: 'getMaintenanceTimeInterval', value: 21600000 },\n { key: 'getAccountUpgradeCost', value: 9999000000 },\n { key: 'getCreateAccountFee', value: 100000 },\n { key: 'getTransactionFee', value: 10 },\n { key: 'getAssetIssueFee', value: 1024000000 },\n { key: 'getWitnessPayPerBlock', value: 32000000 },\n { key: 'getWitnessStandbyAllowance', value: 115200000000 },\n { key: 'getCreateNewAccountFeeInSystemContract' },\n { key: 'getCreateNewAccountBandwidthRate', value: 1 },\n { key: 'getAllowCreationOfContracts', value: 1 },\n { key: 'getRemoveThePowerOfTheGr', value: -1 },\n { key: 'getEnergyFee', value: 10 },\n { key: 'getExchangeCreateFee', value: 1024000000 },\n { key: 'getMaxCpuTimeOfOneTx', value: 50 },\n { key: 'getAllowUpdateAccountName' },\n { key: 'getAllowSameTokenName', value: 1 },\n { key: 'getAllowDelegateResource', value: 1 },\n { key: 'getTotalEnergyLimit', value: 100000000000 },\n { key: 'getAllowTvmTransferTrc10', value: 1 },\n { key: 'getTotalEnergyCurrentLimit', value: 100000000000 },\n { key: 'getAllowMultiSign' },\n { key: 'getAllowAdaptiveEnergy' },\n { key: 'getTotalEnergyTargetLimit', value: 6944444 },\n { key: 'getTotalEnergyAverageUsage' },\n { key: 'getUpdateAccountPermissionFee', value: 100000000 },\n { key: 'getMultiSignFee', value: 1000000 } ]",
"type": "json"
}
]
},
"filename": "src/apis/apiInstance.js",
"groupTitle": "CrossChain"
},
{
"name": "getCoin2WanRatio",
"group": "CrossChain",
Expand Down
66 changes: 66 additions & 0 deletions docs/api_data.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2859,6 +2859,72 @@
"filename": "src/apis/apiInstance.js",
"groupTitle": "CrossChain"
},
{
"name": "getChainParameters",
"group": "CrossChain",
"type": "CONNECT",
"url": "/ws/v3/YOUR-API-KEY",
"title": "getChainParameters",
"version": "1.3.0",
"description": "<p>Get the parameters of the blockchain used for witnessses to create a proposal. <br><br><strong>Returns:</strong> <br><font color=&#39;blue&#39;>«Promise,undefined»</font> Returns undefined if used with callback or a promise otherwise.</p> ",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "chainType",
"description": "<p>The chain being queried. Currently supports <code>&quot;TRX&quot;</code>.</p> "
},
{
"group": "Parameter",
"type": "object",
"optional": true,
"field": "options",
"description": ""
},
{
"group": "Parameter",
"type": "function",
"optional": true,
"field": "callback",
"description": "<p>Optional, the callback will receive two parameters: <br>&nbsp;&nbsp;<code>err</code> - If an error occurred. <br>&nbsp;&nbsp;<code>result</code> - The saved result.</p> "
}
]
},
"examples": [
{
"title": "JSON-RPC over websocket",
"content": "{\"jsonrpc\":\"2.0\",\"method\":\"getChainParameters\",\"params\":{\"chainType\":\"TRX\"},\"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.getChainParameters(\"TRX\", (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.getChainParameters(\"TRX\");\n console.log(\"Result is \", result);\n apiTest.close();",
"type": "nodejs"
}
],
"success": {
"examples": [
{
"title": "Successful Response",
"content": " [ { key: 'getMaintenanceTimeInterval', value: 21600000 },\n { key: 'getAccountUpgradeCost', value: 9999000000 },\n { key: 'getCreateAccountFee', value: 100000 },\n { key: 'getTransactionFee', value: 10 },\n { key: 'getAssetIssueFee', value: 1024000000 },\n { key: 'getWitnessPayPerBlock', value: 32000000 },\n { key: 'getWitnessStandbyAllowance', value: 115200000000 },\n { key: 'getCreateNewAccountFeeInSystemContract' },\n { key: 'getCreateNewAccountBandwidthRate', value: 1 },\n { key: 'getAllowCreationOfContracts', value: 1 },\n { key: 'getRemoveThePowerOfTheGr', value: -1 },\n { key: 'getEnergyFee', value: 10 },\n { key: 'getExchangeCreateFee', value: 1024000000 },\n { key: 'getMaxCpuTimeOfOneTx', value: 50 },\n { key: 'getAllowUpdateAccountName' },\n { key: 'getAllowSameTokenName', value: 1 },\n { key: 'getAllowDelegateResource', value: 1 },\n { key: 'getTotalEnergyLimit', value: 100000000000 },\n { key: 'getAllowTvmTransferTrc10', value: 1 },\n { key: 'getTotalEnergyCurrentLimit', value: 100000000000 },\n { key: 'getAllowMultiSign' },\n { key: 'getAllowAdaptiveEnergy' },\n { key: 'getTotalEnergyTargetLimit', value: 6944444 },\n { key: 'getTotalEnergyAverageUsage' },\n { key: 'getUpdateAccountPermissionFee', value: 100000000 },\n { key: 'getMultiSignFee', value: 1000000 } ]",
"type": "json"
}
]
},
"filename": "src/apis/apiInstance.js",
"groupTitle": "CrossChain"
},
{
"name": "getCoin2WanRatio",
"group": "CrossChain",
Expand Down

0 comments on commit 0aae9b8

Please sign in to comment.