Class QueryBoundWitnessWrapper<T>

constructor

• new QueryBoundWitnessWrapper<T>(boundwitness, payloads?): QueryBoundWitnessWrapper<T>

• Type Parameters

  • T extends SchemaFields & PayloadFields & QueryFields & {
        schema: string;
    } = SchemaFields & PayloadFields & QueryFields & {
        schema: string;
    }

  Parameters

  • boundwitness: SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    }

  • Optional payloads: (null | SchemaFields & PayloadFields & {
        schema: string;
    } | PayloadWrapper<SchemaFields & PayloadFields & {
        schema: string;
    }>)[]

  Returns QueryBoundWitnessWrapper<T>

Readonly obj

Static allowWasm

Static wasmSupported

addresses

• get addresses(): string[]

• Returns string[]

body

• get body(): TPayload

• Returns TPayload

boundwitness

• get boundwitness(): TBoundWitness

• Returns TBoundWitness

hash

• get hash(): string

• Returns string

hashFields

• get hashFields(): T

• Returns T

missingPayloads

• get missingPayloads(): string[]

• Returns string[]

payload

• get payload(): TPayload

• Returns TPayload

payloadHashes

• get payloadHashes(): string[]

• Returns string[]

payloadSchemas

• get payloadSchemas(): string[]

• Returns string[]

payloads

• get payloads(): Record<string, PayloadWrapper<TPayload>>

• Returns Record<string, PayloadWrapper<TPayload>>

• set payloads(payloads): void

• Parameters

  • payloads: undefined | Record<string, PayloadWrapper<TPayload>> | (TPayload | PayloadWrapper<TPayload>)[]

  Returns void

payloadsArray

• get payloadsArray(): PayloadWrapper<TPayload>[]

• Returns PayloadWrapper<TPayload>[]

previousHashes

• get previousHashes(): (null | string)[]

• Returns (null | string)[]

schema

• get schema(): string

• Returns string

schemaName

• get schemaName(): string

• Returns string

stringified

• get stringified(): string

• Returns string

valid

• get valid(): boolean

• Returns boolean

dig

• dig(depth?): BoundWitnessWrapper<SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }, SchemaFields & PayloadFields & {
      schema: string;
  }>

• Parameters

  • Optional depth: number

  Returns BoundWitnessWrapper<SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }, SchemaFields & PayloadFields & {
      schema: string;
  }>

hashAsync

• hashAsync(): Promise<string>

• Returns Promise<string>

payloadsBySchema

• payloadsBySchema(schema): PayloadWrapper<SchemaFields & PayloadFields & {
      schema: string;
  }>[]

• Parameters

  • schema: string

  Returns PayloadWrapper<SchemaFields & PayloadFields & {
      schema: string;
  }>[]

prev

• prev(address): null | string

• Parameters

  • address: string

  Returns null | string

toResult

• toResult(): (SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } | (SchemaFields & PayloadFields & {
      schema: string;
  })[])[]

• Returns (SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } | (SchemaFields & PayloadFields & {
      schema: string;
  })[])[]

validate

• validate(): Error[]

• Returns Error[]

Static hash

• hash<T>(obj): string

• Type Parameters

  • T extends AnyObject

  Parameters

  • obj: T

  Returns string

Static hashAsync

• hashAsync<T>(obj): Promise<string>

• Type Parameters

  • T extends AnyObject

  Parameters

  • obj: T

  Returns Promise<string>

Static hashFields

• hashFields<T>(obj): T

• Type Parameters

  • T extends AnyObject

  Parameters

  • obj: T

  Returns T

Static load

• load(address): Promise<null | BoundWitnessWrapper<SchemaFields & PayloadFields & BoundWitnessFields & {
      schema: "network.xyo.boundwitness";
  }, SchemaFields & PayloadFields & {
      schema: string;
  }>>

• Parameters

  • address: DataLike

  Returns Promise<null | BoundWitnessWrapper<SchemaFields & PayloadFields & BoundWitnessFields & {
      schema: "network.xyo.boundwitness";
  }, SchemaFields & PayloadFields & {
      schema: string;
  }>>

Static parse

• parse<T, P>(obj, payloads?): BoundWitnessWrapper<T, P>

• Type Parameters

  • T extends SchemaFields & PayloadFields & BoundWitnessFields & {
        schema: "network.xyo.boundwitness";
    }

  • P extends SchemaFields & PayloadFields & {
        schema: string;
    }

  Parameters

  • obj: unknown

  • Optional payloads: P[]

  Returns BoundWitnessWrapper<T, P>

Static stringify

• stringify<T>(obj): string

• Type Parameters

  • T extends AnyObject

  Parameters

  • obj: T

  Returns string

Static tryParse

• tryParse(obj): undefined | PayloadWrapperBase<SchemaFields & PayloadFields & {
      schema: string;
  }>

• Parameters

  • obj: unknown

  Returns undefined | PayloadWrapperBase<SchemaFields & PayloadFields & {
      schema: string;
  }>

Static unwrap

• unwrap<TPayload>(payload?): undefined | TPayload

• Type Parameters

  • TPayload extends SchemaFields & PayloadFields & {
        schema: string;
    } = SchemaFields & PayloadFields & {
        schema: string;
    }

  Parameters

  • Optional payload: SchemaFields & PayloadFields & {
        schema: string;
    }

  Returns undefined | TPayload

• unwrap<TPayload>(payload?): (undefined | TPayload)[]

• Type Parameters

  • TPayload extends SchemaFields & PayloadFields & {
        schema: string;
    } = SchemaFields & PayloadFields & {
        schema: string;
    }

  Parameters

  • Optional payload: (SchemaFields & PayloadFields & {
        schema: string;
    })[]

  Returns (undefined | TPayload)[]