xrpl 2.14.0 → 3.0.0-beta.1

package/dist/npm/sugar/getLedgerIndex.js

@@ -1,22 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-function getLedgerIndex() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const ledgerResponse = yield this.request({
-            command: 'ledger',
-            ledger_index: 'validated',
-        });
-        return ledgerResponse.result.ledger_index;
-    });
-}
-exports.default = getLedgerIndex;
-//# sourceMappingURL=getLedgerIndex.js.map

package/dist/npm/sugar/getLedgerIndex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getLedgerIndex.js","sourceRoot":"","sources":["../../../src/sugar/getLedgerIndex.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,SAA8B,cAAc;;QAC1C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YACxC,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,WAAW;SAC1B,CAAC,CAAA;QACF,OAAO,cAAc,CAAC,MAAM,CAAC,YAAY,CAAA;IAC3C,CAAC;CAAA;AAND,iCAMC"}

package/src/client/BroadcastClient.ts

@@ -1,84 +0,0 @@
-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 class BroadcastClient extends Client {
-  private readonly clients: Client[]
-
-  /**
-   * Creates a new BroadcastClient.
-   *
-   * @category Constructor
-   * @param servers - An array of names of servers.
-   * @param options - Options for the clients.
-   */
-  public constructor(servers: string[], options: ClientOptions = {}) {
-    super(servers[0], options)
-
-    const clients: Client[] = servers.map(
-      (server) => new Client(server, options),
-    )
-
-    this.clients = clients
-    this.getMethodNames().forEach((name: string) => {
-      this[name] = async (...args): Promise<unknown> =>
-        /* eslint-disable @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call -- Generates types
-          from the Client */
-        Promise.race(clients.map(async (client) => client[name](...args)))
-      /* eslint-enable @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call */
-    })
-
-    // connection methods must be overridden to apply to all client instances
-    this.connect = async (): Promise<void> => {
-      await Promise.all(clients.map(async (client) => client.connect()))
-    }
-    this.disconnect = async (): Promise<void> => {
-      await Promise.all(clients.map(async (client) => client.disconnect()))
-    }
-    this.isConnected = (): boolean =>
-      clients.map((client) => client.isConnected()).every(Boolean)
-
-    clients.forEach((client) => {
-      client.on('error', (errorCode, errorMessage, data) =>
-        this.emit('error', errorCode, errorMessage, data),
-      )
-    })
-  }
-
-  /**
-   * Gets the method names of all the methods of the client.
-   *
-   * @returns A list of the names of all the methods of the client.
-   */
-  private getMethodNames(): string[] {
-    const methodNames: string[] = []
-    const firstClient = this.clients[0]
-    const methods = Object.getOwnPropertyNames(firstClient)
-    methods.push(
-      ...Object.getOwnPropertyNames(Object.getPrototypeOf(firstClient)),
-    )
-    for (const name of methods) {
-      if (
-        typeof firstClient[name] === 'function' &&
-        name !== 'constructor' &&
-        name !== 'on'
-      ) {
-        methodNames.push(name)
-      }
-    }
-    return methodNames
-  }
-}

package/src/client/WSWrapper.ts

@@ -1,106 +0,0 @@
-/* eslint-disable max-classes-per-file -- Needs to be a wrapper for ws */
-import { EventEmitter } from 'events'
-
-// Define the global WebSocket class found on the native browser
-declare class WebSocket {
-  public onclose?: (closeEvent: CloseEvent) => void
-  public onopen?: (openEvent: Event) => void
-  public onerror?: (error: Error) => void
-  public onmessage?: (message: MessageEvent) => void
-  public readyState: number
-  public constructor(url: string)
-  public close(code?: number, reason?: Buffer): void
-  public send(message: string): void
-}
-
-interface WSWrapperOptions {
-  perMessageDeflate: boolean
-  handshakeTimeout: number
-  protocolVersion: number
-  origin: string
-  maxPayload: number
-  followRedirects: boolean
-  maxRedirects: number
-}
-
-/**
- * Provides `EventEmitter` interface for native browser `WebSocket`,
- * same, as `ws` package provides.
- */
-export default class WSWrapper extends EventEmitter {
-  public static CONNECTING = 0
-  public static OPEN = 1
-  public static CLOSING = 2
-  // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- magic number is being defined here
-  public static CLOSED = 3
-  private readonly ws: WebSocket
-
-  /**
-   * Constructs a browser-safe websocket.
-   *
-   * @param url - URL to connect to.
-   * @param _protocols - Not used.
-   * @param _websocketOptions - Not used.
-   */
-  public constructor(
-    url: string,
-    _protocols: string | string[] | WSWrapperOptions | undefined,
-    _websocketOptions: WSWrapperOptions,
-  ) {
-    super()
-    this.setMaxListeners(Infinity)
-
-    this.ws = new WebSocket(url)
-
-    this.ws.onclose = (closeEvent: CloseEvent): void => {
-      let reason: Uint8Array | undefined
-      if (closeEvent.reason) {
-        const enc = new TextEncoder()
-        reason = enc.encode(closeEvent.reason)
-      }
-      this.emit('close', closeEvent.code, reason)
-    }
-
-    this.ws.onopen = (): void => {
-      this.emit('open')
-    }
-
-    this.ws.onerror = (error): void => {
-      this.emit('error', error)
-    }
-
-    this.ws.onmessage = (message: MessageEvent): void => {
-      this.emit('message', message.data)
-    }
-  }
-
-  /**
-   * Get the ready state of the websocket.
-   *
-   * @returns The Websocket's ready state.
-   */
-  public get readyState(): number {
-    return this.ws.readyState
-  }
-
-  /**
-   * Closes the websocket.
-   *
-   * @param code - Close code.
-   * @param reason - Close reason.
-   */
-  public close(code?: number, reason?: Buffer): void {
-    if (this.readyState === 1) {
-      this.ws.close(code, reason)
-    }
-  }
-
-  /**
-   * Sends a message over the Websocket connection.
-   *
-   * @param message - Message to send.
-   */
-  public send(message: string): void {
-    this.ws.send(message)
-  }
-}

package/src/sugar/getLedgerIndex.ts

@@ -1,15 +0,0 @@
-import type { Client } from '..'
-
-/**
- * Returns the index of the most recently validated ledger.
- *
- * @param this - The Client used to connect to the ledger.
- * @returns The most recently validated ledger index.
- */
-export default async function getLedgerIndex(this: Client): Promise<number> {
-  const ledgerResponse = await this.request({
-    command: 'ledger',
-    ledger_index: 'validated',
-  })
-  return ledgerResponse.result.ledger_index
-}