@xyo-network/payment-payload-plugins 2.89.1 → 2.89.2

package/dist/node/Escrow/Terms.d.mts

@@ -0,0 +1,58 @@
+import { Address, Hash } from '@xylabs/hex';
+import { Payload } from '@xyo-network/payload-model';
+export declare const EscrowTermsSchema: "network.xyo.escrow.terms";
+export type EscrowTermsSchema = typeof EscrowTermsSchema;
+export interface EscrowTermsFields {
+    /**
+     * The trusted estimators for the worth of the things being sold
+     */
+    appraisalAuthorities: Address[];
+    /**
+     * The estimated worths of the things being sold
+     */
+    appraisals: Hash[];
+    /**
+     * The things being sold
+     */
+    assets: Hash[];
+    /**
+     * The buyer
+     */
+    buyer: Address[];
+    /**
+     * The buyer
+     */
+    buyerSecret: Hash;
+    /**
+     * The escrow agent responsible for the escrow
+     */
+    escrowAgent: Address;
+    /**
+     * The time the escrow expires
+     */
+    exp: number;
+    /**
+     * The time the escrow starts
+     */
+    nbf: number;
+    /**
+     * The trusted payment authorities
+     */
+    paymentAuthorities: Address[];
+    /**
+     * The seller
+     */
+    seller: Address[];
+    /**
+     * The seller
+     */
+    sellerSecret: Hash;
+}
+/**
+ * The terms of an escrow
+ */
+export type EscrowTerms = Payload<Partial<EscrowTermsFields>, EscrowTermsSchema>;
+export declare const isEscrowTerms: (x?: unknown) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Partial<EscrowTermsFields> & {
+    schema: "network.xyo.escrow.terms";
+};
+//# sourceMappingURL=Terms.d.ts.map

package/dist/node/Escrow/Terms.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Terms.d.ts","sourceRoot":"","sources":["../../../src/Escrow/Terms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAyB,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAI3E,eAAO,MAAM,iBAAiB,4BAAmC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAGxD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,oBAAoB,EAAE,OAAO,EAAE,CAAA;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,EAAE,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,IAAI,EAAE,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAA;IACjB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB;;OAEG;IACH,YAAY,EAAE,IAAI,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAA;AAEhF,eAAO,MAAM,aAAa;;CAAwD,CAAA"}

package/dist/node/Escrow/Terms.d.ts

@@ -0,0 +1,58 @@
+import { Address, Hash } from '@xylabs/hex';
+import { Payload } from '@xyo-network/payload-model';
+export declare const EscrowTermsSchema: "network.xyo.escrow.terms";
+export type EscrowTermsSchema = typeof EscrowTermsSchema;
+export interface EscrowTermsFields {
+    /**
+     * The trusted estimators for the worth of the things being sold
+     */
+    appraisalAuthorities: Address[];
+    /**
+     * The estimated worths of the things being sold
+     */
+    appraisals: Hash[];
+    /**
+     * The things being sold
+     */
+    assets: Hash[];
+    /**
+     * The buyer
+     */
+    buyer: Address[];
+    /**
+     * The buyer
+     */
+    buyerSecret: Hash;
+    /**
+     * The escrow agent responsible for the escrow
+     */
+    escrowAgent: Address;
+    /**
+     * The time the escrow expires
+     */
+    exp: number;
+    /**
+     * The time the escrow starts
+     */
+    nbf: number;
+    /**
+     * The trusted payment authorities
+     */
+    paymentAuthorities: Address[];
+    /**
+     * The seller
+     */
+    seller: Address[];
+    /**
+     * The seller
+     */
+    sellerSecret: Hash;
+}
+/**
+ * The terms of an escrow
+ */
+export type EscrowTerms = Payload<Partial<EscrowTermsFields>, EscrowTermsSchema>;
+export declare const isEscrowTerms: (x?: unknown) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Partial<EscrowTermsFields> & {
+    schema: "network.xyo.escrow.terms";
+};
+//# sourceMappingURL=Terms.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Terms.d.ts","sourceRoot":"","sources":["../../../src/Escrow/Terms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAyB,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAI3E,eAAO,MAAM,iBAAiB,4BAAmC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAGxD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,oBAAoB,EAAE,OAAO,EAAE,CAAA;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,EAAE,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,IAAI,EAAE,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAA;IACjB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB;;OAEG;IACH,YAAY,EAAE,IAAI,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAA;AAEhF,eAAO,MAAM,aAAa;;CAAwD,CAAA"}

package/dist/node/Escrow/createEscrowIntent.d.cts

@@ -0,0 +1,20 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { EscrowTerms } from './Terms';
+/**
+ * Creates an escrow intent
+ * @param terms The payloads describing the terms for the escrow
+ * @param account The account to create the escrow intent with
+ * @returns The escrow intent
+ */
+export declare const createEscrowIntent: (terms: EscrowTerms[], account: AccountInstance) => Promise<[import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/boundwitness-model").BoundWitnessFields & {
+    schema: "network.xyo.boundwitness";
+}>, import("@xyo-network/payload-model").WithMeta<{
+    schema: string;
+} & import("@xyo-network/payload-model").PayloadFields>[], import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    message?: string | undefined;
+    name?: string | undefined;
+    query?: Lowercase<string> | undefined;
+    schema: "network.xyo.error.module";
+    sources?: Lowercase<string>[] | undefined;
+}>[]]>;
+//# sourceMappingURL=createEscrowIntent.d.ts.map

package/dist/node/Escrow/createEscrowIntent.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEscrowIntent.d.ts","sourceRoot":"","sources":["../../../src/Escrow/createEscrowIntent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAG5D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,UAAiB,WAAW,EAAE,WAAW,eAAe;;;;;;;;;;MAGtF,CAAA"}

package/dist/node/Escrow/createEscrowIntent.d.mts

@@ -0,0 +1,20 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { EscrowTerms } from './Terms';
+/**
+ * Creates an escrow intent
+ * @param terms The payloads describing the terms for the escrow
+ * @param account The account to create the escrow intent with
+ * @returns The escrow intent
+ */
+export declare const createEscrowIntent: (terms: EscrowTerms[], account: AccountInstance) => Promise<[import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/boundwitness-model").BoundWitnessFields & {
+    schema: "network.xyo.boundwitness";
+}>, import("@xyo-network/payload-model").WithMeta<{
+    schema: string;
+} & import("@xyo-network/payload-model").PayloadFields>[], import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    message?: string | undefined;
+    name?: string | undefined;
+    query?: Lowercase<string> | undefined;
+    schema: "network.xyo.error.module";
+    sources?: Lowercase<string>[] | undefined;
+}>[]]>;
+//# sourceMappingURL=createEscrowIntent.d.ts.map

package/dist/node/Escrow/createEscrowIntent.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEscrowIntent.d.ts","sourceRoot":"","sources":["../../../src/Escrow/createEscrowIntent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAG5D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,UAAiB,WAAW,EAAE,WAAW,eAAe;;;;;;;;;;MAGtF,CAAA"}

package/dist/node/Escrow/createEscrowIntent.d.ts

@@ -0,0 +1,20 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { EscrowTerms } from './Terms';
+/**
+ * Creates an escrow intent
+ * @param terms The payloads describing the terms for the escrow
+ * @param account The account to create the escrow intent with
+ * @returns The escrow intent
+ */
+export declare const createEscrowIntent: (terms: EscrowTerms[], account: AccountInstance) => Promise<[import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/boundwitness-model").BoundWitnessFields & {
+    schema: "network.xyo.boundwitness";
+}>, import("@xyo-network/payload-model").WithMeta<{
+    schema: string;
+} & import("@xyo-network/payload-model").PayloadFields>[], import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    message?: string | undefined;
+    name?: string | undefined;
+    query?: Lowercase<string> | undefined;
+    schema: "network.xyo.error.module";
+    sources?: Lowercase<string>[] | undefined;
+}>[]]>;
+//# sourceMappingURL=createEscrowIntent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createEscrowIntent.d.ts","sourceRoot":"","sources":["../../../src/Escrow/createEscrowIntent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAG5D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,UAAiB,WAAW,EAAE,WAAW,eAAe;;;;;;;;;;MAGtF,CAAA"}

package/dist/node/Escrow/getEscrowSecret.d.cts

@@ -0,0 +1,7 @@
+import { IdPayload } from '@xyo-network/id-payload-plugin';
+/**
+ * Returns a cryptographically random secret to use for escrow
+ * @returns The escrow secret
+ */
+export declare const getEscrowSecret: () => IdPayload;
+//# sourceMappingURL=getEscrowSecret.d.ts.map

package/dist/node/Escrow/getEscrowSecret.d.cts.map

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

package/dist/node/Escrow/getEscrowSecret.d.mts

@@ -0,0 +1,7 @@
+import { IdPayload } from '@xyo-network/id-payload-plugin';
+/**
+ * Returns a cryptographically random secret to use for escrow
+ * @returns The escrow secret
+ */
+export declare const getEscrowSecret: () => IdPayload;
+//# sourceMappingURL=getEscrowSecret.d.ts.map

package/dist/node/Escrow/getEscrowSecret.d.mts.map

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

package/dist/node/Escrow/getEscrowSecret.d.ts

@@ -0,0 +1,7 @@
+import { IdPayload } from '@xyo-network/id-payload-plugin';
+/**
+ * Returns a cryptographically random secret to use for escrow
+ * @returns The escrow secret
+ */
+export declare const getEscrowSecret: () => IdPayload;
+//# sourceMappingURL=getEscrowSecret.d.ts.map

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

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

package/dist/node/Escrow/index.d.cts

@@ -0,0 +1,5 @@
+export * from './createEscrowIntent';
+export * from './getEscrowSecret';
+export * from './Schema';
+export * from './Terms';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/Escrow/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Escrow/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}

package/dist/node/Escrow/index.d.mts

@@ -0,0 +1,5 @@
+export * from './createEscrowIntent';
+export * from './getEscrowSecret';
+export * from './Schema';
+export * from './Terms';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/Escrow/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Escrow/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}

package/dist/node/Escrow/index.d.ts

@@ -0,0 +1,5 @@
+export * from './createEscrowIntent';
+export * from './getEscrowSecret';
+export * from './Schema';
+export * from './Terms';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/Escrow/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Escrow/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}

package/dist/node/index.cjs

@@ -20,23 +20,55 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  EscrowSchema: () => EscrowSchema,
+  EscrowTermsSchema: () => EscrowTermsSchema,
   PaymentSchema: () => PaymentSchema,
   PurchaseSchema: () => PurchaseSchema,
+  createEscrowIntent: () => createEscrowIntent,
+  getEscrowSecret: () => getEscrowSecret,
+  isEscrowTerms: () => isEscrowTerms,
   isPayment: () => isPayment
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/Payment.ts
+// src/Escrow/createEscrowIntent.ts
+var import_boundwitness_builder = require("@xyo-network/boundwitness-builder");
+var createEscrowIntent = async (terms, account) => {
+  const result = await new import_boundwitness_builder.BoundWitnessBuilder({ accounts: [account] }).payloads([...terms]).build();
+  return result;
+};
+
+// src/Escrow/getEscrowSecret.ts
+var import_crypto = require("@xylabs/crypto");
+var import_id_payload_plugin = require("@xyo-network/id-payload-plugin");
+var getEscrowSecret = () => {
+  return { salt: import_crypto.Crypto.randomUUID(), schema: import_id_payload_plugin.IdSchema };
+};
+
+// src/Escrow/Schema.ts
+var EscrowSchema = "network.xyo.escrow";
+
+// src/Escrow/Terms.ts
 var import_payload_model = require("@xyo-network/payload-model");
+var EscrowTermsSchema = `${EscrowSchema}.terms`;
+var isEscrowTerms = (0, import_payload_model.isPayloadOfSchemaType)(EscrowTermsSchema);
+
+// src/Payment.ts
+var import_payload_model2 = require("@xyo-network/payload-model");
 var PaymentSchema = "network.xyo.payments.payment";
-var isPayment = (0, import_payload_model.isPayloadOfSchemaType)(PaymentSchema);
+var isPayment = (0, import_payload_model2.isPayloadOfSchemaType)(PaymentSchema);
 
 // src/Purchase.ts
 var PurchaseSchema = "network.xyo.payments.purchase";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  EscrowSchema,
+  EscrowTermsSchema,
   PaymentSchema,
   PurchaseSchema,
+  createEscrowIntent,
+  getEscrowSecret,
+  isEscrowTerms,
   isPayment
 });
 //# sourceMappingURL=index.cjs.map

package/dist/node/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts","../../src/Payment.ts","../../src/Purchase.ts"],"sourcesContent":["export * from './Currency'\nexport * from './Payment'\nexport * from './Purchase'\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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,2BAA0D;AAKnD,IAAM,gBAA+B;AAkBrC,IAAM,gBAAY,4CAA+B,aAAa;;;ACnB9D,IAAM,iBAAiC;","names":[]}
+{"version":3,"sources":["../../src/index.ts","../../src/Escrow/createEscrowIntent.ts","../../src/Escrow/getEscrowSecret.ts","../../src/Escrow/Schema.ts","../../src/Escrow/Terms.ts","../../src/Payment.ts","../../src/Purchase.ts"],"sourcesContent":["export * from './Currency'\nexport * from './Escrow'\nexport * from './Payment'\nexport * from './Purchase'\n","import { AccountInstance } from '@xyo-network/account-model'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\n\nimport { EscrowTerms } from './Terms'\n\n/**\n * Creates an escrow intent\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","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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,kCAAoC;AAU7B,IAAM,qBAAqB,OAAO,OAAsB,YAA6B;AAC1F,QAAM,SAAS,MAAM,IAAI,gDAAoB,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,EAAE,MAAM;AACjG,SAAO;AACT;;;ACdA,oBAAuB;AACvB,+BAAoC;AAM7B,IAAM,kBAAkB,MAAiB;AAC9C,SAAO,EAAE,MAAM,qBAAO,WAAW,GAAG,QAAQ,kCAAS;AACvD;;;ACRO,IAAM,eAA6B;;;ACA1C,2BAA+C;AAIxC,IAAM,oBAAoB,GAAG,YAAY;AAwDzC,IAAM,oBAAgB,4CAAmC,iBAAiB;;;AC7DjF,IAAAA,wBAA0D;AAKnD,IAAM,gBAA+B;AAkBrC,IAAM,gBAAY,6CAA+B,aAAa;;;ACnB9D,IAAM,iBAAiC;","names":["import_payload_model"]}

package/dist/node/index.d.cts

@@ -1,4 +1,5 @@
 export * from './Currency';
+export * from './Escrow';
 export * from './Payment';
 export * from './Purchase';
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}

package/dist/node/index.d.mts

@@ -1,4 +1,5 @@
 export * from './Currency';
+export * from './Escrow';
 export * from './Payment';
 export * from './Purchase';
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}

package/dist/node/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Currency';
+export * from './Escrow';
 export * from './Payment';
 export * from './Purchase';
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}

package/dist/node/index.js

@@ -1,13 +1,40 @@
-// src/Payment.ts
+// src/Escrow/createEscrowIntent.ts
+import { BoundWitnessBuilder } from "@xyo-network/boundwitness-builder";
+var createEscrowIntent = async (terms, account) => {
+  const result = await new BoundWitnessBuilder({ accounts: [account] }).payloads([...terms]).build();
+  return result;
+};
+
+// src/Escrow/getEscrowSecret.ts
+import { Crypto } from "@xylabs/crypto";
+import { IdSchema } from "@xyo-network/id-payload-plugin";
+var getEscrowSecret = () => {
+  return { salt: Crypto.randomUUID(), schema: IdSchema };
+};
+
+// src/Escrow/Schema.ts
+var EscrowSchema = "network.xyo.escrow";
+
+// src/Escrow/Terms.ts
 import { isPayloadOfSchemaType } from "@xyo-network/payload-model";
+var EscrowTermsSchema = `${EscrowSchema}.terms`;
+var isEscrowTerms = isPayloadOfSchemaType(EscrowTermsSchema);
+
+// src/Payment.ts
+import { isPayloadOfSchemaType as isPayloadOfSchemaType2 } from "@xyo-network/payload-model";
 var PaymentSchema = "network.xyo.payments.payment";
-var isPayment = isPayloadOfSchemaType(PaymentSchema);
+var isPayment = isPayloadOfSchemaType2(PaymentSchema);
 
 // src/Purchase.ts
 var PurchaseSchema = "network.xyo.payments.purchase";
 export {
+  EscrowSchema,
+  EscrowTermsSchema,
   PaymentSchema,
   PurchaseSchema,
+  createEscrowIntent,
+  getEscrowSecret,
+  isEscrowTerms,
   isPayment
 };
 //# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Payment.ts","../../src/Purchase.ts"],"sourcesContent":["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":";AAAA,SAAS,6BAAiD;AAKnD,IAAM,gBAA+B;AAkBrC,IAAM,YAAY,sBAA+B,aAAa;;;ACnB9D,IAAM,iBAAiC;","names":[]}
+{"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'\n\nimport { EscrowTerms } from './Terms'\n\n/**\n * Creates an escrow intent\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","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;AAU7B,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;;;ACdA,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"]}

package/package.json

@@ -57,6 +57,6 @@
     "url": "https://github.com/XYOracleNetwork/plugins.git"
   },
   "sideEffects": false,
-  "version": "2.89.1",
+  "version": "2.89.2",
   "type": "module"
 }

package/src/Escrow/Schema.ts

@@ -0,0 +1,2 @@
+export type EscrowSchema = 'network.xyo.escrow'
+export const EscrowSchema: EscrowSchema = 'network.xyo.escrow'

package/src/Escrow/Terms.ts

@@ -0,0 +1,62 @@
+import { Address, Hash } from '@xylabs/hex'
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+import { EscrowSchema } from './Schema'
+
+export const EscrowTermsSchema = `${EscrowSchema}.terms` as const
+export type EscrowTermsSchema = typeof EscrowTermsSchema
+
+// TODO: Include escrow agent in escrow terms
+export interface EscrowTermsFields {
+  /**
+   * The trusted estimators for the worth of the things being sold
+   */
+  appraisalAuthorities: Address[]
+  /**
+   * The estimated worths of the things being sold
+   */
+  appraisals: Hash[]
+  /**
+   * The things being sold
+   */
+  assets: Hash[]
+  /**
+   * The buyer
+   */
+  buyer: Address[]
+  /**
+   * The buyer
+   */
+  buyerSecret: Hash
+  /**
+   * The escrow agent responsible for the escrow
+   */
+  escrowAgent: Address
+  /**
+   * The time the escrow expires
+   */
+  exp: number
+  /**
+   * The time the escrow starts
+   */
+  nbf: number
+  /**
+   * The trusted payment authorities
+   */
+  paymentAuthorities: Address[]
+  /**
+   * The seller
+   */
+  seller: Address[]
+  /**
+   * The seller
+   */
+  sellerSecret: Hash
+}
+
+/**
+ * The terms of an escrow
+ */
+export type EscrowTerms = Payload<Partial<EscrowTermsFields>, EscrowTermsSchema>
+
+export const isEscrowTerms = isPayloadOfSchemaType<EscrowTerms>(EscrowTermsSchema)

package/src/Escrow/createEscrowIntent.ts

@@ -0,0 +1,15 @@
+import { AccountInstance } from '@xyo-network/account-model'
+import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
+
+import { EscrowTerms } from './Terms'
+
+/**
+ * Creates an escrow intent
+ * @param terms The payloads describing the terms for the escrow
+ * @param account The account to create the escrow intent with
+ * @returns The escrow intent
+ */
+export const createEscrowIntent = async (terms: EscrowTerms[], account: AccountInstance) => {
+  const result = await new BoundWitnessBuilder({ accounts: [account] }).payloads([...terms]).build()
+  return result
+}

package/src/Escrow/getEscrowSecret.ts

@@ -0,0 +1,10 @@
+import { Crypto } from '@xylabs/crypto'
+import { IdPayload, IdSchema } from '@xyo-network/id-payload-plugin'
+
+/**
+ * Returns a cryptographically random secret to use for escrow
+ * @returns The escrow secret
+ */
+export const getEscrowSecret = (): IdPayload => {
+  return { salt: Crypto.randomUUID(), schema: IdSchema }
+}

package/src/Escrow/index.ts

@@ -0,0 +1,4 @@
+export * from './createEscrowIntent'
+export * from './getEscrowSecret'
+export * from './Schema'
+export * from './Terms'

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './Currency'
+export * from './Escrow'
 export * from './Payment'
 export * from './Purchase'