Variable gcsConst

Type Declaration

• buildFilter: function

  • buildFilter(
        p: number,
        m: number,
        key: Bytes,
        dataItems: Bytes[],
    ): Promise<GcsFilterResult>

    Build a GCS filter from data items. Calls Go: gcs.BuildGCSFilter() from btcutil/gcs.

    Parameters

    • p: number

      Filter parameter P (false positive rate = 1/2^P).

    • m: number

      Filter parameter M.

    • key: Bytes

      16-byte SipHash key (hex, 32 chars).

    • dataItems: Bytes[]

      Array of data items (hex strings).

    Returns Promise<GcsFilterResult>

• match: function

  • match(
        filter: Bytes,
        n: number,
        p: number,
        m: number,
        key: Bytes,
        target: Bytes,
    ): Promise<boolean>

    Test if a single element matches the filter. Calls Go: gcs.Filter.Match() from btcutil/gcs (via gcs.FromBytes()).

    Parameters

    • filter: Bytes
    • n: number
    • p: number
    • m: number
    • key: Bytes
    • target: Bytes

    Returns Promise<boolean>

• matchAny: function

  • matchAny(
        filter: Bytes,
        n: number,
        p: number,
        m: number,
        key: Bytes,
        targets: Bytes[],
    ): Promise<boolean>

    Test if any of the target elements match the filter. Calls Go: gcs.Filter.MatchAny() from btcutil/gcs (via gcs.FromBytes()).

    Parameters

    • filter: Bytes
    • n: number
    • p: number
    • m: number
    • key: Bytes
    • targets: Bytes[]

    Returns Promise<boolean>