lthn/docs
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Auto generated doc

Browse source
This commit is contained in:
zano build machine 2025-02-10 23:04:01 +03:00
parent cff2ca7f17
commit 3ee92b13fc
10 changed files with 32 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/build/rpc-api/daemon-rpc-api/get_asset_info.md vendored
View file

@ -28,7 +28,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -45,7 +45,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.

4
docs/build/rpc-api/daemon-rpc-api/get_assets_list.md vendored
View file

@ -31,7 +31,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -49,7 +49,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.

27
docs/build/rpc-api/daemon-rpc-api/start_mining.md vendored
View file

@ -1,27 +0,0 @@
Initiates PoW mining process on a node using the specified miner address and the number of CPU threads.
URL: ```http:://127.0.0.1:11211/start_mining```
### Request:
```json
{
"miner_address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"threads_count": 2
}
```
### Request description:
```
"miner_address": The address where the mining rewards will be deposited.
"threads_count": The number of CPU threads to use for mining.
```
### Response:
```json
{
"status": "OK"
}
```
### Response description:
```
"status": Status of the call.
```

23
docs/build/rpc-api/daemon-rpc-api/stop_mining.md vendored
View file

@ -1,23 +0,0 @@
Stop PoW mining process on CPU.
URL: ```http:://127.0.0.1:11211/stop_mining```
### Request:
```json
{
}
```
### Request description:
```
```
### Response:
```json
{
"status": "OK"
}
```
### Response description:
```
"status": Status of the call.
```

4
docs/build/rpc-api/wallet-rpc-api/assets_whitelist_add.md vendored
View file

@ -28,7 +28,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -45,7 +45,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.

12
docs/build/rpc-api/wallet-rpc-api/assets_whitelist_get.md vendored
View file

@ -27,7 +27,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -39,7 +39,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -51,7 +51,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -68,7 +68,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.
@ -79,7 +79,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.
@ -90,7 +90,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.

4
docs/build/rpc-api/wallet-rpc-api/deploy_asset.md vendored
View file

@ -13,7 +13,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -35,7 +35,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.

10
docs/build/rpc-api/wallet-rpc-api/getbalance.md vendored
View file

@ -29,7 +29,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -37,6 +37,9 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
},
"awaiting_in": 1000000000000,
"awaiting_out": 2000000000000,
"outs_amount_max": 2000000000000,
"outs_amount_min": 2000000000000,
"outs_count": 7,
"total": 100000000000000,
"unlocked": 50000000000000
}],
@ -54,13 +57,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.
"total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment.
"awaiting_in": Unconfirmed amount for receive
"awaiting_out": Unconfirmed amount for send
"outs_amount_max": Output's maximum amount
"outs_amount_min": Output's minimum amount
"outs_count": Number of total unspent outputs (including locked)
"total": Total coins available(including locked)
"unlocked": Unlocked coins available(the ones that could be used right now)
"unlocked_balance": Native coins total unlocked amount

10
docs/build/rpc-api/wallet-rpc-api/mw_get_wallets.md vendored
View file

@ -32,7 +32,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -40,6 +40,9 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
},
"awaiting_in": 1000000000000,
"awaiting_out": 2000000000000,
"outs_amount_max": 2000000000000,
"outs_amount_min": 2000000000000,
"outs_count": 7,
"total": 100000000000000,
"unlocked": 50000000000000
}],
@ -66,13 +69,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.
"total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment.
"awaiting_in": Unconfirmed amount for receive
"awaiting_out": Unconfirmed amount for send
"outs_amount_max": Output's maximum amount
"outs_amount_min": Output's minimum amount
"outs_count": Number of total unspent outputs (including locked)
"total": Total coins available(including locked)
"unlocked": Unlocked coins available(the ones that could be used right now)
"has_bare_unspent_outputs": Flag indicating whether the wallet has bare unspent outputs(pre-zarcanum outputs)

4
docs/build/rpc-api/wallet-rpc-api/update_asset.md vendored
View file

@ -13,7 +13,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": 12,
"full_name": "Zano wrapped ABC",
"hidden_supply": false,
"meta_info": "Stable and private",
"meta_info": "{ \"logo_url\": \"https:\/\/some.nice.logo.png\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
@ -30,7 +30,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"decimal_point": Decimal point.
"full_name": Full name of the asset.
"hidden_supply": This field is reserved for future use and will be documented later.
"meta_info": Any other information associated with the asset in free form.
"meta_info": Any other information associated with the asset, by default in a json format.
"owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
"owner_eth_pub_key": [Optional] Owner's key in the case when ETH signature is used.
"ticker": Ticker associated with the asset.