Expand description
Core types for the BSV Overlay Services Engine.
Types that already exist in bsv::overlay::types (Protocol, LookupQuestion, LookupAnswer,
TaggedBEEF, AdmittanceInstructions, Steak, ServiceMetadata, etc.) are re-exported.
This module defines Engine-specific types not present in the SDK.
Structs§
- Admittance
Instructions - Admittance instructions from overlay service.
- Advertisement
- A SHIP or SLAP overlay advertisement.
- Advertisement
Data - Data needed to create a new advertisement.
- Applied
Transaction - Applied transaction record (deduplication tracking).
- GASP
Initial Reply - Reply to the initial response (UTXOs the requester sends back).
- GASP
Initial Request - Initial request in the GASP (Graph Aware Sync Protocol).
- GASP
Initial Response - Initial response in the GASP protocol.
- GASP
Input Ref - Reference to an input transaction in a GASP graph node.
- GASP
Input Request - Request for a specific input in GASP sync.
- GASP
Node - A node in a GASP transaction graph.
- GASP
Node Response - Response indicating which inputs are needed to complete a GASP graph.
- GASP
Output - A single output in a GASP sync response.
- Host
Response - Response from a single host during broadcast.
- Lookup
Formula - Formula for computed lookups.
- Lookup
Question - Question sent to a lookup service.
- Outpoint
- A transaction outpoint — txid + output index.
- Output
- A UTXO tracked by the Overlay Services Engine.
- Output
List Item - Single output in a lookup answer.
- Service
Metadata - Metadata about an overlay service.
- TaggedBEEF
- BEEF transaction tagged with topics.
- Topic
Admittance Context - The context of one
TopicManager::identify_admissible_outputscall: the reference’s fifth argument, under its name (context?: TopicAdmittanceContext, ts-stackpackages/overlays/overlay/src/TopicManager.tsatf999e0c1a). - UTXO
Reference - A minimal reference to a UTXO — just txid and outputIndex. Returned by SHIP/SLAP lookup services.
Enums§
- Admission
Mode - How the Engine delivers data to a LookupService on output admission.
- Lookup
Answer - Answer from a lookup service.
- Lookup
Answer Type - Answer type from lookup service.
- Lookup
Result - What a
LookupService::lookupcall returns to the Engine. - Network
Preset - Network preset for overlay services.
- Output
Admitted ByTopic - Payload delivered to LookupService::output_admitted_by_topic().
- Output
Spent - Payload delivered to LookupService::output_spent().
- Protocol
- Overlay protocol type.
- Spend
Notification Mode - How the Engine notifies a LookupService when an output is spent.
- Submit
Mode - Mode for transaction submission to the Engine.
- Sync
Target - Sync target for a topic.
Type Aliases§
- Steak
- STEAK = Submitted Transaction Execution AcKnowledgment.
- Sync
Configuration - Configuration for topic synchronization via GASP.