Update 2020-10-05T22:45:16.550Z

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

@@ -0,0 +1,9 @@
+{
+  "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
+}

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"],"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"}}}

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

@@ -1,11 +0,0 @@
-{
-  "error": "transaction rejected",
-  "reason": "BadNonce",
-  "reason_data": {
-    "actual": 3,
-    "expected": 0,
-    "is_origin": true,
-    "principal": "ST2MVNFYF6H9DCMAV3HVNHTJVVE3CFWT1JYMH1EZB"
-  },
-  "txid": "0x4068179cb9169b969c80518d83890f8b808a70ab998dd227149221be9480a616"
-}

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

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

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

@@ -1 +0,0 @@
-{"$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/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":"Netowork 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":["address"],"properties":{"address":{"type":"string","description":"Address in network-specific format."},"metadata":{"type":"object"}}}

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

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-preprocess-response","type":"object","title":"RosettaConstructionPreprocessResponse","description":"RosettaConstructionPreprocessResponse contains options that will be sent unmodified to /construction/metadata. If it is not necessary to make a request to /construction/metadata, options should be omitted. Some blockchains require the PublicKey of particular AccountIdentifiers to construct a valid transaction. To fetch these PublicKeys, populate required_public_keys with the AccountIdentifiers associated with the desired PublicKeys. If it is not necessary to retrieve any PublicKeys for construction, required_public_keys should be omitted.","required":[],"properties":{"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":"Recipients's address"},"amount":{"type":"string","description":"Amount to be transfeered."},"symbol":{"type":"string","description":"Currcny 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"}}},"required_public_keys":{"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":[]}}}}}