ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-21 20:25:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad995c7a4270b853ee3c0a77ac595c837a89b052
xrpl-dev-portal/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md
mDuo13 7645140477 Re-levelization: move non-docs content, rename content→docs 
For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.
2024-01-31 17:53:52 -08:00

2.2 KiB
Raw Blame History

html, parent, seo, labels
html parent seo labels
server_definitions.html server-info-methods.html
description
Retrieve an SDK-compatible `definitions.json`, generated from the `rippled` instance currently running.
Core Server

server_definitions

[Source]

The server_definitions command returns an SDK-compatible definitions.json, generated from the rippled instance currently running. You can use this to query a node in a network, quickly receiving the definitions necessary to serialize/deserialize its binary data.

Request Format

An example of the request format:

{% tabs %}

{% tab label="WebSocket" %}

{
  "id": 2,
  "command": "server_definitions"
}

{% /tab %}

{% /tabs %}

Try it! >

The request does not take any parameters.

Response Format

An example of a successful response:

{% tabs %}

{% tab label="WebSocket" %}

{
  "id": 1,
  "result": {
    "FIELDS": [
      [
        "Generic",
        {
          "isSerialized": false,
          "isSigningField": false,
          "isVLEncoded": false,
          "nth": 0,
          "type": "Unknown"
        }
      ],
      [
        "Invalid",
        {
          "isSerialized": false,
          "isSigningField": false,
          "isVLEncoded": false,
          "nth": -1,
          "type": "Unknown"
        }
      ],
      [
        "ObjectEndMarker",
        {
          "isSerialized": true,
          "isSigningField": true,
          "isVLEncoded": false,
          "nth": 1,
          "type": "STObject"
        }
      ],
      [
        "ArrayEndMarker",
        {
          "isSerialized": true,
          "isSigningField": true,
          "isVLEncoded": false,
          "nth": 1,
          "type": "STArray"
        }
      ]
      ...
    ]
  }
}

{% /tab %}

{% /tabs %}

To see a full definitions.json file and descriptions of the top-level fields, see: Definitions File.

Possible Errors

Any of the [universal error types][].

{% raw-partial file="/docs/_snippets/common-links.md" /%}