From 8d3e32cce0055fbc7505ad4029796df13c9d30c7 Mon Sep 17 00:00:00 2001 From: zano build machine Date: Thu, 26 Sep 2024 14:52:55 +0300 Subject: [PATCH] Auto generated doc --- .../daemon-rpc-api/decrypt_tx_details.md | 55 +++++++++++++++++ .../find_outs_in_recent_blocks.md | 55 +++++++++++++++++ .../rpc-api/daemon-rpc-api/get_asset_info.md | 20 +++---- .../rpc-api/daemon-rpc-api/get_assets_list.md | 20 +++---- .../wallet-rpc-api/assets_whitelist_add.md | 20 +++---- .../wallet-rpc-api/assets_whitelist_get.md | 60 +++++++++---------- .../rpc-api/wallet-rpc-api/burn_asset.md | 4 +- .../rpc-api/wallet-rpc-api/deploy_asset.md | 30 +++++----- .../rpc-api/wallet-rpc-api/emit_asset.md | 10 ++-- .../rpc-api/wallet-rpc-api/getbalance.md | 20 +++---- .../rpc-api/wallet-rpc-api/mw_get_wallets.md | 20 +++---- .../send_ext_signed_asset_tx.md | 44 ++++++++++++++ docs/build/rpc-api/wallet-rpc-api/transfer.md | 8 ++- .../rpc-api/wallet-rpc-api/update_asset.md | 24 ++++---- 14 files changed, 275 insertions(+), 115 deletions(-) create mode 100644 docs/build/rpc-api/daemon-rpc-api/decrypt_tx_details.md create mode 100644 docs/build/rpc-api/daemon-rpc-api/find_outs_in_recent_blocks.md create mode 100644 docs/build/rpc-api/wallet-rpc-api/send_ext_signed_asset_tx.md diff --git a/docs/build/rpc-api/daemon-rpc-api/decrypt_tx_details.md b/docs/build/rpc-api/daemon-rpc-api/decrypt_tx_details.md new file mode 100644 index 0000000..c821247 --- /dev/null +++ b/docs/build/rpc-api/daemon-rpc-api/decrypt_tx_details.md @@ -0,0 +1,55 @@ +Decrypts transaction private information. Should be used only with your own local daemon for security reasons. + +URL: ```http:://127.0.0.1:11211/json_rpc``` +### Request: +```json +{ + "id": 0, + "jsonrpc": "2.0", + "method": "decrypt_tx_details", + "params": { + "outputs_addresses": ["ZxDNaMeZjwCjnHuU5gUNyrP1pM3U5vckbakzzV6dEHyDYeCpW8XGLBFTshcaY8LkG9RQn7FsQx8w2JeJzJwPwuDm2NfixPAXf","ZxBvJDuQjMG9R2j4WnYUhBYNrwZPwuyXrC7FHdVmWqaESgowDvgfWtiXeNGu8Px9B24pkmjsA39fzSSiEQG1ekB225ZnrMTBp"], + "tx_blob": "ewogICJ2ZXJzaW9uIjogMSwgC....iAgInZpbiI6IFsgewogICAgIC", + "tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8", + "tx_secret_key": "2e0b840e70dba386effd64c5d988622dea8c064040566e6bf035034cbb54a5c08" + } +} +``` +### Request description: +``` + "outputs_addresses": Address of each of tx's output. Order is important and should correspond to order of tx's outputs. Empty strings are ignored. + "tx_blob": [or] base64-encoded or hex-encoded tx blob. Can be ommited if tx_id is provided. + "tx_id": [either] ID for a transaction if it is already in the blockchain. Can be ommited if tx_blob is provided. + "tx_secret_key": Hex-encoded transaction secret key. + +``` +### Response: +```json +{ + "id": 0, + "jsonrpc": "2.0", + "result": { + "decoded_outputs": [{ + "address": "ZxBvJDuQjMG9R2j4WnYUhBYNrwZPwuyXrC7FHdVmWqaESgowDvgfWtiXeNGu8Px9B24pkmjsA39fzSSiEQG1ekB225ZnrMTBp", + "amount": 10000000000000, + "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852", + "out_index": 1 + }], + "status": "OK", + "tx_in_json": "ewogICJ2ZXJzaW9uIjogMSwgC....iAgInZpbiI6IFsgewogICAgIC", + "verified_tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8" + } +} +``` +### Response description: +``` + "decoded_outputs": Transaction's decoded outputs + "address": Destination address. + "amount": Amount begin transferred. + "asset_id": Asset id. + "out_index": Index of the corresponding output in the transaction. + "status": Status code of operation, OK if success + "tx_in_json": Serialized transaction represented in JSON, encoded in Base64. + "verified_tx_id": (Re)calculated transaction id. Can be used in third-party proof generation. + +``` diff --git a/docs/build/rpc-api/daemon-rpc-api/find_outs_in_recent_blocks.md b/docs/build/rpc-api/daemon-rpc-api/find_outs_in_recent_blocks.md new file mode 100644 index 0000000..b085256 --- /dev/null +++ b/docs/build/rpc-api/daemon-rpc-api/find_outs_in_recent_blocks.md @@ -0,0 +1,55 @@ +Retrieves information about outputs in recent blocks that are targeted for the given address with the corresponding secret view key. + +URL: ```http:://127.0.0.1:11211/json_rpc``` +### Request: +```json +{ + "id": 0, + "jsonrpc": "2.0", + "method": "find_outs_in_recent_blocks", + "params": { + "address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7", + "blocks_limit": 1711021795, + "viewkey": "5fa8eaaf231a305053260ff91d69c6ef1ecbd0f5" + } +} +``` +### Request description: +``` + "address": Target address for which outputs are being searched + "blocks_limit": Block count limit. If 0, only the transaction pool will be searched. Maximum and default is 5. + "viewkey": Secret view key corresponding to the given address. + +``` +### Response: +```json +{ + "id": 0, + "jsonrpc": "2.0", + "result": { + "blockchain_top_block_height": 2555000, + "blocks_limit": 5, + "outputs": [{ + "amount": 1000000000000, + "asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6", + "output_tx_index": 2, + "tx_block_height": 2555000, + "tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8" + }], + "status": "OK" + } +} +``` +### Response description: +``` + "blockchain_top_block_height": Height of the most recent block in the blockchain. + "blocks_limit": Used limit for block count. + "outputs": List of found outputs. + "amount": The amount of the output. + "asset_id": Asset ID of the output. + "output_tx_index": Index of the output in the transaction. + "tx_block_height": Block height where the transaction is present. + "tx_id": Transaction ID where the output is present, if found. + "status": Status of the call. + +``` diff --git a/docs/build/rpc-api/daemon-rpc-api/get_asset_info.md b/docs/build/rpc-api/daemon-rpc-api/get_asset_info.md index f1751c8..d7bee4f 100644 --- a/docs/build/rpc-api/daemon-rpc-api/get_asset_info.md +++ b/docs/build/rpc-api/daemon-rpc-api/get_asset_info.md @@ -26,11 +26,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_descriptor": { "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }, "status": "OK" @@ -40,14 +40,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` ### Response description: ``` "asset_descriptor": Descriptor of the given asset. - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. "status": Status of the call. ``` diff --git a/docs/build/rpc-api/daemon-rpc-api/get_assets_list.md b/docs/build/rpc-api/daemon-rpc-api/get_assets_list.md index e7f9d72..b74d5fc 100644 --- a/docs/build/rpc-api/daemon-rpc-api/get_assets_list.md +++ b/docs/build/rpc-api/daemon-rpc-api/get_assets_list.md @@ -29,11 +29,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }], "status": "OK" @@ -44,14 +44,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` ``` "assets": List of assets registered in Zano blockchain "asset_id": Asset ID - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. "status": Status code of operation, OK if success ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_add.md b/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_add.md index 75338cf..1972d1a 100644 --- a/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_add.md +++ b/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_add.md @@ -26,11 +26,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_descriptor": { "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }, "status": "OK" @@ -40,14 +40,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` ### Response description: ``` "asset_descriptor": Details of the asset, recieved from node - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. "status": Status of the asset ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_get.md b/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_get.md index d2c2924..5924de1 100644 --- a/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_get.md +++ b/docs/build/rpc-api/wallet-rpc-api/assets_whitelist_get.md @@ -25,33 +25,33 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }], "local_whitelist": [{ "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }], "own_assets": [{ "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }] } @@ -61,33 +61,33 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` ``` "global_whitelist": Global whitelist, well-known assets with adoption, mantained by the team and community "asset_id": Asset ID - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. "local_whitelist": Local whitelist, assets that hase been added to this wallet file manually(!) "asset_id": Asset ID - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. "own_assets": Own assets, the ones that is under control of this wallet "asset_id": Asset ID - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/burn_asset.md b/docs/build/rpc-api/wallet-rpc-api/burn_asset.md index ee16224..9a8330b 100644 --- a/docs/build/rpc-api/wallet-rpc-api/burn_asset.md +++ b/docs/build/rpc-api/wallet-rpc-api/burn_asset.md @@ -25,12 +25,12 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "id": 0, "jsonrpc": "2.0", "result": { - "result_tx": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" + "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" } } ``` ### Response description: ``` - "result_tx": Id of transaction that carries asset burn operation + "tx_id": Id of transaction that carries asset burn operation ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/deploy_asset.md b/docs/build/rpc-api/wallet-rpc-api/deploy_asset.md index 7dcfe8a..1e5d8b0 100644 --- a/docs/build/rpc-api/wallet-rpc-api/deploy_asset.md +++ b/docs/build/rpc-api/wallet-rpc-api/deploy_asset.md @@ -11,36 +11,38 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_descriptor": { "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }, "destinations": [{ "address": "ZxBvJDuQjMG9R2j4WnYUhBYNrwZPwuyXrC7FHdVmWqaESgowDvgfWtiXeNGu8Px9B24pkmjsA39fzSSiEQG1ekB225ZnrMTBp", "amount": 10000000000000, "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852" - }] + }], + "do_not_split_destinations": false } } ``` ### Request description: ``` "asset_descriptor": Descriptor that holds all information about asset - ticker, emission, description etc - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment - "destinations": Addresses where to receive emitted coins. Asset id in destinations should be set to 0000000000000000000000000000000000000000000000000000000000000000 + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. + "destinations": Addresses where to receive emitted coins. Asset id in the destinations is irreleant and can be omitted. "address": Destination address "amount": Amount to transfer to destination "asset_id": Asset id to transfer + "do_not_split_destinations": If true, the provided destinations will be used as-is and won't be splitted (or altered) to avoid common issues. Default is false. ``` ### Response: @@ -50,13 +52,13 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "jsonrpc": "2.0", "result": { "new_asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d", - "result_tx": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" + "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" } } ``` ### Response description: ``` "new_asset_id": Issued asset id - "result_tx": Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed + "tx_id": Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/emit_asset.md b/docs/build/rpc-api/wallet-rpc-api/emit_asset.md index 2478db1..35e7c10 100644 --- a/docs/build/rpc-api/wallet-rpc-api/emit_asset.md +++ b/docs/build/rpc-api/wallet-rpc-api/emit_asset.md @@ -13,17 +13,19 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "address": "ZxBvJDuQjMG9R2j4WnYUhBYNrwZPwuyXrC7FHdVmWqaESgowDvgfWtiXeNGu8Px9B24pkmjsA39fzSSiEQG1ekB225ZnrMTBp", "amount": 10000000000000, "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852" - }] + }], + "do_not_split_destinations": false } } ``` ### Request description: ``` "asset_id": Id of the asset to emit more coins - "destinations": Addresses where to receive emitted coins. Asset id in destinations should be set to 0000000000000000000000000000000000000000000000000000000000000000 + "destinations": Addresses where to receive emitted coins. Asset id in the destinations is irreleant and can be omitted. "address": Destination address "amount": Amount to transfer to destination "asset_id": Asset id to transfer + "do_not_split_destinations": If true, the provided destinations will be used as-is and won't be splitted (or altered) to avoid common issues. Default is false. ``` ### Response: @@ -32,12 +34,12 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "id": 0, "jsonrpc": "2.0", "result": { - "result_tx": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" + "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" } } ``` ### Response description: ``` - "result_tx": Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed + "tx_id": Id of transaction that emits the required asset. ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/getbalance.md b/docs/build/rpc-api/wallet-rpc-api/getbalance.md index b208a64..6993da2 100644 --- a/docs/build/rpc-api/wallet-rpc-api/getbalance.md +++ b/docs/build/rpc-api/wallet-rpc-api/getbalance.md @@ -27,11 +27,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }, "awaiting_in": 1000000000000, @@ -49,14 +49,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "balances": Balances groupped by it's asset_id "asset_info": Asset info details "asset_id": Asset ID - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "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 "total": Total coins available(including locked) diff --git a/docs/build/rpc-api/wallet-rpc-api/mw_get_wallets.md b/docs/build/rpc-api/wallet-rpc-api/mw_get_wallets.md index b419478..b66cd51 100644 --- a/docs/build/rpc-api/wallet-rpc-api/mw_get_wallets.md +++ b/docs/build/rpc-api/wallet-rpc-api/mw_get_wallets.md @@ -30,11 +30,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }, "awaiting_in": 1000000000000, @@ -61,14 +61,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "balances": Balances hold by this wallet "asset_info": Asset info details "asset_id": Asset ID - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "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 "total": Total coins available(including locked) diff --git a/docs/build/rpc-api/wallet-rpc-api/send_ext_signed_asset_tx.md b/docs/build/rpc-api/wallet-rpc-api/send_ext_signed_asset_tx.md new file mode 100644 index 0000000..c5153e7 --- /dev/null +++ b/docs/build/rpc-api/wallet-rpc-api/send_ext_signed_asset_tx.md @@ -0,0 +1,44 @@ +Inserts externally made asset ownership signature into the given transaction and broadcasts it. + +URL: ```http:://127.0.0.1:11211/json_rpc``` +### Request: +```json +{ + "id": 0, + "jsonrpc": "2.0", + "method": "send_ext_signed_asset_tx", + "params": { + "eth_sig": "674bb56a5b4fa562e679ccacc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6add697463498a66de4f1760b2cd40f11c3a00a7a8", + "expected_tx_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d", + "finalized_tx": "ewogICJ2ZXJzaW9uIjogMSwgC....iAgInZpbiI6IFsgewogICAgIC", + "unlock_transfers_on_fail": false, + "unsigned_tx": "083737bcfd826a973f74bb56a52b4fa562e6579ccaadd2697463498a66de4f1760b2cd40f11c3a00a7a80000" + } +} +``` +### Request description: +``` + "eth_sig": HEX-encoded ETH signature (64 bytes) + "expected_tx_id": The expected transaction id. Tx won't be sent if the calculated one doesn't match this one. Consider using 'verified_tx_id' returned by 'decrypt_tx_details' call. + "finalized_tx": Base64-encoded finalized_tx data structure, which was received from emit_asset call. + "unlock_transfers_on_fail": If true, all locked wallet transfers, corresponding to the transaction, will be unlocked on sending failure. False by default. + "unsigned_tx": Base64-encoded unsigned transaction blob, which was received from emit_asset call. + +``` +### Response: +```json +{ + "id": 0, + "jsonrpc": "2.0", + "result": { + "status": "OK", + "transfers_were_unlocked": false + } +} +``` +### Response description: +``` + "status": Status of the call + "transfers_were_unlocked": If true, all input transfers that were locked when preparing this transaction, are now unlocked and may be spent. Can be true only upon sending failure and if requested. + +``` diff --git a/docs/build/rpc-api/wallet-rpc-api/transfer.md b/docs/build/rpc-api/wallet-rpc-api/transfer.md index eaa6448..44ca671 100644 --- a/docs/build/rpc-api/wallet-rpc-api/transfer.md +++ b/docs/build/rpc-api/wallet-rpc-api/transfer.md @@ -17,7 +17,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "fee": 10000000000, "hide_receiver": true, "mixin": 15, - "payment_id": "1dfe5a88ff9effb3", + "payment_id": "", "push_payer": false, "service_entries": [{ "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85", @@ -57,13 +57,15 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "id": 0, "jsonrpc": "2.0", "result": { - "tx_hash": "", - "tx_size": 0, + "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93", + "tx_size": 1234, "tx_unsigned_hex": "" } } ``` ### Response description: ``` + "tx_hash": Has of the generated transaction(if succeded) + "tx_size": Transaction size in bytes ``` diff --git a/docs/build/rpc-api/wallet-rpc-api/update_asset.md b/docs/build/rpc-api/wallet-rpc-api/update_asset.md index ff960b7..aa57da7 100644 --- a/docs/build/rpc-api/wallet-rpc-api/update_asset.md +++ b/docs/build/rpc-api/wallet-rpc-api/update_asset.md @@ -11,11 +11,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "asset_descriptor": { "current_supply": 500000000000000000, "decimal_point": 12, - "full_name": "Zano wrapped USD", + "full_name": "Zano wrapped ABC", "hidden_supply": false, "meta_info": "Stable and private", "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8", - "ticker": "ZUSD", + "ticker": "ZABC", "total_max_supply": 1000000000000000000 }, "asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d" @@ -25,14 +25,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` ### Request description: ``` "asset_descriptor": Descriptor that holds all information about asset that need to be updated (only owner could be updated) - "current_supply": Currently emitted supply for given asset (ignored for REGISTER operation) - "decimal_point": Decimal point - "full_name": Full name of the asset - "hidden_supply": This one reserved for future use, will be documented later - "meta_info": Any other information assetiaded with asset in a free form - "owner": Owner's key, used only for EMIT and UPDATE validation, could be changed by transferring asset ownership - "ticker": Ticker associated with asset - "total_max_supply": Maximum possible supply for given asset, can't be changed after deployment + "current_supply": Currently emitted supply for the given asset (ignored for REGISTER operation). + "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. + "owner": Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership. + "ticker": Ticker associated with the asset. + "total_max_supply": Maximum possible supply for a given asset, cannot be changed after deployment. "asset_id": Id of the asset to update ``` @@ -42,12 +42,12 @@ URL: ```http:://127.0.0.1:11211/json_rpc``` "id": 0, "jsonrpc": "2.0", "result": { - "result_tx": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" + "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8" } } ``` ### Response description: ``` - "result_tx": Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed + "tx_id": Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed ```