@bsv/overlay 0.3.1 → 0.4.1

package/src/LookupFormula.ts

@@ -23,4 +23,9 @@ export type LookupFormula = Array<{
    * If not provided, no historical information will be included with the Lookup Answer, except that which may incidentally be required to fully anchor the Lookup Answer to the blockchain.
    */
   history?: ((beef: number[], outputIndex: number, currentDepth: number) => Promise<boolean>) | number
+
+  /**
+   * Context for the UTXO, derived from the off-chain values.
+   */
+  context?: number[]
 }>

package/src/LookupService.ts

@@ -18,12 +18,14 @@ export type OutputAdmittedByTopic =
     topic: string // topic into which it was admitted
     satoshis: number // value of the output
     lockingScript: Script // script in this output
+    offChainValues?: number[] // off-chain values associated with the output
   }
   | { // «whole-tx» mode
     mode: 'whole-tx'
     atomicBEEF: number[] // whole transaction (Atomic BEEF)
     outputIndex: number
     topic: string
+    offChainValues?: number[]
   }
 
 /* ---------------------------------------------------------------------------
@@ -52,6 +54,7 @@ export type OutputSpent =
     inputIndex: number
     unlockingScript: Script
     sequenceNumber: number
+    offChainValues?: number[]
   }
   | { // «whole-tx»  – full spending TX
     mode: 'whole-tx'
@@ -59,6 +62,7 @@ export type OutputSpent =
     outputIndex: number
     topic: string
     spendingAtomicBEEF: number[]
+    offChainValues?: number[]
   }
 
 /* ---------------------------------------------------------------------------
@@ -121,7 +125,7 @@ export interface LookupService {
   /* -------------------------------------------------------------------------
    *  Query API
    * ----------------------------------------------------------------------- */
-  lookup: (question: LookupQuestion) => Promise<LookupAnswer | LookupFormula>
+  lookup: (question: LookupQuestion) => Promise<LookupFormula>
 
   /* -------------------------------------------------------------------------
    *  Documentation helpers

package/src/TopicManager.ts

@@ -9,13 +9,13 @@ export interface TopicManager {
    * Accepts the transaction in BEEF format and an array of those input indices which spend previously-admitted outputs from the same topic.
    * The transaction's BEEF structure will always contain the transactions associated with previous coins for reference (if any), regardless of whether the current transaction was directly proven.
    */
-  identifyAdmissibleOutputs: (beef: number[], previousCoins: number[]) => Promise<AdmittanceInstructions>
+  identifyAdmissibleOutputs: (beef: number[], previousCoins: number[], offChainValues?: number[]) => Promise<AdmittanceInstructions>
 
   /**
    * Identifies and returns the inputs needed to anchor any topical outputs from this transaction to their associated previous history.
    * @throws - if there are no potentially valid topical outputs in this transaction
    */
-  identifyNeededInputs?: (beef: number[]) => Promise<Array<{ txid: string, outputIndex: number }>>
+  identifyNeededInputs?: (beef: number[], offChainValues?: number[]) => Promise<Array<{ txid: string, outputIndex: number }>>
 
   /**
   * Returns a Markdown-formatted documentation string for the topic manager.

package/src/__tests/Engine.test.ts

@@ -534,7 +534,7 @@ describe('BSV Overlay Services Engine', () => {
           beef: exampleBeef,
           topics: ['Hello']
         })
-        expect(engine.managers.Hello.identifyAdmissibleOutputs).toHaveBeenCalledWith(exampleBeef, [0])
+        expect(engine.managers.Hello.identifyAdmissibleOutputs).toHaveBeenCalledWith(exampleBeef, [0], undefined)
       })
       describe('When previous UTXOs were retained by the topic manager', () => {
         it('Notifies all lookup services about the output being spent (not deleted, see the comment about this in deleteUTXODeep)', async () => {

package/dist/cjs/src/AdmittanceInstructions.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=AdmittanceInstructions.js.map

package/dist/cjs/src/AdmittanceInstructions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AdmittanceInstructions.js","sourceRoot":"","sources":["../../../src/AdmittanceInstructions.ts"],"names":[],"mappings":""}

package/dist/cjs/src/LookupAnswer.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=LookupAnswer.js.map

package/dist/cjs/src/LookupAnswer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LookupAnswer.js","sourceRoot":"","sources":["../../../src/LookupAnswer.ts"],"names":[],"mappings":""}

package/dist/cjs/src/LookupQuestion.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=LookupQuestion.js.map

package/dist/cjs/src/LookupQuestion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LookupQuestion.js","sourceRoot":"","sources":["../../../src/LookupQuestion.ts"],"names":[],"mappings":""}

package/dist/cjs/src/SHIPAdvertisement.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=SHIPAdvertisement.js.map

package/dist/cjs/src/SHIPAdvertisement.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SHIPAdvertisement.js","sourceRoot":"","sources":["../../../src/SHIPAdvertisement.ts"],"names":[],"mappings":""}

package/dist/cjs/src/SLAPAdvertisement.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=SLAPAdvertisement.js.map

package/dist/cjs/src/SLAPAdvertisement.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SLAPAdvertisement.js","sourceRoot":"","sources":["../../../src/SLAPAdvertisement.ts"],"names":[],"mappings":""}

package/dist/cjs/src/STEAK.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=STEAK.js.map

package/dist/cjs/src/STEAK.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"STEAK.js","sourceRoot":"","sources":["../../../src/STEAK.ts"],"names":[],"mappings":""}

package/dist/cjs/src/TaggedBEEF.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=TaggedBEEF.js.map

package/dist/cjs/src/TaggedBEEF.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TaggedBEEF.js","sourceRoot":"","sources":["../../../src/TaggedBEEF.ts"],"names":[],"mappings":""}

package/dist/esm/src/AdmittanceInstructions.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=AdmittanceInstructions.js.map

package/dist/esm/src/AdmittanceInstructions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AdmittanceInstructions.js","sourceRoot":"","sources":["../../../src/AdmittanceInstructions.ts"],"names":[],"mappings":""}

package/dist/esm/src/LookupAnswer.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=LookupAnswer.js.map

package/dist/esm/src/LookupAnswer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LookupAnswer.js","sourceRoot":"","sources":["../../../src/LookupAnswer.ts"],"names":[],"mappings":""}

package/dist/esm/src/LookupQuestion.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=LookupQuestion.js.map

package/dist/esm/src/LookupQuestion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LookupQuestion.js","sourceRoot":"","sources":["../../../src/LookupQuestion.ts"],"names":[],"mappings":""}

package/dist/esm/src/SHIPAdvertisement.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=SHIPAdvertisement.js.map

package/dist/esm/src/SHIPAdvertisement.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SHIPAdvertisement.js","sourceRoot":"","sources":["../../../src/SHIPAdvertisement.ts"],"names":[],"mappings":""}

package/dist/esm/src/SLAPAdvertisement.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=SLAPAdvertisement.js.map

package/dist/esm/src/SLAPAdvertisement.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SLAPAdvertisement.js","sourceRoot":"","sources":["../../../src/SLAPAdvertisement.ts"],"names":[],"mappings":""}

package/dist/esm/src/STEAK.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=STEAK.js.map

package/dist/esm/src/STEAK.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"STEAK.js","sourceRoot":"","sources":["../../../src/STEAK.ts"],"names":[],"mappings":""}

package/dist/esm/src/TaggedBEEF.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=TaggedBEEF.js.map

package/dist/esm/src/TaggedBEEF.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TaggedBEEF.js","sourceRoot":"","sources":["../../../src/TaggedBEEF.ts"],"names":[],"mappings":""}

package/dist/types/src/AdmittanceInstructions.d.ts

@@ -1,14 +0,0 @@
-/**
- * Instructs the Overlay Services Engine about which outputs to admit and which previous outputs to retain. Returned by a Topic Manager.
- */
-export type AdmittanceInstructions = {
-    /**
-     * The indices of all admissable outputs into the managed topic from the provided transaction.
-     */
-    outputsToAdmit: number[];
-    /**
-     * The indices of all inputs from the provided transaction which spend previously-admitted outputs that should be retained for historical record-keeping.
-     */
-    coinsToRetain: number[];
-};
-//# sourceMappingURL=AdmittanceInstructions.d.ts.map

package/dist/types/src/AdmittanceInstructions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AdmittanceInstructions.d.ts","sourceRoot":"","sources":["../../../src/AdmittanceInstructions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,EAAE,CAAA;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA"}

package/dist/types/src/LookupAnswer.d.ts

@@ -1,15 +0,0 @@
-/**
- * How the Overlay Services Engine responds to a Lookup Question.
- * It may comprise either an output list or a freeform response from the Lookup Service.
- */
-export type LookupAnswer = {
-    type: 'output-list';
-    outputs: Array<{
-        beef: number[];
-        outputIndex: number;
-    }>;
-} | {
-    type: 'freeform';
-    result: unknown;
-};
-//# sourceMappingURL=LookupAnswer.d.ts.map

package/dist/types/src/LookupAnswer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LookupAnswer.d.ts","sourceRoot":"","sources":["../../../src/LookupAnswer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,aAAa,CAAA;IACnB,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,EAAE,CAAA;QACd,WAAW,EAAE,MAAM,CAAA;KACpB,CAAC,CAAA;CACH,GAAG;IACF,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA"}

package/dist/types/src/LookupQuestion.d.ts

@@ -1,15 +0,0 @@
-/**
- * The question asked to the Overlay Services Engine when a consumer of state wishes to look up information.
- */
-export type LookupQuestion = {
-    /**
-     * The identifier for a Lookup Service which the person asking the question wishes to use.
-     */
-    service: string;
-    /**
-     * The query which will be forwarded to the Lookup Service.
-     * Its type depends on that prescribed by the Lookup Service employed.
-     */
-    query: unknown;
-};
-//# sourceMappingURL=LookupQuestion.d.ts.map

package/dist/types/src/LookupQuestion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LookupQuestion.d.ts","sourceRoot":"","sources":["../../../src/LookupQuestion.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAA;CACf,CAAA"}

package/dist/types/src/SHIPAdvertisement.d.ts

@@ -1,9 +0,0 @@
-export interface SHIPAdvertisement {
-    protocol: 'SHIP';
-    identityKey: string;
-    domain: string;
-    topic: string;
-    beef?: number[];
-    outputIndex?: number;
-}
-//# sourceMappingURL=SHIPAdvertisement.d.ts.map

package/dist/types/src/SHIPAdvertisement.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SHIPAdvertisement.d.ts","sourceRoot":"","sources":["../../../src/SHIPAdvertisement.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}

package/dist/types/src/SLAPAdvertisement.d.ts

@@ -1,9 +0,0 @@
-export interface SLAPAdvertisement {
-    protocol: 'SLAP';
-    identityKey: string;
-    domain: string;
-    service: string;
-    beef?: number[];
-    outputIndex?: number;
-}
-//# sourceMappingURL=SLAPAdvertisement.d.ts.map

package/dist/types/src/SLAPAdvertisement.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SLAPAdvertisement.d.ts","sourceRoot":"","sources":["../../../src/SLAPAdvertisement.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}

package/dist/types/src/STEAK.d.ts

@@ -1,10 +0,0 @@
-import { AdmittanceInstructions } from './AdmittanceInstructions.js';
-/**
- * Submitted Transaction Execution AcKnowledgment
- *
- * @description
- * Comprises the topics where a transaction was submitted, and for each one, the output indices for the UTXOs newly admitted into the topics, and the coins retained.
- * An object whose keys are topic names and whose values are topical admittance instructions denoting the state of the submitted transaction with respect to the associated topic.
- */
-export type STEAK = Record<string, AdmittanceInstructions>;
-//# sourceMappingURL=STEAK.d.ts.map

package/dist/types/src/STEAK.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"STEAK.d.ts","sourceRoot":"","sources":["../../../src/STEAK.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AAEpE;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA"}

package/dist/types/src/TaggedBEEF.d.ts

@@ -1,11 +0,0 @@
-/**
- * Tagged BEEF
- *
- * @description
- * Tagged BEEF ([Background Evaluation Extended Format](https://brc.dev/62)) structure. Comprises a transaction, its SPV information, and the overlay topics where its inclusion is requested.
- */
-export type TaggedBEEF = {
-    beef: number[];
-    topics: string[];
-};
-//# sourceMappingURL=TaggedBEEF.d.ts.map

package/dist/types/src/TaggedBEEF.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TaggedBEEF.d.ts","sourceRoot":"","sources":["../../../src/TaggedBEEF.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA"}