Class PayloadBuilder<T, R>

Type Parameters

T extends Payload = Payload<AnyObject>
R = T

Hierarchy (View Summary)

PayloadBuilder
- BoundWitnessBuilder

Constructors

constructor

new PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T>(
options: PayloadBuilderOptions,
): PayloadBuilder<T, R>
Type Parameters
- T extends Payload = Payload<AnyObject>
- R = T
Parameters
- options: PayloadBuilderOptions
Returns PayloadBuilder<T, R>
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:12

Properties

`Protected` `Optional`_fields

_fields?: DeepOmitStartsWith<WithoutSchema<T>, "_">

`Protected` `Optional`_meta

_meta?: DeepPickStartsWith<T, "$">

`Protected`_schema

_schema: string

`Readonly`options

options: PayloadBuilderOptions

Methods

build

build(): R
Returns R
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:57

dataHashableFields

dataHashableFields(): Promise<
DeepOmitStartsWith<DeepOmitStartsWith<T, "_">, "$">,
>
Returns Promise<DeepOmitStartsWith<DeepOmitStartsWith<T, "_">, "$">>
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:58

fields

fields(fields: DeepOmitStartsWith<WithoutSchema<T>>): this
Parameters
- fields: DeepOmitStartsWith<WithoutSchema<T>>
Returns this
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:59

schema

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

`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>>
- 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>[]>
- 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
- 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>>
- 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>>
- 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>
- 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>[]>
- 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>][]>
- 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[]>
- 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[]>
- 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[]>
- 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[]>
- 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>
- 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>>
- 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>
- 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>
- 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>[]>
- 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
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:32

`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>
- 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>[]
- 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>
- 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>[]
- 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>
- 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>[]
- 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>
- 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>[]
- 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>
- 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>[]
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:45

`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>[]
- 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>>
- 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>>
- 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
- Defined in packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:54

Class PayloadBuilder<T, R>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PayloadBuilder<T, R>

Properties

Protected Optional_fields

Protected Optional_meta

Protected_schema

Readonlyoptions

Methods

build

Returns R

dataHashableFields

Returns Promise<DeepOmitStartsWith<DeepOmitStartsWith<T, "_">, "$">>

fields

Parameters

Returns this

meta

Parameters

Returns this

schema

Parameters

Returns void

StaticaddStorageMeta

Type Parameters

Parameters

Returns Promise<WithStorageMeta<T>>

Type Parameters

Parameters

Returns Promise<WithStorageMeta<T>[]>

StaticcompareStorageMeta

Parameters

Returns number

StaticdataHash

Type Parameters

Parameters

Returns Promise<Lowercase<string>>

StaticdataHashableFields

Type Parameters

Parameters

Returns Promisable<WithoutMeta<T>>

StaticdataHashes

Parameters

Returns Promise<undefined>

Type Parameters

Parameters

Returns Promise<Lowercase<string>[]>

StaticdataHashPairs

Type Parameters

Parameters

Returns Promise<[T, Lowercase<string>][]>

StaticfilterExclude

Type Parameters

Parameters

Returns Promise<T[]>

StaticfilterExcludeByDataHash

Type Parameters

Parameters

Returns Promise<T[]>

StaticfilterIncludeByDataHash

Type Parameters

Parameters

Returns Promise<T[]>

StaticfilterIncludeByEitherHash

Type Parameters

Parameters

Returns Promise<T[]>

StaticfindByDataHash

Type Parameters

Parameters

Returns Promise<undefined | T>

Statichash

`Protected` `Optional`_fields

`Protected` `Optional`_meta

`Protected`_schema

`Readonly`options

`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

`Static`omitClientMeta

`Static`omitMeta

`Static`omitPrivateStorageMeta

`Static`omitStorageMeta

`Static`pickClientMeta

`Static`sortByStorageMeta

`Static`toAllHashMap

`Static`toDataHashMap

`Static`toHashMap