@xyo-network/payment-payload-plugins 3.0.23 → 3.0.25

package/src/Escrow/util/secret/updateEscrowTermsWithSecret.ts

@@ -0,0 +1,37 @@
+import type { AccountInstance } from '@xyo-network/account-model'
+import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
+import type { IdPayload } from '@xyo-network/id-payload-plugin'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+
+import type {
+  EscrowParty, EscrowPartySecret, EscrowTerms,
+} from '../../Terms/index.ts'
+import { getEscrowSecret } from './getEscrowSecret.ts'
+
+/**
+ * Creates an escrow intent (for a buyer or seller) using the supplied secret
+ * @param terms The payload describing the terms for the escrow
+ * @param escrowParty The party in the escrow transaction
+ * @param account The account(s) to create the escrow intent with
+ * @param secret The secret for the escrow principal party to use for the escrow. If
+ * not provided, a cryptographically random secret will be generated.
+ * @returns The escrow intent
+ */
+export const updateEscrowTermsWithSecret = async (
+  terms: EscrowTerms,
+  escrowParty: EscrowParty,
+  account: AccountInstance | AccountInstance[],
+  secret?: IdPayload,
+) => {
+  if (!secret) secret = getEscrowSecret()
+  const signers = Array.isArray(account) ? account : [account]
+  // Add party addresses to escrow terms
+  terms[escrowParty] = signers.map(signer => signer.address)
+  // Add secret hash to terms
+  const secretType: EscrowPartySecret = escrowParty === 'buyer' ? 'buyerSecret' : 'sellerSecret'
+  const secretHash = await PayloadBuilder.dataHash(secret)
+  terms[secretType] = secretHash
+  // Have the parties sign the secret and terms
+  const result = await new BoundWitnessBuilder().signers(signers).payloads([terms, secret]).build()
+  return result
+}

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

@@ -1,7 +1,7 @@
 import type { ModuleIdentifier } from '@xyo-network/module-model'
 import type { PayloadValueExpression } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../../Terms.ts'
+import type { EscrowTerms } from '../../../Terms/index.ts'
 
 /**
  * Checks if property value of the escrow terms contains one of the valid moduleIdentifiers

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

@@ -0,0 +1,48 @@
+import type { Hash } from '@xylabs/hex'
+import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
+import type {
+  AsyncPayloadValidationFunction, Payload, WithMeta,
+} from '@xyo-network/payload-model'
+
+import type {
+  EscrowParty, EscrowPartySecret, EscrowTerms,
+} from '../../../Terms/index.ts'
+import { findEscrowPartySecretSignatures } from '../../../util/index.ts'
+
+/**
+ * Returns the log prefix for the party
+ * @param party The party
+ * @returns The log prefix for the party
+ */
+const getLogPrefix = (party: EscrowParty) => {
+  const partySecret: EscrowPartySecret = party === 'seller' ? 'sellerSecret' : 'buyerSecret'
+  return `EscrowTerms.${partySecret}`
+}
+
+/**
+ * Returns a function that validates the escrow terms for the existence of the party secret signed by the party
+ * @param dictionary Payload dictionary of the escrow terms
+ * @returns A function that validates the escrow terms for the existence of the party secret signed by the party
+ */
+export const getPartySecretSignedValidator = (dictionary: Record<Hash, WithMeta<Payload>>, party: EscrowParty): AsyncPayloadValidationFunction<EscrowTerms> => {
+  const partySecret: EscrowPartySecret = party === 'seller' ? 'sellerSecret' : 'buyerSecret'
+  return async (terms: EscrowTerms): Promise<boolean> => {
+    // Party-signed party secret BWs
+    const buyerSecretBWs = findEscrowPartySecretSignatures(terms, dictionary, party)
+
+    // If there are no BWs, return false
+    if (buyerSecretBWs.length === 0) {
+      console.log(`${getLogPrefix(party)}: No BoundWitnesses supplied for ${partySecret}: ${terms[partySecret]}`)
+      return false
+    }
+
+    // Ensure each BW supplied for the party secret is valid
+    const errors = await Promise.all(buyerSecretBWs.map(bw => new BoundWitnessValidator(bw).validate()))
+    const validBoundWitnesses = errors.every(errors => errors.length === 0)
+    if (!validBoundWitnesses) {
+      console.log(`${getLogPrefix(party)}: Invalid BoundWitnesses supplied for ${partySecret}: ${terms[partySecret]}`)
+      return false
+    }
+    return true
+  }
+}

package/src/Escrow/validators/common/SecretValidators/index.ts

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

package/src/Escrow/validators/common/index.ts

@@ -1,2 +1,3 @@
 export * from './ModuleInstanceValidators/index.ts'
+export * from './SecretValidators/index.ts'
 export * from './TemporalValidators/index.ts'

package/src/Escrow/validators/escrow/agent.ts

@@ -1,7 +1,7 @@
 import type { ModuleIdentifier } from '@xyo-network/module-model'
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 import { moduleIdentifiersContainsOneOf } from '../common/index.ts'
 
 const name = 'EscrowTerms.escrowAgent'

package/src/Escrow/validators/escrow/appraisal.ts

@@ -8,7 +8,7 @@ import type {
   Payload, SyncPayloadValidationFunction, WithMeta, WithSources,
 } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 import { validateWithinWindow } from '../common/index.ts'
 
 const name = 'EscrowTerms.appraisal'
@@ -110,7 +110,7 @@ export const getAppraisalsForAllAssetsValidator = (dictionary: Record<Hash, With
 const validateEstimate = (estimate: WithSources<HashLeaseEstimate>, exp: number): boolean => {
   if (!validateWithinWindow(estimate, exp)) return false
   if (estimate.currency !== 'USD') return false
-  if (estimate.price <= 0) return false
+  if (estimate.price < 0) return false
   return true
 }
 

package/src/Escrow/validators/escrow/appraisalAuthorities.ts

@@ -2,7 +2,7 @@ import { asAddress } from '@xylabs/hex'
 import type { ModuleIdentifier } from '@xyo-network/module-model'
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 import { moduleIdentifiersContainsAllOf } from '../common/index.ts'
 
 const name = 'EscrowTerms.appraisalAuthorities'

package/src/Escrow/validators/escrow/assets.ts

@@ -1,6 +1,6 @@
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 
 const name = 'EscrowTerms.assets'
 

package/src/Escrow/validators/escrow/buyer.ts

@@ -1,7 +1,7 @@
 import { asAddress } from '@xylabs/hex'
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 
 const name = 'EscrowTerms.buyer'
 

package/src/Escrow/validators/escrow/buyerSecret.ts

@@ -1,12 +1,11 @@
 import { assertEx } from '@xylabs/assert'
 import type { Hash } from '@xylabs/hex'
-import { isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'
-import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
 import type {
   AsyncPayloadValidationFunction, Payload, SyncPayloadValidationFunction, WithMeta,
 } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
+import { getPartySecretSignedValidator } from '../common/index.ts'
 
 const name = 'EscrowTerms.buyerSecret'
 
@@ -46,31 +45,5 @@ export const getBuyerSecretSuppliedValidator = (dictionary: Record<Hash, WithMet
  * @returns A function that validates the escrow terms for the existence of the buyerSecret signed by the buyer
  */
 export const getBuyerSecretSignedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): AsyncPayloadValidationFunction<EscrowTerms> => {
-  return async (terms: EscrowTerms): Promise<boolean> => {
-    const buyer = assertEx(terms.buyer, () => `${name}: No buyer: ${terms.buyer}`)
-    const buyerSecret = assertEx(terms.buyerSecret, () => `${name}: No buyerSecret: ${terms.buyerSecret}`)
-    // Buyer-signed buyer secrets
-    const buyerSecretBWs = Object.values(dictionary)
-      // Find all BoundWitnesses
-      .filter(isBoundWitnessWithMeta)
-      // That contain the buyer secret
-      .filter(bw => bw.payload_hashes.includes(buyerSecret))
-      // That are signed by all the buyers
-      .filter(bw => buyer.every(buyerAddress => bw.addresses.includes(buyerAddress)))
-
-    // If there are no buyerSecret BWs, return false
-    if (buyerSecretBWs.length === 0) {
-      console.log(`${name}: No BoundWitnesses supplied for buyerSecret: ${buyerSecret}`)
-      return false
-    }
-
-    // Ensure each BW supplied for the buyerSecret is valid
-    const errors = await Promise.all(buyerSecretBWs.map(bw => new BoundWitnessValidator(bw).validate()))
-    const validBoundWitnesses = errors.every(errors => errors.length === 0)
-    if (!validBoundWitnesses) {
-      console.log(`${name}: Invalid BoundWitnesses supplied for buyerSecret: ${buyerSecret}`)
-      return false
-    }
-    return true
-  }
+  return getPartySecretSignedValidator(dictionary, 'buyer')
 }

package/src/Escrow/validators/escrow/nbfExp.ts

@@ -1,6 +1,6 @@
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 
 export const getNbfExpValidator = (now: number, minRequiredDuration: number): SyncPayloadValidationFunction<EscrowTerms> => {
   const minExp = now + minRequiredDuration

package/src/Escrow/validators/escrow/paymentAuthorities.ts

@@ -1,7 +1,7 @@
 import type { ModuleIdentifier } from '@xyo-network/module-model'
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 import { moduleIdentifiersContainsAllOf } from '../common/index.ts'
 
 const name = 'EscrowTerms.paymentAuthorities'

package/src/Escrow/validators/escrow/seller.ts

@@ -1,7 +1,7 @@
 import { asAddress } from '@xylabs/hex'
 import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
 
 const name = 'EscrowTerms.seller'
 

package/src/Escrow/validators/escrow/sellerSecret.ts

@@ -1,12 +1,11 @@
 import { assertEx } from '@xylabs/assert'
 import type { Hash } from '@xylabs/hex'
-import { isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'
-import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
 import type {
   AsyncPayloadValidationFunction, Payload, SyncPayloadValidationFunction, WithMeta,
 } from '@xyo-network/payload-model'
 
-import type { EscrowTerms } from '../../Terms.ts'
+import type { EscrowTerms } from '../../Terms/index.ts'
+import { getPartySecretSignedValidator } from '../common/index.ts'
 
 const name = 'EscrowTerms.sellerSecret'
 
@@ -46,31 +45,5 @@ export const getSellerSecretSuppliedValidator = (dictionary: Record<Hash, WithMe
  * @returns A function that validates the escrow terms for the existence of the sellerSecret signed by the seller
  */
 export const getSellerSecretSignedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): AsyncPayloadValidationFunction<EscrowTerms> => {
-  return async (terms: EscrowTerms): Promise<boolean> => {
-    const seller = assertEx(terms.seller, () => `${name}: No seller: ${terms.seller}`)
-    const sellerSecret = assertEx(terms.sellerSecret, () => `${name}: No sellerSecret: ${terms.sellerSecret}`)
-    // Seller-signed seller secrets
-    const sellerSecretBWs = Object.values(dictionary)
-      // Find all BoundWitnesses
-      .filter(isBoundWitnessWithMeta)
-      // That contain the seller secret
-      .filter(bw => bw.payload_hashes.includes(sellerSecret))
-      // That are signed by all the sellers
-      .filter(bw => seller.every(sellerAddress => bw.addresses.includes(sellerAddress)))
-
-    // If there are no sellerSecret BWs, return false
-    if (sellerSecretBWs.length === 0) {
-      console.log(`${name}: No BoundWitnesses supplied for sellerSecret: ${sellerSecret}`)
-      return false
-    }
-
-    // Ensure each BW supplied for the sellerSecret is valid
-    const errors = await Promise.all(sellerSecretBWs.map(bw => new BoundWitnessValidator(bw).validate()))
-    const validBoundWitnesses = errors.every(errors => errors.length === 0)
-    if (!validBoundWitnesses) {
-      console.log(`${name}: Invalid BoundWitnesses supplied for sellerSecret: ${sellerSecret}`)
-      return false
-    }
-    return true
-  }
+  return getPartySecretSignedValidator(dictionary, 'seller')
 }

package/dist/neutral/Escrow/Terms.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Terms.d.ts","sourceRoot":"","sources":["../../../src/Escrow/Terms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAOzD,eAAO,MAAM,iBAAiB,4BAAmC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAGxD,MAAM,WAAW,iBAAiB;IAIhC,oBAAoB,EAAE,OAAO,EAAE,CAAA;IAI/B,UAAU,EAAE,IAAI,EAAE,CAAA;IAIlB,MAAM,EAAE,IAAI,EAAE,CAAA;IAId,KAAK,EAAE,OAAO,EAAE,CAAA;IAIhB,WAAW,EAAE,IAAI,CAAA;IAIjB,SAAS,EAAE,IAAI,EAAE,CAAA;IAIjB,WAAW,EAAE,OAAO,CAAA;IAIpB,GAAG,EAAE,MAAM,CAAA;IAIX,GAAG,EAAE,MAAM,CAAA;IAIX,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAI7B,MAAM,EAAE,OAAO,EAAE,CAAA;IAIjB,YAAY,EAAE,IAAI,CAAA;CACnB;AAKD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAA;AAKhF,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAKlF,eAAO,MAAM,wBAAwB;;EAAmE,CAAA;AAKxG,eAAO,MAAM,qBAAqB;;EAAgE,CAAA"}

package/dist/neutral/Escrow/createEscrowIntent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createEscrowIntent.d.ts","sourceRoot":"","sources":["../../../src/Escrow/createEscrowIntent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAE/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAS7C,eAAO,MAAM,kBAAkB,UAAiB,WAAW,EAAE,WAAW,eAAe;;;;;;;;;;;MAGtF,CAAA;AASD,eAAO,MAAM,4BAA4B,UAAiB,WAAW,UAAU,SAAS,WAAW,eAAe;;;;;;;;;;;MAGjH,CAAA"}

package/dist/neutral/Escrow/getEscrowSecret.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getEscrowSecret.d.ts","sourceRoot":"","sources":["../../../src/Escrow/getEscrowSecret.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAA;AAO/D,eAAO,MAAM,eAAe,QAAO,SAElC,CAAA"}