npm - @xyo-network/sdk-js - Versions diffs - 3.15.8 → 3.15.10 - Mend

@xyo-network/sdk-js 3.15.8 → 3.15.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2560) hide show

package/docs/classes/BoundWitnessBuilder.md DELETED Viewed

@@ -1,1387 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / BoundWitnessBuilder
-# Class: BoundWitnessBuilder\<TBoundWitness, TPayload\>
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:9
-## Extends
-- [`PayloadBuilder`](PayloadBuilder.md)\<`TBoundWitness`, `Promise`\<\[[`Signed`](../type-aliases/Signed.md)\<`TBoundWitness`\>, `TPayload`[], [`ModuleError`](../type-aliases/ModuleError.md)[]\]\>\>
-## Extended by
-- [`QueryBoundWitnessBuilder`](QueryBoundWitnessBuilder.md)
-## Type Parameters
-### TBoundWitness
-`TBoundWitness` *extends* [`UnsignedBoundWitness`](../type-aliases/UnsignedBoundWitness.md) = [`UnsignedBoundWitness`](../type-aliases/UnsignedBoundWitness.md)
-### TPayload
-`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`AnyPayload`](../type-aliases/AnyPayload.md)
-## Constructors
-### Constructor
-> **new BoundWitnessBuilder**\<`TBoundWitness`, `TPayload`\>(`options?`): `BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:17
-#### Parameters
-##### options?
-`Omit`\<[`PayloadBuilderOptions`](../interfaces/PayloadBuilderOptions.md), `"schema"`\>
-#### Returns
-`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
-#### Overrides
-[`PayloadBuilder`](PayloadBuilder.md).[`constructor`](PayloadBuilder.md#constructor)
-## Properties
-### options
-> `readonly` **options**: [`PayloadBuilderOptions`](../interfaces/PayloadBuilderOptions.md)
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:8
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`options`](PayloadBuilder.md#options)
-## Methods
-### build()
-> **build**(): `Promise`\<\[[`Signed`](../type-aliases/Signed.md)\<`TBoundWitness`\>, `TPayload`[], [`ModuleError`](../type-aliases/ModuleError.md)[]\]\>
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:28
-#### Returns
-`Promise`\<\[[`Signed`](../type-aliases/Signed.md)\<`TBoundWitness`\>, `TPayload`[], [`ModuleError`](../type-aliases/ModuleError.md)[]\]\>
-#### Overrides
-[`PayloadBuilder`](PayloadBuilder.md).[`build`](PayloadBuilder.md#build)
-***
-### dataHash()
-> **dataHash**(): `Promise`\<`Lowercase`\<`string`\>\>
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:29
-#### Returns
-`Promise`\<`Lowercase`\<`string`\>\>
-***
-### dataHashableFields()
-> **dataHashableFields**(): `Promise`\<`any`\>
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:30
-#### Returns
-`Promise`\<`any`\>
-#### Overrides
-[`PayloadBuilder`](PayloadBuilder.md).[`dataHashableFields`](PayloadBuilder.md#datahashablefields)
-***
-### error()
-> **error**(`payload?`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:31
-#### Parameters
-##### payload?
-[`ModuleError`](../type-aliases/ModuleError.md)
-#### Returns
-`this`
-***
-### errors()
-> **errors**(`errors?`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:32
-#### Parameters
-##### errors?
-(`null` \| [`ModuleError`](../type-aliases/ModuleError.md))[]
-#### Returns
-`this`
-***
-### fields()
-> **fields**(`fields`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:33
-#### Parameters
-##### fields
-`DeepOmitStartsWith`\<`DeepOmitStartsWith`\<[`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`Omit`\<`TBoundWitness`, `"addresses"` \| `"payload_hashes"` \| `"payload_schemas"` \| `"previous_hashes"`\>\>, `"$"`\>\>
-#### Returns
-`this`
-#### Overrides
-[`PayloadBuilder`](PayloadBuilder.md).[`fields`](PayloadBuilder.md#fields)
-***
-### hashes()
-> **hashes**(`hashes`, `schema`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:34
-#### Parameters
-##### hashes
-`Lowercase`\<`string`\>[]
-##### schema
-`string`[]
-#### Returns
-`this`
-***
-### meta()
-> **meta**(`meta`): `this`
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:60
-#### Parameters
-##### meta
-`DeepPickStartsWith`\<`TBoundWitness`\>
-#### Returns
-`this`
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`meta`](PayloadBuilder.md#meta)
-***
-### payload()
-> **payload**(`payload?`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:35
-#### Parameters
-##### payload?
-`TPayload`
-#### Returns
-`this`
-***
-### payloads()
-> **payloads**(`payloads?`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:36
-#### Parameters
-##### payloads?
-(`null` \| `TPayload`)[]
-#### Returns
-`this`
-***
-### schema()
-> **schema**(`value`): `void`
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:61
-#### Parameters
-##### value
-`string`
-#### Returns
-`void`
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`schema`](PayloadBuilder.md#schema)
-***
-### signer()
-> **signer**(`account`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:37
-#### Parameters
-##### account
-`AccountInstance`
-#### Returns
-`this`
-***
-### signers()
-> **signers**(`accounts`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:38
-#### Parameters
-##### accounts
-`AccountInstance`[]
-#### Returns
-`this`
-***
-### sourceQuery()
-> **sourceQuery**(`sourceQuery`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:39
-#### Parameters
-##### sourceQuery
-`Lowercase`\<`string`\>
-#### Returns
-`this`
-***
-### ~~witness()~~
-> **witness**(`account`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:41
-#### Parameters
-##### account
-`AccountInstance`
-#### Returns
-`this`
-#### Deprecated
-use signer instead
-***
-### ~~witnesses()~~
-> **witnesses**(`accounts`): `this`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:43
-#### Parameters
-##### accounts
-`AccountInstance`[]
-#### Returns
-`this`
-#### Deprecated
-use signers instead
-***
-### addressIndex()
-> `static` **addressIndex**\<`T`\>(`payload`, `address`): `number`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:22
-#### Type Parameters
-##### T
-`T` *extends* [`BoundWitness`](../type-aliases/BoundWitness.md)
-#### Parameters
-##### payload
-`T`
-##### address
-`Lowercase`\<`string`\>
-#### Returns
-`number`
-***
-### addStorageMeta()
-#### Call Signature
-> `static` **addStorageMeta**\<`T`\>(`payload`, `index?`): `Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:13
-##### Type Parameters
-###### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-##### Parameters
-###### payload
-`T`
-###### index?
-`number`
-##### Returns
-`Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`addStorageMeta`](PayloadBuilder.md#addstoragemeta)
-#### Call Signature
-> `static` **addStorageMeta**\<`T`\>(`payloads`): `Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:14
-##### Type Parameters
-###### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-##### Parameters
-###### payloads
-`T`[]
-##### Returns
-`Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`addStorageMeta`](PayloadBuilder.md#addstoragemeta)
-***
-### compareStorageMeta()
-> `static` **compareStorageMeta**(`a`, `b`, `comparer?`): `number`
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:15
-#### Parameters
-##### a
-[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`Payload`](../type-aliases/Payload.md)\>
-##### b
-[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`Payload`](../type-aliases/Payload.md)\>
-##### comparer?
-`Compare`\<`Lowercase`\<`string`\>\>
-#### Returns
-`number`
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`compareStorageMeta`](PayloadBuilder.md#comparestoragemeta)
-***
-### dataHash()
-> `static` **dataHash**\<`T`\>(`payload`): `Promise`\<`Lowercase`\<`string`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:16
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payload
-`T`
-#### Returns
-`Promise`\<`Lowercase`\<`string`\>\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`dataHash`](PayloadBuilder.md#datahash)
-***
-### dataHashableFields()
-> `static` **dataHashableFields**\<`T`\>(`schema`, `payload`): `Promisable`\<[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:18
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### schema
-`string`
-##### payload
-[`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`T`\>
-#### Returns
-`Promisable`\<[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`dataHashableFields`](PayloadBuilder.md#datahashablefields-2)
-***
-### dataHashes()
-#### Call Signature
-> `static` **dataHashes**(`payloads`): `Promise`\<`undefined`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:19
-##### Parameters
-###### payloads
-`undefined`
-##### Returns
-`Promise`\<`undefined`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`dataHashes`](PayloadBuilder.md#datahashes)
-#### Call Signature
-> `static` **dataHashes**\<`T`\>(`payloads`): `Promise`\<`Lowercase`\<`string`\>[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:20
-##### Type Parameters
-###### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-##### Parameters
-###### payloads
-`T`[]
-##### Returns
-`Promise`\<`Lowercase`\<`string`\>[]\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`dataHashes`](PayloadBuilder.md#datahashes)
-***
-### dataHashPairs()
-> `static` **dataHashPairs**\<`T`\>(`payloads`): `Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:17
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`T`[]
-#### Returns
-`Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`dataHashPairs`](PayloadBuilder.md#datahashpairs)
-***
-### filterExclude()
-> `static` **filterExclude**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:21
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`undefined` | `T`[]
-##### hash
-`Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`filterExclude`](PayloadBuilder.md#filterexclude)
-***
-### filterExcludeByDataHash()
-> `static` **filterExcludeByDataHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:22
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`undefined` | `T`[]
-##### hash
-`Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`filterExcludeByDataHash`](PayloadBuilder.md#filterexcludebydatahash)
-***
-### filterIncludeByDataHash()
-> `static` **filterIncludeByDataHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:23
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`undefined` | `T`[]
-##### hash
-`Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`filterIncludeByDataHash`](PayloadBuilder.md#filterincludebydatahash)
-***
-### filterIncludeByEitherHash()
-> `static` **filterIncludeByEitherHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:24
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`undefined` | `T`[]
-##### hash
-`Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`filterIncludeByEitherHash`](PayloadBuilder.md#filterincludebyeitherhash)
-***
-### findByDataHash()
-> `static` **findByDataHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`undefined` \| `T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:25
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`undefined` | `T`[]
-##### hash
-`Lowercase`\<`string`\>
-#### Returns
-`Promise`\<`undefined` \| `T`\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`findByDataHash`](PayloadBuilder.md#findbydatahash)
-***
-### hash()
-> `static` **hash**\<`T`\>(`payload`): `Promise`\<`Lowercase`\<`string`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:26
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payload
-`T`
-#### Returns
-`Promise`\<`Lowercase`\<`string`\>\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`hash`](PayloadBuilder.md#hash)
-***
-### hashableFields()
-> `static` **hashableFields**\<`T`\>(`payload`): [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:33
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payload
-`T`
-#### Returns
-[`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`hashableFields`](PayloadBuilder.md#hashablefields)
-***
-### hashes()
-#### Call Signature
-> `static` **hashes**(`payloads`): `Promise`\<`undefined`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:34
-##### Parameters
-###### payloads
-`undefined`
-##### Returns
-`Promise`\<`undefined`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`hashes`](PayloadBuilder.md#hashes)
-#### Call Signature
-> `static` **hashes**\<`T`\>(`payloads`): `Promise`\<`Lowercase`\<`string`\>[]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:35
-##### Type Parameters
-###### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-##### Parameters
-###### payloads
-`T`[]
-##### Returns
-`Promise`\<`Lowercase`\<`string`\>[]\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`hashes`](PayloadBuilder.md#hashes)
-***
-### hashPairs()
-> `static` **hashPairs**\<`T`\>(`payloads`): `Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:32
-Creates an array of payload/hash tuples based on the payloads passed in
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`T`[]
-#### Returns
-`Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
-An array of payload/hash tuples
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`hashPairs`](PayloadBuilder.md#hashpairs)
-***
-### omitClientMeta()
-#### Call Signature
-> `static` **omitClientMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:36
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payload
-`T`
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitClientMeta`](PayloadBuilder.md#omitclientmeta)
-#### Call Signature
-> `static` **omitClientMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>[]
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:37
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payloads
-`T`[]
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>[]
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitClientMeta`](PayloadBuilder.md#omitclientmeta)
-***
-### omitMeta()
-#### Call Signature
-> `static` **omitMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:38
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payload
-`T`
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitMeta`](PayloadBuilder.md#omitmeta)
-#### Call Signature
-> `static` **omitMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>[]
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:39
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payloads
-`T`[]
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>[]
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitMeta`](PayloadBuilder.md#omitmeta)
-***
-### omitPrivateStorageMeta()
-#### Call Signature
-> `static` **omitPrivateStorageMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:40
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payload
-`T`
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitPrivateStorageMeta`](PayloadBuilder.md#omitprivatestoragemeta)
-#### Call Signature
-> `static` **omitPrivateStorageMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>[]
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:41
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payloads
-`T`[]
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>[]
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitPrivateStorageMeta`](PayloadBuilder.md#omitprivatestoragemeta)
-***
-### omitStorageMeta()
-#### Call Signature
-> `static` **omitStorageMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:42
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payload
-`T`
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitStorageMeta`](PayloadBuilder.md#omitstoragemeta)
-#### Call Signature
-> `static` **omitStorageMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>[]
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:43
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payloads
-`T`[]
-###### maxDepth?
-`number`
-##### Returns
-[`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>[]
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`omitStorageMeta`](PayloadBuilder.md#omitstoragemeta)
-***
-### pickClientMeta()
-#### Call Signature
-> `static` **pickClientMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:44
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payload
-`T`
-###### maxDepth?
-`number`
-##### Returns
-[`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`pickClientMeta`](PayloadBuilder.md#pickclientmeta)
-#### Call Signature
-> `static` **pickClientMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>[]
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:45
-##### Type Parameters
-###### T
-`T` *extends* `object`
-##### Parameters
-###### payloads
-`T`[]
-###### maxDepth?
-`number`
-##### Returns
-[`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>[]
-##### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`pickClientMeta`](PayloadBuilder.md#pickclientmeta)
-***
-### previousHash()
-> `static` **previousHash**\<`T`\>(`boundWitness`, `address`): `undefined` \| `string`
-Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:23
-#### Type Parameters
-##### T
-`T` *extends* [`BoundWitness`](../type-aliases/BoundWitness.md)
-#### Parameters
-##### boundWitness
-`T`
-##### address
-`Lowercase`\<`string`\>
-#### Returns
-`undefined` \| `string`
-***
-### sortByStorageMeta()
-> `static` **sortByStorageMeta**\<`T`\>(`payloads`, `direction?`, `comparer?`): [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:46
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]
-##### direction?
-`1` | `-1`
-##### comparer?
-`Compare`\<`Lowercase`\<`string`\>\>
-#### Returns
-[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`sortByStorageMeta`](PayloadBuilder.md#sortbystoragemeta)
-***
-### toAllHashMap()
-> `static` **toAllHashMap**\<`T`\>(`payloads`): `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:47
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### payloads
-`T`[]
-#### Returns
-`Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`toAllHashMap`](PayloadBuilder.md#toallhashmap)
-***
-### toDataHashMap()
-> `static` **toDataHashMap**\<`T`\>(`objs`): `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:48
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### objs
-`T`[]
-#### Returns
-`Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`toDataHashMap`](PayloadBuilder.md#todatahashmap)
-***
-### toHashMap()
-> `static` **toHashMap**\<`T`\>(`objs`): `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
-Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:54
-Creates an object map of payload hashes to payloads based on the payloads passed in
-#### Type Parameters
-##### T
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-#### Parameters
-##### objs
-`T`[]
-Any array of payloads
-#### Returns
-`Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
-A map of hashes to payloads
-#### Inherited from
-[`PayloadBuilder`](PayloadBuilder.md).[`toHashMap`](PayloadBuilder.md#tohashmap)