@xyo-network/core 2.20.45 → 2.21.0

package/src/Payload/Validator/BodyValidator.ts

@@ -1,22 +1,17 @@
-import { WithStringIndex } from '../../models'
+import { XyoValidator } from '../../lib'
+import { XyoPayload } from '../../models'
 import { XyoSchemaNameValidator } from '../../SchemaNameValidator'
-import { XyoPayloadBody } from '../models'
-
-class XyoPayloadBodyValidator {
-  private body: WithStringIndex<XyoPayloadBody>
-  constructor(body: XyoPayloadBody) {
-    this.body = body as WithStringIndex<XyoPayloadBody>
-  }
 
+export class XyoPayloadBodyValidator<T extends XyoPayload = XyoPayload> extends XyoValidator<T> {
   private _schemaValidator?: XyoSchemaNameValidator
   get schemaValidator() {
-    this._schemaValidator = this._schemaValidator ?? new XyoSchemaNameValidator(this.body.schema ?? '')
+    this._schemaValidator = this._schemaValidator ?? new XyoSchemaNameValidator(this.obj.schema ?? '')
     return this._schemaValidator
   }
 
   public schemaName() {
     const errors: Error[] = []
-    if (this.body.schema === undefined) {
+    if (this.obj.schema === undefined) {
       errors.push(Error('schema missing'))
     } else {
       errors.push(...this.schemaValidator.all())
@@ -24,11 +19,9 @@ class XyoPayloadBodyValidator {
     return errors
   }
 
-  public all() {
+  public validate() {
     const errors: Error[] = []
     errors.push(...this.schemaName())
     return errors
   }
 }
-
-export { XyoPayloadBodyValidator }

package/src/Payload/Validator/MetaValidator.spec.ts

@@ -4,7 +4,7 @@ import { XyoPayloadMetaValidator } from './MetaValidator'
 
 test('all', () => {
   const validator = new XyoPayloadMetaValidator(testPayload)
-  const errors = validator.all()
+  const errors = validator.validate()
   dumpErrors(errors)
   expect(errors.length).toBe(0)
 })

package/src/Payload/Validator/MetaValidator.ts

@@ -1,34 +1,30 @@
 import { XyoHasher } from '../../Hasher'
-import { XyoPayload } from '../models'
+import { XyoValidator } from '../../lib'
+import { XyoPayloadMeta } from '../../models'
 
 const MIN_ALLOWED_TIMESTAMP = 1609459200000
 const MAX_ALLOWED_TIMESTAMP = 4102444800000
 
-class XyoPayloadMetaValidator {
-  private payload: XyoPayload
-  constructor(payload: XyoPayload) {
-    this.payload = payload
-  }
-
+class XyoPayloadMetaValidator<T extends XyoPayloadMeta = XyoPayloadMeta> extends XyoValidator<T> {
   public hash() {
     const errors: Error[] = []
-    const wrapper = new XyoHasher(this.payload)
+    const wrapper = new XyoHasher(this.obj)
 
     const bodyHash = wrapper.hash
-    if (bodyHash !== this.payload._hash) errors.push(new Error(`Body hash mismatch: [calculated: ${bodyHash}] [found: ${this.payload._hash}]`))
+    if (bodyHash !== this.obj._hash) errors.push(new Error(`Body hash mismatch: [calculated: ${bodyHash}] [found: ${this.obj._hash}]`))
     return errors
   }
 
   public timestamp() {
     const errors: Error[] = []
-    const { _timestamp } = this.payload
+    const { _timestamp } = this.obj
     if (_timestamp === undefined) errors.push(new Error('Missing _timestamp'))
     else if (_timestamp < MIN_ALLOWED_TIMESTAMP) errors.push(new Error('_timestamp is before year 2021'))
     else if (_timestamp > MAX_ALLOWED_TIMESTAMP) errors.push(new Error('_timestamp is after year 2100'))
     return errors
   }
 
-  public all() {
+  public validate() {
     const errors: Error[] = []
     errors.push(...this.hash(), ...this.timestamp())
     return errors

package/src/Payload/Validator/Validator.spec.ts

@@ -1,53 +1,53 @@
 import { dumpErrors } from '../../lib'
-import { XyoPayload } from '../models'
+import { XyoPayloadWithMeta } from '../../models'
 import { XyoPayloadValidator } from './Validator'
 
-const testPayloadNoSchema: XyoPayload = {
+const testPayloadNoSchema: XyoPayloadWithMeta = {
   _hash: '44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a',
   _timestamp: 1609459255555,
-} as XyoPayload
-const testPayloadMixedCase: XyoPayload = {
+} as XyoPayloadWithMeta
+const testPayloadMixedCase: XyoPayloadWithMeta = {
   _hash: '9a67116e05c33135f6ba23768f9a3fbbba155297ee1bb0a7e21d91fdc3835769',
   _timestamp: 1609459255555,
   schema: 'network.xyo.testMixedCaseSchema',
-}
-const testPayloadTooFewLevels: XyoPayload = {
+} as XyoPayloadWithMeta
+const testPayloadTooFewLevels: XyoPayloadWithMeta = {
   _hash: '95206b26e3173deaac5e3f5d4510d50112b6348d3a2128b1eb6fe3ca66957628',
   _timestamp: 1609459255555,
   schema: 'network.xyo',
-}
-const testPayloadDoesNotExist: XyoPayload = {
+} as XyoPayloadWithMeta
+const testPayloadDoesNotExist: XyoPayloadWithMeta = {
   _hash: '360b4ce36862ef2a20dd572d69283a86d351b2b4a9cd4f61ae6f7a320be81dbf',
   _timestamp: 1609459255555,
   schema: 'network.dfd-sf-sf-s.blahblah',
-}
-const testPayloadValid: XyoPayload = {
+} as XyoPayloadWithMeta
+const testPayloadValid: XyoPayloadWithMeta = {
   _hash: '4b5958c6d16b26d6790e33f5be45578728b0ea36e40a0d1b9c9164822341cac1',
   _timestamp: 1609459255555,
   schema: 'network.xyo.test',
-}
+} as XyoPayloadWithMeta
 
 test('all [missing schema]', () => {
   const validator = new XyoPayloadValidator(testPayloadNoSchema)
-  const errors = validator.all()
+  const errors = validator.validate()
   expect(errors.length).toBe(1)
 })
 
 test('all [mixed case]', () => {
   const validator = new XyoPayloadValidator(testPayloadMixedCase)
-  const errors = validator.all()
+  const errors = validator.validate()
   expect(errors.length).toBe(1)
 })
 
 test('all [too few levels]', () => {
   const validator = new XyoPayloadValidator(testPayloadTooFewLevels)
-  const errors = validator.all()
+  const errors = validator.validate()
   expect(errors.length).toBe(1)
 })
 
 test('all [does not exist]', () => {
   const validator = new XyoPayloadValidator(testPayloadDoesNotExist)
-  const errors = validator.all()
+  const errors = validator.validate()
   dumpErrors(errors)
   expect(errors.length).toBe(0)
 })
@@ -56,7 +56,7 @@ test('all [valid]', () => {
   const validator = new XyoPayloadValidator(testPayloadValid)
 
   let errors: Error[] = []
-  errors = validator.all()
+  errors = validator.validate()
   dumpErrors(errors)
   expect(errors.length).toBe(0)
 })

package/src/Payload/Validator/Validator.ts

@@ -1,22 +1,20 @@
-import { XyoPayload } from '../models'
+import { XyoValidator } from '../../lib'
+import { XyoPayloadWithMeta } from '../../models'
 import { XyoPayloadBodyValidator } from './BodyValidator'
 import { XyoPayloadMetaValidator } from './MetaValidator'
 
-class XyoPayloadValidator<T extends XyoPayload = XyoPayload> {
-  protected payload: T
+export class XyoPayloadValidator<T extends XyoPayloadWithMeta = XyoPayloadWithMeta> extends XyoValidator<T> {
   public body: XyoPayloadBodyValidator
   public meta: XyoPayloadMetaValidator
   constructor(payload: T) {
-    this.payload = payload
+    super(payload)
     this.body = new XyoPayloadBodyValidator(payload)
     this.meta = new XyoPayloadMetaValidator(payload)
   }
 
-  public all() {
+  public validate() {
     const errors: Error[] = []
-    errors.push(...this.body.all())
+    errors.push(...this.body.validate())
     return errors
   }
 }
-
-export { XyoPayloadValidator }

package/src/Payload/Wrapper/Validator.ts

@@ -1,20 +1,16 @@
-import { XyoPayload } from '../models'
+import { XyoValidator } from '../../lib'
+import { XyoPayloadWithMeta } from '../../models'
 import { XyoPayloadValidator } from '../Validator'
 import { XyoPayloadWrapper } from './Wrapper'
 
-export class XyoPayloadWrapperValidator<T extends XyoPayloadWrapper<XyoPayload> = XyoPayloadWrapper<XyoPayload>> {
-  protected wrapper: T
-  constructor(wrapper: T) {
-    this.wrapper = wrapper
-  }
-
+export class XyoPayloadWrapperValidator<T extends XyoPayloadWrapper<XyoPayloadWithMeta> = XyoPayloadWrapper<XyoPayloadWithMeta>> extends XyoValidator<T> {
   public get payload() {
-    return new XyoPayloadValidator(this.wrapper.payload)
+    return new XyoPayloadValidator(this.obj.body)
   }
 
-  public all() {
+  public validate() {
     const errors: Error[] = []
-    errors.push(...this.payload.all())
+    errors.push(...this.payload.validate())
     return errors
   }
 }

package/src/Payload/Wrapper/Wrapper.ts

@@ -1,22 +1,25 @@
-import { deepOmitUnderscoreFields, deepPickUnderscoreFields, XyoAbstractHasher } from '../../Hasher'
-import { XyoPayload } from '../models'
+import { deepOmitUnderscoreFields, deepPickUnderscoreFields, XyoHasher } from '../../Hasher'
+import { Huri } from '../../Huri'
+import { XyoPayload } from '../../models'
+import { XyoDataLike } from '../../Wallet'
 
-export class XyoPayloadWrapper<T extends XyoPayload> extends XyoAbstractHasher<T> {
-  public payload: T
-  constructor(payload: T) {
-    super()
-    this.payload = payload
-  }
-
-  protected get obj() {
-    return this.payload
+export class XyoPayloadWrapper<T extends XyoPayload> extends XyoHasher<T> {
+  public get payload() {
+    return this.obj
   }
 
   public get body() {
-    return deepOmitUnderscoreFields(this.payload)
+    return deepOmitUnderscoreFields<T>(this.obj)
   }
 
   public get meta() {
-    return deepPickUnderscoreFields(this.payload)
+    return deepPickUnderscoreFields<T>(this.obj)
+  }
+
+  public static async load(address: XyoDataLike | Huri) {
+    const payload = await new Huri(address).fetch()
+    if (payload) {
+      return new XyoPayloadWrapper(payload)
+    }
   }
 }

package/src/Payload/index.ts

@@ -1,4 +1,3 @@
 export * from './Builder'
-export * from './models'
 export * from './Validator'
 export * from './Wrapper'

package/src/Query/QueryPayload.ts

@@ -1,4 +1,4 @@
-import { XyoPayload } from '../Payload'
+import { XyoPayload } from '../models'
 
 export interface XyoQueryPayload extends XyoPayload {
   /** @field The preferred schema to use for the answer */

package/src/Schema/Payload.ts

@@ -1,6 +1,6 @@
-import { XyoPayload } from '../Payload'
+import { XyoPayload } from '../models'
 
-export interface XyoSchemaPayload extends XyoPayload {
+export type XyoSchemaPayload = XyoPayload<{
   /** @deprecated use definition.$id instead */
   name?: string
   definition: {
@@ -8,4 +8,4 @@ export interface XyoSchemaPayload extends XyoPayload {
     [key: string]: unknown
   }
   extends?: string
-}
+}>

package/src/Test/testBoundWitness.ts

@@ -1,6 +1,6 @@
-import { XyoBoundWitness } from '../BoundWitness'
+import { XyoBoundWitnessWithMeta } from '../BoundWitness'
 
-const testBoundWitness: XyoBoundWitness = {
+const testBoundWitness: XyoBoundWitnessWithMeta = {
   _archive: 'temp',
   _client: 'js',
   _hash: 'b0ffb9ebf872dc316b7be48327256c5316f7cb84d7c706861b18b86af1942dea',

package/src/Test/testPayload.ts

@@ -1,7 +1,8 @@
-import { XyoPayload } from '../Payload'
+import { WithAdditional } from '../lib'
+import { XyoPayloadWithMeta } from '../models'
 
 const testSchema = 'network.xyo.test'
-const testPayload: XyoPayload = {
+const testPayload: WithAdditional<XyoPayloadWithMeta> = {
   _archive: 'test',
   _hash: '20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c',
   _timestamp: 1609459255555,

package/src/Wallet/Base/WordsPayload.ts

@@ -1,4 +1,4 @@
-import { XyoPayload } from '../../Payload'
+import { XyoPayload } from '../../models'
 
 export interface XyoWordsPayload extends XyoPayload {
   words: string[]

package/src/Witness/LegacyWitness.ts

@@ -1,13 +1,14 @@
-import { XyoPayload, XyoPayloadBuilder } from '../Payload'
+import { XyoPayload } from '../models'
+import { XyoPayloadBuilder } from '../Payload'
 import { XyoWitness } from './Witness'
 
-export interface XyoWitnessConfig<T extends XyoPayload = XyoPayload> {
+export interface XyoSimpleWitnessConfig<T extends XyoPayload = XyoPayload> {
   schema: string
   template?: XyoPayload
   observer?: () => Promise<T> | T
 }
 
-export class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoWitnessConfig<T> = XyoWitnessConfig<T>> extends XyoWitness<T> {
+export class XyoSimpleWitness<T extends XyoPayload = XyoPayload, C extends XyoSimpleWitnessConfig<T> = XyoSimpleWitnessConfig<T>> extends XyoWitness<T> {
   public config?: C
   public previousHash?: string
 
@@ -28,3 +29,9 @@ export class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoWi
       .build()
   }
 }
+
+/** @deprecated Use XyoSimpleWitness */
+export class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoSimpleWitnessConfig<T> = XyoSimpleWitnessConfig<T>> extends XyoSimpleWitness<T, C> {}
+
+/** @deprecated Use XyoSimpleWitnessConfig */
+export type XyoWitnessConfig<T extends XyoPayload = XyoPayload> = XyoSimpleWitnessConfig<T>

package/src/Witness/QueryWitness.ts

@@ -1,6 +1,7 @@
 import { delay } from '@xylabs/sdk-js'
 
-import { XyoPayload, XyoPayloadBuilder } from '../Payload'
+import { XyoPayload } from '../models'
+import { XyoPayloadBuilder } from '../Payload'
 import { XyoQueryPayload } from '../Query'
 import { XyoWitness } from './Witness'
 

package/src/Witness/Witness.spec.ts

@@ -1,11 +1,11 @@
-import { XyoLegacyWitness } from './LegacyWitness'
+import { XyoSimpleWitness } from './LegacyWitness'
 
 describe('XyoWitness', () => {
   test('valid-instantiation', () => {
     const template = {
       schema: 'network.xyo.foo',
     }
-    const witness = new XyoLegacyWitness({ schema: 'network.xyo.payload', template })
+    const witness = new XyoSimpleWitness({ schema: 'network.xyo.payload', template })
     expect(witness).toBeTruthy()
     expect(witness.config?.schema).toBe('network.xyo.payload')
     expect(witness.config?.template).toBe(template)

package/src/Witness/Witness.ts

@@ -1,4 +1,4 @@
-import { XyoPayload } from '../Payload'
+import { XyoPayload } from '../models'
 
 export abstract class XyoWitness<T extends XyoPayload = XyoPayload> {
   abstract observe(fields?: Partial<T>): Promise<T>

package/src/lib/StringKeyObject.ts

@@ -0,0 +1,2 @@
+export type StringKeyObject = { [key: string]: unknown }
+export type WithAdditional<T> = T & StringKeyObject

package/src/lib/XyoObject.ts

@@ -0,0 +1,11 @@
+import { StringKeyObject } from './StringKeyObject'
+
+export abstract class XyoObject<T extends object = object> {
+  public readonly obj: T
+  constructor(obj: T) {
+    this.obj = obj
+  }
+  protected get stringKeyObj() {
+    return this.obj as unknown as StringKeyObject
+  }
+}

package/src/lib/XyoValidator.ts

@@ -0,0 +1,5 @@
+import { XyoObject } from './XyoObject'
+
+export abstract class XyoValidator<T extends object = object> extends XyoObject<T> {
+  public abstract validate(payload: T): Error[]
+}

package/src/lib/index.ts

@@ -1,4 +1,7 @@
 export * from './dns'
 export * from './dumpErrors'
 export * from './isBrowser'
+export * from './StringKeyObject'
 export * from './typeOf'
+export * from './XyoObject'
+export * from './XyoValidator'

package/src/lib/isXyoPayloadOfSchemaType.ts

@@ -1,5 +1,5 @@
 import { XyoBoundWitness } from '../BoundWitness'
-import { XyoPayload } from '../Payload'
+import { XyoPayload } from '../models'
 import { XyoSchemaPayload } from '../Schema'
 
 export const isXyoPayloadOfSchemaType = <T extends XyoPayload>(schema: string) => {

package/src/models/Base.ts

@@ -0,0 +1,6 @@
+export interface XyoPayloadBase {
+  schema: string
+  previousHash?: string
+  sources?: string[]
+  timestamp?: number
+}

package/src/models/Meta.ts

@@ -0,0 +1,17 @@
+import { XyoPayloadBase } from './Base'
+import { XyoPayload } from './XyoPayload'
+
+export interface XyoPayloadMetaBase {
+  _hash: string
+  _observeDuration?: number
+  _archive: string
+  _client?: string
+  _reportedHash?: string
+  _timestamp: number
+  _sources?: XyoPayload[]
+}
+
+export type XyoPayloadMeta<T = unknown> = T & XyoPayloadMetaBase
+export type XyoPartialPayloadMeta<T = unknown> = T & Partial<XyoPayloadMetaBase>
+export type XyoPayloadWithMeta<T = unknown> = T & XyoPayloadMetaBase & XyoPayloadBase
+export type XyoPayloadWithPartialMeta<T = unknown> = T & Partial<XyoPayloadMetaBase> & XyoPayloadBase

package/src/models/XyoPayload.ts

@@ -0,0 +1,3 @@
+import { XyoPayloadBase } from './Base'
+
+export type XyoPayload<T extends object = object> = T & XyoPayloadBase

package/src/models/index.ts

@@ -1 +1,3 @@
-export * from './WithStringIndex'
+export * from './Base'
+export * from './Meta'
+export * from './XyoPayload'

package/src/shared.ts

@@ -2,10 +2,10 @@ export * from './BoundWitness'
 export * from './Hasher'
 export * from './Huri'
 export * from './lib'
-export * from './models'
 export * from './Payload'
 export * from './Query'
 export * from './Schema'
 export * from './SchemaNameValidator'
 export * from './Wallet'
 export * from './Witness'
+export * from './models'

package/src/BoundWitness/models/Body/XyoBoundWitnessBody.ts

@@ -1,13 +0,0 @@
-import { XyoPayloadBody } from '../../../Payload'
-
-interface XyoBoundWitnessBody extends XyoPayloadBody {
-  [key: string]: unknown
-  addresses: string[]
-  previous_hash?: string
-  payload_hashes: string[]
-  payload_schemas: string[]
-  previous_hashes: (string | null)[]
-  schema: string
-}
-
-export type { XyoBoundWitnessBody }

package/src/BoundWitness/models/Body/index.ts

@@ -1,2 +0,0 @@
-export * from './XyoBoundWitnessBody'
-export * from './XyoBoundWitnessBodySchema'

package/src/Hasher/XyoAbstractHasher.ts

@@ -1,37 +0,0 @@
-import shajs from 'sha.js'
-
-import { removeEmptyFields } from './removeEmptyFields'
-import { deepOmitUnderscoreFields } from './removeFields'
-import { sortFields } from './sortFields'
-
-export abstract class XyoAbstractHasher<T extends Record<string, unknown>> {
-  protected abstract get obj(): T
-
-  get hashFields() {
-    return removeEmptyFields(deepOmitUnderscoreFields(this.obj))
-  }
-
-  /** @deprecated use stringified instead */
-  public sortedStringify() {
-    return this.stringified
-  }
-
-  public get stringified() {
-    const sortedEntry = sortFields(this.hashFields)
-    return JSON.stringify(sortedEntry)
-  }
-
-  /** @deprecated use hash instead */
-  public sortedHash() {
-    return this.hash
-  }
-
-  public get hash() {
-    return this.sortedHashData().toString('hex')
-  }
-
-  private sortedHashData() {
-    const stringObject = this.stringified
-    return shajs('sha256').update(stringObject).digest()
-  }
-}

package/src/Payload/models/Body.ts

@@ -1,7 +0,0 @@
-interface XyoPayloadBody {
-  [key: string]: unknown
-  schema: string
-  previousHash?: string
-}
-
-export type { XyoPayloadBody }

package/src/Payload/models/Meta.ts

@@ -1,11 +0,0 @@
-interface XyoPayloadMeta {
-  [key: string]: unknown
-  _hash?: string
-  _client?: string
-  _reportedHash?: string
-  _timestamp?: number
-  _observeDuration?: number
-  _archive?: string
-}
-
-export type { XyoPayloadMeta }

package/src/Payload/models/WithXyoPayloadMeta.ts

@@ -1,6 +0,0 @@
-import { XyoPayloadBody } from './Body'
-import { XyoPayloadMeta } from './Meta'
-
-type WithXyoPayloadMeta<T extends XyoPayloadBody> = T & XyoPayloadMeta
-
-export type { WithXyoPayloadMeta }

package/src/Payload/models/XyoPayload.ts

@@ -1,6 +0,0 @@
-import { XyoPayloadBody } from './Body'
-import { WithXyoPayloadMeta } from './WithXyoPayloadMeta'
-
-export type XyoPayloadFull = WithXyoPayloadMeta<XyoPayloadBody>
-
-export type XyoPayload<T = XyoPayloadFull> = T extends XyoPayloadFull ? T : XyoPayloadFull & T

package/src/Payload/models/index.ts

@@ -1,4 +0,0 @@
-export * from './Body'
-export * from './Meta'
-export * from './WithXyoPayloadMeta'
-export * from './XyoPayload'

package/src/models/WithStringIndex.ts

@@ -1 +0,0 @@
-export type WithStringIndex<T> = T & Record<string, unknown>