Class BoundWitnessBuilder<TBoundWitness, TPayload>

Type Parameters

TBoundWitness extends UnsignedBoundWitness = UnsignedBoundWitness
TPayload extends Payload = AnyPayload

Hierarchy (View Summary)

PayloadBuilder<
TBoundWitness,
Promise<[Signed<TBoundWitness>, TPayload[], ModuleError[]]>,
>
- BoundWitnessBuilder
  - QueryBoundWitnessBuilder

Constructors

constructor

new BoundWitnessBuilder<
    TBoundWitness extends UnsignedBoundWitness = UnsignedBoundWitness,
    TPayload extends Payload = AnyPayload,
>(
    options?: Omit<PayloadBuilderOptions, "schema">,
): BoundWitnessBuilder<TBoundWitness, TPayload>
Type Parameters
- TBoundWitness extends UnsignedBoundWitness = UnsignedBoundWitness
- TPayload extends Payload = AnyPayload
Parameters
- Optionaloptions: Omit<PayloadBuilderOptions, "schema">
Returns BoundWitnessBuilder<TBoundWitness, TPayload>
Overrides PayloadBuilder.constructor
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:17

Properties

`Protected` `Optional`_fields

_fields?: 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>[]
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:18

`Protected`payloadSchemas

get payloadSchemas(): string[]
Returns string[]
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:19

`Protected`previousHashBytes

get previousHashBytes(): (null | ArrayBufferLike)[]
Returns (null | ArrayBufferLike)[]
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:20

`Protected`previousHashes

get previousHashes(): (null | Lowercase<string>)[]
Returns (null | Lowercase<string>)[]
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:21

Methods

build

build(): Promise<[Signed<TBoundWitness>, TPayload[], ModuleError[]]>
Returns Promise<[Signed<TBoundWitness>, TPayload[], ModuleError[]]>
Overrides PayloadBuilder.build
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:28

dataHash

dataHash(): Promise<Lowercase<string>>
Returns Promise<Lowercase<string>>
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:29

dataHashableFields

dataHashableFields(): Promise<any>
Returns Promise<any>
Overrides PayloadBuilder.dataHashableFields
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:30

error

error(payload?: ModuleError): this
Parameters
- Optionalpayload: ModuleError
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:31

errors

errors(errors?: (null | ModuleError)[]): this
Parameters
- Optionalerrors: (null | ModuleError)[]
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:32

fields

fields(
    fields: DeepOmitStartsWith<
        WithoutSchema<
            Omit<
                TBoundWitness,
                "addresses"
                | "payload_hashes"
                | "payload_schemas"
                | "previous_hashes",
            >,
        >,
    >,
): this
Parameters
- fields: DeepOmitStartsWith<
      WithoutSchema<
          Omit<
              TBoundWitness,
              "addresses"
              | "payload_hashes"
              | "payload_schemas"
              | "previous_hashes",
          >,
      >,
  >
Returns this
Overrides PayloadBuilder.fields
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:33

hashes

hashes(hashes: Lowercase<string>[], schema: string[]): this
Parameters
- hashes: Lowercase<string>[]
- schema: string[]
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:34

payload

payload(payload?: TPayload): this
Parameters
- Optionalpayload: TPayload
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:35

payloads

payloads(payloads?: (null | TPayload)[]): this
Parameters
- Optionalpayloads: (null | TPayload)[]
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:36

schema

schema(value: string): void
Parameters
- value: string
Returns void
Inherited from PayloadBuilder.schema
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:61

`Protected`sign

sign(): Promise<string[]>
Returns Promise<string[]>
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:44

signer

signer(account: AccountInstance): this
Parameters
- account: AccountInstance
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:37

signers

signers(accounts: AccountInstance[]): this
Parameters
- accounts: AccountInstance[]
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:38

sourceQuery

sourceQuery(sourceQuery: Lowercase<string>): this
Parameters
- sourceQuery: Lowercase<string>
Returns this
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:39

witness

witness(account: AccountInstance): this
Parameters
- account: AccountInstance
Returns this
Deprecated
use signer instead
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:41

witnesses

witnesses(accounts: AccountInstance[]): this
Parameters
- accounts: AccountInstance[]
Returns this
Deprecated
use signers instead
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:43

`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
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:22

`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 PayloadBuilder.addStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:13
addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<WithStorageMeta<T>[]>
Inherited from PayloadBuilder.addStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:14

`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 PayloadBuilder.compareStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:15

`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 PayloadBuilder.dataHash
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:16

`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 PayloadBuilder.dataHashableFields
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:18

`Static`dataHashes

dataHashes(payloads: undefined): Promise<undefined>
Parameters
- payloads: undefined
Returns Promise<undefined>
Inherited from PayloadBuilder.dataHashes
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:19
dataHashes<T extends Payload>(payloads: T[]): Promise<Lowercase<string>[]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<Lowercase<string>[]>
Inherited from PayloadBuilder.dataHashes
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:20

`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 PayloadBuilder.dataHashPairs
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:17

`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 PayloadBuilder.filterExclude
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:21

`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 PayloadBuilder.filterExcludeByDataHash
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:22

`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 PayloadBuilder.filterIncludeByDataHash
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:23

`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 PayloadBuilder.filterIncludeByEitherHash
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:24

`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 PayloadBuilder.findByDataHash
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:25

`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 PayloadBuilder.hash
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:26

`Static`hashableFields

hashableFields<T extends Payload>(payload: T): WithoutStorageMeta<T>
Type Parameters
- T extends Payload
Parameters
- payload: T
Returns WithoutStorageMeta<T>
Inherited from PayloadBuilder.hashableFields
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:33

`Static`hashes

hashes(payloads: undefined): Promise<undefined>
Parameters
- payloads: undefined
Returns Promise<undefined>
Inherited from PayloadBuilder.hashes
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:34
hashes<T extends Payload>(payloads: T[]): Promise<Lowercase<string>[]>
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<Lowercase<string>[]>
Inherited from PayloadBuilder.hashes
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:35

`Static`hashPairs

hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Lowercase<string>][]>
Creates an array of payload/hash tuples based on the payloads passed in
Type Parameters
- T extends Payload
Parameters
- payloads: T[]
Returns Promise<[T, Lowercase<string>][]>
An array of payload/hash tuples
Inherited from PayloadBuilder.hashPairs
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:32

`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",
    >,
>
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:24

`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 PayloadBuilder.omitClientMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:36
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 PayloadBuilder.omitClientMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:37

`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 PayloadBuilder.omitMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:38
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 PayloadBuilder.omitMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:39

`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 PayloadBuilder.omitPrivateStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:40
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 PayloadBuilder.omitPrivateStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:41

`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 PayloadBuilder.omitStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:42
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 PayloadBuilder.omitStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:43

`Static`pickClientMeta

pickClientMeta<T extends object>(
payload: T,
maxDepth?: number,
): WithOnlyClientMeta<T>
Type Parameters
- T extends object
Parameters
- payload: T
- OptionalmaxDepth: number
Returns WithOnlyClientMeta<T>
Inherited from PayloadBuilder.pickClientMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:44
pickClientMeta<T extends object>(
payloads: T[],
maxDepth?: number,
): WithOnlyClientMeta<T>[]
Type Parameters
- T extends object
Parameters
- payloads: T[]
- OptionalmaxDepth: number
Returns WithOnlyClientMeta<T>[]
Inherited from PayloadBuilder.pickClientMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.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
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:23

`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>
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:25

`Protected` `Static`signatures

signatures(
accounts: AccountInstance[],
dataHash: Lowercase<string>,
): Promise<string[]>
Parameters
- accounts: AccountInstance[]
- dataHash: Lowercase<string>
Returns Promise<string[]>
- Defined in packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:26

`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 PayloadBuilder.sortByStorageMeta
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.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 PayloadBuilder.toAllHashMap
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.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 PayloadBuilder.toDataHashMap
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:48

`Static`toHashMap

toHashMap<T extends Payload>(objs: T[]): Promise<Record<Lowercase<string>, T>>
Creates an object map of payload hashes to payloads based on the payloads passed in
Type Parameters
- T extends Payload
Parameters
- objs: T[]
  Any array of payloads
Returns Promise<Record<Lowercase<string>, T>>
A map of hashes to payloads
Inherited from PayloadBuilder.toHashMap
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:54

Class BoundWitnessBuilder<TBoundWitness, TPayload>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BoundWitnessBuilder<TBoundWitness, TPayload>

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>, TPayload[], ModuleError[]]>

dataHash

Returns Promise<Lowercase<string>>

dataHashableFields

Returns Promise<any>

error

Parameters

Returns this

errors

Parameters

Returns this

fields

Parameters

Returns this

hashes

Parameters

Returns this

meta

Parameters

Returns this

payload

Parameters

Returns this

payloads

Parameters

Returns this

schema

Parameters

Returns void

Protectedsign

Returns Promise<string[]>

signer

Parameters

Returns this

signers

Parameters

Returns this

sourceQuery

Parameters

Returns this

witness

Parameters

Returns this

Deprecated

witnesses

Parameters

Returns this

Deprecated

StaticaddressIndex

Type Parameters

Parameters

`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

`Protected` `Static`linkingFields