@xyo-network/payload-builder 4.3.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-builder",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,20 +28,24 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.0",
-    "@xylabs/exists": "^4.15.0",
-    "@xylabs/hex": "^4.15.0",
-    "@xylabs/logger": "^4.15.0",
-    "@xylabs/object": "^4.15.0",
-    "@xylabs/promise": "^4.15.0",
-    "@xyo-network/hash": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/exists": "^5.0.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xylabs/logger": "^5.0.0",
+    "@xylabs/object": "^5.0.0",
+    "@xylabs/promise": "^5.0.0",
+    "@xyo-network/hash": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Builder.spec.ts

@@ -0,0 +1,172 @@
+import type { Payload } from '@xyo-network/payload-model'
+
+import { PayloadBuilder } from '../Builder.ts'
+
+const schema = 'network.xyo.temp'
+
+import '@xylabs/vitest-extended'
+
+import { ObjectHasher } from '@xyo-network/hash'
+import {
+  describe, expect, test,
+} from 'vitest'
+
+describe('PayloadBuilder', () => {
+  test('build', () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let builder = new PayloadBuilder<any>({ schema })
+    expect(builder).toBeDefined()
+    builder = builder.fields({
+      _testUnderscore: 1,
+      testArray: [1, 2, 3],
+      testBoolean: true,
+      testDollarObject: { $test: 1 },
+      testDollarObjectInArray: [{ $test: 1 }],
+      testNull: null,
+      testNullObject: { t: null, x: undefined },
+      testNumber: 5,
+      testObject: { t: 1 },
+      testSomeNullObject: {
+        s: 1, t: null, x: undefined,
+      },
+      testString: 'hi',
+      testUndefined: undefined,
+      testUnderscoreObject: { _test: 1 },
+      testUnderscoreObjectInArray: [{ _test: 1 }],
+    }).meta({ $testDollar: 1 })
+    expect(builder).toBeDefined()
+
+    const actual = builder.build()
+
+    expect(actual).toBeDefined()
+    expect(actual._timestamp).toBeUndefined()
+    expect(actual._client).toBeUndefined()
+    expect(actual._hash).toBeUndefined()
+    expect(actual._testUnderscore).toBeUndefined()
+    expect(actual.$testDollar).toBeDefined()
+    expect(actual.schema).toBeDefined()
+    expect(Object.keys(actual).length).toBeGreaterThan(1)
+    expect(Object.keys(actual.testSomeNullObject as object).length).toBe(2)
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    expect((actual as any).testUnderscoreObject._test).toBeDefined()
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    expect((actual as any).testUnderscoreObjectInArray[0]._test).toBeDefined()
+
+    // TODO: Determine how we want to handle nested meta
+    // expect((actual as any).testDollarObject.$test).toBeDefined()
+
+    // expect((actual as any).testDollarObjectInArray[0].$test).toBeDefined()
+
+    let builderNoStamp = new PayloadBuilder<Payload<Record<string, unknown>>>({ schema })
+    expect(builderNoStamp).toBeDefined()
+    builderNoStamp = builderNoStamp.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(builderNoStamp).toBeDefined()
+
+    const actualNoStamp = builderNoStamp.build()
+
+    expect(actualNoStamp).toBeDefined()
+    expect(actualNoStamp._timestamp).toBeUndefined()
+    expect(actualNoStamp._client).toBeUndefined()
+    expect(actualNoStamp._hash).toBeUndefined()
+    expect(actualNoStamp.schema).toBeDefined()
+    expect(Object.keys(actualNoStamp).length).toBeGreaterThan(1)
+    expect(Object.keys(actualNoStamp.testSomeNullObject as object).length).toBe(2)
+  })
+})
+
+describe('PayloadBuilder', () => {
+  test('hash', async () => {
+    const value = {
+      $meta_field: 'yo',
+      currentLocation: {
+        coords: {
+          accuracy: 5,
+          altitude: 15,
+          altitudeAccuracy: 15,
+          heading: 90,
+          latitude: 37.7749,
+          longitude: -122.4194,
+          speed: 2.5,
+        },
+        timestamp: 1_609_459_200_000,
+      },
+      schema: 'network.xyo.location.current',
+    }
+    const dh = await PayloadBuilder.dataHash(value)
+    const h = await PayloadBuilder.hash(value)
+    expect(dh).toBe('0c1f0c80481b0f391a677eab542a594a192081325b6416acc3dc99db23355ee2')
+    expect(h).toBe('d1685b23bbc87c0260620fa6ff3581ffd48574bd326cb472425d4db787af487f')
+  })
+})
+
+describe('PayloadBuilder', () => {
+  test('hash', async () => {
+    const value = {
+      $hash: '6f731b3956114fd0d18820dbbe1116f9e36dc8d803b0bb049302f7109037468f',
+      $meta: {
+        client: 'ios',
+        signatures: ['fad86c98252b937a65be61f2307ce6d427a08425b4aee1c90fea0b446e9c862f46b6a36fea69450f83dadf9a2409c4f9ddc2e39a3dc222ae06f81b19eb2a17e6'],
+      },
+      addresses: ['e3b3bb3cdc49e13f9ac5f48d52915368de43afec'],
+      payload_hashes: ['c915c56dd93b5e0db509d1a63ca540cfb211e11f03039b05e19712267bb8b6db'],
+      payload_schemas: ['network.xyo.test'],
+      previous_hashes: [null],
+      schema: 'network.xyo.boundwitness',
+    }
+    const value2 = {
+      addresses: ['e3b3bb3cdc49e13f9ac5f48d52915368de43afec'],
+      payload_hashes: ['c915c56dd93b5e0db509d1a63ca540cfb211e11f03039b05e19712267bb8b6db'],
+      payload_schemas: ['network.xyo.test'],
+      previous_hashes: [null],
+      schema: 'network.xyo.boundwitness',
+    }
+    console.log('payload', PayloadBuilder.omitMeta(value))
+    const dh = await PayloadBuilder.dataHash(value)
+    const dh2 = await PayloadBuilder.dataHash(value2)
+    const h = await PayloadBuilder.hash(value)
+    expect(dh).toBe(dh2)
+    expect(dh).toBe('6f731b3956114fd0d18820dbbe1116f9e36dc8d803b0bb049302f7109037468f')
+    expect(h).toBe('c267291c8169e428aaedbbf52792f9378ee03910401ef882b653a75f85370722')
+  })
+})
+
+describe('temp', () => {
+  test('kotlin-data-hash', async () => {
+    const payload = {
+      $meta: {
+        client: 'android',
+        signatures: ['493178d0b896818e2185ca424738cd6d4cac94990af9c1a238c02e51baa387b3354058c32ef0e601c8e6201ff677bf97885169140e6e36778dc41ecd6bf362d7'],
+      },
+      addresses: ['9858effd232b4033e47d90003d41ec34ecaeda94'],
+      payload_hashes: ['4ca087085f26a7c3961b450457a8e44307f331ecf2580bb952fdacdcb7be4cd7'],
+      payload_schemas: ['network.xyo.test'],
+      previous_hashes: [null],
+      schema: 'network.xyo.boundwitness',
+    }
+    const payload2String = ObjectHasher.stringifyHashFields(payload)
+    const enc = new TextEncoder()
+    const data = enc.encode(payload2String)
+    var total = 0
+    for (const datum of data) {
+      total += datum
+    }
+    console.log('total', total)
+    console.log('len', data.length)
+    const hash2 = await ObjectHasher.hash(payload)
+    expect(hash2).toBe('79f9ff8083f5b1dde361d48b583821bd2b78723a29b422c8d6aefaed5bcba981')
+  })
+})

package/src/spec/ObjectHasher.toMap.spec.ts

@@ -0,0 +1,98 @@
+import '@xylabs/vitest-extended'
+
+import type { AnyObject } from '@xylabs/object'
+import { ObjectHasher } from '@xyo-network/hash'
+import type { Payload } from '@xyo-network/payload-model'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { PayloadBuilder } from '../Builder.ts'
+
+describe('PayloadBuilder', () => {
+  const testObject = {
+    schema: 'network.xyo.test',
+    testArray: [1, 2, 3],
+    testBoolean: true,
+    testNull: null,
+    testNullObject: { t: null, x: null },
+    testNumber: 5,
+    testObject: { t: 1 },
+    testSomeNullObject: {
+      s: 1, t: null, x: null,
+    },
+    testString: 'hello there.  this is a pretty long string.  what do you think?',
+  }
+  const bigObject = {
+    schema: 'network.xyo.test',
+    testArray: [1, 2, 3],
+    testBoolean: true,
+    testNull: null,
+    testNullObject: { t: null, x: null },
+    testNumber: 5,
+    testObjArray: [testObject],
+    testObject: { t: 1 },
+    testSomeNullObject: { s: 1, t: null },
+    testString: 'hello there.  this is a pretty long string.  what do you think?',
+  }
+  for (let i = 0; i < 1000; i++) {
+    bigObject.testObjArray.push(testObject)
+  }
+  const cases: [string, Payload<AnyObject>[]][] = [
+    [
+      'Hashes input payloads to a map',
+      [
+        { a: 0, schema: 'network.xyo.test.a' },
+        { b: 1, schema: 'network.xyo.test.b' },
+      ] satisfies Payload<AnyObject>[],
+    ],
+    [
+      'Preserves ordering of input payloads when creating object keys',
+      [
+        { a: 0, schema: 'network.xyo.test.a' },
+        { b: 1, schema: 'network.xyo.test.b' },
+        { c: 2, schema: 'network.xyo.test.c' },
+        { d: 3, schema: 'network.xyo.test.d' },
+        { e: 4, schema: 'network.xyo.test.e' },
+        { f: 5, schema: 'network.xyo.test.f' },
+        { g: 6, schema: 'network.xyo.test.g' },
+        { h: 7, schema: 'network.xyo.test.h' },
+        { i: 8, schema: 'network.xyo.test.i' },
+        { j: 9, schema: 'network.xyo.test.j' },
+        { k: 10, schema: 'network.xyo.test.k' },
+        { l: 11, schema: 'network.xyo.test.l' },
+        { m: 12, schema: 'network.xyo.test.m' },
+        bigObject,
+        { n: 13, schema: 'network.xyo.test.n' },
+        { o: 14, schema: 'network.xyo.test.o' },
+        { p: 15, schema: 'network.xyo.test.p' },
+        { q: 16, schema: 'network.xyo.test.q' },
+        { r: 17, schema: 'network.xyo.test.r' },
+        { s: 18, schema: 'network.xyo.test.s' },
+        { schema: 'network.xyo.test.t', t: 19 },
+        { schema: 'network.xyo.test.u', u: 20 },
+        { schema: 'network.xyo.test.v', v: 21 },
+        { schema: 'network.xyo.test.w', w: 22 },
+        { schema: 'network.xyo.test.x', x: 23 },
+        { schema: 'network.xyo.test.y', y: 24 },
+        { schema: 'network.xyo.test.z', z: 25 },
+      ] satisfies Payload<AnyObject>[],
+    ],
+  ]
+  beforeAll(async () => {
+    ObjectHasher.wasmSupport.allowWasm = true
+    await ObjectHasher.wasmInitialized
+  })
+  it.each(cases)('%s', async (_title, sources) => {
+    const map = await PayloadBuilder.toDataHashMap(sources)
+    expect(Object.keys(map).length).toBe(sources.length)
+    await Promise.all(Object.entries(map).map(async ([hash, payload], index) => {
+      const source = sources[index]
+      const { $meta: m1, ...sourceWithoutMeta } = source
+      const { $meta: m2, ...payloadWithoutMeta } = payload
+      expect(sourceWithoutMeta).toEqual(payloadWithoutMeta)
+      expect(await PayloadBuilder.dataHash(sourceWithoutMeta)).toEqual(hash)
+    }))
+  })
+})