@xyo-network/payment-payload-plugins 2.91.5 → 2.91.6

package/dist/node/index.js

@@ -24,6 +24,277 @@ import { isPayloadOfSchemaType } from "@xyo-network/payload-model";
 var EscrowTermsSchema = `${EscrowSchema}.terms`;
 var isEscrowTerms = isPayloadOfSchemaType(EscrowTermsSchema);
 
+// src/Escrow/validators/common/ModuleInstanceValidators/moduleInstanceValidators.ts
+var moduleIdentifiersContainsOneOf = (escrowTerms, propertyExpression, moduleIdentifiers, required = true) => {
+  const termsValue = propertyExpression(escrowTerms);
+  if (termsValue === void 0) {
+    return required ? false : true;
+  } else {
+    return Array.isArray(termsValue) ? termsValue.some((address) => moduleIdentifiers.includes(address)) : moduleIdentifiers.includes(termsValue);
+  }
+};
+var moduleIdentifiersContainsAllOf = (escrowTerms, selector, moduleIdentifiers, required = true) => {
+  const termsValue = selector(escrowTerms);
+  if (termsValue === void 0) {
+    return required ? false : true;
+  } else {
+    return Array.isArray(termsValue) ? termsValue.every((address) => moduleIdentifiers.includes(address)) : moduleIdentifiers.includes(termsValue);
+  }
+};
+
+// src/Escrow/validators/common/TemporalValidators/validateWithinWindow.ts
+var validateWithinWindow = (value, exp, nbf = Date.now()) => {
+  if (value.nbf === void 0 || value.nbf > nbf)
+    return false;
+  if (value.exp === void 0 || value.exp < exp)
+    return false;
+  return true;
+};
+
+// src/Escrow/validators/escrow/agent.ts
+var name = "EscrowTerms.escrowAgent";
+var getEscrowAgentAllowedValidator = (allowedEscrowAgent) => {
+  return (terms) => {
+    const result = moduleIdentifiersContainsOneOf(terms, (t) => t.escrowAgent, [allowedEscrowAgent], true);
+    if (!result) {
+      console.log(`${name}: Escrow agent not allowed: ${terms.escrowAgent}`);
+    }
+    return result;
+  };
+};
+
+// src/Escrow/validators/escrow/appraisal.ts
+import { assertEx } from "@xylabs/assert";
+import { isBoundWitnessWithMeta } from "@xyo-network/boundwitness-model";
+import { isHashLeaseEstimateWithSources } from "@xyo-network/diviner-hash-lease";
+var name2 = "EscrowTerms.appraisal";
+var appraisalsExistValidator = (terms) => {
+  const appraisals = terms.appraisals;
+  if (!appraisals || appraisals.length === 0) {
+    console.log(`${name2}: No appraisals: ${terms.appraisals}`);
+    return false;
+  }
+  return true;
+};
+var getAppraisalsFromValidAuthoritiesValidator = (dictionary) => {
+  return (terms) => {
+    const appraisals = assertEx(terms.appraisals, () => `${name2}: No appraisals: ${terms.appraisals}`);
+    const appraisalAuthorities = assertEx(terms.appraisalAuthorities, () => `${name2}: No appraisalAuthorities: ${terms.appraisalAuthorities}`);
+    const appraisalBWsValid = Object.fromEntries(
+      appraisals.map((hash) => [hash, []])
+    );
+    for (const bw of Object.values(dictionary).filter(isBoundWitnessWithMeta)) {
+      for (const appraisal of appraisals) {
+        if (bw.payload_hashes.includes(appraisal) && bw.addresses.some((address) => appraisalAuthorities.includes(address))) {
+          appraisalBWsValid[appraisal].push(bw);
+        }
+      }
+    }
+    for (const [appraisal, bws] of Object.entries(appraisalBWsValid)) {
+      if (bws.length === 0) {
+        console.log(`${name2}: No valid appraisals for ${appraisal}`);
+        return false;
+      }
+    }
+    return true;
+  };
+};
+var getAppraisalsValidValidator = (dictionary, minimumExp) => {
+  return (terms) => {
+    const estimatesByAsset = getEstimatesByAsset(terms, dictionary);
+    const now = Date.now();
+    const exp = now + minimumExp;
+    for (const [asset, estimates] of Object.entries(estimatesByAsset)) {
+      for (const estimate of estimates) {
+        if (!validateEstimate(estimate, exp)) {
+          console.log(`${name2}: Invalid estimate for asset ${asset}: ${estimate}`);
+          return false;
+        }
+      }
+    }
+    return true;
+  };
+};
+var getAppraisalsForAllAssetsValidator = (dictionary) => {
+  return (terms) => {
+    const estimatesByAsset = getEstimatesByAsset(terms, dictionary);
+    const assets = assertEx(terms.assets, () => `${name2}: No assets: ${terms.assets}`);
+    if (Object.keys(estimatesByAsset).length !== assets.length) {
+      console.log(`${name2}: Missing appraisals for all assets: ${assets}`);
+      return false;
+    }
+    return true;
+  };
+};
+var validateEstimate = (estimate, exp) => {
+  if (!validateWithinWindow(estimate, exp))
+    return false;
+  if (estimate.currency !== "USD")
+    return false;
+  if (estimate.price <= 0)
+    return false;
+  return true;
+};
+var getEstimatesByAsset = (terms, dictionary) => {
+  const assets = assertEx(terms.assets, () => `${name2}: No assets: ${terms.assets}`);
+  const estimates = Object.values(dictionary).filter(isHashLeaseEstimateWithSources);
+  const estimatesByAsset = {};
+  for (const estimate of estimates) {
+    const { sources } = estimate;
+    if (sources === void 0 || sources.length === 0) {
+      console.log(`${name2}: No sources: ${estimate}`);
+      continue;
+    }
+    for (const asset of assets) {
+      if (sources.includes(asset)) {
+        if (!estimatesByAsset[asset])
+          estimatesByAsset[asset] = [];
+        estimatesByAsset[asset].push(estimate);
+      }
+    }
+  }
+  return estimatesByAsset;
+};
+
+// src/Escrow/validators/escrow/appraisalAuthorities.ts
+import { asAddress } from "@xylabs/hex";
+var name3 = "EscrowTerms.appraisalAuthorities";
+var appraisalAuthoritiesExistValidator = (terms) => {
+  const appraisalAuthorities = terms.appraisalAuthorities;
+  if (!appraisalAuthorities || appraisalAuthorities.length === 0) {
+    console.log(`${name3}: No appraisalAuthorities: ${terms.appraisalAuthorities}`);
+    return false;
+  }
+  if (appraisalAuthorities.map((x) => asAddress(x)).length !== appraisalAuthorities.length) {
+    console.log(`${name3}: Invalid address: ${terms.appraisalAuthorities}`);
+    return false;
+  }
+  return true;
+};
+var getAppraisalAuthoritiesAllowedValidator = (allowed) => {
+  return (terms) => {
+    const result = moduleIdentifiersContainsAllOf(terms, (t) => t.appraisalAuthorities, allowed, true);
+    if (!result) {
+      console.log(`${name3}: Appraisal authority not allowed: ${terms.appraisalAuthorities}`);
+    }
+    return result;
+  };
+};
+
+// src/Escrow/validators/escrow/assets.ts
+var name4 = "EscrowTerms.assets";
+var assetsExistValidator = (terms) => {
+  const assets = terms.assets;
+  if (!assets || assets.length === 0) {
+    console.log(`${name4}: No assets: ${terms.assets}`);
+    return false;
+  }
+  return true;
+};
+
+// src/Escrow/validators/escrow/buyer.ts
+import { asAddress as asAddress2 } from "@xylabs/hex";
+var name5 = "EscrowTerms.buyer";
+var buyerExistsValidator = (terms) => {
+  const buyer = terms.buyer;
+  if (!buyer || buyer.length === 0) {
+    console.log(`${name5}: No buyer: ${terms.buyer}`);
+    return false;
+  }
+  if (buyer.map((x) => asAddress2(x)).length !== buyer.length) {
+    console.log(`${name5}: Invalid address: ${terms.buyer}`);
+    return false;
+  }
+  return true;
+};
+
+// src/Escrow/validators/escrow/buyerSecret.ts
+import { assertEx as assertEx2 } from "@xylabs/assert";
+import { isBoundWitnessWithMeta as isBoundWitnessWithMeta2 } from "@xyo-network/boundwitness-model";
+import { BoundWitnessValidator } from "@xyo-network/boundwitness-validator";
+var name6 = "EscrowTerms.buyerSecret";
+var buyerSecretExistsValidator = (terms) => {
+  const buyerSecret = terms.buyerSecret;
+  if (!buyerSecret || buyerSecret.length === 0) {
+    console.log(`${name6}: No buyerSecret: ${terms.buyerSecret}`);
+    return false;
+  }
+  return true;
+};
+var getBuyerSecretSuppliedValidator = (dictionary) => {
+  return (terms) => {
+    const buyerSecret = assertEx2(terms.buyerSecret, () => `${name6}: No buyerSecret: ${terms.buyerSecret}`);
+    if (!dictionary[buyerSecret]) {
+      console.log(`${name6}: Payload not supplied for buyerSecret: ${buyerSecret}`);
+      return false;
+    }
+    return true;
+  };
+};
+var getBuyerSecretSignedValidator = (dictionary) => {
+  return async (terms) => {
+    const buyer = assertEx2(terms.buyer, () => `${name6}: No buyer: ${terms.buyer}`);
+    const buyerSecret = assertEx2(terms.buyerSecret, () => `${name6}: No buyerSecret: ${terms.buyerSecret}`);
+    const buyerSecretBWs = Object.values(dictionary).filter(isBoundWitnessWithMeta2).filter((bw) => bw.payload_hashes.includes(buyerSecret)).filter((bw) => buyer.every((buyerAddress) => bw.addresses.includes(buyerAddress)));
+    if (buyerSecretBWs.length === 0) {
+      console.log(`${name6}: No BoundWitnesses supplied for buyerSecret: ${buyerSecret}`);
+      return false;
+    }
+    const errors = await Promise.all(buyerSecretBWs.map((bw) => new BoundWitnessValidator(bw).validate()));
+    const validBoundWitnesses = errors.every((errors2) => errors2.length === 0);
+    if (!validBoundWitnesses) {
+      console.log(`${name6}: Invalid BoundWitnesses supplied for buyerSecret: ${buyerSecret}`);
+      return false;
+    }
+    return true;
+  };
+};
+
+// src/Escrow/validators/escrow/nbfExp.ts
+var getNbfExpValidator = (now, minRequiredDuration) => {
+  const minExp = now + minRequiredDuration;
+  return (terms) => {
+    const { exp, nbf } = terms;
+    if (nbf === void 0 || nbf < now) {
+      console.log(`EscrowTerms.nbf: invalid nbf ${terms.nbf}`);
+      return false;
+    }
+    if (exp === void 0 || exp < minExp || nbf > exp) {
+      console.log(`EscrowTerms.exp: invalid exp ${terms.exp}`);
+      return false;
+    }
+    return true;
+  };
+};
+
+// src/Escrow/validators/escrow/paymentAuthorities.ts
+var name7 = "EscrowTerms.paymentAuthorities";
+var getPaymentAuthoritiesAllowedValidator = (allowed) => {
+  return (terms) => {
+    const result = moduleIdentifiersContainsAllOf(terms, (t) => t.paymentAuthorities, allowed, true);
+    if (!result) {
+      console.log(`${name7}: Payment authority not allowed: ${terms.paymentAuthorities}`);
+    }
+    return result;
+  };
+};
+
+// src/Escrow/validators/escrow/seller.ts
+import { asAddress as asAddress3 } from "@xylabs/hex";
+var name8 = "EscrowTerms.seller";
+var sellerExistsValidator = (terms) => {
+  const seller = terms.seller;
+  if (!seller || seller.length === 0) {
+    console.log(`${name8}: No seller: ${terms.seller}`);
+    return false;
+  }
+  if (seller.map((x) => asAddress3(x)).length !== seller.length) {
+    console.log(`${name8}: Invalid address: ${terms.seller}`);
+    return false;
+  }
+  return true;
+};
+
 // src/Payment.ts
 import { isPayloadOfSchemaType as isPayloadOfSchemaType2 } from "@xyo-network/payload-model";
 var PaymentSchema = "network.xyo.payments.payment";
@@ -36,10 +307,28 @@ export {
   EscrowTermsSchema,
   PaymentSchema,
   PurchaseSchema,
+  appraisalAuthoritiesExistValidator,
+  appraisalsExistValidator,
+  assetsExistValidator,
+  buyerExistsValidator,
+  buyerSecretExistsValidator,
   createEscrowIntent,
   createEscrowIntentWithSecret,
+  getAppraisalAuthoritiesAllowedValidator,
+  getAppraisalsForAllAssetsValidator,
+  getAppraisalsFromValidAuthoritiesValidator,
+  getAppraisalsValidValidator,
+  getBuyerSecretSignedValidator,
+  getBuyerSecretSuppliedValidator,
+  getEscrowAgentAllowedValidator,
   getEscrowSecret,
+  getNbfExpValidator,
+  getPaymentAuthoritiesAllowedValidator,
   isEscrowTerms,
-  isPayment
+  isPayment,
+  moduleIdentifiersContainsAllOf,
+  moduleIdentifiersContainsOneOf,
+  sellerExistsValidator,
+  validateWithinWindow
 };
 //# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Escrow/createEscrowIntent.ts","../../src/Escrow/getEscrowSecret.ts","../../src/Escrow/Schema.ts","../../src/Escrow/Terms.ts","../../src/Payment.ts","../../src/Purchase.ts"],"sourcesContent":["import { AccountInstance } from '@xyo-network/account-model'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\nimport { IdPayload } from '@xyo-network/id-payload-plugin'\n\nimport { EscrowTerms } from './Terms'\n\n/**\n * Creates an escrow intent\n * @deprecated Use createEscrowIntentWithSecret instead\n * @param terms The payloads describing the terms for the escrow\n * @param account The account to create the escrow intent with\n * @returns The escrow intent\n */\nexport const createEscrowIntent = async (terms: EscrowTerms[], account: AccountInstance) => {\n  const result = await new BoundWitnessBuilder({ accounts: [account] }).payloads([...terms]).build()\n  return result\n}\n\n/**\n * Creates an escrow intent (for a buyer or seller) using the supplied secret\n * @param terms The payload describing the terms for the escrow\n * @param secret The secret for the escrow principal party to use for the escrow\n * @param account The account to create the escrow intent with\n * @returns The escrow intent\n */\nexport const createEscrowIntentWithSecret = async (terms: EscrowTerms, secret: IdPayload, account: AccountInstance) => {\n  const result = await new BoundWitnessBuilder({ accounts: [account] }).payloads([terms, secret]).build()\n  return result\n}\n","import { Crypto } from '@xylabs/crypto'\nimport { IdPayload, IdSchema } from '@xyo-network/id-payload-plugin'\n\n/**\n * Returns a cryptographically random secret to use for escrow\n * @returns The escrow secret\n */\nexport const getEscrowSecret = (): IdPayload => {\n  return { salt: Crypto.randomUUID(), schema: IdSchema }\n}\n","export type EscrowSchema = 'network.xyo.escrow'\nexport const EscrowSchema: EscrowSchema = 'network.xyo.escrow'\n","import { Address, Hash } from '@xylabs/hex'\nimport { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\n\nimport { EscrowSchema } from './Schema'\n\nexport const EscrowTermsSchema = `${EscrowSchema}.terms` as const\nexport type EscrowTermsSchema = typeof EscrowTermsSchema\n\n// TODO: Include escrow agent in escrow terms\nexport interface EscrowTermsFields {\n  /**\n   * The trusted estimators for the worth of the things being sold\n   */\n  appraisalAuthorities: Address[]\n  /**\n   * The estimated worths of the things being sold\n   */\n  appraisals: Hash[]\n  /**\n   * The things being sold\n   */\n  assets: Hash[]\n  /**\n   * The buyer\n   */\n  buyer: Address[]\n  /**\n   * The buyer\n   */\n  buyerSecret: Hash\n  /**\n   * The escrow agent responsible for the escrow\n   */\n  escrowAgent: Address\n  /**\n   * The time the escrow expires\n   */\n  exp: number\n  /**\n   * The time the escrow starts\n   */\n  nbf: number\n  /**\n   * The trusted payment authorities\n   */\n  paymentAuthorities: Address[]\n  /**\n   * The seller\n   */\n  seller: Address[]\n  /**\n   * The seller\n   */\n  sellerSecret: Hash\n}\n\n/**\n * The terms of an escrow\n */\nexport type EscrowTerms = Payload<Partial<EscrowTermsFields>, EscrowTermsSchema>\n\nexport const isEscrowTerms = isPayloadOfSchemaType<EscrowTerms>(EscrowTermsSchema)\n","import { isPayloadOfSchemaType, PayloadWithSources } from '@xyo-network/payload-model'\n\nimport { SupportedCurrency } from './Currency'\n\nexport type PaymentSchema = 'network.xyo.payments.payment'\nexport const PaymentSchema: PaymentSchema = 'network.xyo.payments.payment'\n\nexport interface PaymentFields {\n  /**\n   * The amount paid\n   */\n  amount: number\n  /**\n   * The currency of the amount paid\n   */\n  currency: SupportedCurrency\n}\n\n/**\n * A payment is a record of a payment made\n */\nexport type Payment = PayloadWithSources<PaymentFields, PaymentSchema>\n\nexport const isPayment = isPayloadOfSchemaType<Payment>(PaymentSchema)\n","import { Hash } from '@xylabs/hex'\nimport { PayloadWithSources } from '@xyo-network/payload-model'\n\nexport type PurchaseSchema = 'network.xyo.payments.purchase'\nexport const PurchaseSchema: PurchaseSchema = 'network.xyo.payments.purchase'\n\nexport interface PurchaseFields {\n  /**\n   * The hashes that were purchased\n   */\n  hashes: Hash[]\n  /**\n   * The payments for this purchase.  Array to allow for multiple payments\n   * for a single quote.\n   */\n  payments: Hash[]\n}\n\n/**\n * A purchase ties a payment made to a quote\n */\nexport type Purchase = PayloadWithSources<PurchaseFields, PurchaseSchema>\n"],"mappings":";AACA,SAAS,2BAA2B;AAY7B,IAAM,qBAAqB,OAAO,OAAsB,YAA6B;AAC1F,QAAM,SAAS,MAAM,IAAI,oBAAoB,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,EAAE,MAAM;AACjG,SAAO;AACT;AASO,IAAM,+BAA+B,OAAO,OAAoB,QAAmB,YAA6B;AACrH,QAAM,SAAS,MAAM,IAAI,oBAAoB,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,CAAC,OAAO,MAAM,CAAC,EAAE,MAAM;AACtG,SAAO;AACT;;;AC5BA,SAAS,cAAc;AACvB,SAAoB,gBAAgB;AAM7B,IAAM,kBAAkB,MAAiB;AAC9C,SAAO,EAAE,MAAM,OAAO,WAAW,GAAG,QAAQ,SAAS;AACvD;;;ACRO,IAAM,eAA6B;;;ACA1C,SAAS,6BAAsC;AAIxC,IAAM,oBAAoB,GAAG,YAAY;AAwDzC,IAAM,gBAAgB,sBAAmC,iBAAiB;;;AC7DjF,SAAS,yBAAAA,8BAAiD;AAKnD,IAAM,gBAA+B;AAkBrC,IAAM,YAAYA,uBAA+B,aAAa;;;ACnB9D,IAAM,iBAAiC;","names":["isPayloadOfSchemaType"]}
+{"version":3,"sources":["../../src/Escrow/createEscrowIntent.ts","../../src/Escrow/getEscrowSecret.ts","../../src/Escrow/Schema.ts","../../src/Escrow/Terms.ts","../../src/Escrow/validators/common/ModuleInstanceValidators/moduleInstanceValidators.ts","../../src/Escrow/validators/common/TemporalValidators/validateWithinWindow.ts","../../src/Escrow/validators/escrow/agent.ts","../../src/Escrow/validators/escrow/appraisal.ts","../../src/Escrow/validators/escrow/appraisalAuthorities.ts","../../src/Escrow/validators/escrow/assets.ts","../../src/Escrow/validators/escrow/buyer.ts","../../src/Escrow/validators/escrow/buyerSecret.ts","../../src/Escrow/validators/escrow/nbfExp.ts","../../src/Escrow/validators/escrow/paymentAuthorities.ts","../../src/Escrow/validators/escrow/seller.ts","../../src/Payment.ts","../../src/Purchase.ts"],"sourcesContent":["import { AccountInstance } from '@xyo-network/account-model'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\nimport { IdPayload } from '@xyo-network/id-payload-plugin'\n\nimport { EscrowTerms } from './Terms'\n\n/**\n * Creates an escrow intent\n * @deprecated Use createEscrowIntentWithSecret instead\n * @param terms The payloads describing the terms for the escrow\n * @param account The account to create the escrow intent with\n * @returns The escrow intent\n */\nexport const createEscrowIntent = async (terms: EscrowTerms[], account: AccountInstance) => {\n  const result = await new BoundWitnessBuilder({ accounts: [account] }).payloads([...terms]).build()\n  return result\n}\n\n/**\n * Creates an escrow intent (for a buyer or seller) using the supplied secret\n * @param terms The payload describing the terms for the escrow\n * @param secret The secret for the escrow principal party to use for the escrow\n * @param account The account to create the escrow intent with\n * @returns The escrow intent\n */\nexport const createEscrowIntentWithSecret = async (terms: EscrowTerms, secret: IdPayload, account: AccountInstance) => {\n  const result = await new BoundWitnessBuilder({ accounts: [account] }).payloads([terms, secret]).build()\n  return result\n}\n","import { Crypto } from '@xylabs/crypto'\nimport { IdPayload, IdSchema } from '@xyo-network/id-payload-plugin'\n\n/**\n * Returns a cryptographically random secret to use for escrow\n * @returns The escrow secret\n */\nexport const getEscrowSecret = (): IdPayload => {\n  return { salt: Crypto.randomUUID(), schema: IdSchema }\n}\n","export type EscrowSchema = 'network.xyo.escrow'\nexport const EscrowSchema: EscrowSchema = 'network.xyo.escrow'\n","import { Address, Hash } from '@xylabs/hex'\nimport { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\n\nimport { EscrowSchema } from './Schema'\n\nexport const EscrowTermsSchema = `${EscrowSchema}.terms` as const\nexport type EscrowTermsSchema = typeof EscrowTermsSchema\n\n// TODO: Include escrow agent in escrow terms\nexport interface EscrowTermsFields {\n  /**\n   * The trusted estimators for the worth of the things being sold\n   */\n  appraisalAuthorities: Address[]\n  /**\n   * The estimated worths of the things being sold\n   */\n  appraisals: Hash[]\n  /**\n   * The things being sold\n   */\n  assets: Hash[]\n  /**\n   * The buyer\n   */\n  buyer: Address[]\n  /**\n   * The buyer\n   */\n  buyerSecret: Hash\n  /**\n   * The escrow agent responsible for the escrow\n   */\n  escrowAgent: Address\n  /**\n   * The time the escrow expires\n   */\n  exp: number\n  /**\n   * The time the escrow starts\n   */\n  nbf: number\n  /**\n   * The trusted payment authorities\n   */\n  paymentAuthorities: Address[]\n  /**\n   * The seller\n   */\n  seller: Address[]\n  /**\n   * The seller\n   */\n  sellerSecret: Hash\n}\n\n/**\n * The terms of an escrow\n */\nexport type EscrowTerms = Payload<Partial<EscrowTermsFields>, EscrowTermsSchema>\n\nexport const isEscrowTerms = isPayloadOfSchemaType<EscrowTerms>(EscrowTermsSchema)\n","import { ModuleIdentifier } from '@xyo-network/module-model'\n\nimport { EscrowTerms } from '../../../Terms'\nimport { EscrowTermsValueExpression } from '../../types/escrowValidation'\n\n/**\n * Checks if property value of the escrow terms contains one of the valid moduleIdentifiers\n * @param escrowTerms The escrow terms to validate\n * @param propertyExpression The selector to get the property containing the moduleIdentifier(s) from the escrow terms\n * @param moduleIdentifiers The list of allowed moduleIdentifiers\n * @param required Is the property required to be present\n * @returns True if the property value contains one of the valid moduleIdentifiers\n */\nexport const moduleIdentifiersContainsOneOf = (\n  escrowTerms: EscrowTerms,\n  propertyExpression: EscrowTermsValueExpression<'appraisalAuthorities' | 'buyer' | 'escrowAgent' | 'paymentAuthorities' | 'seller'>,\n  moduleIdentifiers: ModuleIdentifier[],\n  required: boolean = true,\n) => {\n  const termsValue: string | string[] | undefined = propertyExpression(escrowTerms)\n  if (termsValue === undefined) {\n    return required ? false : true\n  } else {\n    return Array.isArray(termsValue) ? termsValue.some((address) => moduleIdentifiers.includes(address)) : moduleIdentifiers.includes(termsValue)\n  }\n}\n\n/**\n * Checks if property value of the escrow terms contains all of the valid moduleIdentifiers\n * @param escrowTerms The escrow terms to validate\n * @param selector The selector to get the property containing the moduleIdentifier(s) from the escrow terms\n * @param moduleIdentifiers The list of allowed moduleIdentifiers\n * @param required Is the property required to be present\n * @returns True if the property value contains all of the valid moduleIdentifiers\n */\nexport const moduleIdentifiersContainsAllOf = (\n  escrowTerms: EscrowTerms,\n  selector: EscrowTermsValueExpression<'appraisalAuthorities' | 'buyer' | 'escrowAgent' | 'paymentAuthorities' | 'seller'>,\n  moduleIdentifiers: ModuleIdentifier[],\n  required: boolean = true,\n) => {\n  const termsValue: string | string[] | undefined = selector(escrowTerms)\n  if (termsValue === undefined) {\n    return required ? false : true\n  } else {\n    return Array.isArray(termsValue) ? termsValue.every((address) => moduleIdentifiers.includes(address)) : moduleIdentifiers.includes(termsValue)\n  }\n}\n","export type Windowed = { exp?: number; nbf?: number }\n\nexport const validateWithinWindow = (value: Windowed, exp: number, nbf: number = Date.now()): boolean => {\n  if (value.nbf === undefined || value.nbf > nbf) return false\n  if (value.exp === undefined || value.exp < exp) return false\n  return true\n}\n","import { ModuleIdentifier } from '@xyo-network/module-model'\n\nimport { EscrowTerms } from '../../Terms'\nimport { moduleIdentifiersContainsOneOf } from '../common'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.escrowAgent'\n\nexport const getEscrowAgentAllowedValidator = (allowedEscrowAgent: ModuleIdentifier): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    const result = moduleIdentifiersContainsOneOf(terms, (t) => t.escrowAgent, [allowedEscrowAgent], true)\n    if (!result) {\n      console.log(`${name}: Escrow agent not allowed: ${terms.escrowAgent}`)\n    }\n    return result\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { BoundWitness, isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'\nimport { HashLeaseEstimate, isHashLeaseEstimateWithSources } from '@xyo-network/diviner-hash-lease'\nimport { Payload, WithMeta, WithSources } from '@xyo-network/payload-model'\n\nimport { EscrowTerms } from '../../Terms'\nimport { validateWithinWindow } from '../common'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.appraisal'\n\n/**\n * A function that validates the escrow terms for tbe existence of appraisals\n * @returns True if the escrow terms contain appraisals, false otherwise\n */\nexport const appraisalsExistValidator: EscrowTermsValidationFunction = (terms: EscrowTerms) => {\n  // Validate we have appraisals\n  const appraisals = terms.appraisals\n  if (!appraisals || appraisals.length === 0) {\n    console.log(`${name}: No appraisals: ${terms.appraisals}`)\n    return false\n  }\n  return true\n}\n\n/**\n * Returns a function that validates the escrow terms for appraisals which are from valid authorities\n * @param dictionary Payload dictionary of the escrow terms\n * @returns A function that validates the escrow terms for appraisals which are from valid authorities\n */\nexport const getAppraisalsFromValidAuthoritiesValidator = (dictionary: Record<Hash, WithMeta<Payload>>): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    const appraisals = assertEx(terms.appraisals, () => `${name}: No appraisals: ${terms.appraisals}`)\n    const appraisalAuthorities = assertEx(terms.appraisalAuthorities, () => `${name}: No appraisalAuthorities: ${terms.appraisalAuthorities}`)\n\n    // Validate the appraisals are signed by valid appraisal authorities. Validation criteria:\n    // - We have a bw for each of the appraisal\n    // - The bw is signed by an approved appraisal authority\n    const appraisalBWsValid: Record<Hash, WithMeta<BoundWitness>[]> = Object.fromEntries(\n      appraisals.map<[Hash, WithMeta<BoundWitness>[]]>((hash) => [hash, []]),\n    )\n    for (const bw of Object.values(dictionary).filter(isBoundWitnessWithMeta)) {\n      for (const appraisal of appraisals) {\n        if (bw.payload_hashes.includes(appraisal) && bw.addresses.some((address) => appraisalAuthorities.includes(address))) {\n          appraisalBWsValid[appraisal].push(bw)\n        }\n      }\n    }\n    for (const [appraisal, bws] of Object.entries(appraisalBWsValid)) {\n      if (bws.length === 0) {\n        console.log(`${name}: No valid appraisals for ${appraisal}`)\n        return false\n      }\n    }\n    return true\n  }\n}\n\n/**\n * Returns a function that validates the escrow terms for appraisals which are valid\n * @param dictionary Payload dictionary of the escrow terms\n * @param minimumExp The minium amount of time an estimate needs to be valid\n * for in the future (so as not to expire before the escrow is complete)\n * @returns A function that validates the escrow terms for appraisals which are valid\n */\nexport const getAppraisalsValidValidator = (dictionary: Record<Hash, WithMeta<Payload>>, minimumExp: number): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    // Verify we have an estimate for each of the assets\n    const estimatesByAsset = getEstimatesByAsset(terms, dictionary)\n    // Validate each of the estimates are valid (time, price, etc)\n    const now = Date.now()\n    const exp = now + minimumExp\n    for (const [asset, estimates] of Object.entries(estimatesByAsset)) {\n      for (const estimate of estimates) {\n        if (!validateEstimate(estimate, exp)) {\n          console.log(`${name}: Invalid estimate for asset ${asset}: ${estimate}`)\n          return false\n        }\n      }\n    }\n    return true\n  }\n}\n\n/**\n * Returns a function that validates the escrow terms to ensure that they contain an appraisal for each asset\n * @param dictionary Payload dictionary of the escrow terms\n * @returns A function that validates the escrow terms for appraisals\n */\nexport const getAppraisalsForAllAssetsValidator = (dictionary: Record<Hash, WithMeta<Payload>>): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    // Verify we have an estimate for each of the assets\n    const estimatesByAsset = getEstimatesByAsset(terms, dictionary)\n    const assets = assertEx(terms.assets, () => `${name}: No assets: ${terms.assets}`)\n    if (Object.keys(estimatesByAsset).length !== assets.length) {\n      console.log(`${name}: Missing appraisals for all assets: ${assets}`)\n      return false\n    }\n    return true\n  }\n}\n\nconst validateEstimate = (estimate: WithSources<HashLeaseEstimate>, exp: number): boolean => {\n  if (!validateWithinWindow(estimate, exp)) return false\n  if (estimate.currency !== 'USD') return false\n  if (estimate.price <= 0) return false\n  return true\n}\n\nconst getEstimatesByAsset = (terms: EscrowTerms, dictionary: Record<Hash, WithMeta<Payload>>): Record<Hash, WithSources<HashLeaseEstimate>[]> => {\n  const assets = assertEx(terms.assets, () => `${name}: No assets: ${terms.assets}`)\n  const estimates = Object.values(dictionary).filter(isHashLeaseEstimateWithSources) as unknown as WithSources<HashLeaseEstimate>[]\n  const estimatesByAsset: Record<Hash, WithSources<HashLeaseEstimate>[]> = {}\n  for (const estimate of estimates) {\n    const { sources } = estimate\n    if (sources === undefined || sources.length === 0) {\n      console.log(`${name}: No sources: ${estimate}`)\n      continue\n    }\n    for (const asset of assets) {\n      if (sources.includes(asset)) {\n        if (!estimatesByAsset[asset]) estimatesByAsset[asset] = []\n        estimatesByAsset[asset].push(estimate)\n      }\n    }\n  }\n  return estimatesByAsset\n}\n","import { asAddress } from '@xylabs/hex'\nimport { ModuleIdentifier } from '@xyo-network/module-model'\n\nimport { EscrowTerms } from '../../Terms'\nimport { moduleIdentifiersContainsAllOf } from '../common'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.appraisalAuthorities'\n\n/**\n * A function that validates the escrow terms for appraisalAuthorities\n * @returns True if the escrow terms contain appraisalAuthorities, false otherwise\n */\nexport const appraisalAuthoritiesExistValidator: EscrowTermsValidationFunction = (terms: EscrowTerms) => {\n  // Validate we have appraisalAuthorities\n  const appraisalAuthorities = terms.appraisalAuthorities\n  if (!appraisalAuthorities || appraisalAuthorities.length === 0) {\n    console.log(`${name}: No appraisalAuthorities: ${terms.appraisalAuthorities}`)\n    return false\n  }\n  // Validate the authorities are addresses\n  if (appraisalAuthorities.map((x) => asAddress(x)).length !== appraisalAuthorities.length) {\n    console.log(`${name}: Invalid address: ${terms.appraisalAuthorities}`)\n    return false\n  }\n  return true\n}\n\nexport const getAppraisalAuthoritiesAllowedValidator = (allowed: ModuleIdentifier[]): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    const result = moduleIdentifiersContainsAllOf(terms, (t) => t.appraisalAuthorities, allowed, true)\n    if (!result) {\n      console.log(`${name}: Appraisal authority not allowed: ${terms.appraisalAuthorities}`)\n    }\n    return result\n  }\n}\n","import { EscrowTerms } from '../../Terms'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.assets'\n\n/**\n * Returns a function that validates the escrow terms for assets\n * @returns A function that validates the escrow terms for assets\n */\nexport const assetsExistValidator: EscrowTermsValidationFunction = (terms: EscrowTerms) => {\n  // Validate we have assets\n  const assets = terms.assets\n  if (!assets || assets.length === 0) {\n    console.log(`${name}: No assets: ${terms.assets}`)\n    return false\n  }\n  return true\n}\n","import { asAddress } from '@xylabs/hex'\n\nimport { EscrowTerms } from '../../Terms'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.buyer'\n\n/**\n * A function that validates the escrow terms for buyer\n * @returns True if the escrow terms contain buyer, false otherwise\n */\nexport const buyerExistsValidator: EscrowTermsValidationFunction = (terms: EscrowTerms) => {\n  // Validate we have buyer\n  const buyer = terms.buyer\n  if (!buyer || buyer.length === 0) {\n    console.log(`${name}: No buyer: ${terms.buyer}`)\n    return false\n  }\n  // Validate the authorities are addresses\n  if (buyer.map((x) => asAddress(x)).length !== buyer.length) {\n    console.log(`${name}: Invalid address: ${terms.buyer}`)\n    return false\n  }\n  return true\n}\n","import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'\nimport { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'\nimport { Payload, WithMeta } from '@xyo-network/payload-model'\n\nimport { EscrowTerms } from '../../Terms'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.buyerSecret'\n\n/**\n * Returns a function that validates the escrow terms for buyerSecret\n * @returns A function that validates the escrow terms for buyerSecret\n */\nexport const buyerSecretExistsValidator: EscrowTermsValidationFunction = (terms: EscrowTerms) => {\n  // Validate we have buyerSecret\n  const buyerSecret = terms.buyerSecret\n  if (!buyerSecret || buyerSecret.length === 0) {\n    console.log(`${name}: No buyerSecret: ${terms.buyerSecret}`)\n    return false\n  }\n  return true\n}\n\n/**\n * Returns a function that validates the escrow terms for the existence of the buyerSecret in the dictionary\n * @param dictionary Payload dictionary of the escrow terms\n * @returns A function that validates the escrow terms for the existence of the buyerSecret in the dictionary\n */\nexport const getBuyerSecretSuppliedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    const buyerSecret = assertEx(terms.buyerSecret, () => `${name}: No buyerSecret: ${terms.buyerSecret}`)\n    if (!dictionary[buyerSecret]) {\n      console.log(`${name}: Payload not supplied for buyerSecret: ${buyerSecret}`)\n      return false\n    }\n    return true\n  }\n}\n\n/**\n * Returns a function that validates the escrow terms for the existence of the buyerSecret signed by the buyer\n * @param dictionary Payload dictionary of the escrow terms\n * @returns A function that validates the escrow terms for the existence of the buyerSecret signed by the buyer\n */\nexport const getBuyerSecretSignedValidator = (dictionary: Record<Hash, WithMeta<Payload>>): EscrowTermsValidationFunction => {\n  return async (terms: EscrowTerms) => {\n    const buyer = assertEx(terms.buyer, () => `${name}: No buyer: ${terms.buyer}`)\n    const buyerSecret = assertEx(terms.buyerSecret, () => `${name}: No buyerSecret: ${terms.buyerSecret}`)\n    // Buyer-signed buyer secrets\n    const buyerSecretBWs = Object.values(dictionary)\n      // Find all BoundWitnesses\n      .filter(isBoundWitnessWithMeta)\n      // That contain the buyer secret\n      .filter((bw) => bw.payload_hashes.includes(buyerSecret))\n      // That are signed by all the buyers\n      .filter((bw) => buyer.every((buyerAddress) => bw.addresses.includes(buyerAddress)))\n\n    // If there are no buyerSecret BWs, return false\n    if (buyerSecretBWs.length === 0) {\n      console.log(`${name}: No BoundWitnesses supplied for buyerSecret: ${buyerSecret}`)\n      return false\n    }\n\n    // Ensure each BW supplied for the buyerSecret is valid\n    const errors = await Promise.all(buyerSecretBWs.map((bw) => new BoundWitnessValidator(bw).validate()))\n    const validBoundWitnesses = errors.every((errors) => errors.length === 0)\n    if (!validBoundWitnesses) {\n      console.log(`${name}: Invalid BoundWitnesses supplied for buyerSecret: ${buyerSecret}`)\n      return false\n    }\n    return true\n  }\n}\n","import { EscrowTerms } from '../../Terms'\nimport { EscrowTermsValidationFunction } from '../types'\n\nexport const getNbfExpValidator = (now: number, minRequiredDuration: number): EscrowTermsValidationFunction => {\n  const minExp = now + minRequiredDuration\n  return (terms: EscrowTerms) => {\n    const { exp, nbf } = terms\n    if (nbf === undefined || nbf < now) {\n      console.log(`EscrowTerms.nbf: invalid nbf ${terms.nbf}`)\n      return false\n    }\n    if (exp === undefined || exp < minExp || nbf > exp) {\n      console.log(`EscrowTerms.exp: invalid exp ${terms.exp}`)\n      return false\n    }\n    return true\n  }\n}\n","import { ModuleIdentifier } from '@xyo-network/module-model'\n\nimport { EscrowTerms } from '../../Terms'\nimport { moduleIdentifiersContainsAllOf } from '../common'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.paymentAuthorities'\n\nexport const getPaymentAuthoritiesAllowedValidator = (allowed: ModuleIdentifier[]): EscrowTermsValidationFunction => {\n  return (terms: EscrowTerms) => {\n    const result = moduleIdentifiersContainsAllOf(terms, (t) => t.paymentAuthorities, allowed, true)\n    if (!result) {\n      console.log(`${name}: Payment authority not allowed: ${terms.paymentAuthorities}`)\n    }\n    return result\n  }\n}\n","import { asAddress } from '@xylabs/hex'\n\nimport { EscrowTerms } from '../../Terms'\nimport { EscrowTermsValidationFunction } from '../types'\n\nconst name = 'EscrowTerms.seller'\n\n/**\n * A function that validates the escrow terms for seller\n * @returns True if the escrow terms contain seller, false otherwise\n */\nexport const sellerExistsValidator: EscrowTermsValidationFunction = (terms: EscrowTerms) => {\n  // Validate we have seller\n  const seller = terms.seller\n  if (!seller || seller.length === 0) {\n    console.log(`${name}: No seller: ${terms.seller}`)\n    return false\n  }\n  // Validate the authorities are addresses\n  if (seller.map((x) => asAddress(x)).length !== seller.length) {\n    console.log(`${name}: Invalid address: ${terms.seller}`)\n    return false\n  }\n  return true\n}\n","import { isPayloadOfSchemaType, PayloadWithSources } from '@xyo-network/payload-model'\n\nimport { SupportedCurrency } from './Currency'\n\nexport type PaymentSchema = 'network.xyo.payments.payment'\nexport const PaymentSchema: PaymentSchema = 'network.xyo.payments.payment'\n\nexport interface PaymentFields {\n  /**\n   * The amount paid\n   */\n  amount: number\n  /**\n   * The currency of the amount paid\n   */\n  currency: SupportedCurrency\n}\n\n/**\n * A payment is a record of a payment made\n */\nexport type Payment = PayloadWithSources<PaymentFields, PaymentSchema>\n\nexport const isPayment = isPayloadOfSchemaType<Payment>(PaymentSchema)\n","import { Hash } from '@xylabs/hex'\nimport { PayloadWithSources } from '@xyo-network/payload-model'\n\nexport type PurchaseSchema = 'network.xyo.payments.purchase'\nexport const PurchaseSchema: PurchaseSchema = 'network.xyo.payments.purchase'\n\nexport interface PurchaseFields {\n  /**\n   * The hashes that were purchased\n   */\n  hashes: Hash[]\n  /**\n   * The payments for this purchase.  Array to allow for multiple payments\n   * for a single quote.\n   */\n  payments: Hash[]\n}\n\n/**\n * A purchase ties a payment made to a quote\n */\nexport type Purchase = PayloadWithSources<PurchaseFields, PurchaseSchema>\n"],"mappings":";AACA,SAAS,2BAA2B;AAY7B,IAAM,qBAAqB,OAAO,OAAsB,YAA6B;AAC1F,QAAM,SAAS,MAAM,IAAI,oBAAoB,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,EAAE,MAAM;AACjG,SAAO;AACT;AASO,IAAM,+BAA+B,OAAO,OAAoB,QAAmB,YAA6B;AACrH,QAAM,SAAS,MAAM,IAAI,oBAAoB,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,CAAC,OAAO,MAAM,CAAC,EAAE,MAAM;AACtG,SAAO;AACT;;;AC5BA,SAAS,cAAc;AACvB,SAAoB,gBAAgB;AAM7B,IAAM,kBAAkB,MAAiB;AAC9C,SAAO,EAAE,MAAM,OAAO,WAAW,GAAG,QAAQ,SAAS;AACvD;;;ACRO,IAAM,eAA6B;;;ACA1C,SAAS,6BAAsC;AAIxC,IAAM,oBAAoB,GAAG,YAAY;AAwDzC,IAAM,gBAAgB,sBAAmC,iBAAiB;;;AChD1E,IAAM,iCAAiC,CAC5C,aACA,oBACA,mBACA,WAAoB,SACjB;AACH,QAAM,aAA4C,mBAAmB,WAAW;AAChF,MAAI,eAAe,QAAW;AAC5B,WAAO,WAAW,QAAQ;AAAA,EAC5B,OAAO;AACL,WAAO,MAAM,QAAQ,UAAU,IAAI,WAAW,KAAK,CAAC,YAAY,kBAAkB,SAAS,OAAO,CAAC,IAAI,kBAAkB,SAAS,UAAU;AAAA,EAC9I;AACF;AAUO,IAAM,iCAAiC,CAC5C,aACA,UACA,mBACA,WAAoB,SACjB;AACH,QAAM,aAA4C,SAAS,WAAW;AACtE,MAAI,eAAe,QAAW;AAC5B,WAAO,WAAW,QAAQ;AAAA,EAC5B,OAAO;AACL,WAAO,MAAM,QAAQ,UAAU,IAAI,WAAW,MAAM,CAAC,YAAY,kBAAkB,SAAS,OAAO,CAAC,IAAI,kBAAkB,SAAS,UAAU;AAAA,EAC/I;AACF;;;AC7CO,IAAM,uBAAuB,CAAC,OAAiB,KAAa,MAAc,KAAK,IAAI,MAAe;AACvG,MAAI,MAAM,QAAQ,UAAa,MAAM,MAAM;AAAK,WAAO;AACvD,MAAI,MAAM,QAAQ,UAAa,MAAM,MAAM;AAAK,WAAO;AACvD,SAAO;AACT;;;ACAA,IAAM,OAAO;AAEN,IAAM,iCAAiC,CAAC,uBAAwE;AACrH,SAAO,CAAC,UAAuB;AAC7B,UAAM,SAAS,+BAA+B,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,kBAAkB,GAAG,IAAI;AACrG,QAAI,CAAC,QAAQ;AACX,cAAQ,IAAI,GAAG,IAAI,+BAA+B,MAAM,WAAW,EAAE;AAAA,IACvE;AACA,WAAO;AAAA,EACT;AACF;;;AChBA,SAAS,gBAAgB;AAEzB,SAAuB,8BAA8B;AACrD,SAA4B,sCAAsC;AAOlE,IAAMA,QAAO;AAMN,IAAM,2BAA0D,CAAC,UAAuB;AAE7F,QAAM,aAAa,MAAM;AACzB,MAAI,CAAC,cAAc,WAAW,WAAW,GAAG;AAC1C,YAAQ,IAAI,GAAGA,KAAI,oBAAoB,MAAM,UAAU,EAAE;AACzD,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAOO,IAAM,6CAA6C,CAAC,eAA+E;AACxI,SAAO,CAAC,UAAuB;AAC7B,UAAM,aAAa,SAAS,MAAM,YAAY,MAAM,GAAGA,KAAI,oBAAoB,MAAM,UAAU,EAAE;AACjG,UAAM,uBAAuB,SAAS,MAAM,sBAAsB,MAAM,GAAGA,KAAI,8BAA8B,MAAM,oBAAoB,EAAE;AAKzI,UAAM,oBAA4D,OAAO;AAAA,MACvE,WAAW,IAAsC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;AAAA,IACvE;AACA,eAAW,MAAM,OAAO,OAAO,UAAU,EAAE,OAAO,sBAAsB,GAAG;AACzE,iBAAW,aAAa,YAAY;AAClC,YAAI,GAAG,eAAe,SAAS,SAAS,KAAK,GAAG,UAAU,KAAK,CAAC,YAAY,qBAAqB,SAAS,OAAO,CAAC,GAAG;AACnH,4BAAkB,SAAS,EAAE,KAAK,EAAE;AAAA,QACtC;AAAA,MACF;AAAA,IACF;AACA,eAAW,CAAC,WAAW,GAAG,KAAK,OAAO,QAAQ,iBAAiB,GAAG;AAChE,UAAI,IAAI,WAAW,GAAG;AACpB,gBAAQ,IAAI,GAAGA,KAAI,6BAA6B,SAAS,EAAE;AAC3D,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AASO,IAAM,8BAA8B,CAAC,YAA6C,eAAsD;AAC7I,SAAO,CAAC,UAAuB;AAE7B,UAAM,mBAAmB,oBAAoB,OAAO,UAAU;AAE9D,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,MAAM,MAAM;AAClB,eAAW,CAAC,OAAO,SAAS,KAAK,OAAO,QAAQ,gBAAgB,GAAG;AACjE,iBAAW,YAAY,WAAW;AAChC,YAAI,CAAC,iBAAiB,UAAU,GAAG,GAAG;AACpC,kBAAQ,IAAI,GAAGA,KAAI,gCAAgC,KAAK,KAAK,QAAQ,EAAE;AACvE,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;AAOO,IAAM,qCAAqC,CAAC,eAA+E;AAChI,SAAO,CAAC,UAAuB;AAE7B,UAAM,mBAAmB,oBAAoB,OAAO,UAAU;AAC9D,UAAM,SAAS,SAAS,MAAM,QAAQ,MAAM,GAAGA,KAAI,gBAAgB,MAAM,MAAM,EAAE;AACjF,QAAI,OAAO,KAAK,gBAAgB,EAAE,WAAW,OAAO,QAAQ;AAC1D,cAAQ,IAAI,GAAGA,KAAI,wCAAwC,MAAM,EAAE;AACnE,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAEA,IAAM,mBAAmB,CAAC,UAA0C,QAAyB;AAC3F,MAAI,CAAC,qBAAqB,UAAU,GAAG;AAAG,WAAO;AACjD,MAAI,SAAS,aAAa;AAAO,WAAO;AACxC,MAAI,SAAS,SAAS;AAAG,WAAO;AAChC,SAAO;AACT;AAEA,IAAM,sBAAsB,CAAC,OAAoB,eAAgG;AAC/I,QAAM,SAAS,SAAS,MAAM,QAAQ,MAAM,GAAGA,KAAI,gBAAgB,MAAM,MAAM,EAAE;AACjF,QAAM,YAAY,OAAO,OAAO,UAAU,EAAE,OAAO,8BAA8B;AACjF,QAAM,mBAAmE,CAAC;AAC1E,aAAW,YAAY,WAAW;AAChC,UAAM,EAAE,QAAQ,IAAI;AACpB,QAAI,YAAY,UAAa,QAAQ,WAAW,GAAG;AACjD,cAAQ,IAAI,GAAGA,KAAI,iBAAiB,QAAQ,EAAE;AAC9C;AAAA,IACF;AACA,eAAW,SAAS,QAAQ;AAC1B,UAAI,QAAQ,SAAS,KAAK,GAAG;AAC3B,YAAI,CAAC,iBAAiB,KAAK;AAAG,2BAAiB,KAAK,IAAI,CAAC;AACzD,yBAAiB,KAAK,EAAE,KAAK,QAAQ;AAAA,MACvC;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;;;AChIA,SAAS,iBAAiB;AAO1B,IAAMC,QAAO;AAMN,IAAM,qCAAoE,CAAC,UAAuB;AAEvG,QAAM,uBAAuB,MAAM;AACnC,MAAI,CAAC,wBAAwB,qBAAqB,WAAW,GAAG;AAC9D,YAAQ,IAAI,GAAGA,KAAI,8BAA8B,MAAM,oBAAoB,EAAE;AAC7E,WAAO;AAAA,EACT;AAEA,MAAI,qBAAqB,IAAI,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,WAAW,qBAAqB,QAAQ;AACxF,YAAQ,IAAI,GAAGA,KAAI,sBAAsB,MAAM,oBAAoB,EAAE;AACrE,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,0CAA0C,CAAC,YAA+D;AACrH,SAAO,CAAC,UAAuB;AAC7B,UAAM,SAAS,+BAA+B,OAAO,CAAC,MAAM,EAAE,sBAAsB,SAAS,IAAI;AACjG,QAAI,CAAC,QAAQ;AACX,cAAQ,IAAI,GAAGA,KAAI,sCAAsC,MAAM,oBAAoB,EAAE;AAAA,IACvF;AACA,WAAO;AAAA,EACT;AACF;;;ACjCA,IAAMC,QAAO;AAMN,IAAM,uBAAsD,CAAC,UAAuB;AAEzF,QAAM,SAAS,MAAM;AACrB,MAAI,CAAC,UAAU,OAAO,WAAW,GAAG;AAClC,YAAQ,IAAI,GAAGA,KAAI,gBAAgB,MAAM,MAAM,EAAE;AACjD,WAAO;AAAA,EACT;AACA,SAAO;AACT;;;ACjBA,SAAS,aAAAC,kBAAiB;AAK1B,IAAMC,QAAO;AAMN,IAAM,uBAAsD,CAAC,UAAuB;AAEzF,QAAM,QAAQ,MAAM;AACpB,MAAI,CAAC,SAAS,MAAM,WAAW,GAAG;AAChC,YAAQ,IAAI,GAAGA,KAAI,eAAe,MAAM,KAAK,EAAE;AAC/C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,IAAI,CAAC,MAAMD,WAAU,CAAC,CAAC,EAAE,WAAW,MAAM,QAAQ;AAC1D,YAAQ,IAAI,GAAGC,KAAI,sBAAsB,MAAM,KAAK,EAAE;AACtD,WAAO;AAAA,EACT;AACA,SAAO;AACT;;;ACxBA,SAAS,YAAAC,iBAAgB;AAEzB,SAAS,0BAAAC,+BAA8B;AACvC,SAAS,6BAA6B;AAMtC,IAAMC,QAAO;AAMN,IAAM,6BAA4D,CAAC,UAAuB;AAE/F,QAAM,cAAc,MAAM;AAC1B,MAAI,CAAC,eAAe,YAAY,WAAW,GAAG;AAC5C,YAAQ,IAAI,GAAGA,KAAI,qBAAqB,MAAM,WAAW,EAAE;AAC3D,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAOO,IAAM,kCAAkC,CAAC,eAA+E;AAC7H,SAAO,CAAC,UAAuB;AAC7B,UAAM,cAAcF,UAAS,MAAM,aAAa,MAAM,GAAGE,KAAI,qBAAqB,MAAM,WAAW,EAAE;AACrG,QAAI,CAAC,WAAW,WAAW,GAAG;AAC5B,cAAQ,IAAI,GAAGA,KAAI,2CAA2C,WAAW,EAAE;AAC3E,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;AAOO,IAAM,gCAAgC,CAAC,eAA+E;AAC3H,SAAO,OAAO,UAAuB;AACnC,UAAM,QAAQF,UAAS,MAAM,OAAO,MAAM,GAAGE,KAAI,eAAe,MAAM,KAAK,EAAE;AAC7E,UAAM,cAAcF,UAAS,MAAM,aAAa,MAAM,GAAGE,KAAI,qBAAqB,MAAM,WAAW,EAAE;AAErG,UAAM,iBAAiB,OAAO,OAAO,UAAU,EAE5C,OAAOD,uBAAsB,EAE7B,OAAO,CAAC,OAAO,GAAG,eAAe,SAAS,WAAW,CAAC,EAEtD,OAAO,CAAC,OAAO,MAAM,MAAM,CAAC,iBAAiB,GAAG,UAAU,SAAS,YAAY,CAAC,CAAC;AAGpF,QAAI,eAAe,WAAW,GAAG;AAC/B,cAAQ,IAAI,GAAGC,KAAI,iDAAiD,WAAW,EAAE;AACjF,aAAO;AAAA,IACT;AAGA,UAAM,SAAS,MAAM,QAAQ,IAAI,eAAe,IAAI,CAAC,OAAO,IAAI,sBAAsB,EAAE,EAAE,SAAS,CAAC,CAAC;AACrG,UAAM,sBAAsB,OAAO,MAAM,CAACC,YAAWA,QAAO,WAAW,CAAC;AACxE,QAAI,CAAC,qBAAqB;AACxB,cAAQ,IAAI,GAAGD,KAAI,sDAAsD,WAAW,EAAE;AACtF,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;;;ACvEO,IAAM,qBAAqB,CAAC,KAAa,wBAA+D;AAC7G,QAAM,SAAS,MAAM;AACrB,SAAO,CAAC,UAAuB;AAC7B,UAAM,EAAE,KAAK,IAAI,IAAI;AACrB,QAAI,QAAQ,UAAa,MAAM,KAAK;AAClC,cAAQ,IAAI,gCAAgC,MAAM,GAAG,EAAE;AACvD,aAAO;AAAA,IACT;AACA,QAAI,QAAQ,UAAa,MAAM,UAAU,MAAM,KAAK;AAClD,cAAQ,IAAI,gCAAgC,MAAM,GAAG,EAAE;AACvD,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;;;ACXA,IAAME,QAAO;AAEN,IAAM,wCAAwC,CAAC,YAA+D;AACnH,SAAO,CAAC,UAAuB;AAC7B,UAAM,SAAS,+BAA+B,OAAO,CAAC,MAAM,EAAE,oBAAoB,SAAS,IAAI;AAC/F,QAAI,CAAC,QAAQ;AACX,cAAQ,IAAI,GAAGA,KAAI,oCAAoC,MAAM,kBAAkB,EAAE;AAAA,IACnF;AACA,WAAO;AAAA,EACT;AACF;;;AChBA,SAAS,aAAAC,kBAAiB;AAK1B,IAAMC,QAAO;AAMN,IAAM,wBAAuD,CAAC,UAAuB;AAE1F,QAAM,SAAS,MAAM;AACrB,MAAI,CAAC,UAAU,OAAO,WAAW,GAAG;AAClC,YAAQ,IAAI,GAAGA,KAAI,gBAAgB,MAAM,MAAM,EAAE;AACjD,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,IAAI,CAAC,MAAMD,WAAU,CAAC,CAAC,EAAE,WAAW,OAAO,QAAQ;AAC5D,YAAQ,IAAI,GAAGC,KAAI,sBAAsB,MAAM,MAAM,EAAE;AACvD,WAAO;AAAA,EACT;AACA,SAAO;AACT;;;ACxBA,SAAS,yBAAAC,8BAAiD;AAKnD,IAAM,gBAA+B;AAkBrC,IAAM,YAAYA,uBAA+B,aAAa;;;ACnB9D,IAAM,iBAAiC;","names":["name","name","name","asAddress","name","assertEx","isBoundWitnessWithMeta","name","errors","name","asAddress","name","isPayloadOfSchemaType"]}

package/package.json

@@ -10,11 +10,16 @@
     "url": "https://github.com/XYOracleNetwork/plugins/issues"
   },
   "dependencies": {
+    "@xylabs/assert": "^3.0.25",
     "@xylabs/crypto": "^3.0.25",
     "@xylabs/hex": "^3.0.25",
     "@xyo-network/account-model": "^2.94.11",
     "@xyo-network/boundwitness-builder": "^2.94.11",
+    "@xyo-network/boundwitness-model": "^2.94.11",
+    "@xyo-network/boundwitness-validator": "^2.94.11",
+    "@xyo-network/diviner-hash-lease": "^2.94.11",
     "@xyo-network/id-payload-plugin": "^2.94.11",
+    "@xyo-network/module-model": "^2.94.11",
     "@xyo-network/payload-model": "^2.94.11"
   },
   "devDependencies": {
@@ -61,6 +66,6 @@
     "url": "https://github.com/XYOracleNetwork/plugins.git"
   },
   "sideEffects": false,
-  "version": "2.91.5",
+  "version": "2.91.6",
   "type": "module"
 }

package/src/Escrow/index.ts

@@ -2,3 +2,4 @@ export * from './createEscrowIntent'
 export * from './getEscrowSecret'
 export * from './Schema'
 export * from './Terms'
+export * from './validators'

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

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

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

@@ -0,0 +1,48 @@
+import { ModuleIdentifier } from '@xyo-network/module-model'
+
+import { EscrowTerms } from '../../../Terms'
+import { EscrowTermsValueExpression } from '../../types/escrowValidation'
+
+/**
+ * Checks if property value of the escrow terms contains one of the valid moduleIdentifiers
+ * @param escrowTerms The escrow terms to validate
+ * @param propertyExpression The selector to get the property containing the moduleIdentifier(s) from the escrow terms
+ * @param moduleIdentifiers The list of allowed moduleIdentifiers
+ * @param required Is the property required to be present
+ * @returns True if the property value contains one of the valid moduleIdentifiers
+ */
+export const moduleIdentifiersContainsOneOf = (
+  escrowTerms: EscrowTerms,
+  propertyExpression: EscrowTermsValueExpression<'appraisalAuthorities' | 'buyer' | 'escrowAgent' | 'paymentAuthorities' | 'seller'>,
+  moduleIdentifiers: ModuleIdentifier[],
+  required: boolean = true,
+) => {
+  const termsValue: string | string[] | undefined = propertyExpression(escrowTerms)
+  if (termsValue === undefined) {
+    return required ? false : true
+  } else {
+    return Array.isArray(termsValue) ? termsValue.some((address) => moduleIdentifiers.includes(address)) : moduleIdentifiers.includes(termsValue)
+  }
+}
+
+/**
+ * Checks if property value of the escrow terms contains all of the valid moduleIdentifiers
+ * @param escrowTerms The escrow terms to validate
+ * @param selector The selector to get the property containing the moduleIdentifier(s) from the escrow terms
+ * @param moduleIdentifiers The list of allowed moduleIdentifiers
+ * @param required Is the property required to be present
+ * @returns True if the property value contains all of the valid moduleIdentifiers
+ */
+export const moduleIdentifiersContainsAllOf = (
+  escrowTerms: EscrowTerms,
+  selector: EscrowTermsValueExpression<'appraisalAuthorities' | 'buyer' | 'escrowAgent' | 'paymentAuthorities' | 'seller'>,
+  moduleIdentifiers: ModuleIdentifier[],
+  required: boolean = true,
+) => {
+  const termsValue: string | string[] | undefined = selector(escrowTerms)
+  if (termsValue === undefined) {
+    return required ? false : true
+  } else {
+    return Array.isArray(termsValue) ? termsValue.every((address) => moduleIdentifiers.includes(address)) : moduleIdentifiers.includes(termsValue)
+  }
+}

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

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

package/src/Escrow/validators/common/TemporalValidators/validateWithinWindow.ts

@@ -0,0 +1,7 @@
+export type Windowed = { exp?: number; nbf?: number }
+
+export const validateWithinWindow = (value: Windowed, exp: number, nbf: number = Date.now()): boolean => {
+  if (value.nbf === undefined || value.nbf > nbf) return false
+  if (value.exp === undefined || value.exp < exp) return false
+  return true
+}

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

@@ -0,0 +1,2 @@
+export * from './ModuleInstanceValidators'
+export * from './TemporalValidators'

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

@@ -0,0 +1,17 @@
+import { ModuleIdentifier } from '@xyo-network/module-model'
+
+import { EscrowTerms } from '../../Terms'
+import { moduleIdentifiersContainsOneOf } from '../common'
+import { EscrowTermsValidationFunction } from '../types'
+
+const name = 'EscrowTerms.escrowAgent'
+
+export const getEscrowAgentAllowedValidator = (allowedEscrowAgent: ModuleIdentifier): EscrowTermsValidationFunction => {
+  return (terms: EscrowTerms) => {
+    const result = moduleIdentifiersContainsOneOf(terms, (t) => t.escrowAgent, [allowedEscrowAgent], true)
+    if (!result) {
+      console.log(`${name}: Escrow agent not allowed: ${terms.escrowAgent}`)
+    }
+    return result
+  }
+}

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

@@ -0,0 +1,129 @@
+import { assertEx } from '@xylabs/assert'
+import { Hash } from '@xylabs/hex'
+import { BoundWitness, isBoundWitnessWithMeta } from '@xyo-network/boundwitness-model'
+import { HashLeaseEstimate, isHashLeaseEstimateWithSources } from '@xyo-network/diviner-hash-lease'
+import { Payload, WithMeta, WithSources } from '@xyo-network/payload-model'
+
+import { EscrowTerms } from '../../Terms'
+import { validateWithinWindow } from '../common'
+import { EscrowTermsValidationFunction } from '../types'
+
+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: EscrowTermsValidationFunction = (terms: EscrowTerms) => {
+  // Validate we have appraisals
+  const appraisals = terms.appraisals
+  if (!appraisals || appraisals.length === 0) {
+    console.log(`${name}: No appraisals: ${terms.appraisals}`)
+    return false
+  }
+  return true
+}
+
+/**
+ * Returns a function that validates the escrow terms for appraisals which are from valid authorities
+ * @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>>): EscrowTermsValidationFunction => {
+  return (terms: EscrowTerms) => {
+    const appraisals = assertEx(terms.appraisals, () => `${name}: No appraisals: ${terms.appraisals}`)
+    const appraisalAuthorities = assertEx(terms.appraisalAuthorities, () => `${name}: No appraisalAuthorities: ${terms.appraisalAuthorities}`)
+
+    // Validate the appraisals are signed by valid appraisal authorities. Validation criteria:
+    // - We have a bw for each of the appraisal
+    // - The bw is signed by an approved appraisal authority
+    const appraisalBWsValid: Record<Hash, WithMeta<BoundWitness>[]> = Object.fromEntries(
+      appraisals.map<[Hash, WithMeta<BoundWitness>[]]>((hash) => [hash, []]),
+    )
+    for (const bw of Object.values(dictionary).filter(isBoundWitnessWithMeta)) {
+      for (const appraisal of appraisals) {
+        if (bw.payload_hashes.includes(appraisal) && bw.addresses.some((address) => appraisalAuthorities.includes(address))) {
+          appraisalBWsValid[appraisal].push(bw)
+        }
+      }
+    }
+    for (const [appraisal, bws] of Object.entries(appraisalBWsValid)) {
+      if (bws.length === 0) {
+        console.log(`${name}: No valid appraisals for ${appraisal}`)
+        return false
+      }
+    }
+    return true
+  }
+}
+
+/**
+ * Returns a function that validates the escrow terms for appraisals which are valid
+ * @param dictionary Payload dictionary of the escrow terms
+ * @param minimumExp The minium amount of time an estimate needs to be valid
+ * for in the future (so as not to expire before the escrow is complete)
+ * @returns A function that validates the escrow terms for appraisals which are valid
+ */
+export const getAppraisalsValidValidator = (dictionary: Record<Hash, WithMeta<Payload>>, minimumExp: number): EscrowTermsValidationFunction => {
+  return (terms: EscrowTerms) => {
+    // Verify we have an estimate for each of the assets
+    const estimatesByAsset = getEstimatesByAsset(terms, dictionary)
+    // Validate each of the estimates are valid (time, price, etc)
+    const now = Date.now()
+    const exp = now + minimumExp
+    for (const [asset, estimates] of Object.entries(estimatesByAsset)) {
+      for (const estimate of estimates) {
+        if (!validateEstimate(estimate, exp)) {
+          console.log(`${name}: Invalid estimate for asset ${asset}: ${estimate}`)
+          return false
+        }
+      }
+    }
+    return true
+  }
+}
+
+/**
+ * Returns a function that validates the escrow terms to ensure that they contain an appraisal for each asset
+ * @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>>): EscrowTermsValidationFunction => {
+  return (terms: EscrowTerms) => {
+    // Verify we have an estimate for each of the assets
+    const estimatesByAsset = getEstimatesByAsset(terms, dictionary)
+    const assets = assertEx(terms.assets, () => `${name}: No assets: ${terms.assets}`)
+    if (Object.keys(estimatesByAsset).length !== assets.length) {
+      console.log(`${name}: Missing appraisals for all assets: ${assets}`)
+      return false
+    }
+    return true
+  }
+}
+
+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
+  return true
+}
+
+const getEstimatesByAsset = (terms: EscrowTerms, dictionary: Record<Hash, WithMeta<Payload>>): Record<Hash, WithSources<HashLeaseEstimate>[]> => {
+  const assets = assertEx(terms.assets, () => `${name}: No assets: ${terms.assets}`)
+  const estimates = Object.values(dictionary).filter(isHashLeaseEstimateWithSources) as unknown as WithSources<HashLeaseEstimate>[]
+  const estimatesByAsset: Record<Hash, WithSources<HashLeaseEstimate>[]> = {}
+  for (const estimate of estimates) {
+    const { sources } = estimate
+    if (sources === undefined || sources.length === 0) {
+      console.log(`${name}: No sources: ${estimate}`)
+      continue
+    }
+    for (const asset of assets) {
+      if (sources.includes(asset)) {
+        if (!estimatesByAsset[asset]) estimatesByAsset[asset] = []
+        estimatesByAsset[asset].push(estimate)
+      }
+    }
+  }
+  return estimatesByAsset
+}