Update 2021-03-12T09:52:27.287Z

api/address/get-address-assets.example.json

@@ -0,0 +1,17 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 0,
+  "results": [
+    {
+      "event_index": 0,
+      "event_type": "stx_asset",
+      "asset": {
+        "asset_event_type": "transfer",
+        "sender": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
+        "recipient": "ST2TJRHDHMYBQ417HFB0BDX430TQA5PXRX6495G1V",
+        "amount": "500000"
+      }
+    }
+  ]
+}

api/address/get-address-assets.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns address assets","title":"AddressAssetsListResponse","type":"object","required":["results","limit","offset","total"],"properties":{"limit":{"type":"integer","maximum":30},"offset":{"type":"integer"},"total":{"type":"integer"},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEvent","oneOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventSmartContractLog","description":"Only present in `smart_contract` and `contract_call` tx types.","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","contract_log"],"properties":{"event_type":{"type":"string","enum":["smart_contract_log"]},"contract_log":{"type":"object","additionalProperties":false,"required":["contract_id","topic","value"],"properties":{"contract_id":{"type":"string"},"topic":{"type":"string"},"value":{"type":"object","additionalProperties":false,"required":["hex","repr"],"properties":{"hex":{"type":"string"},"repr":{"type":"string"}}}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventStxLock","description":"Only present in `smart_contract` and `contract_call` tx types.","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","stx_lock_event"],"properties":{"event_type":{"type":"string","enum":["stx_lock"]},"stx_lock_event":{"type":"object","additionalProperties":false,"required":["locked_amount","unlock_height","locked_address"],"properties":{"locked_amount":{"type":"string"},"unlock_height":{"type":"integer"},"locked_address":{"type":"string"}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventStxAsset","description":"Only present in `smart_contract` and `contract_call` tx types.","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","asset"],"properties":{"event_type":{"type":"string","enum":["stx_asset"]},"asset":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventAsset","additionalProperties":false,"properties":{"asset_event_type":{"$schema":"http://json-schema.org/draft-07/schema#","title":"TransactionEventAssetType","type":"string","enum":["transfer","mint","burn"]},"asset_id":{"type":"string"},"sender":{"type":"string"},"recipient":{"type":"string"},"amount":{"type":"string"},"value":{"type":"string"}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventFungibleAsset","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","asset"],"properties":{"event_type":{"type":"string","enum":["fungible_token_asset"]},"asset":{"type":"object","additionalProperties":false,"required":["asset_event_type","asset_id","sender","recipient","amount"],"properties":{"asset_event_type":{"type":"string"},"asset_id":{"type":"string"},"sender":{"type":"string"},"recipient":{"type":"string"},"amount":{"type":"string"}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventNonFungibleAsset","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","asset"],"properties":{"event_type":{"type":"string","enum":["non_fungible_token_asset"]},"asset":{"type":"object","additionalProperties":false,"required":["asset_event_type","asset_id","sender","recipient","value"],"properties":{"asset_event_type":{"type":"string"},"asset_id":{"type":"string"},"sender":{"type":"string"},"recipient":{"type":"string"},"value":{"type":"object","additionalProperties":false,"required":["hex","repr"],"properties":{"hex":{"type":"string"},"repr":{"type":"string"}}}}}}}]}]}}}}

api/address/get-address-balances.example.json

@@ -0,0 +1,14 @@
+{
+  "stx": {
+    "balance": "1000000",
+    "total_sent": "0",
+    "total_received": "1000000",
+    "lock_tx_id": "0xec94e7d20af8979b44d17a0520c126bf742b999a0fc7ddbcbe0ab21b228ecc8c",
+    "locked": "50000",
+    "lock_height": 100,
+    "burnchain_lock_height": 100,
+    "burnchain_unlock_height": 200
+  },
+  "fungible_tokens": {},
+  "non_fungible_tokens": {}
+}

api/address/get-address-balances.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns address balances","title":"AddressBalanceResponse","type":"object","required":["stx","fungible_tokens","non_fungible_tokens"],"properties":{"stx":{"$schema":"http://json-schema.org/draft-07/schema#","description":"StxBalance","type":"object","additionalProperties":false,"required":["balance","total_sent","total_received","total_fees_sent","total_miner_rewards_received","lock_tx_id","locked","lock_height","burnchain_lock_height","burnchain_unlock_height"],"properties":{"balance":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"},"total_fees_sent":{"type":"string"},"total_miner_rewards_received":{"type":"string"},"lock_tx_id":{"type":"string","description":"The transaction where the lock event occurred. Empty if no tokens are locked."},"locked":{"type":"string","description":"The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked."},"lock_height":{"type":"integer","description":"The STX chain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_lock_height":{"type":"integer","description":"The burnchain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_unlock_height":{"type":"integer","description":"The burnchain block height of when the tokens unlock. Zero if no tokens are locked."}}},"fungible_tokens":{"type":"object","patternProperties":{"*":{"$schema":"http://json-schema.org/draft-07/schema#","description":"FtBalance","type":"object","additionalProperties":false,"required":["balance","total_sent","total_received"],"properties":{"balance":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"}}}}},"non_fungible_tokens":{"type":"object","patternProperties":{"*":{"$schema":"http://json-schema.org/draft-07/schema#","description":"NftBalance","type":"object","additionalProperties":false,"required":["count","total_sent","total_received"],"properties":{"count":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"}}}}}}}

api/address/get-address-stx-balance.example.json

@@ -0,0 +1,10 @@
+{
+  "balance": "1000000",
+  "total_sent": "0",
+  "total_received": "1000000",
+  "lock_tx_id": "0xec94e7d20af8979b44d17a0520c126bf742b999a0fc7ddbcbe0ab21b228ecc8c",
+  "locked": "50000",
+  "lock_height": 100,
+  "burnchain_lock_height": 100,
+  "burnchain_unlock_height": 200
+}

api/address/get-address-stx-balance.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns address balances","title":"AddressStxBalanceResponse","type":"object","additionalProperties":false,"required":["balance","total_sent","total_received","total_fees_sent","total_miner_rewards_received","lock_tx_id","locked","lock_height","burnchain_lock_height","burnchain_unlock_height"],"properties":{"balance":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"},"total_fees_sent":{"type":"string"},"total_miner_rewards_received":{"type":"string"},"lock_tx_id":{"type":"string","description":"The transaction where the lock event occurred. Empty if no tokens are locked."},"locked":{"type":"string","description":"The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked."},"lock_height":{"type":"integer","description":"The STX chain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_lock_height":{"type":"integer","description":"The burnchain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_unlock_height":{"type":"integer","description":"The burnchain block height of when the tokens unlock. Zero if no tokens are locked."}}}

api/address/get-address-stx-inbound.example.json

@@ -0,0 +1,16 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 0,
+  "results": [
+    {
+      "sender": "ST1RZG804V6Y0N4XHQD3ZE2GE3XSCV3VHRKMA3GB0",
+      "amount": "123456789",
+      "memo": "0x00000000000000000000000000000000000000000000000000000000000000000000",
+      "block_height": 12345,
+      "tx_id": "0x29e25515652dad41ef675bd0670964e3d537b80ec19cf6ca6f1dd65d5bc642c5",
+      "transfer_type": "bulk-send",
+      "tx_index": 3
+    }    
+  ]
+}

api/address/get-address-stx-inbound.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns a list of inbound STX transfers with a memo","title":"AddressStxInboundListResponse","type":"object","required":["results","limit","offset","total"],"properties":{"limit":{"type":"integer","maximum":30},"offset":{"type":"integer"},"total":{"type":"integer"},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"InboundStxTransfer","description":"A inbound STX transfer with a memo","type":"object","required":["sender","amount","memo","block_height","tx_id","transfer_type","tx_index"],"properties":{"sender":{"type":"string","description":"Principal that sent this transfer"},"amount":{"type":"string","description":"Transfer amount in micro-STX as integer string"},"memo":{"type":"string","description":"Hex encoded memo bytes associated with the transfer"},"block_height":{"type":"number","description":"Block height at which this transfer occurred"},"tx_id":{"type":"string","description":"The transaction ID in which this transfer occurred"},"transfer_type":{"type":"string","enum":["bulk-send","stx-transfer"],"description":"Indicates if the transfer is from a stx-transfer transaction or a contract-call transaction"},"tx_index":{"type":"number","description":"Index of the transaction within a block"}}}}}}

api/address/get-address-transactions.example.json

@@ -0,0 +1,24 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 4989,
+  "results": [
+    {
+      "tx_id": "0xb16077b94222bc1466396d30df13db460864e85ce929a20aae0a2ac80b31e4e2",
+      "tx_status": "success",
+      "tx_type": "coinbase",
+      "fee_rate": "0",
+      "sender_address": "ST2TJRHDHMYBQ417HFB0BDX430TQA5PXRX6495G1V",
+      "sponsored": false,
+      "post_condition_mode": "deny",
+      "block_hash": "0x83f84f814c1b00ddb672d93b97d06c8326f76746d90a979c12b69e54beb73f69",
+      "block_height": 5603,
+      "burn_block_time": 1594335838,
+      "canonical": true,
+      "tx_index": 0,
+      "coinbase_payload": {
+        "data": "0x0000000000000000000000000000000000000000000000000000000000000000"
+      }
+    }
+  ]
+}

api/blocks/get-blocks.example.json

@@ -0,0 +1,15 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "total": 3275,
+  "results": [
+    {
+      "canonical": true,
+      "height": 3275,
+      "hash": "0xe77ba8cf6bb7c0e4f64adc83356289ed467d31a22354907b4bb814590058430f",
+      "parent_block_hash": "0x75ab21ef25cbff2caa14c27d830ed7886a4d1522e1b6f9e5dc3b59ccf73ed49f",
+      "burn_block_time": 1594233639,
+      "txs": ["0x66557c219c6b0cdb40681ecf79a69f03654d88ef1910651a7db0b078f58af5ca"]
+    }
+  ]
+}

api/blocks/get-blocks.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns blocks","additionalProperties":false,"title":"BlockListResponse","type":"object","required":["results","limit","offset","total"],"properties":{"limit":{"type":"integer","maximum":30,"description":"The number of blocks to return"},"offset":{"type":"integer","description":"The number to blocks to skip (starting at `0`)","default":0},"total":{"type":"integer","description":"The number of blocks available"},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"Block","description":"A block","type":"object","required":["canonical","height","hash","parent_block_hash","txs","burn_block_time","burn_block_time_iso","burn_block_hash","burn_block_height","miner_txid"],"properties":{"canonical":{"type":"boolean","description":"Set to `true` if block corresponds to the canonical chain tip"},"height":{"type":"integer","description":"Height of the block"},"hash":{"type":"string","description":"Hash representing the block"},"parent_block_hash":{"type":"string","description":"Hash of the parent block"},"burn_block_time":{"type":"number","description":"Unix timestamp (in seconds) indicating when this block was mined."},"burn_block_time_iso":{"type":"string","description":"An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined."},"burn_block_hash":{"type":"string","description":"Hash of the anchor chain block"},"burn_block_height":{"type":"integer","description":"Height of the anchor chain block"},"miner_txid":{"type":"string","description":"Anchor chain transaction ID"},"txs":{"type":"array","description":"List of transactions included in the block","items":{"type":"string","description":"Transaction ID"}}}}}}}

api/bns/errors/bns-error.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-error","title":"BNSError","description":"Error","type":"object","properties":{"error":{"type":"string"}}}

api/bns/errors/bns-invalid-name-subdomain.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "Invalid name or subdomain"
+}

api/bns/errors/bns-invalid-page.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "Invalid page"
+}

api/bns/errors/bns-invalid-tx-id.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "Invalid txid"
+}

api/bns/errors/bns-no-such-name.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "No such name"
+}

api/bns/errors/bns-no-such-namespace.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "No such namespace"
+}

api/bns/errors/bns-no-zone-file.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "No zone file for name"
+}

api/bns/errors/bns-unsupported-blockchain.example.json

@@ -0,0 +1,3 @@
+{
+  "error": "Unsupported blockchain"
+}

api/bns/manage-names/bns-fetch-zone-file-response.example.json

@@ -0,0 +1,3 @@
+{
+  "zonefile": "$ORIGIN bar.test\n$TTL 3600\n_https._tcp URI 10 1 \"https://gaia.blockstack.org/hub/17Zijx61Sp7SbVfRTdETo7PhizJHYEUxbY/profile.json\"\n"
+}

api/bns/manage-names/bns-fetch-zone-file-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-fetch-zone-file-response","title":"BNSFetchFileZoneResponse","description":"Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.","required":[],"anyOf":[{"type":"object","properties":{"zonefile":{"type":"string","pattern":".+"}}},{"type":"object","properties":{"error":{"type":"string","pattern":".+"}}}]}

api/bns/name-querying/bns-get-all-names-response.example.json

@@ -0,0 +1 @@
+["aldenquimby.id", "aldeoryn.id", "alderete.id", "aldert.id", "aldi.id", "aldighieri.id"]

api/bns/name-querying/bns-get-all-names-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-all-names-response","title":"BNSGetAllNamesResponse","description":"Fetch a list of all names known to the node.","required":[],"type":"array","items":{"type":"string","pattern":"^([a-z0-9\\-_.+]{3,37})$"}}

api/bns/name-querying/bns-get-all-subdomains-response.example.json

@@ -0,0 +1,10 @@
+[
+  "collegeinfogeek.verified.podcast",
+  "collider.verified.podcast",
+  "combatandclassics.verified.podcast",
+  "combatjack.verified.podcast",
+  "comedybangbang.verified.podcast",
+  "comedybutton.verified.podcast",
+  "commonsense.verified.podcast",
+  "concilio002.personal.id"
+]

api/bns/name-querying/bns-get-all-subdomains-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-all-subdomains-response","title":"BNSGetAllSubdomainsResponse","description":"Fetch a list of all subdomains known to the node.","required":[],"type":"array","items":{"type":"string","pattern":"^([a-z0-9\\-_.+]{3,37}).([a-z0-9\\-_.+]{3,37})$"}}

api/bns/name-querying/bns-get-historical-zone-file-response.example.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "bns-fetch-historical-zone-file-response",
+  "title": "BNSFetchHistoricalZoneFileResponse",
+  "description": "Fetches the historical zonefile specified by the username and zone hash.",
+  "required": [],
+  "anyOf": [
+    {
+      "type": "object",
+      "properties": {
+        "zonefile": { "type": "string" }
+      }
+    },
+    {
+      "type": "object",
+      "properties": {
+        "error": { "type": "string" }
+      }
+    }
+  ]
+}

api/bns/name-querying/bns-get-historical-zone-file-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-fetch-historical-zone-file-response","title":"BNSFetchHistoricalZoneFileResponse","description":"Fetches the historical zonefile specified by the username and zone hash.","required":[],"anyOf":[{"type":"object","properties":{"zonefile":{"type":"string"}}},{"type":"object","properties":{"error":{"type":"string"}}}]}

api/bns/name-querying/bns-get-name-history-response.example.json

@@ -0,0 +1,3 @@
+{
+  "zonefile": "$ORIGIN muneeb.id\n$TTL 3600\n_http._tcp IN URI 10 1 \"https://blockstack.s3.amazonaws.com/muneeb.id\"\n"
+}

api/bns/name-querying/bns-get-name-history-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-name-history","title":"BNSGetNameHistoryResponse","description":"Get a history of all blockchain records of a registered name.","type":"object","patternProperties":{"^[0-9]+":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$"},"base":{"type":"integer","minimum":0,"maximum":255},"buckets":{"anyOf":[{"type":"array","items":{"type":"integer","minItems":16,"maxItems":16}},{"type":"null"}]},"block_number":{"type":"integer","minimum":0},"coeff":{"anyOf":[{"type":"integer","minimum":0,"maximum":255},{"type":"null"}]},"consensus_hash":{"anyOf":[{"type":"string","pattern":"^[0-9a-fA-F]{32}"},{"type":"null"}]},"domain":{"type":"string","pattern":"^([a-z0-9\\-_.+]{3,37})$"},"fee":{"type":"integer","minimum":0},"first_registered":{"type":"integer","minimum":0},"history_snapshot":{"type":"boolean"},"importer":{"anyOf":[{"type":"string","pattern":"^76[aA]914[0-9a-fA-F]{40}88[aA][cC]$"},{"type":"null"}]},"importer_address":{"anyOf":[{"type":"string","pattern":"^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$"},{"type":"null"}]},"last_renewed":{"type":"integer","minimum":0},"name":{"type":"string","pattern":"^([a-z0-9\\-_.+]{3,37}).([a-z0-9\\-_.+]{3,37})$"},"op":{"type":"string","pattern":"^([>?+~:!&*:;#]{1}|>>|>~|::)$"},"op_fee":{"type":"number"},"opcode":{"type":"string","pattern":"^NAME_TRANSFER|NAME_PREORDER|NAME_UPDATE|NAME_REVOKE|NAME_REGISTRATION|NAMESPACE_READY|NAMESPACE_REVEAL|NAMESPACE_PREORDER|NAME_RENEWAL|NAME_IMPORT|ANNOUNCE$"},"revoked":{"type":"boolean"},"sender":{"type":"string","pattern":"^([0-9a-fA-F]+)$"},"sender_pubkey":{"anyOf":[{"type":"string","pattern":"^([0-9a-fA-F]+)$"},{"type":"null"}]},"sequence":{"type":"integer","minimum":0},"recipient":{"anyOf":[{"type":"string","pattern":"^([0-9a-fA-F]+)$"},{"type":"null"}]},"recipient_address":{"anyOf":[{"type":"string","pattern":"^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$"},{"type":"null"}]},"recipient_pubkey":{"anyOf":[{"type":"string","pattern":"^([0-9a-fA-F]+)$"},{"type":"null"}]},"txid":{"type":"string","pattern":"^([0-9a-fA-F]+)$"},"value_hash":{"anyOf":[{"type":"string","pattern":"^([0-9a-fA-F]{40})$"},{"type":"null"}]},"vtxindex":{"type":"integer","minimum":0}},"required":["txid","vtxindex"]}}}}

api/bns/name-querying/bns-get-name-info.response.example.json

@@ -0,0 +1,12 @@
+{
+  "address": "1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs",
+  "blockchain": "bitcoin",
+  "expire_block": 599266,
+  "grace_period": false,
+  "last_txid": "1edfa419f7b83f33e00830bc9409210da6c6d1db60f99eda10c835aa339cad6b",
+  "renewal_deadline": 604266,
+  "resolver": null,
+  "status": "registered",
+  "zonefile": "$ORIGIN muneeb.id\n$TTL 3600\n_http._tcp IN URI 10 1 \"https://gaia.blockstack.org/hub/1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs/0/profile.json\"\n",
+  "zonefile_hash": "37aecf837c6ae9bdc9dbd98a268f263dacd00361"
+}

api/bns/name-querying/bns-get-name-info.response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-name-info","title":"BNSGetNameInfoResponse","description":"Get name details","type":"object","required":["address","blockchain","last_txid","status","zonefile","zonefile_hash"],"properties":{"address":{"type":"string"},"blockchain":{"type":"string","pattern":"^stacks$"},"expire_block":{"type":"integer","minimum":0},"grace_period":{"type":"integer","minimum":0},"last_txid":{"type":"string"},"resolver":{"type":"string"},"status":{"type":"string"},"zonefile":{"type":"string"},"zonefile_hash":{"type":"string"}}}

api/bns/name-querying/bns-get-name-price-response.example.json

@@ -0,0 +1,6 @@
+{
+  "name_price": {
+    "units": "BTC",
+    "amount": "100000"
+  }
+}

api/bns/name-querying/bns-get-name-price-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-name-price-response","title":"BNSGetNamePriceResponse","description":"Fetch price for name.","required":["units","amount"],"type":"object","properties":{"units":{"type":"string"},"amount":{"type":"string","pattern":"^[0-9]+$"}}}

api/bns/name-querying/bns-get-names-owned-by-address-response.example.json

@@ -0,0 +1,3 @@
+{
+  "names": ["muneeb.id"]
+}

api/bns/name-querying/bns-get-names-owned-by-address-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-names-own-by-address-response","title":"BNSNamesOwnByAddressResponse","description":"Retrieves a list of names owned by the address provided.","required":[],"type":"object","properties":{"names":{"type":"array","items":{"type":"string","pattern":"^([a-z0-9-_.+]{3,37})$"}}}}

api/bns/name-querying/bns-get-subdomain-at-tx-response.example.json

@@ -0,0 +1,34 @@
+[
+  {
+    "accepted": 1,
+    "block_height": 546199,
+    "domain": "id.blockstack",
+    "fully_qualified_subdomain": "nturl345.id.blockstack",
+    "missing": "",
+    "owner": "17Q8hcsxRLCk3ypJiGeXQv9tFK9GnHr5Ea",
+    "parent_zonefile_hash": "58224144791919f6206251a9960a2dd5723b96b6",
+    "parent_zonefile_index": 95780,
+    "resolver": "https://registrar.blockstack.org",
+    "sequence": 0,
+    "signature": "None",
+    "txid": "d04d708472ea3c147f50e43264efdb1535f71974053126dc4db67b3ac19d41fe",
+    "zonefile_hash": "d3bdf1cf010aac3f21fac473e41450f5357e0817",
+    "zonefile_offset": 0
+  },
+  {
+    "accepted": 1,
+    "block_height": 546199,
+    "domain": "id.blockstack",
+    "fully_qualified_subdomain": "dwerner1.id.blockstack",
+    "missing": "",
+    "owner": "17tFeKEBMUAAiHVsCgqKo8ccwYqq7aCn9X",
+    "parent_zonefile_hash": "58224144791919f6206251a9960a2dd5723b96b6",
+    "parent_zonefile_index": 95780,
+    "resolver": "https://registrar.blockstack.org",
+    "sequence": 0,
+    "signature": "None",
+    "txid": "d04d708472ea3c147f50e43264efdb1535f71974053126dc4db67b3ac19d41fe",
+    "zonefile_hash": "ab79b1774fa7a4c5709b6ad4e5892fb7c0f79765",
+    "zonefile_offset": 1
+  }
+]

api/bns/name-querying/bns-get-subdomain-at-tx-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-subdomain-at-tx","title":"BNSGetSubdomainAtTx","description":"Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.","required":["accepted","block_height","domain","fully_qualified_subdomain","missing","owner","parent_zonefile_hash","parent_zonefile_index","resolver","sequence","signature","txid","zonefile_hash","zonefile_offset"],"type":"array","items":{"type":"object","properties":{"accepted":{"type":"integer","minimum":0,"maximum":1},"block_height":{"type":"integer","minimum":0},"domain":{"type":"string","pattern":"^([a-z0-9\\-_.+]{3,37})$|^([a-z0-9\\-_.+]){3,37}$"},"fully_qualified_subdomain":{"type":"string","pattern":"^([a-z0-9\\-_.+]{3,37}).([a-z0-9\\-_.+]{3,37})$"},"missing":{"type":"string"},"owner":{"type":"string","pattern":"^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$"},"parent_zonefile_hash":{"type":"string","pattern":"^[0-9a-fA-F]{40}"},"parent_zonefile_index":{"type":"integer","minimum":0},"resolver":{"type":"string"},"sequence":{"type":"integer","minimum":0},"signature":{"type":"string"},"txid":{"type":"string","pattern":"^[0-9a-fA-F]{64}"},"zonefile_hash":{"type":"string","pattern":"^[0-9a-fA-F]{40}"},"zonefile_offset":{"type":"integer","minimum":0}}}}

api/bns/namespace-operations/bns-get-all-namespaces-names-response.example.json

@@ -0,0 +1 @@
+["aldenquimby.id", "aldeoryn.id", "alderete.id", "aldert.id", "aldi.id", "aldighieri.id"]

api/bns/namespace-operations/bns-get-all-namespaces-names-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-all-namespaces-names-response","title":"BNSGetAllNamespacesNamesResponse","description":"Fetch a list of names from the namespace.","type":"array","items":{"type":"string","pattern":"^([a-z0-9-_.+]{3,37})$"}}

api/bns/namespace-operations/bns-get-all-namespaces-response.example.json

@@ -0,0 +1,3 @@
+{
+  "namespaces": ["id", "helloworld", "podcast", "graphite", "blockstack"]
+}

api/bns/namespace-operations/bns-get-all-namespaces-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-all-namespaces-response","title":"BNSGetAllNamespacesResponse","description":"Fetch a list of all namespaces known to the node.","required":["namespaces"],"type":"object","properties":{"namespaces":{"type":"array","items":{"type":"string"}}}}

api/bns/namespace-operations/bns-get-namespace-price-response.example.json

@@ -0,0 +1,4 @@
+{
+  "units": "BTC",
+  "amount": "4000000000"
+}

api/bns/namespace-operations/bns-get-namespace-price-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"bns-get-namespace-price-response","title":"BNSGetNamespacePriceResponse","description":"Fetch price for namespace.","required":["units","amount"],"type":"object","properties":{"units":{"type":"string"},"amount":{"type":"string","pattern":"^[0-9]+$"}}}

api/burnchain/get-rewards.example.json

@@ -0,0 +1,24 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "results": [
+    {
+      "canonical": true,
+      "burn_block_hash": "0x4eaabcd105865e471f697eff5dd5bd85d47ecb5a26a3379d74fae0ae87c40904",
+      "burn_block_height": 331,
+      "burn_amount": "12000",
+      "reward_recipient": "1C56LYirKa3PFXFsvhSESgDy2acEHVAEt6",
+      "reward_amount": "5000",
+      "reward_index": 0
+    },
+    {
+      "canonical": true,
+      "burn_block_hash": "0x4eaabcd105865e471f697eff5dd5bd85d47ecb5a26a3379d74fae0ae87c40904",
+      "burn_block_height": 336,
+      "burn_amount": "14000",
+      "reward_recipient": "1M3bvWB9CRh5BTumeVxtHDEV6W4S2R9AZw",
+      "reward_amount": "2000",
+      "reward_index": 0
+    }
+  ]
+}

api/burnchain/get-rewards.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns blocks","additionalProperties":false,"title":"BurnchainRewardListResponse","type":"object","required":["results","limit","offset"],"properties":{"limit":{"type":"integer","maximum":30,"description":"The number of burnchain rewards to return"},"offset":{"type":"integer","description":"The number to burnchain rewards to skip (starting at `0`)","default":0},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"BurnchainReward","description":"Reward payment made on the burnchain","type":"object","required":["canonical","burn_block_hash","burn_block_height","burn_amount","reward_recipient","reward_amount","reward_index"],"properties":{"canonical":{"type":"boolean","description":"Set to `true` if block corresponds to the canonical burchchain tip"},"burn_block_hash":{"type":"string","description":"The hash representing the burnchain block"},"burn_block_height":{"type":"integer","description":"Height of the burnchain block"},"burn_amount":{"type":"string","description":"The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin)"},"reward_recipient":{"type":"string","description":"The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin)"},"reward_amount":{"type":"string","description":"The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin)"},"reward_index":{"type":"integer","description":"The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain block"}}}}}}

api/contract/post-call-read-only-fn-fail.example.json

@@ -0,0 +1,4 @@
+{
+  "okay": false,
+  "cause": "Unchecked(PublicFunctionNotReadOnly(..."
+}

api/contract/post-call-read-only-fn-success.example.json

@@ -0,0 +1,4 @@
+{
+  "okay": true,
+  "result": "0x111..."
+}

api/contract/post-call-read-only-fn.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request to get contract source","title":"ReadOnlyFunctionSuccessResponse","type":"object","additionalProperties":false,"required":["okay"],"properties":{"okay":{"type":"boolean"},"result":{"type":"string"},"cause":{"type":"string"}}}

api/core-node/get-account-data.example.json

@@ -0,0 +1,8 @@
+{
+  "balance": "0x0000000000000000000000000007a120",
+  "locked": "0x0000000000000000000000000007a120",
+  "unlock_height": 126,
+  "nonce": 2867,
+  "balance_proof": "0xabce",
+  "nonce_proof": "0xabcd"
+}

api/core-node/get-account-data.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request for account data","title":"AccountDataResponse","type":"object","additionalProperties":false,"required":["balance","locked","unlock_height","nonce","balance_proof","nonce_proof"],"properties":{"balance":{"type":"string"},"locked":{"type":"string"},"unlock_height":{"type":"integer"},"nonce":{"type":"integer"},"balance_proof":{"type":"string"},"nonce_proof":{"type":"string"}}}

api/core-node/get-contract-data-map-entry.example.json

@@ -0,0 +1,4 @@
+{
+  "data": "0x0a0c000000010a6d6f6e737465722d69640100000000000000000000000000000001",
+  "proof": "0x123..."
+}

api/core-node/get-contract-data-map-entry.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"Response of get data map entry request","title":"MapEntryResponse","type":"object","required":["data"],"properties":{"data":{"type":"string","description":"Hex-encoded string of clarity value. It is always an optional tuple."},"proof":{"type":"string","description":"Hex-encoded string of the MARF proof for the data"}}}

api/core-node/get-contract-interface.example.json

@@ -0,0 +1,134 @@
+{
+  "functions": [
+    {
+      "name": "get-value",
+      "access": "public",
+      "args": [
+        {
+          "name": "key",
+          "type": {
+            "buffer": {
+              "length": 32
+            }
+          }
+        }
+      ],
+      "outputs": {
+        "type": {
+          "response": {
+            "ok": {
+              "buffer": {
+                "length": 32
+              }
+            },
+            "error": "int128"
+          }
+        }
+      }
+    },
+    {
+      "name": "set-value",
+      "access": "public",
+      "args": [
+        {
+          "name": "key",
+          "type": {
+            "buffer": {
+              "length": 32
+            }
+          }
+        },
+        {
+          "name": "value",
+          "type": {
+            "buffer": {
+              "length": 32
+            }
+          }
+        }
+      ],
+      "outputs": {
+        "type": {
+          "response": {
+            "ok": "uint128",
+            "error": "none"
+          }
+        }
+      }
+    },
+    {
+      "name": "test-emit-event",
+      "access": "public",
+      "args": [],
+      "outputs": {
+        "type": {
+          "response": {
+            "ok": "uint128",
+            "error": "none"
+          }
+        }
+      }
+    },
+    {
+      "name": "test-event-types",
+      "access": "public",
+      "args": [],
+      "outputs": {
+        "type": {
+          "response": {
+            "ok": "uint128",
+            "error": "none"
+          }
+        }
+      }
+    }
+  ],
+  "variables": [
+    {
+      "name": "recipient",
+      "type": "principal",
+      "access": "constant"
+    },
+    {
+      "name": "sender",
+      "type": "principal",
+      "access": "constant"
+    }
+  ],
+  "maps": [
+    {
+      "name": "store",
+      "key": [
+        {
+          "name": "key",
+          "type": {
+            "buffer": {
+              "length": 32
+            }
+          }
+        }
+      ],
+      "value": [
+        {
+          "name": "value",
+          "type": {
+            "buffer": {
+              "length": 32
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "fungible_tokens": [
+    {
+      "name": "novel-token-19"
+    }
+  ],
+  "non_fungible_tokens": [
+    {
+      "name": "hello-nft",
+      "type": "uint128"
+    }
+  ]
+}

api/core-node/get-contract-interface.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request to get contract interface","title":"ContractInterfaceResponse","type":"object","required":["functions","variables","maps","fungible_tokens","non_fungible_tokens"],"properties":{"functions":{"type":"array","items":{"type":"object"},"description":"List of defined methods"},"variables":{"type":"array","items":{"type":"object"},"description":"List of defined variables"},"maps":{"type":"array","items":{"type":"object"},"description":"List of defined data-maps"},"fungible_tokens":{"type":"array","items":{"type":"object"},"description":"List of fungible tokens in the contract"},"non_fungible_tokens":{"type":"array","items":{"type":"object"},"description":"List of non-fungible tokens in the contract"}}}

api/core-node/get-contract-source.example.json

@@ -0,0 +1,5 @@
+{
+  "source": "(define-constant sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR)\n(define-constant recipient 'SM2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQVX8X0G)\n\n(define-fungible-token novel-token-19)\n(begin (ft-mint? novel-token-19 u12 sender))\n(begin (ft-transfer? novel-token-19 u2 sender recipient))\n\n(define-non-fungible-token hello-nft uint)\n(begin (nft-mint? hello-nft u1 sender))\n(begin (nft-mint? hello-nft u2 sender))\n(begin (nft-transfer? hello-nft u1 sender recipient))\n\n(define-public (test-emit-event)\n    (begin\n        (print \"Event! Hello world\")\n        (ok u1)))\n(begin (test-emit-event))\n\n(define-public (test-event-types)\n    (begin\n        (unwrap-panic (ft-mint? novel-token-19 u3 recipient))\n        (unwrap-panic (nft-mint? hello-nft u2 recipient))\n        (unwrap-panic (stx-transfer? u60 tx-sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR))\n        (unwrap-panic (stx-burn? u20 tx-sender))\n        (ok u1)))\n\n(define-map store ((key (buff 32))) ((value (buff 32))))\n(define-public (get-value (key (buff 32)))\n    (begin\n        (match (map-get? store ((key key)))\n            entry (ok (get value entry))\n            (err 0))))\n(define-public (set-value (key (buff 32)) (value (buff 32)))\n    (begin\n        (map-set store ((key key)) ((value value)))\n        (ok u1)))",
+  "publish_height": 3196,
+  "proof": "0000001104060000001ec4e..."
+}

api/core-node/get-contract-source.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request to get contract source","title":"ContractSourceResponse","type":"object","additionalProperties":false,"required":["source","publish_height","proof"],"properties":{"source":{"type":"string"},"publish_height":{"type":"integer"},"proof":{"type":"string"}}}

api/core-node/get-fee-transfer.example.json

@@ -0,0 +1 @@
+1

api/core-node/get-fee-transfer.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET fee estimates","title":"CoreNodeFeeResponse","type":"string","additionalProperties":false}

api/core-node/get-info.example.json

@@ -0,0 +1,15 @@
+{
+  "peer_version": 385875968,
+  "pox_consensus": "17f76e597bab45646956f38dd39573085d72cbc0",
+  "burn_block_height": 16,
+  "stable_pox_consensus": "8e0561978fc5506b68a589c402dad97e862edb59",
+  "stable_burn_block_height": 15,
+  "server_version": "blockstack-core 0.0.1 => 23.0.0.0 (, release build, linux [x86_64])",
+  "network_id": 2147483648,
+  "parent_network_id": 3669344250,
+  "stacks_tip_height": 15,
+  "stacks_tip": "b1807a2d3f7f8c7922f7c1d60d7c34145ade05d789640dc7dc9ec1021e07bb54",
+  "stacks_tip_consensus_hash": "17f76e597bab45646956f38dd39573085d72cbc0",
+  "unanchored_tip": "0000000000000000000000000000000000000000000000000000000000000000",
+  "exit_at_block_height": null
+}

api/core-node/get-info.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that core node information","title":"CoreNodeInfoResponse","type":"object","additionalProperties":false,"required":["peer_version","pox_consensus","burn_block_height","stable_pox_consensus","stable_burn_block_height","server_version","network_id","parent_network_id","stacks_tip_height","stacks_tip","stacks_tip_consensus_hash","unanchored_tip","exit_at_block_height"],"properties":{"peer_version":{"type":"integer","description":"identifies the version number for the networking communication, this should not change while a node is running, and will only change if there's an upgrade"},"pox_consensus":{"type":"string","description":"is a hash used to identify the burnchain view for a node. it incorporates bitcoin chain information and PoX information. nodes that disagree on this value will appear to each other as forks. this value will change after every block"},"burn_block_height":{"type":"integer","description":"latest bitcoin chain height"},"stable_pox_consensus":{"type":"string","description":"same as burn_consensus, but evaluated at stable_burn_block_height"},"stable_burn_block_height":{"type":"integer","description":"leftover from stacks 1.0, basically always burn_block_height - 1"},"server_version":{"type":"string","description":"is a version descriptor"},"network_id":{"type":"integer","description":"is similar to peer_version and will be used to differentiate between different testnets. this value will be different between mainnet and testnet. once launched, this value will not change"},"parent_network_id":{"type":"integer","description":"same as network_id, but for bitcoin"},"stacks_tip_height":{"type":"integer","description":"the latest Stacks chain height. Stacks forks can occur independent of the Bitcoin chain, that height doesn't increase 1-to-1 with the Bitcoin height"},"stacks_tip":{"type":"string","description":"the best known block hash for the Stack chain (not including any pending microblocks)"},"stacks_tip_consensus_hash":{"type":"string","description":"the burn chain (i.e., bitcoin) consensus hash at the time that stacks_tip was mined"},"unanchored_tip":{"type":"string","description":"the latest microblock hash if any microblocks were processed. if no microblock has been processed for the current block, a 000.., hex array is returned"},"exit_at_block_height":{"type":"integer","description":"the block height at which the testnet network will be reset. not applicable for mainnet"}}}

api/core-node/get-pox.example.json

@@ -0,0 +1,11 @@
+{
+  "contract_id": "ST000000000000000000002AMW42H.pox",
+  "first_burnchain_block_height": 0,
+  "min_amount_ustx": 150000000000,
+  "registration_window_length": 250,
+  "rejection_fraction": 25,
+  "reward_cycle_id": 0,
+  "reward_cycle_length": 1000,
+  "rejection_votes_left_required": 1000,
+  "total_liquid_supply_ustx": 1000000000
+}

api/core-node/get-pox.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"Get Proof of Transfer (PoX) information","title":"CoreNodePoxResponse","type":"object","additionalProperties":false,"required":["contract_id","first_burnchain_block_height","min_amount_ustx","registration_window_length","rejection_fraction","reward_cycle_id","reward_cycle_length","rejection_votes_left_required","total_liquid_supply_ustx"],"properties":{"contract_id":{"type":"string"},"first_burnchain_block_height":{"type":"integer"},"min_amount_ustx":{"type":"integer"},"registration_window_length":{"type":"integer"},"rejection_fraction":{"type":"integer"},"reward_cycle_id":{"type":"integer"},"reward_cycle_length":{"type":"integer"},"rejection_votes_left_required":{"type":"integer"},"total_liquid_supply_ustx":{"type":"integer"}}}

api/faucet/run-faucet.example.json

@@ -0,0 +1,5 @@
+{
+  "success": true,
+  "txId": "0xf2f0402f9f4c4d43b382690c4f7b97e24d5ff5dd5c619e3615daa64dca7ef4bc",
+  "txRaw": "80800000000400164247d6f2b425ac5771423ae6c80c754f7172b0000000000000003200000000000000b400008537046ff1008368baaa3ff2235122c556b89dad4f9df0639b924cf32a44b866497e49846b24191e711b21faaae96ca0542e4a140168484740b94211cececb3303020000000000051ab52c45b1a7977204f17ac0b6f48306aea2dbb8e9000000000007a12046617563657400000000000000000000000000000000000000000000000000000000"
+}

api/faucet/run-faucet.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"POST request that runs the faucet","title":"RunFaucetResponse","type":"object","additionalProperties":false,"required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the faucet call was successful"},"txId":{"type":"string","description":"The transaction ID for the faucet call"},"txRaw":{"type":"string","description":"Raw transaction in hex string representation"}}}

api/info/get-network-block-time-by-network.example.json

@@ -0,0 +1,3 @@
+{
+  "target_block_time": 600
+}

api/info/get-network-block-time-by-network.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that target block time for a given network","title":"NetworkBlockTimeResponse","type":"object","additionalProperties":false,"required":["target_block_time","total_sent","total_received"],"properties":{"target_block_time":{"type":"integer"}}}

api/info/get-network-block-times.example.json

@@ -0,0 +1,8 @@
+{
+  "testnet": {
+    "target_block_time": 120
+  },
+  "mainnet": {
+    "target_block_time": 600
+  }
+}

api/info/get-network-block-times.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"NetworkBlockTimesResponse","type":"object","additionalProperties":false,"required":["mainnet","testnet"],"properties":{"mainnet":{"$schema":"http://json-schema.org/draft-07/schema#","description":"TargetBlockTime","type":"object","additionalProperties":false,"required":["target_block_time","total_sent","total_received"],"properties":{"target_block_time":{"type":"integer"}}},"testnet":{"$schema":"http://json-schema.org/draft-07/schema#","description":"TargetBlockTime","type":"object","additionalProperties":false,"required":["target_block_time","total_sent","total_received"],"properties":{"target_block_time":{"type":"integer"}}}}}

api/info/get-stx-supply-circulating-plain.example.json

@@ -0,0 +1 @@
+123.456789

api/info/get-stx-supply-circulating-plain.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetStxCirculatingSupplyPlainResponse","type":"string"}

api/info/get-stx-supply-legacy-format.example.json

@@ -0,0 +1,8 @@
+{
+  "unlockedPercent": "71.99",
+  "totalStacks": "1352464600.000000",
+  "totalStacksFormatted": "1,352,464,600.000000",
+  "unlockedSupply": "973705260.219817",
+  "unlockedSupplyFormatted": "973,705,260.219817",
+  "blockHeight": "665746"
+}

api/info/get-stx-supply-legacy-format.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetStxSupplyLegacyFormatResponse","type":"object","additionalProperties":false,"required":["unlockedPercent","totalStacks","totalStacksFormatted","unlockedSupply","unlockedSupplyFormatted","blockHeight"],"properties":{"unlockedPercent":{"type":"string","description":"String quoted decimal number of the percentage of STX that have unlocked"},"totalStacks":{"type":"string","description":"String quoted decimal number of the total possible number of STX"},"totalStacksFormatted":{"type":"string","description":"Same as `totalStacks` but formatted with comma thousands separators"},"unlockedSupply":{"type":"string","description":"String quoted decimal number of the STX that have been mined or unlocked"},"unlockedSupplyFormatted":{"type":"string","description":"Same as `unlockedSupply` but formatted with comma thousands separators"},"blockHeight":{"type":"string","description":"The block height at which this information was queried"}}}

api/info/get-stx-supply-plain.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetStxSupplyResponse","type":"object","additionalProperties":false,"required":["unlocked_percent","total_stx","unlocked_stx","block_height"],"properties":{"unlocked_percent":{"type":"string","description":"String quoted decimal number of the percentage of STX that have unlocked"},"total_stx":{"type":"string","description":"String quoted decimal number of the total possible number of STX"},"unlocked_stx":{"type":"string","description":"String quoted decimal number of the STX that have been mined or unlocked"},"block_height":{"type":"integer","description":"The block height at which this information was queried"}}}

api/info/get-stx-supply-total-supply-plain.example.json

@@ -0,0 +1 @@
+123.456789

api/info/get-stx-supply-total-supply-plain.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetStxTotalSupplyPlainResponse","type":"string"}

api/info/get-stx-supply.example.json

@@ -0,0 +1,6 @@
+{
+  "unlocked_percent": "71.99",
+  "total_stx": "1352464600.000000",
+  "unlocked_stx": "973705260.219817",
+  "block_height": 3210
+}

api/info/get-stx-supply.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetStxSupplyResponse","type":"object","additionalProperties":false,"required":["unlocked_percent","total_stx","unlocked_stx","block_height"],"properties":{"unlocked_percent":{"type":"string","description":"String quoted decimal number of the percentage of STX that have unlocked"},"total_stx":{"type":"string","description":"String quoted decimal number of the total possible number of STX"},"unlocked_stx":{"type":"string","description":"String quoted decimal number of the STX that have been mined or unlocked"},"block_height":{"type":"integer","description":"The block height at which this information was queried"}}}

api/info/get-total-stx-supply-legacy-format.example.json

@@ -0,0 +1,8 @@
+{
+  "unlockedPercent": "71.99",
+  "totalStacks": "1352464600.000000",
+  "totalStacksFormatted": "1,352,464,600.000000",
+  "unlockedSupply": "973705260.219817",
+  "unlockedSupplyFormatted": "973,705,260.219817",
+  "blockHeight": "665746"
+}

api/info/get-total-stx-supply-legacy-format.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetTotalStxSupplyLegacyFormatResponse","type":"object","additionalProperties":false,"required":["unlockedPercent","totalStacks","totalStacksFormatted","unlockedSupply","unlockedSupplyFormatted","blockHeight"],"properties":{"unlockedPercent":{"type":"string","description":"String quoted decimal number of the percentage of STX that have unlocked"},"totalStacks":{"type":"string","description":"String quoted decimal number of the total possible number of STX"},"totalStacksFormatted":{"type":"string","description":"Same as `totalStacks` but formatted with comma thousands separators"},"unlockedSupply":{"type":"string","description":"String quoted decimal number of the STX that have been mined or unlocked"},"unlockedSupplyFormatted":{"type":"string","description":"Same as `unlockedSupply` but formatted with comma thousands separators"},"blockHeight":{"type":"string","description":"The block height at which this information was queried"}}}

api/info/get-total-stx-supply.example.json

@@ -0,0 +1,6 @@
+{
+  "unlocked_percent": "71.99",
+  "total_stx": "1352464600.000000",
+  "unlocked_stx": "973705260.219817",
+  "block_height": 3210
+}

api/info/get-total-stx-supply.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"GetTotalStxSupplyResponse","type":"object","additionalProperties":false,"required":["unlocked_percent","total_stx","unlocked_stx","block_height"],"properties":{"unlocked_percent":{"type":"string","description":"String quoted decimal number of the percentage of STX that have unlocked"},"total_stx":{"type":"string","description":"String quoted decimal number of the total possible number of STX"},"unlocked_stx":{"type":"string","description":"String quoted decimal number of the STX that have been mined or unlocked"},"block_height":{"type":"integer","description":"The block height at which this information was queried"}}}

api/rosetta/rosetta-account-balance-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-account-request","type":"object","title":"RosettaAccountBalanceRequest","description":"An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint. If the block_identifier is populated, a historical balance query should be performed.","required":["network_identifier","account_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"account_identifier":{"type":"object","title":"RosettaAccount","description":"The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"sub_account":{"type":"object","title":"RosettaSubAccount","description":"An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"metadata":{"type":"object","description":"If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.","required":[]}}},"metadata":{"type":"object","description":"Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.","required":[]}}},"block_identifier":{"$id":"rosetta-partial-block-identifier.schema.json","type":"object","title":"RosettaPartialBlockIdentifier","description":"When fetching data by BlockIdentifier, it may be possible to only specify the index or hash. If neither property is specified, it is assumed that the client is making a request at the current block.","anyOf":[{"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]}}}

api/rosetta/rosetta-block-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-block-request","type":"object","title":"RosettaBlockRequest","description":"A BlockRequest is utilized to make a block request on the /block endpoint.","required":["network_identifier","block_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"block_identifier":{"$id":"rosetta-partial-block-identifier.schema.json","type":"object","title":"RosettaPartialBlockIdentifier","description":"When fetching data by BlockIdentifier, it may be possible to only specify the index or hash. If neither property is specified, it is assumed that the client is making a request at the current block.","anyOf":[{"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]}}}

api/rosetta/rosetta-block-transaction-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-block-transaction-request.schema.json","type":"object","title":"RosettaBlockTransactionRequest","description":"A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.","required":["network_identifier","block_identifier","transaction_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"block_identifier":{"$id":"rosetta-block-identifier.schema.json","title":"RosettaBlockIdentifier","description":"The block_identifier uniquely identifies a block in a particular network.","allOf":[{"required":["hash"],"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"required":["index"],"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]},"transaction_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}}}}

api/rosetta/rosetta-construction-combine-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-combine-response","type":"object","title":"RosettaConstructionCombineResponse","description":"RosettaConstructionCombineResponse is returned by /construction/combine. The network payload will be sent directly to the construction/submit endpoint.","required":["signed_transaction"],"properties":{"signed_transaction":{"type":"string","description":"Signed transaction bytes in hex"}}}

api/rosetta/rosetta-construction-derive-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"construction-derive-request","type":"object","title":"RosettaConstructionDeriveRequest","description":"Network is provided in the request because some blockchains have different address formats for different networks","required":["network_identifier","public_key"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"public_key":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-public-key-schema","type":"object","title":"RosettaPublicKey","description":"PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation.","required":["hex_bytes","curve_type"],"properties":{"hex_bytes":{"type":"string","description":"Hex-encoded public key bytes in the format specified by the CurveType."},"curve_type":{"type":"string","description":"CurveType is the type of cryptographic curve associated with a PublicKey.","enum":["secp256k1","edwards25519"]}}},"metadata":{"type":"object"}}}

api/rosetta/rosetta-construction-derive-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-derive-response","type":"object","title":"RosettaConstructionDeriveResponse","description":"ConstructionDeriveResponse is returned by the /construction/derive endpoint.","required":[],"properties":{"address":{"type":"string","description":"[DEPRECATED by account_identifier in v1.4.4] Address in network-specific format."},"account_identifier":{"type":"object","title":"RosettaAccountIdentifier","description":"The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"sub_account":{"type":"object","title":"RosettaSubAccount","description":"An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"metadata":{"type":"object","description":"If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.","required":[]}}},"metadata":{"type":"object","description":"Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.","required":[]}}},"metadata":{"type":"object"}}}

api/rosetta/rosetta-construction-hash-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-hash-request","type":"object","title":"RosettaConstructionHashRequest","description":"TransactionHash returns the network-specific transaction hash for a signed transaction.","required":["network_identifier","signed_transaction"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"signed_transaction":{"type":"string","description":"Signed transaction"}}}

api/rosetta/rosetta-construction-hash-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-hash-response","type":"object","title":"RosettaConstructionHashResponse","description":"TransactionIdentifier contains the transaction_identifier of a transaction that was submitted to either /construction/hash or /construction/submit.","required":["transaction_identifier"],"properties":{"transaction_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}},"metadata":{"type":"object"}}}

api/rosetta/rosetta-construction-metadata-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"http://example.com/example.json","type":"object","title":"RosettaConstructionMetadataRequest","description":"A ConstructionMetadataRequest is utilized to get information required to construct a transaction. The Options object used to specify which metadata to return is left purposely unstructured to allow flexibility for implementers. Optionally, the request can also include an array of PublicKeys associated with the AccountIdentifiers returned in ConstructionPreprocessResponse.","required":["network_identifier","options"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"options":{"$id":"rosetta-construction-options","title":"RosettaOptions","type":"object","description":"The options that will be sent directly to /construction/metadata by the caller.","required":[],"properties":{"sender_address":{"type":"string","description":"sender's address "},"type":{"type":"string","description":"Type of operation e.g transfer"},"status":{"type":"string","description":"This value indicates the state of the operations"},"token_transfer_recipient_address":{"type":"string","description":"Recipient's address"},"amount":{"type":"string","description":"Amount to be transfeered."},"symbol":{"type":"string","description":"Currency symbol e.g STX"},"decimals":{"type":"integer","description":"Number of decimal places"},"gas_limit":{"type":"number","description":"Maximum price a user is willing to pay."},"gas_price":{"type":"number","description":"Cost necessary to perform a transaction on the network"},"suggested_fee_multiplier":{"type":"number","description":" A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency."},"max_fee":{"type":"string","description":"Maximum fee user is willing to pay"},"fee":{"type":"string","description":"Fee for this transaction"}}},"public_keys":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-public-key-schema","type":"object","title":"RosettaPublicKey","description":"PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation.","required":["hex_bytes","curve_type"],"properties":{"hex_bytes":{"type":"string","description":"Hex-encoded public key bytes in the format specified by the CurveType."},"curve_type":{"type":"string","description":"CurveType is the type of cryptographic curve associated with a PublicKey.","enum":["secp256k1","edwards25519"]}}}}}}

api/rosetta/rosetta-construction-metadata-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-metadata-response","type":"object","title":"RosettaConstructionMetadataResponse","description":"The ConstructionMetadataResponse returns network-specific metadata used for transaction construction. Optionally, the implementer can return the suggested fee associated with the transaction being constructed. The caller may use this info to adjust the intent of the transaction or to create a transaction with a different account that can pay the suggested fee. Suggested fee is an array in case fee payment must occur in multiple currencies.","required":["metadata"],"properties":{"metadata":{"type":"object","required":[],"properties":{"account_sequence":{"type":"integer"},"recent_block_hash":{"type":"string"}}},"suggested_fee":{"type":"object","title":"RosettaAmount","description":"Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency.","required":["value","currency"],"properties":{"value":{"type":"string","description":"Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000."},"currency":{"description":"Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).","title":"RosettaCurrency","type":"object","required":["symbol","decimals"],"properties":{"symbol":{"type":"string","description":"Canonical symbol associated with a currency."},"decimals":{"type":"integer","description":"Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10."},"metadata":{"type":"object","description":"Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token."}}},"metadata":{"type":"object","description":"","required":[]}}}}}

api/rosetta/rosetta-construction-parse-request.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-parse-request","type":"object","title":"RosettaConstructionParseRequest","description":"Parse is called on both unsigned and signed transactions to understand the intent of the formulated transaction. This is run as a sanity check before signing (after /construction/payloads) and before broadcast (after /construction/combine).","required":["network_identifier","signed","transaction"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Network name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"signed":{"type":"boolean","description":"Signed is a boolean indicating whether the transaction is signed."},"transaction":{"type":"string","description":"This must be either the unsigned transaction blob returned by /construction/payloads or the signed transaction blob returned by /construction/combine."}}}

api/rosetta/rosetta-construction-payloads-response.schema.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"http://example.com/example.json","type":"object","title":"RosettaConstructionPayloadResponse","description":"RosettaConstructionPayloadResponse is returned by /construction/payloads. It contains an unsigned transaction blob (that is usually needed to construct the a network transaction from a collection of signatures) and an array of payloads that must be signed by the caller.","required":["unsigned_transaction","payloads"],"properties":{"unsigned_transaction":{"type":"string","description":"This is an unsigned transaction blob (that is usually needed to construct the a network transaction from a collection of signatures)"},"payloads":{"type":"array","description":"An array of payloads that must be signed by the caller","items":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-signing-payload","type":"object","title":"SigningPayload","description":"SigningPayload is signed by the client with the keypair associated with an address using the specified SignatureType. SignatureType can be optionally populated if there is a restriction on the signature scheme that can be used to sign the payload.","required":["hex_bytes"],"properties":{"address":{"type":"string","description":"The network-specific address of the account that should sign the payload."},"account_identifier":{"type":"object","title":"RosettaAccount","description":"The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"sub_account":{"type":"object","title":"RosettaSubAccount","description":"An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"metadata":{"type":"object","description":"If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.","required":[]}}},"metadata":{"type":"object","description":"Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.","required":[]}}},"hex_bytes":{"type":"string"},"signature_type":{"type":"string","description":"SignatureType is the type of a cryptographic signature.","enum":["ecdsa","ecdsa_recovery","ed25519","schnorr_1","schnorr_poseidon"]}}}}}}