@xyo-network/core 2.21.10 → 2.21.13

package/src/BoundWitness/models/XyoBoundWitnessSchema.ts

@@ -1,23 +0,0 @@
-//Should type as JSONSchemaType<XyoBoundWitness> once ajv/eslint issue is fixed
-//https://github.com/microsoft/TypeScript/issues/44851
-
-import { XyoBoundWitnessMetaSchemaProperties } from './Meta'
-
-const XyoBoundWitnessSchema = () => {
-  return {
-    $id: 'https://schemas.xyo.network/2.0/boundwitness',
-    additionalProperties: false,
-    properties: {
-      ...XyoBoundWitnessMetaSchemaProperties(),
-      addresses: { items: { type: 'string' }, type: 'array' },
-      payload_hashes: { items: { type: 'string' }, type: 'array' },
-      payload_schemas: { items: { type: 'string' }, type: 'array' },
-      previous_hashes: { items: { nullable: true, type: 'string' }, type: 'array' },
-      schema: { type: 'string' },
-    },
-    required: ['addresses', 'payload_hashes', 'payload_schemas', 'previous_hashes', 'schema'],
-    type: 'object',
-  }
-}
-
-export { XyoBoundWitnessSchema }

package/src/BoundWitness/models/index.ts

@@ -1,5 +0,0 @@
-export * from './Base'
-export * from './Meta'
-export * from './WithXyoBoundWitnessMeta'
-export * from './XyoBoundWitness'
-export * from './XyoBoundWitnessSchema'

package/src/Huri/Huri.spec.ts

@@ -1,92 +0,0 @@
-import { delay } from '@xylabs/sdk-js'
-
-import { XyoPayload } from '../models'
-import { Huri } from './Huri'
-
-const hash = 'fb3606d71dcdd49a0aacc9d234e412684d577803c8a9ed9399a9d3776cc88e24'
-
-const valid = [
-  `https://${hash}`,
-  `https://api.archivist.xyo.network/temp/${hash}`,
-  `https://api.archivist.xyo.network/${hash}`,
-  `http://api.archivist.xyo.network/${hash}`,
-  `/api.archivist.xyo.network/${hash}`,
-  `//${hash}`,
-  `/${hash}`,
-  `${hash}`,
-]
-
-const validWithTempArchive = [
-  `https://api.archivist.xyo.network/temp/${hash}`,
-  `https://api.archivist.xyo.network/temp/${hash}`,
-  `http://api.archivist.xyo.network/temp/${hash}`,
-  `/api.archivist.xyo.network/temp/${hash}`,
-]
-
-const invalid = [`https:///api.archivist.xyo.network/${hash}`, `https://api.archivist.xyo.network//${hash}`]
-
-describe('Huri', () => {
-  describe('Valid Items', () => {
-    valid.map((item) => {
-      test(`valid [${item}]`, () => {
-        try {
-          const huri = new Huri(item)
-          expect(huri.hash).toBe(hash)
-        } catch (ex) {
-          console.error(`Valid Huri failed: [${item}]`)
-          console.error(ex)
-        }
-      })
-    })
-  })
-  describe('Valid Items w/archive', () => {
-    validWithTempArchive.map((item) => {
-      test(`valid w/archive [${item}]`, () => {
-        try {
-          const huri = new Huri(item)
-          expect(huri.hash).toBe(hash)
-          expect(huri.archive).toBe('temp')
-        } catch (ex) {
-          console.error(`Valid Huri w/archive failed: [${item}]`)
-          console.error(ex)
-        }
-      })
-    })
-  })
-  describe('Invalid Items', () => {
-    invalid.map((item) => {
-      test(`invalid [${item}]`, () => {
-        expect(() => new Huri(item)).toThrowError()
-      })
-    })
-  })
-  describe('Api Fetch', () => {
-    it('Valid Huri', async () => {
-      const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
-      const result = await huri.fetch()
-      expect(result?.schema).toBe('network.xyo.schema')
-    })
-    it('Invalid Huri', async () => {
-      const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653bad')
-      await expect(huri.fetch()).rejects.toThrow()
-    })
-  })
-  describe('Fetch Override', () => {
-    invalid.map((item) => {
-      test(`invalid [${item}]`, async () => {
-        const oldFetch = Huri.fetch
-        Huri.fetch = async (huri: Huri) => {
-          await delay(0)
-          const payload: XyoPayload = {
-            schema: huri.hash,
-          }
-          return payload
-        }
-        const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
-        const result = await huri.fetch()
-        Huri.fetch = oldFetch
-        expect(result?.schema).toBe('18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
-      })
-    })
-  })
-})

package/src/Huri/Huri.ts

@@ -1,154 +0,0 @@
-import { assertEx } from '@xylabs/sdk-js'
-import axios from 'axios'
-
-import { XyoPayload } from '../models'
-import { XyoAddressValue, XyoDataLike } from '../Wallet'
-
-export type XyoObjectCategory = 'block' | 'payload'
-
-export type HuriFetchFunction = (huri: Huri) => Promise<XyoPayload | undefined>
-
-/* 
-  Valid Huri:
-
-  [<protocol>://][<archivist>/[<archive>/]]<hash>
-
-  defaults:
-    protocol: https
-    archivist: api.archivist.xyo.network
-*/
-
-export interface HuriOptions {
-  archivistUri?: string
-}
-
-export interface XyoFetchedPayload<T extends XyoPayload = XyoPayload> {
-  payload: T
-  huri?: Huri
-}
-
-export class Huri {
-  public originalHref: string
-  public protocol?: string
-  public archivist?: string
-  public archive?: string
-  public hash: string
-
-  private isHuri = true
-
-  constructor(huri: XyoDataLike | Huri, { archivistUri }: HuriOptions = {}) {
-    const huriString = Huri.isHuri(huri)?.href ?? typeof huri === 'string' ? (huri as string) : new XyoAddressValue(huri as XyoDataLike).hex
-    this.originalHref = huriString
-
-    const protocol = Huri.parseProtocol(huriString)
-    this.protocol = protocol ?? 'https'
-
-    const path = assertEx(Huri.parsePath(huriString), 'Missing path')
-    this.hash = this.parsePath(path, protocol !== undefined)
-
-    //if archivistUri sent, overwrite protocol and archivist
-    if (archivistUri) {
-      const archivistUriParts = archivistUri.split('://')
-      this.protocol = archivistUriParts[0]
-      this.archivist = archivistUriParts[1]
-    }
-
-    this.validateParse()
-  }
-
-  private parsePath(path: string, hasProtocol: boolean) {
-    const pathParts = path.split('/')
-
-    //if the protocal was found, then there is not allowed to be a leading /
-    assertEx(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol seperator')
-
-    //remove leading '/' if needed
-    pathParts[0].length === 0 ? pathParts.shift() : null
-
-    //hash is assumed to be the last part
-    const hash = assertEx(pathParts.pop(), 'No hash specified')
-
-    //archivist is assumed to be the first part
-    this.archivist = pathParts.shift() ?? 'api.archivist.xyo.network'
-
-    //the archive is whatever is left
-    this.archive = pathParts.pop()
-
-    //after we pull off all the path parts, there should be nothing left
-    assertEx(pathParts.length === 0, 'Too many path parts')
-
-    return hash
-  }
-
-  private validateParse() {
-    //the archivist should not be zero length
-    assertEx(this.archivist?.length !== 0, 'Invalid archivist length')
-
-    //the archivist should not be zero length (can be undefined)
-    assertEx(this.archive?.length !== 0, 'Invalid archive length')
-
-    //the archive should not be set if the archivist is not set
-    assertEx(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required')
-  }
-
-  /*
-  The full href or the hash
-  */
-
-  public get href() {
-    const parts: string[] = []
-    if (this.protocol) {
-      parts.push(`${this.protocol}:/`)
-    }
-    if (this.archive) {
-      parts.push(`${this.archive}`)
-    }
-    if (this.archivist) {
-      parts.push(`${this.archivist}`)
-    }
-    parts.push(this.hash)
-    return parts.join('/')
-  }
-
-  public toString() {
-    return this.href
-  }
-
-  public async fetch() {
-    return await Huri.fetch(this)
-  }
-
-  static async fetch(huri: Huri): Promise<XyoPayload | undefined> {
-    return (await axios.get<XyoPayload>(huri.href)).data
-  }
-
-  private static parseProtocol(huri: string) {
-    const protocolSplit = huri.split('//')
-    assertEx(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`)
-    const rawProtocol = protocolSplit.length === 2 ? protocolSplit.shift() : undefined
-    if (rawProtocol) {
-      const protocolParts = rawProtocol?.split(':')
-      assertEx(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`)
-      assertEx(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`)
-      return protocolParts.shift()
-    }
-  }
-
-  private static parsePath(huri: string) {
-    const protocolSplit = huri.split('//')
-    assertEx(protocolSplit.length <= 2, `Invalid format [${huri}]`)
-    if (protocolSplit.length === 1) {
-      return huri
-    }
-    if (protocolSplit.length === 2) {
-      return protocolSplit[1]
-    }
-  }
-
-  public static isHuri(value: unknown) {
-    if (typeof value === 'object') {
-      return (value as Huri).isHuri ? (value as Huri) : undefined
-    }
-    return undefined
-  }
-}

package/src/Huri/index.ts

@@ -1 +0,0 @@
-export * from './Huri'

package/src/Payload/Builder/Builder.spec.ts

@@ -1,37 +0,0 @@
-import { XyoPayloadBuilder } from './Builder'
-
-const schema = 'network.xyo.temp'
-
-const payloadHash = '57b78b1b7df3ac0369654642e879cdf2f3c95f9c5949bcb34ea3cb8309c538b4'
-
-const ADDITIONAL_FIELD_COUNT = 4
-
-describe('XyoBoundWitnessBuilder', () => {
-  test('build', () => {
-    let builder = new XyoPayloadBuilder({ schema })
-    expect(builder).toBeDefined()
-    builder = builder.fields({
-      testArray: [1, 2, 3],
-      testBoolean: true,
-      testNull: null,
-      testNullObject: { t: null, x: undefined },
-      testNumber: 5,
-      testObject: { t: 1 },
-      testSomeNullObject: { s: 1, t: null, x: undefined },
-      testString: 'hi',
-      testUndefined: undefined,
-    })
-    expect(builder).toBeDefined()
-
-    const actual = builder.build()
-
-    expect(actual).toBeDefined()
-    expect(actual._timestamp).toBeDefined()
-    expect(actual._client).toBeDefined()
-    expect(actual._hash).toBeDefined()
-    expect(actual.schema).toBeDefined()
-    expect(Object.keys(actual).length).toBe(8 + ADDITIONAL_FIELD_COUNT)
-    expect(Object.keys(actual.testSomeNullObject as object).length).toBe(2)
-    expect(actual._hash).toEqual(payloadHash)
-  })
-})

package/src/Payload/Builder/Builder.ts

@@ -1,43 +0,0 @@
-import { deepOmitUnderscoreFields, removeEmptyFields, XyoHasher } from '../../Hasher'
-import { StringKeyObject } from '../../lib'
-import { XyoPayload } from '../../models'
-
-export interface XyoPayloadBuilderOptions {
-  schema: string
-}
-
-export class XyoPayloadBuilder<T extends XyoPayload = XyoPayload<StringKeyObject>> {
-  private _fields: Partial<T> = {}
-  private _previousHash?: string
-  private _schema: string
-
-  constructor({ schema }: XyoPayloadBuilderOptions) {
-    this._schema = schema
-  }
-
-  public fields(fields?: Partial<T>) {
-    if (fields) {
-      this._fields = { ...this._fields, ...removeEmptyFields(fields) }
-    }
-    return this
-  }
-
-  public previousHash(hash?: string) {
-    this._previousHash = hash
-    return this
-  }
-
-  public hashableFields() {
-    return {
-      ...removeEmptyFields(deepOmitUnderscoreFields({ ...this._fields, previousHash: this._previousHash })),
-      schema: this._schema,
-    } as T
-  }
-
-  public build(): T {
-    const hashableFields = this.hashableFields()
-    const _hash = new XyoHasher(hashableFields).hash
-    const _timestamp = Date.now()
-    return { ...hashableFields, _client: 'js', _hash, _timestamp, schema: this._schema }
-  }
-}

package/src/Payload/Builder/index.ts

@@ -1 +0,0 @@
-export * from './Builder'

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

@@ -1,10 +0,0 @@
-import { dumpErrors } from '../../lib'
-import { testPayload } from '../../Test'
-import { XyoPayloadBodyValidator } from './BodyValidator'
-
-test('all', () => {
-  const validator = new XyoPayloadBodyValidator(testPayload)
-  const errors = validator.validate()
-  dumpErrors(errors)
-  expect(errors.length).toBe(0)
-})

package/src/Payload/Validator/BodyValidator.ts

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

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

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

package/src/Payload/Validator/MetaValidator.ts

@@ -1,34 +0,0 @@
-import { XyoHasher } from '../../Hasher'
-import { XyoValidator } from '../../lib'
-import { XyoPayloadMeta } from '../../models'
-
-const MIN_ALLOWED_TIMESTAMP = 1609459200000
-const MAX_ALLOWED_TIMESTAMP = 4102444800000
-
-class XyoPayloadMetaValidator<T extends XyoPayloadMeta = XyoPayloadMeta> extends XyoValidator<T> {
-  public hash() {
-    const errors: Error[] = []
-    const wrapper = new XyoHasher(this.obj)
-
-    const bodyHash = wrapper.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.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 validate() {
-    const errors: Error[] = []
-    errors.push(...this.hash(), ...this.timestamp())
-    return errors
-  }
-}
-
-export { XyoPayloadMetaValidator }

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

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

package/src/Payload/Validator/Validator.ts

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

package/src/Payload/Validator/index.ts

@@ -1,3 +0,0 @@
-export * from './BodyValidator'
-export * from './MetaValidator'
-export * from './Validator'

package/src/Payload/Wrapper/Validator.ts

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

package/src/Payload/Wrapper/Wrapper.ts

@@ -1,25 +0,0 @@
-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 XyoHasher<T> {
-  public get payload() {
-    return this.obj
-  }
-
-  public get body() {
-    return deepOmitUnderscoreFields<T>(this.obj)
-  }
-
-  public get meta() {
-    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/Wrapper/index.ts

@@ -1,2 +0,0 @@
-export * from './Validator'
-export * from './Wrapper'

package/src/Payload/index.ts

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

package/src/Query/QueryPayload.ts

@@ -1,15 +0,0 @@
-import { XyoPayload } from '../models'
-
-export interface XyoQueryPayload extends XyoPayload {
-  /** @field The preferred schema to use for the answer */
-  targetSchema?: string
-
-  /** @field The maximum XYO that can be spent executing the query */
-  budget?: number
-
-  /** @field The frequency on which this query can be rerun */
-  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
-
-  /** @field The starting point for the bidding on the query */
-  minBid?: number
-}

package/src/Query/index.ts

@@ -1 +0,0 @@
-export * from './QueryPayload'

package/src/Schema/Payload.ts

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

package/src/Schema/index.ts

@@ -1 +0,0 @@
-export * from './Payload'