Options

Get Network Options

This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.

POST/network/options

Body

application/json

network_identifier*NetworkIdentifier (object)

The network_identifier specifies which network a particular object is associated with.

metadataobject

Response

200500

Expected response to a valid request

Body

application/json

version*Version (object)

The Version object is utilized to inform the client of the versions of different components of the Rosetta implementation.

allow*Allow (object)

Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here.

Request

JavaScriptCurlPython

const response = await fetch('/network/options', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "network_identifier": {
        "blockchain": "bitcoin",
        "network": "mainnet"
      }
    }),
});
const data = await response.json();

Response

200500

{
  "version": {
    "rosetta_version": "1.2.5",
    "node_version": "1.0.2",
    "middleware_version": "0.2.7"
  },
  "allow": {
    "operation_statuses": [
      {
        "status": "SUCCESS",
        "successful": true
      }
    ],
    "operation_types": [
      "TRANSFER"
    ],
    "errors": [
      {
        "code": 12,
        "message": "Invalid account format",
        "description": "This error is returned when the requested AccountIdentifier is improperly formatted.",
        "retriable": false,
        "details": {
          "address": "0x1dcc4de8dec75d7aab85b567b6",
          "error": "not base64"
        }
      }
    ],
    "historical_balance_lookup": false,
    "timestamp_start_index": 0,
    "call_methods": [
      "eth_call"
    ],
    "balance_exemptions": [
      {
        "sub_account_address": "staking",
        "currency": {
          "symbol": "BTC",
          "decimals": 8,
          "metadata": {
            "Issuer": "Satoshi"
          }
        },
        "exemption_type": "greater_or_equal"
      }
    ],
    "mempool_coins": false,
    "block_hash_case": "upper_case",
    "transaction_hash_case": "upper_case"
  }
}