@bsv/overlay 2.2.1 → 2.3.0

package/LICENSE.txt

@@ -1,28 +1,58 @@
-Open BSV License version 4
-
-Copyright (c) 2023 BSV Blockchain Association ("Bitcoin Association")
- 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
- 
-1 - The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-2 - The Software, and any software that is derived from the Software or parts thereof,
-can only be used on the Bitcoin SV blockchains. The Bitcoin SV blockchains are defined,
-for purposes of this license, as the Bitcoin blockchain containing block height #556767
-with the hash "000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
-that contains the longest persistent chain of blocks accepted by this Software and which are valid under the rules set forth in the Bitcoin white paper (S. Nakamoto, Bitcoin: A Peer-to-Peer Electronic Cash System, posted online October 2008) and the latest version of this Software available in this repository or another repository designated by Bitcoin Association,
-as well as the test blockchains that contain the longest persistent chains of blocks accepted by this Software and which are valid under the rules set forth in the Bitcoin whitepaper (S. Nakamoto, Bitcoin: A Peer-to-Peer Electronic Cash System, posted online October 2008) and the latest version of this Software available in this repository, or another repository designated by Bitcoin Association
- 
+Open BSV License Version 6 – granted by BSV Association, Alpenstrasse 15, 6300
+Zug, Switzerland (CHE-427.008.338) ("Licensor"), to you as a user (henceforth
+"You", "User" or "Licensee").
+
+For the purposes of this license, the definitions below have the following
+meanings:
+
+"Bitcoin Protocol" means the protocol implementation, cryptographic rules,
+network protocols, and consensus mechanisms in the Bitcoin White Paper as
+described here https://protocol.bsvblockchain.org.
+
+"Bitcoin White Paper" means the paper entitled 'Bitcoin: A Peer-to-Peer
+Electronic Cash System' published by 'Satoshi Nakamoto' in October 2008.
+
+"BSV Blockchain" means:
+
+  (a) the Bitcoin blockchain containing block height #556767 with the hash
+      "000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
+      that contains the longest honest persistent chain of blocks which has been
+      produced in a manner which is consistent with the rules set forth in the
+      Network Access Rules; and
+  (b) the test blockchains that contain the longest honest persistent chains of
+      blocks which has been produced in a manner which is consistent with the
+      rules set forth in the Network Access Rules.
+
+"Network Access Rules" or "Rules" means the set of rules regulating the
+relationship between BSV Association and the nodes on BSV based on the Bitcoin
+Protocol rules and those set out in the Bitcoin White Paper, and available here
+https://bsvblockchain.org/network-access-rules.
+
+"Software" means the software the subject of this license, including any/all
+intellectual property rights therein and associated documentation files.
+
+BSV Association grants permission, free of charge and on a non-exclusive basis
+to any person obtaining a copy of the Software to deal in the Software, including
+without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to and conditioned upon the following
+conditions:
+
+1 - The text "© BSV Association", and this license shall be included in all
+copies or substantial portions of the Software.
+
+2 - The Software, and any software that is derived from the Software or parts
+thereof, may only be used exclusively on the BSV Blockchain.
+
+For the avoidance of doubt, this license is granted subject to and conditioned
+upon your compliance with these terms only and is limited to uses on the BSV
+Blockchain. Any exercise of rights not compliant with these terms including
+use not for the BSV Blockchain is deemed outside the scope of the license.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES REGARDING ENTITLEMENT,
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS THEREOF BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,308 +1,141 @@
-# BSV Overlay Services Engine
+# @bsv/overlay
 
-BSV BLOCKCHAIN | Overlay Services Engine
+The core engine and storage contracts for BSV Overlay Services. The engine admits
+transactions through topic managers, maintains UTXO state, serves lookup
+services, and supports SHIP, SLAP, GASP, and BASM synchronization.
 
-The Overlay Services Engine enables dynamic tracking and management of UTXO-based systems that work on top of the BSV blockchain.
+Use [`@bsv/overlay-express`](../overlay-express/README.md) when you want the
+standard HTTP server, operational endpoints, edge policy, and health checks.
+Use this package directly when you are embedding the engine in another runtime
+or implementing a custom transport.
 
-## Table of Contents
+## Requirements
 
-1. [Objective](#objective)
-2. [Getting Started](#getting-started)
-3. [Features & Deliverables](#features--deliverables)
-4. [Documentation](#documentation)
-5. [Contribution Guidelines](#contribution-guidelines)
-6. [Support & Contacts](#support--contacts)
+- Node.js 22 or newer
+- `@bsv/sdk` installed as a peer dependency
+- A `Storage` implementation
+- A `ChainTracker`, or the explicit `'scripts only'` validation mode
 
-## Objective
+## Install
 
-- Enable a general-purpose system for tracking UTXOs
-- Let each service decide what UTXOs get into the system
-- Provide an efficient global storage engine for UTXO data
-- Let each lookup service dynamically respond to different types of queries
-- Let each lookup service have its own, specialized storage engine for its unique needs
-
-## Getting Started
-
-### Installation
+```bash
+npm install @bsv/overlay @bsv/sdk
+```
 
-You'll usually want to wrap the Engine within an HTTP server. To get set up with Express, create a new project and install everything you'll need:
+## Create an engine
 
-```
-npm i express body-parser @bsv/sdk @bsv/overlay hello-services knex
-```
+```ts
+import { Engine, KnexStorage } from '@bsv/overlay'
+import type { LookupService, TopicManager } from '@bsv/overlay'
+import knex from 'knex'
 
-### Basic Usage
+const database = knex({
+  client: 'pg',
+  connection: process.env.DATABASE_URL
+})
 
-In your server's main file, you can set everything up. Create a new Engine to run the overlay services you want, then expose some routes over HTTP. For example:
+const topicManagers: Record<string, TopicManager> = {
+  tm_example: exampleTopicManager
+}
 
-```js
-const express = require('express')
-const bodyparser = require('body-parser')
-const { Engine, KnexStorage, HelloTopicManager, HelloLookupService, HelloStorageEngine } = require('@bsv/overlay')
-import { WhatsOnChain, NodejsHttpClient, ARC, ArcConfig, MerklePath } from '@bsv/sdk'
-// Populate a Knexfile with your database credentials
-const knex = require('knex')(require('../knexfile.js'))
-const app = express()
-app.use(bodyparser.json({ limit: '1gb', type: 'application/json' }))
+const lookupServices: Record<string, LookupService> = {
+  ls_example: exampleLookupService
+}
 
 const engine = new Engine(
-    {
-      hello: new HelloTopicManager(),
-    },
-    {
-      hello: new HelloLookupService({
-        storageEngine: new HelloStorageEngine({
-          knex
-        })
-      }),
-    },
-    new KnexStorageEngine({
-      knex
-    }),
-    new CombinatorialChainTracker([
-      new WhatsOnChain(
-        NODE_ENV === 'production' ? 'main' : 'test',
-        {
-          httpClient: new NodejsHttpClient(https)
-        })
-    ]),
-    HOSTING_DOMAIN as string,
-    SHIP_TRACKERS,
-    SLAP_TRACKERS,
-    new ARC('https://arc.taal.com', arcConfig)
-  )
-
-// This allows the API to be used everywhere when CORS is enforced
-app.use((req, res, next) => {
-  res.header('Access-Control-Allow-Origin', '*')
-  res.header('Access-Control-Allow-Headers', '*')
-  res.header('Access-Control-Allow-Methods', '*')
-  res.header('Access-Control-Expose-Headers', '*')
-  res.header('Access-Control-Allow-Private-Network', 'true')
-  if (req.method === 'OPTIONS') {
-    res.sendStatus(200)
-  } else {
-    next()
-  }
-})
-
-// Serve a static documentstion site, if you have one.
-app.use(express.static('public'))
-
-// List hosted topic managers and lookup services
-app.get(`/listTopicManagers`, async (req, res) => {
-  try {
-    const result = await engine.listTopicManagers()
-    return res.status(200).json(result)
-  } catch (error) {
-    return res.status(400).json({
-      status: 'error',
-      code: error.code,
-      description: error.message
-    })
-  }
-})
-app.get(`/listLookupServiceProviders`, async (req, res) => {
-  try {
-    const result = await engine.listLookupServiceProviders()
-    return res.status(200).json(result)
-  } catch (error) {
-    return res.status(400).json({
-      status: 'error',
-      code: error.code,
-      description: error.message
-    })
-  }
+  topicManagers,
+  lookupServices,
+  new KnexStorage(database),
+  chainTracker,
+  'https://overlay.example'
+)
+
+await engine.submit({
+  beef: transaction.toBEEF(),
+  topics: ['tm_example']
 })
 
-// Host documentation for the services
-app.get(`/getDocumentationForTopicManager`, async (req, res) => {
-  try {
-    const result = await engine.getDocumentationForTopicManger(req.query.manager)
-    return res.status(200).json(result)
-  } catch (error) {
-    return res.status(400).json({
-      status: 'error',
-      code: error.code,
-      description: error.message
-    })
-  }
-})
-app.get(`/getDocumentationForLookupServiceProvider`, async (req, res) => {
-  try {
-    const result = await engine.getDocumentationForLookupServiceProvider(req.query.lookupServices)
-    return res.status(200).json(result)
-  } catch (error) {
-    return res.status(400).json({
-      status: 'error',
-      code: error.code,
-      description: error.message
-    })
-  }
+const answer = await engine.lookup({
+  service: 'ls_example',
+  query: { txid }
 })
+```
 
-// Submit transactions and facilitate lookup requests
-app.post(`/submit`, async (req, res) => {
-  try {
-    // Parse out the topics and construct the tagged BEEF
-    const topicsHeader = req.headers['x-topics'] as string
-    const topics = topicsHeader.trim().startsWith('[')
-      ? JSON.parse(topicsHeader)
-      : topicsHeader.split(',').map(topic => topic.trim())
-    const taggedBEEF: TaggedBEEF = {
-      beef: Array.from(req.body as number[]),
-      topics
-    }
-
-    // Using a callback function, we can just return once our steak is ready
-    // instead of having to wait for all the broadcasts to occur.
-    await engine.submit(taggedBEEF, (steak: STEAK) => {
-      return res.status(200).json(steak)
-    })
-  } catch (error) {
-    return res.status(400).json({
-      status: 'error',
-      code: error.code,
-      description: error.message
-    })
-  }
-})
-app.post(`/lookup`, async (req, res) => {
-  try {
-    const result = await engine.lookup(req.body)
-    return res.status(200).json(result)
-  } catch (error) {
-    return res.status(400).json({
-      status: 'error',
-      code: error.code,
-      description: error.message
-    })
-  }
-})
+The constructor also accepts SHIP/SLAP trackers, broadcasters, an advertiser,
+sync configuration, a logger, a topic-anchor header resolver, and BASM/unproven
+state controls. Type declarations document the complete configuration surface.
 
-app.post('/arc-ingest', (req, res) => {
-  (async () => {
-    try {
-      const merklePath = MerklePath.fromHex(req.body.merklePath)
-      await engine.handleNewMerkleProof(req.body.txid, merklePath, req.body.blockHeight)
-      return res.status(200).json({ status: 'success', message: 'transaction status updated' })
-    } catch (error) {
-      console.error(error)
-      return res.status(400).json({
-        status: 'error',
-        message: error instanceof Error ? error.message : 'An unknown error occurred'
-      })
-    }
-  })().catch(() => {
-    res.status(500).json({
-      status: 'error',
-      message: 'Unexpected error'
-    })
-  })
-})
+## Public API
 
-app.post('/requestSyncResponse', (req, res) => {
-  (async () => {
-    try {
-      const topic = req.headers['x-bsv-topic'] as string
-      const response = await engine.provideForeignSyncResponse(req.body, topic)
-      return res.status(200).json(response)
-    } catch (error) {
-      console.error(error)
-      return res.status(400).json({
-        status: 'error',
-        message: error instanceof Error ? error.message : 'An unknown error occurred'
-      })
-    }
-  })().catch(() => {
-    res.status(500).json({
-      status: 'error',
-      message: 'Unexpected error'
-    })
-  })
-})
+The root entry point exports:
 
-app.post('/requestForeignGASPNode', (req, res) => {
-  (async () => {
-    try {
-      console.log(req.body)
-      const { graphID, txid, outputIndex, metadata } = req.body
-      const response = await engine.provideForeignGASPNode(graphID, txid, outputIndex)
-      return res.status(200).json(response)
-    } catch (error) {
-      console.error(error)
-      return res.status(400).json({
-        status: 'error',
-        message: error instanceof Error ? error.message : 'An unknown error occurred'
-      })
-    }
-  })().catch(() => {
-    res.status(500).json({
-      status: 'error',
-      message: 'Unexpected error'
-    })
-  })
-})
+- `Engine`
+- `KnexStorage` and `KnexStorageMigrations`
+- the topic-manager, lookup-service, storage, advertisement, and sync contracts
+- BASM utilities and types
+- safe structured-log serializers
 
-// 404, all other routes are not found.
-app.use((req, res) => {
-  console.log('404', req.url)
-  res.status(404).json({
-    status: 'error',
-    code: 'ERR_ROUTE_NOT_FOUND',
-    description: 'Route not found.'
-  })
-})
+`@bsv/overlay/storage` exports the `Storage` contract. Existing supported deep
+imports remain available through the documented package export map, but new
+applications should prefer the root entry point wherever possible.
 
-// Start your Engines!
-  app.listen(8080, () => {
-    console.log('BSV Overlay Services Engine is listening on port', 8080)
-  })
-```
+## Runtime and package formats
 
-For more detailed tutorials and examples, check out the [full documentation](#documentation).
+The package supports both module systems:
 
-The Overlay Services Engine is also richly documented with code-level annotations. This should show up well within editors like VSCode. 
+```ts
+import { Engine } from '@bsv/overlay'
+```
 
-<!-- ## Documentation
+```js
+const { Engine } = require('@bsv/overlay')
+```
 
-[links to conceptsexamples and internals] -->
+ES modules load from `dist/esm`; CommonJS loads from `dist/cjs`. Each condition
+has matching declarations. Published artifacts contain compiled output, the
+README, and the license only—tests, compiler caches, workspace source, and lock
+files are excluded.
 
-## Features & Deliverables
+## Security and operations
 
-- UTXO Tracking
-- History management and state tracking
-- Lookup Services
-- Storage engine abstractions
-- [WIP] Examples, HTTP wrapper and Docs
-- [WIP] Arc Proof Acquisition
-- [WIP] Distributed Overlay Availability Advertisements
-- [WIP] Federated Transaction Synchronization
+The engine is transport-neutral. Authentication, CORS, CSP, body limits,
+timeouts, rate or concurrency controls, and administrative authorization belong
+at the HTTP or application boundary.
 
-## Contribution Guidelines
+Overlay endpoints are commonly public protocol services used by browsers,
+mobile wallets, WUI, and applications on previously unknown origins. A wrapper
+should therefore remain public-by-default unless an operator deliberately
+configures an exact-origin allowlist. CORS is not an authentication mechanism,
+and CSP for a hosted UI should be configured independently.
 
-We're always looking for contributors to help us improve the Engine. Whether it's bug reports, feature requests, or pull requests - all contributions are welcome.
+For production deployments:
 
-1. **Fork & Clone**: Fork this repository and clone it to your local machine.
-2. **Set Up**: Run `npm i` to install all dependencies.
-3. **Make Changes**: Create a new branch and make your changes.
-4. **Test**: Ensure all tests pass by running `npm test`.
-5. **Commit**: Commit your changes and push to your fork.
-6. **Pull Request**: Open a pull request from your fork to this repository.
-For more details, check the [contribution guidelines](./CONTRIBUTING.md).
+- validate all untrusted request data before invoking the engine;
+- use a durable storage implementation and tested database migrations;
+- configure transaction broadcast and proof providers;
+- protect administrative and callback routes with explicit credentials;
+- avoid logging raw secrets, authorization headers, or unbounded payloads;
+- monitor readiness, proof acquisition, synchronization, and unproven state.
 
-For information on past releases, check out the [changelog](./CHANGELOG.md). For future plans, check the [roadmap](./ROADMAP.md)!
+`@bsv/overlay-express` supplies these standard HTTP controls while preserving
+public protocol access by default.
 
-## Support & Contacts
+## Development
 
-Project Owners: Thomas Giacomo, Darren Kellenschwiler, Jake Jones
+From the repository root:
 
-Development Team Lead: Ty Everett
+```bash
+pnpm --filter @bsv/overlay format:check
+pnpm --filter @bsv/overlay lint
+pnpm --filter @bsv/overlay typecheck
+pnpm --filter @bsv/overlay test
+pnpm --filter @bsv/overlay test:coverage
+pnpm --filter @bsv/overlay pack:check
+```
 
-For questions, bug reports, or feature requests, please open an issue on GitHub or contact us directly.
+`pack:check` verifies the actual npm tarball with publint, strict type
+resolution, and clean ESM/CommonJS consumer projects.
 
 ## License
 
-The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
-
-Thank you for being a part of the BSV Blockchain Overlay Services Project. Let's build the future of BSV Blockchain together!
+Open BSV License. See [LICENSE.txt](./LICENSE.txt).

package/dist/cjs/mod.d.ts

@@ -0,0 +1,15 @@
+export { Engine } from './src/Engine.js';
+export { serializeErrorForLog, serializeLogValue } from './src/SafeLog.js';
+export type * from './src/LookupService.js';
+export type { TopicManager } from './src/TopicManager.js';
+export type { Storage, AppliedTransaction } from './src/storage/Storage.js';
+export type { Output } from './src/Output.js';
+export type { TaggedBEEF, STEAK, LookupQuestion, LookupAnswer, AdmittanceInstructions } from '@bsv/sdk';
+export type { LookupFormula } from './src/LookupFormula.js';
+export type { Advertisement } from './src/Advertisement.js';
+export type { AdvertisementData, Advertiser } from './src/Advertiser.js';
+export { BASM_ZERO_HASH, computeBasmRoot, computeTac, extractMerkleProofMetadata } from './src/BASM.js';
+export type { AdmittedListRequest, AdmittedListResponse, AdmittedTxRef, BASMPeerSyncReport, CompoundMerklePathRequest, CompoundMerklePathResponse, MerkleProofMetadata, RawTransactionRecord, RawTransactionRequest, RawTransactionResponse, TopicAnchorHeader, TopicAnchorHeaderResolver, TopicAnchorRangeRequest, TopicAnchorRangeResponse, TopicAnchorTip, TopicBlockAnchor } from './src/BASM.js';
+export { KnexStorage } from './src/storage/knex/KnexStorage.js';
+export * as KnexStorageMigrations from './src/storage/knex/all-migrations.js';
+//# sourceMappingURL=mod.d.ts.map

package/dist/cjs/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAC1E,mBAAmB,wBAAwB,CAAA;AAC3C,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAGzD,YAAY,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAC3E,YAAY,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,YAAY,EACV,UAAU,EACV,KAAK,EACL,cAAc,EACd,YAAY,EACZ,sBAAsB,EACvB,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,YAAY,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACxE,OAAO,EACL,cAAc,EACd,eAAe,EACf,UAAU,EACV,0BAA0B,EAC3B,MAAM,eAAe,CAAA;AACtB,YAAY,EACV,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,kBAAkB,EAClB,yBAAyB,EACzB,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,cAAc,EACd,gBAAgB,EACjB,MAAM,eAAe,CAAA;AAGtB,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAA;AAC/D,OAAO,KAAK,qBAAqB,MAAM,sCAAsC,CAAA"}

package/dist/cjs/mod.js

@@ -33,10 +33,13 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KnexStorageMigrations = exports.KnexStorage = exports.extractMerkleProofMetadata = exports.computeTac = exports.computeBasmRoot = exports.BASM_ZERO_HASH = exports.Engine = void 0;
+exports.KnexStorageMigrations = exports.KnexStorage = exports.extractMerkleProofMetadata = exports.computeTac = exports.computeBasmRoot = exports.BASM_ZERO_HASH = exports.serializeLogValue = exports.serializeErrorForLog = exports.Engine = void 0;
 // Fundamentals
 var Engine_js_1 = require("./src/Engine.js");
 Object.defineProperty(exports, "Engine", { enumerable: true, get: function () { return Engine_js_1.Engine; } });
+var SafeLog_js_1 = require("./src/SafeLog.js");
+Object.defineProperty(exports, "serializeErrorForLog", { enumerable: true, get: function () { return SafeLog_js_1.serializeErrorForLog; } });
+Object.defineProperty(exports, "serializeLogValue", { enumerable: true, get: function () { return SafeLog_js_1.serializeLogValue; } });
 var BASM_js_1 = require("./src/BASM.js");
 Object.defineProperty(exports, "BASM_ZERO_HASH", { enumerable: true, get: function () { return BASM_js_1.BASM_ZERO_HASH; } });
 Object.defineProperty(exports, "computeBasmRoot", { enumerable: true, get: function () { return BASM_js_1.computeBasmRoot; } });

package/dist/cjs/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,eAAe;AACf,6CAAwC;AAA/B,mGAAA,MAAM,OAAA;AAWf,yCAKsB;AAJpB,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,qGAAA,UAAU,OAAA;AACV,qHAAA,0BAA0B,OAAA;AAqB5B,0BAA0B;AAC1B,oEAA+D;AAAtD,6GAAA,WAAW,OAAA;AACpB,8FAA6E"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,eAAe;AACf,6CAAwC;AAA/B,mGAAA,MAAM,OAAA;AACf,+CAA0E;AAAjE,kHAAA,oBAAoB,OAAA;AAAE,+GAAA,iBAAiB,OAAA;AAiBhD,yCAKsB;AAJpB,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,qGAAA,UAAU,OAAA;AACV,qHAAA,0BAA0B,OAAA;AAqB5B,0BAA0B;AAC1B,oEAA+D;AAAtD,6GAAA,WAAW,OAAA;AACpB,QAAY,qBAAqB,iEAA4C"}

package/dist/cjs/package.json

@@ -1,24 +1,34 @@
 {
   "name": "@bsv/overlay",
-  "version": "2.2.1",
+  "version": "2.3.0",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "commonjs",
   "description": "BSV Blockchain Overlay Services Engine",
   "files": [
     "dist",
-    "src",
-    "docs",
-    "mod.ts",
+    "!dist/**/*.tsbuildinfo",
+    "README.md",
     "LICENSE.txt"
   ],
   "scripts": {
-    "test": "npm run build && jest",
-    "test:watch": "npm run build && jest --watch",
-    "test:coverage": "npm run build && jest --coverage",
-    "lint": "oxlint src",
-    "lint:ci": "oxlint src",
+    "test": "pnpm build && jest --runInBand --watchman=false",
+    "test:watch": "pnpm build && jest --watch",
+    "test:coverage": "pnpm build && jest --coverage --runInBand --watchman=false",
+    "test:property": "jest --runInBand --watchman=false --runTestsByPath src/__tests/BASM.property.test.ts",
+    "format:check": "pnpm --workspace-root exec prettier --check \"packages/overlays/overlay/{README.md,jest.config.js,mod.ts,package.json,tsconfig*.json}\"",
+    "lint": "oxlint mod.ts src jest.config.js --deny-warnings",
+    "lint:ci": "pnpm lint",
+    "pack:check": "pnpm build && node ../../../scripts/check-package-artifact.mjs . --exports BASM_ZERO_HASH,Engine,KnexStorage,KnexStorageMigrations,computeBasmRoot,computeTac,extractMerkleProofMetadata,serializeErrorForLog,serializeLogValue --entry-exports \"./storage=;./storage/knex/KnexStorage=KnexStorage\"",
+    "typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false",
     "build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
     "dev": "tsc -b -w",
-    "prepublish": "npm run build",
+    "prepublishOnly": "pnpm build",
     "doc": "ts2md --inputFilename=mod.ts --outputFilename=docs/API.md --filenameSubstring=API --firstHeadingLevel=1"
   },
   "repository": {
@@ -42,13 +52,15 @@
   "devDependencies": {
     "@bsv/sdk": "workspace:^",
     "@types/jest": "^30.0.0",
-    "@types/node": "^26.1.1",
+    "@types/node": "^26.1.2",
+    "@typescript/native": "npm:typescript@7.0.2",
+    "fast-check": "^4.9.0",
     "jest": "^30.4.2",
+    "oxlint": "^1.76.0",
     "ts-jest": "^29.4.12",
     "ts2md": "^0.2.8",
     "tsconfig-to-dual-package": "^1.2.0",
-    "typescript": "^6.0.3",
-    "oxlint": "^1.75.0"
+    "typescript": "npm:@typescript/typescript6@6.0.2"
   },
   "dependencies": {
     "@bsv/gasp": "workspace:^",
@@ -61,5 +73,21 @@
     "@bsv/sdk": {
       "optional": false
     }
+  },
+  "typesVersions": {
+    "*": {
+      "storage": [
+        "dist/types/src/storage/Storage.d.ts"
+      ],
+      "storage/*": [
+        "dist/types/src/storage/*"
+      ],
+      "*.ts": [
+        "dist/types/src/*.d.ts"
+      ],
+      "*": [
+        "dist/types/mod.d.ts"
+      ]
+    }
   }
 }

package/dist/cjs/src/Advertisement.d.ts

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

package/dist/cjs/src/Advertisement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Advertisement.d.ts","sourceRoot":"","sources":["../../../src/Advertisement.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}