@xyo-network/payload-model 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,3758 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/payload-model
 
-[![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__payload-model)
+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
+
+      ### payload
+
+        ### packages
+
+          ### model
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="SequenceParser"></a>SequenceParser
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new SequenceParser(privateConstructorKey, hex): SequenceParser;
+```
+
+### Parameters
+
+#### privateConstructorKey
+
+`string`
+
+#### hex
+
+`BrandedHex`
+
+### Returns
+
+`SequenceParser`
+
+## Properties
+
+### privateConstructorKey
+
+```ts
+protected static privateConstructorKey: string;
+```
+
+## Accessors
+
+### address
+
+### Get Signature
+
+```ts
+get address(): BrandedAddress;
+```
+
+#### Returns
+
+`BrandedAddress`
+
+***
+
+### epoch
+
+### Get Signature
+
+```ts
+get epoch(): Epoch;
+```
+
+#### Returns
+
+[`Epoch`](#../type-aliases/Epoch)
+
+***
+
+### localSequence
+
+### Get Signature
+
+```ts
+get localSequence(): LocalSequence;
+```
+
+#### Returns
+
+[`LocalSequence`](#../type-aliases/LocalSequence)
+
+***
+
+### nonce
+
+### Get Signature
+
+```ts
+get nonce(): Nonce;
+```
+
+#### Returns
+
+[`Nonce`](#../type-aliases/Nonce)
+
+***
+
+### qualifiedSequence
+
+### Get Signature
+
+```ts
+get qualifiedSequence(): QualifiedSequence;
+```
+
+#### Returns
+
+[`QualifiedSequence`](#../type-aliases/QualifiedSequence)
+
+## Methods
+
+### from()
+
+### Call Signature
+
+```ts
+static from(sequence, address?): SequenceParser;
+```
+
+#### Parameters
+
+##### sequence
+
+[`Sequence`](#../type-aliases/Sequence)
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`BrandedHex`
+
+##### hash
+
+`BrandedHash`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`BrandedHex`
+
+##### hash
+
+`BrandedHex`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   nonce, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`BrandedHex`
+
+##### nonce
+
+[`Nonce`](#../type-aliases/Nonce)
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   index?, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`BrandedHex`
+
+##### hash
+
+`BrandedHash`
+
+##### index?
+
+`number`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   index?, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`BrandedHex`
+
+##### hash
+
+`BrandedHex`
+
+##### index?
+
+`number`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   nonce, 
+   index?, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`BrandedHex`
+
+##### nonce
+
+[`Nonce`](#../type-aliases/Nonce)
+
+##### index?
+
+`number`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+##### hash
+
+`BrandedHash`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+##### hash
+
+`BrandedHex`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   nonce, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+##### nonce
+
+[`Nonce`](#../type-aliases/Nonce)
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   index?, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+##### hash
+
+`BrandedHash`
+
+##### index?
+
+`number`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   hash, 
+   index?, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+##### hash
+
+`BrandedHex`
+
+##### index?
+
+`number`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+### Call Signature
+
+```ts
+static from(
+   timestamp, 
+   nonce, 
+   index?, 
+   address?): SequenceParser;
+```
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+##### nonce
+
+[`Nonce`](#../type-aliases/Nonce)
+
+##### index?
+
+`number`
+
+##### address?
+
+`BrandedAddress`
+
+#### Returns
+
+`SequenceParser`
+
+***
+
+### parse()
+
+```ts
+static parse(value): SequenceParser;
+```
+
+### Parameters
+
+#### value
+
+`string` \| `BrandedHex` \| `ArrayBufferLike`
+
+### Returns
+
+`SequenceParser`
+
+***
+
+### toEpoch()
+
+```ts
+static toEpoch(value): Epoch;
+```
+
+### Parameters
+
+#### value
+
+`number` \| `BrandedHex` \| [`Epoch`](#../type-aliases/Epoch)
+
+### Returns
+
+[`Epoch`](#../type-aliases/Epoch)
+
+***
+
+### toNonce()
+
+```ts
+static toNonce(value, index?): Nonce;
+```
+
+### Parameters
+
+#### value
+
+`BrandedHex` \| `BrandedHash`
+
+#### index?
+
+`number` = `0`
+
+### Returns
+
+[`Nonce`](#../type-aliases/Nonce)
+
+              ### functions
+
+                ### <a id="PayloadZodLooseOfSchema"></a>PayloadZodLooseOfSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function PayloadZodLooseOfSchema<S>(schema): ZodObject<{
+  schema: ZodLiteral<S>;
+}, $strict>;
+```
+
+## Type Parameters
+
+### S
+
+`S` *extends* [`Schema`](#../type-aliases/Schema)
+
+## Parameters
+
+### schema
+
+`S`
+
+## Returns
+
+`ZodObject`\<\{
+  `schema`: `ZodLiteral`\<`S`\>;
+\}, `$strict`\>
+
+                ### <a id="PayloadZodOfSchema"></a>PayloadZodOfSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function PayloadZodOfSchema<S>(schema): ZodObject<{
+  schema: ZodLiteral<S>;
+}, $strip>;
+```
+
+## Type Parameters
+
+### S
+
+`S` *extends* [`Schema`](#../type-aliases/Schema)
+
+## Parameters
+
+### schema
+
+`S`
+
+## Returns
+
+`ZodObject`\<\{
+  `schema`: `ZodLiteral`\<`S`\>;
+\}, `$strip`\>
+
+                ### <a id="PayloadZodStrictOfSchema"></a>PayloadZodStrictOfSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function PayloadZodStrictOfSchema<S>(schema): ZodObject<{
+  schema: ZodLiteral<S>;
+}, $strict>;
+```
+
+## Type Parameters
+
+### S
+
+`S` *extends* [`Schema`](#../type-aliases/Schema)
+
+## Parameters
+
+### schema
+
+`S`
+
+## Returns
+
+`ZodObject`\<\{
+  `schema`: `ZodLiteral`\<`S`\>;
+\}, `$strict`\>
+
+                ### <a id="WithHashMetaZod"></a>WithHashMetaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function WithHashMetaZod<T>(valueZod): ZodObject<{ -readonly [P in string | number | symbol]: (T & { _hash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>; _dataHash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>> })[P] }, $strip>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Readonly`\<\{
+\[`k`: `string`\]: `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>;
+\}\>
+
+## Parameters
+
+### valueZod
+
+`ZodObject`\<`T`\>
+
+## Returns
+
+`ZodObject`\<\{ -readonly \[P in string \| number \| symbol\]: (T & \{ \_hash: ZodPipe\<ZodString, ZodTransform\<BrandedHash, string\>\>; \_dataHash: ZodPipe\<ZodString, ZodTransform\<BrandedHash, string\>\> \})\[P\] \}, `$strip`\>
+
+                ### <a id="WithStorageMetaZod"></a>WithStorageMetaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function WithStorageMetaZod<T>(valueZod): ZodObject<{ -readonly [P in string | number | symbol]: (T & { _hash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>; _dataHash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>; _sequence: ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<LocalSequence, string>>, ZodPipe<ZodString, ZodTransform<QualifiedSequence, string>>]> })[P] }, $strip>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Readonly`\<\{
+\[`k`: `string`\]: `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>;
+\}\>
+
+## Parameters
+
+### valueZod
+
+`ZodObject`\<`T`\>
+
+## Returns
+
+`ZodObject`\<\{ -readonly \[P in string \| number \| symbol\]: (T & \{ \_hash: ZodPipe\<ZodString, ZodTransform\<BrandedHash, string\>\>; \_dataHash: ZodPipe\<ZodString, ZodTransform\<BrandedHash, string\>\>; \_sequence: ZodUnion\<readonly \[ZodPipe\<ZodString, ZodTransform\<LocalSequence, string\>\>, ZodPipe\<ZodString, ZodTransform\<QualifiedSequence, string\>\>\]\> \})\[P\] \}, `$strip`\>
+
+                ### <a id="isEpoch"></a>isEpoch
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isEpoch(value): value is Epoch;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Epoch`
+
+                ### <a id="isLocalSequence"></a>isLocalSequence
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isLocalSequence(value): value is LocalSequence;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is LocalSequence`
+
+                ### <a id="isNonce"></a>isNonce
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isNonce(value): value is Nonce;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Nonce`
+
+                ### <a id="isPayloadOfSchemaType"></a>isPayloadOfSchemaType
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isPayloadOfSchemaType<T>(schema): (x?) => x is T;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#../type-aliases/Payload) = `never`
+
+## Parameters
+
+### schema
+
+`T`\[`"schema"`\]
+
+## Returns
+
+(`x?`) => `x is T`
+
+                ### <a id="isPayloadOfSchemaTypeWithSources"></a>isPayloadOfSchemaTypeWithSources
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isPayloadOfSchemaTypeWithSources<T>(schema): (x?) => x is WithSources<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#../type-aliases/Payload) = `never`
+
+## Parameters
+
+### schema
+
+`T`\[`"schema"`\]
+
+## Returns
+
+(`x?`) => `x is WithSources<T>`
+
+                ### <a id="isPayloadOfZodType"></a>isPayloadOfZodType
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isPayloadOfZodType<T, S>(zodSchema, schema?): (x?) => x is T;
+```
+
+Checks if a value is a payload of a specific Zod type.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#../type-aliases/Payload) = `never`
+
+### S
+
+`S` *extends* `ZodObject`\<`$ZodLooseShape`, `$strip`\> = `ZodObject`\<`$ZodLooseShape`, `$strip`\>
+
+## Parameters
+
+### zodSchema
+
+`S`
+
+The Zod schema to validate against
+
+### schema?
+
+`T`\[`"schema"`\]
+
+The schema string to match against the payload. Optional in
+case you want to validate any payload matching the Zod schema or in case
+schema is part of the Zod schema.
+
+## Returns
+
+A function that checks if a value is a payload of the specified Zod type
+
+(`x?`) => `x is T`
+
+                ### <a id="isQualifiedSequence"></a>isQualifiedSequence
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isQualifiedSequence(value): value is QualifiedSequence;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is QualifiedSequence`
+
+                ### <a id="isSequence"></a>isSequence
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isSequence(value): value is Sequence;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Sequence`
+
+                ### <a id="isSequenceStorageMeta"></a>isSequenceStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function isSequenceStorageMeta(value): value is SequenceStorageMeta;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is SequenceStorageMeta`
+
+                ### <a id="makeSchema"></a>makeSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function makeSchema<T>(value): ZodPipe<ZodTemplateLiteral<ZodLiteral<T> extends $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> ? `${T extends T ? UndefinedToEmptyString<T> : never}` : never>, ZodTransform<Awaited<ZodLiteral<T> extends $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> ? `${T extends T ? UndefinedToEmptyString<T> : never}` : never & object>, ZodLiteral<T> extends $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> ? `${T extends T ? UndefinedToEmptyString<T> : never}` : never>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `string`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`ZodPipe`\<`ZodTemplateLiteral`\<`ZodLiteral`\<`T`\> *extends* `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> ? `` `${T extends T ? UndefinedToEmptyString<T> : never}` `` : `never`\>, `ZodTransform`\<`Awaited`\<`ZodLiteral`\<`T`\> *extends* `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> ? `` `${T extends T ? UndefinedToEmptyString<T> : never}` `` : `never` & `object`\>, `ZodLiteral`\<`T`\> *extends* `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> ? `` `${T extends T ? UndefinedToEmptyString<T> : never}` `` : `never`\>\>
+
+                ### <a id="notPayloadOfSchemaType"></a>notPayloadOfSchemaType
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+function notPayloadOfSchemaType<T>(schema): (x?) => x is T;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#../type-aliases/Payload) = `never`
+
+## Parameters
+
+### schema
+
+`T`\[`"schema"`\]
+
+## Returns
+
+(`x?`) => `x is T`
+
+              ### interfaces
+
+                ### <a id="PayloadFields"></a>PayloadFields
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+Additional fields for a payload
+
+## Extends
+
+- [`SchemaField`](#SchemaField)
+
+## Properties
+
+### schema
+
+```ts
+schema: Schema;
+```
+
+### Inherited from
+
+[`SchemaField`](#SchemaField).[`schema`](SchemaField.md#schema)
+
+                ### <a id="PayloadFindFilter"></a>PayloadFindFilter
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Properties
+
+### limit?
+
+```ts
+optional limit?: number;
+```
+
+***
+
+### order?
+
+```ts
+optional order?: "desc" | "asc";
+```
+
+***
+
+### schema?
+
+```ts
+optional schema?: string | string[];
+```
+
+                ### <a id="PayloadHashMap"></a>PayloadHashMap
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Type Parameters
+
+### TPayload
+
+`TPayload` *extends* [`Payload`](#../type-aliases/Payload) = [`Payload`](#../type-aliases/Payload)
+
+### TId
+
+`TId` *extends* `string` \| `number` \| `symbol` = `Hash`
+
+## Properties
+
+### dataHash
+
+```ts
+dataHash: Record<TId, TId>;
+```
+
+***
+
+### hash
+
+```ts
+hash: Record<TId, TPayload>;
+```
+
+                ### <a id="PayloadMetaFields"></a>PayloadMetaFields
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Extends
+
+- [`SourcesMetaField`](#SourcesMetaField)
+
+## Properties
+
+### $sources
+
+```ts
+$sources: BrandedHash[];
+```
+
+### Inherited from
+
+[`SourcesMetaField`](#SourcesMetaField).[`$sources`](SourcesMetaField.md#sources)
+
+                ### <a id="PayloadSet"></a>PayloadSet
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Properties
+
+### optional?
+
+```ts
+optional optional?: Record<string, number>;
+```
+
+***
+
+### required?
+
+```ts
+optional required?: Record<string, number>;
+```
+
+                ### <a id="QueryFields"></a>QueryFields
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Properties
+
+### address?
+
+```ts
+optional address?: BrandedAddress | BrandedAddress[];
+```
+
+### Field
+
+The addresses of the intended handlers
+
+***
+
+### budget?
+
+```ts
+optional budget?: number;
+```
+
+### Field
+
+The maximum XYO that can be spent executing the query
+
+***
+
+### maxFrequency?
+
+```ts
+optional maxFrequency?: "once" | "second" | "minute" | "hour" | "day" | "week" | "month" | "year";
+```
+
+### Field
+
+The frequency on which this query can be rerun
+
+***
+
+### minBid?
+
+```ts
+optional minBid?: number;
+```
+
+### Field
+
+The starting point for the bidding on the query
+
+                ### <a id="SchemaField"></a>SchemaField
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Extended by
+
+- [`PayloadFields`](#PayloadFields)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Schema`](#../type-aliases/Schema) = [`Schema`](#../type-aliases/Schema)
+
+## Properties
+
+### schema
+
+```ts
+schema: T;
+```
+
+                ### <a id="SequenceStorageMeta"></a>SequenceStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Properties
+
+### \_sequence
+
+```ts
+_sequence: Sequence;
+```
+
+                ### <a id="SourcesMetaField"></a>SourcesMetaField
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+## Extended by
+
+- [`PayloadMetaFields`](#PayloadMetaFields)
+
+## Properties
+
+### $sources
+
+```ts
+$sources: BrandedHash[];
+```
+
+                ### <a id="Timestamp"></a>Timestamp
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+Object with a timestamp
+
+## Properties
+
+### timestamp
+
+```ts
+timestamp: number;
+```
+
+              ### type-aliases
+
+                ### <a id="AnyPayload"></a>AnyPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type AnyPayload = z.infer<typeof AnyPayloadZod>;
+```
+
+                ### <a id="AsyncPayloadValidationFunction"></a>AsyncPayloadValidationFunction
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type AsyncPayloadValidationFunction<T> = (payload) => Promise<boolean>;
+```
+
+A function that validates the supplied payload asynchronously
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+## Parameters
+
+### payload
+
+`T`
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+                ### <a id="BrandedSchema"></a>BrandedSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type BrandedSchema<T> = Brand<T, {
+  __schema: true;
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `string` = `string`
+
+                ### <a id="Epoch"></a>Epoch
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type Epoch = Brand<Hex, {
+  __epoch: true;
+}>;
+```
+
+                ### <a id="HashMeta"></a>HashMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type HashMeta = z.infer<typeof HashMetaZod>;
+```
+
+                ### <a id="LocalSequence"></a>LocalSequence
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type LocalSequence = Brand<Hex, {
+  __localSequence: true;
+}>;
+```
+
+                ### <a id="ModuleError"></a>ModuleError
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type ModuleError = Payload<{
+  details?: JsonValue;
+  message?: string;
+  name?: string;
+  query?: Hash | Schema;
+}, ModuleErrorSchema>;
+```
+
+                ### <a id="ModuleErrorSchema"></a>ModuleErrorSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type ModuleErrorSchema = typeof ModuleErrorSchema;
+```
+
+                ### <a id="Nonce"></a>Nonce
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type Nonce = Brand<Hex, {
+  __nonce: true;
+}>;
+```
+
+                ### <a id="OverridablePayload"></a>OverridablePayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type OverridablePayload<T> = WithoutMeta<Omit<T, "schema"> & PayloadFields>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload)
+
+                ### <a id="Payload"></a>Payload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type Payload<T, S> = T extends SchemaField ? S extends Schema ? WithPayload<Omit<T, "schema"> & object> : WithPayload<T> : T extends object ? S extends Schema ? WithPayload<T & object> : WithPayload<T & PayloadFields> : WithPayload<{
+  schema: S extends Schema ? S : Schema;
+}> & Partial<PayloadMetaFields>;
+```
+
+Base Type for Payloads
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| [`SchemaField`](#../interfaces/SchemaField) = `void`
+
+### S
+
+`S` *extends* [`Schema`](#Schema) \| `void` = `void`
+
+                ### <a id="PayloadBundle"></a>PayloadBundle
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadBundle = z.infer<typeof PayloadBundleZod>;
+```
+
+                ### <a id="PayloadBundleFields"></a>PayloadBundleFields
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadBundleFields = z.infer<typeof PayloadBundleFieldsZod>;
+```
+
+                ### <a id="PayloadBundleSchema"></a>PayloadBundleSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadBundleSchema = typeof PayloadBundleSchema;
+```
+
+                ### <a id="PayloadProperty"></a>PayloadProperty
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadProperty<T> = keyof T;
+```
+
+Type corresponding to the properties of a payload
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+                ### <a id="PayloadSchema"></a>PayloadSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadSchema = z.infer<typeof PayloadSchemaZod>;
+```
+
+                ### <a id="PayloadSetPayload"></a>PayloadSetPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadSetPayload = Payload<PayloadSet, PayloadSetSchema>;
+```
+
+                ### <a id="PayloadSetSchema"></a>PayloadSetSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadSetSchema = typeof PayloadSetSchema;
+```
+
+                ### <a id="PayloadValidationFunction"></a>PayloadValidationFunction
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadValidationFunction<T> = 
+  | SyncPayloadValidationFunction<T>
+| AsyncPayloadValidationFunction<T>;
+```
+
+A function that validates the supplied payload
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+                ### <a id="PayloadValue"></a>PayloadValue
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadValue<T, Key> = T[Key];
+```
+
+Type corresponding to the payload values
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+### Key
+
+`Key` *extends* [`PayloadProperty`](#PayloadProperty)\<`T`\> = [`PayloadProperty`](#PayloadProperty)\<`T`\>
+
+                ### <a id="PayloadValueExpression"></a>PayloadValueExpression
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadValueExpression<T, Key, TValue> = (payload) => TValue;
+```
+
+An expressions that selects a property value from the payload
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+### Key
+
+`Key` *extends* [`PayloadProperty`](#PayloadProperty)\<`T`\> = [`PayloadProperty`](#PayloadProperty)\<`T`\>
+
+### TValue
+
+`TValue` = [`PayloadValue`](#PayloadValue)\<`T`, `Key`\>
+
+## Parameters
+
+### payload
+
+`T`
+
+## Returns
+
+`TValue`
+
+                ### <a id="PayloadWithSources"></a>PayloadWithSources
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadWithSources<T, S> = WithSources<Payload<T, S>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| [`SchemaField`](#../interfaces/SchemaField) = `void`
+
+### S
+
+`S` *extends* [`Schema`](#Schema) \| `void` = `void`
+
+                ### <a id="PayloadZodLoose"></a>PayloadZodLoose
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadZodLoose = typeof PayloadZodLoose;
+```
+
+                ### <a id="PayloadZodStrict"></a>PayloadZodStrict
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type PayloadZodStrict = typeof PayloadZodStrict;
+```
+
+                ### <a id="QualifiedSequence"></a>QualifiedSequence
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type QualifiedSequence = Brand<Hex, {
+  __qualifiedSequence: true;
+}>;
+```
+
+                ### <a id="Query"></a>Query
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type Query<T, S> = Payload<T extends void ? QueryFields : T & QueryFields, S extends void ? T extends SchemaField ? T["schema"] : T extends void ? Schema : void : S>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| [`SchemaField`](#../interfaces/SchemaField) = `void`
+
+### S
+
+`S` *extends* [`Schema`](#Schema) \| `void` = `void`
+
+                ### <a id="Schema"></a>Schema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type Schema<T> = z.infer<typeof SchemaZod> & BrandedSchema<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `string` = `string`
+
+                ### <a id="Sequence"></a>Sequence
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type Sequence = 
+  | LocalSequence
+  | QualifiedSequence;
+```
+
+                ### <a id="SequenceMeta"></a>SequenceMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type SequenceMeta = z.infer<typeof SequenceMetaZod>;
+```
+
+                ### <a id="StorageMeta"></a>StorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type StorageMeta = z.infer<typeof StorageMetaZod>;
+```
+
+                ### <a id="SyncPayloadValidationFunction"></a>SyncPayloadValidationFunction
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type SyncPayloadValidationFunction<T> = (payload) => boolean;
+```
+
+A function that validates the supplied payload synchronously
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+## Parameters
+
+### payload
+
+`T`
+
+## Returns
+
+`boolean`
+
+                ### <a id="WithAnySchema"></a>WithAnySchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithAnySchema<T> = OverridablePayload<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload)
+
+                ### <a id="WithHashMeta"></a>WithHashMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithHashMeta<T> = T & HashMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload)
+
+                ### <a id="WithOnlyClientMeta"></a>WithOnlyClientMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithOnlyClientMeta<T> = DeepPickStartsWith<T, "$">;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload)
+
+                ### <a id="WithOptionalSchema"></a>WithOptionalSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithOptionalSchema<T> = WithoutSchema<T> & Partial<T & SchemaField>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+                ### <a id="WithPartialSequenceStorageMeta"></a>WithPartialSequenceStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithPartialSequenceStorageMeta<T> = Partial<WithSequenceStorageMeta<T>>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+                ### <a id="WithPayload"></a>WithPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithPayload<T> = T extends EmptyObject ? PayloadFields & T : PayloadFields;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` \| `void` = `void`
+
+                ### <a id="WithSchema"></a>WithSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithSchema<T> = T extends EmptyObject ? SchemaField & T : PayloadFields;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` \| `void` = `void`
+
+                ### <a id="WithSequenceStorageMeta"></a>WithSequenceStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithSequenceStorageMeta<T> = T & SequenceStorageMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+                ### <a id="WithSources"></a>WithSources
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithSources<T> = T & SourcesMetaField;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject`
+
+                ### <a id="WithStorageMeta"></a>WithStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithStorageMeta<T> = T & StorageMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) = [`Payload`](#Payload)
+
+                ### <a id="WithTimestamp"></a>WithTimestamp
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithTimestamp<T> = T & Timestamp;
+```
+
+Add a timestamp field to any object
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` = `EmptyObject`
+
+                ### <a id="WithoutClientMeta"></a>WithoutClientMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithoutClientMeta<T> = DeepOmitStartsWith<T, "$"> & T extends Payload ? Payload : EmptyObject;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) \| `EmptyObject`
+
+                ### <a id="WithoutMeta"></a>WithoutMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithoutMeta<T> = WithoutClientMeta<WithoutStorageMeta<T>> & T extends Payload ? Payload : EmptyObject;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) \| `EmptyObject`
+
+                ### <a id="WithoutPrivateStorageMeta"></a>WithoutPrivateStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithoutPrivateStorageMeta<T> = DeepOmitStartsWith<T, "__"> & T extends Payload ? Payload : EmptyObject;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) \| `EmptyObject`
+
+                ### <a id="WithoutSchema"></a>WithoutSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithoutSchema<T> = Omit<T, "schema">;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`WithOptionalSchema`](#WithOptionalSchema)\<[`Payload`](#Payload)\>
+
+                ### <a id="WithoutStorageMeta"></a>WithoutStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+type WithoutStorageMeta<T> = DeepOmitStartsWith<T, "_"> & T extends Payload ? Payload : EmptyObject;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](#Payload) \| `EmptyObject`
+
+              ### variables
+
+                ### <a id="AnyPayloadZod"></a>AnyPayloadZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const AnyPayloadZod: ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $loose>;
+```
+
+                ### <a id="HashMetaZod"></a>HashMetaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const HashMetaZod: ZodObject<{
+  _hash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
+  _dataHash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
+}, $strip>;
+```
+
+                ### <a id="LocalSequenceConstants"></a>LocalSequenceConstants
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const LocalSequenceConstants: object;
+```
+
+## Type Declaration
+
+### nonceIndexBytes
+
+```ts
+nonceIndexBytes: number = 4;
+```
+
+### nonceHashBytes
+
+```ts
+nonceHashBytes: number = 4;
+```
+
+### epochBytes
+
+```ts
+epochBytes: number = 8;
+```
+
+### nonceBytes
+
+```ts
+nonceBytes: number;
+```
+
+### addressBytes
+
+```ts
+addressBytes: number = 20;
+```
+
+### minEpoch
+
+```ts
+minEpoch: Epoch;
+```
+
+### maxEpoch
+
+```ts
+maxEpoch: Epoch;
+```
+
+### minNonce
+
+```ts
+minNonce: Nonce;
+```
+
+### maxNonce
+
+```ts
+maxNonce: Nonce;
+```
+
+### minAddress
+
+```ts
+minAddress: BrandedAddress;
+```
+
+### maxAddress
+
+```ts
+maxAddress: BrandedAddress;
+```
+
+### localSequenceBytes
+
+```ts
+localSequenceBytes: number;
+```
+
+### minLocalSequence
+
+```ts
+minLocalSequence: LocalSequence;
+```
+
+### maxLocalSequence
+
+```ts
+maxLocalSequence: LocalSequence;
+```
+
+                ### <a id="LocalSequenceFromStringZod"></a>LocalSequenceFromStringZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const LocalSequenceFromStringZod: ZodPipe<ZodString, ZodTransform<LocalSequence, string>>;
+```
+
+                ### <a id="LocalSequenceToStringZod"></a>LocalSequenceToStringZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const LocalSequenceToStringZod: ZodString;
+```
+
+                ### <a id="ModuleErrorSchema"></a>ModuleErrorSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const ModuleErrorSchema: "network.xyo.error.module" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="PayloadBundleFieldsZod"></a>PayloadBundleFieldsZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadBundleFieldsZod: ZodObject<{
+  payloads: ZodArray<ZodObject<{
+     schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+  }, $strict>>;
+  root: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
+}, $strip>;
+```
+
+                ### <a id="PayloadBundleSchema"></a>PayloadBundleSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadBundleSchema: "network.xyo.payload.bundle" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="PayloadBundleZod"></a>PayloadBundleZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadBundleZod: ZodObject<{
+  payloads: ZodArray<ZodObject<{
+     schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+  }, $strict>>;
+  root: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
+  schema: ZodLiteral<"network.xyo.payload.bundle" & object>;
+}, $strip>;
+```
+
+                ### <a id="PayloadSchema"></a>PayloadSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadSchema: "network.xyo.payload" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="PayloadSchemaZod"></a>PayloadSchemaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadSchemaZod: ZodLiteral<"network.xyo.payload" & object>;
+```
+
+                ### <a id="PayloadSetSchema"></a>PayloadSetSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadSetSchema: "network.xyo.payload.set" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="PayloadZod"></a>PayloadZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadZod: ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $strip>;
+```
+
+                ### <a id="PayloadZodLoose"></a>PayloadZodLoose
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadZodLoose: PayloadZodStrict;
+```
+
+                ### <a id="PayloadZodStrict"></a>PayloadZodStrict
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const PayloadZodStrict: ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $strict>;
+```
+
+                ### <a id="QualifiedSequenceConstants"></a>QualifiedSequenceConstants
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const QualifiedSequenceConstants: object;
+```
+
+## Type Declaration
+
+### qualifiedSequenceBytes
+
+```ts
+qualifiedSequenceBytes: number;
+```
+
+### minQualifiedSequence
+
+```ts
+minQualifiedSequence: QualifiedSequence;
+```
+
+### maxQualifiedSequence
+
+```ts
+maxQualifiedSequence: QualifiedSequence;
+```
+
+                ### <a id="QualifiedSequenceFromStringZod"></a>QualifiedSequenceFromStringZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const QualifiedSequenceFromStringZod: ZodPipe<ZodString, ZodTransform<QualifiedSequence, string>>;
+```
+
+                ### <a id="QualifiedSequenceToStringZod"></a>QualifiedSequenceToStringZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const QualifiedSequenceToStringZod: ZodString;
+```
+
+                ### <a id="SchemaRegEx"></a>SchemaRegEx
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SchemaRegEx: RegExp;
+```
+
+                ### <a id="SchemaZod"></a>SchemaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SchemaZod: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+```
+
+                ### <a id="SequenceComparer"></a>SequenceComparer
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceComparer: object;
+```
+
+## Type Declaration
+
+### local
+
+```ts
+local: Compare<Sequence>;
+```
+
+### qualified
+
+```ts
+qualified: Compare<Sequence>;
+```
+
+                ### <a id="SequenceComponentLengths"></a>SequenceComponentLengths
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceComponentLengths: object;
+```
+
+## Type Declaration
+
+### nonceIndexBytes
+
+```ts
+nonceIndexBytes: number = 4;
+```
+
+### nonceHashBytes
+
+```ts
+nonceHashBytes: number = 4;
+```
+
+### epochBytes
+
+```ts
+epochBytes: number = 8;
+```
+
+### nonceBytes
+
+```ts
+nonceBytes: number;
+```
+
+### addressBytes
+
+```ts
+addressBytes: number = 20;
+```
+
+                ### <a id="SequenceComponentMinMax"></a>SequenceComponentMinMax
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceComponentMinMax: object;
+```
+
+## Type Declaration
+
+### minEpoch
+
+```ts
+minEpoch: Epoch;
+```
+
+### maxEpoch
+
+```ts
+maxEpoch: Epoch;
+```
+
+### minNonce
+
+```ts
+minNonce: Nonce;
+```
+
+### maxNonce
+
+```ts
+maxNonce: Nonce;
+```
+
+### minAddress
+
+```ts
+minAddress: BrandedAddress;
+```
+
+### maxAddress
+
+```ts
+maxAddress: BrandedAddress;
+```
+
+                ### <a id="SequenceConstants"></a>SequenceConstants
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceConstants: object;
+```
+
+## Type Declaration
+
+### nonceIndexBytes
+
+```ts
+nonceIndexBytes: number = 4;
+```
+
+### nonceHashBytes
+
+```ts
+nonceHashBytes: number = 4;
+```
+
+### epochBytes
+
+```ts
+epochBytes: number = 8;
+```
+
+### nonceBytes
+
+```ts
+nonceBytes: number;
+```
+
+### addressBytes
+
+```ts
+addressBytes: number = 20;
+```
+
+### minEpoch
+
+```ts
+minEpoch: Epoch;
+```
+
+### maxEpoch
+
+```ts
+maxEpoch: Epoch;
+```
+
+### minNonce
+
+```ts
+minNonce: Nonce;
+```
+
+### maxNonce
+
+```ts
+maxNonce: Nonce;
+```
+
+### minAddress
+
+```ts
+minAddress: BrandedAddress;
+```
+
+### maxAddress
+
+```ts
+maxAddress: BrandedAddress;
+```
+
+### localSequenceBytes
+
+```ts
+localSequenceBytes: number;
+```
+
+### minLocalSequence
+
+```ts
+minLocalSequence: LocalSequence;
+```
+
+### maxLocalSequence
+
+```ts
+maxLocalSequence: LocalSequence;
+```
+
+### qualifiedSequenceBytes
+
+```ts
+qualifiedSequenceBytes: number;
+```
+
+### minQualifiedSequence
+
+```ts
+minQualifiedSequence: QualifiedSequence;
+```
+
+### maxQualifiedSequence
+
+```ts
+maxQualifiedSequence: QualifiedSequence;
+```
+
+                ### <a id="SequenceFromStringZod"></a>SequenceFromStringZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceFromStringZod: ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<LocalSequence, string>>, ZodPipe<ZodString, ZodTransform<QualifiedSequence, string>>]>;
+```
+
+                ### <a id="SequenceMetaZod"></a>SequenceMetaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceMetaZod: ZodObject<{
+  _sequence: ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<LocalSequence, string>>, ZodPipe<ZodString, ZodTransform<QualifiedSequence, string>>]>;
+}, $strip>;
+```
+
+                ### <a id="SequenceNonceComponentLengths"></a>SequenceNonceComponentLengths
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceNonceComponentLengths: object;
+```
+
+## Type Declaration
+
+### nonceIndexBytes
+
+```ts
+nonceIndexBytes: number = 4;
+```
+
+### nonceHashBytes
+
+```ts
+nonceHashBytes: number = 4;
+```
+
+                ### <a id="SequenceToStringZod"></a>SequenceToStringZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const SequenceToStringZod: ZodUnion<readonly [ZodString, ZodString]>;
+```
+
+                ### <a id="StorageMetaZod"></a>StorageMetaZod
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const StorageMetaZod: ZodObject<{
+  _hash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
+  _dataHash: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
+  _sequence: ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<LocalSequence, string>>, ZodPipe<ZodString, ZodTransform<QualifiedSequence, string>>]>;
+}, $strip>;
+```
+
+                ### <a id="asAnyPayload"></a>asAnyPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asAnyPayload: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="asHashMeta"></a>asHashMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asHashMeta: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="asOptionalPayloadBundle"></a>asOptionalPayloadBundle
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asOptionalPayloadBundle: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="asOptionalSequenceStorageMeta"></a>asOptionalSequenceStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asOptionalSequenceStorageMeta: (value) => 
+  | SequenceStorageMeta
+  | undefined;
+```
+
+## Parameters
+
+### value
+
+`AnyNonPromise`
+
+## Returns
+
+  \| [`SequenceStorageMeta`](#../interfaces/SequenceStorageMeta)
+  \| `undefined`
+
+                ### <a id="asPayload"></a>asPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asPayload: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="asPayloadBundle"></a>asPayloadBundle
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asPayloadBundle: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="asSchema"></a>asSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asSchema: {
+<T>  (value): T & string & object | undefined;
+<T>  (value, assert): T & string & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & string & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `string` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & string & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `string` & `object`
+
+                ### <a id="asSequenceMeta"></a>asSequenceMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asSequenceMeta: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="asSequenceStorageMeta"></a>asSequenceStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asSequenceStorageMeta: AsTypeFunction<SequenceStorageMeta>;
+```
+
+                ### <a id="asStorageMeta"></a>asStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const asStorageMeta: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="isAnyPayload"></a>isAnyPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isAnyPayload: <T>(value) => value is T & { schema: BrandedSchema<string>; [key: string]: unknown };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`value is T & { schema: BrandedSchema<string>; [key: string]: unknown }`
+
+                ### <a id="isHashMeta"></a>isHashMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isHashMeta: <T>(value) => value is T & { _hash: BrandedHash; _dataHash: BrandedHash };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`value is T & { _hash: BrandedHash; _dataHash: BrandedHash }`
+
+                ### <a id="isModuleError"></a>isModuleError
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isModuleError: (x?) => x is ModuleError;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is ModuleError`
+
+                ### <a id="isPayload"></a>isPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isPayload: <T>(value) => value is T & { schema: BrandedSchema<string> };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`value is T & { schema: BrandedSchema<string> }`
+
+                ### <a id="isPayloadBundle"></a>isPayloadBundle
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isPayloadBundle: <T>(value) => value is T & { payloads: { schema: BrandedSchema<string> }[]; root: BrandedHash; schema: "network.xyo.payload.bundle" & { __schema: true } };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`value is T & { payloads: { schema: BrandedSchema<string> }[]; root: BrandedHash; schema: "network.xyo.payload.bundle" & { __schema: true } }`
+
+                ### <a id="isSchema"></a>isSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isSchema: <T>(value) => value is T & string & { __schema: true };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`value is T & string & { __schema: true }`
+
+                ### <a id="isSequenceMeta"></a>isSequenceMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isSequenceMeta: <T>(value) => value is T & { _sequence: LocalSequence | QualifiedSequence };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+value is T & \{ \_sequence: LocalSequence \| QualifiedSequence \}
+
+                ### <a id="isStorageMeta"></a>isStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const isStorageMeta: <T>(value) => value is T & { _hash: BrandedHash; _dataHash: BrandedHash; _sequence: LocalSequence | QualifiedSequence };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+value is T & \{ \_hash: BrandedHash; \_dataHash: BrandedHash; \_sequence: LocalSequence \| QualifiedSequence \}
+
+                ### <a id="toAnyPayload"></a>toAnyPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const toAnyPayload: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="toHashMeta"></a>toHashMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const toHashMeta: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="toPayload"></a>toPayload
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const toPayload: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="toSchema"></a>toSchema
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const toSchema: {
+<T>  (value): T & string & object | undefined;
+<T>  (value, assert): T & string & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & string & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `string` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & string & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `string` & `object`
+
+                ### <a id="toSequenceMeta"></a>toSequenceMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const toSequenceMeta: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="toStorageMeta"></a>toStorageMeta
+
+[**@xyo-network/payload-model**](#../README)
+
+***
+
+```ts
+const toStorageMeta: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
 
-## Credits
+`T` & `object`
 
-[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/payload-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/payload-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/payload-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE