@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/classes/PayloadBuilder.md

@@ -0,0 +1,967 @@
+[@xyo-network/sdk-js](../README.md) / PayloadBuilder
+
+# Class: PayloadBuilder\<T, R\>
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:7
+
+## Extended by
+
+- [`BoundWitnessBuilder`](BoundWitnessBuilder.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)\<`AnyObject`\>
+
+### R
+
+`R` = `T`
+
+## Constructors
+
+### Constructor
+
+> **new PayloadBuilder**\<`T`, `R`\>(`options`): `PayloadBuilder`\<`T`, `R`\>
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:12
+
+#### Parameters
+
+##### options
+
+[`PayloadBuilderOptions`](../interfaces/PayloadBuilderOptions.md)
+
+#### Returns
+
+`PayloadBuilder`\<`T`, `R`\>
+
+## Properties
+
+### options
+
+> `readonly` **options**: [`PayloadBuilderOptions`](../interfaces/PayloadBuilderOptions.md)
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:8
+
+## Methods
+
+### build()
+
+> **build**(): `R`
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:57
+
+#### Returns
+
+`R`
+
+***
+
+### dataHashableFields()
+
+> **dataHashableFields**(): `Promise`\<`DeepOmitStartsWith`\<`DeepOmitStartsWith`\<`T`, `"_"`\>, `"$"`\>\>
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:58
+
+#### Returns
+
+`Promise`\<`DeepOmitStartsWith`\<`DeepOmitStartsWith`\<`T`, `"_"`\>, `"$"`\>\>
+
+***
+
+### fields()
+
+> **fields**(`fields`): `this`
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:59
+
+#### Parameters
+
+##### fields
+
+`DeepOmitStartsWith`\<`DeepOmitStartsWith`\<[`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`T`\>, `"$"`\>\>
+
+#### Returns
+
+`this`
+
+***
+
+### meta()
+
+> **meta**(`meta`): `this`
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:60
+
+#### Parameters
+
+##### meta
+
+`DeepPickStartsWith`\<`T`\>
+
+#### 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`
+
+***
+
+### 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`\>\>
+
+#### 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`\>[]\>
+
+***
+
+### 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`
+
+***
+
+### 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`\>\>
+
+***
+
+### 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`\>\>
+
+***
+
+### 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`\>
+
+#### 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`\>[]\>
+
+***
+
+### 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`\>\][]\>
+
+***
+
+### 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`[]\>
+
+***
+
+### 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`[]\>
+
+***
+
+### 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`[]\>
+
+***
+
+### 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`[]\>
+
+***
+
+### 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`\>
+
+***
+
+### 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`\>\>
+
+***
+
+### 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`\>
+
+***
+
+### 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`\>
+
+#### 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`\>[]\>
+
+***
+
+### 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
+
+***
+
+### 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`\>
+
+#### 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`\>[]
+
+***
+
+### 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`\>
+
+#### 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`\>[]
+
+***
+
+### 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`\>
+
+#### 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`\>[]
+
+***
+
+### 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`\>
+
+#### 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`\>[]
+
+***
+
+### 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`\>
+
+#### 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`\>[]
+
+***
+
+### 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`\>[]
+
+***
+
+### 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`\>\>
+
+***
+
+### 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`\>\>
+
+***
+
+### 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