@lodestar/reqresp 1.35.0-dev.fcf8d024ea → 1.35.0-dev.feed916580

package/src/utils/bufferedSource.ts

@@ -1,46 +0,0 @@
-import {Uint8ArrayList} from "uint8arraylist";
-
-/**
- * Wraps a buffer chunk stream source with another async iterable
- * so it can be reused in multiple for..of statements.
- *
- * Uses a BufferList internally to make sure all chunks are consumed
- * when switching consumers
- */
-export class BufferedSource {
-  isDone = false;
-  private buffer: Uint8ArrayList;
-  private source: AsyncGenerator<Uint8ArrayList | Uint8Array>;
-
-  constructor(source: AsyncGenerator<Uint8ArrayList | Uint8Array>) {
-    this.buffer = new Uint8ArrayList();
-    this.source = source;
-  }
-
-  [Symbol.asyncIterator](): AsyncIterator<Uint8ArrayList> {
-    const that = this;
-
-    let firstNext = true;
-
-    return {
-      async next() {
-        // Prevent fetching a new chunk if there are pending bytes
-        // not processed by a previous consumer of this BufferedSource
-        if (firstNext && that.buffer.length > 0) {
-          firstNext = false;
-          return {done: false, value: that.buffer};
-        }
-
-        const {done, value: chunk} = await that.source.next();
-        if (done === true) {
-          that.isDone = true;
-          return {done: true, value: undefined};
-        }
-
-        // Concat new chunk and return a reference to its BufferList instance
-        that.buffer.append(chunk);
-        return {done: false, value: that.buffer};
-      },
-    };
-  }
-}

package/src/utils/collectExactOne.ts

@@ -1,15 +0,0 @@
-import {RequestError, RequestErrorCode} from "../request/errors.js";
-
-/**
- * Sink for `<response_chunk>*`, from
- * ```bnf
- * response ::= <response_chunk>*
- * ```
- * Expects exactly one response
- */
-export async function collectExactOne<T>(source: AsyncIterable<T>): Promise<T> {
-  for await (const response of source) {
-    return response;
-  }
-  throw new RequestError({code: RequestErrorCode.EMPTY_RESPONSE});
-}

package/src/utils/collectMaxResponse.ts

@@ -1,19 +0,0 @@
-/**
- * Sink for `<response_chunk>*`, from
- * ```bnf
- * response ::= <response_chunk>*
- * ```
- * Collects a bounded list of responses up to `maxResponses`
- */
-export async function collectMaxResponse<T>(source: AsyncIterable<T>, maxResponses: number): Promise<T[]> {
-  // else: zero or more responses
-  const responses: T[] = [];
-  for await (const response of source) {
-    responses.push(response);
-
-    if (maxResponses !== undefined && responses.length >= maxResponses) {
-      break;
-    }
-  }
-  return responses;
-}

package/src/utils/errorMessage.ts

@@ -1,51 +0,0 @@
-import {decode as varintDecode, encodingLength as varintEncodingLength} from "uint8-varint";
-import {Uint8ArrayList} from "uint8arraylist";
-import {writeSszSnappyPayload} from "../encodingStrategies/sszSnappy/encode.js";
-import {SnappyFramesUncompress} from "../encodingStrategies/sszSnappy/snappyFrames/uncompress.js";
-import {Encoding} from "../types.js";
-
-// ErrorMessage schema:
-//
-// (
-//   error_message: List[byte, 256]
-// )
-//
-// By convention, the error_message is a sequence of bytes that MAY be interpreted as a
-// UTF-8 string (for debugging purposes). Clients MUST treat as valid any byte sequences
-//
-// Spec v1.1.10 https://github.com/ethereum/consensus-specs/blob/v1.1.10/specs/phase0/p2p-interface.md#responding-side
-
-/**
- * Encodes a UTF-8 string to 256 bytes max
- */
-export async function* encodeErrorMessage(errorMessage: string, encoding: Encoding): AsyncGenerator<Buffer> {
-  const encoder = new TextEncoder();
-  const bytes = encoder.encode(errorMessage).slice(0, 256);
-
-  switch (encoding) {
-    case Encoding.SSZ_SNAPPY:
-      yield* writeSszSnappyPayload(bytes);
-  }
-}
-
-/**
- * Decodes error message from network bytes and removes non printable, non ascii characters.
- */
-export async function decodeErrorMessage(encodedErrorMessage: Uint8Array): Promise<string> {
-  const encoder = new TextDecoder();
-  let sszDataLength: number;
-  try {
-    sszDataLength = varintDecode(encodedErrorMessage);
-    const decompressor = new SnappyFramesUncompress();
-    const varintBytes = varintEncodingLength(sszDataLength);
-    const errorMessage = decompressor.uncompress(new Uint8ArrayList(encodedErrorMessage.subarray(varintBytes)));
-    if (errorMessage == null || errorMessage.length !== sszDataLength) {
-      throw new Error("Malformed input: data length mismatch");
-    }
-    // remove non ascii characters from string
-    return encoder.decode(errorMessage.subarray(0)).replace(/[^\x20-\x7F]/g, "");
-  } catch (_e) {
-    // remove non ascii characters from string
-    return encoder.decode(encodedErrorMessage.slice(0, 256)).replace(/[^\x20-\x7F]/g, "");
-  }
-}

package/src/utils/index.ts

@@ -1,8 +0,0 @@
-export * from "./abortableSource.js";
-export * from "./bufferedSource.js";
-export * from "./collectExactOne.js";
-export * from "./collectMaxResponse.js";
-export * from "./errorMessage.js";
-export * from "./onChunk.js";
-export * from "./peerId.js";
-export * from "./protocolId.js";

package/src/utils/onChunk.ts

@@ -1,12 +0,0 @@
-/**
- * Calls `callback` with each `chunk` received from the `source` AsyncIterable
- * Useful for logging, or cancelling timeouts
- */
-export function onChunk<T>(callback: (chunk: T) => void): (source: AsyncIterable<T>) => AsyncIterable<T> {
-  return async function* onChunkTransform(source) {
-    for await (const chunk of source) {
-      callback(chunk);
-      yield chunk;
-    }
-  };
-}

package/src/utils/peerId.ts

@@ -1,6 +0,0 @@
-import {PeerId} from "@libp2p/interface";
-
-export function prettyPrintPeerId(peerId: PeerId): string {
-  const id = peerId.toString();
-  return `${id.substr(0, 2)}...${id.substr(id.length - 6, id.length)}`;
-}

package/src/utils/protocolId.ts

@@ -1,44 +0,0 @@
-import {Encoding, ProtocolAttributes} from "../types.js";
-
-/**
- * https://github.com/ethereum/consensus-specs/blob/v1.2.0/specs/phase0/p2p-interface.md#protocol-identification
- */
-export function formatProtocolID(protocolPrefix: string, method: string, version: number, encoding: Encoding): string {
-  return `${protocolPrefix}/${method}/${version}/${encoding}`;
-}
-
-/**
- * https://github.com/ethereum/consensus-specs/blob/v1.2.0/specs/phase0/p2p-interface.md#protocol-identification
- */
-export function parseProtocolID(protocolId: string): ProtocolAttributes {
-  const result = protocolId.split("/");
-  if (result.length < 4) {
-    throw new Error(`Invalid protocol id: ${protocolId}`);
-  }
-
-  const encoding = result.at(-1) as Encoding;
-  if (!Object.values(Encoding).includes(encoding)) {
-    throw new Error(`Invalid protocol encoding: ${encoding}`);
-  }
-
-  const versionStr = result.at(-2) as string;
-  if (!/^-?[0-9]+$/.test(versionStr)) {
-    throw new Error(`Invalid protocol version: ${versionStr}`);
-  }
-
-  // an ordinal version number (e.g. 1, 2, 3…).
-  const version = parseInt(versionStr);
-
-  // each request is identified by a name consisting of English alphabet, digits and underscores (_).
-  const method = result.at(-3) as string;
-
-  // messages are grouped into families identified by a shared libp2p protocol name prefix
-  const protocolPrefix = result.slice(0, result.length - 3).join("/");
-
-  return {
-    protocolPrefix,
-    method,
-    version,
-    encoding,
-  };
-}