@xyo-network/payload-model 3.6.0-rc.4 → 3.6.0-rc.5

package/dist/node/index.mjs

@@ -41,28 +41,150 @@ var isSchema = (value) => {
 };
 var asSchema = AsTypeFactory.create(isSchema);
 
-// src/StorageMeta.ts
-import {
-  isHash
-} from "@xylabs/hex";
-var StorageMetaComponentConstants = {
+// src/StorageMeta/Sequence.ts
+import { isHex } from "@xylabs/hex";
+var isEpoch = (value) => {
+  return isHex(value) && value.length === SequenceConstants.epochBytes * 2;
+};
+var isNonce = (value) => {
+  return isHex(value) && value.length === SequenceConstants.nonceBytes * 2;
+};
+var isLocalSequence = (value) => {
+  return isHex(value) && value.length === SequenceConstants.localSequenceBytes * 2;
+};
+var isQualifiedSequence = (value) => {
+  return isHex(value) && value.length === SequenceConstants.qualifiedSequenceBytes * 2;
+};
+var isSequence = (value) => {
+  return isLocalSequence(value) || isQualifiedSequence(value);
+};
+var SequenceComponentLengths = {
   epochBytes: 8,
   nonceBytes: 8,
   addressBytes: 20
 };
-var StorageMetaLocalConstants = {
-  maxEpoch: Math.pow(256, StorageMetaComponentConstants.epochBytes) - 1,
-  localSequenceBytes: StorageMetaComponentConstants.epochBytes + StorageMetaComponentConstants.nonceBytes,
-  minLocalSequence: "00000000000000000000000000000000",
-  maxLocalSequence: "ffffffffffffffffffffffffffffffff",
-  ...StorageMetaComponentConstants
+var SequenceComponentMinMax = {
+  minEpoch: "0".repeat(SequenceComponentLengths.epochBytes),
+  maxEpoch: "f".repeat(SequenceComponentLengths.epochBytes),
+  minNonce: "0".repeat(SequenceComponentLengths.nonceBytes),
+  maxNonce: "f".repeat(SequenceComponentLengths.nonceBytes),
+  minAddress: "0".repeat(SequenceComponentLengths.addressBytes),
+  maxAddress: "f".repeat(SequenceComponentLengths.addressBytes)
+};
+var LocalSequenceConstants = {
+  ...SequenceComponentLengths,
+  ...SequenceComponentMinMax,
+  localSequenceBytes: SequenceComponentLengths.epochBytes + SequenceComponentLengths.nonceBytes,
+  minLocalSequence: SequenceComponentMinMax.minEpoch + SequenceComponentMinMax.minNonce,
+  maxLocalSequence: SequenceComponentMinMax.maxEpoch + SequenceComponentMinMax.maxNonce
+};
+var QualifiedSequenceConstants = {
+  qualifiedSequenceBytes: LocalSequenceConstants.localSequenceBytes + SequenceComponentLengths.addressBytes,
+  minLocalSequence: LocalSequenceConstants.minLocalSequence + SequenceComponentMinMax.minAddress,
+  maxLocalSequence: LocalSequenceConstants.maxLocalSequence + SequenceComponentMinMax.maxAddress
 };
-var StorageMetaConstants = {
-  qualifiedSequenceBytes: StorageMetaLocalConstants.localSequenceBytes + StorageMetaComponentConstants.addressBytes,
-  minSequence: `${StorageMetaLocalConstants}0000000000000000000000000000000000000000`,
-  maxSequence: `${StorageMetaLocalConstants}ffffffffffffffffffffffffffffffffffffffff`,
-  ...StorageMetaLocalConstants
+var SequenceConstants = {
+  ...LocalSequenceConstants,
+  ...QualifiedSequenceConstants
+};
+
+// src/StorageMeta/SequenceParser.ts
+import { toUint8Array } from "@xylabs/arraybuffer";
+import { assertEx } from "@xylabs/assert";
+import {
+  isAddress,
+  toHex
+} from "@xylabs/hex";
+var SequenceParser = class _SequenceParser {
+  static privateConstructorKey = Date.now().toString();
+  data;
+  constructor(privateConstructorKey, hex) {
+    assertEx(_SequenceParser.privateConstructorKey === privateConstructorKey, () => "Use create function instead of constructor");
+    const paddedHex = toHex(hex, {
+      prefix: false,
+      bitLength: hex.length <= SequenceConstants.localSequenceBytes * 2 ? SequenceConstants.localSequenceBytes * 8 : SequenceConstants.qualifiedSequenceBytes * 8
+    });
+    this.data = toUint8Array(paddedHex);
+  }
+  get address() {
+    const start = SequenceConstants.localSequenceBytes;
+    const end = SequenceConstants.qualifiedSequenceBytes;
+    return toHex(this.data.slice(start, end).buffer, { prefix: false });
+  }
+  get epoch() {
+    const start = 0;
+    const end = SequenceConstants.epochBytes;
+    return toHex(this.data.slice(start, end).buffer, { prefix: false });
+  }
+  get localSequence() {
+    const start = 0;
+    const end = SequenceConstants.localSequenceBytes;
+    return toHex(this.data.slice(start, end).buffer, { prefix: false });
+  }
+  get nonce() {
+    const start = SequenceConstants.epochBytes;
+    const end = SequenceConstants.localSequenceBytes;
+    return toHex(this.data.slice(start, end).buffer, { prefix: false });
+  }
+  get qualifiedSequence() {
+    const start = 0;
+    const end = SequenceConstants.qualifiedSequenceBytes;
+    return toHex(this.data.slice(start, end).buffer, { prefix: false });
+  }
+  static from(timestampOrSequence, nonceOrAddress, address) {
+    if (isSequence(timestampOrSequence)) {
+      if (nonceOrAddress) {
+        assertEx(!isQualifiedSequence(timestampOrSequence), () => "Providing both a qualified sequence and a address is not allowed");
+        assertEx(isAddress(nonceOrAddress), () => "Invalid address provided");
+        return new this(_SequenceParser.privateConstructorKey, timestampOrSequence + address);
+      }
+      return new this(_SequenceParser.privateConstructorKey, timestampOrSequence);
+    }
+    const epoch = _SequenceParser.toEpoch(timestampOrSequence);
+    const nonce = _SequenceParser.toNonce(nonceOrAddress);
+    const addressHex = address ? toHex(address, { bitLength: SequenceConstants.addressBytes * 8 }) : "";
+    const hexString = epoch + nonce + addressHex;
+    assertEx(isSequence(hexString), () => `Invalid sequence [${hexString}] [${epoch}, ${nonce}, ${addressHex}]`);
+    return new this(_SequenceParser.privateConstructorKey, hexString);
+  }
+  static parse(value) {
+    const hex = toHex(value);
+    if (isSequence(hex)) {
+      return new this(_SequenceParser.privateConstructorKey, hex);
+    }
+    throw new Error(`Invalid sequence [${value}]`);
+  }
+  // can convert a short number/hex to an epoch (treats it as the whole value) or extract an epoch from a sequence
+  static toEpoch(value) {
+    assertEx(
+      typeof value !== "number" || Number.isInteger(value),
+      () => "Value must be in integer"
+    );
+    const hex = toHex(value, { prefix: false });
+    if (hex.length <= SequenceConstants.epochBytes * 2) {
+      return toHex(value, { prefix: false, bitLength: SequenceConstants.epochBytes * 8 });
+    }
+    if (isSequence(hex)) {
+      return hex.slice(0, SequenceConstants.epochBytes * 2);
+    }
+    throw new Error(`Value could not be converted to epoch [${hex}]`);
+  }
+  // can convert a short number/hex to a nonce (treats it as the whole value) or extract an nonce from a sequence
+  static toNonce(value) {
+    assertEx(
+      typeof value !== "number" || Number.isInteger(value),
+      () => "Value must be in integer"
+    );
+    const hex = toHex(value, { prefix: false });
+    if (isSequence(hex)) {
+      return hex.slice(SequenceConstants.epochBytes * 2, SequenceConstants.localSequenceBytes * 2);
+    }
+    return toHex(hex.slice(-SequenceConstants.nonceBytes), { prefix: false, bitLength: SequenceConstants.nonceBytes * 8 });
+  }
 };
+
+// src/StorageMeta/StorageMeta.ts
+import { isHash } from "@xylabs/hex";
 var isSequenceMeta = (value) => {
   return value?._sequence !== void 0;
 };
@@ -73,20 +195,30 @@ var isStorageMeta = (value) => {
   return isSequenceMeta(value) && isHashMeta(value);
 };
 export {
+  LocalSequenceConstants,
   ModuleErrorSchema,
   PayloadSchema,
   PayloadSetSchema,
-  StorageMetaConstants,
+  QualifiedSequenceConstants,
+  SequenceComponentLengths,
+  SequenceComponentMinMax,
+  SequenceConstants,
+  SequenceParser,
   asAnyPayload,
   asPayload,
   asSchema,
   isAnyPayload,
+  isEpoch,
   isHashMeta,
+  isLocalSequence,
   isModuleError,
+  isNonce,
   isPayload,
   isPayloadOfSchemaType,
   isPayloadOfSchemaTypeWithSources,
+  isQualifiedSequence,
   isSchema,
+  isSequence,
   isSequenceMeta,
   isStorageMeta,
   notPayloadOfSchemaType

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts","../../src/StorageMeta.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n  if (isObject(value)) {\n    return typeof value.schema === 'string'\n  }\n  return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n  = <T extends Payload>(schema: string[]) =>\n    (value: unknown): value is T => {\n      if (isAnyPayload(value)) {\n        return schema.includes(value.schema)\n      }\n      return false\n    }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is WithSources<T> =>\n    isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n  details?: JsonValue\n  message?: string\n  name?: string\n  query?: Hash\n  schema: ModuleErrorSchema\n  sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n  return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n  /**  Schema of the object */\n  schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n","import {\n  type Hash, type Hex, isHash,\n} from '@xylabs/hex'\n\nimport type { Payload } from './Payload.ts'\n\nexport interface SequenceMeta {\n  _sequence: Hex\n}\n\nexport type WithPartialSequenceMeta<T extends Payload = Payload> = Partial<WithSequenceMeta<T>>\n\nexport type WithSequenceMeta<T extends Payload = Payload> = T & SequenceMeta\n\nexport interface HashMeta {\n  _dataHash: Hash\n  _hash: Hash\n}\n\nexport type WithPartialHashMeta<T extends Payload = Payload> = Partial<WithHashMeta<T>>\n\nexport type WithHashMeta<T extends Payload = Payload> = T & HashMeta\n\nexport interface StorageMeta extends SequenceMeta, HashMeta {}\n\nexport type WithPartialStorageMeta<T extends Payload = Payload> = Partial<WithStorageMeta<T>>\n\nexport type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta\n\nconst StorageMetaComponentConstants = {\n  epochBytes: 8,\n  nonceBytes: 8,\n  addressBytes: 20,\n}\n\nconst StorageMetaLocalConstants = {\n  maxEpoch: Math.pow(256, StorageMetaComponentConstants.epochBytes) - 1,\n  localSequenceBytes: StorageMetaComponentConstants.epochBytes + StorageMetaComponentConstants.nonceBytes,\n  minLocalSequence: '00000000000000000000000000000000' as Hex,\n  maxLocalSequence: 'ffffffffffffffffffffffffffffffff' as Hex,\n  ...StorageMetaComponentConstants,\n}\n\nexport const StorageMetaConstants = {\n  qualifiedSequenceBytes: StorageMetaLocalConstants.localSequenceBytes + StorageMetaComponentConstants.addressBytes,\n  minSequence: `${StorageMetaLocalConstants}0000000000000000000000000000000000000000` as Hex,\n  maxSequence: `${StorageMetaLocalConstants}ffffffffffffffffffffffffffffffffffffffff` as Hex,\n  ...StorageMetaLocalConstants,\n}\n\nexport const isSequenceMeta = (value: unknown): value is SequenceMeta => {\n  return (value as WithSequenceMeta)?._sequence !== undefined\n}\n\nexport const isHashMeta = (value: unknown): value is HashMeta => {\n  return isHash((value as WithHashMeta)?._hash) && isHash((value as WithHashMeta)?._dataHash)\n}\n\nexport const isStorageMeta = (value: unknown): value is StorageMeta => {\n  return isSequenceMeta(value) && isHashMeta(value)\n}\n\n// \"00005a7f354762f3ac1bc5ddc6cfd08d14\" is and example of a local sequence string\n\n// \"00005a7f354762f3ac1bc5ddc6cfd08d14a123456789abcdef0123\" is and example of a local sequence string\n// epoch = \"00005a7f354762f3ac\"\n// nonce = \"1bc5ddc6cfd08d14\"\n// address = \"a123456789abcdef0123\"\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;ACnB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACPO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACjB1E,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;;;ACb7D;AAAA,EACuB;AAAA,OAChB;AA2BP,IAAM,gCAAgC;AAAA,EACpC,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,cAAc;AAChB;AAEA,IAAM,4BAA4B;AAAA,EAChC,UAAU,KAAK,IAAI,KAAK,8BAA8B,UAAU,IAAI;AAAA,EACpE,oBAAoB,8BAA8B,aAAa,8BAA8B;AAAA,EAC7F,kBAAkB;AAAA,EAClB,kBAAkB;AAAA,EAClB,GAAG;AACL;AAEO,IAAM,uBAAuB;AAAA,EAClC,wBAAwB,0BAA0B,qBAAqB,8BAA8B;AAAA,EACrG,aAAa,GAAG,yBAAyB;AAAA,EACzC,aAAa,GAAG,yBAAyB;AAAA,EACzC,GAAG;AACL;AAEO,IAAM,iBAAiB,CAAC,UAA0C;AACvE,SAAQ,OAA4B,cAAc;AACpD;AAEO,IAAM,aAAa,CAAC,UAAsC;AAC/D,SAAO,OAAQ,OAAwB,KAAK,KAAK,OAAQ,OAAwB,SAAS;AAC5F;AAEO,IAAM,gBAAgB,CAAC,UAAyC;AACrE,SAAO,eAAe,KAAK,KAAK,WAAW,KAAK;AAClD;","names":[]}
+{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts","../../src/StorageMeta/Sequence.ts","../../src/StorageMeta/SequenceParser.ts","../../src/StorageMeta/StorageMeta.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n  if (isObject(value)) {\n    return typeof value.schema === 'string'\n  }\n  return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n  = <T extends Payload>(schema: string[]) =>\n    (value: unknown): value is T => {\n      if (isAnyPayload(value)) {\n        return schema.includes(value.schema)\n      }\n      return false\n    }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is WithSources<T> =>\n    isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n  details?: JsonValue\n  message?: string\n  name?: string\n  query?: Hash\n  schema: ModuleErrorSchema\n  sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n  return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n  /**  Schema of the object */\n  schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n","import type { Address, Hex } from '@xylabs/hex'\nimport { isHex } from '@xylabs/hex'\n\n// we use Exclude to intentionally make the type not equal to string\nexport type LocalSequence = Hex & Exclude<string, 'reserved-local-sequence-value'>\nexport type QualifiedSequence = Hex & Exclude<string, 'reserved-qualified-sequence-value'>\nexport type Sequence = LocalSequence | QualifiedSequence\n\nexport type Epoch = Hex & Exclude<string, 'reserved-epoch-sequence-value'>\n\nexport const isEpoch = (value: unknown): value is Epoch => {\n  return isHex(value) && (value as string).length === SequenceConstants.epochBytes * 2\n}\n\nexport type Nonce = Hex & Exclude<string, 'reserved-nonce-sequence-value'>\n\nexport const isNonce = (value: unknown): value is Epoch => {\n  return isHex(value) && (value as string).length === SequenceConstants.nonceBytes * 2\n}\n\nexport const isLocalSequence = (value: unknown): value is Sequence => {\n  return isHex(value) && (value as string).length === (SequenceConstants.localSequenceBytes) * 2\n}\n\nexport const isQualifiedSequence = (value: unknown): value is Sequence => {\n  return isHex(value) && (value as string).length === (SequenceConstants.qualifiedSequenceBytes) * 2\n}\n\nexport const isSequence = (value: unknown): value is Sequence => {\n  return isLocalSequence(value) || isQualifiedSequence(value)\n}\n\nexport const SequenceComponentLengths = {\n  epochBytes: 8,\n  nonceBytes: 8,\n  addressBytes: 20,\n}\n\nexport const SequenceComponentMinMax = {\n  minEpoch: '0'.repeat(SequenceComponentLengths.epochBytes) as Epoch,\n  maxEpoch: 'f'.repeat(SequenceComponentLengths.epochBytes) as Epoch,\n  minNonce: '0'.repeat(SequenceComponentLengths.nonceBytes) as Nonce,\n  maxNonce: 'f'.repeat(SequenceComponentLengths.nonceBytes) as Nonce,\n  minAddress: '0'.repeat(SequenceComponentLengths.addressBytes) as Address,\n  maxAddress: 'f'.repeat(SequenceComponentLengths.addressBytes) as Address,\n}\n\nexport const LocalSequenceConstants = {\n  ...SequenceComponentLengths,\n  ...SequenceComponentMinMax,\n  localSequenceBytes: SequenceComponentLengths.epochBytes + SequenceComponentLengths.nonceBytes,\n  minLocalSequence: SequenceComponentMinMax.minEpoch + SequenceComponentMinMax.minNonce as LocalSequence,\n  maxLocalSequence: SequenceComponentMinMax.maxEpoch + SequenceComponentMinMax.maxNonce as LocalSequence,\n}\n\nexport const QualifiedSequenceConstants = {\n  qualifiedSequenceBytes: LocalSequenceConstants.localSequenceBytes + SequenceComponentLengths.addressBytes,\n  minLocalSequence: LocalSequenceConstants.minLocalSequence + SequenceComponentMinMax.minAddress as QualifiedSequence,\n  maxLocalSequence: LocalSequenceConstants.maxLocalSequence + SequenceComponentMinMax.maxAddress as QualifiedSequence,\n}\n\nexport const SequenceConstants = {\n  ...LocalSequenceConstants,\n  ...QualifiedSequenceConstants,\n}\n\n// \"11111111111111112222222222222222\" is and example of a local sequence string\n\n// \"111111111111111122222222222222223333333333333333333333333333333333333333\" is and example of a local sequence string\n// epoch = \"1111111111111111\"\n// nonce = \"2222222222222222\"\n// address = \"3333333333333333333333333333333333333333\"\n","import { toUint8Array } from '@xylabs/arraybuffer'\nimport { assertEx } from '@xylabs/assert'\nimport {\n  type Address,\n  type Hash, type Hex,\n  isAddress,\n  toHex,\n} from '@xylabs/hex'\n\nimport type {\n  Epoch, LocalSequence, Nonce, QualifiedSequence,\n  Sequence,\n} from './Sequence.ts'\nimport {\n  isQualifiedSequence, isSequence, SequenceConstants,\n} from './Sequence.ts'\n\nexport class SequenceParser {\n  protected static privateConstructorKey = Date.now().toString()\n\n  private readonly data: Readonly<Uint8Array>\n\n  protected constructor(privateConstructorKey: string, hex: Hex) {\n    assertEx(SequenceParser.privateConstructorKey === privateConstructorKey, () => 'Use create function instead of constructor')\n    const paddedHex = toHex(hex, {\n      prefix: false,\n      bitLength: (hex.length <= SequenceConstants.localSequenceBytes * 2)\n        ? SequenceConstants.localSequenceBytes * 8\n        : SequenceConstants.qualifiedSequenceBytes * 8,\n    })\n    this.data = toUint8Array(paddedHex)\n  }\n\n  get address(): Address {\n    const start = SequenceConstants.localSequenceBytes\n    const end = SequenceConstants.qualifiedSequenceBytes\n    return toHex(this.data.slice(start, end).buffer, { prefix: false })\n  }\n\n  get epoch(): Epoch {\n    const start = 0\n    const end = SequenceConstants.epochBytes\n    return toHex(this.data.slice(start, end).buffer, { prefix: false })\n  }\n\n  get localSequence(): LocalSequence {\n    const start = 0\n    const end = SequenceConstants.localSequenceBytes\n    return toHex(this.data.slice(start, end).buffer, { prefix: false })\n  }\n\n  get nonce(): Nonce {\n    const start = SequenceConstants.epochBytes\n    const end = SequenceConstants.localSequenceBytes\n    return toHex(this.data.slice(start, end).buffer, { prefix: false })\n  }\n\n  get qualifiedSequence(): QualifiedSequence {\n    const start = 0\n    const end = SequenceConstants.qualifiedSequenceBytes\n    return toHex(this.data.slice(start, end).buffer, { prefix: false })\n  }\n\n  static from(sequence: Sequence, address?: Address): SequenceParser\n  static from(timestamp: Hex, hash: Hash, address?: Address): SequenceParser\n  static from(timestamp: Hex, hash: Hex, address?: Address): SequenceParser\n  static from(timestamp: Hex, nonce: Nonce, address?: Address): SequenceParser\n  static from(timestamp: number, hash: Hash, address?: Address): SequenceParser\n  static from(timestamp: number, hash: Hex, address?: Address): SequenceParser\n  static from(timestamp: number, nonce: Nonce, address?: Address): SequenceParser\n  static from(timestampOrSequence: Sequence | Hex | number, nonceOrAddress: Hash | Nonce, address?: Address): SequenceParser {\n    if (isSequence(timestampOrSequence)) {\n      if (nonceOrAddress) {\n        assertEx(!isQualifiedSequence(timestampOrSequence), () => 'Providing both a qualified sequence and a address is not allowed')\n        assertEx(isAddress(nonceOrAddress), () => 'Invalid address provided')\n        return new this(SequenceParser.privateConstructorKey, (timestampOrSequence + address) as Hex)\n      }\n      return new this(SequenceParser.privateConstructorKey, timestampOrSequence)\n    }\n    const epoch = SequenceParser.toEpoch(timestampOrSequence)\n    const nonce = SequenceParser.toNonce(nonceOrAddress)\n    const addressHex: Hex = address ? toHex(address, { bitLength: SequenceConstants.addressBytes * 8 }) : '' as Hex\n    const hexString = (epoch + nonce + addressHex) as Hex\n    assertEx(isSequence(hexString), () => `Invalid sequence [${hexString}] [${epoch}, ${nonce}, ${addressHex}]`)\n    return new this(SequenceParser.privateConstructorKey, hexString)\n  }\n\n  static parse(value: Hex | string | ArrayBufferLike): SequenceParser {\n    const hex = toHex(value)\n    if (isSequence(hex)) {\n      return new this(SequenceParser.privateConstructorKey, hex)\n    }\n    throw new Error(`Invalid sequence [${value}]`)\n  }\n\n  // can convert a short number/hex to an epoch (treats it as the whole value) or extract an epoch from a sequence\n  static toEpoch(value: number | Hex | Epoch): Epoch {\n    assertEx(\n      typeof value !== 'number' || Number.isInteger(value),\n      () => 'Value must be in integer',\n    )\n    const hex = toHex(value, { prefix: false })\n    if (hex.length <= SequenceConstants.epochBytes * 2) {\n      return toHex(value, { prefix: false, bitLength: SequenceConstants.epochBytes * 8 }) as Epoch\n    }\n    if (isSequence(hex)) {\n      return hex.slice(0, SequenceConstants.epochBytes * 2) as Epoch\n    }\n    throw new Error(`Value could not be converted to epoch [${hex}]`)\n  }\n\n  // can convert a short number/hex to a nonce (treats it as the whole value) or extract an nonce from a sequence\n  static toNonce(value: Hash | Hex): Nonce {\n    assertEx(\n      typeof value !== 'number' || Number.isInteger(value),\n      () => 'Value must be in integer',\n    )\n    const hex = toHex(value, { prefix: false })\n    if (isSequence(hex)) {\n      return hex.slice(SequenceConstants.epochBytes * 2, SequenceConstants.localSequenceBytes * 2) as Nonce\n    }\n    return toHex((hex as string).slice(-SequenceConstants.nonceBytes), { prefix: false, bitLength: SequenceConstants.nonceBytes * 8 }) as Nonce\n  }\n}\n","import { type Hash, isHash } from '@xylabs/hex'\n\nimport type { Payload } from '../Payload.ts'\nimport type { Sequence } from './Sequence.ts'\n\nexport interface SequenceMeta {\n  _sequence: Sequence\n}\n\nexport type WithPartialSequenceMeta<T extends Payload = Payload> = Partial<WithSequenceMeta<T>>\n\nexport type WithSequenceMeta<T extends Payload = Payload> = T & SequenceMeta\n\nexport interface HashMeta {\n  _dataHash: Hash\n  _hash: Hash\n}\n\nexport type WithPartialHashMeta<T extends Payload = Payload> = Partial<WithHashMeta<T>>\n\nexport type WithHashMeta<T extends Payload = Payload> = T & HashMeta\n\nexport interface StorageMeta extends SequenceMeta, HashMeta {}\n\nexport type WithPartialStorageMeta<T extends Payload = Payload> = Partial<WithStorageMeta<T>>\n\nexport type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta\n\nexport const isSequenceMeta = (value: unknown): value is SequenceMeta => {\n  return (value as WithSequenceMeta)?._sequence !== undefined\n}\n\nexport const isHashMeta = (value: unknown): value is HashMeta => {\n  return isHash((value as WithHashMeta)?._hash) && isHash((value as WithHashMeta)?._dataHash)\n}\n\nexport const isStorageMeta = (value: unknown): value is StorageMeta => {\n  return isSequenceMeta(value) && isHashMeta(value)\n}\n\n// \"00005a7f354762f3ac1bc5ddc6cfd08d14\" is and example of a local sequence string\n\n// \"00005a7f354762f3ac1bc5ddc6cfd08d14a123456789abcdef0123\" is and example of a local sequence string\n// epoch = \"00005a7f354762f3ac\"\n// nonce = \"1bc5ddc6cfd08d14\"\n// address = \"a123456789abcdef0123\"\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;ACnB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACPO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACjB1E,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;;;ACZ7D,SAAS,aAAa;AASf,IAAM,UAAU,CAAC,UAAmC;AACzD,SAAO,MAAM,KAAK,KAAM,MAAiB,WAAW,kBAAkB,aAAa;AACrF;AAIO,IAAM,UAAU,CAAC,UAAmC;AACzD,SAAO,MAAM,KAAK,KAAM,MAAiB,WAAW,kBAAkB,aAAa;AACrF;AAEO,IAAM,kBAAkB,CAAC,UAAsC;AACpE,SAAO,MAAM,KAAK,KAAM,MAAiB,WAAY,kBAAkB,qBAAsB;AAC/F;AAEO,IAAM,sBAAsB,CAAC,UAAsC;AACxE,SAAO,MAAM,KAAK,KAAM,MAAiB,WAAY,kBAAkB,yBAA0B;AACnG;AAEO,IAAM,aAAa,CAAC,UAAsC;AAC/D,SAAO,gBAAgB,KAAK,KAAK,oBAAoB,KAAK;AAC5D;AAEO,IAAM,2BAA2B;AAAA,EACtC,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,cAAc;AAChB;AAEO,IAAM,0BAA0B;AAAA,EACrC,UAAU,IAAI,OAAO,yBAAyB,UAAU;AAAA,EACxD,UAAU,IAAI,OAAO,yBAAyB,UAAU;AAAA,EACxD,UAAU,IAAI,OAAO,yBAAyB,UAAU;AAAA,EACxD,UAAU,IAAI,OAAO,yBAAyB,UAAU;AAAA,EACxD,YAAY,IAAI,OAAO,yBAAyB,YAAY;AAAA,EAC5D,YAAY,IAAI,OAAO,yBAAyB,YAAY;AAC9D;AAEO,IAAM,yBAAyB;AAAA,EACpC,GAAG;AAAA,EACH,GAAG;AAAA,EACH,oBAAoB,yBAAyB,aAAa,yBAAyB;AAAA,EACnF,kBAAkB,wBAAwB,WAAW,wBAAwB;AAAA,EAC7E,kBAAkB,wBAAwB,WAAW,wBAAwB;AAC/E;AAEO,IAAM,6BAA6B;AAAA,EACxC,wBAAwB,uBAAuB,qBAAqB,yBAAyB;AAAA,EAC7F,kBAAkB,uBAAuB,mBAAmB,wBAAwB;AAAA,EACpF,kBAAkB,uBAAuB,mBAAmB,wBAAwB;AACtF;AAEO,IAAM,oBAAoB;AAAA,EAC/B,GAAG;AAAA,EACH,GAAG;AACL;;;AChEA,SAAS,oBAAoB;AAC7B,SAAS,gBAAgB;AACzB;AAAA,EAGE;AAAA,EACA;AAAA,OACK;AAUA,IAAM,iBAAN,MAAM,gBAAe;AAAA,EAC1B,OAAiB,wBAAwB,KAAK,IAAI,EAAE,SAAS;AAAA,EAE5C;AAAA,EAEP,YAAY,uBAA+B,KAAU;AAC7D,aAAS,gBAAe,0BAA0B,uBAAuB,MAAM,4CAA4C;AAC3H,UAAM,YAAY,MAAM,KAAK;AAAA,MAC3B,QAAQ;AAAA,MACR,WAAY,IAAI,UAAU,kBAAkB,qBAAqB,IAC7D,kBAAkB,qBAAqB,IACvC,kBAAkB,yBAAyB;AAAA,IACjD,CAAC;AACD,SAAK,OAAO,aAAa,SAAS;AAAA,EACpC;AAAA,EAEA,IAAI,UAAmB;AACrB,UAAM,QAAQ,kBAAkB;AAChC,UAAM,MAAM,kBAAkB;AAC9B,WAAO,MAAM,KAAK,KAAK,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,MAAM,CAAC;AAAA,EACpE;AAAA,EAEA,IAAI,QAAe;AACjB,UAAM,QAAQ;AACd,UAAM,MAAM,kBAAkB;AAC9B,WAAO,MAAM,KAAK,KAAK,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,MAAM,CAAC;AAAA,EACpE;AAAA,EAEA,IAAI,gBAA+B;AACjC,UAAM,QAAQ;AACd,UAAM,MAAM,kBAAkB;AAC9B,WAAO,MAAM,KAAK,KAAK,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,MAAM,CAAC;AAAA,EACpE;AAAA,EAEA,IAAI,QAAe;AACjB,UAAM,QAAQ,kBAAkB;AAChC,UAAM,MAAM,kBAAkB;AAC9B,WAAO,MAAM,KAAK,KAAK,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,MAAM,CAAC;AAAA,EACpE;AAAA,EAEA,IAAI,oBAAuC;AACzC,UAAM,QAAQ;AACd,UAAM,MAAM,kBAAkB;AAC9B,WAAO,MAAM,KAAK,KAAK,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,QAAQ,MAAM,CAAC;AAAA,EACpE;AAAA,EASA,OAAO,KAAK,qBAA8C,gBAA8B,SAAmC;AACzH,QAAI,WAAW,mBAAmB,GAAG;AACnC,UAAI,gBAAgB;AAClB,iBAAS,CAAC,oBAAoB,mBAAmB,GAAG,MAAM,kEAAkE;AAC5H,iBAAS,UAAU,cAAc,GAAG,MAAM,0BAA0B;AACpE,eAAO,IAAI,KAAK,gBAAe,uBAAwB,sBAAsB,OAAe;AAAA,MAC9F;AACA,aAAO,IAAI,KAAK,gBAAe,uBAAuB,mBAAmB;AAAA,IAC3E;AACA,UAAM,QAAQ,gBAAe,QAAQ,mBAAmB;AACxD,UAAM,QAAQ,gBAAe,QAAQ,cAAc;AACnD,UAAM,aAAkB,UAAU,MAAM,SAAS,EAAE,WAAW,kBAAkB,eAAe,EAAE,CAAC,IAAI;AACtG,UAAM,YAAa,QAAQ,QAAQ;AACnC,aAAS,WAAW,SAAS,GAAG,MAAM,qBAAqB,SAAS,MAAM,KAAK,KAAK,KAAK,KAAK,UAAU,GAAG;AAC3G,WAAO,IAAI,KAAK,gBAAe,uBAAuB,SAAS;AAAA,EACjE;AAAA,EAEA,OAAO,MAAM,OAAuD;AAClE,UAAM,MAAM,MAAM,KAAK;AACvB,QAAI,WAAW,GAAG,GAAG;AACnB,aAAO,IAAI,KAAK,gBAAe,uBAAuB,GAAG;AAAA,IAC3D;AACA,UAAM,IAAI,MAAM,qBAAqB,KAAK,GAAG;AAAA,EAC/C;AAAA;AAAA,EAGA,OAAO,QAAQ,OAAoC;AACjD;AAAA,MACE,OAAO,UAAU,YAAY,OAAO,UAAU,KAAK;AAAA,MACnD,MAAM;AAAA,IACR;AACA,UAAM,MAAM,MAAM,OAAO,EAAE,QAAQ,MAAM,CAAC;AAC1C,QAAI,IAAI,UAAU,kBAAkB,aAAa,GAAG;AAClD,aAAO,MAAM,OAAO,EAAE,QAAQ,OAAO,WAAW,kBAAkB,aAAa,EAAE,CAAC;AAAA,IACpF;AACA,QAAI,WAAW,GAAG,GAAG;AACnB,aAAO,IAAI,MAAM,GAAG,kBAAkB,aAAa,CAAC;AAAA,IACtD;AACA,UAAM,IAAI,MAAM,0CAA0C,GAAG,GAAG;AAAA,EAClE;AAAA;AAAA,EAGA,OAAO,QAAQ,OAA0B;AACvC;AAAA,MACE,OAAO,UAAU,YAAY,OAAO,UAAU,KAAK;AAAA,MACnD,MAAM;AAAA,IACR;AACA,UAAM,MAAM,MAAM,OAAO,EAAE,QAAQ,MAAM,CAAC;AAC1C,QAAI,WAAW,GAAG,GAAG;AACnB,aAAO,IAAI,MAAM,kBAAkB,aAAa,GAAG,kBAAkB,qBAAqB,CAAC;AAAA,IAC7F;AACA,WAAO,MAAO,IAAe,MAAM,CAAC,kBAAkB,UAAU,GAAG,EAAE,QAAQ,OAAO,WAAW,kBAAkB,aAAa,EAAE,CAAC;AAAA,EACnI;AACF;;;AC3HA,SAAoB,cAAc;AA4B3B,IAAM,iBAAiB,CAAC,UAA0C;AACvE,SAAQ,OAA4B,cAAc;AACpD;AAEO,IAAM,aAAa,CAAC,UAAsC;AAC/D,SAAO,OAAQ,OAAwB,KAAK,KAAK,OAAQ,OAAwB,SAAS;AAC5F;AAEO,IAAM,gBAAgB,CAAC,UAAyC;AACrE,SAAO,eAAe,KAAK,KAAK,WAAW,KAAK;AAClD;","names":[]}

package/dist/node/isPayload.d.ts

@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
 export declare const asAnyPayload: {
     <TType extends {
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.13-f119ea3c1f/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.14-a00a2a7e8e/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
     <TType extends {
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.13-f119ea3c1f/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.14-a00a2a7e8e/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
         schema: string;
     } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
 export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
 export declare const asPayload: <T extends Payload>(schema: string[]) => {
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.13-f119ea3c1f/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.13-f119ea3c1f/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.14-a00a2a7e8e/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.14-a00a2a7e8e/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
 //# sourceMappingURL=isPayload.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-model",
-  "version": "3.6.0-rc.4",
+  "version": "3.6.0-rc.5",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -37,13 +37,15 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/hex": "^4.4.13",
-    "@xylabs/object": "^4.4.13"
+    "@xylabs/arraybuffer": "^4.4.14",
+    "@xylabs/assert": "^4.4.14",
+    "@xylabs/hex": "^4.4.14",
+    "@xylabs/object": "^4.4.14"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^4.2.4",
     "@xylabs/tsconfig": "^4.2.4",
-    "@xylabs/vitest-extended": "^4.4.13",
+    "@xylabs/vitest-extended": "^4.4.14",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
   },

package/src/StorageMeta/Sequence.ts

@@ -0,0 +1,72 @@
+import type { Address, Hex } from '@xylabs/hex'
+import { isHex } from '@xylabs/hex'
+
+// we use Exclude to intentionally make the type not equal to string
+export type LocalSequence = Hex & Exclude<string, 'reserved-local-sequence-value'>
+export type QualifiedSequence = Hex & Exclude<string, 'reserved-qualified-sequence-value'>
+export type Sequence = LocalSequence | QualifiedSequence
+
+export type Epoch = Hex & Exclude<string, 'reserved-epoch-sequence-value'>
+
+export const isEpoch = (value: unknown): value is Epoch => {
+  return isHex(value) && (value as string).length === SequenceConstants.epochBytes * 2
+}
+
+export type Nonce = Hex & Exclude<string, 'reserved-nonce-sequence-value'>
+
+export const isNonce = (value: unknown): value is Epoch => {
+  return isHex(value) && (value as string).length === SequenceConstants.nonceBytes * 2
+}
+
+export const isLocalSequence = (value: unknown): value is Sequence => {
+  return isHex(value) && (value as string).length === (SequenceConstants.localSequenceBytes) * 2
+}
+
+export const isQualifiedSequence = (value: unknown): value is Sequence => {
+  return isHex(value) && (value as string).length === (SequenceConstants.qualifiedSequenceBytes) * 2
+}
+
+export const isSequence = (value: unknown): value is Sequence => {
+  return isLocalSequence(value) || isQualifiedSequence(value)
+}
+
+export const SequenceComponentLengths = {
+  epochBytes: 8,
+  nonceBytes: 8,
+  addressBytes: 20,
+}
+
+export const SequenceComponentMinMax = {
+  minEpoch: '0'.repeat(SequenceComponentLengths.epochBytes) as Epoch,
+  maxEpoch: 'f'.repeat(SequenceComponentLengths.epochBytes) as Epoch,
+  minNonce: '0'.repeat(SequenceComponentLengths.nonceBytes) as Nonce,
+  maxNonce: 'f'.repeat(SequenceComponentLengths.nonceBytes) as Nonce,
+  minAddress: '0'.repeat(SequenceComponentLengths.addressBytes) as Address,
+  maxAddress: 'f'.repeat(SequenceComponentLengths.addressBytes) as Address,
+}
+
+export const LocalSequenceConstants = {
+  ...SequenceComponentLengths,
+  ...SequenceComponentMinMax,
+  localSequenceBytes: SequenceComponentLengths.epochBytes + SequenceComponentLengths.nonceBytes,
+  minLocalSequence: SequenceComponentMinMax.minEpoch + SequenceComponentMinMax.minNonce as LocalSequence,
+  maxLocalSequence: SequenceComponentMinMax.maxEpoch + SequenceComponentMinMax.maxNonce as LocalSequence,
+}
+
+export const QualifiedSequenceConstants = {
+  qualifiedSequenceBytes: LocalSequenceConstants.localSequenceBytes + SequenceComponentLengths.addressBytes,
+  minLocalSequence: LocalSequenceConstants.minLocalSequence + SequenceComponentMinMax.minAddress as QualifiedSequence,
+  maxLocalSequence: LocalSequenceConstants.maxLocalSequence + SequenceComponentMinMax.maxAddress as QualifiedSequence,
+}
+
+export const SequenceConstants = {
+  ...LocalSequenceConstants,
+  ...QualifiedSequenceConstants,
+}
+
+// "11111111111111112222222222222222" is and example of a local sequence string
+
+// "111111111111111122222222222222223333333333333333333333333333333333333333" is and example of a local sequence string
+// epoch = "1111111111111111"
+// nonce = "2222222222222222"
+// address = "3333333333333333333333333333333333333333"

package/src/StorageMeta/SequenceParser.ts

@@ -0,0 +1,124 @@
+import { toUint8Array } from '@xylabs/arraybuffer'
+import { assertEx } from '@xylabs/assert'
+import {
+  type Address,
+  type Hash, type Hex,
+  isAddress,
+  toHex,
+} from '@xylabs/hex'
+
+import type {
+  Epoch, LocalSequence, Nonce, QualifiedSequence,
+  Sequence,
+} from './Sequence.ts'
+import {
+  isQualifiedSequence, isSequence, SequenceConstants,
+} from './Sequence.ts'
+
+export class SequenceParser {
+  protected static privateConstructorKey = Date.now().toString()
+
+  private readonly data: Readonly<Uint8Array>
+
+  protected constructor(privateConstructorKey: string, hex: Hex) {
+    assertEx(SequenceParser.privateConstructorKey === privateConstructorKey, () => 'Use create function instead of constructor')
+    const paddedHex = toHex(hex, {
+      prefix: false,
+      bitLength: (hex.length <= SequenceConstants.localSequenceBytes * 2)
+        ? SequenceConstants.localSequenceBytes * 8
+        : SequenceConstants.qualifiedSequenceBytes * 8,
+    })
+    this.data = toUint8Array(paddedHex)
+  }
+
+  get address(): Address {
+    const start = SequenceConstants.localSequenceBytes
+    const end = SequenceConstants.qualifiedSequenceBytes
+    return toHex(this.data.slice(start, end).buffer, { prefix: false })
+  }
+
+  get epoch(): Epoch {
+    const start = 0
+    const end = SequenceConstants.epochBytes
+    return toHex(this.data.slice(start, end).buffer, { prefix: false })
+  }
+
+  get localSequence(): LocalSequence {
+    const start = 0
+    const end = SequenceConstants.localSequenceBytes
+    return toHex(this.data.slice(start, end).buffer, { prefix: false })
+  }
+
+  get nonce(): Nonce {
+    const start = SequenceConstants.epochBytes
+    const end = SequenceConstants.localSequenceBytes
+    return toHex(this.data.slice(start, end).buffer, { prefix: false })
+  }
+
+  get qualifiedSequence(): QualifiedSequence {
+    const start = 0
+    const end = SequenceConstants.qualifiedSequenceBytes
+    return toHex(this.data.slice(start, end).buffer, { prefix: false })
+  }
+
+  static from(sequence: Sequence, address?: Address): SequenceParser
+  static from(timestamp: Hex, hash: Hash, address?: Address): SequenceParser
+  static from(timestamp: Hex, hash: Hex, address?: Address): SequenceParser
+  static from(timestamp: Hex, nonce: Nonce, address?: Address): SequenceParser
+  static from(timestamp: number, hash: Hash, address?: Address): SequenceParser
+  static from(timestamp: number, hash: Hex, address?: Address): SequenceParser
+  static from(timestamp: number, nonce: Nonce, address?: Address): SequenceParser
+  static from(timestampOrSequence: Sequence | Hex | number, nonceOrAddress: Hash | Nonce, address?: Address): SequenceParser {
+    if (isSequence(timestampOrSequence)) {
+      if (nonceOrAddress) {
+        assertEx(!isQualifiedSequence(timestampOrSequence), () => 'Providing both a qualified sequence and a address is not allowed')
+        assertEx(isAddress(nonceOrAddress), () => 'Invalid address provided')
+        return new this(SequenceParser.privateConstructorKey, (timestampOrSequence + address) as Hex)
+      }
+      return new this(SequenceParser.privateConstructorKey, timestampOrSequence)
+    }
+    const epoch = SequenceParser.toEpoch(timestampOrSequence)
+    const nonce = SequenceParser.toNonce(nonceOrAddress)
+    const addressHex: Hex = address ? toHex(address, { bitLength: SequenceConstants.addressBytes * 8 }) : '' as Hex
+    const hexString = (epoch + nonce + addressHex) as Hex
+    assertEx(isSequence(hexString), () => `Invalid sequence [${hexString}] [${epoch}, ${nonce}, ${addressHex}]`)
+    return new this(SequenceParser.privateConstructorKey, hexString)
+  }
+
+  static parse(value: Hex | string | ArrayBufferLike): SequenceParser {
+    const hex = toHex(value)
+    if (isSequence(hex)) {
+      return new this(SequenceParser.privateConstructorKey, hex)
+    }
+    throw new Error(`Invalid sequence [${value}]`)
+  }
+
+  // can convert a short number/hex to an epoch (treats it as the whole value) or extract an epoch from a sequence
+  static toEpoch(value: number | Hex | Epoch): Epoch {
+    assertEx(
+      typeof value !== 'number' || Number.isInteger(value),
+      () => 'Value must be in integer',
+    )
+    const hex = toHex(value, { prefix: false })
+    if (hex.length <= SequenceConstants.epochBytes * 2) {
+      return toHex(value, { prefix: false, bitLength: SequenceConstants.epochBytes * 8 }) as Epoch
+    }
+    if (isSequence(hex)) {
+      return hex.slice(0, SequenceConstants.epochBytes * 2) as Epoch
+    }
+    throw new Error(`Value could not be converted to epoch [${hex}]`)
+  }
+
+  // can convert a short number/hex to a nonce (treats it as the whole value) or extract an nonce from a sequence
+  static toNonce(value: Hash | Hex): Nonce {
+    assertEx(
+      typeof value !== 'number' || Number.isInteger(value),
+      () => 'Value must be in integer',
+    )
+    const hex = toHex(value, { prefix: false })
+    if (isSequence(hex)) {
+      return hex.slice(SequenceConstants.epochBytes * 2, SequenceConstants.localSequenceBytes * 2) as Nonce
+    }
+    return toHex((hex as string).slice(-SequenceConstants.nonceBytes), { prefix: false, bitLength: SequenceConstants.nonceBytes * 8 }) as Nonce
+  }
+}

package/src/{StorageMeta.ts → StorageMeta/StorageMeta.ts}

@@ -1,11 +1,10 @@
-import {
-  type Hash, type Hex, isHash,
-} from '@xylabs/hex'
+import { type Hash, isHash } from '@xylabs/hex'
 
-import type { Payload } from './Payload.ts'
+import type { Payload } from '../Payload.ts'
+import type { Sequence } from './Sequence.ts'
 
 export interface SequenceMeta {
-  _sequence: Hex
+  _sequence: Sequence
 }
 
 export type WithPartialSequenceMeta<T extends Payload = Payload> = Partial<WithSequenceMeta<T>>
@@ -27,27 +26,6 @@ export type WithPartialStorageMeta<T extends Payload = Payload> = Partial<WithSt
 
 export type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta
 
-const StorageMetaComponentConstants = {
-  epochBytes: 8,
-  nonceBytes: 8,
-  addressBytes: 20,
-}
-
-const StorageMetaLocalConstants = {
-  maxEpoch: Math.pow(256, StorageMetaComponentConstants.epochBytes) - 1,
-  localSequenceBytes: StorageMetaComponentConstants.epochBytes + StorageMetaComponentConstants.nonceBytes,
-  minLocalSequence: '00000000000000000000000000000000' as Hex,
-  maxLocalSequence: 'ffffffffffffffffffffffffffffffff' as Hex,
-  ...StorageMetaComponentConstants,
-}
-
-export const StorageMetaConstants = {
-  qualifiedSequenceBytes: StorageMetaLocalConstants.localSequenceBytes + StorageMetaComponentConstants.addressBytes,
-  minSequence: `${StorageMetaLocalConstants}0000000000000000000000000000000000000000` as Hex,
-  maxSequence: `${StorageMetaLocalConstants}ffffffffffffffffffffffffffffffffffffffff` as Hex,
-  ...StorageMetaLocalConstants,
-}
-
 export const isSequenceMeta = (value: unknown): value is SequenceMeta => {
   return (value as WithSequenceMeta)?._sequence !== undefined
 }

package/src/StorageMeta/index.ts

@@ -0,0 +1,3 @@
+export * from './Sequence.ts'
+export * from './SequenceParser.ts'
+export * from './StorageMeta.ts'

package/src/index.ts

@@ -8,4 +8,4 @@ export * from './PayloadValidationFunction.ts'
 export * from './PayloadValueExpression.ts'
 export * from './Query.ts'
 export * from './Schema.ts'
-export * from './StorageMeta.ts'
+export * from './StorageMeta/index.ts'

package/dist/browser/StorageMeta.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageMeta.d.ts","sourceRoot":"","sources":["../../src/StorageMeta.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EAAE,KAAK,GAAG,EACpB,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,GAAG,CAAA;CACf;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/F,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,YAAY,CAAA;AAE5E,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,IAAI,CAAA;IACf,KAAK,EAAE,IAAI,CAAA;CACZ;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAEvF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAA;AAEpE,MAAM,WAAW,WAAY,SAAQ,YAAY,EAAE,QAAQ;CAAG;AAE9D,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7F,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,WAAW,CAAA;AAgB1E,eAAO,MAAM,oBAAoB;;;;;;sBALyB,GAAG;sBACH,GAAG;;iBAM4B,GAAG;iBACH,GAAG;CAE3F,CAAA;AAED,eAAO,MAAM,cAAc,UAAW,OAAO,KAAG,KAAK,IAAI,YAExD,CAAA;AAED,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,QAEpD,CAAA;AAED,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA"}

package/dist/neutral/StorageMeta.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageMeta.d.ts","sourceRoot":"","sources":["../../src/StorageMeta.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EAAE,KAAK,GAAG,EACpB,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,GAAG,CAAA;CACf;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/F,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,YAAY,CAAA;AAE5E,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,IAAI,CAAA;IACf,KAAK,EAAE,IAAI,CAAA;CACZ;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAEvF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAA;AAEpE,MAAM,WAAW,WAAY,SAAQ,YAAY,EAAE,QAAQ;CAAG;AAE9D,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7F,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,WAAW,CAAA;AAgB1E,eAAO,MAAM,oBAAoB;;;;;;sBALyB,GAAG;sBACH,GAAG;;iBAM4B,GAAG;iBACH,GAAG;CAE3F,CAAA;AAED,eAAO,MAAM,cAAc,UAAW,OAAO,KAAG,KAAK,IAAI,YAExD,CAAA;AAED,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,QAEpD,CAAA;AAED,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA"}

package/dist/node/StorageMeta.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageMeta.d.ts","sourceRoot":"","sources":["../../src/StorageMeta.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EAAE,KAAK,GAAG,EACpB,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,GAAG,CAAA;CACf;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/F,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,YAAY,CAAA;AAE5E,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,IAAI,CAAA;IACf,KAAK,EAAE,IAAI,CAAA;CACZ;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAEvF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAA;AAEpE,MAAM,WAAW,WAAY,SAAQ,YAAY,EAAE,QAAQ;CAAG;AAE9D,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7F,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,WAAW,CAAA;AAgB1E,eAAO,MAAM,oBAAoB;;;;;;sBALyB,GAAG;sBACH,GAAG;;iBAM4B,GAAG;iBACH,GAAG;CAE3F,CAAA;AAED,eAAO,MAAM,cAAc,UAAW,OAAO,KAAG,KAAK,IAAI,YAExD,CAAA;AAED,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,QAEpD,CAAA;AAED,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA"}