@xyo-network/payment-plugin 3.0.18

package/dist/neutral/index.mjs

@@ -0,0 +1,347 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/Discount/Diviner.ts
+import { assertEx as assertEx2 } from "@xylabs/assert";
+import { exists as exists2 } from "@xylabs/exists";
+import { asArchivistInstance } from "@xyo-network/archivist-model";
+import { AbstractDiviner } from "@xyo-network/diviner-abstract";
+import { BoundWitnessDivinerQuerySchema } from "@xyo-network/diviner-boundwitness-model";
+import {
+  isHashLeaseEstimate
+} from "@xyo-network/diviner-hash-lease";
+import {
+  asDivinerInstance
+} from "@xyo-network/diviner-model";
+import { creatableModule } from "@xyo-network/module-model";
+import { PayloadBuilder } from "@xyo-network/payload-builder";
+import {
+  isCoupon,
+  isCouponWithMeta,
+  isEscrowTerms,
+  NO_DISCOUNT,
+  PaymentDiscountDivinerConfigSchema
+} from "@xyo-network/payment-payload-plugins";
+
+// src/Discount/lib/applyCoupons.ts
+import { assertEx } from "@xylabs/assert";
+import { exists } from "@xylabs/exists";
+import {
+  DiscountSchema,
+  isFixedAmountCoupon,
+  isFixedPercentageCoupon,
+  isStackable
+} from "@xyo-network/payment-payload-plugins";
+var applyCoupons = (appraisals, coupons) => {
+  const allAppraisalsAreUSD = appraisals.every((appraisal) => appraisal.currency === "USD");
+  assertEx(allAppraisalsAreUSD, "All appraisals must be in USD");
+  const allCouponsAreUSD = coupons.map((coupon) => coupon?.currency).filter(exists).every((currency2) => currency2 === "USD");
+  assertEx(allCouponsAreUSD, "All coupons must be in USD");
+  const total = appraisals.reduce((acc, appraisal) => acc + appraisal.price, 0);
+  const singularFixedDiscount = Math.max(...coupons.filter((coupon) => isFixedAmountCoupon(coupon) && !isStackable(coupon)).map((coupon) => coupon.amount), 0);
+  const singularPercentageDiscount = Math.max(...coupons.filter((coupon) => isFixedPercentageCoupon(coupon) && !isStackable(coupon)).map((coupon) => coupon.percentage), 0) * total;
+  const stackedFixedDiscount = coupons.filter((coupon) => isFixedAmountCoupon(coupon) && isStackable(coupon)).reduce((acc, coupon) => acc + coupon.amount, 0);
+  const stackedPercentageDiscount = coupons.filter((coupon) => isFixedPercentageCoupon(coupon) && isStackable(coupon)).reduce((acc, coupon) => acc + coupon.percentage, 0) * (total - stackedFixedDiscount);
+  const stackedDiscount = stackedFixedDiscount + stackedPercentageDiscount;
+  const maxDiscount = Math.max(
+    singularFixedDiscount,
+    singularPercentageDiscount,
+    stackedDiscount,
+    0
+  );
+  const amount = Math.min(maxDiscount, total);
+  return {
+    amount,
+    schema: DiscountSchema,
+    currency: "USD"
+  };
+};
+
+// src/Discount/Diviner.ts
+var DEFAULT_BOUND_WITNESS_DIVINER_QUERY_PROPS = {
+  limit: 1,
+  order: "desc",
+  schema: BoundWitnessDivinerQuerySchema
+};
+var PaymentDiscountDiviner = class extends AbstractDiviner {
+  get couponAuthorities() {
+    return [...this.config.couponAuthorities ?? [], ...this.params.couponAuthorities ?? []];
+  }
+  async divineHandler(payloads = []) {
+    const sources = [];
+    const terms = payloads.find(isEscrowTerms);
+    if (!terms) return [{ ...NO_DISCOUNT, sources }];
+    sources.push(await PayloadBuilder.hash(terms));
+    const discountHashes = terms.discounts ?? [];
+    if (discountHashes.length === 0) return [{ ...NO_DISCOUNT, sources }];
+    const termsAppraisals = terms?.appraisals;
+    if (!termsAppraisals || termsAppraisals.length === 0) return [{ ...NO_DISCOUNT, sources }];
+    const hashMap = await PayloadBuilder.toAllHashMap(payloads);
+    const foundAppraisals = termsAppraisals.filter((hash) => hashMap[hash]);
+    sources.push(...foundAppraisals);
+    if (foundAppraisals.length !== termsAppraisals.length) {
+      return [{ ...NO_DISCOUNT, sources }];
+    }
+    const appraisals = foundAppraisals.map((hash) => hashMap[hash]).filter(exists2).filter(isHashLeaseEstimate);
+    const discounts = discountHashes.map((hash) => hashMap[hash]).filter(exists2).filter(isCoupon);
+    if (discounts.length !== discountHashes.length) {
+      const discountsArchivist = await this.getDiscountsArchivist();
+      const foundDiscounts = await discountsArchivist.get(discountHashes);
+      discounts.push(...foundDiscounts.filter(isCouponWithMeta));
+    }
+    const discountsMap = await PayloadBuilder.toAllHashMap(discounts);
+    if (Object.keys(discountsMap).length === 0) return [{ ...NO_DISCOUNT, sources }];
+    const foundDiscountsHashes = Object.keys(discountsMap);
+    sources.push(...foundDiscountsHashes);
+    for (const hash of discountHashes) {
+      if (!foundDiscountsHashes.includes(hash)) {
+        console.warn(`Discount ${hash} not found for terms ${await PayloadBuilder.hash(terms)}`);
+      }
+    }
+    const coupons = Object.values(discountsMap);
+    const validCoupons = await this.filterToSigned(coupons.filter(this.isCouponCurrent));
+    if (validCoupons.length === 0) return [{ ...NO_DISCOUNT, sources }];
+    const discount = applyCoupons(appraisals, validCoupons);
+    return [{ ...discount, sources }];
+  }
+  /**
+   * Filters the supplied list of coupons to only those that are signed by
+   * addresses specified in the couponAuthorities
+   * @param coupons The list of coupons to filter
+   * @returns The filtered list of coupons that are signed by the couponAuthorities
+   */
+  async filterToSigned(coupons) {
+    const signed = [];
+    const dataHashMap = await PayloadBuilder.toDataHashMap(coupons);
+    const boundWitnessDiviner = await this.getDiscountsBoundWitnessDiviner();
+    const hashes = Object.keys(dataHashMap);
+    const addresses = this.couponAuthorities;
+    await Promise.all(hashes.map((h) => {
+      const hash = h;
+      return Promise.all(addresses.map(async (address) => {
+        const query = {
+          ...DEFAULT_BOUND_WITNESS_DIVINER_QUERY_PROPS,
+          addresses: [address],
+          payload_hashes: [hash]
+        };
+        const result = await boundWitnessDiviner.divine([query]);
+        if (result.length > 0) signed.push(dataHashMap[hash]);
+      }));
+    }));
+    return signed;
+  }
+  async getDiscountsArchivist() {
+    const name = assertEx2(this.config.archivist, () => "Missing archivist in config");
+    const mod = assertEx2(await this.resolve(name), () => `Error resolving archivist: ${name}`);
+    return assertEx2(asArchivistInstance(mod), () => `Resolved module ${mod.address} not a valid Archivist`);
+  }
+  async getDiscountsBoundWitnessDiviner() {
+    const name = assertEx2(this.config.boundWitnessDiviner, () => "Missing boundWitnessDiviner in config");
+    const mod = assertEx2(await this.resolve(name), () => `Error resolving boundWitnessDiviner: ${name}`);
+    return assertEx2(asDivinerInstance(mod), () => `Resolved module ${mod.address} not a valid Diviner`);
+  }
+  isCouponCurrent(coupon) {
+    const now = Date.now();
+    return coupon.exp > now && coupon.nbf < now;
+  }
+};
+__publicField(PaymentDiscountDiviner, "configSchemas", [PaymentDiscountDivinerConfigSchema]);
+__publicField(PaymentDiscountDiviner, "defaultConfigSchema", PaymentDiscountDivinerConfigSchema);
+PaymentDiscountDiviner = __decorateClass([
+  creatableModule()
+], PaymentDiscountDiviner);
+
+// src/Invoice/getInvoiceForEscrow.ts
+import { PayloadBuilder as PayloadBuilder2 } from "@xyo-network/payload-builder";
+import {
+  isDiscount,
+  isSubtotal,
+  isTotal,
+  PaymentSchema
+} from "@xyo-network/payment-payload-plugins";
+var getInvoiceForEscrow = async (terms, dataHashMap, paymentTotalDiviner) => {
+  const payloads = Object.values(dataHashMap);
+  const results = await paymentTotalDiviner.divine([terms, ...payloads]);
+  const subtotal = results.find(isSubtotal);
+  const discount = results.find(isDiscount);
+  const total = results.find(isTotal);
+  if (!subtotal || !total) return void 0;
+  const { amount, currency: currency2 } = total;
+  if (currency2 !== "USD") return void 0;
+  const sources = await getSources(terms, subtotal, total, discount);
+  const payment = {
+    amount,
+    currency: currency2,
+    schema: PaymentSchema,
+    sources
+  };
+  return discount ? [subtotal, total, payment, discount] : [subtotal, total, payment];
+};
+var getSources = async (terms, subtotal, total, discount) => {
+  const sources = discount ? [terms, subtotal, total, discount] : [terms, subtotal, total];
+  return await Promise.all(sources.map((p) => PayloadBuilder2.dataHash(p)));
+};
+
+// src/Subtotal/Diviner.ts
+import { AbstractDiviner as AbstractDiviner2 } from "@xyo-network/diviner-abstract";
+import { isHashLeaseEstimate as isHashLeaseEstimate2 } from "@xyo-network/diviner-hash-lease";
+import { creatableModule as creatableModule2 } from "@xyo-network/module-model";
+import { PayloadBuilder as PayloadBuilder3 } from "@xyo-network/payload-builder";
+import {
+  isEscrowTerms as isEscrowTerms2,
+  PaymentSubtotalDivinerConfigSchema,
+  SubtotalSchema
+} from "@xyo-network/payment-payload-plugins";
+
+// src/Subtotal/lib/appraisalValidators.ts
+import { isIso4217CurrencyCode } from "@xyo-network/payment-payload-plugins";
+
+// src/Subtotal/lib/durationValidators.ts
+var FIVE_MINUTES = 1e3 * 60 * 5;
+var validateDuration = (value, windowMs = FIVE_MINUTES) => {
+  const now = Date.now();
+  if (!value.nbf || value.nbf > now) return false;
+  if (!value.exp || value.exp - now < windowMs) return false;
+  return true;
+};
+
+// src/Subtotal/lib/appraisalValidators.ts
+var validateAppraisalAmount = (appraisals) => {
+  if (appraisals.some((appraisal) => typeof appraisal.price !== "number")) return false;
+  if (appraisals.some((appraisal) => appraisal.price < 0)) return false;
+  return true;
+};
+var validateAppraisalCurrency = (appraisals) => {
+  if (!appraisals.every((appraisal) => appraisal.currency == "USD")) return false;
+  if (!appraisals.every((appraisal) => isIso4217CurrencyCode(appraisal.currency))) return false;
+  return true;
+};
+var validateAppraisalConsistentCurrency = (appraisals) => {
+  if (appraisals.length <= 1) return true;
+  const { currency: currency2 } = appraisals[0];
+  if (!currency2) return false;
+  if (!appraisals.every((item) => item.currency === currency2)) return false;
+  return true;
+};
+var validateAppraisalWindow = (appraisals) => appraisals.every(validateDuration);
+var appraisalValidators = [
+  validateAppraisalAmount,
+  validateAppraisalCurrency,
+  validateAppraisalConsistentCurrency,
+  validateAppraisalWindow
+];
+
+// src/Subtotal/lib/termsValidators.ts
+var validateTermsAppraisals = (terms) => {
+  if (!terms.appraisals) return false;
+  if (terms.appraisals.length === 0) return false;
+  return true;
+};
+var validateTermsWindow = (terms) => validateDuration(terms);
+var termsValidators = [
+  validateTermsAppraisals,
+  validateTermsWindow
+];
+
+// src/Subtotal/Diviner.ts
+var currency = "USD";
+var PaymentSubtotalDiviner = class extends AbstractDiviner2 {
+  async divineHandler(payloads = []) {
+    const terms = payloads.find(isEscrowTerms2);
+    if (!terms) return [];
+    if (!termsValidators.every((validator) => validator(terms))) return [];
+    const validTerms = terms;
+    const hashMap = await PayloadBuilder3.toAllHashMap(payloads);
+    const appraisals = validTerms.appraisals.map((appraisal) => hashMap[appraisal]).filter(isHashLeaseEstimate2);
+    if (appraisals.length !== validTerms.appraisals.length) return [];
+    if (!appraisalValidators.every((validator) => validator(appraisals))) return [];
+    const amount = calculateSubtotal(appraisals);
+    const sources = [await PayloadBuilder3.dataHash(validTerms), ...validTerms.appraisals];
+    return [{
+      amount,
+      currency,
+      schema: SubtotalSchema,
+      sources
+    }];
+  }
+};
+__publicField(PaymentSubtotalDiviner, "configSchemas", [PaymentSubtotalDivinerConfigSchema]);
+__publicField(PaymentSubtotalDiviner, "defaultConfigSchema", PaymentSubtotalDivinerConfigSchema);
+PaymentSubtotalDiviner = __decorateClass([
+  creatableModule2()
+], PaymentSubtotalDiviner);
+var calculateSubtotal = (appraisals) => {
+  return appraisals.reduce((sum, appraisal) => sum + appraisal.price, 0);
+};
+
+// src/Total/Diviner.ts
+import { assertEx as assertEx3 } from "@xylabs/assert";
+import { AbstractDiviner as AbstractDiviner3 } from "@xyo-network/diviner-abstract";
+import {
+  asDivinerInstance as asDivinerInstance2
+} from "@xyo-network/diviner-model";
+import { creatableModule as creatableModule3 } from "@xyo-network/module-model";
+import {
+  isDiscountWithMeta,
+  isSubtotalWithMeta,
+  PaymentTotalDivinerConfigSchema,
+  TotalSchema
+} from "@xyo-network/payment-payload-plugins";
+var PaymentTotalDiviner = class extends AbstractDiviner3 {
+  async divineHandler(payloads = []) {
+    const subtotalDiviner = await this.getPaymentSubtotalDiviner();
+    const subtotalResult = await subtotalDiviner.divine(payloads);
+    const subtotal = subtotalResult.find(isSubtotalWithMeta);
+    if (!subtotal) return [];
+    const discountDiviner = await this.getPaymentDiscountsDiviner();
+    const discountResult = await discountDiviner.divine(payloads);
+    const discount = discountResult.find(isDiscountWithMeta);
+    if (!discount) return [];
+    const { currency: subtotalCurrency } = subtotal;
+    const { currency: discountCurrency } = discount;
+    assertEx3(subtotalCurrency === discountCurrency, () => `Subtotal currency ${subtotalCurrency} does not match discount currency ${discountCurrency}`);
+    const amount = Math.max(0, subtotal.amount - discount.amount);
+    const currency2 = subtotalCurrency;
+    const sources = [subtotal.$hash, discount.$hash];
+    const total = {
+      amount,
+      currency: currency2,
+      sources,
+      schema: TotalSchema
+    };
+    return [subtotal, discount, total];
+  }
+  async getPaymentDiscountsDiviner() {
+    const name = assertEx3(this.config.paymentDiscountDiviner, () => "Missing paymentDiscountDiviner in config");
+    const mod = assertEx3(await this.resolve(name), () => `Error resolving paymentDiscountDiviner: ${name}`);
+    return assertEx3(asDivinerInstance2(mod), () => `Resolved module ${mod.address} not a valid Diviner`);
+  }
+  async getPaymentSubtotalDiviner() {
+    const name = assertEx3(this.config.paymentSubtotalDiviner, () => "Missing paymentSubtotalDiviner in config");
+    const mod = assertEx3(await this.resolve(name), () => `Error resolving paymentSubtotalDiviner: ${name}`);
+    return assertEx3(asDivinerInstance2(mod), () => `Resolved module ${mod.address} not a valid Diviner`);
+  }
+};
+__publicField(PaymentTotalDiviner, "configSchemas", [PaymentTotalDivinerConfigSchema]);
+__publicField(PaymentTotalDiviner, "defaultConfigSchema", PaymentTotalDivinerConfigSchema);
+PaymentTotalDiviner = __decorateClass([
+  creatableModule3()
+], PaymentTotalDiviner);
+export {
+  PaymentDiscountDiviner,
+  PaymentSubtotalDiviner,
+  PaymentTotalDiviner,
+  applyCoupons,
+  getInvoiceForEscrow
+};
+//# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Discount/Diviner.ts","../../src/Discount/lib/applyCoupons.ts","../../src/Invoice/getInvoiceForEscrow.ts","../../src/Subtotal/Diviner.ts","../../src/Subtotal/lib/appraisalValidators.ts","../../src/Subtotal/lib/durationValidators.ts","../../src/Subtotal/lib/termsValidators.ts","../../src/Total/Diviner.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport { Address, Hash } from '@xylabs/hex'\nimport { ArchivistInstance, asArchivistInstance } from '@xyo-network/archivist-model'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { BoundWitnessDivinerQueryPayload, BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'\nimport {\n  HashLeaseEstimate,\n  isHashLeaseEstimate,\n} from '@xyo-network/diviner-hash-lease'\nimport {\n  asDivinerInstance, DivinerInstance, DivinerModuleEventData,\n} from '@xyo-network/diviner-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload } from '@xyo-network/payload-model'\nimport {\n  Coupon,\n  Discount,\n  EscrowTerms, isCoupon,\n  isCouponWithMeta,\n  isEscrowTerms, NO_DISCOUNT, PaymentDiscountDivinerConfigSchema, PaymentDiscountDivinerParams,\n} from '@xyo-network/payment-payload-plugins'\n\nimport { applyCoupons } from './lib/index.ts'\n\nconst DEFAULT_BOUND_WITNESS_DIVINER_QUERY_PROPS: Readonly<BoundWitnessDivinerQueryPayload> = {\n  limit: 1,\n  order: 'desc',\n  schema: BoundWitnessDivinerQuerySchema,\n}\n\nexport type PaymentDiscountDivinerInputType = EscrowTerms | Coupon | HashLeaseEstimate | Payload\n\n@creatableModule()\nexport class PaymentDiscountDiviner<\n  TParams extends PaymentDiscountDivinerParams = PaymentDiscountDivinerParams,\n  TIn extends PaymentDiscountDivinerInputType = PaymentDiscountDivinerInputType,\n  TOut extends Discount = Discount,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override configSchemas = [PaymentDiscountDivinerConfigSchema]\n  static override defaultConfigSchema = PaymentDiscountDivinerConfigSchema\n\n  protected get couponAuthorities(): Address[] {\n    return [...(this.config.couponAuthorities ?? []), ...(this.params.couponAuthorities ?? [])]\n  }\n\n  protected async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    const sources: Hash[] = []\n\n    // Parse terms\n    const terms = payloads.find(isEscrowTerms) as EscrowTerms | undefined\n    if (!terms) return [{ ...NO_DISCOUNT, sources }] as TOut[]\n    sources.push(await PayloadBuilder.hash(terms))\n\n    // Parse discounts\n    const discountHashes = terms.discounts ?? []\n    if (discountHashes.length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]\n\n    // TODO: Call paymentSubtotalDiviner to get the subtotal to centralize the logic\n    // Parse appraisals\n    const termsAppraisals = terms?.appraisals\n    if (!termsAppraisals || termsAppraisals.length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]\n    const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n    const foundAppraisals = termsAppraisals.filter(hash => hashMap[hash])\n    // Add the appraisals that were found to the sources\n    sources.push(...foundAppraisals)\n    // If not all appraisals are found, return no discount\n    if (foundAppraisals.length !== termsAppraisals.length) {\n      return [{ ...NO_DISCOUNT, sources }] as TOut[]\n    }\n    // TODO: Cast should not be required\n    const appraisals = foundAppraisals.map(hash => hashMap[hash]).filter(exists).filter(isHashLeaseEstimate) as unknown as HashLeaseEstimate[]\n\n    // Use the supplied payloads to find the discounts\n    const discounts = discountHashes.map(hash => hashMap[hash]).filter(exists).filter(isCoupon) as Coupon[]\n    // Find any remaining coupons from the archivist\n    if (discounts.length !== discountHashes.length) {\n      // Find remaining from discounts archivist\n      const discountsArchivist = await this.getDiscountsArchivist()\n      const foundDiscounts = await discountsArchivist.get(discountHashes)\n      discounts.push(...foundDiscounts.filter(isCouponWithMeta))\n    }\n    const discountsMap = await PayloadBuilder.toAllHashMap(discounts)\n    if (Object.keys(discountsMap).length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]\n\n    // Add the found discounts to the sources\n    const foundDiscountsHashes = Object.keys(discountsMap) as Hash[]\n    sources.push(...foundDiscountsHashes)\n\n    // Log individual discounts that were not found\n    for (const hash of discountHashes) {\n      if (!foundDiscountsHashes.includes(hash)) {\n        console.warn(`Discount ${hash} not found for terms ${await PayloadBuilder.hash(terms)}`)\n      }\n    }\n\n    // Parse coupons\n    const coupons = Object.values(discountsMap)\n    const validCoupons = await this.filterToSigned(coupons.filter(this.isCouponCurrent))\n    if (validCoupons.length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]\n\n    const discount = applyCoupons(appraisals, validCoupons)\n    return [{ ...discount, sources }] as TOut[]\n  }\n\n  /**\n   * Filters the supplied list of coupons to only those that are signed by\n   * addresses specified in the couponAuthorities\n   * @param coupons The list of coupons to filter\n   * @returns The filtered list of coupons that are signed by the couponAuthorities\n   */\n  protected async filterToSigned(coupons: Coupon[]): Promise<Coupon[]> {\n    const signed: Coupon[] = []\n    const dataHashMap = await PayloadBuilder.toDataHashMap(coupons)\n    const boundWitnessDiviner = await this.getDiscountsBoundWitnessDiviner()\n    const hashes = Object.keys(dataHashMap)\n    const addresses = this.couponAuthorities\n    // TODO: Keep an in memory cache of the hashes queried and their results\n    // to avoid querying the same hash multiple times\n    await Promise.all(hashes.map((h) => {\n      const hash = h as Hash\n      return Promise.all(addresses.map(async (address) => {\n        const query: BoundWitnessDivinerQueryPayload = {\n          ...DEFAULT_BOUND_WITNESS_DIVINER_QUERY_PROPS, addresses: [address], payload_hashes: [hash],\n        }\n        const result = await boundWitnessDiviner.divine([query])\n        if (result.length > 0) signed.push(dataHashMap[hash])\n      }))\n    }))\n    return signed\n  }\n\n  protected async getDiscountsArchivist(): Promise<ArchivistInstance> {\n    const name = assertEx(this.config.archivist, () => 'Missing archivist in config')\n    const mod = assertEx(await this.resolve(name), () => `Error resolving archivist: ${name}`)\n    return assertEx(asArchivistInstance(mod), () => `Resolved module ${mod.address} not a valid Archivist`)\n  }\n\n  protected async getDiscountsBoundWitnessDiviner(): Promise<DivinerInstance> {\n    const name = assertEx(this.config.boundWitnessDiviner, () => 'Missing boundWitnessDiviner in config')\n    const mod = assertEx(await this.resolve(name), () => `Error resolving boundWitnessDiviner: ${name}`)\n    return assertEx(asDivinerInstance(mod), () => `Resolved module ${mod.address} not a valid Diviner`)\n  }\n\n  protected isCouponCurrent(coupon: Coupon): boolean {\n    const now = Date.now()\n    return coupon.exp > now && coupon.nbf < now\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport type { HashLeaseEstimate } from '@xyo-network/diviner-hash-lease'\nimport type {\n  AmountFields,\n  Coupon, Discount, FixedAmountCoupon,\n  FixedPercentageCoupon,\n} from '@xyo-network/payment-payload-plugins'\nimport {\n  DiscountSchema, isFixedAmountCoupon, isFixedPercentageCoupon,\n  isStackable,\n} from '@xyo-network/payment-payload-plugins'\n\nexport const applyCoupons = (appraisals: HashLeaseEstimate[], coupons: Coupon[]): Discount => {\n  // Ensure all appraisals and coupons are in USD\n  const allAppraisalsAreUSD = appraisals.every(appraisal => appraisal.currency === 'USD')\n  assertEx(allAppraisalsAreUSD, 'All appraisals must be in USD')\n  const allCouponsAreUSD = coupons.map(coupon => (coupon as Partial<AmountFields>)?.currency).filter(exists).every(currency => currency === 'USD')\n  assertEx(allCouponsAreUSD, 'All coupons must be in USD')\n  const total = appraisals.reduce((acc, appraisal) => acc + appraisal.price, 0)\n\n  // Calculated non-stackable discount coupons\n  const singularFixedDiscount = Math.max(...coupons\n    .filter(coupon => isFixedAmountCoupon(coupon) && !isStackable(coupon))\n    .map(coupon => (coupon as FixedAmountCoupon).amount), 0)\n  const singularPercentageDiscount = (Math.max(...coupons\n    .filter(coupon => isFixedPercentageCoupon(coupon) && !isStackable(coupon))\n    .map(coupon => (coupon as FixedPercentageCoupon).percentage), 0)) * total\n\n  // Calculate stackable discount coupons\n  // First calculate the total discount from fixed amount coupons\n  const stackedFixedDiscount = coupons\n    .filter(coupon => isFixedAmountCoupon(coupon) && isStackable(coupon))\n    .reduce((acc, coupon) => acc + (coupon as FixedAmountCoupon).amount, 0)\n  // Then calculate the total discount from percentage coupons and apply\n  // the percentage discount to the remaining total after fixed discounts\n  const stackedPercentageDiscount = coupons\n    .filter(coupon => isFixedPercentageCoupon(coupon) && isStackable(coupon))\n    .reduce((acc, coupon) => acc + (coupon as FixedPercentageCoupon).percentage, 0) * (total - stackedFixedDiscount)\n  // Sum all stackable discounts\n  const stackedDiscount = stackedFixedDiscount + stackedPercentageDiscount\n\n  // Find the best coupon(s) to apply\n  const maxDiscount = Math.max(\n    singularFixedDiscount,\n    singularPercentageDiscount,\n    stackedDiscount,\n    0,\n  )\n\n  // Ensure discount is not more than the total\n  const amount = Math.min(maxDiscount, total)\n\n  // Return single discount payload\n  return {\n    amount, schema: DiscountSchema, currency: 'USD',\n  }\n}\n","import type { Hash } from '@xylabs/hex'\nimport type { DivinerInstance } from '@xyo-network/diviner-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload } from '@xyo-network/payload-model'\nimport type {\n  Discount, EscrowTerms, Invoice, Payment, Subtotal, Total,\n} from '@xyo-network/payment-payload-plugins'\nimport {\n  isDiscount, isSubtotal, isTotal, PaymentSchema,\n} from '@xyo-network/payment-payload-plugins'\n\n/**\n * Validates the escrow terms to ensure they are valid for a purchase\n * @returns A payment if the terms are valid for a purchase, undefined otherwise\n */\nexport const getInvoiceForEscrow = async (\n  terms: EscrowTerms,\n  dataHashMap: Record<Hash, Payload>,\n  paymentTotalDiviner: DivinerInstance,\n): Promise<Invoice | undefined> => {\n  const payloads = Object.values(dataHashMap)\n  const results = await paymentTotalDiviner.divine([terms, ...payloads])\n  const subtotal = results.find(isSubtotal) as Subtotal | undefined\n  const discount = results.find(isDiscount) as Discount | undefined\n  const total = results.find(isTotal) as Total | undefined\n  if (!subtotal || !total) return undefined\n  const { amount, currency } = total\n  if (currency !== 'USD') return undefined\n  const sources = await getSources(terms, subtotal, total, discount)\n  const payment: Payment = {\n    amount, currency, schema: PaymentSchema, sources,\n  }\n  return discount ? [subtotal, total, payment, discount] : [subtotal, total, payment]\n}\n\nconst getSources = async (terms: EscrowTerms, subtotal: Subtotal, total: Total, discount?: Discount): Promise<Hash[]> => {\n  const sources = discount ? [terms, subtotal, total, discount] : [terms, subtotal, total]\n  return await Promise.all(sources.map(p => PayloadBuilder.dataHash(p)))\n}\n","import { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { HashLeaseEstimate, isHashLeaseEstimate } from '@xyo-network/diviner-hash-lease'\nimport { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload } from '@xyo-network/payload-model'\nimport {\n  EscrowTerms, isEscrowTerms, PaymentSubtotalDivinerConfigSchema, PaymentSubtotalDivinerParams, Subtotal, SubtotalSchema,\n} from '@xyo-network/payment-payload-plugins'\n\nimport {\n  appraisalValidators, termsValidators, ValidEscrowTerms,\n} from './lib/index.ts'\n\nconst currency = 'USD'\n\n/**\n * Escrow terms that contain all the valid fields for calculating a subtotal\n */\nexport type PaymentSubtotalDivinerInputType = EscrowTerms | HashLeaseEstimate | Payload\n\n@creatableModule()\nexport class PaymentSubtotalDiviner<\n  TParams extends PaymentSubtotalDivinerParams = PaymentSubtotalDivinerParams,\n  TIn extends PaymentSubtotalDivinerInputType = PaymentSubtotalDivinerInputType,\n  TOut extends Subtotal = Subtotal,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override configSchemas = [PaymentSubtotalDivinerConfigSchema]\n  static override defaultConfigSchema = PaymentSubtotalDivinerConfigSchema\n\n  protected async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    // Find the escrow terms\n    const terms = payloads.find(isEscrowTerms) as EscrowTerms | undefined\n    if (!terms) return []\n\n    // Run all terms validations\n    if (!termsValidators.every(validator => validator(terms))) return []\n    const validTerms = terms as ValidEscrowTerms\n\n    // Retrieve all appraisals from terms\n    const hashMap = await PayloadBuilder.toAllHashMap(payloads)\n    const appraisals = validTerms.appraisals.map(appraisal => hashMap[appraisal]).filter(isHashLeaseEstimate) as unknown as HashLeaseEstimate[]\n\n    // Ensure all appraisals are present\n    if (appraisals.length !== validTerms.appraisals.length) return []\n\n    // Run all appraisal validations\n    if (!appraisalValidators.every(validator => validator(appraisals))) return []\n    const amount = calculateSubtotal(appraisals)\n    const sources = [await PayloadBuilder.dataHash(validTerms), ...validTerms.appraisals]\n    return [{\n      amount, currency, schema: SubtotalSchema, sources,\n    }] as TOut[]\n  }\n}\n\n// TODO: Add support for other currencies\nconst calculateSubtotal = (appraisals: HashLeaseEstimate[]): number => {\n  return appraisals.reduce((sum, appraisal) => sum + appraisal.price, 0)\n}\n","import type { HashLeaseEstimate } from '@xyo-network/diviner-hash-lease'\nimport { isIso4217CurrencyCode } from '@xyo-network/payment-payload-plugins'\n\nimport { validateDuration } from './durationValidators.ts'\n\nconst validateAppraisalAmount = (appraisals: HashLeaseEstimate[]): boolean => {\n  // Ensure all appraisals are numeric\n  if (appraisals.some(appraisal => typeof appraisal.price !== 'number')) return false\n  // Ensure all appraisals are positive numbers\n  if (appraisals.some(appraisal => appraisal.price < 0)) return false\n  return true\n}\n\nconst validateAppraisalCurrency = (appraisals: HashLeaseEstimate[]): boolean => {\n  // NOTE: Only supporting USD for now, the remaining checks are for future-proofing.\n  if (!appraisals.every(appraisal => appraisal.currency == 'USD')) return false\n\n  // Check every object in the array to ensure they all are in a supported currency.\n  if (!appraisals.every(appraisal => isIso4217CurrencyCode(appraisal.currency))) return false\n\n  return true\n}\n\nconst validateAppraisalConsistentCurrency = (appraisals: HashLeaseEstimate[]): boolean => {\n  // Check if the array is empty or contains only one element, no need to compare.\n  if (appraisals.length <= 1) return true\n\n  // Get the currency of the first element to compare with others.\n  const { currency } = appraisals[0]\n  if (!currency) return false\n\n  // Check every object in the array to ensure they all have the same currency.\n  if (!appraisals.every(item => item.currency === currency)) return false\n\n  return true\n}\n\nconst validateAppraisalWindow = (appraisals: HashLeaseEstimate[]): boolean => appraisals.every(validateDuration)\n\nexport const appraisalValidators = [\n  validateAppraisalAmount,\n  validateAppraisalCurrency,\n  validateAppraisalConsistentCurrency,\n  validateAppraisalWindow,\n]\n","import type { DurationFields } from '@xyo-network/xns-record-payload-plugins'\n\nconst FIVE_MINUTES = 1000 * 60 * 5\n\n/**\n * Validates that the current time is within the duration window, within a configurable a buffer\n * @param value The duration value\n * @param windowMs The window in milliseconds to allow for a buffer\n * @returns True if the duration is valid, false otherwise\n */\nexport const validateDuration = (value: Partial<DurationFields>, windowMs = FIVE_MINUTES): boolean => {\n  const now = Date.now()\n  if (!value.nbf || value.nbf > now) return false\n  // If already expired (include for a 5 minute buffer to allow for a reasonable\n  // minimum amount of time for the transaction to be processed)\n  if (!value.exp || value.exp - now < windowMs) return false\n  return true\n}\n","import type { Hash } from '@xylabs/hex'\nimport type { EscrowTerms } from '@xyo-network/payment-payload-plugins'\n\nimport { validateDuration } from './durationValidators.ts'\n\nexport type ValidEscrowTerms = Required<EscrowTerms>\n\nconst validateTermsAppraisals = (terms: EscrowTerms): terms is Required<EscrowTerms & { appraisals: Hash[] }> => {\n  if (!terms.appraisals) return false\n  if (terms.appraisals.length === 0) return false\n  return true\n}\nconst validateTermsWindow = (terms: EscrowTerms): boolean => validateDuration(terms)\n\nexport const termsValidators = [\n  validateTermsAppraisals,\n  validateTermsWindow,\n]\n","import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport {\n  asDivinerInstance, DivinerInstance, DivinerModuleEventData,\n} from '@xyo-network/diviner-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport {\n  Discount,\n  isDiscountWithMeta,\n  isSubtotalWithMeta,\n  PaymentTotalDivinerConfigSchema, PaymentTotalDivinerParams, Subtotal, Total, TotalSchema,\n} from '@xyo-network/payment-payload-plugins'\n\nimport { PaymentDiscountDiviner, PaymentDiscountDivinerInputType } from '../Discount/index.ts'\nimport { PaymentSubtotalDiviner, PaymentSubtotalDivinerInputType } from '../Subtotal/index.ts'\n\ntype InputType = PaymentDiscountDivinerInputType | PaymentSubtotalDivinerInputType\ntype OutputType = Subtotal | Discount | Total\n\n@creatableModule()\nexport class PaymentTotalDiviner<\n  TParams extends PaymentTotalDivinerParams = PaymentTotalDivinerParams,\n  TIn extends InputType = InputType,\n  TOut extends OutputType = OutputType,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override configSchemas = [PaymentTotalDivinerConfigSchema]\n  static override defaultConfigSchema: PaymentTotalDivinerConfigSchema = PaymentTotalDivinerConfigSchema\n\n  protected async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    const subtotalDiviner = await this.getPaymentSubtotalDiviner()\n    const subtotalResult = await subtotalDiviner.divine(payloads)\n    const subtotal = subtotalResult.find(isSubtotalWithMeta)\n    if (!subtotal) return []\n    const discountDiviner = await this.getPaymentDiscountsDiviner()\n    const discountResult = await discountDiviner.divine(payloads)\n    const discount = discountResult.find(isDiscountWithMeta)\n    if (!discount) return []\n    const { currency: subtotalCurrency } = subtotal\n    const { currency: discountCurrency } = discount\n    assertEx(subtotalCurrency === discountCurrency, () => `Subtotal currency ${subtotalCurrency} does not match discount currency ${discountCurrency}`)\n    const amount = Math.max(0, subtotal.amount - discount.amount)\n    const currency = subtotalCurrency\n    const sources = [subtotal.$hash, discount.$hash] as Hash[]\n    const total: Total = {\n      amount, currency, sources, schema: TotalSchema,\n    }\n    return [subtotal, discount, total] as TOut[]\n  }\n\n  protected async getPaymentDiscountsDiviner(): Promise<PaymentDiscountDiviner> {\n    const name = assertEx(this.config.paymentDiscountDiviner, () => 'Missing paymentDiscountDiviner in config')\n    const mod = assertEx(await this.resolve(name), () => `Error resolving paymentDiscountDiviner: ${name}`)\n    return assertEx(asDivinerInstance(mod), () => `Resolved module ${mod.address} not a valid Diviner`) as PaymentDiscountDiviner\n  }\n\n  protected async getPaymentSubtotalDiviner(): Promise<PaymentSubtotalDiviner> {\n    const name = assertEx(this.config.paymentSubtotalDiviner, () => 'Missing paymentSubtotalDiviner in config')\n    const mod = assertEx(await this.resolve(name), () => `Error resolving paymentSubtotalDiviner: ${name}`)\n    return assertEx(asDivinerInstance(mod), () => `Resolved module ${mod.address} not a valid Diviner`) as PaymentSubtotalDiviner\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA,SAAS,YAAAA,iBAAgB;AACzB,SAAS,UAAAC,eAAc;AAEvB,SAA4B,2BAA2B;AACvD,SAAS,uBAAuB;AAChC,SAA0C,sCAAsC;AAChF;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EACE;AAAA,OACK;AACP,SAAS,uBAAuB;AAChC,SAAS,sBAAsB;AAE/B;AAAA,EAGe;AAAA,EACb;AAAA,EACA;AAAA,EAAe;AAAA,EAAa;AAAA,OACvB;;;ACtBP,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAOvB;AAAA,EACE;AAAA,EAAgB;AAAA,EAAqB;AAAA,EACrC;AAAA,OACK;AAEA,IAAM,eAAe,CAAC,YAAiC,YAAgC;AAE5F,QAAM,sBAAsB,WAAW,MAAM,eAAa,UAAU,aAAa,KAAK;AACtF,WAAS,qBAAqB,+BAA+B;AAC7D,QAAM,mBAAmB,QAAQ,IAAI,YAAW,QAAkC,QAAQ,EAAE,OAAO,MAAM,EAAE,MAAM,CAAAC,cAAYA,cAAa,KAAK;AAC/I,WAAS,kBAAkB,4BAA4B;AACvD,QAAM,QAAQ,WAAW,OAAO,CAAC,KAAK,cAAc,MAAM,UAAU,OAAO,CAAC;AAG5E,QAAM,wBAAwB,KAAK,IAAI,GAAG,QACvC,OAAO,YAAU,oBAAoB,MAAM,KAAK,CAAC,YAAY,MAAM,CAAC,EACpE,IAAI,YAAW,OAA6B,MAAM,GAAG,CAAC;AACzD,QAAM,6BAA8B,KAAK,IAAI,GAAG,QAC7C,OAAO,YAAU,wBAAwB,MAAM,KAAK,CAAC,YAAY,MAAM,CAAC,EACxE,IAAI,YAAW,OAAiC,UAAU,GAAG,CAAC,IAAK;AAItE,QAAM,uBAAuB,QAC1B,OAAO,YAAU,oBAAoB,MAAM,KAAK,YAAY,MAAM,CAAC,EACnE,OAAO,CAAC,KAAK,WAAW,MAAO,OAA6B,QAAQ,CAAC;AAGxE,QAAM,4BAA4B,QAC/B,OAAO,YAAU,wBAAwB,MAAM,KAAK,YAAY,MAAM,CAAC,EACvE,OAAO,CAAC,KAAK,WAAW,MAAO,OAAiC,YAAY,CAAC,KAAK,QAAQ;AAE7F,QAAM,kBAAkB,uBAAuB;AAG/C,QAAM,cAAc,KAAK;AAAA,IACvB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAGA,QAAM,SAAS,KAAK,IAAI,aAAa,KAAK;AAG1C,SAAO;AAAA,IACL;AAAA,IAAQ,QAAQ;AAAA,IAAgB,UAAU;AAAA,EAC5C;AACF;;;AD/BA,IAAM,4CAAuF;AAAA,EAC3F,OAAO;AAAA,EACP,OAAO;AAAA,EACP,QAAQ;AACV;AAKO,IAAM,yBAAN,cASG,gBAAgD;AAAA,EAIxD,IAAc,oBAA+B;AAC3C,WAAO,CAAC,GAAI,KAAK,OAAO,qBAAqB,CAAC,GAAI,GAAI,KAAK,OAAO,qBAAqB,CAAC,CAAE;AAAA,EAC5F;AAAA,EAEA,MAAgB,cAAc,WAAkB,CAAC,GAAoB;AACnE,UAAM,UAAkB,CAAC;AAGzB,UAAM,QAAQ,SAAS,KAAK,aAAa;AACzC,QAAI,CAAC,MAAO,QAAO,CAAC,EAAE,GAAG,aAAa,QAAQ,CAAC;AAC/C,YAAQ,KAAK,MAAM,eAAe,KAAK,KAAK,CAAC;AAG7C,UAAM,iBAAiB,MAAM,aAAa,CAAC;AAC3C,QAAI,eAAe,WAAW,EAAG,QAAO,CAAC,EAAE,GAAG,aAAa,QAAQ,CAAC;AAIpE,UAAM,kBAAkB,OAAO;AAC/B,QAAI,CAAC,mBAAmB,gBAAgB,WAAW,EAAG,QAAO,CAAC,EAAE,GAAG,aAAa,QAAQ,CAAC;AACzF,UAAM,UAAU,MAAM,eAAe,aAAa,QAAQ;AAC1D,UAAM,kBAAkB,gBAAgB,OAAO,UAAQ,QAAQ,IAAI,CAAC;AAEpE,YAAQ,KAAK,GAAG,eAAe;AAE/B,QAAI,gBAAgB,WAAW,gBAAgB,QAAQ;AACrD,aAAO,CAAC,EAAE,GAAG,aAAa,QAAQ,CAAC;AAAA,IACrC;AAEA,UAAM,aAAa,gBAAgB,IAAI,UAAQ,QAAQ,IAAI,CAAC,EAAE,OAAOC,OAAM,EAAE,OAAO,mBAAmB;AAGvG,UAAM,YAAY,eAAe,IAAI,UAAQ,QAAQ,IAAI,CAAC,EAAE,OAAOA,OAAM,EAAE,OAAO,QAAQ;AAE1F,QAAI,UAAU,WAAW,eAAe,QAAQ;AAE9C,YAAM,qBAAqB,MAAM,KAAK,sBAAsB;AAC5D,YAAM,iBAAiB,MAAM,mBAAmB,IAAI,cAAc;AAClE,gBAAU,KAAK,GAAG,eAAe,OAAO,gBAAgB,CAAC;AAAA,IAC3D;AACA,UAAM,eAAe,MAAM,eAAe,aAAa,SAAS;AAChE,QAAI,OAAO,KAAK,YAAY,EAAE,WAAW,EAAG,QAAO,CAAC,EAAE,GAAG,aAAa,QAAQ,CAAC;AAG/E,UAAM,uBAAuB,OAAO,KAAK,YAAY;AACrD,YAAQ,KAAK,GAAG,oBAAoB;AAGpC,eAAW,QAAQ,gBAAgB;AACjC,UAAI,CAAC,qBAAqB,SAAS,IAAI,GAAG;AACxC,gBAAQ,KAAK,YAAY,IAAI,wBAAwB,MAAM,eAAe,KAAK,KAAK,CAAC,EAAE;AAAA,MACzF;AAAA,IACF;AAGA,UAAM,UAAU,OAAO,OAAO,YAAY;AAC1C,UAAM,eAAe,MAAM,KAAK,eAAe,QAAQ,OAAO,KAAK,eAAe,CAAC;AACnF,QAAI,aAAa,WAAW,EAAG,QAAO,CAAC,EAAE,GAAG,aAAa,QAAQ,CAAC;AAElE,UAAM,WAAW,aAAa,YAAY,YAAY;AACtD,WAAO,CAAC,EAAE,GAAG,UAAU,QAAQ,CAAC;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,eAAe,SAAsC;AACnE,UAAM,SAAmB,CAAC;AAC1B,UAAM,cAAc,MAAM,eAAe,cAAc,OAAO;AAC9D,UAAM,sBAAsB,MAAM,KAAK,gCAAgC;AACvE,UAAM,SAAS,OAAO,KAAK,WAAW;AACtC,UAAM,YAAY,KAAK;AAGvB,UAAM,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM;AAClC,YAAM,OAAO;AACb,aAAO,QAAQ,IAAI,UAAU,IAAI,OAAO,YAAY;AAClD,cAAM,QAAyC;AAAA,UAC7C,GAAG;AAAA,UAA2C,WAAW,CAAC,OAAO;AAAA,UAAG,gBAAgB,CAAC,IAAI;AAAA,QAC3F;AACA,cAAM,SAAS,MAAM,oBAAoB,OAAO,CAAC,KAAK,CAAC;AACvD,YAAI,OAAO,SAAS,EAAG,QAAO,KAAK,YAAY,IAAI,CAAC;AAAA,MACtD,CAAC,CAAC;AAAA,IACJ,CAAC,CAAC;AACF,WAAO;AAAA,EACT;AAAA,EAEA,MAAgB,wBAAoD;AAClE,UAAM,OAAOC,UAAS,KAAK,OAAO,WAAW,MAAM,6BAA6B;AAChF,UAAM,MAAMA,UAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,8BAA8B,IAAI,EAAE;AACzF,WAAOA,UAAS,oBAAoB,GAAG,GAAG,MAAM,mBAAmB,IAAI,OAAO,wBAAwB;AAAA,EACxG;AAAA,EAEA,MAAgB,kCAA4D;AAC1E,UAAM,OAAOA,UAAS,KAAK,OAAO,qBAAqB,MAAM,uCAAuC;AACpG,UAAM,MAAMA,UAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,wCAAwC,IAAI,EAAE;AACnG,WAAOA,UAAS,kBAAkB,GAAG,GAAG,MAAM,mBAAmB,IAAI,OAAO,sBAAsB;AAAA,EACpG;AAAA,EAEU,gBAAgB,QAAyB;AACjD,UAAM,MAAM,KAAK,IAAI;AACrB,WAAO,OAAO,MAAM,OAAO,OAAO,MAAM;AAAA,EAC1C;AACF;AA7GE,cAVW,wBAUK,iBAAgB,CAAC,kCAAkC;AACnE,cAXW,wBAWK,uBAAsB;AAX3B,yBAAN;AAAA,EADN,gBAAgB;AAAA,GACJ;;;AEjCb,SAAS,kBAAAC,uBAAsB;AAK/B;AAAA,EACE;AAAA,EAAY;AAAA,EAAY;AAAA,EAAS;AAAA,OAC5B;AAMA,IAAM,sBAAsB,OACjC,OACA,aACA,wBACiC;AACjC,QAAM,WAAW,OAAO,OAAO,WAAW;AAC1C,QAAM,UAAU,MAAM,oBAAoB,OAAO,CAAC,OAAO,GAAG,QAAQ,CAAC;AACrE,QAAM,WAAW,QAAQ,KAAK,UAAU;AACxC,QAAM,WAAW,QAAQ,KAAK,UAAU;AACxC,QAAM,QAAQ,QAAQ,KAAK,OAAO;AAClC,MAAI,CAAC,YAAY,CAAC,MAAO,QAAO;AAChC,QAAM,EAAE,QAAQ,UAAAC,UAAS,IAAI;AAC7B,MAAIA,cAAa,MAAO,QAAO;AAC/B,QAAM,UAAU,MAAM,WAAW,OAAO,UAAU,OAAO,QAAQ;AACjE,QAAM,UAAmB;AAAA,IACvB;AAAA,IAAQ,UAAAA;AAAA,IAAU,QAAQ;AAAA,IAAe;AAAA,EAC3C;AACA,SAAO,WAAW,CAAC,UAAU,OAAO,SAAS,QAAQ,IAAI,CAAC,UAAU,OAAO,OAAO;AACpF;AAEA,IAAM,aAAa,OAAO,OAAoB,UAAoB,OAAc,aAAyC;AACvH,QAAM,UAAU,WAAW,CAAC,OAAO,UAAU,OAAO,QAAQ,IAAI,CAAC,OAAO,UAAU,KAAK;AACvF,SAAO,MAAM,QAAQ,IAAI,QAAQ,IAAI,OAAKD,gBAAe,SAAS,CAAC,CAAC,CAAC;AACvE;;;ACtCA,SAAS,mBAAAE,wBAAuB;AAChC,SAA4B,uBAAAC,4BAA2B;AAEvD,SAAS,mBAAAC,wBAAuB;AAChC,SAAS,kBAAAC,uBAAsB;AAE/B;AAAA,EACe,iBAAAC;AAAA,EAAe;AAAA,EAA4E;AAAA,OACnG;;;ACPP,SAAS,6BAA6B;;;ACCtC,IAAM,eAAe,MAAO,KAAK;AAQ1B,IAAM,mBAAmB,CAAC,OAAgC,WAAW,iBAA0B;AACpG,QAAM,MAAM,KAAK,IAAI;AACrB,MAAI,CAAC,MAAM,OAAO,MAAM,MAAM,IAAK,QAAO;AAG1C,MAAI,CAAC,MAAM,OAAO,MAAM,MAAM,MAAM,SAAU,QAAO;AACrD,SAAO;AACT;;;ADZA,IAAM,0BAA0B,CAAC,eAA6C;AAE5E,MAAI,WAAW,KAAK,eAAa,OAAO,UAAU,UAAU,QAAQ,EAAG,QAAO;AAE9E,MAAI,WAAW,KAAK,eAAa,UAAU,QAAQ,CAAC,EAAG,QAAO;AAC9D,SAAO;AACT;AAEA,IAAM,4BAA4B,CAAC,eAA6C;AAE9E,MAAI,CAAC,WAAW,MAAM,eAAa,UAAU,YAAY,KAAK,EAAG,QAAO;AAGxE,MAAI,CAAC,WAAW,MAAM,eAAa,sBAAsB,UAAU,QAAQ,CAAC,EAAG,QAAO;AAEtF,SAAO;AACT;AAEA,IAAM,sCAAsC,CAAC,eAA6C;AAExF,MAAI,WAAW,UAAU,EAAG,QAAO;AAGnC,QAAM,EAAE,UAAAC,UAAS,IAAI,WAAW,CAAC;AACjC,MAAI,CAACA,UAAU,QAAO;AAGtB,MAAI,CAAC,WAAW,MAAM,UAAQ,KAAK,aAAaA,SAAQ,EAAG,QAAO;AAElE,SAAO;AACT;AAEA,IAAM,0BAA0B,CAAC,eAA6C,WAAW,MAAM,gBAAgB;AAExG,IAAM,sBAAsB;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;;;AErCA,IAAM,0BAA0B,CAAC,UAAgF;AAC/G,MAAI,CAAC,MAAM,WAAY,QAAO;AAC9B,MAAI,MAAM,WAAW,WAAW,EAAG,QAAO;AAC1C,SAAO;AACT;AACA,IAAM,sBAAsB,CAAC,UAAgC,iBAAiB,KAAK;AAE5E,IAAM,kBAAkB;AAAA,EAC7B;AAAA,EACA;AACF;;;AHHA,IAAM,WAAW;AAQV,IAAM,yBAAN,cASGC,iBAAgD;AAAA,EAIxD,MAAgB,cAAc,WAAkB,CAAC,GAAoB;AAEnE,UAAM,QAAQ,SAAS,KAAKC,cAAa;AACzC,QAAI,CAAC,MAAO,QAAO,CAAC;AAGpB,QAAI,CAAC,gBAAgB,MAAM,eAAa,UAAU,KAAK,CAAC,EAAG,QAAO,CAAC;AACnE,UAAM,aAAa;AAGnB,UAAM,UAAU,MAAMC,gBAAe,aAAa,QAAQ;AAC1D,UAAM,aAAa,WAAW,WAAW,IAAI,eAAa,QAAQ,SAAS,CAAC,EAAE,OAAOC,oBAAmB;AAGxG,QAAI,WAAW,WAAW,WAAW,WAAW,OAAQ,QAAO,CAAC;AAGhE,QAAI,CAAC,oBAAoB,MAAM,eAAa,UAAU,UAAU,CAAC,EAAG,QAAO,CAAC;AAC5E,UAAM,SAAS,kBAAkB,UAAU;AAC3C,UAAM,UAAU,CAAC,MAAMD,gBAAe,SAAS,UAAU,GAAG,GAAG,WAAW,UAAU;AACpF,WAAO,CAAC;AAAA,MACN;AAAA,MAAQ;AAAA,MAAU,QAAQ;AAAA,MAAgB;AAAA,IAC5C,CAAC;AAAA,EACH;AACF;AA3BE,cAVW,wBAUK,iBAAgB,CAAC,kCAAkC;AACnE,cAXW,wBAWK,uBAAsB;AAX3B,yBAAN;AAAA,EADNE,iBAAgB;AAAA,GACJ;AAwCb,IAAM,oBAAoB,CAAC,eAA4C;AACrE,SAAO,WAAW,OAAO,CAAC,KAAK,cAAc,MAAM,UAAU,OAAO,CAAC;AACvE;;;AIhEA,SAAS,YAAAC,iBAAgB;AAEzB,SAAS,mBAAAC,wBAAuB;AAChC;AAAA,EACE,qBAAAC;AAAA,OACK;AACP,SAAS,mBAAAC,wBAAuB;AAChC;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EAA6E;AAAA,OACxE;AASA,IAAM,sBAAN,cASGC,iBAAgD;AAAA,EAIxD,MAAgB,cAAc,WAAkB,CAAC,GAAoB;AACnE,UAAM,kBAAkB,MAAM,KAAK,0BAA0B;AAC7D,UAAM,iBAAiB,MAAM,gBAAgB,OAAO,QAAQ;AAC5D,UAAM,WAAW,eAAe,KAAK,kBAAkB;AACvD,QAAI,CAAC,SAAU,QAAO,CAAC;AACvB,UAAM,kBAAkB,MAAM,KAAK,2BAA2B;AAC9D,UAAM,iBAAiB,MAAM,gBAAgB,OAAO,QAAQ;AAC5D,UAAM,WAAW,eAAe,KAAK,kBAAkB;AACvD,QAAI,CAAC,SAAU,QAAO,CAAC;AACvB,UAAM,EAAE,UAAU,iBAAiB,IAAI;AACvC,UAAM,EAAE,UAAU,iBAAiB,IAAI;AACvC,IAAAC,UAAS,qBAAqB,kBAAkB,MAAM,qBAAqB,gBAAgB,qCAAqC,gBAAgB,EAAE;AAClJ,UAAM,SAAS,KAAK,IAAI,GAAG,SAAS,SAAS,SAAS,MAAM;AAC5D,UAAMC,YAAW;AACjB,UAAM,UAAU,CAAC,SAAS,OAAO,SAAS,KAAK;AAC/C,UAAM,QAAe;AAAA,MACnB;AAAA,MAAQ,UAAAA;AAAA,MAAU;AAAA,MAAS,QAAQ;AAAA,IACrC;AACA,WAAO,CAAC,UAAU,UAAU,KAAK;AAAA,EACnC;AAAA,EAEA,MAAgB,6BAA8D;AAC5E,UAAM,OAAOD,UAAS,KAAK,OAAO,wBAAwB,MAAM,0CAA0C;AAC1G,UAAM,MAAMA,UAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,2CAA2C,IAAI,EAAE;AACtG,WAAOA,UAASE,mBAAkB,GAAG,GAAG,MAAM,mBAAmB,IAAI,OAAO,sBAAsB;AAAA,EACpG;AAAA,EAEA,MAAgB,4BAA6D;AAC3E,UAAM,OAAOF,UAAS,KAAK,OAAO,wBAAwB,MAAM,0CAA0C;AAC1G,UAAM,MAAMA,UAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,2CAA2C,IAAI,EAAE;AACtG,WAAOA,UAASE,mBAAkB,GAAG,GAAG,MAAM,mBAAmB,IAAI,OAAO,sBAAsB;AAAA,EACpG;AACF;AAnCE,cAVW,qBAUK,iBAAgB,CAAC,+BAA+B;AAChE,cAXW,qBAWK,uBAAuD;AAX5D,sBAAN;AAAA,EADNC,iBAAgB;AAAA,GACJ;","names":["assertEx","exists","currency","exists","assertEx","PayloadBuilder","currency","AbstractDiviner","isHashLeaseEstimate","creatableModule","PayloadBuilder","isEscrowTerms","currency","AbstractDiviner","isEscrowTerms","PayloadBuilder","isHashLeaseEstimate","creatableModule","assertEx","AbstractDiviner","asDivinerInstance","creatableModule","AbstractDiviner","assertEx","currency","asDivinerInstance","creatableModule"]}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@xyo-network/payment-plugin",
+  "version": "3.0.18",
+  "description": "Typescript/Javascript Plugins for XYO Platform",
+  "homepage": "https://xyo.network",
+  "bugs": {
+    "url": "git+https://github.com/XYOracleNetwork/plugins/issues",
+    "email": "support@xyo.network"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XYO Development Team",
+    "email": "support@xyo.network",
+    "url": "https://xyo.network"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/neutral/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "dist/neutral/index.mjs",
+  "types": "dist/neutral/index.d.ts",
+  "dependencies": {
+    "@xylabs/assert": "^4.0.9",
+    "@xylabs/exists": "^4.0.10",
+    "@xylabs/hex": "^4.0.10",
+    "@xyo-network/archivist-model": "^3.1.9",
+    "@xyo-network/diviner-abstract": "^3.1.9",
+    "@xyo-network/diviner-boundwitness-model": "^3.1.9",
+    "@xyo-network/diviner-hash-lease": "^3.1.9",
+    "@xyo-network/diviner-model": "^3.1.9",
+    "@xyo-network/module-model": "^3.1.9",
+    "@xyo-network/payload-builder": "^3.1.9",
+    "@xyo-network/payload-model": "^3.1.9",
+    "@xyo-network/payment-payload-plugins": "^3.0.18",
+    "@xyo-network/xns-record-payload-plugins": "^3.0.18"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^4.0.7",
+    "@xylabs/tsconfig": "^4.0.7",
+    "@xyo-network/account": "^3.1.9",
+    "@xyo-network/archivist-memory": "^3.1.9",
+    "@xyo-network/boundwitness-builder": "^3.1.9",
+    "@xyo-network/diviner-boundwitness-memory": "^3.1.9",
+    "@xyo-network/node-memory": "^3.1.9",
+    "jest": "^29.7.0",
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/Discount/Diviner.ts

@@ -0,0 +1,155 @@
+import { assertEx } from '@xylabs/assert'
+import { exists } from '@xylabs/exists'
+import { Address, Hash } from '@xylabs/hex'
+import { ArchivistInstance, asArchivistInstance } from '@xyo-network/archivist-model'
+import { AbstractDiviner } from '@xyo-network/diviner-abstract'
+import { BoundWitnessDivinerQueryPayload, BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'
+import {
+  HashLeaseEstimate,
+  isHashLeaseEstimate,
+} from '@xyo-network/diviner-hash-lease'
+import {
+  asDivinerInstance, DivinerInstance, DivinerModuleEventData,
+} from '@xyo-network/diviner-model'
+import { creatableModule } from '@xyo-network/module-model'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import { Payload } from '@xyo-network/payload-model'
+import {
+  Coupon,
+  Discount,
+  EscrowTerms, isCoupon,
+  isCouponWithMeta,
+  isEscrowTerms, NO_DISCOUNT, PaymentDiscountDivinerConfigSchema, PaymentDiscountDivinerParams,
+} from '@xyo-network/payment-payload-plugins'
+
+import { applyCoupons } from './lib/index.ts'
+
+const DEFAULT_BOUND_WITNESS_DIVINER_QUERY_PROPS: Readonly<BoundWitnessDivinerQueryPayload> = {
+  limit: 1,
+  order: 'desc',
+  schema: BoundWitnessDivinerQuerySchema,
+}
+
+export type PaymentDiscountDivinerInputType = EscrowTerms | Coupon | HashLeaseEstimate | Payload
+
+@creatableModule()
+export class PaymentDiscountDiviner<
+  TParams extends PaymentDiscountDivinerParams = PaymentDiscountDivinerParams,
+  TIn extends PaymentDiscountDivinerInputType = PaymentDiscountDivinerInputType,
+  TOut extends Discount = Discount,
+  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<
+    DivinerInstance<TParams, TIn, TOut>,
+    TIn,
+    TOut
+  >,
+> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
+  static override configSchemas = [PaymentDiscountDivinerConfigSchema]
+  static override defaultConfigSchema = PaymentDiscountDivinerConfigSchema
+
+  protected get couponAuthorities(): Address[] {
+    return [...(this.config.couponAuthorities ?? []), ...(this.params.couponAuthorities ?? [])]
+  }
+
+  protected async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {
+    const sources: Hash[] = []
+
+    // Parse terms
+    const terms = payloads.find(isEscrowTerms) as EscrowTerms | undefined
+    if (!terms) return [{ ...NO_DISCOUNT, sources }] as TOut[]
+    sources.push(await PayloadBuilder.hash(terms))
+
+    // Parse discounts
+    const discountHashes = terms.discounts ?? []
+    if (discountHashes.length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]
+
+    // TODO: Call paymentSubtotalDiviner to get the subtotal to centralize the logic
+    // Parse appraisals
+    const termsAppraisals = terms?.appraisals
+    if (!termsAppraisals || termsAppraisals.length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]
+    const hashMap = await PayloadBuilder.toAllHashMap(payloads)
+    const foundAppraisals = termsAppraisals.filter(hash => hashMap[hash])
+    // Add the appraisals that were found to the sources
+    sources.push(...foundAppraisals)
+    // If not all appraisals are found, return no discount
+    if (foundAppraisals.length !== termsAppraisals.length) {
+      return [{ ...NO_DISCOUNT, sources }] as TOut[]
+    }
+    // TODO: Cast should not be required
+    const appraisals = foundAppraisals.map(hash => hashMap[hash]).filter(exists).filter(isHashLeaseEstimate) as unknown as HashLeaseEstimate[]
+
+    // Use the supplied payloads to find the discounts
+    const discounts = discountHashes.map(hash => hashMap[hash]).filter(exists).filter(isCoupon) as Coupon[]
+    // Find any remaining coupons from the archivist
+    if (discounts.length !== discountHashes.length) {
+      // Find remaining from discounts archivist
+      const discountsArchivist = await this.getDiscountsArchivist()
+      const foundDiscounts = await discountsArchivist.get(discountHashes)
+      discounts.push(...foundDiscounts.filter(isCouponWithMeta))
+    }
+    const discountsMap = await PayloadBuilder.toAllHashMap(discounts)
+    if (Object.keys(discountsMap).length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]
+
+    // Add the found discounts to the sources
+    const foundDiscountsHashes = Object.keys(discountsMap) as Hash[]
+    sources.push(...foundDiscountsHashes)
+
+    // Log individual discounts that were not found
+    for (const hash of discountHashes) {
+      if (!foundDiscountsHashes.includes(hash)) {
+        console.warn(`Discount ${hash} not found for terms ${await PayloadBuilder.hash(terms)}`)
+      }
+    }
+
+    // Parse coupons
+    const coupons = Object.values(discountsMap)
+    const validCoupons = await this.filterToSigned(coupons.filter(this.isCouponCurrent))
+    if (validCoupons.length === 0) return [{ ...NO_DISCOUNT, sources }] as TOut[]
+
+    const discount = applyCoupons(appraisals, validCoupons)
+    return [{ ...discount, sources }] as TOut[]
+  }
+
+  /**
+   * Filters the supplied list of coupons to only those that are signed by
+   * addresses specified in the couponAuthorities
+   * @param coupons The list of coupons to filter
+   * @returns The filtered list of coupons that are signed by the couponAuthorities
+   */
+  protected async filterToSigned(coupons: Coupon[]): Promise<Coupon[]> {
+    const signed: Coupon[] = []
+    const dataHashMap = await PayloadBuilder.toDataHashMap(coupons)
+    const boundWitnessDiviner = await this.getDiscountsBoundWitnessDiviner()
+    const hashes = Object.keys(dataHashMap)
+    const addresses = this.couponAuthorities
+    // TODO: Keep an in memory cache of the hashes queried and their results
+    // to avoid querying the same hash multiple times
+    await Promise.all(hashes.map((h) => {
+      const hash = h as Hash
+      return Promise.all(addresses.map(async (address) => {
+        const query: BoundWitnessDivinerQueryPayload = {
+          ...DEFAULT_BOUND_WITNESS_DIVINER_QUERY_PROPS, addresses: [address], payload_hashes: [hash],
+        }
+        const result = await boundWitnessDiviner.divine([query])
+        if (result.length > 0) signed.push(dataHashMap[hash])
+      }))
+    }))
+    return signed
+  }
+
+  protected async getDiscountsArchivist(): Promise<ArchivistInstance> {
+    const name = assertEx(this.config.archivist, () => 'Missing archivist in config')
+    const mod = assertEx(await this.resolve(name), () => `Error resolving archivist: ${name}`)
+    return assertEx(asArchivistInstance(mod), () => `Resolved module ${mod.address} not a valid Archivist`)
+  }
+
+  protected async getDiscountsBoundWitnessDiviner(): Promise<DivinerInstance> {
+    const name = assertEx(this.config.boundWitnessDiviner, () => 'Missing boundWitnessDiviner in config')
+    const mod = assertEx(await this.resolve(name), () => `Error resolving boundWitnessDiviner: ${name}`)
+    return assertEx(asDivinerInstance(mod), () => `Resolved module ${mod.address} not a valid Diviner`)
+  }
+
+  protected isCouponCurrent(coupon: Coupon): boolean {
+    const now = Date.now()
+    return coupon.exp > now && coupon.nbf < now
+  }
+}

package/src/Discount/index.ts

@@ -0,0 +1,2 @@
+export * from './Diviner.ts'
+export * from './lib/index.ts'