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 2024-06-29 01:43:31 +03:00
parent 833eb9cd36
commit 1d938ca43d
40 changed files with 669 additions and 216 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/build/rpc-api/daemon-rpc-api/force_relay.md vendored
View file

@ -4,10 +4,12 @@ URL: ```http:://127.0.0.1:11211/force_relay```
### Request:
```json
{
"txs_as_hex": ["000535b8b2e.....3685a86","00087368b2e.....349b77f"]
}
```
### Request description:
```
"txs_as_hex": List of transactions as a hexadecimal strings.
```
### Response:

11
docs/build/rpc-api/daemon-rpc-api/get_alias_by_address.md vendored
View file

@ -20,12 +20,23 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"alias_info_list": [{
"address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"status": "OK"
}
}
```
### Response description:
```
"alias_info_list": List of alias_rpc_details objects, each containing detailed information about each alias registered to the specified address.
"address": Address of the alias.
"alias": Alias itself, a brief shortcut for an address.
"comment": Arbitrary comment (optional).
"tracking_key": View secret key of the corresponding address (optional).
"status": Status of the call.
```

2
docs/build/rpc-api/daemon-rpc-api/get_alias_details.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_alias_details",
"params": {
"alias": ""
"alias": "gigabyted"
}
}
```

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

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_alias_reward",
"params": {
"alias": ""
"alias": "zxdya6q6whzwqjkmtcsjpc3ku"
}
}
```
@ -23,7 +23,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"reward": 0,
"reward": 100000000000,
"status": "OK"
}
}

22
docs/build/rpc-api/daemon-rpc-api/get_aliases.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_aliases",
"params": {
"count": 0,
"count": 2,
"offset": 0
}
}
@ -25,12 +25,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases": [{
"address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
},{
"address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"status": "OK"
}
}
```
### Response description:
```
"aliases": List of alias_rpc_details objects, each containing information about an individual alias retrieved based on the request parameters.
"address": Address of the alias.
"alias": Alias itself, a brief shortcut for an address.
"comment": Arbitrary comment (optional).
"tracking_key": View secret key of the corresponding address (optional).
"address": Address of the alias.
"alias": Alias itself, a brief shortcut for an address.
"comment": Arbitrary comment (optional).
"tracking_key": View secret key of the corresponding address (optional).
"status": Status of the call.
```

20
docs/build/rpc-api/daemon-rpc-api/get_all_alias_details.md vendored
View file

@ -21,12 +21,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases": [{
"address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
},{
"address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"status": "OK"
}
}
```
### Response description:
```
"aliases": List of alias_rpc_details objects, each containing information about an individual alias.
"address": Address of the alias.
"alias": Alias itself, a brief shortcut for an address.
"comment": Arbitrary comment (optional).
"tracking_key": View secret key of the corresponding address (optional).
"address": Address of the alias.
"alias": Alias itself, a brief shortcut for an address.
"comment": Arbitrary comment (optional).
"tracking_key": View secret key of the corresponding address (optional).
"status": Status of the call.
```

2
docs/build/rpc-api/daemon-rpc-api/get_all_pool_tx_list.md vendored
View file

@ -21,12 +21,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"ids": [""],
"status": "OK"
}
}
```
### Response description:
```
"ids": List of all transaction IDs currently in the transaction pool.
"status": Status of the call.
```

96
docs/build/rpc-api/daemon-rpc-api/get_alt_block_details.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_alt_block_details",
"params": {
"id": ""
"id": "4cf2c7c7e16d1a2a0771cd552c696dd94e7db4e1031982ed88eff99d5006ee4a"
}
}
```
@ -24,41 +24,65 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"result": {
"block_details": {
"actual_timestamp": 0,
"already_generated_coins": "",
"base_reward": 0,
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 0,
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "",
"cumulative_diff_precise": "",
"difficulty": "",
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 0,
"id": "",
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "",
"summary_reward": 0,
"this_block_fee_median": 0,
"timestamp": 0,
"total_fee": 0,
"total_txs_size": 0,
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 0,
"blob": "",
"blob_size": 0,
"fee": 0,
"id": "",
"keeper_block": 0,
"object_in_json": "",
"pub_key": "",
"timestamp": 0
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"type": 0
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"global_indexes": [0,2,12,27],
"htlc_origin": "",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"global_index": 0,
"is_spent": false,
"minimum_sigs": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
},
"status": "OK"
}
@ -89,12 +113,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"total_txs_size": Total size of all transactions included in the block.
"transactions_details": Detailed information about each transaction included in the block.
"amount": Total output amount of the transaction (legacy, for pre-Zarcanum txs).
"attachments": Additional attachments to the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"blob": Serialized form of the transaction, encoded in Base64.
"blob_size": Size of the serialized transaction in bytes.
"extra": Extra data associated with the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"ins": Inputs of the transaction.
"amount": The amount of coins being transacted.
"global_indexes": List of global indexes indicating the outputs referenced by this input, where only one is actually being spent.
"htlc_origin": Origin hash for HTLC (Hash Time Locked Contract).
"kimage_or_ms_id": Contains either the key image for the input or the multisig output ID, depending on the input type.
"multisig_count": Number of multisig signatures used, relevant only for multisig outputs.
"keeper_block": Block height where the transaction is confirmed, or -1 if it is unconfirmed.
"object_in_json": Serialized transaction represented in JSON, encoded in Base64.
"outs": Outputs of the transaction.
"amount": The output's amount, 0 for ZC outputs.
"global_index": Global index of the output for this specific amount.
"is_spent": Indicates whether the output has been spent.
"minimum_sigs": Minimum number of signatures required to spend the output, for multisig outputs only.
"pub_keys": List of public keys associated with the output.
"pub_key": Public key associated with the transaction.
"timestamp": Timestamp when the transaction was created.
"type": Type of the block.

96
docs/build/rpc-api/daemon-rpc-api/get_alt_blocks_details.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_alt_blocks_details",
"params": {
"count": 0,
"count": 1,
"offset": 0
}
}
@ -26,41 +26,65 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"result": {
"blocks": [{
"actual_timestamp": 0,
"already_generated_coins": "",
"base_reward": 0,
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 0,
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "",
"cumulative_diff_precise": "",
"difficulty": "",
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 0,
"id": "",
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "",
"summary_reward": 0,
"this_block_fee_median": 0,
"timestamp": 0,
"total_fee": 0,
"total_txs_size": 0,
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 0,
"blob": "",
"blob_size": 0,
"fee": 0,
"id": "",
"keeper_block": 0,
"object_in_json": "",
"pub_key": "",
"timestamp": 0
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"type": 0
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"global_indexes": [0,2,12,27],
"htlc_origin": "",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"global_index": 0,
"is_spent": false,
"minimum_sigs": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
}],
"status": "OK"
}
@ -91,12 +115,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"total_txs_size": Total size of all transactions included in the block.
"transactions_details": Detailed information about each transaction included in the block.
"amount": Total output amount of the transaction (legacy, for pre-Zarcanum txs).
"attachments": Additional attachments to the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"blob": Serialized form of the transaction, encoded in Base64.
"blob_size": Size of the serialized transaction in bytes.
"extra": Extra data associated with the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"ins": Inputs of the transaction.
"amount": The amount of coins being transacted.
"global_indexes": List of global indexes indicating the outputs referenced by this input, where only one is actually being spent.
"htlc_origin": Origin hash for HTLC (Hash Time Locked Contract).
"kimage_or_ms_id": Contains either the key image for the input or the multisig output ID, depending on the input type.
"multisig_count": Number of multisig signatures used, relevant only for multisig outputs.
"keeper_block": Block height where the transaction is confirmed, or -1 if it is unconfirmed.
"object_in_json": Serialized transaction represented in JSON, encoded in Base64.
"outs": Outputs of the transaction.
"amount": The output's amount, 0 for ZC outputs.
"global_index": Global index of the output for this specific amount.
"is_spent": Indicates whether the output has been spent.
"minimum_sigs": Minimum number of signatures required to spend the output, for multisig outputs only.
"pub_keys": List of public keys associated with the output.
"pub_key": Public key associated with the transaction.
"timestamp": Timestamp when the transaction was created.
"type": Type of the block.

98
docs/build/rpc-api/daemon-rpc-api/get_blocks_details.md vendored
View file

@ -8,8 +8,8 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_blocks_details",
"params": {
"count": 0,
"height_start": 0,
"count": 1,
"height_start": 51,
"ignore_transactions": false
}
}
@ -27,41 +27,65 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"result": {
"blocks": [{
"actual_timestamp": 0,
"already_generated_coins": "",
"base_reward": 0,
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 0,
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "",
"cumulative_diff_precise": "",
"difficulty": "",
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 0,
"id": "",
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "",
"summary_reward": 0,
"this_block_fee_median": 0,
"timestamp": 0,
"total_fee": 0,
"total_txs_size": 0,
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 0,
"blob": "",
"blob_size": 0,
"fee": 0,
"id": "",
"keeper_block": 0,
"object_in_json": "",
"pub_key": "",
"timestamp": 0
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"type": 0
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"global_indexes": [0,2,12,27],
"htlc_origin": "",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"global_index": 0,
"is_spent": false,
"minimum_sigs": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
}],
"status": "OK"
}
@ -92,12 +116,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"total_txs_size": Total size of all transactions included in the block.
"transactions_details": Detailed information about each transaction included in the block.
"amount": Total output amount of the transaction (legacy, for pre-Zarcanum txs).
"attachments": Additional attachments to the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"blob": Serialized form of the transaction, encoded in Base64.
"blob_size": Size of the serialized transaction in bytes.
"extra": Extra data associated with the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"ins": Inputs of the transaction.
"amount": The amount of coins being transacted.
"global_indexes": List of global indexes indicating the outputs referenced by this input, where only one is actually being spent.
"htlc_origin": Origin hash for HTLC (Hash Time Locked Contract).
"kimage_or_ms_id": Contains either the key image for the input or the multisig output ID, depending on the input type.
"multisig_count": Number of multisig signatures used, relevant only for multisig outputs.
"keeper_block": Block height where the transaction is confirmed, or -1 if it is unconfirmed.
"object_in_json": Serialized transaction represented in JSON, encoded in Base64.
"outs": Outputs of the transaction.
"amount": The output's amount, 0 for ZC outputs.
"global_index": Global index of the output for this specific amount.
"is_spent": Indicates whether the output has been spent.
"minimum_sigs": Minimum number of signatures required to spend the output, for multisig outputs only.
"pub_keys": List of public keys associated with the output.
"pub_key": Public key associated with the transaction.
"timestamp": Timestamp when the transaction was created.
"type": Type of the block.

2
docs/build/rpc-api/daemon-rpc-api/get_current_core_tx_expiration_median.md vendored
View file

@ -21,7 +21,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"expiration_median": 0,
"expiration_median": 1719591540,
"status": "OK"
}
}

96
docs/build/rpc-api/daemon-rpc-api/get_main_block_details.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_main_block_details",
"params": {
"id": ""
"id": "4cf2c7c7e16d1a2a0771cd552c696dd94e7db4e1031982ed88eff99d5006ee4a"
}
}
```
@ -24,41 +24,65 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"result": {
"block_details": {
"actual_timestamp": 0,
"already_generated_coins": "",
"base_reward": 0,
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 0,
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "",
"cumulative_diff_precise": "",
"difficulty": "",
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 0,
"id": "",
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "",
"summary_reward": 0,
"this_block_fee_median": 0,
"timestamp": 0,
"total_fee": 0,
"total_txs_size": 0,
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 0,
"blob": "",
"blob_size": 0,
"fee": 0,
"id": "",
"keeper_block": 0,
"object_in_json": "",
"pub_key": "",
"timestamp": 0
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"type": 0
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"global_indexes": [0,2,12,27],
"htlc_origin": "",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"global_index": 0,
"is_spent": false,
"minimum_sigs": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
},
"status": "OK"
}
@ -89,12 +113,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"total_txs_size": Total size of all transactions included in the block.
"transactions_details": Detailed information about each transaction included in the block.
"amount": Total output amount of the transaction (legacy, for pre-Zarcanum txs).
"attachments": Additional attachments to the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"blob": Serialized form of the transaction, encoded in Base64.
"blob_size": Size of the serialized transaction in bytes.
"extra": Extra data associated with the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"ins": Inputs of the transaction.
"amount": The amount of coins being transacted.
"global_indexes": List of global indexes indicating the outputs referenced by this input, where only one is actually being spent.
"htlc_origin": Origin hash for HTLC (Hash Time Locked Contract).
"kimage_or_ms_id": Contains either the key image for the input or the multisig output ID, depending on the input type.
"multisig_count": Number of multisig signatures used, relevant only for multisig outputs.
"keeper_block": Block height where the transaction is confirmed, or -1 if it is unconfirmed.
"object_in_json": Serialized transaction represented in JSON, encoded in Base64.
"outs": Outputs of the transaction.
"amount": The output's amount, 0 for ZC outputs.
"global_index": Global index of the output for this specific amount.
"is_spent": Indicates whether the output has been spent.
"minimum_sigs": Minimum number of signatures required to spend the output, for multisig outputs only.
"pub_keys": List of public keys associated with the output.
"pub_key": Public key associated with the transaction.
"timestamp": Timestamp when the transaction was created.
"type": Type of the block.

6
docs/build/rpc-api/daemon-rpc-api/get_multisig_info.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_multisig_info",
"params": {
"ms_id": ""
"ms_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
```
@ -23,9 +23,9 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"out_no": 0,
"out_no": 11,
"status": "OK",
"tx_id": ""
"tx_id": "a88541e38d64f87c41b9153412d1d7667f6e4337fe429ed1374722355fa7b423"
}
}
```

6
docs/build/rpc-api/daemon-rpc-api/get_out_info.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_out_info",
"params": {
"amount": 0,
"amount": 3000000000000,
"i": 0
}
}
@ -25,9 +25,9 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"out_no": 0,
"out_no": 7,
"status": "OK",
"tx_id": ""
"tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
```

11
docs/build/rpc-api/daemon-rpc-api/get_pool_info.md vendored
View file

@ -21,6 +21,12 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases_que": [{
"address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"error_code": "",
"status": "OK"
}
@ -28,6 +34,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
```
### Response description:
```
"aliases_que": List of aliases from txs that are currently in the tx pool.
"address": Address of the alias.
"alias": Alias itself, a brief shortcut for an address.
"comment": Arbitrary comment (optional).
"tracking_key": View secret key of the corresponding address (optional).
"error_code": Error code, if there's any error (optional).
"status": Status code, OK if succeeded.

15
docs/build/rpc-api/daemon-rpc-api/get_pool_txs_brief_details.md vendored
View file

@ -8,11 +8,13 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_pool_txs_brief_details",
"params": {
"ids": ["bd9a89f95c9115d29540c6778dab9d9798eb251143dcd4b8960fcd9730a1471c","1c938f04c935d976310c4338fc570ea20777951471609f3edecb341ea4932b0a"]
}
}
```
### Request description:
```
"ids": List of transaction IDs.
```
### Response:
@ -21,12 +23,23 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
"status": "OK",
"txs": [{
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"sz": 6142,
"total_amount": 9000000000
}]
}
}
```
### Response description:
```
"status": Status of the call.
"txs": List of transactions with detailed information.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"sz": Size of the transaction in bytes.
"total_amount": Total amount transferred in the transaction (legacy, for pre-Zarcanum txs).
```

69
docs/build/rpc-api/daemon-rpc-api/get_pool_txs_details.md vendored
View file

@ -8,11 +8,13 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_pool_txs_details",
"params": {
"ids": ["bd9a89f95c9115d29540c6778dab9d9798eb251143dcd4b8960fcd9730a1471c","1c938f04c935d976310c4338fc570ea20777951471609f3edecb341ea4932b0a"]
}
}
```
### Request description:
```
"ids": List of transaction IDs.
```
### Response:
@ -21,12 +23,77 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
"status": "OK",
"txs": [{
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"global_indexes": [0,2,12,27],
"htlc_origin": "",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"global_index": 0,
"is_spent": false,
"minimum_sigs": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}]
}
}
```
### Response description:
```
"status": Status of the call.
"txs": List of transactions with detailed information.
"amount": Total output amount of the transaction (legacy, for pre-Zarcanum txs).
"attachments": Additional attachments to the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"blob": Serialized form of the transaction, encoded in Base64.
"blob_size": Size of the serialized transaction in bytes.
"extra": Extra data associated with the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"ins": Inputs of the transaction.
"amount": The amount of coins being transacted.
"global_indexes": List of global indexes indicating the outputs referenced by this input, where only one is actually being spent.
"htlc_origin": Origin hash for HTLC (Hash Time Locked Contract).
"kimage_or_ms_id": Contains either the key image for the input or the multisig output ID, depending on the input type.
"multisig_count": Number of multisig signatures used, relevant only for multisig outputs.
"keeper_block": Block height where the transaction is confirmed, or -1 if it is unconfirmed.
"object_in_json": Serialized transaction represented in JSON, encoded in Base64.
"outs": Outputs of the transaction.
"amount": The output's amount, 0 for ZC outputs.
"global_index": Global index of the output for this specific amount.
"is_spent": Indicates whether the output has been spent.
"minimum_sigs": Minimum number of signatures required to spend the output, for multisig outputs only.
"pub_keys": List of public keys associated with the output.
"pub_key": Public key associated with the transaction.
"timestamp": Timestamp when the transaction was created.
```

64
docs/build/rpc-api/daemon-rpc-api/get_tx_details.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "get_tx_details",
"params": {
"tx_hash": ""
"tx_hash": "d46c415c3aa3f3e17bd0bf85ffb813cacf4d9595d2d5392f42dacbaffcffdc70"
}
}
```
@ -25,15 +25,39 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"result": {
"status": "OK",
"tx_info": {
"amount": 0,
"blob": "",
"blob_size": 0,
"fee": 0,
"id": "",
"keeper_block": 0,
"object_in_json": "",
"pub_key": "",
"timestamp": 0
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"global_indexes": [0,2,12,27],
"htlc_origin": "",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"global_index": 0,
"is_spent": false,
"minimum_sigs": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}
}
}
@ -43,12 +67,32 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"status": Status of the call.
"tx_info": Detailed information about the transaction.
"amount": Total output amount of the transaction (legacy, for pre-Zarcanum txs).
"attachments": Additional attachments to the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"blob": Serialized form of the transaction, encoded in Base64.
"blob_size": Size of the serialized transaction in bytes.
"extra": Extra data associated with the transaction.
"details_view": A detailed representation of the extra entry.
"short_view": A concise representation of the extra entry.
"type": Type of the extra entry in the transaction.
"fee": Transaction fee in the smallest currency unit.
"id": Hash of the transaction.
"ins": Inputs of the transaction.
"amount": The amount of coins being transacted.
"global_indexes": List of global indexes indicating the outputs referenced by this input, where only one is actually being spent.
"htlc_origin": Origin hash for HTLC (Hash Time Locked Contract).
"kimage_or_ms_id": Contains either the key image for the input or the multisig output ID, depending on the input type.
"multisig_count": Number of multisig signatures used, relevant only for multisig outputs.
"keeper_block": Block height where the transaction is confirmed, or -1 if it is unconfirmed.
"object_in_json": Serialized transaction represented in JSON, encoded in Base64.
"outs": Outputs of the transaction.
"amount": The output's amount, 0 for ZC outputs.
"global_index": Global index of the output for this specific amount.
"is_spent": Indicates whether the output has been spent.
"minimum_sigs": Minimum number of signatures required to spend the output, for multisig outputs only.
"pub_keys": List of public keys associated with the output.
"pub_key": Public key associated with the transaction.
"timestamp": Timestamp when the transaction was created.

2
docs/build/rpc-api/daemon-rpc-api/get_tx_pool.bin.md vendored
View file

@ -14,7 +14,7 @@ URL: ```http:://127.0.0.1:11211/get_tx_pool.bin```
```json
{
"status": "OK",
"tx_expiration_ts_median": 0,
"tx_expiration_ts_median": 1711021795,
"txs": ["7d914497d91442f8f3c2268397d914497d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc2f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"]
}
```

18
docs/build/rpc-api/daemon-rpc-api/get_votes.md vendored
View file

@ -28,7 +28,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"error_code": "",
"status": "OK",
"votes": {
"total_pos_blocks": 87482
"total_pos_blocks": 87482,
"votes": [{
"no": 37,
"proposal_id": "ZAP999",
"yes": 42
},{
"no": 37,
"proposal_id": "ZAP999",
"yes": 42
}]
}
}
}
@ -39,5 +48,12 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"status": Status of the call.
"votes": Found votes in the given range.
"total_pos_blocks": Number of blocks in a given range.
"votes": Result of votes in a given range.
"no": Number of negative votes.
"proposal_id": ID of the proposal.
"yes": Nubmer of positve votes.
"no": Number of negative votes.
"proposal_id": ID of the proposal.
"yes": Nubmer of positve votes.
```

2
docs/build/rpc-api/daemon-rpc-api/getblockcount.md vendored
View file

@ -21,7 +21,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"count": 0,
"count": 2697388,
"status": "OK"
}
}

14
docs/build/rpc-api/daemon-rpc-api/getblockheaderbyhash.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getblockheaderbyhash",
"params": {
"hash": ""
"hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f"
}
}
```
@ -25,16 +25,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"result": {
"block_header": {
"depth": 0,
"difficulty": "",
"hash": "",
"height": 0,
"major_version": 0,
"difficulty": "1849593878843995770114",
"hash": "f5df39c4b1590394976aa6e72f04df7836e22dbdfc1e6f61f6cc1b624d83cd94",
"height": 2697404,
"major_version": 3,
"minor_version": 0,
"nonce": 0,
"orphan_status": false,
"prev_hash": "",
"prev_hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f",
"reward": 0,
"timestamp": 0
"timestamp": 1719588270
},
"status": "OK"
}

14
docs/build/rpc-api/daemon-rpc-api/getblockheaderbyheight.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getblockheaderbyheight",
"params": {
"height": 0
"height": 2555000
}
}
```
@ -25,16 +25,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"result": {
"block_header": {
"depth": 0,
"difficulty": "",
"hash": "",
"height": 0,
"major_version": 0,
"difficulty": "1849593878843995770114",
"hash": "f5df39c4b1590394976aa6e72f04df7836e22dbdfc1e6f61f6cc1b624d83cd94",
"height": 2697404,
"major_version": 3,
"minor_version": 0,
"nonce": 0,
"orphan_status": false,
"prev_hash": "",
"prev_hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f",
"reward": 0,
"timestamp": 0
"timestamp": 1719588270
},
"status": "OK"
}

8
docs/build/rpc-api/daemon-rpc-api/getblocks.bin.md vendored
View file

@ -15,13 +15,17 @@ URL: ```http:://127.0.0.1:11211/getblocks.bin```
### Response:
```json
{
"current_height": 0,
"start_height": 0,
"blocks": [{
"block": ""
}],
"current_height": 2555000,
"start_height": 2000000,
"status": "OK"
}
```
### Response description:
```
"blocks": Bunch of blocks
"current_height": Current height of the blockchain.
"start_height": Starting height of the resulting bunch of blocks.
"status": Status of the call.

20
docs/build/rpc-api/daemon-rpc-api/getblocktemplate.md vendored
View file

@ -8,8 +8,8 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getblocktemplate",
"params": {
"explicit_transaction": "",
"extra_text": "",
"explicit_transaction": "5fa8eaaf231a305053260ff91d69c6ef1ecbd0f5",
"extra_text": "OMG, you can't just ask people why they're PoW-maxi",
"pe": {
"amount": 0,
"block_timestamp": 0,
@ -21,7 +21,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
},
"pos_block": false,
"stakeholder_address": "",
"wallet_address": ""
"wallet_address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7"
}
}
```
@ -41,11 +41,11 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_reward": 0,
"block_reward_without_fee": 0,
"blocktemplate_blob": "",
"difficulty": "",
"height": 0,
"block_reward": 1000000000000,
"block_reward_without_fee": 1000000000000,
"blocktemplate_blob": "030000000000000000ae73338b792......6258a2b5ee340700",
"difficulty": "12936195379842",
"height": 2555002,
"miner_tx_tgc": {
"amount_blinding_masks": "",
"amount_blinding_masks_sum": "0000000000000000000000000000000000000000000000000000000000000000",
@ -70,8 +70,8 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"tx_key": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"tx_pub_key_p": "00000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
},
"prev_hash": "",
"seed": "",
"prev_hash": "ae73338b7927df71b6ed477937625c230172219306750ba97995fb5109dda703",
"seed": "0518e1373ff88ccabb28493cac10cb0731313135d880dae0d846be6016ab9acf",
"status": "OK",
"txs_fee": 0
}

68
docs/build/rpc-api/daemon-rpc-api/getinfo.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getinfo",
"params": {
"flags": 0
"flags": 1048575
}
}
```
@ -23,26 +23,27 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"alias_count": 0,
"alt_blocks_count": 0,
"block_reward": 0,
"alias_count": 1653,
"alt_blocks_count": 99,
"block_reward": 1000000000000,
"current_blocks_median": 0,
"current_max_allowed_block_size": 0,
"current_network_hashrate_350": 0,
"current_network_hashrate_50": 0,
"daemon_network_state": 0,
"default_fee": 0,
"expiration_median_timestamp": 0,
"grey_peerlist_size": 0,
"height": 0,
"current_max_allowed_block_size": 250000,
"current_network_hashrate_350": 107939216153,
"current_network_hashrate_50": 109575236643,
"daemon_network_state": 2,
"default_fee": 10000000000,
"expiration_median_timestamp": 1719585827,
"grey_peerlist_size": 321,
"height": 2555000,
"incoming_connections_count": 0,
"last_block_hash": "",
"is_hardfok_active": [true,true,true,true,true,false],
"last_block_hash": "153af86fd0d7d0a427526258e30505a4d21b8f77261f5276c7669e0a6c83efa0",
"last_block_size": 0,
"last_block_timestamp": 0,
"last_block_timestamp": 1719586493,
"last_block_total_reward": 0,
"last_pos_timestamp": 0,
"last_pow_timestamp": 0,
"max_net_seen_height": 0,
"last_pos_timestamp": 1719585105,
"last_pow_timestamp": 1719586493,
"max_net_seen_height": 2555743,
"mi": {
"build_no": 0,
"mode": 0,
@ -50,10 +51,10 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"ver_minor": 0,
"ver_revision": 0
},
"minimum_fee": 0,
"minimum_fee": 10000000000,
"net_time_delta_median": 0,
"offers_count": 0,
"outgoing_connections_count": 0,
"outgoing_connections_count": 8,
"outs_stat": {
"amount_0": 0,
"amount_0_001": 0,
@ -107,22 +108,22 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"tx_store_db": 0,
"writer_tx_count": 0
},
"pos_allowed": false,
"pos_block_ts_shift_vs_actual": 0,
"pos_allowed": true,
"pos_block_ts_shift_vs_actual": -1387,
"pos_diff_total_coins_rate": 0,
"pos_difficulty": "",
"pos_difficulty": "1848455949616658404658",
"pos_sequence_factor": 0,
"pow_difficulty": 0,
"pow_sequence_factor": 0,
"seconds_for_10_blocks": 0,
"seconds_for_30_blocks": 0,
"pow_difficulty": 12777323347117,
"pow_sequence_factor": 1,
"seconds_for_10_blocks": 476,
"seconds_for_30_blocks": 1264,
"status": "OK",
"synchronization_start_height": 0,
"synchronized_connections_count": 0,
"total_coins": "",
"transactions_cnt_per_day": 0,
"transactions_volume_per_day": 0,
"tx_count": 0,
"synchronization_start_height": 2555000,
"synchronized_connections_count": 8,
"total_coins": "14308874719144585856",
"transactions_cnt_per_day": 1325,
"transactions_volume_per_day": 6615220203700000,
"tx_count": 767742,
"tx_count_in_last_block": 0,
"tx_pool_performance_data": {
"begin_tx_time": 0,
@ -137,7 +138,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"validate_amount_time": 0
},
"tx_pool_size": 0,
"white_peerlist_size": 0
"white_peerlist_size": 12
}
}
```
@ -155,6 +156,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"grey_peerlist_size": Size of the grey peer list, which includes addresses of nodes with less consistent availability.
"height": The current size of the blockchain, equal to the height of the top block plus one.
"incoming_connections_count": Number of incoming P2P connections established by other nodes.
"is_hardfok_active": A list of boolean values indicating whether each corresponding hardfork is active. For example, a list 'true, true, false' indicates that the first hardfork is activated, while the second is not. Hardfork #0 is always active as it is a stub.
"last_block_hash": Hash of the last block. Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.
"last_block_size": The size of the last block in bytes. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_LAST_BLOCK_SIZE flag is set.
"last_block_timestamp": Timestamp of the last block. Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.

13
docs/build/rpc-api/daemon-rpc-api/getlastblockheader.md vendored
View file

@ -22,16 +22,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"result": {
"block_header": {
"depth": 0,
"difficulty": "",
"hash": "",
"height": 0,
"major_version": 0,
"difficulty": "1849593878843995770114",
"hash": "f5df39c4b1590394976aa6e72f04df7836e22dbdfc1e6f61f6cc1b624d83cd94",
"height": 2697404,
"major_version": 3,
"minor_version": 0,
"nonce": 0,
"orphan_status": false,
"prev_hash": "",
"prev_hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f",
"reward": 0,
"timestamp": 0
"timestamp": 1719588270
},
"status": "OK"
}
@ -39,6 +39,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
```
### Response description:
```
"block_header": Detailed header information of the block.
"depth": Depth of the block in the blockchain. Depth 0 indicates the most recent block.
"difficulty": Network difficulty target that the block met.
"hash": Hash of the block.

9
docs/build/rpc-api/daemon-rpc-api/getrandom_outs.bin.md vendored
View file

@ -4,12 +4,14 @@ URL: ```http:://127.0.0.1:11211/getrandom_outs.bin```
### Request:
```json
{
"outs_count": 0,
"amounts": [0,10000000000],
"outs_count": 2,
"use_forced_mix_outs": false
}
```
### Request description:
```
"amounts": List of amounts for which decoy outputs are requested.
"outs_count": Number of decoy outputs requested for each amount.
"use_forced_mix_outs": If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
@ -17,11 +19,16 @@ URL: ```http:://127.0.0.1:11211/getrandom_outs.bin```
### Response:
```json
{
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
```
### Response description:
```
"outs": List of 'outs_for_amount' structures, each containing decoys for a specific amount.
"amount": The amount for which decoys are returned.
"status": Status of the call.
```

9
docs/build/rpc-api/daemon-rpc-api/getrandom_outs.md vendored
View file

@ -8,13 +8,15 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getrandom_outs",
"params": {
"outs_count": 0,
"amounts": [0,10000000000],
"outs_count": 2,
"use_forced_mix_outs": false
}
}
```
### Request description:
```
"amounts": List of amounts for which decoy outputs are requested.
"outs_count": Number of decoy outputs requested for each amount.
"use_forced_mix_outs": If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
@ -25,12 +27,17 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
}
```
### Response description:
```
"outs": List of 'outs_for_amount' structures, each containing decoys for a specific amount.
"amount": The amount for which decoys are returned.
"status": Status of the call.
```

11
docs/build/rpc-api/daemon-rpc-api/getrandom_outs1.bin.md vendored
View file

@ -4,13 +4,15 @@ URL: ```http:://127.0.0.1:11211/getrandom_outs1.bin```
### Request:
```json
{
"decoys_count": 0,
"height_upper_limit": 0,
"amounts": [0,10000000000,5000000000000],
"decoys_count": 10,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
```
### Request description:
```
"amounts": List of amounts for which decoy outputs are requested.
"decoys_count": Number of decoy outputs required for each amount specified.
"height_upper_limit": Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.
"use_forced_mix_outs": If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
@ -19,11 +21,16 @@ URL: ```http:://127.0.0.1:11211/getrandom_outs1.bin```
### Response:
```json
{
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
```
### Response description:
```
"outs": List of 'outs_for_amount' structures, each containing decoys for a specific amount.
"amount": The amount for which decoys are returned.
"status": Status of the call.
```

11
docs/build/rpc-api/daemon-rpc-api/getrandom_outs1.md vendored
View file

@ -8,14 +8,16 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getrandom_outs1",
"params": {
"decoys_count": 0,
"height_upper_limit": 0,
"amounts": [0,10000000000,5000000000000],
"decoys_count": 10,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
}
```
### Request description:
```
"amounts": List of amounts for which decoy outputs are requested.
"decoys_count": Number of decoy outputs required for each amount specified.
"height_upper_limit": Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.
"use_forced_mix_outs": If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
@ -27,12 +29,17 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
}
```
### Response description:
```
"outs": List of 'outs_for_amount' structures, each containing decoys for a specific amount.
"amount": The amount for which decoys are returned.
"status": Status of the call.
```

16
docs/build/rpc-api/daemon-rpc-api/getrandom_outs3.bin.md vendored
View file

@ -4,13 +4,20 @@ URL: ```http:://127.0.0.1:11211/getrandom_outs3.bin```
### Request:
```json
{
"coinbase_percents": 0,
"height_upper_limit": 0,
"amounts": [{
"amount": 0,
"global_offsets": [1,3,5928,2811]
}],
"coinbase_percents": 15,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
```
### Request description:
```
"amounts": List of amount distributions specifying where to look for decoys, based on old bare outputs or ZC outputs.
"amount": If set to 0, only ZC outputs are considered. If nonzero, only old bare outputs are considered.
"global_offsets": List of global indices for picking decoys. Each index corresponds to a potential decoy output.
"coinbase_percents": Specifies the estimated percentage of coinbase outputs to be included in the decoy sets, ranging from 0 to 100.
"height_upper_limit": Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.
"use_forced_mix_outs": If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
@ -19,11 +26,16 @@ URL: ```http:://127.0.0.1:11211/getrandom_outs3.bin```
### Response:
```json
{
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
```
### Response description:
```
"outs": List of 'outs_for_amount' structures, each containing decoys for a specific amount.
"amount": The amount for which decoys are returned.
"status": Status of the call.
```

16
docs/build/rpc-api/daemon-rpc-api/getrandom_outs3.md vendored
View file

@ -8,14 +8,21 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "getrandom_outs3",
"params": {
"coinbase_percents": 0,
"height_upper_limit": 0,
"amounts": [{
"amount": 0,
"global_offsets": [1,3,5928,2811]
}],
"coinbase_percents": 15,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
}
```
### Request description:
```
"amounts": List of amount distributions specifying where to look for decoys, based on old bare outputs or ZC outputs.
"amount": If set to 0, only ZC outputs are considered. If nonzero, only old bare outputs are considered.
"global_offsets": List of global indices for picking decoys. Each index corresponds to a potential decoy output.
"coinbase_percents": Specifies the estimated percentage of coinbase outputs to be included in the decoy sets, ranging from 0 to 100.
"height_upper_limit": Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.
"use_forced_mix_outs": If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
@ -27,12 +34,17 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
}
```
### Response description:
```
"outs": List of 'outs_for_amount' structures, each containing decoys for a specific amount.
"amount": The amount for which decoys are returned.
"status": Status of the call.
```

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

@ -4,16 +4,18 @@ URL: ```http:://127.0.0.1:11211/gettransactions```
### Request:
```json
{
"txs_hashes": ["146791c4f5ca94bcf423557e5eb859a3a69991bd33960d52f709d88bf5d1ac6d","ec4d913a40a9ac1fbd9d33b71ef507b5c85d1f503b89096618a18b08991b5171"]
}
```
### Request description:
```
"txs_hashes": List of transactions' IDs.
```
### Response:
```json
{
"missed_tx": ["97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"],
"missed_tx": ["ec4d913a40a9ac1fbd9d33b71ef507b5c85d1f503b89096618a18b08991b5171"],
"status": "OK",
"txs_as_hex": ["7d914497d91442f8f3c2268397d914497d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc2f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"]
}

2
docs/build/rpc-api/daemon-rpc-api/remove_tx_from_pool.md vendored
View file

@ -8,11 +8,13 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "remove_tx_from_pool",
"params": {
"tx_to_remove": ["c5efacd06128fc5a73f58392c84534cd1a146de7d47ffbe770486cce5130dc1f","c2f0de2ef4753dc0ec8dd2da5ebf8e77f07d2ac0791357a9e3f2537071b33762"]
}
}
```
### Request description:
```
"tx_to_remove": List of transaction IDs that are to be removed from the transaction pool.
```
### Response:

6
docs/build/rpc-api/daemon-rpc-api/search_by_id.md vendored
View file

@ -8,7 +8,7 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "search_by_id",
"params": {
"id": ""
"id": "729811f9340537e8d5641949e6cc58261f91f109687a706f39bae9514757e819"
}
}
```
@ -23,12 +23,14 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
"status": "OK",
"types_found": ["key_image"]
}
}
```
### Response description:
```
"status": Status of the call.
"types_found": List of entity types where the identifier was found.
```

2
docs/build/rpc-api/daemon-rpc-api/sendrawtransaction.md vendored
View file

@ -4,7 +4,7 @@ URL: ```http:://127.0.0.1:11211/sendrawtransaction```
### Request:
```json
{
"tx_as_hex": ""
"tx_as_hex": "00018ed1535b8b4862e.....368cdc5a86"
}
```
### Request description:

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

@ -4,8 +4,8 @@ URL: ```http:://127.0.0.1:11211/start_mining```
### Request:
```json
{
"miner_address": "",
"threads_count": 0
"miner_address": "ZxCSpsGGeJsS8fwvQ4HktDU3qBeauoJTR6j73jAWWZxFXdF7XTbGm4YfS2kXJmAP4Rf5BVsSQ9iZ45XANXEYsrLN2L2W77dH7",
"threads_count": 2
}
```
### Request description:

8
docs/build/rpc-api/daemon-rpc-api/submitblock2.md vendored
View file

@ -8,13 +8,19 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "submitblock2",
"params": {
"b": ""
"b": "030000000000000000ae73338b7926258a2b5ee340700",
"explicit_txs": [{
"blob": "36323538613262356565376139633230"
},{
"blob": "38653066306132636565333430373030"
}]
}
}
```
### Request description:
```
"b": Hex-encoded serialized block.
"explicit_txs": List of hex-encoded transactions to be explicitly included in the block.
```
### Response:

6
docs/build/rpc-api/daemon-rpc-api/validate_signature.md vendored
View file

@ -8,10 +8,10 @@ URL: ```http:://127.0.0.1:11211/json_rpc```
"jsonrpc": "2.0",
"method": "validate_signature",
"params": {
"alias": "",
"buff": "",
"alias": "sowle",
"buff": "SSBkaWRuJ3QgZXhwZWN0IGFueW9uZSB0byBkZWNyeXB0IHRoaXMgZGF0YSwgc2luY2UgaXQncyBqdXN0IGFuIGV4YW1wbGUuIEJ1dCB5b3UgZGVjcnlwdGVkIGl0ISBJJ20gYW1hemVkLg==",
"pkey": "",
"sig": ""
"sig": "5c202d4bf82c2dd3c6354e2f02826ca72c797950dbe8db5bc5e3b2e60290a407ac2ef85bfc905ace8fe3b3819217084c00faf7237fee3ad2f6a7f662636cd20f"
}
}
```