Class QueryBoundWitnessWrapper<T>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

boundwitness moduleErrors? payload payloads

Accessors

addresses payloadHashes payloadSchemas previousHashes

Methods

dataHash dig getErrors getMissingPayloads getPayloadsWithoutQuery getQuery getValid getWrappedPayloads hashesBySchema payloadsByDataHashes payloadsByHashes payloadsBySchema payloadsDataHashMap payloadsHashMap prev schema toResult validate as load parse parseQuery tryParse tryParseQuery unwrap unwrapSinglePayload wrap wrappedDataHashMap

Constructors

Protectedconstructor

  • new QueryBoundWitnessWrapper<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            > = DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
    >(
        boundwitness: UnsignedQueryBoundWitness,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
        moduleErrors?: DeepRestrictToStringKeys<{ schema: string }>[],
    ): QueryBoundWitnessWrapper<T>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      > = DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >

    Parameters

    Returns QueryBoundWitnessWrapper<T>

Properties

boundwitness

boundwitness: UnsignedQueryBoundWitness

OptionalmoduleErrors

moduleErrors?: DeepRestrictToStringKeys<{ schema: string }>[]

payload

payload: UnsignedQueryBoundWitness

payloads

payloads: DeepRestrictToStringKeys<{ schema: string }>[]

Accessors

addresses

  • get addresses(): Lowercase<string>[]

  • Returns Lowercase<string>[]

payloadHashes

  • get payloadHashes(): Lowercase<string>[]

  • Returns Lowercase<string>[]

payloadSchemas

  • get payloadSchemas(): string[]

  • Returns string[]

previousHashes

  • get previousHashes(): DeepRestrictToStringKeys<null | Lowercase<string>>[]

  • Returns DeepRestrictToStringKeys<null | Lowercase<string>>[]

Methods

dataHash

  • dataHash(): Promise<Lowercase<string>>

  • Returns Promise<Lowercase<string>>

dig

getErrors

  • getErrors(): Promise<Error[]>

  • Returns Promise<Error[]>

getMissingPayloads

  • getMissingPayloads(): Promise<Lowercase<string>[]>

  • Returns Promise<Lowercase<string>[]>

getPayloadsWithoutQuery

  • getPayloadsWithoutQuery(): Promise<PayloadWrapper[]>

  • Returns Promise<PayloadWrapper[]>

getQuery

  • getQuery(): Promise<T>

  • Returns Promise<T>

getValid

  • getValid(): Promise<boolean>

  • Returns Promise<boolean>

getWrappedPayloads

hashesBySchema

  • hashesBySchema(schema: string): string[]

  • Parameters

    • schema: string

    Returns string[]

payloadsByDataHashes

payloadsByHashes

payloadsBySchema

payloadsDataHashMap

payloadsHashMap

prev

schema

  • schema(): string

  • Returns string

toResult

validate

  • validate(): Promise<Error[]>

  • Returns Promise<Error[]>

Staticas

Staticload

Staticparse

StaticparseQuery

  • parseQuery<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            > = DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
    >(
        obj: unknown,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    ): QueryBoundWitnessWrapper<T>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      > = DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >

    Parameters

    Returns QueryBoundWitnessWrapper<T>

StatictryParse

StatictryParseQuery

  • tryParseQuery<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            >,
    >(
        obj: unknown,
    ): Promisable<undefined | QueryBoundWitnessWrapper<T>>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >

    Parameters

    • obj: unknown

    Returns Promisable<undefined | QueryBoundWitnessWrapper<T>>

Staticunwrap

StaticunwrapSinglePayload

Staticwrap

StaticwrappedDataHashMap

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods