Class BoundWitnessWrapper<TBoundWitness, TPayload>

boundwitness

OptionalmoduleErrors

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

dig

• dig(depth?: number): Promise<BoundWitnessWrapper<TBoundWitness>>

• Parameters

  • Optionaldepth: number

  Returns Promise<BoundWitnessWrapper<TBoundWitness>>

getMissingPayloads

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

• Returns Promise<Lowercase<string>[]>

getWrappedPayloads

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

• Returns Promise<PayloadWrapper<TPayload>[]>

hashesBySchema

• hashesBySchema(schema: string): string[]

• Parameters

  • schema: string

  Returns string[]

payloadsByDataHashes

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

• Parameters

  • hashes: Lowercase<string>[]

  Returns Promise<TPayload[]>

payloadsByHashes

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

• Parameters

  • hashes: Lowercase<string>[]

  Returns Promise<TPayload[]>

payloadsBySchema

• payloadsBySchema<T extends DeepRestrictToStringKeys<{ schema: string }>>(
      schema: string,
  ): T[]

• Type Parameters

  • T extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • schema: string

  Returns T[]

payloadsDataHashMap

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

• Returns Promise<Record<Lowercase<string>, TPayload>>

payloadsHashMap

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

• Returns Promise<Record<Lowercase<string>, TPayload>>

prev

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

• Parameters

  • address: Lowercase<string>

  Returns DeepRestrictToStringKeys<null | Lowercase<string>>

toResult

• toResult(): (TBoundWitness | TPayload[])[]

• Returns (TBoundWitness | TPayload[])[]

validate

• validate(): Promise<Error[]>

• Returns Promise<Error[]>

Staticas

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

• Type Parameters

  • T extends BoundWitness = BoundWitness

  Parameters

  • value: unknown

  Returns undefined | BoundWitnessWrapper<T>

Staticload

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

• Parameters

  • address: Lowercase<string>

  Returns Promise<null | BoundWitnessWrapper>

Staticparse

• parse<
      T extends BoundWitness = BoundWitness,
      P extends
          DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
          { schema: string },
      >,
  >(
      obj: unknown,
      payloads?: P[],
  ): BoundWitnessWrapper<T, P>

• Type Parameters

  • T extends BoundWitness = BoundWitness
  • P extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • obj: unknown
  • Optionalpayloads: P[]

  Returns BoundWitnessWrapper<T, P>

StatictryParse

• tryParse<
      T extends BoundWitness,
      P extends DeepRestrictToStringKeys<{ schema: string }>,
  >(
      obj: unknown,
      payloads?: P[],
  ): undefined | BoundWitnessWrapper<T, P>

• Type Parameters

  • T extends BoundWitness
  • P extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

  • obj: unknown
  • Optionalpayloads: P[]

  Returns undefined | BoundWitnessWrapper<T, P>

Staticwrap

• wrap<
      T extends BoundWitness,
      P extends DeepRestrictToStringKeys<{ schema: string }>,
  >(
      obj: PayloadWrapperBase<T> | WithoutPrivateStorageMeta<T>,
      payloads?: P[],
  ): Promise<BoundWitnessWrapper<T, P>>

• Type Parameters

  • T extends BoundWitness
  • P extends DeepRestrictToStringKeys<{ schema: string }>

  Parameters

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

  Returns Promise<BoundWitnessWrapper<T, P>>

StaticwrappedDataHashMap

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

• Type Parameters

  • T extends BoundWitness

  Parameters

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

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