diff --git a/docs/api/mempool/create-item-asset.api.mdx b/docs/api/mempool/create-item-asset.api.mdx index ffd71a1..dc1375b 100644 --- a/docs/api/mempool/create-item-asset.api.mdx +++ b/docs/api/mempool/create-item-asset.api.mdx @@ -5,7 +5,7 @@ description: "Create new item/asset." sidebar_label: "create_item_asset" hide_title: true hide_table_of_contents: true -api: {"tags":["transaction"],"description":"Create new item/asset.","operationId":"createItemAsset","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"Create a new item/asset","content":{"application/json":{"schema":{"type":"object","properties":{"item_amount":{"type":"number","example":10,"description":"The amount of `Item` assets to create"},"script_public_key":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","description":"Address"},"public_key":{"type":"string","example":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","description":"Key-pair to use for the creation of the item-assets"},"signature":{"type":"string","example":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","description":"Signature to use for the creation of the item-assets"},"drs_tx_hash_spec":{"type":"string","example":"Default","description":"Whether to create `Item` assets that contain the default DRS identifier"}},"title":"ItemCreate"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"asset":{"type":"object","properties":{"asset":{"type":"object","properties":{"Item":{"type":"object","properties":{"amount":{"type":"number","example":1000},"drs_tx_hash":{"type":"string","example":"default_drs_tx_hash"},"metadata":{"type":"string","example":null}}}}},"extra_info":{"type":"string","example":null}}},"to_address":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01"},"tx_hash":{"type":"string","example":"default_drs_tx_hash"}}}},"title":"ResponseCreateItem"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/create_item_asset","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":{"item_amount":10,"script_public_key":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","public_key":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","signature":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","drs_tx_hash_spec":"Default"},"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"create_item_asset","description":{"content":"Create new item/asset.","type":"text/plain"},"url":{"path":["create_item_asset"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["transaction"],"description":"Create new item/asset.","operationId":"createItemAsset","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"Create a new item/asset","content":{"application/json":{"schema":{"type":"object","properties":{"item_amount":{"type":"number","example":10,"description":"The amount of `Item` assets to create"},"script_public_key":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","description":"Address"},"public_key":{"type":"string","example":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","description":"Key-pair to use for the creation of the item-assets"},"signature":{"type":"string","example":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","description":"Signature to use for the creation of the item-assets"},"drs_tx_hash_spec":{"type":"string","example":"Default","description":"Whether to create `Item` assets that contain the default DRS identifier"}},"title":"ItemCreate"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"asset":{"type":"object","properties":{"asset":{"type":"object","properties":{"Item":{"type":"object","properties":{"amount":{"type":"number","example":1000},"drs_tx_hash":{"type":"string","example":"default_drs_tx_hash"},"metadata":{"type":"string","example":null}}}}},"extra_info":{"type":"string","example":null}}},"to_address":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01"},"tx_hash":{"type":"string","example":"default_drs_tx_hash"}}}},"title":"ResponseCreateItem"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/create_item_asset","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":{"item_amount":10,"script_public_key":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","public_key":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","signature":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","drs_tx_hash_spec":"Default"},"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"create_item_asset","description":{"content":"Create new item/asset.","type":"text/plain"},"url":{"path":["create_item_asset"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs/api/mempool/mempool-api custom_edit_url: null diff --git a/docs/api/mempool/create-tx.api.mdx b/docs/api/mempool/create-tx.api.mdx index 41550a4..5669a95 100644 --- a/docs/api/mempool/create-tx.api.mdx +++ b/docs/api/mempool/create-tx.api.mdx @@ -5,7 +5,7 @@ description: "Create new transaction/s, which will be submitted to the Mempool n sidebar_label: "create_transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["transaction"],"description":"Create new transaction/s, which will be submitted to the Mempool nodes for inclusion into a new block. This call assumes a full transaction as part of the request body, which might make raw calls difficult to manage. For convenience, it may be best to use an AIBlock library or SDK that abstracts this call for you.","operationId":"createTx","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"Create a new transaction","content":{"application/json":{"schema":{"type":"object","xml":{"name":"txcreate"},"properties":{"inputs":{"type":"array","items":{"type":"object","xml":{"name":"txinput"},"properties":{"previous_out":{"description":"Previous output tx hash","type":"object","properties":{"t_hash":{"type":"string","example":"f0698b112da09","description":"Transaction hash"},"n":{"type":"number","example":0,"description":"The index of the output in the input transaction"}},"title":"previousOut"},"script_signature":{"type":"object","properties":{"Pay2PkH":{"type":"object","properties":{"signable_data":{"type":"string","example":"1b061ff7e94765f95a2a5122d3bde757f2daaacef762c5aef2bf237ca3da2abf","description":"Data to sign for verification. This is a SHA3 hash of the all the transaction outputs and this input's previous output, for example \"{output1}{output2}{previousOut}\""},"signature":{"type":"string","example":"b576d3f5c1703206bad8b9de0ce3a3167e203b78164c86d78774534c930a535a31c49adae9e70569008c0329fb4a9128ca96d350f47a88ce06ef5a334506f803","description":"Signature of the signable data"},"public_key":{"type":"string","example":"5e7856117f404562c47dbdccfb8c23dc9ec69be14df5712bb459eeb440f40808","description":"Public key used to sign the signable data"},"address_version":{"type":"string","example":"null"}},"title":"ScriptSig"}},"title":"Pay2PkH"}},"title":"TransactionInput"},"description":"The inputs to the transaction"},"outputs":{"type":"array","items":{"type":"object","xml":{"name":"txinput"},"properties":{"value":{"type":"object","properties":{"Token":{"type":"number","example":10,"description":"Token amount"}}},"locktime":{"type":"number","example":0},"script_public_key":{"type":"string","example":"ec66c99201a7a8299e5acace235b03932c7990cc479eca35ee1dd692a5d3c030"}},"title":"TransactionOutput"},"description":"The outputs to the transaction"},"version":{"type":"integer","format":"int8","example":2,"description":"The transaction's schema version"},"druid_info":{"type":"object","properties":{"druid":{"type":"string","example":"DRUID_1"},"participants":{"type":"integer","example":2},"expectations":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"asset":{"type":"object"}}}}}},"title":"TransactionCreate"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"a1d46199e5c89b00509e118f5af83172","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Transaction/s successfully created","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"create_transactions","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"transaction":{"type":"object","example":"This section is unfinished, refer to postman collection for more details","description":"This section is unfinished, refer to postman collection for more details"}}}},"title":"ResponseCreateTransactions"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/create_transactions","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":{"inputs":[{"previous_out":{"t_hash":"f0698b112da09","n":0},"script_signature":{"Pay2PkH":{"signable_data":"1b061ff7e94765f95a2a5122d3bde757f2daaacef762c5aef2bf237ca3da2abf","signature":"b576d3f5c1703206bad8b9de0ce3a3167e203b78164c86d78774534c930a535a31c49adae9e70569008c0329fb4a9128ca96d350f47a88ce06ef5a334506f803","public_key":"5e7856117f404562c47dbdccfb8c23dc9ec69be14df5712bb459eeb440f40808","address_version":"null"}}}],"outputs":[{"value":{"Token":10},"locktime":0,"script_public_key":"ec66c99201a7a8299e5acace235b03932c7990cc479eca35ee1dd692a5d3c030"}],"version":2,"druid_info":{"druid":"DRUID_1","participants":2,"expectations":{"from":"string","to":"string","asset":{}}}},"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"create_transactions","description":{"content":"Create new transaction/s, which will be submitted to the Mempool nodes for inclusion into a new block. This call assumes a full transaction as part of the request body, which might make raw calls difficult to manage. For convenience, it may be best to use an AIBlock library or SDK that abstracts this call for you.","type":"text/plain"},"url":{"path":["create_transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["transaction"],"description":"Create new transaction/s, which will be submitted to the Mempool nodes for inclusion into a new block. This call assumes a full transaction as part of the request body, which might make raw calls difficult to manage. For convenience, it may be best to use an AIBlock library or SDK that abstracts this call for you.","operationId":"createTx","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"Create a new transaction","content":{"application/json":{"schema":{"type":"object","xml":{"name":"txcreate"},"properties":{"inputs":{"type":"array","items":{"type":"object","xml":{"name":"txinput"},"properties":{"previous_out":{"description":"Previous output tx hash","type":"object","properties":{"t_hash":{"type":"string","example":"f0698b112da09","description":"Transaction hash"},"n":{"type":"number","example":0,"description":"The index of the output in the input transaction"}},"title":"previousOut"},"script_signature":{"type":"object","properties":{"Pay2PkH":{"type":"object","properties":{"signable_data":{"type":"string","example":"1b061ff7e94765f95a2a5122d3bde757f2daaacef762c5aef2bf237ca3da2abf","description":"Data to sign for verification. This is a SHA3 hash of the all the transaction outputs and this input's previous output, for example \"{output1}{output2}{previousOut}\""},"signature":{"type":"string","example":"b576d3f5c1703206bad8b9de0ce3a3167e203b78164c86d78774534c930a535a31c49adae9e70569008c0329fb4a9128ca96d350f47a88ce06ef5a334506f803","description":"Signature of the signable data"},"public_key":{"type":"string","example":"5e7856117f404562c47dbdccfb8c23dc9ec69be14df5712bb459eeb440f40808","description":"Public key used to sign the signable data"},"address_version":{"type":"string","example":"null"}},"title":"ScriptSig"}},"title":"Pay2PkH"}},"title":"TransactionInput"},"description":"The inputs to the transaction"},"outputs":{"type":"array","items":{"type":"object","xml":{"name":"txinput"},"properties":{"value":{"type":"object","properties":{"Token":{"type":"number","example":10,"description":"Token amount"}}},"locktime":{"type":"number","example":0},"script_public_key":{"type":"string","example":"ec66c99201a7a8299e5acace235b03932c7990cc479eca35ee1dd692a5d3c030"}},"title":"TransactionOutput"},"description":"The outputs to the transaction"},"version":{"type":"integer","format":"int8","example":2,"description":"The transaction's schema version"},"druid_info":{"type":"object","properties":{"druid":{"type":"string","example":"DRUID_1"},"participants":{"type":"integer","example":2},"expectations":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"asset":{"type":"object"}}}}}},"title":"TransactionCreate"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"a1d46199e5c89b00509e118f5af83172","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Transaction/s successfully created","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"create_transactions","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"transaction":{"type":"object","example":"This section is unfinished, refer to postman collection for more details","description":"This section is unfinished, refer to postman collection for more details"}}}},"title":"ResponseCreateTransactions"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/create_transactions","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":{"inputs":[{"previous_out":{"t_hash":"f0698b112da09","n":0},"script_signature":{"Pay2PkH":{"signable_data":"1b061ff7e94765f95a2a5122d3bde757f2daaacef762c5aef2bf237ca3da2abf","signature":"b576d3f5c1703206bad8b9de0ce3a3167e203b78164c86d78774534c930a535a31c49adae9e70569008c0329fb4a9128ca96d350f47a88ce06ef5a334506f803","public_key":"5e7856117f404562c47dbdccfb8c23dc9ec69be14df5712bb459eeb440f40808","address_version":"null"}}}],"outputs":[{"value":{"Token":10},"locktime":0,"script_public_key":"ec66c99201a7a8299e5acace235b03932c7990cc479eca35ee1dd692a5d3c030"}],"version":2,"druid_info":{"druid":"DRUID_1","participants":2,"expectations":{"from":"string","to":"string","asset":{}}}},"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"create_transactions","description":{"content":"Create new transaction/s, which will be submitted to the Mempool nodes for inclusion into a new block. This call assumes a full transaction as part of the request body, which might make raw calls difficult to manage. For convenience, it may be best to use an AIBlock library or SDK that abstracts this call for you.","type":"text/plain"},"url":{"path":["create_transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs/api/mempool/mempool-api custom_edit_url: null diff --git a/docs/api/mempool/debug-data.api.mdx b/docs/api/mempool/debug-data.api.mdx index 4d85bd8..e7a4548 100644 --- a/docs/api/mempool/debug-data.api.mdx +++ b/docs/api/mempool/debug-data.api.mdx @@ -5,7 +5,7 @@ description: "Get general information about the current node." sidebar_label: "debug_data" hide_title: true hide_table_of_contents: true -api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Mempool","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_item_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]}}}},"title":"ResponseDebugData"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Mempool","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_item_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]}}}},"title":"ResponseDebugData"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/api/mempool/mempool-api custom_edit_url: null diff --git a/docs/api/mempool/fetch-balance.api.mdx b/docs/api/mempool/fetch-balance.api.mdx index 6087b98..7c7ecde 100644 --- a/docs/api/mempool/fetch-balance.api.mdx +++ b/docs/api/mempool/fetch-balance.api.mdx @@ -5,7 +5,7 @@ description: "Fetches the balance/s for 1 or more addresses." sidebar_label: "fetch_balance" hide_title: true hide_table_of_contents: true -api: {"tags":["address"],"description":"Fetches the balance/s for 1 or more addresses.","operationId":"fetchBalance","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"List of addresses to fetch the balance from.","content":{"application/json":{"schema":{"type":"array","description":"list of addresses to fetch from","items":{"type":"string","example":"d6fa779a3de8b216c56375018375e490c7e2ce92918abce4caecf73b1f77c38f"},"title":"FetchBalance"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Balance successfully fetched","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"fetch_balance","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"total":{"type":"object","properties":{"tokens":{"type":"number","example":5463669},"items":{"type":"object"}}},"address_list":{"type":"object","example":{"d6fa779a3de8b216c56375018375e490c7e2ce92918abce4caecf73b1f77c38f":[{"out_point":{"t_hash":"g9182e1e2a55b0ef36f1183602d74e63","n":0},"value":{"Token":5463669}}]}}}}},"title":"ResponseFetchBalance"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/fetch_balance","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":["d6fa779a3de8b216c56375018375e490c7e2ce92918abce4caecf73b1f77c38f"],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"fetch_balance","description":{"content":"Fetches the balance/s for 1 or more addresses.","type":"text/plain"},"url":{"path":["fetch_balance"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["address"],"description":"Fetches the balance/s for 1 or more addresses.","operationId":"fetchBalance","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"List of addresses to fetch the balance from.","content":{"application/json":{"schema":{"type":"array","description":"list of addresses to fetch from","items":{"type":"string","example":"d6fa779a3de8b216c56375018375e490c7e2ce92918abce4caecf73b1f77c38f"},"title":"FetchBalance"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Balance successfully fetched","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"fetch_balance","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"total":{"type":"object","properties":{"tokens":{"type":"number","example":5463669},"items":{"type":"object"}}},"address_list":{"type":"object","example":{"d6fa779a3de8b216c56375018375e490c7e2ce92918abce4caecf73b1f77c38f":[{"out_point":{"t_hash":"g9182e1e2a55b0ef36f1183602d74e63","n":0},"value":{"Token":5463669}}]}}}}},"title":"ResponseFetchBalance"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/fetch_balance","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":["d6fa779a3de8b216c56375018375e490c7e2ce92918abce4caecf73b1f77c38f"],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"fetch_balance","description":{"content":"Fetches the balance/s for 1 or more addresses.","type":"text/plain"},"url":{"path":["fetch_balance"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs/api/mempool/mempool-api custom_edit_url: null diff --git a/docs/api/mempool/issued-supply.api.mdx b/docs/api/mempool/issued-supply.api.mdx index 2d71218..f18cb30 100644 --- a/docs/api/mempool/issued-supply.api.mdx +++ b/docs/api/mempool/issued-supply.api.mdx @@ -5,7 +5,7 @@ description: "Get issued supply information." sidebar_label: "issued_supply" hide_title: true hide_table_of_contents: true -api: {"tags":["info"],"description":"Get issued supply information.","operationId":"issuedSupply","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Successfully fetched issued supply","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"issued_supply","description":"The endpoint route that was called"},"content":{"type":"number","example":94028360708339,"description":"The total supply of tokens"}},"title":"ResponseIssuedSupply"}}}}},"method":"get","path":"/issued_supply","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"issued_supply","description":{"content":"Get issued supply information.","type":"text/plain"},"url":{"path":["issued_supply"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["info"],"description":"Get issued supply information.","operationId":"issuedSupply","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Successfully fetched issued supply","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"issued_supply","description":"The endpoint route that was called"},"content":{"type":"number","example":94028360708339,"description":"The total supply of tokens"}},"title":"ResponseIssuedSupply"}}}}},"method":"get","path":"/issued_supply","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"issued_supply","description":{"content":"Get issued supply information.","type":"text/plain"},"url":{"path":["issued_supply"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/api/mempool/mempool-api custom_edit_url: null diff --git a/docs/api/mempool/total-supply.api.mdx b/docs/api/mempool/total-supply.api.mdx index fae8063..8f0418e 100644 --- a/docs/api/mempool/total-supply.api.mdx +++ b/docs/api/mempool/total-supply.api.mdx @@ -5,7 +5,7 @@ description: "Get total supply information." sidebar_label: "total_supply" hide_title: true hide_table_of_contents: true -api: {"tags":["info"],"description":"Get total supply information.","operationId":"totalSupply","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Successfully fetched total supply","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"total_supply","description":"The endpoint route that was called"},"content":{"type":"number","example":360360000000000000,"description":"The total supply of tokens"}},"title":"ResponseTotalSupply"}}}}},"method":"get","path":"/total_supply","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"total_supply","description":{"content":"Get total supply information.","type":"text/plain"},"url":{"path":["total_supply"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["info"],"description":"Get total supply information.","operationId":"totalSupply","parameters":[{"in":"header","name":"x-cache-id","description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Successfully fetched total supply","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"total_supply","description":"The endpoint route that was called"},"content":{"type":"number","example":360360000000000000,"description":"The total supply of tokens"}},"title":"ResponseTotalSupply"}}}}},"method":"get","path":"/total_supply","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes. ","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"total_supply","description":{"content":"Get total supply information.","type":"text/plain"},"url":{"path":["total_supply"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/api/mempool/mempool-api custom_edit_url: null diff --git a/docs/api/miner/debug-data.api.mdx b/docs/api/miner/debug-data.api.mdx index bc2946c..091597b 100644 --- a/docs/api/miner/debug-data.api.mdx +++ b/docs/api/miner/debug-data.api.mdx @@ -5,7 +5,7 @@ description: "Get general information about the current node." sidebar_label: "debug_data" hide_title: true hide_table_of_contents: true -api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Compute","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_item_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]},"routes_pow":{"type":"object","properties":{"create_transactions":{"type":"number","example":2}}}}}},"title":"ResponseDebugData"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"http://37.27.23.104:3000","description":"Testnet Miner Node"}],"info":{"title":"Miner API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Miner node is most like the Bitcoin miner you may be familiar with. They are responsible for mining new blocks that they receive from the Mempool nodes and collect the associated block reward for their efforts. They are only able to mine a block if they manage to get into the partition for that round.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Compute","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_item_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]},"routes_pow":{"type":"object","properties":{"create_transactions":{"type":"number","example":2}}}}}},"title":"ResponseDebugData"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"http://localhost:3000","description":"Testnet Miner Node"}],"info":{"title":"Miner API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Miner node is most like the Bitcoin miner you may be familiar with. They are responsible for mining new blocks that they receive from the Mempool nodes and collect the associated block reward for their efforts. They are only able to mine a block if they manage to get into the partition for that round.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/api/miner/miner-api custom_edit_url: null diff --git a/docs/api/storage/block-by-num.api.mdx b/docs/api/storage/block-by-num.api.mdx index 8f89570..36049d2 100644 --- a/docs/api/storage/block-by-num.api.mdx +++ b/docs/api/storage/block-by-num.api.mdx @@ -5,7 +5,7 @@ description: "Fetches block/s from the chain by block number. Multiple block num sidebar_label: "block_by_num" hide_title: true hide_table_of_contents: true -api: {"tags":["block"],"description":"Fetches block/s from the chain by block number. Multiple block numbers can be supplied in the same request body.","operationId":"blockByNum","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"a1d46199e5c89b00509e118f5af83172","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"List of block numbers to fetch blocks for in the chain","content":{"application/json":{"schema":{"type":"array","example":[0,10,20000],"items":{"type":"number"}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Database item(s) successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"block_by_num","description":"The endpoint route that was called"},"content":{"type":"array","items":{"type":"array","items":{"type":"object","example":{"id":"8bdc6c43fa004725bbd5eabef41e9d5d","status":"Success","reason":"Database item(s) successfully retrieved","route":"block_by_num","content":[["b00b7bb7ee1b41c857db05c86f8cf0f5548734d57dcb930605744d24425ea975d",{"block":{"header":{"version":6,"bits":0,"nonce_and_mining_tx_hash":[[54,94,67,154,"..."],"g4c25d5bf7f3bff93b5cf34bb1dbf4a7"],"b_num":0,"timestamp":0,"seed_value":[57,52,57,57,"..."],"previous_hash":null,"txs_merkle_root_and_hash":["6187c89a825c908668d7ade3d900fa38468be1d0dd5995adc690e6 1c9f3c4717","fd72629f4bb412913474be46095d1b65cac336b67be8db0959460c 4a41016ff6"]},"transactions":["000000","000001","000010","000011"]}}]]}}}}},"title":"ResponseBlockByNum"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/block_by_num","servers":[{"url":"http://37.27.23.104:3001","description":"Testnet Storage Node"}],"jsonRequestBodyExample":[0,10,20000],"info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"block_by_num","description":{"content":"Fetches block/s from the chain by block number. Multiple block numbers can be supplied in the same request body.","type":"text/plain"},"url":{"path":["block_by_num"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["block"],"description":"Fetches block/s from the chain by block number. Multiple block numbers can be supplied in the same request body.","operationId":"blockByNum","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"a1d46199e5c89b00509e118f5af83172","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"List of block numbers to fetch blocks for in the chain","content":{"application/json":{"schema":{"type":"array","example":[0,10,20000],"items":{"type":"number"}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Database item(s) successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"block_by_num","description":"The endpoint route that was called"},"content":{"type":"array","items":{"type":"array","items":{"type":"object","example":{"id":"8bdc6c43fa004725bbd5eabef41e9d5d","status":"Success","reason":"Database item(s) successfully retrieved","route":"block_by_num","content":[["b00b7bb7ee1b41c857db05c86f8cf0f5548734d57dcb930605744d24425ea975d",{"block":{"header":{"version":6,"bits":0,"nonce_and_mining_tx_hash":[[54,94,67,154,"..."],"g4c25d5bf7f3bff93b5cf34bb1dbf4a7"],"b_num":0,"timestamp":0,"seed_value":[57,52,57,57,"..."],"previous_hash":null,"txs_merkle_root_and_hash":["6187c89a825c908668d7ade3d900fa38468be1d0dd5995adc690e6 1c9f3c4717","fd72629f4bb412913474be46095d1b65cac336b67be8db0959460c 4a41016ff6"]},"transactions":["000000","000001","000010","000011"]}}]]}}}}},"title":"ResponseBlockByNum"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/block_by_num","servers":[{"url":"https://storage.aiblock.dev","description":"Testnet Storage Node"}],"jsonRequestBodyExample":[0,10,20000],"info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"block_by_num","description":{"content":"Fetches block/s from the chain by block number. Multiple block numbers can be supplied in the same request body.","type":"text/plain"},"url":{"path":["block_by_num"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs/api/storage/storage-api custom_edit_url: null diff --git a/docs/api/storage/blockchain-entry.api.mdx b/docs/api/storage/blockchain-entry.api.mdx index 28a82ef..e766cbf 100644 --- a/docs/api/storage/blockchain-entry.api.mdx +++ b/docs/api/storage/blockchain-entry.api.mdx @@ -5,7 +5,7 @@ description: "Fetches a block or transaction from the chain." sidebar_label: "blockchain_entry" hide_title: true hide_table_of_contents: true -api: {"tags":["block"],"description":"Fetches a block or transaction from the chain.","operationId":"blockchainEntry","requestBody":{"description":"The hash of the block or transaction to fetch","content":{"application/json":{"schema":{"type":"string","example":"ga0e7a2ff46a4a9c9775118db6de61ec"}}},"required":true},"parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"afac3a3dd8a04538934db1c20cc29767","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Database item(s) successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"blockchain_entry","description":"The endpoint route that was called"},"content":{"type":"object","example":{"Transaction":{"inputs":[{"previous_out":null,"script_signature":{"stack":[{"Num":1585843}]}}],"outputs":[{"value":{"Token":5369041},"locktime":1585943,"drs_block_hash":null,"script_public_key":"0dafb...afdb3"}],"version":5,"druid_info":null}}}},"title":"ResponseBlockchainEntry"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/blockchain_entry","servers":[{"url":"http://37.27.23.104:3001","description":"Testnet Storage Node"}],"jsonRequestBodyExample":"ga0e7a2ff46a4a9c9775118db6de61ec","info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"blockchain_entry","description":{"content":"Fetches a block or transaction from the chain.","type":"text/plain"},"url":{"path":["blockchain_entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["block"],"description":"Fetches a block or transaction from the chain.","operationId":"blockchainEntry","requestBody":{"description":"The hash of the block or transaction to fetch","content":{"application/json":{"schema":{"type":"string","example":"ga0e7a2ff46a4a9c9775118db6de61ec"}}},"required":true},"parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"afac3a3dd8a04538934db1c20cc29767","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Database item(s) successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"blockchain_entry","description":"The endpoint route that was called"},"content":{"type":"object","example":{"Transaction":{"inputs":[{"previous_out":null,"script_signature":{"stack":[{"Num":1585843}]}}],"outputs":[{"value":{"Token":5369041},"locktime":1585943,"drs_block_hash":null,"script_public_key":"0dafb...afdb3"}],"version":5,"druid_info":null}}}},"title":"ResponseBlockchainEntry"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/blockchain_entry","servers":[{"url":"https://storage.aiblock.dev","description":"Testnet Storage Node"}],"jsonRequestBodyExample":"ga0e7a2ff46a4a9c9775118db6de61ec","info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"blockchain_entry","description":{"content":"Fetches a block or transaction from the chain.","type":"text/plain"},"url":{"path":["blockchain_entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs/api/storage/storage-api custom_edit_url: null diff --git a/docs/api/storage/debug-data.api.mdx b/docs/api/storage/debug-data.api.mdx index 3d503e1..cda813e 100644 --- a/docs/api/storage/debug-data.api.mdx +++ b/docs/api/storage/debug-data.api.mdx @@ -5,7 +5,7 @@ description: "Get general information about the current node." sidebar_label: "debug_data" hide_title: true hide_table_of_contents: true -api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Storage","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["block_by_num","latest_block,","blockchain_entry,","debug_data"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Mempool"]},"routes_pow":{"type":"object","properties":{"create_transactions":{"type":"number","example":2}}}}}},"title":"ResponseDebugData"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"http://37.27.23.104:3001","description":"Testnet Storage Node"}],"info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"fde57c5d0e0c49f8a9e91ba5acc18cfd","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Storage","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["block_by_num","latest_block,","blockchain_entry,","debug_data"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Mempool"]},"routes_pow":{"type":"object","properties":{"create_transactions":{"type":"number","example":2}}}}}},"title":"ResponseDebugData"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"https://storage.aiblock.dev","description":"Testnet Storage Node"}],"info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/api/storage/storage-api custom_edit_url: null diff --git a/docs/api/storage/latest-block.api.mdx b/docs/api/storage/latest-block.api.mdx index 8e02e5f..f5a02dd 100644 --- a/docs/api/storage/latest-block.api.mdx +++ b/docs/api/storage/latest-block.api.mdx @@ -5,7 +5,7 @@ description: "Get the latest block successfully mined and stored on this Storage sidebar_label: "latest_block" hide_title: true hide_table_of_contents: true -api: {"tags":["block"],"description":"Get the latest block successfully mined and stored on this Storage node.","operationId":"latestBlock","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"afac3a3dd8a04538934db1c20cc29767","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Transaction/s successfully created","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"create_transactions","description":"The endpoint route that was called"},"content":{"type":"object","description":"The block itself. The header contains specific info about the block, while the transactions are stored as a separate property.","properties":{"block":{"type":"object","properties":{"header":{"type":"object","properties":{"version":{"type":"number"},"bits":{"type":"number"},"b_num":{"description":"The block number","type":"number"},"seed_value":{"type":"array","description":"The UNiCORN random number value, which is composed of both the UNiCORN witness and seed value for verification. The example array in this documentation is truncated for brevity.","items":{"example":[56,53,48,57,52,57,50]}},"nonce_and_mining_tx_hash":{"type":"array","items":{"example":[[168,23,49,67,25,109],"g130489f617edf5792163c2d4d72568a"]}},"previous_hash":{"type":"string","example":"b0004...7c383"},"txs_merkle_root_and_hash":{"type":"array","items":{"example":["","48dda...ee9df"]}}}},"transactions":{"type":"array","description":"A list of hashes for all transactions in this block","items":{"example":["g130489f617edf5792163c2d4d72568a"]}}}}}}},"title":"ResponseLatestBlock"}}}}},"method":"get","path":"/latest_block","servers":[{"url":"http://37.27.23.104:3001","description":"Testnet Storage Node"}],"info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"latest_block","description":{"content":"Get the latest block successfully mined and stored on this Storage node.","type":"text/plain"},"url":{"path":["latest_block"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["block"],"description":"Get the latest block successfully mined and stored on this Storage node.","operationId":"latestBlock","parameters":[{"in":"header","name":"x-cache-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"afac3a3dd8a04538934db1c20cc29767","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"45v340cd2f8c4782a5b058832565afb1","description":"The ID of the call, which corresponds to the x-cache-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Transaction/s successfully created","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"create_transactions","description":"The endpoint route that was called"},"content":{"type":"object","description":"The block itself. The header contains specific info about the block, while the transactions are stored as a separate property.","properties":{"block":{"type":"object","properties":{"header":{"type":"object","properties":{"version":{"type":"number"},"bits":{"type":"number"},"b_num":{"description":"The block number","type":"number"},"seed_value":{"type":"array","description":"The UNiCORN random number value, which is composed of both the UNiCORN witness and seed value for verification. The example array in this documentation is truncated for brevity.","items":{"example":[56,53,48,57,52,57,50]}},"nonce_and_mining_tx_hash":{"type":"array","items":{"example":[[168,23,49,67,25,109],"g130489f617edf5792163c2d4d72568a"]}},"previous_hash":{"type":"string","example":"b0004...7c383"},"txs_merkle_root_and_hash":{"type":"array","items":{"example":["","48dda...ee9df"]}}}},"transactions":{"type":"array","description":"A list of hashes for all transactions in this block","items":{"example":["g130489f617edf5792163c2d4d72568a"]}}}}}}},"title":"ResponseLatestBlock"}}}}},"method":"get","path":"/latest_block","servers":[{"url":"https://storage.aiblock.dev","description":"Testnet Storage Node"}],"info":{"title":"Storage API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe Storage node is responsible for storing the full blockchain history. \nOnce blocks are mined by the miners and sent to the Mempool nodes for validation, they are pushed on to the Storage nodes for long-term storage. \nAnybody is allowed to request a full history of the blockchain from the Storage nodes, but they are not required to keep such a history to participate in the network.","contact":{"email":"byron.houwens@a-block.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.1"},"postman":{"name":"latest_block","description":{"content":"Get the latest block successfully mined and stored on this Storage node.","type":"text/plain"},"url":{"path":["latest_block"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/api/storage/storage-api custom_edit_url: null diff --git a/openapi/mempool_openapi.yml b/openapi/mempool_openapi.yml index 66ccdd9..9d52aa0 100644 --- a/openapi/mempool_openapi.yml +++ b/openapi/mempool_openapi.yml @@ -17,7 +17,7 @@ externalDocs: description: Find out more about AIBlock url: https://aiblock.ch servers: - - url: http://37.27.23.104:3003 + - url: https://mempool.aiblock.dev description: Testnet Mempool Node # TAGS tags: diff --git a/openapi/miner_openapi.yml b/openapi/miner_openapi.yml index 1cca5c6..821b00e 100644 --- a/openapi/miner_openapi.yml +++ b/openapi/miner_openapi.yml @@ -15,7 +15,7 @@ externalDocs: description: Find out more about AIBlock url: https://aiblock.ch servers: - - url: http://37.27.23.104:3000 + - url: http://localhost:3000 description: Testnet Miner Node tags: - name: info @@ -33,7 +33,6 @@ paths: parameters: - in: header name: x-cache-id - required: true description: An idempotent key for retrieving cached responses from the node schema: type: string diff --git a/openapi/storage_openapi.yml b/openapi/storage_openapi.yml index a61eaf0..24fd28c 100644 --- a/openapi/storage_openapi.yml +++ b/openapi/storage_openapi.yml @@ -17,7 +17,7 @@ externalDocs: description: Find out more about AIBlock url: https://aiblock.ch servers: - - url: http://37.27.23.104:3001 + - url: https://storage.aiblock.dev description: Testnet Storage Node tags: - name: info @@ -35,7 +35,6 @@ paths: parameters: - in: header name: x-cache-id - required: true description: An idempotent key for retrieving cached responses from the node schema: type: string @@ -58,7 +57,6 @@ paths: parameters: - in: header name: x-cache-id - required: true description: An idempotent key for retrieving cached responses from the node schema: type: string @@ -81,7 +79,6 @@ paths: parameters: - in: header name: x-cache-id - required: true description: An idempotent key for retrieving cached responses from the node schema: type: string @@ -128,7 +125,6 @@ paths: parameters: - in: header name: x-cache-id - required: true description: An idempotent key for retrieving cached responses from the node schema: type: string diff --git a/static/files/Infrastructure_AIBlock.postman_collection.json b/static/files/Infrastructure_AIBlock.postman_collection.json index c741331..dc2a6ec 100644 --- a/static/files/Infrastructure_AIBlock.postman_collection.json +++ b/static/files/Infrastructure_AIBlock.postman_collection.json @@ -79,7 +79,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3003/debug_data", + "raw": "https://mempool.aiblock.dev/debug_data", "protocol": "http", "host": [ "37", @@ -184,7 +184,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3003/total_supply", + "raw": "https://mempool.aiblock.dev/total_supply", "protocol": "http", "host": [ "37", @@ -291,7 +291,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3003/issued_supply", + "raw": "https://mempool.aiblock.dev/issued_supply", "protocol": "http", "host": [ "37", @@ -421,7 +421,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3003/fetch_balance", + "raw": "https://mempool.aiblock.dev/fetch_balance", "protocol": "http", "host": [ "37", @@ -604,7 +604,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3003/create_item_asset", + "raw": "https://mempool.aiblock.dev/create_item_asset", "protocol": "http", "host": [ "37", @@ -836,7 +836,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3001/debug_data", + "raw": "https://storage.aiblock.dev/debug_data", "protocol": "http", "host": [ "37", @@ -945,7 +945,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3001/latest_block", + "raw": "https://storage.aiblock.dev/latest_block", "protocol": "http", "host": [ "37", @@ -1070,7 +1070,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3001/block_by_num", + "raw": "https://storage.aiblock.dev/block_by_num", "protocol": "http", "host": [ "37", @@ -1252,7 +1252,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3001/blockchain_entry", + "raw": "https://storage.aiblock.dev/blockchain_entry", "protocol": "http", "host": [ "37", @@ -1479,7 +1479,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3004/debug_data", + "raw": "http://localhost:3004/debug_data", "protocol": "http", "host": [ "37", @@ -1694,7 +1694,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3004/payment_address", + "raw": "http://localhost:3004/payment_address", "protocol": "http", "host": [ "37", @@ -1799,7 +1799,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3004/current_mining_block", + "raw": "http://localhost:3004/current_mining_block", "protocol": "http", "host": [ "37", @@ -1904,7 +1904,7 @@ } ], "url": { - "raw": "http://37.27.23.104:3004/export_keypairs", + "raw": "http://localhost:3004/export_keypairs", "protocol": "http", "host": [ "37", @@ -2028,7 +2028,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3004/import_keypairs", + "raw": "http://localhost:3004/import_keypairs", "protocol": "http", "host": [ "37", @@ -2203,7 +2203,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3004/make_payment", + "raw": "http://localhost:3004/make_payment", "protocol": "http", "host": [ "37", @@ -2558,7 +2558,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3000/change_passphrase", + "raw": "http://localhost:3000/change_passphrase", "protocol": "http", "host": [ "37", @@ -2786,7 +2786,7 @@ } }, "url": { - "raw": "http://37.27.23.104:3000/update_running_total", + "raw": "http://localhost:3000/update_running_total", "protocol": "http", "host": [ "37", diff --git a/static/files/TestNet.postman_environment.json b/static/files/TestNet.postman_environment.json index e032151..99f0d7a 100644 --- a/static/files/TestNet.postman_environment.json +++ b/static/files/TestNet.postman_environment.json @@ -4,27 +4,27 @@ "values": [ { "key": "mempool_api_endpoint", - "value": "37.27.23.104", + "value": "mempool.aiblock.dev", "enabled": true }, { "key": "mempool_api_port", - "value": "3003", + "value": "443", "enabled": true }, { "key": "storage_api_endpoint", - "value": "37.27.23.104", + "value": "storage.aiblock.dev", "enabled": true }, { "key": "storage_api_port", - "value": "3001", + "value": "443", "enabled": true }, { "key": "miner_api_endpoint", - "value": "37.27.23.104", + "value": "localhost", "enabled": true }, { @@ -34,7 +34,7 @@ }, { "key": "user_api_endpoint", - "value": "37.27.23.104", + "value": "localhost", "enabled": true }, { @@ -44,7 +44,7 @@ }, { "key": "protocol", - "value": "http", + "value": "https", "enabled": true }, {