Update client `on` docs for `server` streams being able to receive `serverStatus` type events

XRPLF / xrpl.js

A JavaScript/TypeScript API for interacting with the XRP Ledger in Node.js and the browser

https://xrpl.org/

1.21k stars 512 forks source link

Closed justinr1234 closed 7 months ago

justinr1234 commented 8 months ago

For https://xrpl.org/subscribe.html you can subscribe to server events

server - Sends a message whenever the status of the rippled server (for example, network connectivity) changes.

This allows clients to use client.on to receive serverStatus type events, but we lack documentation here: https://js.xrpl.org/classes/Client.html#on

mvadari commented 8 months ago

Does this type still exist? It was removed from the Explorer, I'm not sure if it's an admin-only subscribe command.

intelliot commented 8 months ago

This appears to be an admin stream, so generally, only the node operator (or other admins) can access it.

It's still nice to have documented, especially if it might be useful to node operators.

Internal tracker: DGE-46

mvadari commented 8 months ago

We don't support any other admin RPCs, so I'm somewhat hesitant to just support that one.

JST5000 commented 7 months ago

Closing this since we don't currently support admin RPCs with the client libraries.