openrpc.json

{
  "info" : {
    "title" : "JAM JSONRPC (draft)",
    "description" : "JSONRPC spec for JAM nodes (draft)",
    "version" : "0.0.1"
  },
  "methods" : [
    {
      "result" : {
        "required" : false,
        "name" : "Data",
        "schema" : {
          "title" : "Data",
          "type" : "string",
          "pattern" : "^0x[0-9a-fA-F]*$"
        }
      },
      "name" : "chain_getBlock",
      "params" : [
        {
          "name" : "hash",
          "schema" : {
            "type" : "string",
            "pattern" : "^0x[0-9a-fA-F]{64}$",
            "title" : "Data32"
          },
          "required" : false
        }
      ],
      "summary" : "Get block by hash. If hash is not provided, returns the best block."
    },
    {
      "params" : [
        {
          "required" : false,
          "name" : "timeslot",
          "schema" : {
            "type" : "integer"
          }
        }
      ],
      "summary" : "Get the block hash by timeslot. If timeslot is not provided, returns the best block hash.",
      "result" : {
        "name" : "Data",
        "schema" : {
          "type" : "string",
          "title" : "Data",
          "pattern" : "^0x[0-9a-fA-F]*$"
        },
        "required" : false
      },
      "name" : "chain_getBlockHash"
    },
    {
      "summary" : "Get hash of the last finalized block in the canon chain.",
      "result" : {
        "required" : false,
        "schema" : {
          "pattern" : "^0x[0-9a-fA-F]{64}$",
          "title" : "Data32",
          "type" : "string"
        },
        "name" : "Data32"
      },
      "name" : "chain_getFinalizedHead",
      "params" : [

      ]
    },
    {
      "name" : "chain_getHeader",
      "summary" : "Get block header by hash. If hash is not provided, returns the best block header.",
      "result" : {
        "schema" : {
          "pattern" : "^0x[0-9a-fA-F]*$",
          "title" : "Data",
          "type" : "string"
        },
        "name" : "Data",
        "required" : false
      },
      "params" : [
        {
          "schema" : {
            "pattern" : "^0x[0-9a-fA-F]{64}$",
            "title" : "Data32",
            "type" : "string"
          },
          "required" : false,
          "name" : "hash"
        }
      ]
    },
    {
      "name" : "system_health",
      "result" : {
        "name" : "Bool",
        "schema" : {
          "type" : "boolean"
        },
        "required" : true
      },
      "params" : [

      ],
      "summary" : "Returns true if the node is healthy."
    },
    {
      "result" : {
        "name" : "String",
        "required" : true,
        "schema" : {
          "type" : "string"
        }
      },
      "name" : "system_implementation",
      "summary" : "Returns the implementation name of the node.",
      "params" : [

      ]
    },
    {
      "name" : "system_version",
      "result" : {
        "required" : true,
        "name" : "String",
        "schema" : {
          "type" : "string"
        }
      },
      "summary" : "Returns the version of the node.",
      "params" : [

      ]
    },
    {
      "result" : {
        "schema" : {
          "type" : "object",
          "title" : "JSON"
        },
        "required" : true,
        "name" : "JSON"
      },
      "summary" : "Get a custom set of properties as a JSON object, defined in the chain spec.",
      "params" : [

      ],
      "name" : "system_properties"
    },
    {
      "params" : [

      ],
      "name" : "system_nodeRoles",
      "summary" : "Returns the roles the node is running as.",
      "result" : {
        "required" : true,
        "schema" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "name" : "Array<String>"
      }
    },
    {
      "summary" : "Returns the chain name, defined in the chain spec.",
      "params" : [

      ],
      "result" : {
        "schema" : {
          "type" : "string"
        },
        "name" : "String",
        "required" : true
      },
      "name" : "system_chain"
    },
    {
      "params" : [
        {
          "schema" : {
            "type" : "string",
            "title" : "Data32",
            "pattern" : "^0x[0-9a-fA-F]{64}$"
          },
          "name" : "prefix",
          "required" : true
        },
        {
          "name" : "count",
          "required" : true,
          "schema" : {
            "type" : "integer"
          }
        },
        {
          "name" : "startKey",
          "schema" : {
            "type" : "string",
            "title" : "Data32",
            "pattern" : "^0x[0-9a-fA-F]{64}$"
          },
          "required" : false
        },
        {
          "schema" : {
            "pattern" : "^0x[0-9a-fA-F]{64}$",
            "title" : "Data32",
            "type" : "string"
          },
          "name" : "blockHash",
          "required" : false
        }
      ],
      "summary" : "Returns the keys of the state.",
      "name" : "state_getKeys",
      "result" : {
        "schema" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "name" : "Array<String>",
        "required" : true
      }
    },
    {
      "result" : {
        "required" : true,
        "name" : "Array<String>",
        "schema" : {
          "items" : {
            "type" : "string"
          },
          "type" : "array"
        }
      },
      "params" : [
        {
          "schema" : {
            "type" : "string",
            "title" : "Data32",
            "pattern" : "^0x[0-9a-fA-F]{64}$"
          },
          "required" : true,
          "name" : "key"
        },
        {
          "schema" : {
            "type" : "string",
            "pattern" : "^0x[0-9a-fA-F]{64}$",
            "title" : "Data32"
          },
          "name" : "blockHash",
          "required" : false
        }
      ],
      "name" : "state_getStorage",
      "summary" : "Returns the storage entry for a key for blockHash or best head."
    },
    {
      "name" : "telemetry_name",
      "result" : {
        "schema" : {
          "type" : "string"
        },
        "name" : "String",
        "required" : true
      },
      "summary" : "Returns the name of the node.",
      "params" : [

      ]
    },
    {
      "result" : {
        "required" : true,
        "schema" : {
          "type" : "integer"
        },
        "name" : "Int"
      },
      "params" : [

      ],
      "name" : "telemetry_peersCount",
      "summary" : "Returns the number of connected peers."
    },
    {
      "summary" : "Returns the Ed25519 key for p2p networks.",
      "params" : [

      ],
      "name" : "telemetry_networkKey",
      "result" : {
        "schema" : {
          "type" : "string"
        },
        "name" : "String",
        "required" : true
      }
    },
    {
      "name" : "rpc_methods",
      "summary" : "Returns a list of available RPC methods.",
      "params" : [

      ],
      "result" : {
        "name" : "Array<String>",
        "schema" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "required" : true
      }
    }
  ],
  "openrpc" : "1.0.0"
}