Class QueryBoundWitnessWrapper<T>

boundwitness

OptionalmoduleErrors

payload

payloads

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>>[]

dataHash

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

  Returns Promise<Lowercase<string>>

dig

• dig(
      depth?: number,
  ): Promise<BoundWitnessWrapper<UnsignedQueryBoundWitness, Payload>>

  Parameters

  • Optionaldepth: number

  Returns Promise<BoundWitnessWrapper<UnsignedQueryBoundWitness, Payload>>

getErrors

• getErrors(): Promise<Error[]>

  Returns Promise<Error[]>

getMissingPayloads

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

  Returns Promise<Lowercase<string>[]>

getValid

• getValid(): Promise<boolean>

  Returns Promise<boolean>

getWrappedPayloads

• getWrappedPayloads(): Promise<PayloadWrapper<Payload>[]>

  Returns Promise<PayloadWrapper<Payload>[]>

hashesBySchema

• hashesBySchema(schema: string): string[]

  Parameters

  • schema: string

  Returns string[]

payloadsByDataHashes

• payloadsByDataHashes(hashes: Lowercase<string>[]): Promise<Payload[]>

  Parameters

  • hashes: Lowercase<string>[]

  Returns Promise<Payload[]>

payloadsByHashes

• payloadsByHashes(hashes: Lowercase<string>[]): Promise<Payload[]>

  Parameters

  • hashes: Lowercase<string>[]

  Returns Promise<Payload[]>

payloadsBySchema

• payloadsBySchema<T extends Payload>(schema: string): T[]

  Type Parameters

  • T extends Payload

  Parameters

  • schema: string

  Returns T[]

payloadsDataHashMap

• payloadsDataHashMap(): Promise<Record<Lowercase<string>, Payload>>

  Returns Promise<Record<Lowercase<string>, Payload>>

payloadsHashMap

• payloadsHashMap(): Promise<Record<Lowercase<string>, Payload>>

  Returns Promise<Record<Lowercase<string>, Payload>>

prev

• prev(
      address: Lowercase<string>,
  ): DeepRestrictToStringKeys<null | Lowercase<string>>

  Parameters

  • address: Lowercase<string>

  Returns DeepRestrictToStringKeys<null | Lowercase<string>>

schema

• schema(): string

  Returns string

toResult

• toResult(): (Payload[] | UnsignedQueryBoundWitness)[]

  Returns (Payload[] | UnsignedQueryBoundWitness)[]

validate

• validate(): Promise<Error[]>

  Returns Promise<Error[]>

Staticas

• as<T extends BoundWitness = BoundWitness>(
      value: unknown,
  ): undefined | BoundWitnessWrapper<T, Payload>

  Type Parameters

  • T extends BoundWitness = BoundWitness

  Parameters

  • value: unknown

  Returns undefined | BoundWitnessWrapper<T, Payload>

Staticload

• load(
      address: Lowercase<string>,
  ): Promise<null | BoundWitnessWrapper<BoundWitness, Payload>>

  Parameters

  • address: Lowercase<string>

  Returns Promise<null | BoundWitnessWrapper<BoundWitness, Payload>>

Staticparse

• parse<T extends BoundWitness = BoundWitness, P extends Payload = Payload>(
      obj: unknown,
      payloads?: P[],
  ): BoundWitnessWrapper<T, P>

  Type Parameters

  • T extends BoundWitness = BoundWitness
  • P extends Payload = Payload

  Parameters

  • obj: unknown
  • Optionalpayloads: P[]

  Returns BoundWitnessWrapper<T, P>

StatictryParse

• tryParse<T extends BoundWitness, P extends Payload>(
      obj: unknown,
      payloads?: P[],
  ): undefined | BoundWitnessWrapper<T, P>

  Type Parameters

  • T extends BoundWitness
  • P extends Payload

  Parameters

  • obj: unknown
  • Optionalpayloads: P[]

  Returns undefined | BoundWitnessWrapper<T, P>

Staticunwrap

• unwrap<TPayload extends Payload = Payload>(
      payload?: TPayload,
  ): undefined | TPayload

  Type Parameters

  • TPayload extends Payload = Payload

  Parameters

  • Optionalpayload: TPayload

  Returns undefined | TPayload

• unwrap<
      TPayload extends Payload = Payload,
      TWrapper extends
          PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
  >(
      payload: TPayload | TWrapper,
  ): TPayload

  Type Parameters

  • TPayload extends Payload = Payload
  • TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>

  Parameters

  • payload: TPayload | TWrapper

  Returns TPayload

• unwrap<
      TPayload extends Payload = Payload,
      TWrapper extends
          PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
  >(
      payload: (TPayload | TWrapper)[],
  ): TPayload[]

  Type Parameters

  • TPayload extends Payload = Payload
  • TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>

  Parameters

  • payload: (TPayload | TWrapper)[]

  Returns TPayload[]

StaticunwrapSinglePayload

• unwrapSinglePayload<TPayload extends Payload = Payload>(
      payload?: TPayload,
  ): undefined | TPayload

  Type Parameters

  • TPayload extends Payload = Payload

  Parameters

  • Optionalpayload: TPayload

  Returns undefined | TPayload

• unwrapSinglePayload<
      TPayload extends Payload = Payload,
      TWrapper extends
          PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
  >(
      payload: TPayload | TWrapper,
  ): TPayload

  Type Parameters

  • TPayload extends Payload = Payload
  • TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>

  Parameters

  • payload: TPayload | TWrapper

  Returns TPayload

Staticwrap

• wrap<T extends BoundWitness, P extends Payload>(
      obj: PayloadWrapperBase<T> | WithoutPrivateStorageMeta<T>,
      payloads?: P[],
  ): BoundWitnessWrapper<T, P>

  Type Parameters

  • T extends BoundWitness
  • P extends Payload

  Parameters

  • obj: PayloadWrapperBase<T> | WithoutPrivateStorageMeta<T>
  • Optionalpayloads: P[]

  Returns BoundWitnessWrapper<T, P>

StaticwrappedDataHashMap

• wrappedDataHashMap<T extends BoundWitness>(
      boundWitnesses: (T | BoundWitnessWrapper<T, Payload>)[],
  ): Promise<Record<string, BoundWitnessWrapper<T, Payload>>>

  Type Parameters

  • T extends BoundWitness

  Parameters

  • boundWitnesses: (T | BoundWitnessWrapper<T, Payload>)[]

  Returns Promise<Record<string, BoundWitnessWrapper<T, Payload>>>