@node-dlc/bitcoin/lib/Witness.ts

DLC bitcoin

import { BufferWriter, StreamReader } from '@node-dlc/bufio';

import { ICloneable } from './ICloneable';

/**
 * Represents segregated witness data. This data is nothing more than a
 * buffer.
 */
export class Witness implements ICloneable<Witness> {
  /**
   * Parses witness data
   * @param reader
   */
  public static parse(reader: StreamReader): Witness {
    const len = reader.readVarInt();
    const data = reader.readBytes(Number(len));
    return new Witness(data);
  }

  /**
   * Hex-encoded Witness data. This method interally creates a
   * StreamReader and uses the parse function
   * @param hex encoded as a string
   */
  public static fromHex(hex: string): Witness {
    return Witness.parse(StreamReader.fromHex(hex));
  }

  constructor(readonly data: Buffer) {}

  /**
   * Serializes witness data into a buffer in the format:
   *
   * [varint] length
   * [length] data
   */
  public serialize(): Buffer {
    const writer = new BufferWriter();
    writer.writeVarInt(this.data.length);
    writer.writeBytes(this.data);
    return writer.toBuffer();
  }

  /**
   * Returns the string of a piece of witness data
   */
  public toString(): string {
    return this.data.toString('hex');
  }

  /**
   * Returns the string of a piece of witness data
   */
  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
  public toJSON() {
    return this.toString();
  }

  /**
   * Clone via deep copy
   */
  public clone(): Witness {
    return new Witness(Buffer.from(this.data));
  }
}