@xyo-network/payment-payload-plugins 4.1.1 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payment-payload-plugins",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,31 +28,34 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.23",
-    "@xylabs/crypto": "^4.13.23",
-    "@xylabs/hex": "^4.13.23",
-    "@xylabs/object": "^4.13.23",
-    "@xyo-network/account-model": "^4.1.7",
-    "@xyo-network/boundwitness-builder": "^4.1.7",
-    "@xyo-network/boundwitness-model": "^4.1.7",
-    "@xyo-network/boundwitness-validator": "^4.1.7",
-    "@xyo-network/diviner-hash-lease": "^4.1.7",
-    "@xyo-network/diviner-model": "^4.1.7",
-    "@xyo-network/id-payload-plugin": "^4.1.7",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-builder": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/schema-payload-plugin": "^4.1.7",
-    "@xyo-network/xns-record-payload-plugins": "^4.1.1"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/crypto": "^5.0.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xylabs/object": "^5.0.0",
+    "@xyo-network/account-model": "^5.0.0",
+    "@xyo-network/boundwitness-builder": "^5.0.0",
+    "@xyo-network/boundwitness-model": "^5.0.0",
+    "@xyo-network/boundwitness-validator": "^5.0.0",
+    "@xyo-network/diviner-hash-lease": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/id-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/schema-payload-plugin": "^5.0.0",
+    "@xyo-network/xns-record-payload-plugins": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/payload-builder": "^4.1.7",
-    "@xyo-network/wallet": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/wallet": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/Escrow/validators/common/ModuleInstanceValidators/spec/moduleInstanceValidators.spec.ts

@@ -0,0 +1,79 @@
+import '@xylabs/vitest-extended'
+
+import type { Address } from '@xylabs/hex'
+import type { ModuleIdentifier } from '@xyo-network/module-model'
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import type { EscrowTerms } from '../../../../Terms/index.ts'
+import { EscrowTermsSchema } from '../../../../Terms/index.ts'
+import { moduleIdentifiersContainsOneOf } from '../moduleInstanceValidators.ts'
+
+describe('RegistrarSentinel', () => {
+  const appraisalAuthority1 = 'address1' as Address
+  const appraisalAuthority2 = 'address2' as Address
+  const buyer1 = 'address3' as Address
+  const escrowAgent = 'address4' as Address
+  const paymentAuthority1 = 'address5' as Address
+  const seller1 = 'address6' as Address
+  const escrowTermsExample: EscrowTerms = {
+    appraisalAuthorities: [appraisalAuthority1, appraisalAuthority2],
+    buyer: [buyer1],
+    escrowAgent: escrowAgent,
+    paymentAuthorities: [paymentAuthority1],
+    schema: EscrowTermsSchema,
+    seller: [seller1],
+  }
+
+  const moduleIdentifiersExample: ModuleIdentifier[] = [appraisalAuthority1, 'randomAddress', escrowAgent, paymentAuthority1]
+
+  describe('moduleIdentifiersContainsOneOf', () => {
+    // Positive test for scalar value
+    test('returns true for a matching scalar value', () => {
+      const result = moduleIdentifiersContainsOneOf(escrowTermsExample, terms => terms.escrowAgent, moduleIdentifiersExample)
+      expect(result).toBeTruthy()
+    })
+
+    // Negative test for scalar value
+    test('returns false for a non-matching scalar value', () => {
+      const result = moduleIdentifiersContainsOneOf(escrowTermsExample, terms => terms.buyer, moduleIdentifiersExample)
+      expect(result).toBeFalsy()
+    })
+
+    // Positive test for array values
+    test('returns true when at least one array value matches', () => {
+      const result = moduleIdentifiersContainsOneOf(escrowTermsExample, terms => terms.appraisalAuthorities, moduleIdentifiersExample)
+      expect(result).toBeTruthy()
+    })
+
+    // Negative test for array values
+    test('returns false when no array values match', () => {
+      const nonMatchingModuleIdentifiers: ModuleIdentifier[] = ['nonMatching1', 'nonMatching2']
+      const result = moduleIdentifiersContainsOneOf(escrowTermsExample, terms => terms.appraisalAuthorities, nonMatchingModuleIdentifiers)
+      expect(result).toBeFalsy()
+    })
+
+    // Test for required parameter when termsValue is undefined
+    test('returns false when termsValue is undefined and required is true', () => {
+      const result = moduleIdentifiersContainsOneOf(
+        { schema: EscrowTermsSchema }, // Empty object, no terms defined
+        terms => terms.buyer, // This will be undefined
+        moduleIdentifiersExample,
+        true, // Explicitly stating required is true
+      )
+      expect(result).toBeFalsy()
+    })
+
+    // Test for not required parameter when termsValue is undefined
+    test('returns true when termsValue is undefined and required is false', () => {
+      const result = moduleIdentifiersContainsOneOf(
+        { schema: EscrowTermsSchema }, // Empty object, no terms defined
+        terms => terms.buyer, // This will be undefined
+        moduleIdentifiersExample,
+        false, // Required is false
+      )
+      expect(result).toBeTruthy()
+    })
+  })
+})

package/src/Escrow/validators/common/SecretValidators/spec/getPartySecretSignedValidator.spec.ts

@@ -0,0 +1,91 @@
+/* eslint-disable max-nested-callbacks */
+import '@xylabs/vitest-extended'
+
+import type { AccountInstance } from '@xyo-network/account-model'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import type { Id } from '@xyo-network/id-payload-plugin'
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import type { Payload } from '@xyo-network/payload-model'
+import { HDWallet } from '@xyo-network/wallet'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import type { EscrowParty, EscrowTerms } from '../../../../Terms/index.ts'
+import { EscrowTermsSchema } from '../../../../Terms/index.ts'
+import { createEscrowIntentWithSecret } from '../../../../util/index.ts'
+import { getPartySecretSignedValidator } from '../getPartySecretSignedValidator.ts'
+
+describe('RegistrarSentinel', () => {
+  let buyer: AccountInstance
+  let seller: AccountInstance
+  const baseTerms: EscrowTerms = { schema: EscrowTermsSchema }
+  const buyerSecret: Id = { schema: IdSchema, salt: `${Date.now() - 10}` }
+  let buyerSecretSignature: BoundWitness
+  const sellerSecret: Id = { schema: IdSchema, salt: `${Date.now() + 10}` }
+  let sellerSecretSignature: BoundWitness
+
+  describe('getPartySecretSignedValidator', () => {
+    beforeAll(async () => {
+      buyer = await HDWallet.random()
+      seller = await HDWallet.random()
+
+      baseTerms.buyer = [buyer.address]
+      baseTerms.buyerSecret = await PayloadBuilder.dataHash(buyerSecret)
+      baseTerms.seller = [seller.address]
+      baseTerms.sellerSecret = await PayloadBuilder.dataHash(sellerSecret)
+
+      const buyerIntent = await createEscrowIntentWithSecret(baseTerms, buyerSecret, buyer)
+      const sellerIntent = await createEscrowIntentWithSecret(baseTerms, sellerSecret, seller)
+
+      buyerSecretSignature = buyerIntent[0]
+      sellerSecretSignature = sellerIntent[0]
+    })
+    const cases: EscrowParty[] = ['buyer', 'seller']
+    describe.each(cases)('for %s', (party) => {
+      describe('returns true', () => {
+        it('with valid escrow terms and values supplied', async () => {
+          const payloads = party === 'buyer' ? [baseTerms, buyerSecret, buyerSecretSignature] : [baseTerms, sellerSecret, sellerSecretSignature]
+          const dictionary = await PayloadBuilder.toAllHashMap(payloads)
+          const partySecretValidator = getPartySecretSignedValidator(dictionary, party)
+          const result = await partySecretValidator(baseTerms)
+          expect(result).toBeTrue()
+        })
+      })
+      describe('returns false', () => {
+        describe('with invalid escrow terms value for', () => {
+          describe('secret', () => {
+            it('undefined', async () => {
+              const terms = { ...baseTerms, [`${party}Secret`]: undefined }
+              const payloads = party === 'buyer' ? [terms, buyerSecret, buyerSecretSignature] : [terms, sellerSecret, sellerSecretSignature]
+              const dictionary = await PayloadBuilder.toAllHashMap(payloads)
+              const partySecretValidator = getPartySecretSignedValidator(dictionary, party)
+              const result = await partySecretValidator(terms)
+              expect(result).toBeFalse()
+            })
+            it('different from signature', async () => {
+              const secret: Id = { schema: IdSchema, salt: '0' }
+              const terms = { ...baseTerms, [`${party}Secret`]: await PayloadBuilder.dataHash(secret) }
+              const payloads = party === 'buyer' ? [terms, buyerSecret, buyerSecretSignature] : [terms, sellerSecret, sellerSecretSignature]
+              const dictionary = await PayloadBuilder.toAllHashMap(payloads)
+              const partySecretValidator = getPartySecretSignedValidator(dictionary, party)
+              const result = await partySecretValidator(terms)
+              expect(result).toBeFalse()
+            })
+          })
+        })
+        describe('with missing value for', () => {
+          it('boundwitness', async () => {
+            const payloads: Payload[] = party === 'buyer' ? [baseTerms, buyerSecret] : [baseTerms, sellerSecret]
+            const dictionary = await PayloadBuilder.toAllHashMap(payloads)
+            const partySecretValidator = getPartySecretSignedValidator(dictionary, party)
+            const result = await partySecretValidator(baseTerms)
+            expect(result).toBeFalse()
+          })
+        })
+      })
+    })
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config