@bsv/overlay 0.4.0 → 0.4.2

package/src/storage/knex/KnexStorage.ts

@@ -34,7 +34,8 @@ export class KnexStorage implements Storage {
       'outputs.satoshis',
       'outputs.outputsConsumed',
       'outputs.spent',
-      'outputs.consumedBy'
+      'outputs.consumedBy',
+      'outputs.score'
     ]
 
     if (includeBEEF) {
@@ -72,7 +73,8 @@ export class KnexStorage implements Storage {
       'outputs.satoshis',
       'outputs.outputsConsumed',
       'outputs.spent',
-      'outputs.consumedBy'
+      'outputs.consumedBy',
+      'outputs.score'
     ]
 
     if (includeBEEF) {
@@ -97,16 +99,20 @@ export class KnexStorage implements Storage {
     }))
   }
 
-  async findUTXOsForTopic (topic: string, since?: number, includeBEEF: boolean = false): Promise<Output[]> {
+  async findUTXOsForTopic (topic: string, since?: number, limit?: number, includeBEEF: boolean = false): Promise<Output[]> {
     // Base query to get outputs
     const query = this.knex('outputs').where({ 'outputs.topic': topic, 'outputs.spent': false })
 
-    // If provided, additionally filters UTXOs by block height
+    // If provided, additionally filters UTXOs by score
     if (since !== undefined && since > 0) {
       // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      query.andWhere('outputs.blockHeight', '>=', since)
+      query.andWhere('outputs.score', '>=', since)
     }
 
+    // Sort by score
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    query.orderBy('outputs.score', 'asc')
+
     // Select necessary fields from outputs and conditionally include beef from transactions
     const selectFields = [
       'outputs.txid',
@@ -116,7 +122,8 @@ export class KnexStorage implements Storage {
       'outputs.satoshis',
       'outputs.outputsConsumed',
       'outputs.spent',
-      'outputs.consumedBy'
+      'outputs.consumedBy',
+      'outputs.score'
     ]
 
     if (includeBEEF) {
@@ -125,6 +132,12 @@ export class KnexStorage implements Storage {
       selectFields.push('transactions.beef')
     }
 
+    // Apply limit if specified
+    if (limit !== undefined && limit > 0) {
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
+      query.limit(limit)
+    }
+
     const outputs = await query.select(selectFields)
 
     if (outputs === undefined || outputs.length === 0) {
@@ -165,7 +178,8 @@ export class KnexStorage implements Storage {
       satoshis: Number(output.satoshis),
       outputsConsumed: JSON.stringify(output.outputsConsumed),
       consumedBy: JSON.stringify(output.consumedBy),
-      spent: output.spent
+      spent: output.spent,
+      score: output.score
     })]
 
     if (output.beef !== undefined) {
@@ -226,4 +240,20 @@ export class KnexStorage implements Storage {
 
     return !!result
   }
+
+  async updateLastInteraction (host: string, topic: string, since: number): Promise<void> {
+    await this.knex('host_sync_state')
+      .insert({ host, topic, since })
+      .onConflict(['host', 'topic'])
+      .merge({ since })
+  }
+
+  async getLastInteraction (host: string, topic: string): Promise<number> {
+    const result = await this.knex('host_sync_state')
+      .where({ host, topic })
+      .select('since')
+      .first()
+
+    return result ? result.since : 0
+  }
 }

package/src/storage/knex/migrations/2025-06-25-001-gasp-pagination-support.ts

@@ -0,0 +1,46 @@
+import type { Knex } from 'knex'
+
+export async function up (knex: Knex): Promise<void> {
+  // 1. Add score column to outputs table for pagination/sorting
+  const hasScoreColumn = await knex.schema.hasColumn('outputs', 'score')
+  
+  if (!hasScoreColumn) {
+    // Add new column for score (can be timestamp or any other sorting factor)
+    await knex.schema.table('outputs', table => {
+      table.float('score').notNullable().defaultTo(0)
+      // Create compound index on topic and score for efficient querying
+      table.index(['topic', 'score'])
+    })
+  }
+
+  // 2. Create host_sync_state table for tracking sync progress per host/topic
+  const hostSyncStateExists = await knex.schema.hasTable('host_sync_state')
+  
+  if (!hostSyncStateExists) {
+    await knex.schema.createTable('host_sync_state', table => {
+      table.string('host').notNullable()
+      table.string('topic').notNullable()
+      table.bigInteger('since').unsigned().notNullable()
+      table.primary(['host', 'topic'])
+      table.index('host')
+      table.index('topic')
+    })
+  }
+}
+
+export async function down (knex: Knex): Promise<void> {
+  // Rollback in reverse order
+  
+  // 1. Drop host_sync_state table
+  await knex.schema.dropTableIfExists('host_sync_state')
+  
+  // 2. Remove score column from outputs table
+  const hasScoreColumn = await knex.schema.hasColumn('outputs', 'score')
+  if (hasScoreColumn) {
+    await knex.schema.table('outputs', table => {
+      // Drop the compound index on topic and score
+      table.dropIndex(['topic', 'score'])
+      table.dropColumn('score')
+    })
+  }
+}

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"}