diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md index 5d932c10..e242edaa 100644 --- a/packages/xrpl/HISTORY.md +++ b/packages/xrpl/HISTORY.md @@ -5,6 +5,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr ## Unreleased ### Added * Export deriveAddress from ripple-keypairs in xrpl.js +* Deprecated BroadcastClient as it does not solve the reliabile connection problem. ### Fixed * Add missing filter types in AccountObjectType diff --git a/packages/xrpl/src/client/BroadcastClient.ts b/packages/xrpl/src/client/BroadcastClient.ts index d7e1a60f..87970569 100644 --- a/packages/xrpl/src/client/BroadcastClient.ts +++ b/packages/xrpl/src/client/BroadcastClient.ts @@ -3,6 +3,16 @@ import { Client, ClientOptions } from '.' /** * Client that can rely on multiple different servers. * + * @deprecated since version 2.2.0. + * Will be deleted in version 3.0.0. + * + * Currently this implementation does not provide better reliability. + * To get better reliability, implement reconnect/error handling logic + * and choose a reliable endpoint. + * + * If you need the ability to fall-back to different endpoints, consider + * using [xrpl-client](https://github.com/XRPL-Labs/xrpl-client/) + * * @category Clients */ export default class BroadcastClient extends Client {