@xyo-network/xl1-schema 1.7.16

package/src/payload/TransferPayload.spec.ts

@@ -0,0 +1,84 @@
+import { Account } from '@xyo-network/account'
+import { TransferSchema } from '@xyo-network/xl1-protocol'
+import { Ajv } from 'ajv'
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { TransferPayloadJsonSchema } from './TransferPayload.ts'
+
+const ajv = new Ajv()
+
+describe('TransferPayloadJsonSchema', () => {
+  test('should have the correct $id', () => {
+    expect(TransferPayloadJsonSchema.$id).toBe('https://schemas.xyo.network/2.0/payload/transfer')
+  })
+
+  test('should define the correct properties', () => {
+    const properties = TransferPayloadJsonSchema.properties
+    expect(properties).toHaveProperty('from')
+    expect(properties).toHaveProperty('epoch')
+    expect(properties).toHaveProperty('transfers')
+    expect(properties).toHaveProperty('schema')
+  })
+
+  test('should include required fields', () => {
+    expect(TransferPayloadJsonSchema.required).toContain('transfers')
+    expect(TransferPayloadJsonSchema.required).toContain('epoch')
+  })
+
+  test('should have type "object"', () => {
+    expect(TransferPayloadJsonSchema.type).toBe('object')
+  })
+
+  test('should validate a valid payload', async () => {
+    const fromAddress = (await Account.random()).address
+    const toAddress = (await Account.random()).address
+    const validate = ajv.compile(TransferPayloadJsonSchema)
+    const validPayload = {
+      from: fromAddress,
+      epoch: 1_234_567_890,
+      transfers: { [toAddress]: '1000000000000000000' },
+      schema: TransferSchema,
+    }
+    const result = validate(validPayload)
+    expect(result).toBe(true)
+  })
+
+  test('should validate a invalid payload - leading 0x on from address', async () => {
+    const validate = ajv.compile(TransferPayloadJsonSchema)
+    const fromAddress = (await Account.random()).address
+    const toAddress = (await Account.random()).address
+    const validPayload = {
+      from: `0x${fromAddress}`,
+      epoch: 1_234_567_890,
+      transfers: { [toAddress]: '1000000000000000000' },
+      schema: TransferSchema,
+    }
+    expect(validate(validPayload)).toBe(false)
+  })
+
+  test('should validate a invalid payload - leading 0x on from address', async () => {
+    const validate = ajv.compile(TransferPayloadJsonSchema)
+    const fromAddress = (await Account.random()).address
+    const toAddress = (await Account.random()).address
+    const validPayload = {
+      from: fromAddress,
+      epoch: 1_234_567_890,
+      transfers: { [`0x${toAddress}`]: '1000000000000000000' },
+      schema: TransferSchema,
+    }
+    expect(validate(validPayload)).toBe(false)
+  })
+
+  test('should invalidate an invalid payload', () => {
+    const validate = ajv.compile(TransferPayloadJsonSchema)
+    const invalidPayload = {
+      from: 'invalid-address',
+      epoch: 'not-a-number',
+      transfers: { 'invalid-address': 'not-a-uint256' },
+      schema: 'invalid-schema',
+    }
+    expect(validate(invalidPayload)).toBe(false)
+  })
+})

package/src/payload/TransferPayload.ts

@@ -0,0 +1,31 @@
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import {
+  AddressRegEx, payloadJsonSchema, Uint256RegEx,
+} from '@xyo-network/payload-wrapper'
+import type { SchemaPayload } from '@xyo-network/schema-payload-plugin'
+import { SchemaSchema } from '@xyo-network/schema-payload-plugin'
+import type { Transfer } from '@xyo-network/xl1-protocol'
+import { TransferSchema } from '@xyo-network/xl1-protocol'
+import type { JSONSchemaType } from 'ajv'
+
+export const TransferPayloadJsonSchema: JSONSchemaType<Transfer> = {
+  ...payloadJsonSchema,
+  $id: 'https://schemas.xyo.network/2.0/payload/transfer',
+  additionalProperties: false,
+  properties: {
+    ...payloadJsonSchema.properties,
+    from: { type: 'string', pattern: AddressRegEx },
+    epoch: { type: 'number' },
+    transfers: {
+      type: 'object',
+      propertyNames: { pattern: AddressRegEx },
+      patternProperties: { [AddressRegEx]: { type: 'string', pattern: Uint256RegEx } },
+    },
+    schema: { type: 'string', pattern: TransferSchema },
+  },
+  required: [...payloadJsonSchema.required, 'transfers', 'epoch'],
+  type: 'object',
+}
+
+export const TransferPayloadJsonSchemaPayload = new PayloadBuilder<SchemaPayload>({ schema: SchemaSchema })
+  .fields({ definition: TransferPayloadJsonSchema }).build()

package/src/payload/index.ts

@@ -0,0 +1,3 @@
+export * from './ChainStakeIntent.ts'
+export * from './HashPayload.ts'
+export * from './TransferPayload.ts'