@xyo-network/boundwitness-wrapper 5.3.30 → 5.4.0

package/README.md

@@ -38,1831 +38,6 @@ bun add {{name}}
 
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Reference
-
-### packages
-
-  ### protocol
-
-    ### packages
-
-      ### boundwitness
-
-        ### packages
-
-          ### wrapper
-
-            ### .temp-typedoc
-
-              ### classes
-
-                ### <a id="BoundWitnessWrapper"></a>BoundWitnessWrapper
-
-[**@xyo-network/boundwitness-wrapper**](#../README)
-
-***
-
-## Extends
-
-- `PayloadWrapperBase`\<`TBoundWitness`\>
-
-## Extended by
-
-- [`QueryBoundWitnessWrapper`](#QueryBoundWitnessWrapper)
-
-## Type Parameters
-
-### TBoundWitness
-
-`TBoundWitness` *extends* `BoundWitness` = `BoundWitness`
-
-### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-## Constructors
-
-### Constructor
-
-```ts
-protected new BoundWitnessWrapper<TBoundWitness, TPayload>(
-   boundwitness, 
-   payloads?, 
-moduleErrors?): BoundWitnessWrapper<TBoundWitness, TPayload>;
-```
-
-### Parameters
-
-#### boundwitness
-
-`TBoundWitness`
-
-#### payloads?
-
-`TPayload`[] = `[]`
-
-#### moduleErrors?
-
-`Payload`[]
-
-### Returns
-
-`BoundWitnessWrapper`\<`TBoundWitness`, `TPayload`\>
-
-### Overrides
-
-```ts
-PayloadWrapperBase<TBoundWitness>.constructor
-```
-
-## Properties
-
-### boundwitness
-
-```ts
-boundwitness: TBoundWitness;
-```
-
-***
-
-### moduleErrors?
-
-```ts
-optional moduleErrors?: Payload[];
-```
-
-***
-
-### payloads
-
-```ts
-payloads: TPayload[] = [];
-```
-
-***
-
-### payload
-
-```ts
-payload: TBoundWitness;
-```
-
-### Inherited from
-
-```ts
-PayloadWrapperBase.payload
-```
-
-## Accessors
-
-### addresses
-
-### Get Signature
-
-```ts
-get addresses(): Lowercase<string> & object & object[];
-```
-
-#### Returns
-
-`Lowercase`\<`string`\> & `object` & `object`[]
-
-***
-
-### payloadHashes
-
-### Get Signature
-
-```ts
-get payloadHashes(): BrandedHash[];
-```
-
-#### Returns
-
-`BrandedHash`[]
-
-***
-
-### payloadSchemas
-
-### Get Signature
-
-```ts
-get payloadSchemas(): BrandedSchema<string>[];
-```
-
-#### Returns
-
-`BrandedSchema`\<`string`\>[]
-
-***
-
-### previousHashes
-
-### Get Signature
-
-```ts
-get previousHashes(): (BrandedHash | null)[];
-```
-
-#### Returns
-
-(`BrandedHash` \| `null`)[]
-
-## Methods
-
-### as()
-
-```ts
-static as<T>(value): BoundWitnessWrapper<T, Payload> | undefined;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object` = \{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}
-
-### Parameters
-
-#### value
-
-`unknown`
-
-### Returns
-
-`BoundWitnessWrapper`\<`T`, `Payload`\> \| `undefined`
-
-***
-
-### load()
-
-```ts
-static load(address): Promise<
-  | BoundWitnessWrapper<{
-  schema: "network.xyo.boundwitness" & object;
-  addresses: Lowercase<string> & object & object[];
-  payload_hashes: BrandedHash[];
-  payload_schemas: BrandedSchema<string>[];
-  previous_hashes: (BrandedHash | null)[];
-  $destination?: Lowercase<string> & object & object;
-  $sourceQuery?: BrandedHash;
-  $signatures: (BrandedHex | null)[];
-}, Payload>
-| null>;
-```
-
-### Parameters
-
-#### address
-
-`BrandedAddress`
-
-### Returns
-
-`Promise`\<
-  \| `BoundWitnessWrapper`\<\{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}, `Payload`\>
-  \| `null`\>
-
-***
-
-### parse()
-
-```ts
-static parse<T, P>(obj, payloads?): BoundWitnessWrapper<T, P>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object` = \{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}
-
-#### P
-
-`P` *extends* `Payload` = `Payload`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### payloads?
-
-`P`[]
-
-### Returns
-
-`BoundWitnessWrapper`\<`T`, `P`\>
-
-***
-
-### tryParse()
-
-```ts
-static tryParse<T, P>(obj, payloads?): BoundWitnessWrapper<T, P> | undefined;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object`
-
-#### P
-
-`P` *extends* `Payload`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### payloads?
-
-`P`[]
-
-### Returns
-
-`BoundWitnessWrapper`\<`T`, `P`\> \| `undefined`
-
-***
-
-### wrap()
-
-```ts
-static wrap<T, P>(obj, payloads?): BoundWitnessWrapper<T, P>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object`
-
-#### P
-
-`P` *extends* `Payload`
-
-### Parameters
-
-#### obj
-
-`PayloadWrapperBase`\<`T`\> \| `WithoutPrivateStorageMeta`\<`T`\>
-
-#### payloads?
-
-`P`[]
-
-### Returns
-
-`BoundWitnessWrapper`\<`T`, `P`\>
-
-***
-
-### wrappedDataHashMap()
-
-```ts
-static wrappedDataHashMap<T>(boundWitnesses): Promise<Record<string, BoundWitnessWrapper<T, Payload>>>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object`
-
-### Parameters
-
-#### boundWitnesses
-
-(`T` \| `BoundWitnessWrapper`\<`T`, `Payload`\>)[]
-
-### Returns
-
-`Promise`\<`Record`\<`string`, `BoundWitnessWrapper`\<`T`, `Payload`\>\>\>
-
-***
-
-### dig()
-
-```ts
-dig(depth?): Promise<BoundWitnessWrapper<TBoundWitness, Payload>>;
-```
-
-### Parameters
-
-#### depth?
-
-`number`
-
-### Returns
-
-`Promise`\<`BoundWitnessWrapper`\<`TBoundWitness`, `Payload`\>\>
-
-***
-
-### getMissingPayloads()
-
-```ts
-getMissingPayloads(): Promise<BrandedHash[]>;
-```
-
-### Returns
-
-`Promise`\<`BrandedHash`[]\>
-
-***
-
-### getWrappedPayloads()
-
-```ts
-getWrappedPayloads(): Promise<PayloadWrapper<TPayload>[]>;
-```
-
-### Returns
-
-`Promise`\<`PayloadWrapper`\<`TPayload`\>[]\>
-
-***
-
-### hashesBySchema()
-
-```ts
-hashesBySchema(schema): string[];
-```
-
-### Parameters
-
-#### schema
-
-`string`
-
-### Returns
-
-`string`[]
-
-***
-
-### payloadsByDataHashes()
-
-```ts
-payloadsByDataHashes(hashes): Promise<TPayload[]>;
-```
-
-### Parameters
-
-#### hashes
-
-`BrandedHash`[]
-
-### Returns
-
-`Promise`\<`TPayload`[]\>
-
-***
-
-### payloadsByHashes()
-
-```ts
-payloadsByHashes(hashes): Promise<TPayload[]>;
-```
-
-### Parameters
-
-#### hashes
-
-`BrandedHash`[]
-
-### Returns
-
-`Promise`\<`TPayload`[]\>
-
-***
-
-### payloadsBySchema()
-
-```ts
-payloadsBySchema<T>(schema): T[];
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `Payload`
-
-### Parameters
-
-#### schema
-
-`string`
-
-### Returns
-
-`T`[]
-
-***
-
-### payloadsDataHashMap()
-
-```ts
-payloadsDataHashMap(): Promise<Partial<Record<BrandedHash, TPayload>>>;
-```
-
-### Returns
-
-`Promise`\<`Partial`\<`Record`\<`BrandedHash`, `TPayload`\>\>\>
-
-***
-
-### payloadsHashMap()
-
-```ts
-payloadsHashMap(): Promise<Partial<Record<BrandedHash, TPayload>>>;
-```
-
-### Returns
-
-`Promise`\<`Partial`\<`Record`\<`BrandedHash`, `TPayload`\>\>\>
-
-***
-
-### prev()
-
-```ts
-prev(address): BrandedHash | null;
-```
-
-### Parameters
-
-#### address
-
-`BrandedAddress`
-
-### Returns
-
-`BrandedHash` \| `null`
-
-***
-
-### toResult()
-
-```ts
-toResult(): (TBoundWitness | TPayload[])[];
-```
-
-### Returns
-
-(`TBoundWitness` \| `TPayload`[])[]
-
-***
-
-### validate()
-
-```ts
-validate(): Promise<Error[]>;
-```
-
-### Returns
-
-`Promise`\<`Error`[]\>
-
-### Overrides
-
-```ts
-PayloadWrapperBase.validate
-```
-
-***
-
-### unwrap()
-
-### Call Signature
-
-```ts
-static unwrap<TPayload>(payload?): TPayload | undefined;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-#### Parameters
-
-##### payload?
-
-`TPayload`
-
-#### Returns
-
-`TPayload` \| `undefined`
-
-#### Inherited from
-
-```ts
-PayloadWrapperBase.unwrap
-```
-
-### Call Signature
-
-```ts
-static unwrap<TPayload, TWrapper>(payload): TPayload;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-##### TWrapper
-
-`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
-
-#### Parameters
-
-##### payload
-
-`TPayload` \| `TWrapper`
-
-#### Returns
-
-`TPayload`
-
-#### Inherited from
-
-```ts
-PayloadWrapperBase.unwrap
-```
-
-### Call Signature
-
-```ts
-static unwrap<TPayload, TWrapper>(payload): TPayload[];
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-##### TWrapper
-
-`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
-
-#### Parameters
-
-##### payload
-
-(`TPayload` \| `TWrapper`)[]
-
-#### Returns
-
-`TPayload`[]
-
-#### Inherited from
-
-```ts
-PayloadWrapperBase.unwrap
-```
-
-***
-
-### unwrapSinglePayload()
-
-### Call Signature
-
-```ts
-static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-#### Parameters
-
-##### payload?
-
-`TPayload`
-
-#### Returns
-
-`TPayload` \| `undefined`
-
-#### Inherited from
-
-```ts
-PayloadWrapperBase.unwrapSinglePayload
-```
-
-### Call Signature
-
-```ts
-static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-##### TWrapper
-
-`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
-
-#### Parameters
-
-##### payload
-
-`TPayload` \| `TWrapper`
-
-#### Returns
-
-`TPayload`
-
-#### Inherited from
-
-```ts
-PayloadWrapperBase.unwrapSinglePayload
-```
-
-***
-
-### dataHash()
-
-```ts
-dataHash(): Promise<BrandedHash>;
-```
-
-### Returns
-
-`Promise`\<`BrandedHash`\>
-
-### Inherited from
-
-```ts
-PayloadWrapperBase.dataHash
-```
-
-***
-
-### getErrors()
-
-```ts
-getErrors(): Promise<Error[]>;
-```
-
-### Returns
-
-`Promise`\<`Error`[]\>
-
-### Inherited from
-
-```ts
-PayloadWrapperBase.getErrors
-```
-
-***
-
-### getValid()
-
-```ts
-getValid(): Promise<boolean>;
-```
-
-### Returns
-
-`Promise`\<`boolean`\>
-
-### Inherited from
-
-```ts
-PayloadWrapperBase.getValid
-```
-
-***
-
-### hash()
-
-```ts
-hash(): Promise<BrandedHash>;
-```
-
-### Returns
-
-`Promise`\<`BrandedHash`\>
-
-### Inherited from
-
-```ts
-PayloadWrapperBase.hash
-```
-
-***
-
-### schema()
-
-```ts
-schema(): string;
-```
-
-### Returns
-
-`string`
-
-### Inherited from
-
-```ts
-PayloadWrapperBase.schema
-```
-
-                ### <a id="QueryBoundWitnessWrapper"></a>QueryBoundWitnessWrapper
-
-[**@xyo-network/boundwitness-wrapper**](#../README)
-
-***
-
-## Extends
-
-- [`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`QueryBoundWitness`\>
-
-## Type Parameters
-
-### T
-
-`T` *extends* `Query` = `Query`
-
-## Constructors
-
-### Constructor
-
-```ts
-protected new QueryBoundWitnessWrapper<T>(
-   boundwitness, 
-   payloads?, 
-moduleErrors?): QueryBoundWitnessWrapper<T>;
-```
-
-### Parameters
-
-#### boundwitness
-
-`UnsignedQueryBoundWitness`
-
-#### payloads?
-
-`Payload`[] = `[]`
-
-#### moduleErrors?
-
-`Payload`[]
-
-### Returns
-
-`QueryBoundWitnessWrapper`\<`T`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`constructor`](BoundWitnessWrapper.md#constructor)
-
-## Properties
-
-### boundwitness
-
-```ts
-boundwitness: UnsignedQueryBoundWitness;
-```
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`boundwitness`](BoundWitnessWrapper.md#boundwitness)
-
-***
-
-### moduleErrors?
-
-```ts
-optional moduleErrors?: Payload[];
-```
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`moduleErrors`](BoundWitnessWrapper.md#moduleerrors)
-
-***
-
-### payloads
-
-```ts
-payloads: Payload[] = [];
-```
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloads`](BoundWitnessWrapper.md#payloads)
-
-***
-
-### payload
-
-```ts
-payload: UnsignedQueryBoundWitness;
-```
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payload`](BoundWitnessWrapper.md#payload)
-
-## Accessors
-
-### addresses
-
-### Get Signature
-
-```ts
-get addresses(): Lowercase<string> & object & object[];
-```
-
-#### Returns
-
-`Lowercase`\<`string`\> & `object` & `object`[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`addresses`](BoundWitnessWrapper.md#addresses)
-
-***
-
-### payloadHashes
-
-### Get Signature
-
-```ts
-get payloadHashes(): BrandedHash[];
-```
-
-#### Returns
-
-`BrandedHash`[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadHashes`](BoundWitnessWrapper.md#payloadhashes)
-
-***
-
-### payloadSchemas
-
-### Get Signature
-
-```ts
-get payloadSchemas(): BrandedSchema<string>[];
-```
-
-#### Returns
-
-`BrandedSchema`\<`string`\>[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadSchemas`](BoundWitnessWrapper.md#payloadschemas)
-
-***
-
-### previousHashes
-
-### Get Signature
-
-```ts
-get previousHashes(): (BrandedHash | null)[];
-```
-
-#### Returns
-
-(`BrandedHash` \| `null`)[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`previousHashes`](BoundWitnessWrapper.md#previoushashes)
-
-## Methods
-
-### as()
-
-```ts
-static as<T>(value): 
-  | BoundWitnessWrapper<T, Payload>
-  | undefined;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object` = \{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}
-
-### Parameters
-
-#### value
-
-`unknown`
-
-### Returns
-
-  \| [`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`T`, `Payload`\>
-  \| `undefined`
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`as`](BoundWitnessWrapper.md#as)
-
-***
-
-### load()
-
-```ts
-static load(address): Promise<
-  | BoundWitnessWrapper<{
-  schema: "network.xyo.boundwitness" & object;
-  addresses: Lowercase<string> & object & object[];
-  payload_hashes: BrandedHash[];
-  payload_schemas: BrandedSchema<string>[];
-  previous_hashes: (BrandedHash | null)[];
-  $destination?: Lowercase<string> & object & object;
-  $sourceQuery?: BrandedHash;
-  $signatures: (BrandedHex | null)[];
-}, Payload>
-| null>;
-```
-
-### Parameters
-
-#### address
-
-`BrandedAddress`
-
-### Returns
-
-`Promise`\<
-  \| [`BoundWitnessWrapper`](#BoundWitnessWrapper)\<\{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}, `Payload`\>
-  \| `null`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`load`](BoundWitnessWrapper.md#load)
-
-***
-
-### parse()
-
-```ts
-static parse<T, P>(obj, payloads?): BoundWitnessWrapper<T, P>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object` = \{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}
-
-#### P
-
-`P` *extends* `Payload` = `Payload`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### payloads?
-
-`P`[]
-
-### Returns
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`T`, `P`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`parse`](BoundWitnessWrapper.md#parse)
-
-***
-
-### tryParse()
-
-```ts
-static tryParse<T, P>(obj, payloads?): BoundWitnessWrapper<T, P> | undefined;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object`
-
-#### P
-
-`P` *extends* `Payload`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### payloads?
-
-`P`[]
-
-### Returns
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`T`, `P`\> \| `undefined`
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`tryParse`](BoundWitnessWrapper.md#tryparse)
-
-***
-
-### wrap()
-
-```ts
-static wrap<T, P>(obj, payloads?): BoundWitnessWrapper<T, P>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object`
-
-#### P
-
-`P` *extends* `Payload`
-
-### Parameters
-
-#### obj
-
-`PayloadWrapperBase`\<`T`\> \| `WithoutPrivateStorageMeta`\<`T`\>
-
-#### payloads?
-
-`P`[]
-
-### Returns
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`T`, `P`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`wrap`](BoundWitnessWrapper.md#wrap)
-
-***
-
-### wrappedDataHashMap()
-
-```ts
-static wrappedDataHashMap<T>(boundWitnesses): Promise<Record<string, BoundWitnessWrapper<T, Payload>>>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `object`
-
-### Parameters
-
-#### boundWitnesses
-
-(`T` \| [`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`T`, `Payload`\>)[]
-
-### Returns
-
-`Promise`\<`Record`\<`string`, [`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`T`, `Payload`\>\>\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`wrappedDataHashMap`](BoundWitnessWrapper.md#wrappeddatahashmap)
-
-***
-
-### dig()
-
-```ts
-dig(depth?): Promise<BoundWitnessWrapper<UnsignedQueryBoundWitness, Payload>>;
-```
-
-### Parameters
-
-#### depth?
-
-`number`
-
-### Returns
-
-`Promise`\<[`BoundWitnessWrapper`](#BoundWitnessWrapper)\<`UnsignedQueryBoundWitness`, `Payload`\>\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`dig`](BoundWitnessWrapper.md#dig)
-
-***
-
-### getMissingPayloads()
-
-```ts
-getMissingPayloads(): Promise<BrandedHash[]>;
-```
-
-### Returns
-
-`Promise`\<`BrandedHash`[]\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`getMissingPayloads`](BoundWitnessWrapper.md#getmissingpayloads)
-
-***
-
-### getWrappedPayloads()
-
-```ts
-getWrappedPayloads(): Promise<PayloadWrapper<Payload>[]>;
-```
-
-### Returns
-
-`Promise`\<`PayloadWrapper`\<`Payload`\>[]\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`getWrappedPayloads`](BoundWitnessWrapper.md#getwrappedpayloads)
-
-***
-
-### hashesBySchema()
-
-```ts
-hashesBySchema(schema): string[];
-```
-
-### Parameters
-
-#### schema
-
-`string`
-
-### Returns
-
-`string`[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`hashesBySchema`](BoundWitnessWrapper.md#hashesbyschema)
-
-***
-
-### payloadsByDataHashes()
-
-```ts
-payloadsByDataHashes(hashes): Promise<Payload[]>;
-```
-
-### Parameters
-
-#### hashes
-
-`BrandedHash`[]
-
-### Returns
-
-`Promise`\<`Payload`[]\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadsByDataHashes`](BoundWitnessWrapper.md#payloadsbydatahashes)
-
-***
-
-### payloadsByHashes()
-
-```ts
-payloadsByHashes(hashes): Promise<Payload[]>;
-```
-
-### Parameters
-
-#### hashes
-
-`BrandedHash`[]
-
-### Returns
-
-`Promise`\<`Payload`[]\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadsByHashes`](BoundWitnessWrapper.md#payloadsbyhashes)
-
-***
-
-### payloadsBySchema()
-
-```ts
-payloadsBySchema<T>(schema): T[];
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `Payload`
-
-### Parameters
-
-#### schema
-
-`string`
-
-### Returns
-
-`T`[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadsBySchema`](BoundWitnessWrapper.md#payloadsbyschema)
-
-***
-
-### payloadsDataHashMap()
-
-```ts
-payloadsDataHashMap(): Promise<Partial<Record<BrandedHash, Payload>>>;
-```
-
-### Returns
-
-`Promise`\<`Partial`\<`Record`\<`BrandedHash`, `Payload`\>\>\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadsDataHashMap`](BoundWitnessWrapper.md#payloadsdatahashmap)
-
-***
-
-### payloadsHashMap()
-
-```ts
-payloadsHashMap(): Promise<Partial<Record<BrandedHash, Payload>>>;
-```
-
-### Returns
-
-`Promise`\<`Partial`\<`Record`\<`BrandedHash`, `Payload`\>\>\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`payloadsHashMap`](BoundWitnessWrapper.md#payloadshashmap)
-
-***
-
-### prev()
-
-```ts
-prev(address): BrandedHash | null;
-```
-
-### Parameters
-
-#### address
-
-`BrandedAddress`
-
-### Returns
-
-`BrandedHash` \| `null`
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`prev`](BoundWitnessWrapper.md#prev)
-
-***
-
-### toResult()
-
-```ts
-toResult(): (Payload[] | UnsignedQueryBoundWitness)[];
-```
-
-### Returns
-
-(`Payload`[] \| `UnsignedQueryBoundWitness`)[]
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`toResult`](BoundWitnessWrapper.md#toresult)
-
-***
-
-### validate()
-
-```ts
-validate(): Promise<Error[]>;
-```
-
-### Returns
-
-`Promise`\<`Error`[]\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`validate`](BoundWitnessWrapper.md#validate)
-
-***
-
-### parseQuery()
-
-```ts
-static parseQuery<T>(obj, payloads?): QueryBoundWitnessWrapper<T>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `Query` = `Query`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### payloads?
-
-`Payload`[]
-
-### Returns
-
-`QueryBoundWitnessWrapper`\<`T`\>
-
-***
-
-### tryParseQuery()
-
-```ts
-static tryParseQuery<T>(obj): Promisable<QueryBoundWitnessWrapper<T> | undefined>;
-```
-
-### Type Parameters
-
-#### T
-
-`T` *extends* `Query`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-### Returns
-
-`Promisable`\<`QueryBoundWitnessWrapper`\<`T`\> \| `undefined`\>
-
-***
-
-### getPayloadsWithoutQuery()
-
-```ts
-getPayloadsWithoutQuery(): Promise<PayloadWrapper<Payload>[]>;
-```
-
-### Returns
-
-`Promise`\<`PayloadWrapper`\<`Payload`\>[]\>
-
-***
-
-### getQuery()
-
-```ts
-getQuery(): Promise<T>;
-```
-
-### Returns
-
-`Promise`\<`T`\>
-
-***
-
-### unwrap()
-
-### Call Signature
-
-```ts
-static unwrap<TPayload>(payload?): TPayload | undefined;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-#### Parameters
-
-##### payload?
-
-`TPayload`
-
-#### Returns
-
-`TPayload` \| `undefined`
-
-#### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`unwrap`](BoundWitnessWrapper.md#unwrap)
-
-### Call Signature
-
-```ts
-static unwrap<TPayload, TWrapper>(payload): TPayload;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-##### TWrapper
-
-`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
-
-#### Parameters
-
-##### payload
-
-`TPayload` \| `TWrapper`
-
-#### Returns
-
-`TPayload`
-
-#### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`unwrap`](BoundWitnessWrapper.md#unwrap)
-
-### Call Signature
-
-```ts
-static unwrap<TPayload, TWrapper>(payload): TPayload[];
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-##### TWrapper
-
-`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
-
-#### Parameters
-
-##### payload
-
-(`TPayload` \| `TWrapper`)[]
-
-#### Returns
-
-`TPayload`[]
-
-#### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`unwrap`](BoundWitnessWrapper.md#unwrap)
-
-***
-
-### unwrapSinglePayload()
-
-### Call Signature
-
-```ts
-static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-#### Parameters
-
-##### payload?
-
-`TPayload`
-
-#### Returns
-
-`TPayload` \| `undefined`
-
-#### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`unwrapSinglePayload`](BoundWitnessWrapper.md#unwrapsinglepayload)
-
-### Call Signature
-
-```ts
-static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
-```
-
-#### Type Parameters
-
-##### TPayload
-
-`TPayload` *extends* `Payload` = `Payload`
-
-##### TWrapper
-
-`TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
-
-#### Parameters
-
-##### payload
-
-`TPayload` \| `TWrapper`
-
-#### Returns
-
-`TPayload`
-
-#### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`unwrapSinglePayload`](BoundWitnessWrapper.md#unwrapsinglepayload)
-
-***
-
-### dataHash()
-
-```ts
-dataHash(): Promise<BrandedHash>;
-```
-
-### Returns
-
-`Promise`\<`BrandedHash`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`dataHash`](BoundWitnessWrapper.md#datahash)
-
-***
-
-### getErrors()
-
-```ts
-getErrors(): Promise<Error[]>;
-```
-
-### Returns
-
-`Promise`\<`Error`[]\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`getErrors`](BoundWitnessWrapper.md#geterrors)
-
-***
-
-### getValid()
-
-```ts
-getValid(): Promise<boolean>;
-```
-
-### Returns
-
-`Promise`\<`boolean`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`getValid`](BoundWitnessWrapper.md#getvalid)
-
-***
-
-### hash()
-
-```ts
-hash(): Promise<BrandedHash>;
-```
-
-### Returns
-
-`Promise`\<`BrandedHash`\>
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`hash`](BoundWitnessWrapper.md#hash)
-
-***
-
-### schema()
-
-```ts
-schema(): string;
-```
-
-### Returns
-
-`string`
-
-### Inherited from
-
-[`BoundWitnessWrapper`](#BoundWitnessWrapper).[`schema`](BoundWitnessWrapper.md#schema)
-
-              ### functions
-
-                ### <a id="isBoundWitnessWrapper"></a>isBoundWitnessWrapper
-
-[**@xyo-network/boundwitness-wrapper**](#../README)
-
-***
-
-```ts
-function isBoundWitnessWrapper<T, P>(value?): value is BoundWitnessWrapper<T, P>;
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object` = \{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}
-
-### P
-
-`P` *extends* `Payload` = `Payload`
-
-## Parameters
-
-### value?
-
-`unknown`
-
-## Returns
-
-`value is BoundWitnessWrapper<T, P>`
-
-              ### variables
-
-                ### <a id="SignatureRegEx"></a>SignatureRegEx
-
-[**@xyo-network/boundwitness-wrapper**](#../README)
-
-***
-
-```ts
-const SignatureRegEx: RegExp;
-```
-
-                ### <a id="boundWitnessJsonSchema"></a>boundWitnessJsonSchema
-
-[**@xyo-network/boundwitness-wrapper**](#../README)
-
-***
-
-```ts
-const boundWitnessJsonSchema: JSONSchemaType<BoundWitness>;
-```
-
-                ### <a id="boundWitnessProperties"></a>boundWitnessProperties
-
-[**@xyo-network/boundwitness-wrapper**](#../README)
-
-***
-
-```ts
-const boundWitnessProperties: JSONSchemaType<BoundWitness>["properties"];
-```
 
 
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png