Class QueryBoundWitnessBuilder<TBoundWitness, TQuery>

Type Parameters

TBoundWitness extends QueryBoundWitness = QueryBoundWitness
TQuery extends Query = Query

Hierarchy (View Summary)

BoundWitnessBuilder<TBoundWitness>
- QueryBoundWitnessBuilder

Constructors

constructor

new QueryBoundWitnessBuilder<
    TBoundWitness extends
        UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TQuery extends Query = Query,
>(
    options?: Omit<PayloadBuilderOptions, "schema">,
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Type Parameters
- TBoundWitness extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TQuery extends Query = Query
Parameters
- Optionaloptions: Omit<PayloadBuilderOptions, "schema">
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.constructor
- Defined in boundwitness/packages/builder/src/Builder.ts:57

Properties

`Protected` `Optional`_fields

_fields?: DeepOmitStartsWith<
DeepOmitStartsWith<WithoutSchema<TBoundWitness>, "_">,
"$",
>

`Protected` `Optional`_meta

_meta?: DeepPickStartsWith<TBoundWitness, "$">

`Protected`_schema

_schema: string

`Readonly`options

options: PayloadBuilderOptions

Accessors

`Protected`addresses

get addresses(): Lowercase<string>[]
Returns Lowercase<string>[]
Inherited from BoundWitnessBuilder.addresses
- Defined in boundwitness/packages/builder/src/Builder.ts:61

`Protected`payloadSchemas

get payloadSchemas(): string[]
Returns string[]
Inherited from BoundWitnessBuilder.payloadSchemas
- Defined in boundwitness/packages/builder/src/Builder.ts:66

`Protected`previousHashBytes

get previousHashBytes(): (null | ArrayBufferLike)[]
Returns (null | ArrayBufferLike)[]
Inherited from BoundWitnessBuilder.previousHashBytes
- Defined in boundwitness/packages/builder/src/Builder.ts:75

`Protected`previousHashes

get previousHashes(): (null | Lowercase<string>)[]
Returns (null | Lowercase<string>)[]
Inherited from BoundWitnessBuilder.previousHashes
- Defined in boundwitness/packages/builder/src/Builder.ts:79

Methods

build

build(): Promise<[Signed<TBoundWitness>, AnyPayload[], ModuleError[]]>
Returns Promise<[Signed<TBoundWitness>, AnyPayload[], ModuleError[]]>
Inherited from BoundWitnessBuilder.build
- Defined in boundwitness/packages/builder/src/Builder.ts:124

dataHash

dataHash(): Promise<Lowercase<string>>
Returns Promise<Lowercase<string>>
Inherited from BoundWitnessBuilder.dataHash
- Defined in boundwitness/packages/builder/src/Builder.ts:140

fields

fields(
    fields: DeepOmitStartsWith<
        DeepOmitStartsWith<
            WithoutSchema<
                Omit<
                    TBoundWitness,
                    "addresses"
                    | "payload_hashes"
                    | "payload_schemas"
                    | "previous_hashes",
                >,
            >,
            "_",
        >,
    >,
): this
Parameters
- fields: DeepOmitStartsWith<
      DeepOmitStartsWith<
          WithoutSchema<
              Omit<
                  TBoundWitness,
                  "addresses"
                  | "payload_hashes"
                  | "payload_schemas"
                  | "previous_hashes",
              >,
          >,
          "_",
      >,
  >
Returns this
Inherited from BoundWitnessBuilder.fields
- Defined in boundwitness/packages/builder/src/Builder.ts:175

hashes

hashes(
hashes: Lowercase<string>[],
schema: string[],
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- hashes: Lowercase<string>[]
- schema: string[]
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.hashes
- Defined in boundwitness/packages/builder/src/Builder.ts:189

payload

payload(payload?: AnyPayload): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- Optionalpayload: AnyPayload
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.payload
- Defined in boundwitness/packages/builder/src/Builder.ts:196

payloads

payloads(
payloads?: (null | AnyPayload)[],
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- Optionalpayloads: (null | AnyPayload)[]
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.payloads
- Defined in boundwitness/packages/builder/src/Builder.ts:204

query

query<T extends Query>(
query: T,
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Type Parameters
- T extends Query
Parameters
- query: T
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
- Defined in boundwitness/packages/builder/src/Query/QueryBoundWitnessBuilder.ts:22

schema

schema(value: string): void
Parameters
- value: string
Returns void
Inherited from BoundWitnessBuilder.schema
- Defined in payload/packages/builder/dist/neutral/index.d.ts:56

`Protected`sign

sign(): Promise<string[]>
Returns Promise<string[]>
Inherited from BoundWitnessBuilder.sign
- Defined in boundwitness/packages/builder/src/Builder.ts:246

signer

signer(
account: AccountInstance,
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- account: AccountInstance
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.signer
- Defined in boundwitness/packages/builder/src/Builder.ts:214

signers

signers(
accounts: AccountInstance[],
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- accounts: AccountInstance[]
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.signers
- Defined in boundwitness/packages/builder/src/Builder.ts:220

sourceQuery

sourceQuery(
sourceQuery: Lowercase<string>,
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- sourceQuery: Lowercase<string>
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Inherited from BoundWitnessBuilder.sourceQuery
- Defined in boundwitness/packages/builder/src/Builder.ts:226

witness

witness(
account: AccountInstance,
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- account: AccountInstance
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Deprecated
use signer instead
Inherited from BoundWitnessBuilder.witness
- Defined in boundwitness/packages/builder/src/Builder.ts:235

witnesses

witnesses(
accounts: AccountInstance[],
): QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Parameters
- accounts: AccountInstance[]
Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>
Deprecated
use signers instead
Inherited from BoundWitnessBuilder.witnesses
- Defined in boundwitness/packages/builder/src/Builder.ts:241

`Static`addressIndex

addressIndex<T extends BoundWitness>(
payload: T,
address: Lowercase<string>,
): number
Type Parameters
- T extends BoundWitness
Parameters
- payload: T
- address: Lowercase<string>
Returns number
Inherited from BoundWitnessBuilder.addressIndex
- Defined in boundwitness/packages/builder/src/Builder.ts:83

`Static`addStorageMeta

addStorageMeta<T extends Payload>(
payload: T,
index?: number,
): Promise<WithStorageMeta<T>>
Type Parameters
- T extends Payload
Parameters
- payload: T
- Optionalindex: number
Returns Promise<WithStorageMeta<T>>
Inherited from BoundWitnessBuilder.addStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:20
addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<WithStorageMeta<T>[]>
Inherited from BoundWitnessBuilder.addStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:21

`Static`compareStorageMeta

compareStorageMeta(
    a: WithStorageMeta<Payload>,
    b: WithStorageMeta<Payload>,
    comparer?: Compare<Lowercase<string>>,
): number
Parameters
- a: WithStorageMeta<Payload>
- b: WithStorageMeta<Payload>
- Optionalcomparer: Compare<Lowercase<string>>
Returns number
Inherited from BoundWitnessBuilder.compareStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:22

`Static`dataHash

dataHash<T extends Payload>(payload: T): Promise<Lowercase<string>>
Type Parameters
- T extends Payload
Parameters
- payload: T
Returns Promise<Lowercase<string>>
Inherited from BoundWitnessBuilder.dataHash
- Defined in payload/packages/builder/dist/neutral/index.d.ts:23

`Static`dataHashableFields

dataHashableFields<T extends Payload>(
schema: string,
payload: WithoutSchema<T>,
): Promisable<WithoutMeta<T>>
Type Parameters
- T extends Payload
Parameters
- schema: string
- payload: WithoutSchema<T>
Returns Promisable<WithoutMeta<T>>
Inherited from BoundWitnessBuilder.dataHashableFields
- Defined in payload/packages/builder/dist/neutral/index.d.ts:25

`Static`dataHashes

dataHashes(payloads: undefined): Promise<undefined>
Parameters
- payloads: undefined
Returns Promise<undefined>
Inherited from BoundWitnessBuilder.dataHashes
- Defined in payload/packages/builder/dist/neutral/index.d.ts:26
dataHashes<T extends Payload>(payloads: T[]): Promise<Lowercase<string>[]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<Lowercase<string>[]>
Inherited from BoundWitnessBuilder.dataHashes
- Defined in payload/packages/builder/dist/neutral/index.d.ts:27

`Static`dataHashPairs

dataHashPairs<T extends Payload>(
payloads: T[],
): Promise<[T, Lowercase<string>][]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<[T, Lowercase<string>][]>
Inherited from BoundWitnessBuilder.dataHashPairs
- Defined in payload/packages/builder/dist/neutral/index.d.ts:24

`Static`filterExclude

filterExclude<T extends Payload>(
payloads: undefined | T[],
hash: Lowercase<string> | Lowercase<string>[],
): Promise<T[]>
Type Parameters
- T extends Payload
Parameters
- payloads: undefined | T[]
- hash: Lowercase<string> | Lowercase<string>[]
Returns Promise<T[]>
Inherited from BoundWitnessBuilder.filterExclude
- Defined in payload/packages/builder/dist/neutral/index.d.ts:28

`Static`filterExcludeByDataHash

filterExcludeByDataHash<T extends Payload>(
payloads: undefined | T[],
hash: Lowercase<string> | Lowercase<string>[],
): Promise<T[]>
Type Parameters
- T extends Payload
Parameters
- payloads: undefined | T[]
- hash: Lowercase<string> | Lowercase<string>[]
Returns Promise<T[]>
Inherited from BoundWitnessBuilder.filterExcludeByDataHash
- Defined in payload/packages/builder/dist/neutral/index.d.ts:29

`Static`filterIncludeByDataHash

filterIncludeByDataHash<T extends Payload>(
payloads: undefined | T[],
hash: Lowercase<string> | Lowercase<string>[],
): Promise<T[]>
Type Parameters
- T extends Payload
Parameters
- payloads: undefined | T[]
- hash: Lowercase<string> | Lowercase<string>[]
Returns Promise<T[]>
Inherited from BoundWitnessBuilder.filterIncludeByDataHash
- Defined in payload/packages/builder/dist/neutral/index.d.ts:30

`Static`filterIncludeByEitherHash

filterIncludeByEitherHash<T extends Payload>(
payloads: undefined | T[],
hash: Lowercase<string> | Lowercase<string>[],
): Promise<T[]>
Type Parameters
- T extends Payload
Parameters
- payloads: undefined | T[]
- hash: Lowercase<string> | Lowercase<string>[]
Returns Promise<T[]>
Inherited from BoundWitnessBuilder.filterIncludeByEitherHash
- Defined in payload/packages/builder/dist/neutral/index.d.ts:31

`Static`findByDataHash

findByDataHash<T extends Payload>(
payloads: undefined | T[],
hash: Lowercase<string>,
): Promise<undefined | T>
Type Parameters
- T extends Payload
Parameters
- payloads: undefined | T[]
- hash: Lowercase<string>
Returns Promise<undefined | T>
Inherited from BoundWitnessBuilder.findByDataHash
- Defined in payload/packages/builder/dist/neutral/index.d.ts:32

`Static`hash

hash<T extends Payload>(payload: T): Promise<Lowercase<string>>
Type Parameters
- T extends Payload
Parameters
- payload: T
Returns Promise<Lowercase<string>>
Inherited from BoundWitnessBuilder.hash
- Defined in payload/packages/builder/dist/neutral/index.d.ts:33

`Static`hashableFields

hashableFields<T extends Payload>(payload: T): WithoutStorageMeta<T>
Type Parameters
- T extends Payload
Parameters
- payload: T
Returns WithoutStorageMeta<T>
Inherited from BoundWitnessBuilder.hashableFields
- Defined in payload/packages/builder/dist/neutral/index.d.ts:35

`Static`hashes

hashes(payloads: undefined): Promise<undefined>
Parameters
- payloads: undefined
Returns Promise<undefined>
Inherited from BoundWitnessBuilder.hashes
- Defined in payload/packages/builder/dist/neutral/index.d.ts:36
hashes<T extends Payload>(payloads: T[]): Promise<Lowercase<string>[]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<Lowercase<string>[]>
Inherited from BoundWitnessBuilder.hashes
- Defined in payload/packages/builder/dist/neutral/index.d.ts:37

`Static`hashPairs

hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Lowercase<string>][]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<[T, Lowercase<string>][]>
Inherited from BoundWitnessBuilder.hashPairs
- Defined in payload/packages/builder/dist/neutral/index.d.ts:34

`Protected` `Static`linkingFields

linkingFields<T extends BoundWitness>(
    accounts: AccountInstance[],
    payloads?: Payload[],
): Promise<
    Pick<
        T,
        "addresses"
        | "payload_hashes"
        | "payload_schemas"
        | "previous_hashes",
    >,
>
Type Parameters
- T extends BoundWitness
Parameters
- accounts: AccountInstance[]
- Optionalpayloads: Payload[]
Returns Promise<
    Pick<
        T,
        "addresses"
        | "payload_hashes"
        | "payload_schemas"
        | "previous_hashes",
    >,
>
Inherited from BoundWitnessBuilder.linkingFields
- Defined in boundwitness/packages/builder/src/Builder.ts:95

`Static`omitClientMeta

omitClientMeta<T extends object>(
payload: T,
maxDepth?: number,
): WithoutClientMeta<T>
Type Parameters
- T extends object
Parameters
- payload: T
- OptionalmaxDepth: number
Returns WithoutClientMeta<T>
Inherited from BoundWitnessBuilder.omitClientMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:38
omitClientMeta<T extends object>(
payloads: T[],
maxDepth?: number,
): WithoutClientMeta<T>[]
Type Parameters
- T extends object
Parameters
- payloads: T[]
- OptionalmaxDepth: number
Returns WithoutClientMeta<T>[]
Inherited from BoundWitnessBuilder.omitClientMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:39

`Static`omitMeta

omitMeta<T extends object>(payload: T, maxDepth?: number): WithoutMeta<T>
Type Parameters
- T extends object
Parameters
- payload: T
- OptionalmaxDepth: number
Returns WithoutMeta<T>
Inherited from BoundWitnessBuilder.omitMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:40
omitMeta<T extends object>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]
Type Parameters
- T extends object
Parameters
- payloads: T[]
- OptionalmaxDepth: number
Returns WithoutMeta<T>[]
Inherited from BoundWitnessBuilder.omitMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:41

`Static`omitPrivateStorageMeta

omitPrivateStorageMeta<T extends object>(
payload: T,
maxDepth?: number,
): WithoutPrivateStorageMeta<T>
Type Parameters
- T extends object
Parameters
- payload: T
- OptionalmaxDepth: number
Returns WithoutPrivateStorageMeta<T>
Inherited from BoundWitnessBuilder.omitPrivateStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:42
omitPrivateStorageMeta<T extends object>(
payloads: T[],
maxDepth?: number,
): WithoutPrivateStorageMeta<T>[]
Type Parameters
- T extends object
Parameters
- payloads: T[]
- OptionalmaxDepth: number
Returns WithoutPrivateStorageMeta<T>[]
Inherited from BoundWitnessBuilder.omitPrivateStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:43

`Static`omitStorageMeta

omitStorageMeta<T extends object>(
payload: T,
maxDepth?: number,
): WithoutStorageMeta<T>
Type Parameters
- T extends object
Parameters
- payload: T
- OptionalmaxDepth: number
Returns WithoutStorageMeta<T>
Inherited from BoundWitnessBuilder.omitStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:44
omitStorageMeta<T extends object>(
payloads: T[],
maxDepth?: number,
): WithoutStorageMeta<T>[]
Type Parameters
- T extends object
Parameters
- payloads: T[]
- OptionalmaxDepth: number
Returns WithoutStorageMeta<T>[]
Inherited from BoundWitnessBuilder.omitStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:45

`Static`previousHash

previousHash<T extends BoundWitness>(
boundWitness: T,
address: Lowercase<string>,
): undefined | string
Type Parameters
- T extends BoundWitness
Parameters
- boundWitness: T
- address: Lowercase<string>
Returns undefined | string
Inherited from BoundWitnessBuilder.previousHash
- Defined in boundwitness/packages/builder/src/Builder.ts:91

`Protected` `Static`signature

signature<T extends BoundWitness>(
payload: T,
address: Lowercase<string>,
): Lowercase<string>
Type Parameters
- T extends BoundWitness
Parameters
- payload: T
- address: Lowercase<string>
Returns Lowercase<string>
Inherited from BoundWitnessBuilder.signature
- Defined in boundwitness/packages/builder/src/Builder.ts:108

`Protected` `Static`signatures

signatures(
accounts: AccountInstance[],
dataHash: Lowercase<string>,
): Promise<string[]>
Parameters
- accounts: AccountInstance[]
- dataHash: Lowercase<string>
Returns Promise<string[]>
Inherited from BoundWitnessBuilder.signatures
- Defined in boundwitness/packages/builder/src/Builder.ts:112

`Static`sortByStorageMeta

sortByStorageMeta<T extends Payload>(
    payloads: WithStorageMeta<T>[],
    direction?: 1 | -1,
    comparer?: Compare<Lowercase<string>>,
): WithStorageMeta<T>[]
Type Parameters
- T extends Payload
Parameters
- payloads: WithStorageMeta<T>[]
- Optionaldirection: 1 | -1
- Optionalcomparer: Compare<Lowercase<string>>
Returns WithStorageMeta<T>[]
Inherited from BoundWitnessBuilder.sortByStorageMeta
- Defined in payload/packages/builder/dist/neutral/index.d.ts:46

`Static`toAllHashMap

toAllHashMap<T extends Payload>(
payloads: T[],
): Promise<Record<Lowercase<string>, T>>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<Record<Lowercase<string>, T>>
Inherited from BoundWitnessBuilder.toAllHashMap
- Defined in payload/packages/builder/dist/neutral/index.d.ts:47

`Static`toDataHashMap

toDataHashMap<T extends Payload>(
objs: T[],
): Promise<Record<Lowercase<string>, T>>
Type Parameters
- T extends Payload
Parameters
- objs: T[]
Returns Promise<Record<Lowercase<string>, T>>
Inherited from BoundWitnessBuilder.toDataHashMap
- Defined in payload/packages/builder/dist/neutral/index.d.ts:48

`Static`toHashMap

toHashMap<T extends Payload>(objs: T[]): Promise<Record<Lowercase<string>, T>>
Type Parameters
- T extends Payload
Parameters
- objs: T[]
Returns Promise<Record<Lowercase<string>, T>>
Inherited from BoundWitnessBuilder.toHashMap
- Defined in payload/packages/builder/dist/neutral/index.d.ts:49

Class QueryBoundWitnessBuilder<TBoundWitness, TQuery>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

Properties

Protected Optional_fields

Protected Optional_meta

Protected_schema

Readonlyoptions

Accessors

Protectedaddresses

Returns Lowercase<string>[]

ProtectedpayloadSchemas

Returns string[]

ProtectedpreviousHashBytes

Returns (null | ArrayBufferLike)[]

ProtectedpreviousHashes

Returns (null | Lowercase<string>)[]

Methods

build

Returns Promise<[Signed<TBoundWitness>, AnyPayload[], ModuleError[]]>

dataHash

Returns Promise<Lowercase<string>>

dataHashableFields

Returns Promise<WithoutMeta<TBoundWitness>>

error

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

errors

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

fields

Parameters

Returns this

hashes

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

meta

Parameters

Returns this

payload

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

payloads

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

query

Type Parameters

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

schema

Parameters

Returns void

Protectedsign

Returns Promise<string[]>

signer

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

signers

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

sourceQuery

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

witness

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

Deprecated

witnesses

Parameters

Returns QueryBoundWitnessBuilder<TBoundWitness, TQuery>

`Protected` `Optional`_fields

`Protected` `Optional`_meta

`Protected`_schema

`Readonly`options

`Protected`addresses

`Protected`payloadSchemas

`Protected`previousHashBytes

`Protected`previousHashes

`Protected`sign

`Static`addressIndex

`Static`addStorageMeta

`Static`compareStorageMeta

`Static`dataHash

`Static`dataHashableFields

`Static`dataHashes

`Static`dataHashPairs

`Static`filterExclude

`Static`filterExcludeByDataHash

`Static`filterIncludeByDataHash

`Static`filterIncludeByEitherHash

`Static`findByDataHash

`Static`hash

`Static`hashableFields

`Static`hashes

`Static`hashPairs