@bsv/overlay 0.1.15 → 0.1.17

package/docs/API.md

@@ -1,16 +1,21 @@
 # API
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ## Interfaces
 
 | |
 | --- |
+| [Advertisement](#interface-advertisement) |
+| [AdvertisementData](#interface-advertisementdata) |
+| [Advertiser](#interface-advertiser) |
+| [AppliedTransaction](#interface-appliedtransaction) |
+| [GraphNode](#interface-graphnode) |
 | [LookupService](#interface-lookupservice) |
 | [Storage](#interface-storage) |
 | [TopicManager](#interface-topicmanager) |
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 
@@ -19,10 +24,14 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#typ
 Defines a Topic Manager interface that can be implemented for specific use-cases
 
 ```ts
-export default interface TopicManager {
-    identifyAdmissibleOutputs(beef: number[], previousCoins: number[]): Promise<AdmittanceInstructions>;
-    getDocumentation(): Promise<string>;
-    getMetaData(): Promise<{
+export interface TopicManager {
+    identifyAdmissibleOutputs: (beef: number[], previousCoins: number[]) => Promise<AdmittanceInstructions>;
+    identifyNeededInputs?: (beef: number[]) => Promise<Array<{
+        txid: string;
+        outputIndex: number;
+    }>>;
+    getDocumentation: () => Promise<string>;
+    getMetaData: () => Promise<{
         name: string;
         shortDescription: string;
         iconURL?: string;
@@ -36,20 +45,20 @@ export default interface TopicManager {
 
 <summary>Interface TopicManager Details</summary>
 
-#### Method getDocumentation
+#### Property getDocumentation
 
 Returns a Markdown-formatted documentation string for the topic manager.
 
 ```ts
-getDocumentation(): Promise<string>
+getDocumentation: () => Promise<string>
 ```
 
-#### Method getMetaData
+#### Property getMetaData
 
 Returns a metadata object that can be used to identify the topic manager.
 
 ```ts
-getMetaData(): Promise<{
+getMetaData: () => Promise<{
     name: string;
     shortDescription: string;
     iconURL?: string;
@@ -58,19 +67,30 @@ getMetaData(): Promise<{
 }>
 ```
 
-#### Method identifyAdmissibleOutputs
+#### Property identifyAdmissibleOutputs
 
 Returns instructions that denote which outputs from the provided transaction to admit into the topic, and which previous coins should be retained.
-Accepts the transaction in BEEF format and an array of those input indicies which spend previously-admitted outputs from the same topic.
+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.
 
 ```ts
-identifyAdmissibleOutputs(beef: number[], previousCoins: number[]): Promise<AdmittanceInstructions>
+identifyAdmissibleOutputs: (beef: number[], previousCoins: number[]) => Promise<AdmittanceInstructions>
+```
+
+#### Property identifyNeededInputs
+
+Identifies and returns the inputs needed to anchor any topical outputs from this transaction to their associated previous history.
+
+```ts
+identifyNeededInputs?: (beef: number[]) => Promise<Array<{
+    txid: string;
+    outputIndex: number;
+}>>
 ```
 
 </details>
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 ### Interface: LookupService
@@ -78,13 +98,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#typ
 Defines a Lookup Service interface to be implemented for specific use-cases
 
 ```ts
-export default interface LookupService {
-    outputAdded?(txid: string, outputIndex: number, outputScript: Script, topic: string): Promise<void>;
-    outputSpent?(txid: string, outputIndex: number, topic: string): Promise<void>;
-    outputDeleted?(txid: string, outputIndex: number, topic: string): Promise<void>;
-    lookup(question: LookupQuestion): Promise<LookupAnswer | LookupFormula>;
-    getDocumentation(): Promise<string>;
-    getMetaData(): Promise<{
+export interface LookupService {
+    outputAdded?: (txid: string, outputIndex: number, outputScript: Script, topic: string) => Promise<void>;
+    outputSpent?: (txid: string, outputIndex: number, topic: string) => Promise<void>;
+    outputDeleted?: (txid: string, outputIndex: number, topic: string) => Promise<void>;
+    lookup: (question: LookupQuestion) => Promise<LookupAnswer | LookupFormula>;
+    getDocumentation: () => Promise<string>;
+    getMetaData: () => Promise<{
         name: string;
         shortDescription: string;
         iconURL?: string;
@@ -98,20 +118,20 @@ export default interface LookupService {
 
 <summary>Interface LookupService Details</summary>
 
-#### Method getDocumentation
+#### Property getDocumentation
 
 Returns a Markdown-formatted documentation string for the lookup service.
 
 ```ts
-getDocumentation(): Promise<string>
+getDocumentation: () => Promise<string>
 ```
 
-#### Method getMetaData
+#### Property getMetaData
 
 Returns a metadata object that can be used to identify the lookup service.
 
 ```ts
-getMetaData(): Promise<{
+getMetaData: () => Promise<{
     name: string;
     shortDescription: string;
     iconURL?: string;
@@ -120,50 +140,77 @@ getMetaData(): Promise<{
 }>
 ```
 
-#### Method lookup
+#### Property lookup
 
 Queries the lookup service for information
 
 ```ts
-lookup(question: LookupQuestion): Promise<LookupAnswer | LookupFormula>
+lookup: (question: LookupQuestion) => Promise<LookupAnswer | LookupFormula>
 ```
 
-Returns
+#### Property outputAdded
+
+Process the event when a new UTXO is let into a topic
+
+```ts
+outputAdded?: (txid: string, outputIndex: number, outputScript: Script, topic: string) => Promise<void>
+```
 
-— The Lookup Answer or Lookup Formula used to answer the question
+#### Property outputDeleted
 
-Argument Details
+Processes the deletion event for a UTXO.
+
+```ts
+outputDeleted?: (txid: string, outputIndex: number, topic: string) => Promise<void>
+```
 
-+ **question**
-  + — The question to be answered by the lookup service
+#### Property outputSpent
 
-#### Method outputAdded
+Processes the spend event for a UTXO.
 
-Process the event when a new UTXO is let into a topic
+```ts
+outputSpent?: (txid: string, outputIndex: number, topic: string) => Promise<void>
+```
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+### Interface: AppliedTransaction
+
+Represents a transaction that has been applied to a topic.
 
 ```ts
-outputAdded?(txid: string, outputIndex: number, outputScript: Script, topic: string): Promise<void>
+export interface AppliedTransaction {
+    txid: string;
+    topic: string;
+}
 ```
 
-#### Method outputDeleted
+<details>
+
+<summary>Interface AppliedTransaction Details</summary>
+
+#### Property topic
 
-Process the deletion event for a UTXO
+Output index of the applied transaction
 
 ```ts
-outputDeleted?(txid: string, outputIndex: number, topic: string): Promise<void>
+topic: string
 ```
 
-#### Method outputSpent
+#### Property txid
 
-Process the spend event for a UTXO
+TXID of the applied transaction
 
 ```ts
-outputSpent?(txid: string, outputIndex: number, topic: string): Promise<void>
+txid: string
 ```
 
 </details>
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 ### Interface: Storage
@@ -171,17 +218,21 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#typ
 Defines the Storage Engine interface used internally by the Overlay Services Engine.
 
 ```ts
-export default interface Storage {
-    insertOutput(utxo: Output): Promise<void>;
-    findOutput(txid: string, outputIndex: number, topic?: string, spent?: boolean): Promise<Output | null>;
-    deleteOutput(txid: string, outputIndex: number, topic: string): Promise<void>;
-    markUTXOAsSpent(txid: string, outputIndex: number, topic: string): Promise<void>;
-    updateConsumedBy(txid: string, outputIndex: number, topic: string, consumedBy: {
+export interface Storage {
+    insertOutput: (utxo: Output) => Promise<void>;
+    findOutput: (txid: string, outputIndex: number, topic?: string, spent?: boolean, includeBEEF?: boolean) => Promise<Output | null>;
+    findOutputsForTransaction: (txid: string, includeBEEF?: boolean) => Promise<Output[]>;
+    findUTXOsForTopic: (topic: string, since?: number, includeBEEF?: boolean) => Promise<Output[]>;
+    deleteOutput: (txid: string, outputIndex: number, topic: string) => Promise<void>;
+    markUTXOAsSpent: (txid: string, outputIndex: number, topic: string) => Promise<void>;
+    updateConsumedBy: (txid: string, outputIndex: number, topic: string, consumedBy: Array<{
         txid: string;
         outputIndex: number;
-    }[]): Promise<void>;
-    insertAppliedTransaction(tx: AppliedTransaction): Promise<void>;
-    doesAppliedTransactionExist(tx: AppliedTransaction): Promise<boolean>;
+    }>) => Promise<void>;
+    updateTransactionBEEF: (txid: string, beef: number[]) => Promise<void>;
+    updateOutputBlockHeight?: (txid: string, outputIndex: number, topic: string, blockHeight: number) => Promise<void>;
+    insertAppliedTransaction: (tx: AppliedTransaction) => Promise<void>;
+    doesAppliedTransactionExist: (tx: AppliedTransaction) => Promise<boolean>;
 }
 ```
 
@@ -189,127 +240,208 @@ export default interface Storage {
 
 <summary>Interface Storage Details</summary>
 
-#### Method deleteOutput
+#### Property deleteOutput
 
 Deletes an output from storage
 
 ```ts
-deleteOutput(txid: string, outputIndex: number, topic: string): Promise<void>
+deleteOutput: (txid: string, outputIndex: number, topic: string) => Promise<void>
 ```
 
-Argument Details
+#### Property doesAppliedTransactionExist
 
-+ **txid**
-  + — The TXID of the output to delete
-+ **outputIndex**
-  + — The index of the output to delete
-+ **topic**
-  + — The topic where the output should be deleted
+Checks if a duplicate transaction exists
+
+```ts
+doesAppliedTransactionExist: (tx: AppliedTransaction) => Promise<boolean>
+```
 
-#### Method doesAppliedTransactionExist
+#### Property findOutput
 
-Checks if a duplicate transaction exists
+Finds an output from storage
 
 ```ts
-doesAppliedTransactionExist(tx: AppliedTransaction): Promise<boolean>
+findOutput: (txid: string, outputIndex: number, topic?: string, spent?: boolean, includeBEEF?: boolean) => Promise<Output | null>
 ```
 
-Returns
+#### Property findOutputsForTransaction
 
-Whether the transaction is already applied
+Finds outputs with a matching transaction ID from storage
 
-Argument Details
+```ts
+findOutputsForTransaction: (txid: string, includeBEEF?: boolean) => Promise<Output[]>
+```
 
-+ **tx**
-  + — Transaction to check
+#### Property findUTXOsForTopic
 
-#### Method findOutput
+Finds current UTXOs that have been admitted into a given topic
 
-Finds an output from storage
+```ts
+findUTXOsForTopic: (topic: string, since?: number, includeBEEF?: boolean) => Promise<Output[]>
+```
+
+#### Property insertAppliedTransaction
+
+Inserts record of the applied transaction
 
 ```ts
-findOutput(txid: string, outputIndex: number, topic?: string, spent?: boolean): Promise<Output | null>
+insertAppliedTransaction: (tx: AppliedTransaction) => Promise<void>
 ```
 
-Argument Details
+#### Property insertOutput
 
-+ **txid**
-  + — TXID of hte output to find
-+ **outputIndex**
-  + — Output index for the output to find
-+ **topic**
-  + — The topic in which the output is stored
-+ **spent**
-  + — Whether the output must be spent to be returned
+Adds a new output to storage
+
+```ts
+insertOutput: (utxo: Output) => Promise<void>
+```
 
-#### Method insertAppliedTransaction
+#### Property markUTXOAsSpent
 
-Inserts record of the applied transaction
+Updates a UTXO as spent
 
 ```ts
-insertAppliedTransaction(tx: AppliedTransaction): Promise<void>
+markUTXOAsSpent: (txid: string, outputIndex: number, topic: string) => Promise<void>
 ```
 
-Argument Details
+#### Property updateConsumedBy
 
-+ **tx**
-  + — The transaction to insert
+Updates which outputs are consumed by this output
 
-#### Method insertOutput
+```ts
+updateConsumedBy: (txid: string, outputIndex: number, topic: string, consumedBy: Array<{
+    txid: string;
+    outputIndex: number;
+}>) => Promise<void>
+```
 
-Adds a new output to storage
+#### Property updateOutputBlockHeight
+
+Updates the block height on an output
 
 ```ts
-insertOutput(utxo: Output): Promise<void>
+updateOutputBlockHeight?: (txid: string, outputIndex: number, topic: string, blockHeight: number) => Promise<void>
 ```
 
-Argument Details
+#### Property updateTransactionBEEF
+
+Updates the beef data for a transaction
+
+```ts
+updateTransactionBEEF: (txid: string, beef: number[]) => Promise<void>
+```
 
-+ **utxo**
-  + — The output to add
+</details>
 
-#### Method markUTXOAsSpent
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
-Updates a UTXO as spent
+---
+### Interface: Advertisement
 
 ```ts
-markUTXOAsSpent(txid: string, outputIndex: number, topic: string): Promise<void>
+export interface Advertisement {
+    protocol: "SHIP" | "SLAP";
+    identityKey: string;
+    domain: string;
+    topicOrService: string;
+    beef?: number[];
+    outputIndex?: number;
+}
 ```
 
-Argument Details
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
-+ **txid**
-  + — TXID of the output to update
-+ **outputIndex**
-  + — Index of the output to update
-+ **topic**
-  + — Topic in which the output should be updated
+---
+### Interface: AdvertisementData
 
-#### Method updateConsumedBy
+```ts
+export interface AdvertisementData {
+    protocol: "SHIP" | "SLAP";
+    topicOrServiceName: string;
+}
+```
 
-Updates which outputs are consumed by this output
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+### Interface: Advertiser
+
+Interface for managing SHIP and SLAP advertisements.
+Provides methods for creating, finding, and revoking advertisements.
 
 ```ts
-updateConsumedBy(txid: string, outputIndex: number, topic: string, consumedBy: {
-    txid: string;
-    outputIndex: number;
-}[]): Promise<void>
+export interface Advertiser {
+    createAdvertisements: (adsData: AdvertisementData[]) => Promise<TaggedBEEF>;
+    findAllAdvertisements: (protocol: "SHIP" | "SLAP") => Promise<Advertisement[]>;
+    revokeAdvertisements: (advertisements: Advertisement[]) => Promise<TaggedBEEF>;
+    parseAdvertisement: (outputScript: Script) => Advertisement;
+}
 ```
 
-Argument Details
+<details>
 
-+ **txid**
-  + — TXID of the output to update
-+ **outputIndex**
-  + — Index of the output to update
-+ **topic**
-  + — Topic in which the output should be updated
-+ **consumedBy**
-  + — The new set of outputs consumed by this output
+<summary>Interface Advertiser Details</summary>
+
+#### Property createAdvertisements
+
+Creates a new SHIP/SLAP advertisement for a given topic.
+
+```ts
+createAdvertisements: (adsData: AdvertisementData[]) => Promise<TaggedBEEF>
+```
+
+#### Property findAllAdvertisements
+
+Finds all SHIP/SLAP advertisements.
+
+```ts
+findAllAdvertisements: (protocol: "SHIP" | "SLAP") => Promise<Advertisement[]>
+```
+
+#### Property parseAdvertisement
+
+Parses an output script to extract an advertisement.
+
+```ts
+parseAdvertisement: (outputScript: Script) => Advertisement
+```
+
+#### Property revokeAdvertisements
+
+Revokes an existing advertisement, either SHIP or SLAP.
+
+```ts
+revokeAdvertisements: (advertisements: Advertisement[]) => Promise<TaggedBEEF>
+```
 
 </details>
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+### Interface: GraphNode
+
+Represents a node in the temporary graph.
+
+```ts
+export interface GraphNode {
+    txid: string;
+    graphID: string;
+    rawTx: string;
+    outputIndex: number;
+    spentBy?: string;
+    proof?: string;
+    txMetadata?: string;
+    outputMetadata?: string;
+    inputs?: Record<string, {
+        hash: string;
+    }> | undefined;
+    children: GraphNode[];
+    parent?: GraphNode;
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 ## Classes
@@ -318,27 +450,201 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#typ
 | --- |
 | [Engine](#class-engine) |
 | [KnexStorage](#class-knexstorage) |
+| [OverlayGASPRemote](#class-overlaygaspremote) |
+| [OverlayGASPStorage](#class-overlaygaspstorage) |
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 
+### Class: OverlayGASPRemote
+
+```ts
+export class OverlayGASPRemote implements GASPRemote {
+    constructor(public endpointURL: string, public topic: string) 
+    async getInitialResponse(request: GASPInitialRequest): Promise<GASPInitialResponse> 
+    async requestNode(graphID: string, txid: string, outputIndex: number, metadata: boolean): Promise<GASPNode> 
+    async getInitialReply(response: GASPInitialResponse): Promise<GASPInitialReply> 
+    async submitNode(node: GASPNode): Promise<void | GASPNodeResponse> 
+}
+```
+
+<details>
+
+<summary>Class OverlayGASPRemote Details</summary>
+
+#### Method getInitialResponse
+
+Given an outgoing initial request, sends the request to the foreign instance and obtains their initial response.
+
+```ts
+async getInitialResponse(request: GASPInitialRequest): Promise<GASPInitialResponse> 
+```
+
+#### Method requestNode
+
+Given an outgoing txid, outputIndex and optional metadata, request the associated GASP node from the foreign instance.
+
+```ts
+async requestNode(graphID: string, txid: string, outputIndex: number, metadata: boolean): Promise<GASPNode> 
+```
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+### Class: OverlayGASPStorage
+
+```ts
+export class OverlayGASPStorage implements GASPStorage {
+    readonly temporaryGraphNodeRefs: Record<string, GraphNode> = {};
+    constructor(public topic: string, public engine: Engine, public maxNodesInGraph?: number) 
+    async findKnownUTXOs(since: number): Promise<Array<{
+        txid: string;
+        outputIndex: number;
+    }>> 
+    async hydrateGASPNode(graphID: string, txid: string, outputIndex: number, metadata: boolean): Promise<GASPNode> 
+    async findNeededInputs(tx: GASPNode): Promise<GASPNodeResponse | undefined> 
+    async appendToGraph(tx: GASPNode, spentBy?: string | undefined): Promise<void> 
+    async validateGraphAnchor(graphID: string): Promise<void> 
+    async discardGraph(graphID: string): Promise<void> 
+    async finalizeGraph(graphID: string): Promise<void> 
+}
+```
+
+<details>
+
+<summary>Class OverlayGASPStorage Details</summary>
+
+#### Method appendToGraph
+
+Appends a new node to a temporary graph.
+
+```ts
+async appendToGraph(tx: GASPNode, spentBy?: string | undefined): Promise<void> 
+```
+
+Argument Details
+
++ **tx**
+  + The node to append to this graph.
++ **spentBy**
+  + Unless this is the same node identified by the graph ID, denotes the TXID and input index for the node which spent this one, in 36-byte format.
+
+Throws
+
+If the node cannot be appended to the graph, either because the graph ID is for a graph the recipient does not want or because the graph has grown to be too large before being finalized.
+
+#### Method discardGraph
+
+Deletes all data associated with a temporary graph that has failed to sync, if the graph exists.
+
+```ts
+async discardGraph(graphID: string): Promise<void> 
+```
+
+Argument Details
+
++ **graphID**
+  + The TXID and output index (in 36-byte format) for the UTXO at the tip of this graph.
+
+#### Method finalizeGraph
+
+Finalizes a graph, solidifying the new UTXO and its ancestors so that it will appear in the list of known UTXOs.
+
+```ts
+async finalizeGraph(graphID: string): Promise<void> 
+```
+
+Argument Details
+
++ **graphID**
+  + The TXID and output index (in 36-byte format) for the UTXO at the root of this graph.
+
+#### Method findNeededInputs
+
+For a given node, returns the inputs needed to complete the graph, including whether updated metadata is requested for those inputs.
+
+```ts
+async findNeededInputs(tx: GASPNode): Promise<GASPNodeResponse | undefined> 
+```
+
+Returns
+
+A promise for a mapping of requested input transactions and whether metadata should be provided for each.
+
+Argument Details
+
++ **tx**
+  + The node for which needed inputs should be found.
+
+#### Method hydrateGASPNode
+
+For a given txid and output index, returns the associated transaction, a merkle proof if the transaction is in a block, and metadata if if requested. If no metadata is requested, metadata hashes on inputs are not returned.
+
+```ts
+async hydrateGASPNode(graphID: string, txid: string, outputIndex: number, metadata: boolean): Promise<GASPNode> 
+```
+
+#### Method validateGraphAnchor
+
+Checks whether the given graph, in its current state, makes reference only to transactions that are proven in the blockchain, or already known by the recipient to be valid.
+Additionally, in a breadth-first manner (ensuring that all inputs for any given node are processed before nodes that spend them), it ensures that the root node remains valid according to the rules of the overlay's topic manager,
+while considering any coins which the Manager had previously indicated were either valid or invalid.
+
+```ts
+async validateGraphAnchor(graphID: string): Promise<void> 
+```
+
+Argument Details
+
++ **graphID**
+  + The TXID and output index (in 36-byte format) for the UTXO at the tip of this graph.
+
+Throws
+
+If the graph is not well-anchored, according to the rules of Bitcoin or the rules of the Overlay Topic Manager.
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
 ### Class: Engine
 
-Am engine for running BSV Overlay Services (topic managers and lookup services).
+An engine for running BSV Overlay Services (topic managers and lookup services).
 
 ```ts
-export default class Engine {
+export class Engine {
     constructor(public managers: {
         [key: string]: TopicManager;
     }, public lookupServices: {
         [key: string]: LookupService;
-    }, public storage: Storage, public chainTracker: ChainTracker) 
-    async submit(taggedBEEF: TaggedBEEF): Promise<STEAK> 
+    }, public storage: Storage, public chainTracker: ChainTracker | "scripts only", public hostingURL?: string, public shipTrackers?: string[], public slapTrackers?: string[], public broadcaster?: Broadcaster, public advertiser?: Advertiser, public syncConfiguration?: SyncConfiguration, public logTime = false, public logPrefix = "[OVERLAY_ENGINE] ", public throwOnBroadcastFailure = false, public overlayBroadcastFacilitator: OverlayBroadcastFacilitator = new HTTPSOverlayBroadcastFacilitator(), public logger: typeof console = console) 
+    async submit(taggedBEEF: TaggedBEEF, onSteakReady?: (steak: STEAK) => void, mode: "historical-tx" | "current-tx" = "current-tx"): Promise<STEAK> 
     async lookup(lookupQuestion: LookupQuestion): Promise<LookupAnswer> 
-    async listTopicManagers(): Promise<string[]> 
-    async listLookupServiceProviders(): Promise<string[]> 
-    async getDocumentationForTopicManger(manager: any): Promise<string> 
+    async syncAdvertisements(): Promise<void> 
+    async startGASPSync(): Promise<void> 
+    async provideForeignSyncResponse(initialRequest: GASPInitialRequest, topic: string): Promise<GASPInitialResponse> 
+    async provideForeignGASPNode(graphID: string, txid: string, outputIndex: number): Promise<GASPNode> 
+    async getUTXOHistory(output: Output, historySelector?: ((beef: number[], outputIndex: number, currentDepth: number) => Promise<boolean>) | number, currentDepth = 0): Promise<Output | undefined> 
+    async handleNewMerkleProof(txid: string, proof: MerklePath, blockHeight?: number): Promise<void> 
+    async listTopicManagers(): Promise<Record<string, {
+        name: string;
+        shortDescription: string;
+        iconURL?: string;
+        version?: string;
+        informationURL?: string;
+    }>> 
+    async listLookupServices(): Promise<Record<string, {
+        name: string;
+        shortDescription: string;
+        iconURL?: string;
+        version?: string;
+        informationURL?: string;
+    }>> 
+    async getDocumentationForTopicManager(manager: any): Promise<string> 
     async getDocumentationForLookupServiceProvider(provider: any): Promise<string> 
 }
 ```
@@ -356,7 +662,7 @@ constructor(public managers: {
     [key: string]: TopicManager;
 }, public lookupServices: {
     [key: string]: LookupService;
-}, public storage: Storage, public chainTracker: ChainTracker) 
+}, public storage: Storage, public chainTracker: ChainTracker | "scripts only", public hostingURL?: string, public shipTrackers?: string[], public slapTrackers?: string[], public broadcaster?: Broadcaster, public advertiser?: Advertiser, public syncConfiguration?: SyncConfiguration, public logTime = false, public logPrefix = "[OVERLAY_ENGINE] ", public throwOnBroadcastFailure = false, public overlayBroadcastFacilitator: OverlayBroadcastFacilitator = new HTTPSOverlayBroadcastFacilitator(), public logger: typeof console = console) 
 ```
 
 Argument Details
@@ -369,8 +675,28 @@ Argument Details
   + for interacting with internally-managed persistent data
 + **chainTracker**
   + Verifies SPV data associated with transactions
-+ **proofNotifiers**
-  + proof notifier services coming soon!
++ **hostingURL**
+  + The URL this engine is hosted at. Required if going to support peer-discovery with an advertiser.
++ **Broadcaster**
+  + broadcaster used for broadcasting the incoming transaction
++ **Advertiser**
+  + handles SHIP and SLAP advertisements for peer-discovery
++ **shipTrackers**
+  + SHIP domains we know to bootstrap the system
++ **slapTrackers**
+  + SLAP domains we know to bootstrap the system
++ **syncConfiguration**
+  + — Configuration object describing historical synchronization of topics.
++ **logTime**
+  + Enables / disables the timing logs for various operations in the Overlay submit route.
++ **logPrefix**
+  + Supports overriding the log prefix with a custom string.
++ **throwOnBroadcastFailure**
+  + Enables / disables throwing an error when a transaction broadcast failure is detected.
++ **overlayBroadcastFacilitator**
+  + Facilitator for propagation to other Overlay Services.
++ **logger**
+  + The place where log entries are written.
 
 #### Method getDocumentationForLookupServiceProvider
 
@@ -384,45 +710,101 @@ Returns
 
 -  the documentation for the lookup service
 
-#### Method getDocumentationForTopicManger
+#### Method getDocumentationForTopicManager
 
 Run a query to get the documentation for a particular topic manager
 
 ```ts
-async getDocumentationForTopicManger(manager: any): Promise<string> 
+async getDocumentationForTopicManager(manager: any): Promise<string> 
 ```
 
 Returns
 
 - the documentation for the topic manager
 
-#### Method listLookupServiceProviders
+#### Method getUTXOHistory
+
+Traverse and return the history of a UTXO.
+
+This method traverses the history of a given Unspent Transaction Output (UTXO) and returns
+its historical data based on the provided history selector and current depth.
+
+```ts
+async getUTXOHistory(output: Output, historySelector?: ((beef: number[], outputIndex: number, currentDepth: number) => Promise<boolean>) | number, currentDepth = 0): Promise<Output | undefined> 
+```
+
+Returns
+
+- A promise that resolves to the output history if found, or undefined if not.
+
+Argument Details
+
++ **output**
+  + The UTXO to traverse the history for.
++ **historySelector**
+  + Optionally directs the history traversal:
+- If a number, denotes how many previous spends (in terms of chain depth) to include.
+- If a function, accepts a BEEF-formatted transaction, an output index, and the current depth as parameters,
+returning a promise that resolves to a boolean indicating whether to include the output in the history.
++ **currentDepth**
+  + The current depth of the traversal relative to the top-level UTXO.
+
+#### Method handleNewMerkleProof
+
+Recursively prune UTXOs when an incoming Merkle Proof is received.
+
+```ts
+async handleNewMerkleProof(txid: string, proof: MerklePath, blockHeight?: number): Promise<void> 
+```
+
+Argument Details
+
++ **txid**
+  + Transaction ID of the associated outputs to prune.
++ **proof**
+  + Merkle proof containing the Merkle path and other relevant data to verify the transaction.
++ **blockHeight**
+  + The block height associated with the incoming merkle proof.
+
+#### Method listLookupServices
 
 Find a list of supported lookup services
 
 ```ts
-async listLookupServiceProviders(): Promise<string[]> 
+async listLookupServices(): Promise<Record<string, {
+    name: string;
+    shortDescription: string;
+    iconURL?: string;
+    version?: string;
+    informationURL?: string;
+}>> 
 ```
 
 Returns
 
-- array of supported lookup services
+- Supported lookup services and their metadata
 
 #### Method listTopicManagers
 
 Find a list of supported topic managers
 
 ```ts
-async listTopicManagers(): Promise<string[]> 
+async listTopicManagers(): Promise<Record<string, {
+    name: string;
+    shortDescription: string;
+    iconURL?: string;
+    version?: string;
+    informationURL?: string;
+}>> 
 ```
 
 Returns
 
-- array of supported topic managers
+- Supported topic managers and their metadata
 
 #### Method lookup
 
-Submit a lookup question to the Overlay Services Engine, and receive bakc a Lookup Answer
+Submit a lookup question to the Overlay Services Engine, and receive back a Lookup Answer
 
 ```ts
 async lookup(lookupQuestion: LookupQuestion): Promise<LookupAnswer> 
@@ -437,12 +819,74 @@ Argument Details
 + **LookupQuestion**
   + — The question to ask the Overlay Services Engine
 
+#### Method provideForeignGASPNode
+
+Provides a GASPNode for the given graphID, transaction ID, and output index.
+
+```ts
+async provideForeignGASPNode(graphID: string, txid: string, outputIndex: number): Promise<GASPNode> 
+```
+
+Returns
+
+A promise that resolves to a GASPNode containing the raw transaction and other optional data.
+
+Argument Details
+
++ **graphID**
+  + The identifier for the graph to which this node belongs (in the format txid.outputIndex).
++ **txid**
+  + The transaction ID for the requested output from somewhere within the graph's history.
++ **outputIndex**
+  + The index of the output in the transaction.
+
+Throws
+
+An error if no output is found for the given transaction ID and output index.
+
+#### Method provideForeignSyncResponse
+
+Given a GASP request, create an initial response.
+
+This method processes an initial synchronization request by finding the relevant UTXOs for the given topic
+since the provided block height in the request. It constructs a response that includes a list of these UTXOs
+and the min block height from the initial request.
+
+```ts
+async provideForeignSyncResponse(initialRequest: GASPInitialRequest, topic: string): Promise<GASPInitialResponse> 
+```
+
+Returns
+
+A promise that resolves to a GASPInitialResponse containing the list of UTXOs and the provided min block height.
+
+Argument Details
+
++ **initialRequest**
+  + The GASP initial request containing the version and the block height since the last sync.
++ **topic**
+  + The topic for which UTXOs are being requested.
+
+#### Method startGASPSync
+
+This method goes through each topic that we support syncing and attempts to sync with each endpoint
+associated with that topic. If the sync configuration is 'SHIP', it will sync to all peers that support
+the topic.
+
+```ts
+async startGASPSync(): Promise<void> 
+```
+
+Throws
+
+Error if the overlay service engine is not configured for topical synchronization.
+
 #### Method submit
 
 Submits a transaction for processing by Overlay Services.
 
 ```ts
-async submit(taggedBEEF: TaggedBEEF): Promise<STEAK> 
+async submit(taggedBEEF: TaggedBEEF, onSteakReady?: (steak: STEAK) => void, mode: "historical-tx" | "current-tx" = "current-tx"): Promise<STEAK> 
 ```
 
 Returns
@@ -452,31 +896,70 @@ The submitted transaction execution acknowledgement
 Argument Details
 
 + **taggedBEEF**
-  + — The transaction to process
+  + The transaction to process
++ **onSTEAKReady**
+  + Optional callback function invoked when the STEAK is ready.
++ **mode**
+  + — Indicates the submission behavior, whether historical or current. Historical transactions are not broadcast or propagated.
+
+The optional callback function should be used to get STEAK when ready, and avoid waiting for broadcast and transaction propagation to complete.
+
+#### Method syncAdvertisements
+
+Ensures alignment between the current SHIP/SLAP advertisements and the 
+configured Topic Managers and Lookup Services in the engine.
+
+This method performs the following actions:
+1. Retrieves the current configuration of topics and services.
+2. Fetches the existing SHIP advertisements for each configured topic.
+3. Fetches the existing SLAP advertisements for each configured service.
+4. Compares the current configuration with the fetched advertisements to determine which advertisements
+   need to be created or revoked.
+5. Creates new SHIP/SLAP advertisements if they do not exist for the configured topics/services.
+6. Revokes existing SHIP/SLAP advertisements if they are no longer required based on the current configuration.
+
+The function uses the `Advertiser` methods to create or revoke advertisements and ensures the updates are
+submitted to the SHIP/SLAP overlay networks using the engine's `submit()` method.
+
+```ts
+async syncAdvertisements(): Promise<void> 
+```
+
+Returns
+
+A promise that resolves when the synchronization process is complete.
+
+Throws
+
+Will throw an error if there are issues during the advertisement synchronization process.
 
 </details>
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 ### Class: KnexStorage
 
 ```ts
-export default class KnexStorage implements Storage {
+export class KnexStorage implements Storage {
     knex: Knex;
     constructor(knex: Knex) 
-    async findOutput(txid: string, outputIndex: number, topic?: string, spent?: boolean): Promise<Output | null> 
+    async findOutput(txid: string, outputIndex: number, topic?: string, spent?: boolean, includeBEEF: boolean = false): Promise<Output | null> 
+    async findOutputsForTransaction(txid: string, includeBEEF: boolean = false): Promise<Output[]> 
+    async findUTXOsForTopic(topic: string, since?: number, includeBEEF: boolean = false): Promise<Output[]> 
     async deleteOutput(txid: string, outputIndex: number, topic: string): Promise<void> 
-    async insertOutput(output: Output) 
+    async insertOutput(output: Output): Promise<void> 
     async markUTXOAsSpent(txid: string, outputIndex: number, topic?: string): Promise<void> 
-    async updateConsumedBy(txid: string, outputIndex: number, topic: string, consumedBy: {
+    async updateConsumedBy(txid: string, outputIndex: number, topic: string, consumedBy: Array<{
         txid: string;
         outputIndex: number;
-    }[]) 
+    }>): Promise<void> 
+    async updateTransactionBEEF(txid: string, beef: number[]): Promise<void> 
+    async updateOutputBlockHeight(txid: string, outputIndex: number, topic: string, blockHeight: number): Promise<void> 
     async insertAppliedTransaction(tx: {
         txid: string;
         topic: string;
-    }) 
+    }): Promise<void> 
     async doesAppliedTransactionExist(tx: {
         txid: string;
         topic: string;
@@ -484,87 +967,123 @@ export default class KnexStorage implements Storage {
 }
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
-## Types
+## Functions
 
 | |
 | --- |
-| [AdmittanceInstructions](#type-admittanceinstructions) |
-| [LookupAnswer](#type-lookupanswer) |
-| [LookupFormula](#type-lookupformula) |
-| [LookupQuestion](#type-lookupquestion) |
-| [Output](#type-output) |
-| [STEAK](#type-steak) |
-| [TaggedBEEF](#type-taggedbeef) |
+| [down](#function-down) |
+| [down](#function-down) |
+| [down](#function-down) |
+| [down](#function-down) |
+| [up](#function-up) |
+| [up](#function-up) |
+| [up](#function-up) |
+| [up](#function-up) |
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 
-### Type: AdmittanceInstructions
+### Function: up
+
+```ts
+export async function up(knex: Knex): Promise<void> 
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
-Instructs the Overlay Services Engine about which outputs to admit and which previous outputs to retain. Returned by a Topic Manager.
+---
+### Function: down
 
 ```ts
-export type AdmittanceInstructions = {
-    outputsToAdmit: number[];
-    coinsToRetain: number[];
-}
+export async function down(knex: Knex): Promise<void> 
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
-### Type: LookupQuestion
+### Function: up
+
+```ts
+export async function up(knex: Knex): Promise<void> 
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
-The question asked to the Overlay Services Engine when a consumer of state wishes to look up information.
+---
+### Function: down
 
 ```ts
-export type LookupQuestion = {
-    service: string;
-    query: unknown;
-}
+export async function down(knex: Knex): Promise<void> 
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
-### Type: LookupFormula
+### Function: up
 
-The formula that will be used by the Overlay Services Engine to compute the Lookup Answer. Can be returned by Lookup Services in response to a Lookup Question.
+```ts
+export async function up(knex: Knex): Promise<void> 
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+### Function: down
 
 ```ts
-export type LookupFormula = {
-    txid: string;
-    outputIndex: number;
-    history?: ((beef: number[], outputIndex: number, currentDepth: number) => Promise<boolean>) | number;
-}[]
+export async function down(knex: Knex): Promise<void> 
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
-### Type: LookupAnswer
+### Function: up
 
-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.
+```ts
+export async function up(knex: Knex): Promise<void> 
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+### Function: down
 
 ```ts
-export type LookupAnswer = {
-    type: "output-list";
-    outputs: Array<{
-        beef: number[];
-        outputIndex: number;
-    }>;
-} | {
-    type: "freeform";
-    result: unknown;
-}
+export async function down(knex: Knex): Promise<void> 
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+## Types
+
+| |
+| --- |
+| [LookupFormula](#type-lookupformula) |
+| [Output](#type-output) |
+| [SyncConfiguration](#type-syncconfiguration) |
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
+
+---
+
+### Type: LookupFormula
+
+The formula that will be used by the Overlay Services Engine to compute the Lookup Answer. Can be returned by Lookup Services in response to a Lookup Question.
+
+```ts
+export type LookupFormula = Array<{
+    txid: string;
+    outputIndex: number;
+    history?: ((beef: number[], outputIndex: number, currentDepth: number) => Promise<boolean>) | number;
+}>
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
 ### Type: Output
@@ -579,43 +1098,48 @@ export type Output = {
     satoshis: number;
     topic: string;
     spent: boolean;
-    beef: number[];
-    outputsConsumed: {
+    outputsConsumed: Array<{
         txid: string;
         outputIndex: number;
-    }[];
-    consumedBy: {
+    }>;
+    consumedBy: Array<{
         txid: string;
         outputIndex: number;
-    }[];
+    }>;
+    beef?: number[];
+    blockHeight?: number;
 }
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---
-### Type: TaggedBEEF
+### Type: SyncConfiguration
 
-Tagged BEEF
+Configuration for synchronizing supported topic managers.
 
-```ts
-export type TaggedBEEF = {
-    beef: number[];
-    topics: string[];
-}
-```
+This configuration determines which topics should support synchronization and specifies the mode of synchronization.
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+There are two synchronization modes:
+1. Sync to predefined hardcoded peers for the specified topic, including associated hosting URLs.
+2. Use SHIP (Service Host Interconnect Protocol) to sync with all known peers that support the specified topic.
 
----
-### Type: STEAK
+Each entry in the configuration object maps a topic to either an array of overlay service peers (hardcoded URLs) or the string 'SHIP' (for dynamic syncing using SHIP).
+
+Example
 
-Submitted Transaction Execution AcKnowledgment
+```ts
+// Example usage of SyncConfiguration
+const config: SyncConfiguration = {
+  "topicManager1": ["http://peer1.com", "http://peer2.com"],
+  "topicManager2": "SHIP"
+}
+```
 
 ```ts
-export type STEAK = Record<string, AdmittanceInstructions>
+export type SyncConfiguration = Record<string, string[] | "SHIP" | false>
 ```
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Types](#types)
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types)
 
 ---