XRPL.ServerInfo (xrpl v1.0.0)
XRPL.ServerInfo is a module to interact with server_info modules on the XRP Ledger.
Use these methods to retrieve information about the current state of the rippled server.
Official documentation: https://xrpl.org/server-info-methods.html
Summary
Functions
Builds a changeset from the schema and params.
The fee command reports the current state of the open-ledger requirements for the transaction cost. This requires the FeeEscalation amendment to be enabled.
The manifest method reports the current "manifest" information for a given validator public key. The "manifest" is a block of data that authorizes an ephemeral signing key with a signature from the validator's master key pair.
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.
The server_info command asks the server for a human-readable version of various information about the rippled server being queried. For Clio servers, see server_info (Clio) instead.
The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)
Returns the validated parameters or an error changeset.
Returns the validated parameters or an error changeset.
Expects a schema to be defined with defparams.
Functions
changeset(name, params \\ %{}, opts \\ [])
Builds a changeset from the schema and params.
fee()
The fee command reports the current state of the open-ledger requirements for the transaction cost. This requires the FeeEscalation amendment to be enabled.
This is a public command available to unprivileged users.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee/
fee!()
manifest(params)
The manifest method reports the current "manifest" information for a given validator public key. The "manifest" is a block of data that authorizes an ephemeral signing key with a signature from the validator's master key pair.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest/
manifest!(params)
schema(binary)
server_definitions()
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.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server-definitions/
server_definitions!()
server_info()
The server_info command asks the server for a human-readable version of various information about the rippled server being queried. For Clio servers, see server_info (Clio) instead.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server-info/
server_info!()
server_state(params)
The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)
The Clio server does not support server_state directly, but you can ask for the server_state of the rippled server that Clio is connected to. Specify "ledger_index": "current" (WebSocket) or "params": [{"ledger_index": "current"}] (JSON-RPC).
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state/
server_state!(params)
validate(changeset)
@spec validate(changeset()) :: {:ok, params()} | {:error, changeset()}
Returns the validated parameters or an error changeset.
validate(name, params \\ %{}, opts \\ [])
@spec validate(name(), params(), opts()) :: {:ok, params()} | {:error, changeset()}
Returns the validated parameters or an error changeset.
Expects a schema to be defined with defparams.