@xyo-network/boundwitness-builder 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,4105 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/boundwitness-builder
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__boundwitness-builder)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### protocol
+
+    ### packages
+
+      ### boundwitness
+
+        ### packages
+
+          ### builder
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="BoundWitnessBuilder"></a>BoundWitnessBuilder
+
+[**@xyo-network/boundwitness-builder**](#../README)
+
+***
+
+## Extends
+
+- `PayloadBuilder`\<`TBoundWitness`, `Promise`\<\[`PossiblySigned`\<`TBoundWitness`\>, `TPayload`[], `ModuleError`[]\]\>\>
+
+## Extended by
+
+- [`QueryBoundWitnessBuilder`](#QueryBoundWitnessBuilder)
+
+## Type Parameters
+
+### TBoundWitness
+
+`TBoundWitness` *extends* `BoundWitness` = `BoundWitness`
+
+### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+## Constructors
+
+### Constructor
+
+```ts
+new BoundWitnessBuilder<TBoundWitness, TPayload>(options?): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### options?
+
+`Omit`\<`PayloadBuilderOptions`, `"schema"`\>
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+### Overrides
+
+```ts
+PayloadBuilder<
+    TBoundWitness,
+    Promise<[PossiblySigned<TBoundWitness>, TPayload[], ModuleError[]]>
+  >.constructor
+```
+
+## Properties
+
+### options
+
+```ts
+readonly options: PayloadBuilderOptions;
+```
+
+### Inherited from
+
+[`QueryBoundWitnessBuilder`](#QueryBoundWitnessBuilder).[`options`](QueryBoundWitnessBuilder.md#options)
+
+***
+
+### \_fields?
+
+```ts
+protected optional _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<TBoundWitness>>>;
+```
+
+### Inherited from
+
+```ts
+PayloadBuilder._fields
+```
+
+***
+
+### \_meta?
+
+```ts
+protected optional _meta?: DeepPickStartsWith<TBoundWitness, "$">;
+```
+
+### Inherited from
+
+```ts
+PayloadBuilder._meta
+```
+
+***
+
+### \_schema
+
+```ts
+protected _schema: Schema;
+```
+
+### Inherited from
+
+```ts
+PayloadBuilder._schema
+```
+
+## Accessors
+
+### addresses
+
+### Get Signature
+
+```ts
+get protected addresses(): BrandedAddress[];
+```
+
+#### Returns
+
+`BrandedAddress`[]
+
+***
+
+### payloadSchemas
+
+### Get Signature
+
+```ts
+get protected payloadSchemas(): string[];
+```
+
+#### Returns
+
+`string`[]
+
+***
+
+### previousHashBytes
+
+### Get Signature
+
+```ts
+get protected previousHashBytes(): (ArrayBufferLike | null)[];
+```
+
+#### Returns
+
+(`ArrayBufferLike` \| `null`)[]
+
+***
+
+### previousHashes
+
+### Get Signature
+
+```ts
+get protected previousHashes(): (BrandedHash | null)[];
+```
+
+#### Returns
+
+(`BrandedHash` \| `null`)[]
+
+## Methods
+
+### addressIndex()
+
+```ts
+static addressIndex<T>(payload, address): number;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`number`
+
+***
+
+### previousHash()
+
+```ts
+static previousHash<T>(boundWitness, address): string | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### boundWitness
+
+`T`
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`string` \| `undefined`
+
+***
+
+### linkingFields()
+
+```ts
+protected static linkingFields<T>(accounts, payloads?): Promise<Pick<T, "addresses" | "payload_hashes" | "payload_schemas" | "previous_hashes">>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+#### payloads?
+
+`Payload`[]
+
+### Returns
+
+`Promise`\<`Pick`\<`T`, `"addresses"` \| `"payload_hashes"` \| `"payload_schemas"` \| `"previous_hashes"`\>\>
+
+***
+
+### signature()
+
+```ts
+protected static signature<T>(payload, address): BrandedHex | null;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`BrandedHex` \| `null`
+
+***
+
+### signatures()
+
+```ts
+protected static signatures(accounts, dataHash): Promise<string[]>;
+```
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+#### dataHash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`string`[]\>
+
+***
+
+### build()
+
+### Call Signature
+
+```ts
+build(): Promise<[Signed<TBoundWitness>, TPayload[], ModuleError[]]>;
+```
+
+#### Returns
+
+`Promise`\<\[`Signed`\<`TBoundWitness`\>, `TPayload`[], `ModuleError`[]\]\>
+
+#### Overrides
+
+```ts
+PayloadBuilder.build
+```
+
+### Call Signature
+
+```ts
+build(sign): Promise<[Unsigned<TBoundWitness>, TPayload[], ModuleError[]]>;
+```
+
+#### Parameters
+
+##### sign
+
+`false`
+
+#### Returns
+
+`Promise`\<\[`Unsigned`\<`TBoundWitness`\>, `TPayload`[], `ModuleError`[]\]\>
+
+#### Overrides
+
+```ts
+PayloadBuilder.build
+```
+
+### Call Signature
+
+```ts
+build(sign): Promise<[Signed<TBoundWitness>, TPayload[], ModuleError[]]>;
+```
+
+#### Parameters
+
+##### sign
+
+`true`
+
+#### Returns
+
+`Promise`\<\[`Signed`\<`TBoundWitness`\>, `TPayload`[], `ModuleError`[]\]\>
+
+#### Overrides
+
+```ts
+PayloadBuilder.build
+```
+
+***
+
+### dataHash()
+
+```ts
+dataHash(): Promise<BrandedHash>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+***
+
+### dataHashableFields()
+
+```ts
+dataHashableFields(): Promise<WithoutMeta<TBoundWitness>>;
+```
+
+### Returns
+
+`Promise`\<`WithoutMeta`\<`TBoundWitness`\>\>
+
+### Overrides
+
+```ts
+PayloadBuilder.dataHashableFields
+```
+
+***
+
+### error()
+
+```ts
+error(payload?): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### payload?
+
+`ModuleError`
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### errors()
+
+```ts
+errors(errors?): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### errors?
+
+(`ModuleError` \| `null`)[]
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### fields()
+
+```ts
+fields(fields): this;
+```
+
+### Parameters
+
+#### fields
+
+`WithoutSchema`\<`Omit`\<`WithoutStorageMeta`\<`WithoutClientMeta`\<`TBoundWitness`\>\>, `"addresses"` \| `"payload_hashes"` \| `"payload_schemas"` \| `"previous_hashes"`\>\>
+
+### Returns
+
+`this`
+
+### Overrides
+
+```ts
+PayloadBuilder.fields
+```
+
+***
+
+### hashes()
+
+```ts
+hashes(hashes, schema): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### hashes
+
+`BrandedHash`[]
+
+#### schema
+
+`Schema`[]
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### payload()
+
+```ts
+payload(payload?): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### payload?
+
+`TPayload`
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### payloads()
+
+```ts
+payloads(payloads?): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### payloads?
+
+(`TPayload` \| `null`)[]
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### signer()
+
+```ts
+signer(account): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### signers()
+
+```ts
+signers(accounts): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### sourceQuery()
+
+```ts
+sourceQuery(sourceQuery): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### sourceQuery
+
+`BrandedHash`
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+***
+
+### ~~witness()~~
+
+```ts
+witness(account): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+### Deprecated
+
+use signer instead
+
+***
+
+### ~~witnesses()~~
+
+```ts
+witnesses(accounts): BoundWitnessBuilder<TBoundWitness, TPayload>;
+```
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+### Returns
+
+`BoundWitnessBuilder`\<`TBoundWitness`, `TPayload`\>
+
+### Deprecated
+
+use signers instead
+
+***
+
+### sign()
+
+```ts
+protected sign(): Promise<BrandedHex[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHex`[]\>
+
+***
+
+### addHashMeta()
+
+### Call Signature
+
+```ts
+static addHashMeta<T>(payload): Promise<WithHashMeta<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+#### Returns
+
+`Promise`\<`WithHashMeta`\<`T`\>\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.addHashMeta
+```
+
+### Call Signature
+
+```ts
+static addHashMeta<T>(payloads): Promise<WithHashMeta<T>[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`WithHashMeta`\<`T`\>[]\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.addHashMeta
+```
+
+***
+
+### addStorageMeta()
+
+### Call Signature
+
+```ts
+static addStorageMeta<T>(payload, index?): Promise<WithStorageMeta<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### index?
+
+`number`
+
+#### Returns
+
+`Promise`\<`WithStorageMeta`\<`T`\>\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.addStorageMeta
+```
+
+### Call Signature
+
+```ts
+static addStorageMeta<T>(payloads): Promise<WithStorageMeta<T>[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`WithStorageMeta`\<`T`\>[]\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.addStorageMeta
+```
+
+***
+
+### compareStorageMeta()
+
+```ts
+static compareStorageMeta(
+   a, 
+   b, 
+   comparer?): number;
+```
+
+### Parameters
+
+#### a
+
+`WithStorageMeta`\<`Payload`\>
+
+#### b
+
+`WithStorageMeta`\<`Payload`\>
+
+#### comparer?
+
+`Compare`\<`Sequence`\>
+
+### Returns
+
+`number`
+
+### Inherited from
+
+```ts
+PayloadBuilder.compareStorageMeta
+```
+
+***
+
+### dataHash()
+
+```ts
+static dataHash<T>(payload): Promise<BrandedHash>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.dataHash
+```
+
+***
+
+### dataHashPairs()
+
+```ts
+static dataHashPairs<T>(payloads): Promise<[T, BrandedHash][]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[]
+
+### Returns
+
+`Promise`\<\[`T`, `BrandedHash`\][]\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.dataHashPairs
+```
+
+***
+
+### dataHashableFields()
+
+```ts
+static dataHashableFields<T>(schema, payload): Promisable<WithoutMeta<T>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### schema
+
+`Schema`
+
+#### payload
+
+`WithoutSchema`\<`T`\>
+
+### Returns
+
+`Promisable`\<`WithoutMeta`\<`T`\>\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.dataHashableFields
+```
+
+***
+
+### dataHashes()
+
+### Call Signature
+
+```ts
+static dataHashes(payloads): Promise<undefined>;
+```
+
+#### Parameters
+
+##### payloads
+
+`undefined`
+
+#### Returns
+
+`Promise`\<`undefined`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.dataHashes
+```
+
+### Call Signature
+
+```ts
+static dataHashes<T>(payloads): Promise<BrandedHash[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`BrandedHash`[]\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.dataHashes
+```
+
+***
+
+### filterExclude()
+
+```ts
+static filterExclude<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.filterExclude
+```
+
+***
+
+### filterExcludeByDataHash()
+
+```ts
+static filterExcludeByDataHash<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.filterExcludeByDataHash
+```
+
+***
+
+### filterIncludeByDataHash()
+
+```ts
+static filterIncludeByDataHash<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.filterIncludeByDataHash
+```
+
+***
+
+### filterIncludeByEitherHash()
+
+```ts
+static filterIncludeByEitherHash<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.filterIncludeByEitherHash
+```
+
+***
+
+### findByDataHash()
+
+```ts
+static findByDataHash<T>(payloads, hash): Promise<T | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.findByDataHash
+```
+
+***
+
+### hash()
+
+```ts
+static hash<T>(payload): Promise<BrandedHash>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.hash
+```
+
+***
+
+### hashPairs()
+
+```ts
+static hashPairs<T>(payloads): Promise<[T, BrandedHash][]>;
+```
+
+Creates an array of payload/hash tuples based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[]
+
+### Returns
+
+`Promise`\<\[`T`, `BrandedHash`\][]\>
+
+An array of payload/hash tuples
+
+### Inherited from
+
+```ts
+PayloadBuilder.hashPairs
+```
+
+***
+
+### hashableFields()
+
+```ts
+static hashableFields<T>(payload): WithoutStorageMeta<T>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`WithoutStorageMeta`\<`T`\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.hashableFields
+```
+
+***
+
+### hashes()
+
+### Call Signature
+
+```ts
+static hashes(payloads): Promise<undefined>;
+```
+
+#### Parameters
+
+##### payloads
+
+`undefined`
+
+#### Returns
+
+`Promise`\<`undefined`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.hashes
+```
+
+### Call Signature
+
+```ts
+static hashes<T>(payloads): Promise<BrandedHash[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`BrandedHash`[]\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.hashes
+```
+
+***
+
+### omitClientMeta()
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitClientMeta
+```
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitClientMeta
+```
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitClientMeta
+```
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitClientMeta
+```
+
+***
+
+### omitMeta()
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitMeta
+```
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitMeta
+```
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitMeta
+```
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitMeta
+```
+
+***
+
+### omitPrivateStorageMeta()
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitPrivateStorageMeta
+```
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitPrivateStorageMeta
+```
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitPrivateStorageMeta
+```
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitPrivateStorageMeta
+```
+
+***
+
+### omitStorageMeta()
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`[]
+
+#### Parameters
+
+##### payloads
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\[`number`\]\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitStorageMeta
+```
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`[]
+
+#### Parameters
+
+##### payloads
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\[`number`\]\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitStorageMeta
+```
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitStorageMeta
+```
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.omitStorageMeta
+```
+
+***
+
+### pickClientMeta()
+
+### Call Signature
+
+```ts
+static pickClientMeta<T>(payloads, maxDepth?): WithOnlyClientMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithOnlyClientMeta`\<`T`\>[]
+
+#### Inherited from
+
+```ts
+PayloadBuilder.pickClientMeta
+```
+
+### Call Signature
+
+```ts
+static pickClientMeta<T>(payload, maxDepth?): WithOnlyClientMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithOnlyClientMeta`\<`T`\>
+
+#### Inherited from
+
+```ts
+PayloadBuilder.pickClientMeta
+```
+
+***
+
+### sortByStorageMeta()
+
+```ts
+static sortByStorageMeta<T>(
+   payloads, 
+   direction?, 
+   comparer?): WithStorageMeta<T>[];
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`WithStorageMeta`\<`T`\>[]
+
+#### direction?
+
+`1` \| `-1`
+
+#### comparer?
+
+`Compare`\<`Sequence`\>
+
+### Returns
+
+`WithStorageMeta`\<`T`\>[]
+
+### Inherited from
+
+```ts
+PayloadBuilder.sortByStorageMeta
+```
+
+***
+
+### toAllHashMap()
+
+```ts
+static toAllHashMap<T>(payloads): Promise<Record<BrandedHash, T>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[]
+
+### Returns
+
+`Promise`\<`Record`\<`BrandedHash`, `T`\>\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.toAllHashMap
+```
+
+***
+
+### toDataHashMap()
+
+```ts
+static toDataHashMap<T>(objs): Promise<Record<BrandedHash, T>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### objs
+
+`T`[]
+
+### Returns
+
+`Promise`\<`Record`\<`BrandedHash`, `T`\>\>
+
+### Inherited from
+
+```ts
+PayloadBuilder.toDataHashMap
+```
+
+***
+
+### toHashMap()
+
+```ts
+static toHashMap<T>(objs): Promise<Record<BrandedHash, T>>;
+```
+
+Creates an object map of payload hashes to payloads based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### objs
+
+`T`[]
+
+Any array of payloads
+
+### Returns
+
+`Promise`\<`Record`\<`BrandedHash`, `T`\>\>
+
+A map of hashes to payloads
+
+### Inherited from
+
+```ts
+PayloadBuilder.toHashMap
+```
+
+***
+
+### meta()
+
+```ts
+meta(meta): this;
+```
+
+### Parameters
+
+#### meta
+
+`DeepPickStartsWith`\<`TBoundWitness`\>
+
+### Returns
+
+`this`
+
+### Inherited from
+
+```ts
+PayloadBuilder.meta
+```
+
+***
+
+### schema()
+
+```ts
+schema(value): void;
+```
+
+### Parameters
+
+#### value
+
+`Schema`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+PayloadBuilder.schema
+```
+
+                ### <a id="QueryBoundWitnessBuilder"></a>QueryBoundWitnessBuilder
+
+[**@xyo-network/boundwitness-builder**](#../README)
+
+***
+
+## Extends
+
+- [`BoundWitnessBuilder`](#BoundWitnessBuilder)\<`TBoundWitness`\>
+
+## Type Parameters
+
+### TBoundWitness
+
+`TBoundWitness` *extends* `QueryBoundWitness` = `QueryBoundWitness`
+
+### TQuery
+
+`TQuery` *extends* `Query` = `Query`
+
+## Constructors
+
+### Constructor
+
+```ts
+new QueryBoundWitnessBuilder<TBoundWitness, TQuery>(options?): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### options?
+
+`Omit`\<`PayloadBuilderOptions`, `"schema"`\>
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`constructor`](BoundWitnessBuilder.md#constructor)
+
+## Properties
+
+### options
+
+```ts
+readonly options: PayloadBuilderOptions;
+```
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`options`](BoundWitnessBuilder.md#options)
+
+***
+
+### \_fields?
+
+```ts
+protected optional _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<TBoundWitness>>>;
+```
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`_fields`](BoundWitnessBuilder.md#_fields)
+
+***
+
+### \_meta?
+
+```ts
+protected optional _meta?: DeepPickStartsWith<TBoundWitness, "$">;
+```
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`_meta`](BoundWitnessBuilder.md#_meta)
+
+***
+
+### \_schema
+
+```ts
+protected _schema: Schema;
+```
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`_schema`](BoundWitnessBuilder.md#_schema)
+
+## Accessors
+
+### addresses
+
+### Get Signature
+
+```ts
+get protected addresses(): BrandedAddress[];
+```
+
+#### Returns
+
+`BrandedAddress`[]
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`addresses`](BoundWitnessBuilder.md#addresses)
+
+***
+
+### payloadSchemas
+
+### Get Signature
+
+```ts
+get protected payloadSchemas(): string[];
+```
+
+#### Returns
+
+`string`[]
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`payloadSchemas`](BoundWitnessBuilder.md#payloadschemas)
+
+***
+
+### previousHashBytes
+
+### Get Signature
+
+```ts
+get protected previousHashBytes(): (ArrayBufferLike | null)[];
+```
+
+#### Returns
+
+(`ArrayBufferLike` \| `null`)[]
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`previousHashBytes`](BoundWitnessBuilder.md#previoushashbytes)
+
+***
+
+### previousHashes
+
+### Get Signature
+
+```ts
+get protected previousHashes(): (BrandedHash | null)[];
+```
+
+#### Returns
+
+(`BrandedHash` \| `null`)[]
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`previousHashes`](BoundWitnessBuilder.md#previoushashes)
+
+## Methods
+
+### addressIndex()
+
+```ts
+static addressIndex<T>(payload, address): number;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`number`
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`addressIndex`](BoundWitnessBuilder.md#addressindex)
+
+***
+
+### previousHash()
+
+```ts
+static previousHash<T>(boundWitness, address): string | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### boundWitness
+
+`T`
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`string` \| `undefined`
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`previousHash`](BoundWitnessBuilder.md#previoushash)
+
+***
+
+### linkingFields()
+
+```ts
+protected static linkingFields<T>(accounts, payloads?): Promise<Pick<T, "addresses" | "payload_hashes" | "payload_schemas" | "previous_hashes">>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+#### payloads?
+
+`Payload`[]
+
+### Returns
+
+`Promise`\<`Pick`\<`T`, `"addresses"` \| `"payload_hashes"` \| `"payload_schemas"` \| `"previous_hashes"`\>\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`linkingFields`](BoundWitnessBuilder.md#linkingfields)
+
+***
+
+### signature()
+
+```ts
+protected static signature<T>(payload, address): BrandedHex | null;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`BrandedHex` \| `null`
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`signature`](BoundWitnessBuilder.md#signature)
+
+***
+
+### signatures()
+
+```ts
+protected static signatures(accounts, dataHash): Promise<string[]>;
+```
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+#### dataHash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`string`[]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`signatures`](BoundWitnessBuilder.md#signatures)
+
+***
+
+### build()
+
+### Call Signature
+
+```ts
+build(): Promise<[Signed<TBoundWitness>, Payload[], ModuleError[]]>;
+```
+
+#### Returns
+
+`Promise`\<\[`Signed`\<`TBoundWitness`\>, `Payload`[], `ModuleError`[]\]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`build`](BoundWitnessBuilder.md#build)
+
+### Call Signature
+
+```ts
+build(sign): Promise<[Unsigned<TBoundWitness>, Payload[], ModuleError[]]>;
+```
+
+#### Parameters
+
+##### sign
+
+`false`
+
+#### Returns
+
+`Promise`\<\[`Unsigned`\<`TBoundWitness`\>, `Payload`[], `ModuleError`[]\]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`build`](BoundWitnessBuilder.md#build)
+
+### Call Signature
+
+```ts
+build(sign): Promise<[Signed<TBoundWitness>, Payload[], ModuleError[]]>;
+```
+
+#### Parameters
+
+##### sign
+
+`true`
+
+#### Returns
+
+`Promise`\<\[`Signed`\<`TBoundWitness`\>, `Payload`[], `ModuleError`[]\]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`build`](BoundWitnessBuilder.md#build)
+
+***
+
+### dataHash()
+
+```ts
+dataHash(): Promise<BrandedHash>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHash`](BoundWitnessBuilder.md#datahash)
+
+***
+
+### error()
+
+```ts
+error(payload?): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### payload?
+
+`ModuleError`
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`error`](BoundWitnessBuilder.md#error)
+
+***
+
+### errors()
+
+```ts
+errors(errors?): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### errors?
+
+(`ModuleError` \| `null`)[]
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`errors`](BoundWitnessBuilder.md#errors)
+
+***
+
+### fields()
+
+```ts
+fields(fields): this;
+```
+
+### Parameters
+
+#### fields
+
+`WithoutSchema`\<`Omit`\<`WithoutStorageMeta`\<`WithoutClientMeta`\<`TBoundWitness`\>\>, `"addresses"` \| `"payload_hashes"` \| `"payload_schemas"` \| `"previous_hashes"`\>\>
+
+### Returns
+
+`this`
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`fields`](BoundWitnessBuilder.md#fields)
+
+***
+
+### hashes()
+
+```ts
+hashes(hashes, schema): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### hashes
+
+`BrandedHash`[]
+
+#### schema
+
+`Schema`[]
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`hashes`](BoundWitnessBuilder.md#hashes)
+
+***
+
+### payload()
+
+```ts
+payload(payload?): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### payload?
+
+`Payload`
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`payload`](BoundWitnessBuilder.md#payload)
+
+***
+
+### payloads()
+
+```ts
+payloads(payloads?): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### payloads?
+
+(`Payload` \| `null`)[]
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`payloads`](BoundWitnessBuilder.md#payloads)
+
+***
+
+### signer()
+
+```ts
+signer(account): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`signer`](BoundWitnessBuilder.md#signer)
+
+***
+
+### signers()
+
+```ts
+signers(accounts): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`signers`](BoundWitnessBuilder.md#signers)
+
+***
+
+### sourceQuery()
+
+```ts
+sourceQuery(sourceQuery): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### sourceQuery
+
+`BrandedHash`
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`sourceQuery`](BoundWitnessBuilder.md#sourcequery)
+
+***
+
+### ~~witness()~~
+
+```ts
+witness(account): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Deprecated
+
+use signer instead
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`witness`](BoundWitnessBuilder.md#witness)
+
+***
+
+### ~~witnesses()~~
+
+```ts
+witnesses(accounts): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Parameters
+
+#### accounts
+
+`AccountInstance`[]
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+### Deprecated
+
+use signers instead
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`witnesses`](BoundWitnessBuilder.md#witnesses)
+
+***
+
+### sign()
+
+```ts
+protected sign(): Promise<BrandedHex[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHex`[]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`sign`](BoundWitnessBuilder.md#sign)
+
+***
+
+### dataHashableFields()
+
+```ts
+dataHashableFields(): Promise<WithoutMeta<TBoundWitness>>;
+```
+
+### Returns
+
+`Promise`\<`WithoutMeta`\<`TBoundWitness`\>\>
+
+### Overrides
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHashableFields`](BoundWitnessBuilder.md#datahashablefields)
+
+***
+
+### query()
+
+```ts
+query<T>(query): QueryBoundWitnessBuilder<TBoundWitness, TQuery>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Query`
+
+### Parameters
+
+#### query
+
+`T`
+
+### Returns
+
+`QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
+
+***
+
+### addHashMeta()
+
+### Call Signature
+
+```ts
+static addHashMeta<T>(payload): Promise<WithHashMeta<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+#### Returns
+
+`Promise`\<`WithHashMeta`\<`T`\>\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`addHashMeta`](BoundWitnessBuilder.md#addhashmeta)
+
+### Call Signature
+
+```ts
+static addHashMeta<T>(payloads): Promise<WithHashMeta<T>[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`WithHashMeta`\<`T`\>[]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`addHashMeta`](BoundWitnessBuilder.md#addhashmeta)
+
+***
+
+### addStorageMeta()
+
+### Call Signature
+
+```ts
+static addStorageMeta<T>(payload, index?): Promise<WithStorageMeta<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### index?
+
+`number`
+
+#### Returns
+
+`Promise`\<`WithStorageMeta`\<`T`\>\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`addStorageMeta`](BoundWitnessBuilder.md#addstoragemeta)
+
+### Call Signature
+
+```ts
+static addStorageMeta<T>(payloads): Promise<WithStorageMeta<T>[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`WithStorageMeta`\<`T`\>[]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`addStorageMeta`](BoundWitnessBuilder.md#addstoragemeta)
+
+***
+
+### compareStorageMeta()
+
+```ts
+static compareStorageMeta(
+   a, 
+   b, 
+   comparer?): number;
+```
+
+### Parameters
+
+#### a
+
+`WithStorageMeta`\<`Payload`\>
+
+#### b
+
+`WithStorageMeta`\<`Payload`\>
+
+#### comparer?
+
+`Compare`\<`Sequence`\>
+
+### Returns
+
+`number`
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`compareStorageMeta`](BoundWitnessBuilder.md#comparestoragemeta)
+
+***
+
+### dataHash()
+
+```ts
+static dataHash<T>(payload): Promise<BrandedHash>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHash`](BoundWitnessBuilder.md#datahash-1)
+
+***
+
+### dataHashPairs()
+
+```ts
+static dataHashPairs<T>(payloads): Promise<[T, BrandedHash][]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[]
+
+### Returns
+
+`Promise`\<\[`T`, `BrandedHash`\][]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHashPairs`](BoundWitnessBuilder.md#datahashpairs)
+
+***
+
+### dataHashableFields()
+
+```ts
+static dataHashableFields<T>(schema, payload): Promisable<WithoutMeta<T>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### schema
+
+`Schema`
+
+#### payload
+
+`WithoutSchema`\<`T`\>
+
+### Returns
+
+`Promisable`\<`WithoutMeta`\<`T`\>\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHashableFields`](BoundWitnessBuilder.md#datahashablefields-1)
+
+***
+
+### dataHashes()
+
+### Call Signature
+
+```ts
+static dataHashes(payloads): Promise<undefined>;
+```
+
+#### Parameters
+
+##### payloads
+
+`undefined`
+
+#### Returns
+
+`Promise`\<`undefined`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHashes`](BoundWitnessBuilder.md#datahashes)
+
+### Call Signature
+
+```ts
+static dataHashes<T>(payloads): Promise<BrandedHash[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`BrandedHash`[]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`dataHashes`](BoundWitnessBuilder.md#datahashes)
+
+***
+
+### filterExclude()
+
+```ts
+static filterExclude<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`filterExclude`](BoundWitnessBuilder.md#filterexclude)
+
+***
+
+### filterExcludeByDataHash()
+
+```ts
+static filterExcludeByDataHash<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`filterExcludeByDataHash`](BoundWitnessBuilder.md#filterexcludebydatahash)
+
+***
+
+### filterIncludeByDataHash()
+
+```ts
+static filterIncludeByDataHash<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`filterIncludeByDataHash`](BoundWitnessBuilder.md#filterincludebydatahash)
+
+***
+
+### filterIncludeByEitherHash()
+
+```ts
+static filterIncludeByEitherHash<T>(payloads, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`filterIncludeByEitherHash`](BoundWitnessBuilder.md#filterincludebyeitherhash)
+
+***
+
+### findByDataHash()
+
+```ts
+static findByDataHash<T>(payloads, hash): Promise<T | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[] \| `undefined`
+
+#### hash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`findByDataHash`](BoundWitnessBuilder.md#findbydatahash)
+
+***
+
+### hash()
+
+```ts
+static hash<T>(payload): Promise<BrandedHash>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`hash`](BoundWitnessBuilder.md#hash)
+
+***
+
+### hashPairs()
+
+```ts
+static hashPairs<T>(payloads): Promise<[T, BrandedHash][]>;
+```
+
+Creates an array of payload/hash tuples based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[]
+
+### Returns
+
+`Promise`\<\[`T`, `BrandedHash`\][]\>
+
+An array of payload/hash tuples
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`hashPairs`](BoundWitnessBuilder.md#hashpairs)
+
+***
+
+### hashableFields()
+
+```ts
+static hashableFields<T>(payload): WithoutStorageMeta<T>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`WithoutStorageMeta`\<`T`\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`hashableFields`](BoundWitnessBuilder.md#hashablefields)
+
+***
+
+### hashes()
+
+### Call Signature
+
+```ts
+static hashes(payloads): Promise<undefined>;
+```
+
+#### Parameters
+
+##### payloads
+
+`undefined`
+
+#### Returns
+
+`Promise`\<`undefined`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`hashes`](BoundWitnessBuilder.md#hashes-1)
+
+### Call Signature
+
+```ts
+static hashes<T>(payloads): Promise<BrandedHash[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+#### Returns
+
+`Promise`\<`BrandedHash`[]\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`hashes`](BoundWitnessBuilder.md#hashes-1)
+
+***
+
+### omitClientMeta()
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitClientMeta`](BoundWitnessBuilder.md#omitclientmeta)
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitClientMeta`](BoundWitnessBuilder.md#omitclientmeta)
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitClientMeta`](BoundWitnessBuilder.md#omitclientmeta)
+
+### Call Signature
+
+```ts
+static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutClientMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitClientMeta`](BoundWitnessBuilder.md#omitclientmeta)
+
+***
+
+### omitMeta()
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitMeta`](BoundWitnessBuilder.md#omitmeta)
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitMeta`](BoundWitnessBuilder.md#omitmeta)
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitMeta`](BoundWitnessBuilder.md#omitmeta)
+
+### Call Signature
+
+```ts
+static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitMeta`](BoundWitnessBuilder.md#omitmeta)
+
+***
+
+### omitPrivateStorageMeta()
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitPrivateStorageMeta`](BoundWitnessBuilder.md#omitprivatestoragemeta)
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitPrivateStorageMeta`](BoundWitnessBuilder.md#omitprivatestoragemeta)
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitPrivateStorageMeta`](BoundWitnessBuilder.md#omitprivatestoragemeta)
+
+### Call Signature
+
+```ts
+static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutPrivateStorageMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitPrivateStorageMeta`](BoundWitnessBuilder.md#omitprivatestoragemeta)
+
+***
+
+### omitStorageMeta()
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`[]
+
+#### Parameters
+
+##### payloads
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\[`number`\]\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitStorageMeta`](BoundWitnessBuilder.md#omitstoragemeta)
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`[]
+
+#### Parameters
+
+##### payloads
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\[`number`\]\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitStorageMeta`](BoundWitnessBuilder.md#omitstoragemeta)
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `object`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitStorageMeta`](BoundWitnessBuilder.md#omitstoragemeta)
+
+### Call Signature
+
+```ts
+static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithoutStorageMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`omitStorageMeta`](BoundWitnessBuilder.md#omitstoragemeta)
+
+***
+
+### pickClientMeta()
+
+### Call Signature
+
+```ts
+static pickClientMeta<T>(payloads, maxDepth?): WithOnlyClientMeta<T>[];
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payloads
+
+`T`[]
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithOnlyClientMeta`\<`T`\>[]
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`pickClientMeta`](BoundWitnessBuilder.md#pickclientmeta)
+
+### Call Signature
+
+```ts
+static pickClientMeta<T>(payload, maxDepth?): WithOnlyClientMeta<T>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Payload`
+
+#### Parameters
+
+##### payload
+
+`T`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`WithOnlyClientMeta`\<`T`\>
+
+#### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`pickClientMeta`](BoundWitnessBuilder.md#pickclientmeta)
+
+***
+
+### sortByStorageMeta()
+
+```ts
+static sortByStorageMeta<T>(
+   payloads, 
+   direction?, 
+   comparer?): WithStorageMeta<T>[];
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`WithStorageMeta`\<`T`\>[]
+
+#### direction?
+
+`1` \| `-1`
+
+#### comparer?
+
+`Compare`\<`Sequence`\>
+
+### Returns
+
+`WithStorageMeta`\<`T`\>[]
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`sortByStorageMeta`](BoundWitnessBuilder.md#sortbystoragemeta)
+
+***
+
+### toAllHashMap()
+
+```ts
+static toAllHashMap<T>(payloads): Promise<Record<BrandedHash, T>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### payloads
+
+`T`[]
+
+### Returns
+
+`Promise`\<`Record`\<`BrandedHash`, `T`\>\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`toAllHashMap`](BoundWitnessBuilder.md#toallhashmap)
+
+***
+
+### toDataHashMap()
+
+```ts
+static toDataHashMap<T>(objs): Promise<Record<BrandedHash, T>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### objs
+
+`T`[]
+
+### Returns
+
+`Promise`\<`Record`\<`BrandedHash`, `T`\>\>
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`toDataHashMap`](BoundWitnessBuilder.md#todatahashmap)
+
+***
+
+### toHashMap()
+
+```ts
+static toHashMap<T>(objs): Promise<Record<BrandedHash, T>>;
+```
+
+Creates an object map of payload hashes to payloads based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `Payload`
+
+### Parameters
+
+#### objs
+
+`T`[]
+
+Any array of payloads
+
+### Returns
+
+`Promise`\<`Record`\<`BrandedHash`, `T`\>\>
+
+A map of hashes to payloads
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`toHashMap`](BoundWitnessBuilder.md#tohashmap)
+
+***
+
+### meta()
+
+```ts
+meta(meta): this;
+```
+
+### Parameters
+
+#### meta
+
+`DeepPickStartsWith`\<`TBoundWitness`\>
+
+### Returns
+
+`this`
+
+### Inherited from
+
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`meta`](BoundWitnessBuilder.md#meta)
+
+***
+
+### schema()
+
+```ts
+schema(value): void;
+```
+
+### Parameters
+
+#### value
+
+`Schema`
+
+### Returns
+
+`void`
+
+### Inherited from
 
-## Credits
+[`BoundWitnessBuilder`](#BoundWitnessBuilder).[`schema`](BoundWitnessBuilder.md#schema)
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/boundwitness-builder.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/boundwitness-builder
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/boundwitness-builder.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE