feat: remove BroadcastClient (#2408)

BREAKING CHANGE: `BroadcastClient` was removed. It was deprecated in 2.2
XRPLF · Jul 27, 2023 · 6bdcf62 · 6bdcf62
1 parent 12512d8
commit 6bdcf62
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 131 deletions.
diff --git a/packages/xrpl/src/client/BroadcastClient.ts b/packages/xrpl/src/client/BroadcastClient.ts
diff --git a/packages/xrpl/src/index.ts b/packages/xrpl/src/index.ts
@@ -1,6 +1,3 @@
-// Broadcast client is experimental
-export { BroadcastClient } from './client/BroadcastClient'
-
 export { Client, ClientOptions } from './client'
 
 export * from './models'

diff --git a/packages/xrpl/test/setupClient.ts b/packages/xrpl/test/setupClient.ts
@@ -1,6 +1,4 @@
 import { Client } from '../src/client'
-// eslint-disable-next-line import/no-deprecated -- Will remove in 3.0.0
-import { BroadcastClient } from '../src/client/BroadcastClient'
 
 import createMockRippled, {
   type MockedWebSocketServer,
@@ -9,8 +7,7 @@ import rippled from './fixtures/rippled'
 import { destroyServer, getFreePort } from './testUtils'
 
 export interface XrplTestContext {
-  // eslint-disable-next-line import/no-deprecated -- Will remove in 3.0.0
-  client: Client | BroadcastClient
+  client: Client
   _mockedServerPort?: number
   mockRippled?: MockedWebSocketServer
   mocks?: MockedWebSocketServer[]
@@ -38,32 +35,12 @@ async function setupMockRippledConnection(
   return context.client.connect().then(() => context)
 }
 
-async function setupMockRippledConnectionForBroadcast(
-  ports: number[],
-): Promise<XrplTestContext> {
-  const servers = ports.map((port) => `ws://localhost:${port}`)
-  const context: XrplTestContext = {
-    mocks: ports.map((port) => createMockRippled(port)),
-    // eslint-disable-next-line import/no-deprecated -- Will remove in 3.0.0
-    client: new BroadcastClient(servers),
-    servers: ports,
-  }
-
-  return context.client.connect().then(() => context)
-}
-
 async function setupClient(): Promise<XrplTestContext> {
   return getFreePort().then(async (port) => {
     return setupMockRippledConnection(port)
   })
 }
 
-async function setupBroadcast(): Promise<XrplTestContext> {
-  return Promise.all([getFreePort(), getFreePort()]).then(async (ports) => {
-    return setupMockRippledConnectionForBroadcast(ports)
-  })
-}
-
 async function teardownClient(
   incomingContext: XrplTestContext,
   done?: () => void,
@@ -98,4 +75,4 @@ async function teardownClient(
     })
 }
 
-export { setupClient, teardownClient, setupBroadcast, createMockRippled }
+export { setupClient, teardownClient, createMockRippled }
diff --git a/packages/xrpl/test/wallet/fundWallet.test.ts b/packages/xrpl/test/wallet/fundWallet.test.ts
@@ -1,6 +1,5 @@
 import { assert } from 'chai'
 
-import type { Client } from '../../src/client'
 import {
   FaucetNetwork,
   FaucetNetworkPaths,
@@ -26,43 +25,31 @@ describe('Get Faucet host ', function () {
     // @ts-expect-error Intentionally modifying private data for test
     testContext.client.connection.url = FaucetNetwork.Devnet
 
-    assert.strictEqual(
-      getFaucetHost(testContext.client as Client),
-      expectedFaucet,
-    )
+    assert.strictEqual(getFaucetHost(testContext.client), expectedFaucet)
   })
 
   it('returns the Testnet host', function () {
     const expectedFaucet = FaucetNetwork.Testnet
     // @ts-expect-error Intentionally modifying private data for test
     testContext.client.connection.url = FaucetNetwork.Testnet
 
-    assert.strictEqual(
-      getFaucetHost(testContext.client as Client),
-      expectedFaucet,
-    )
+    assert.strictEqual(getFaucetHost(testContext.client), expectedFaucet)
   })
 
   it('returns the Testnet host with the XRPL Labs server', function () {
     const expectedFaucet = FaucetNetwork.Testnet
     // @ts-expect-error Intentionally modifying private data for test
     testContext.client.connection.url = 'wss://testnet.xrpl-labs.com'
 
-    assert.strictEqual(
-      getFaucetHost(testContext.client as Client),
-      expectedFaucet,
-    )
+    assert.strictEqual(getFaucetHost(testContext.client), expectedFaucet)
   })
 
   it('returns the Hooks V3 Testnet host', function () {
     const expectedFaucet = FaucetNetwork.HooksV3Testnet
     // @ts-expect-error Intentionally modifying private data for test
     testContext.client.connection.url = FaucetNetwork.HooksV3Testnet
 
-    assert.strictEqual(
-      getFaucetHost(testContext.client as Client),
-      expectedFaucet,
-    )
+    assert.strictEqual(getFaucetHost(testContext.client), expectedFaucet)
   })
 
   it('returns the correct faucetPath for Devnet host', function () {
@@ -71,7 +58,7 @@ describe('Get Faucet host ', function () {
     testContext.client.connection.url = FaucetNetwork.Devnet
 
     assert.strictEqual(
-      getDefaultFaucetPath(getFaucetHost(testContext.client as Client)),
+      getDefaultFaucetPath(getFaucetHost(testContext.client)),
       expectedFaucetPath,
     )
   })
@@ -82,7 +69,7 @@ describe('Get Faucet host ', function () {
     testContext.client.connection.url = FaucetNetwork.HooksV3Testnet
 
     assert.strictEqual(
-      getDefaultFaucetPath(getFaucetHost(testContext.client as Client)),
+      getDefaultFaucetPath(getFaucetHost(testContext.client)),
       expectedFaucetPath,
     )
   })