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

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

@@ -5,7 +5,7 @@ import { isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'
 import type { HashLeaseEstimate } from '@xyo-network/diviner-hash-lease'
 import { isHashLeaseEstimateWithSources } from '@xyo-network/diviner-hash-lease'
 import type {
-  Payload, PayloadValidationFunction, WithMeta, WithSources,
+  Payload, SyncPayloadValidationFunction, WithMeta, WithSources,
 } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
@@ -17,7 +17,7 @@ const name = 'EscrowTerms.appraisal'
  * A function that validates the escrow terms for tbe existence of appraisals
  * @returns True if the escrow terms contain appraisals, false otherwise
  */
-export const appraisalsExistValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const appraisalsExistValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have appraisals
   const appraisals = terms.appraisals
   if (!appraisals || appraisals.length === 0) {
@@ -32,7 +32,7 @@ export const appraisalsExistValidator: PayloadValidationFunction<EscrowTerms> =
  * @param dictionary Payload dictionary of the escrow terms
  * @returns A function that validates the escrow terms for appraisals which are from valid authorities
  */
-export const getAppraisalsFromValidAuthoritiesValidator = (dictionary: Record<Hash, WithMeta<Payload>>): PayloadValidationFunction<EscrowTerms> => {
+export const getAppraisalsFromValidAuthoritiesValidator = (dictionary: Record<Hash, WithMeta<Payload>>): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     const appraisals = assertEx(terms.appraisals, () => `${name}: No appraisals: ${terms.appraisals}`)
     const appraisalAuthorities = assertEx(terms.appraisalAuthorities, () => `${name}: No appraisalAuthorities: ${terms.appraisalAuthorities}`)
@@ -70,7 +70,7 @@ export const getAppraisalsFromValidAuthoritiesValidator = (dictionary: Record<Ha
 export const getAppraisalsValidValidator = (
   dictionary: Record<Hash, WithMeta<Payload>>,
   minimumExp: number,
-): PayloadValidationFunction<EscrowTerms> => {
+): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     // Verify we have an estimate for each of the assets
     const estimatesByAsset = getEstimatesByAsset(terms, dictionary)
@@ -94,7 +94,7 @@ export const getAppraisalsValidValidator = (
  * @param dictionary Payload dictionary of the escrow terms
  * @returns A function that validates the escrow terms for appraisals
  */
-export const getAppraisalsForAllAssetsValidator = (dictionary: Record<Hash, WithMeta<Payload>>): PayloadValidationFunction<EscrowTerms> => {
+export const getAppraisalsForAllAssetsValidator = (dictionary: Record<Hash, WithMeta<Payload>>): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     // Verify we have an estimate for each of the assets
     const estimatesByAsset = getEstimatesByAsset(terms, dictionary)

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

@@ -1,6 +1,6 @@
 import { asAddress } from '@xylabs/hex'
 import type { ModuleIdentifier } from '@xyo-network/module-model'
-import type { PayloadValidationFunction } from '@xyo-network/payload-model'
+import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
 import { moduleIdentifiersContainsAllOf } from '../common/index.ts'
@@ -11,7 +11,7 @@ const name = 'EscrowTerms.appraisalAuthorities'
  * A function that validates the escrow terms for appraisalAuthorities
  * @returns True if the escrow terms contain appraisalAuthorities, false otherwise
  */
-export const appraisalAuthoritiesExistValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const appraisalAuthoritiesExistValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have appraisalAuthorities
   const appraisalAuthorities = terms.appraisalAuthorities
   if (!appraisalAuthorities || appraisalAuthorities.length === 0) {
@@ -26,7 +26,7 @@ export const appraisalAuthoritiesExistValidator: PayloadValidationFunction<Escro
   return true
 }
 
-export const getAppraisalAuthoritiesAllowedValidator = (allowed: ModuleIdentifier[]): PayloadValidationFunction<EscrowTerms> => {
+export const getAppraisalAuthoritiesAllowedValidator = (allowed: ModuleIdentifier[]): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     const result = moduleIdentifiersContainsAllOf(terms, t => t.appraisalAuthorities, allowed, true)
     if (!result) {

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

@@ -1,4 +1,4 @@
-import type { PayloadValidationFunction } from '@xyo-network/payload-model'
+import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
 
@@ -8,7 +8,7 @@ const name = 'EscrowTerms.assets'
  * Returns a function that validates the escrow terms for assets
  * @returns A function that validates the escrow terms for assets
  */
-export const assetsExistValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const assetsExistValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have assets
   const assets = terms.assets
   if (!assets || assets.length === 0) {

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

@@ -1,5 +1,5 @@
 import { asAddress } from '@xylabs/hex'
-import type { PayloadValidationFunction } from '@xyo-network/payload-model'
+import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
 
@@ -9,7 +9,7 @@ const name = 'EscrowTerms.buyer'
  * A function that validates the escrow terms for buyer
  * @returns True if the escrow terms contain buyer, false otherwise
  */
-export const buyerExistsValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const buyerExistsValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have buyer
   const buyer = terms.buyer
   if (!buyer || buyer.length === 0) {

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

@@ -3,7 +3,7 @@ import type { Hash } from '@xylabs/hex'
 import { isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'
 import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
 import type {
-  Payload, PayloadValidationFunction, WithMeta,
+  AsyncPayloadValidationFunction, Payload, SyncPayloadValidationFunction, WithMeta,
 } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
@@ -14,7 +14,7 @@ const name = 'EscrowTerms.buyerSecret'
  * Returns a function that validates the escrow terms for buyerSecret
  * @returns A function that validates the escrow terms for buyerSecret
  */
-export const buyerSecretExistsValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const buyerSecretExistsValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have buyerSecret
   const buyerSecret = terms.buyerSecret
   if (!buyerSecret || buyerSecret.length === 0) {
@@ -29,7 +29,7 @@ export const buyerSecretExistsValidator: PayloadValidationFunction<EscrowTerms>
  * @param dictionary Payload dictionary of the escrow terms
  * @returns A function that validates the escrow terms for the existence of the buyerSecret in the dictionary
  */
-export const getBuyerSecretSuppliedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): PayloadValidationFunction<EscrowTerms> => {
+export const getBuyerSecretSuppliedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     const buyerSecret = assertEx(terms.buyerSecret, () => `${name}: No buyerSecret: ${terms.buyerSecret}`)
     if (!dictionary[buyerSecret]) {
@@ -45,8 +45,8 @@ export const getBuyerSecretSuppliedValidator = (dictionary: Record<Hash, WithMet
  * @param dictionary Payload dictionary of the escrow terms
  * @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>>): PayloadValidationFunction<EscrowTerms> => {
-  return async (terms: EscrowTerms) => {
+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

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

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

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

@@ -1,12 +1,12 @@
 import type { ModuleIdentifier } from '@xyo-network/module-model'
-import type { PayloadValidationFunction } from '@xyo-network/payload-model'
+import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
 import { moduleIdentifiersContainsAllOf } from '../common/index.ts'
 
 const name = 'EscrowTerms.paymentAuthorities'
 
-export const getPaymentAuthoritiesAllowedValidator = (allowed: ModuleIdentifier[]): PayloadValidationFunction<EscrowTerms> => {
+export const getPaymentAuthoritiesAllowedValidator = (allowed: ModuleIdentifier[]): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     const result = moduleIdentifiersContainsAllOf(terms, t => t.paymentAuthorities, allowed, true)
     if (!result) {

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

@@ -1,5 +1,5 @@
 import { asAddress } from '@xylabs/hex'
-import type { PayloadValidationFunction } from '@xyo-network/payload-model'
+import type { SyncPayloadValidationFunction } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
 
@@ -9,7 +9,7 @@ const name = 'EscrowTerms.seller'
  * A function that validates the escrow terms for seller
  * @returns True if the escrow terms contain seller, false otherwise
  */
-export const sellerExistsValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const sellerExistsValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have seller
   const seller = terms.seller
   if (!seller || seller.length === 0) {

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

@@ -3,7 +3,7 @@ import type { Hash } from '@xylabs/hex'
 import { isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'
 import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
 import type {
-  Payload, PayloadValidationFunction, WithMeta,
+  AsyncPayloadValidationFunction, Payload, SyncPayloadValidationFunction, WithMeta,
 } from '@xyo-network/payload-model'
 
 import type { EscrowTerms } from '../../Terms.ts'
@@ -14,7 +14,7 @@ const name = 'EscrowTerms.sellerSecret'
  * Returns a function that validates the escrow terms for sellerSecret
  * @returns A function that validates the escrow terms for sellerSecret
  */
-export const sellerSecretExistsValidator: PayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
+export const sellerSecretExistsValidator: SyncPayloadValidationFunction<EscrowTerms> = (terms: EscrowTerms) => {
   // Validate we have sellerSecret
   const sellerSecret = terms.sellerSecret
   if (!sellerSecret || sellerSecret.length === 0) {
@@ -29,7 +29,7 @@ export const sellerSecretExistsValidator: PayloadValidationFunction<EscrowTerms>
  * @param dictionary Payload dictionary of the escrow terms
  * @returns A function that validates the escrow terms for the existence of the sellerSecret in the dictionary
  */
-export const getSellerSecretSuppliedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): PayloadValidationFunction<EscrowTerms> => {
+export const getSellerSecretSuppliedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): SyncPayloadValidationFunction<EscrowTerms> => {
   return (terms: EscrowTerms) => {
     const sellerSecret = assertEx(terms.sellerSecret, () => `${name}: No sellerSecret: ${terms.sellerSecret}`)
     if (!dictionary[sellerSecret]) {
@@ -45,8 +45,8 @@ export const getSellerSecretSuppliedValidator = (dictionary: Record<Hash, WithMe
  * @param dictionary Payload dictionary of the escrow terms
  * @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>>): PayloadValidationFunction<EscrowTerms> => {
-  return async (terms: EscrowTerms) => {
+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