XRPL.Clio (xrpl v1.0.0)
Use these methods to retrieve information using Clio server APIs.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/clio-server/
Summary
Functions
Builds a changeset from the schema and params.
The ledger command retrieves information about the public ledger.
The nft_history command asks the Clio server for past transaction metadata for the NFT being queried. New in: Clio v1.1.0
The nft_info command asks the Clio server for information about the NFT being queried.
The server_info command asks the Clio server for a human-readable version of various information about the Clio server being queried. For rippled servers, see server_info (rippled) instead.
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.
ledger(params)
The ledger command retrieves information about the public ledger.
Note that the Clio server returns validated ledger data by default.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio/#ledger
ledger!(params)
nft_history(params)
The nft_history command asks the Clio server for past transaction metadata for the NFT being queried. New in: Clio v1.1.0
Note nft_history returns only successful transactions associated with the NFT.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history/
nft_history!(params)
nft_info(params)
The nft_info command asks the Clio server for information about the NFT being queried.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info/
nft_info!(params)
schema(binary)
server_info()
The server_info command asks the Clio server for a human-readable version of various information about the Clio server being queried. For rippled servers, see server_info (rippled) instead.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio/#server_info
server_info!()
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
.