Artifact 50e997e28dc6157dad0ea355a8f3750416f27ca0d2beb4e175cfcf436c6c2467:
- File
docs/site/content/docs/reference/sdk/dst/api.md
— part of check-in
[e2a2f28861]
at
2026-04-26 07:52:11
on branch trunk
— docs site + landing + Cloudflare auto-deploy (#6)
* design: docs site + landing page + Cloudflare auto-deploy
Mirror dagnats's docs/landing infrastructure for libfossil: a single-page landing at site/index.html (forked CSS/HTML, content rewritten), a Hugo + Hextra docs site at docs/site/, gomarkdoc-generated SDK reference under docs/site/content/docs/reference/sdk/, llms.txt artifacts, and a wrangler.jsonc that lets Cloudflare's git integration auto-deploy on push to main. Existing docs/*.md files move under docs/site/content/docs/.
* design: correct landing-page path to Hugo layout override
dagnats's working landing page lives at docs/site/layouts/index.html (a Hugo home-page layout override), not at site/index.html. The top-level site/index.html in dagnats is an older draft that the build pipeline ignores. Match the working setup.
* design: align visual system + section list with live dagnats landing
The earlier description came from dagnats's stale top-level site/index.html (JetBrains Mono + Instrument Serif italic + ember/teal accents, 8 sections). The live Hugo layout that actually serves at / uses Geist Mono only, prefers-color-scheme dual-mode (warm cream / warm dark), a single ember accent, and 7 sections (Install, What it is, Why you might want it, How it fits together, Compared to neighbors, What it is not, Get going). Update the spec to match what we are actually mirroring.
* design: drop SDK regen from CF build to match dagnats exactly
Earlier draft had CF install Go + gomarkdoc and re-run docs-gen-sdk on every deploy. dagnats does not do that; it relies on the pre-commit hook to keep committed SDK pages in sync, and ships only Hugo + llms-gen + hugo --minify in the CF build. Match that: smaller, faster CF build, no Go-runtime assumption about Workers Builds, and a true 1:1 mirror.
* plan: docs site + landing + CF auto-deploy implementation steps
11 tasks covering Hugo+Hextra bootstrap, content moves, gomarkdoc SDK generation with pre-commit drift check, llms.txt artifacts, Makefile targets, landing page fork from dagnats's live Hugo home layout, wrangler.jsonc for CF Workers Static Assets, README update, and PR creation.
* docs(site): bootstrap Hugo + Hextra skeleton
* docs(site): move existing docs into Hugo content tree
* docs(site): fix links + H1s broken by docs-tree move
- Drop .md extensions on Hugo cross-doc links - Switch source-code references to absolute github.com/danmestas/libfossil URLs (relative ../ paths broke when files moved 3 dirs deeper) - Align H1 of architecture.md and migration-from-fossil.md with their frontmatter titles
* docs(site): add quickstart, examples, and SDK section stubs
* docs(site): tighten quickstart snippets + reference index
- Make the Sync example self-contained (open + sync, full main, real signatures) - Bridge from Clone to Open with a one-line prose link - Add a sentence to reference/_index.md so it does not render blank - Use the project's canonical "pure-Go, CGo-free" phrasing
* docs(site): add docs-gen-sdk Makefile target + commit generated SDK pages
* docs(site): pin gomarkdoc version + replace empty driver stubs with prose
- Add GOMARKDOC_VERSION Makefile variable so contributors don't drift on output format when a new gomarkdoc ships - Drop the two driver packages (modernc, ncruces) from gomarkdoc and hand-write _index.md pages explaining the register-on-import contract; the stubs were byte-stable but rendered as visibly broken documentation
* docs(site): add gen-llms-txt.sh + docs-gen-llms target
* docs(site): switch llms-full frontmatter strip from sed to awk
The sed range-negation pattern '/^---$/,/^---$/!p' silently re-opens a suppression range on any bare '---' in body content, eating Markdown horizontal rules and embedded YAML in fenced code blocks. The awk pattern strips the frontmatter only when it begins on line 1, leaving body content intact regardless of how many '---' lines it contains.
* hooks: pre-commit fails when SDK pages drift from code
* hooks: pre-commit re-installs gomarkdoc if it's the wrong version
The drift check's existing gate just looks for gomarkdoc on PATH. A contributor with an older gomarkdoc installed locally would have the gate pass and then run regeneration with their stale binary, producing either a silent false-negative or a confusing OUT-OF-DATE error with no version hint. Compare the installed version against GOMARKDOC_VERSION from Makefile and re-install on mismatch. Best-effort; offline contributors can still commit.
* docs(site): add docs-serve, docs-build, docs aggregate targets
* docs(site): make docs aggregate parallel-safe via explicit deps
The docs aggregate previously listed gen-sdk, gen-llms, and build as side-by-side prereqs. Make doesn't guarantee left-to-right ordering under -j, and gen-llms reads what gen-sdk writes, while build reads both. Encode the chain explicitly so 'make -j docs' is correct. Side benefit: 'make docs-build' standalone now produces a complete deployable site, matching contributor expectation.
* site(landing): fork dagnats home layout; rebrand chrome
* site(landing): rewrite §01–§07 content for libfossil
* site(landing): use .ascii class for diagram + fix §03 phrasing
* deploy: add wrangler.jsonc for CF Workers Static Assets
* docs: point README at the new docs site (user: [email protected], size: 26670) [annotate] [blame] [check-ins using]
<!-- Code generated by gomarkdoc. DO NOT EDIT --> # dst ```go import "github.com/danmestas/libfossil/dst" ``` ## Index - [func AllBlobUUIDsSorted\(r \*repo.Repo\) \(\[\]string, error\)](<#AllBlobUUIDsSorted>) - [func CheckBlobIntegrity\(nodeID string, r \*repo.Repo\) error](<#CheckBlobIntegrity>) - [func CheckConvergence\(master \*repo.Repo, leaves map\[NodeID\]\*repo.Repo\) error](<#CheckConvergence>) - [func CheckDeltaChains\(nodeID string, r \*repo.Repo\) error](<#CheckDeltaChains>) - [func CheckNoOrphanPhantoms\(nodeID string, r \*repo.Repo\) error](<#CheckNoOrphanPhantoms>) - [func CheckSubsetOf\(master \*repo.Repo, leaves map\[NodeID\]\*repo.Repo\) error](<#CheckSubsetOf>) - [func CheckTableSyncConvergence\(repos map\[string\]\*repo.Repo\) error](<#CheckTableSyncConvergence>) - [func CheckTableSyncIntegrity\(nodeID string, r \*repo.Repo\) error](<#CheckTableSyncIntegrity>) - [func CheckTagxrefIntegrity\(nodeID string, r \*repo.Repo\) error](<#CheckTagxrefIntegrity>) - [func CheckUVConvergence\(master \*repo.Repo, leaves map\[NodeID\]\*repo.Repo\) error](<#CheckUVConvergence>) - [func CheckUVIntegrity\(nodeID string, r \*repo.Repo\) error](<#CheckUVIntegrity>) - [func CountBlobs\(r \*repo.Repo\) \(int, error\)](<#CountBlobs>) - [func HasBlob\(r \*repo.Repo, uuid string\) bool](<#HasBlob>) - [type Action](<#Action>) - [type ActionType](<#ActionType>) - [type DefaultNode](<#DefaultNode>) - [func NewDefaultNode\(r \*repo.Repo, t sync.Transport, projectCode, serverCode string, opts DefaultNodeOpts\) \*DefaultNode](<#NewDefaultNode>) - [func \(n \*DefaultNode\) Repo\(\) \*repo.Repo](<#DefaultNode.Repo>) - [func \(n \*DefaultNode\) Tick\(ctx context.Context, event EventType\) Action](<#DefaultNode.Tick>) - [type DefaultNodeOpts](<#DefaultNodeOpts>) - [type Event](<#Event>) - [type EventQueue](<#EventQueue>) - [func \(q EventQueue\) Len\(\) int](<#EventQueue.Len>) - [func \(q EventQueue\) Less\(i, j int\) bool](<#EventQueue.Less>) - [func \(q \*EventQueue\) Pop\(\) any](<#EventQueue.Pop>) - [func \(q \*EventQueue\) PopEvent\(\) \*Event](<#EventQueue.PopEvent>) - [func \(q \*EventQueue\) Push\(x any\)](<#EventQueue.Push>) - [func \(q \*EventQueue\) PushEvent\(e \*Event\)](<#EventQueue.PushEvent>) - [func \(q EventQueue\) Swap\(i, j int\)](<#EventQueue.Swap>) - [type EventType](<#EventType>) - [type InvariantError](<#InvariantError>) - [func \(e \*InvariantError\) Error\(\) string](<#InvariantError.Error>) - [type MockFossil](<#MockFossil>) - [func NewMockFossil\(r \*repo.Repo\) \*MockFossil](<#NewMockFossil>) - [func \(f \*MockFossil\) Exchange\(ctx context.Context, req \*xfer.Message\) \(\*xfer.Message, error\)](<#MockFossil.Exchange>) - [func \(f \*MockFossil\) Repo\(\) \*repo.Repo](<#MockFossil.Repo>) - [func \(f \*MockFossil\) SetBuggify\(b libsync.BuggifyChecker\)](<#MockFossil.SetBuggify>) - [func \(f \*MockFossil\) StoreArtifact\(data \[\]byte\) \(string, error\)](<#MockFossil.StoreArtifact>) - [type Node](<#Node>) - [type NodeID](<#NodeID>) - [type PeerNetwork](<#PeerNetwork>) - [func NewPeerNetwork\(rng \*rand.Rand\) \*PeerNetwork](<#NewPeerNetwork>) - [func \(n \*PeerNetwork\) AddPeer\(id NodeID, r \*repo.Repo\)](<#PeerNetwork.AddPeer>) - [func \(n \*PeerNetwork\) Heal\(id NodeID\)](<#PeerNetwork.Heal>) - [func \(n \*PeerNetwork\) HealAll\(\)](<#PeerNetwork.HealAll>) - [func \(n \*PeerNetwork\) Partition\(id NodeID\)](<#PeerNetwork.Partition>) - [func \(n \*PeerNetwork\) SetBuggify\(b libsync.BuggifyChecker\)](<#PeerNetwork.SetBuggify>) - [func \(n \*PeerNetwork\) SetDropRate\(rate float64\)](<#PeerNetwork.SetDropRate>) - [func \(n \*PeerNetwork\) Transport\(source, target NodeID\) \*PeerTransport](<#PeerNetwork.Transport>) - [type PeerTransport](<#PeerTransport>) - [func \(t \*PeerTransport\) Exchange\(ctx context.Context, req \*xfer.Message\) \(\*xfer.Message, error\)](<#PeerTransport.Exchange>) - [type SeededBuggify](<#SeededBuggify>) - [func \(b \*SeededBuggify\) Check\(\_ string, probability float64\) bool](<#SeededBuggify.Check>) - [type SimConfig](<#SimConfig>) - [type SimNetwork](<#SimNetwork>) - [func NewSimNetwork\(rng \*rand.Rand, upstream libsync.Transport\) \*SimNetwork](<#NewSimNetwork>) - [func \(n \*SimNetwork\) Heal\(id NodeID\)](<#SimNetwork.Heal>) - [func \(n \*SimNetwork\) HealAll\(\)](<#SimNetwork.HealAll>) - [func \(n \*SimNetwork\) Partition\(id NodeID\)](<#SimNetwork.Partition>) - [func \(n \*SimNetwork\) SetDropRate\(rate float64\)](<#SimNetwork.SetDropRate>) - [func \(n \*SimNetwork\) SetTruncateRate\(rate float64\)](<#SimNetwork.SetTruncateRate>) - [func \(n \*SimNetwork\) Transport\(nodeID NodeID\) \*SimTransport](<#SimNetwork.Transport>) - [type SimTransport](<#SimTransport>) - [func \(t \*SimTransport\) Exchange\(ctx context.Context, req \*xfer.Message\) \(\*xfer.Message, error\)](<#SimTransport.Exchange>) - [type Simulator](<#Simulator>) - [func New\(cfg SimConfig\) \(\*Simulator, error\)](<#New>) - [func \(s \*Simulator\) CheckAllConverged\(master \*repo.Repo\) error](<#Simulator.CheckAllConverged>) - [func \(s \*Simulator\) CheckAllTableSyncConverged\(\) error](<#Simulator.CheckAllTableSyncConverged>) - [func \(s \*Simulator\) CheckAllUVConverged\(master \*repo.Repo\) error](<#Simulator.CheckAllUVConverged>) - [func \(s \*Simulator\) CheckSafety\(\) error](<#Simulator.CheckSafety>) - [func \(s \*Simulator\) CheckTombstoneConvergence\(t \*testing.T, masterRepo \*repo.Repo, tableName string, def repo.TableDef\)](<#Simulator.CheckTombstoneConvergence>) - [func \(s \*Simulator\) Clock\(\) \*simio.SimClock](<#Simulator.Clock>) - [func \(s \*Simulator\) Close\(\) error](<#Simulator.Close>) - [func \(s \*Simulator\) Leaf\(id NodeID\) Node](<#Simulator.Leaf>) - [func \(s \*Simulator\) LeafIDs\(\) \[\]NodeID](<#Simulator.LeafIDs>) - [func \(s \*Simulator\) Network\(\) \*SimNetwork](<#Simulator.Network>) - [func \(s \*Simulator\) Run\(maxSteps int\) error](<#Simulator.Run>) - [func \(s \*Simulator\) RunUntil\(deadline time.Time\) error](<#Simulator.RunUntil>) - [func \(s \*Simulator\) ScheduleSyncNow\(id NodeID\)](<#Simulator.ScheduleSyncNow>) - [func \(s \*Simulator\) ScheduleUVDelete\(id NodeID, at time.Time, name string, mtime int64\)](<#Simulator.ScheduleUVDelete>) - [func \(s \*Simulator\) ScheduleUVWrite\(id NodeID, at time.Time, name string, data \[\]byte, mtime int64\)](<#Simulator.ScheduleUVWrite>) - [func \(s \*Simulator\) SetMasterRepo\(r \*repo.Repo\)](<#Simulator.SetMasterRepo>) - [func \(s \*Simulator\) Step\(\) \(bool, error\)](<#Simulator.Step>) <a name="AllBlobUUIDsSorted"></a> ## func AllBlobUUIDsSorted ```go func AllBlobUUIDsSorted(r *repo.Repo) ([]string, error) ``` AllBlobUUIDsSorted returns a sorted slice of UUIDs for deterministic comparison. <a name="CheckBlobIntegrity"></a> ## func CheckBlobIntegrity ```go func CheckBlobIntegrity(nodeID string, r *repo.Repo) error ``` CheckBlobIntegrity verifies that every blob in the repo has a UUID matching the hash of its expanded content. This catches corruption from buggify \(content.Expand byte\-flip\) or storage bugs. <a name="CheckConvergence"></a> ## func CheckConvergence ```go func CheckConvergence(master *repo.Repo, leaves map[NodeID]*repo.Repo) error ``` CheckConvergence verifies that every leaf repo contains the same set of artifact UUIDs as the master repo. <a name="CheckDeltaChains"></a> ## func CheckDeltaChains ```go func CheckDeltaChains(nodeID string, r *repo.Repo) error ``` CheckDeltaChains verifies that every delta's srcid points to an existing blob \(no dangling references\). <a name="CheckNoOrphanPhantoms"></a> ## func CheckNoOrphanPhantoms ```go func CheckNoOrphanPhantoms(nodeID string, r *repo.Repo) error ``` CheckNoOrphanPhantoms verifies that phantom entries reference blobs that actually exist in the blob table \(they're just missing content\). <a name="CheckSubsetOf"></a> ## func CheckSubsetOf ```go func CheckSubsetOf(master *repo.Repo, leaves map[NodeID]*repo.Repo) error ``` CheckSubsetOf verifies that all artifacts in the master are present in every leaf. Unlike CheckConvergence, this allows leaves to have extra artifacts \(useful when only pull is being tested\). <a name="CheckTableSyncConvergence"></a> ## func CheckTableSyncConvergence ```go func CheckTableSyncConvergence(repos map[string]*repo.Repo) error ``` CheckTableSyncConvergence verifies that all repos have identical rows for every shared synced table. Tables present in some repos but not others are skipped \(schema may still be propagating\). <a name="CheckTableSyncIntegrity"></a> ## func CheckTableSyncIntegrity ```go func CheckTableSyncIntegrity(nodeID string, r *repo.Repo) error ``` CheckTableSyncIntegrity verifies that: 1. Every row in every synced table has a valid PK hash. 2. Every row's mtime is positive. 3. The computed catalog hash is 40 hex chars. <a name="CheckTagxrefIntegrity"></a> ## func CheckTagxrefIntegrity ```go func CheckTagxrefIntegrity(nodeID string, r *repo.Repo) error ``` CheckTagxrefIntegrity verifies that: 1. Every tagxref.rid references a valid blob 2. Every tagxref.tagid references a valid tag 3. Propagated entries \(srcid=0\) have tagtype=2 4. No tagxref.rid references a phantom blob <a name="CheckUVConvergence"></a> ## func CheckUVConvergence ```go func CheckUVConvergence(master *repo.Repo, leaves map[NodeID]*repo.Repo) error ``` CheckUVConvergence verifies that all repos have identical UV content hashes. <a name="CheckUVIntegrity"></a> ## func CheckUVIntegrity ```go func CheckUVIntegrity(nodeID string, r *repo.Repo) error ``` CheckUVIntegrity verifies that every non\-tombstone entry in the unversioned table has a hash matching the SHA1 of its decompressed content, and sz matches the content length. <a name="CountBlobs"></a> ## func CountBlobs ```go func CountBlobs(r *repo.Repo) (int, error) ``` CountBlobs returns the number of non\-phantom blobs in the repo. <a name="HasBlob"></a> ## func HasBlob ```go func HasBlob(r *repo.Repo, uuid string) bool ``` HasBlob checks if a specific artifact exists in the repo. <a name="Action"></a> ## type Action Action is the result of processing a single event via Tick. ```go type Action struct { Type ActionType Result *sync.SyncResult // non-nil when Type == ActionSynced Err error // non-nil on sync failure } ``` <a name="ActionType"></a> ## type ActionType ActionType classifies the result of processing an event. ```go type ActionType int ``` <a name="ActionNone"></a> ```go const ( ActionNone ActionType = iota ActionSynced // a sync round was executed ) ``` <a name="DefaultNode"></a> ## type DefaultNode DefaultNode is a simple Node that calls sync.Sync directly. No NATS, no HTTP — just a repo \+ transport. ```go type DefaultNode struct { // contains filtered or unexported fields } ``` <a name="NewDefaultNode"></a> ### func NewDefaultNode ```go func NewDefaultNode(r *repo.Repo, t sync.Transport, projectCode, serverCode string, opts DefaultNodeOpts) *DefaultNode ``` NewDefaultNode creates a Node backed by sync.Sync. <a name="DefaultNode.Repo"></a> ### func \(\*DefaultNode\) Repo ```go func (n *DefaultNode) Repo() *repo.Repo ``` Repo returns the node's Fossil repository. <a name="DefaultNode.Tick"></a> ### func \(\*DefaultNode\) Tick ```go func (n *DefaultNode) Tick(ctx context.Context, event EventType) Action ``` Tick executes a sync cycle for the given event. <a name="DefaultNodeOpts"></a> ## type DefaultNodeOpts DefaultNodeOpts configures a DefaultNode. ```go type DefaultNodeOpts struct { Push bool Pull bool UV bool XTableSync bool Private bool Buggify sync.BuggifyChecker } ``` <a name="Event"></a> ## type Event Event is a scheduled occurrence in the simulation. ```go type Event struct { Time time.Time Type EventType NodeID NodeID UVName string // for EvUVWrite/EvUVDelete: file name UVData []byte // for EvUVWrite: file content UVMTime int64 // for EvUVWrite/EvUVDelete: mtime } ``` <a name="EventQueue"></a> ## type EventQueue EventQueue is a min\-heap of events ordered by time. ```go type EventQueue []*Event ``` <a name="EventQueue.Len"></a> ### func \(EventQueue\) Len ```go func (q EventQueue) Len() int ``` <a name="EventQueue.Less"></a> ### func \(EventQueue\) Less ```go func (q EventQueue) Less(i, j int) bool ``` <a name="EventQueue.Pop"></a> ### func \(\*EventQueue\) Pop ```go func (q *EventQueue) Pop() any ``` <a name="EventQueue.PopEvent"></a> ### func \(\*EventQueue\) PopEvent ```go func (q *EventQueue) PopEvent() *Event ``` PopEvent removes and returns the earliest event. <a name="EventQueue.Push"></a> ### func \(\*EventQueue\) Push ```go func (q *EventQueue) Push(x any) ``` <a name="EventQueue.PushEvent"></a> ### func \(\*EventQueue\) PushEvent ```go func (q *EventQueue) PushEvent(e *Event) ``` PushEvent adds an event to the queue. <a name="EventQueue.Swap"></a> ### func \(EventQueue\) Swap ```go func (q EventQueue) Swap(i, j int) ``` <a name="EventType"></a> ## type EventType EventType classifies simulation events. ```go type EventType int ``` <a name="EvTimer"></a> ```go const ( EvTimer EventType = iota // leaf poll timer fired EvSyncNow // manual sync trigger for a leaf EvUVWrite // write a UV file to a node's repo EvUVDelete // delete a UV file from a node's repo ) ``` <a name="InvariantError"></a> ## type InvariantError InvariantError records which invariant failed, on which node, and why. ```go type InvariantError struct { Invariant string NodeID string // "master" or leaf ID Detail string } ``` <a name="InvariantError.Error"></a> ### func \(\*InvariantError\) Error ```go func (e *InvariantError) Error() string ``` <a name="MockFossil"></a> ## type MockFossil MockFossil simulates a Fossil master server using the real HandleSync handler. It manages its own repo and implements sync.Transport by dispatching xfer messages to HandleSyncWithOpts. ```go type MockFossil struct { // contains filtered or unexported fields } ``` <a name="NewMockFossil"></a> ### func NewMockFossil ```go func NewMockFossil(r *repo.Repo) *MockFossil ``` NewMockFossil creates a MockFossil backed by the given repo. <a name="MockFossil.Exchange"></a> ### func \(\*MockFossil\) Exchange ```go func (f *MockFossil) Exchange(ctx context.Context, req *xfer.Message) (*xfer.Message, error) ``` Exchange handles one xfer request/response round by delegating to the real HandleSyncWithOpts. This ensures the DST tests exercise the same code path as production servers. <a name="MockFossil.Repo"></a> ### func \(\*MockFossil\) Repo ```go func (f *MockFossil) Repo() *repo.Repo ``` Repo returns the mock fossil's repository \(for seeding and invariants\). <a name="MockFossil.SetBuggify"></a> ### func \(\*MockFossil\) SetBuggify ```go func (f *MockFossil) SetBuggify(b libsync.BuggifyChecker) ``` SetBuggify configures fault injection for the handler. <a name="MockFossil.StoreArtifact"></a> ### func \(\*MockFossil\) StoreArtifact ```go func (f *MockFossil) StoreArtifact(data []byte) (string, error) ``` StoreArtifact adds a raw artifact to the mock fossil's repo. Returns the UUID. Used by tests to seed the master with content. <a name="Node"></a> ## type Node Node represents a sync participant in the simulation. The simulator drives events by calling Tick; the Node executes a sync cycle and reports the result. EdgeSync can implement this by wrapping its agent.Agent; the DST provides a DefaultNode for in\-module testing. ```go type Node interface { Tick(ctx context.Context, event EventType) Action Repo() *repo.Repo } ``` <a name="NodeID"></a> ## type NodeID NodeID identifies a node in the simulation. ```go type NodeID string ``` <a name="PeerNetwork"></a> ## type PeerNetwork PeerNetwork simulates a peer\-to\-peer network where each leaf's Exchange calls HandleSync on the designated peer's repo. No bridge, no central server — pure leaf\-to\-leaf sync under DST control. ```go type PeerNetwork struct { // contains filtered or unexported fields } ``` <a name="NewPeerNetwork"></a> ### func NewPeerNetwork ```go func NewPeerNetwork(rng *rand.Rand) *PeerNetwork ``` NewPeerNetwork creates a simulated peer network. <a name="PeerNetwork.AddPeer"></a> ### func \(\*PeerNetwork\) AddPeer ```go func (n *PeerNetwork) AddPeer(id NodeID, r *repo.Repo) ``` AddPeer registers a leaf's repo as a sync target for other leaves. <a name="PeerNetwork.Heal"></a> ### func \(\*PeerNetwork\) Heal ```go func (n *PeerNetwork) Heal(id NodeID) ``` Heal removes a node from the partition set. <a name="PeerNetwork.HealAll"></a> ### func \(\*PeerNetwork\) HealAll ```go func (n *PeerNetwork) HealAll() ``` HealAll removes all partitions. <a name="PeerNetwork.Partition"></a> ### func \(\*PeerNetwork\) Partition ```go func (n *PeerNetwork) Partition(id NodeID) ``` Partition isolates a node — all messages to/from it are dropped. <a name="PeerNetwork.SetBuggify"></a> ### func \(\*PeerNetwork\) SetBuggify ```go func (n *PeerNetwork) SetBuggify(b libsync.BuggifyChecker) ``` SetBuggify configures fault injection for the handler. <a name="PeerNetwork.SetDropRate"></a> ### func \(\*PeerNetwork\) SetDropRate ```go func (n *PeerNetwork) SetDropRate(rate float64) ``` SetDropRate sets the probability that any message is dropped. <a name="PeerNetwork.Transport"></a> ### func \(\*PeerNetwork\) Transport ```go func (n *PeerNetwork) Transport(source, target NodeID) *PeerTransport ``` Transport returns a sync.Transport for the given source node that routes to a specific target peer's HandleSync. <a name="PeerTransport"></a> ## type PeerTransport PeerTransport implements sync.Transport by routing through the PeerNetwork to a specific target peer. ```go type PeerTransport struct { // contains filtered or unexported fields } ``` <a name="PeerTransport.Exchange"></a> ### func \(\*PeerTransport\) Exchange ```go func (t *PeerTransport) Exchange(ctx context.Context, req *xfer.Message) (*xfer.Message, error) ``` Exchange sends a request through the peer network to the target's HandleSync. <a name="SeededBuggify"></a> ## type SeededBuggify SeededBuggify implements sync.BuggifyChecker with a deterministic PRNG. ```go type SeededBuggify struct { // contains filtered or unexported fields } ``` <a name="SeededBuggify.Check"></a> ### func \(\*SeededBuggify\) Check ```go func (b *SeededBuggify) Check(_ string, probability float64) bool ``` Check returns true with the given probability, using the seeded PRNG. <a name="SimConfig"></a> ## type SimConfig SimConfig configures a simulation run. ```go type SimConfig struct { Seed int64 NumLeaves int PollInterval time.Duration TmpDir string // directory for repo files Upstream libsync.Transport // mock Fossil master Buggify bool // enable BUGGIFY fault injection UV bool // sync unversioned files Private bool // sync private artifacts SafetyCheckInterval int // run CheckSafety() every N steps; 0 = disabled } ``` <a name="SimNetwork"></a> ## type SimNetwork SimNetwork simulates the network between leaf agents and the upstream transport \(mock Fossil master\). It supports message dropping, response truncation, and network partitions, controlled by a seeded PRNG for deterministic behavior. In the original EdgeSync DST, messages routed through a Bridge that forwarded to the upstream. Since Bridge.HandleRequest was just upstream.Exchange, SimNetwork now calls the upstream directly. ```go type SimNetwork struct { // contains filtered or unexported fields } ``` <a name="NewSimNetwork"></a> ### func NewSimNetwork ```go func NewSimNetwork(rng *rand.Rand, upstream libsync.Transport) *SimNetwork ``` NewSimNetwork creates a simulated network connected to the given upstream transport. <a name="SimNetwork.Heal"></a> ### func \(\*SimNetwork\) Heal ```go func (n *SimNetwork) Heal(id NodeID) ``` Heal removes a node from the partition set. <a name="SimNetwork.HealAll"></a> ### func \(\*SimNetwork\) HealAll ```go func (n *SimNetwork) HealAll() ``` HealAll removes all partitions. <a name="SimNetwork.Partition"></a> ### func \(\*SimNetwork\) Partition ```go func (n *SimNetwork) Partition(id NodeID) ``` Partition isolates a node — all messages to/from it are dropped. <a name="SimNetwork.SetDropRate"></a> ### func \(\*SimNetwork\) SetDropRate ```go func (n *SimNetwork) SetDropRate(rate float64) ``` SetDropRate sets the probability that any message is dropped entirely. <a name="SimNetwork.SetTruncateRate"></a> ### func \(\*SimNetwork\) SetTruncateRate ```go func (n *SimNetwork) SetTruncateRate(rate float64) ``` SetTruncateRate sets the probability that a response is truncated \(random suffix of cards dropped\). Simulates partial delivery. <a name="SimNetwork.Transport"></a> ### func \(\*SimNetwork\) Transport ```go func (n *SimNetwork) Transport(nodeID NodeID) *SimTransport ``` Transport returns a sync.Transport for the given node that routes messages through this simulated network to the upstream. <a name="SimTransport"></a> ## type SimTransport SimTransport implements sync.Transport by routing through the SimNetwork. ```go type SimTransport struct { // contains filtered or unexported fields } ``` <a name="SimTransport.Exchange"></a> ### func \(\*SimTransport\) Exchange ```go func (t *SimTransport) Exchange(ctx context.Context, req *xfer.Message) (*xfer.Message, error) ``` Exchange sends a request through the simulated network to the upstream. <a name="Simulator"></a> ## type Simulator Simulator drives a deterministic simulation of multiple leaf nodes syncing through a simulated network to an upstream transport \(mock Fossil master\). ```go type Simulator struct { Seed int64 // Stats Steps int TotalSyncs int TotalErrors int TotalUVSent int TotalUVRecvd int TotalUVGimmes int // contains filtered or unexported fields } ``` <a name="New"></a> ### func New ```go func New(cfg SimConfig) (*Simulator, error) ``` New creates a Simulator with the given configuration. It creates leaf repos, nodes, and the simulated network. All I/O is local SQLite — no NATS or HTTP connections are made. <a name="Simulator.CheckAllConverged"></a> ### func \(\*Simulator\) CheckAllConverged ```go func (s *Simulator) CheckAllConverged(master *repo.Repo) error ``` CheckAllConverged checks convergence between master and all leaves. Only meaningful after a fault\-free sync period. <a name="Simulator.CheckAllTableSyncConverged"></a> ### func \(\*Simulator\) CheckAllTableSyncConverged ```go func (s *Simulator) CheckAllTableSyncConverged() error ``` CheckAllTableSyncConverged checks table sync convergence across all nodes. <a name="Simulator.CheckAllUVConverged"></a> ### func \(\*Simulator\) CheckAllUVConverged ```go func (s *Simulator) CheckAllUVConverged(master *repo.Repo) error ``` CheckAllUVConverged checks UV convergence between master and all leaves. <a name="Simulator.CheckSafety"></a> ### func \(\*Simulator\) CheckSafety ```go func (s *Simulator) CheckSafety() error ``` CheckSafety runs all safety invariants on every node in the simulation. <a name="Simulator.CheckTombstoneConvergence"></a> ### func \(\*Simulator\) CheckTombstoneConvergence ```go func (s *Simulator) CheckTombstoneConvergence(t *testing.T, masterRepo *repo.Repo, tableName string, def repo.TableDef) ``` CheckTombstoneConvergence verifies that all nodes agree on which rows are tombstones for each synced table. Two nodes may have different catalog hashes during convergence, but once converged, their tombstone sets must match. <a name="Simulator.Clock"></a> ### func \(\*Simulator\) Clock ```go func (s *Simulator) Clock() *simio.SimClock ``` Clock returns the simulator's virtual clock. <a name="Simulator.Close"></a> ### func \(\*Simulator\) Close ```go func (s *Simulator) Close() error ``` Close cleans up all leaf node repos and disables buggify. Iterates leafIDs \(not map\) for deterministic error reporting. <a name="Simulator.Leaf"></a> ### func \(\*Simulator\) Leaf ```go func (s *Simulator) Leaf(id NodeID) Node ``` Leaf returns the node for the given node ID. <a name="Simulator.LeafIDs"></a> ### func \(\*Simulator\) LeafIDs ```go func (s *Simulator) LeafIDs() []NodeID ``` LeafIDs returns the ordered list of leaf node IDs. <a name="Simulator.Network"></a> ### func \(\*Simulator\) Network ```go func (s *Simulator) Network() *SimNetwork ``` Network returns the simulated network for fault injection. <a name="Simulator.Run"></a> ### func \(\*Simulator\) Run ```go func (s *Simulator) Run(maxSteps int) error ``` Run processes up to maxSteps events. Returns nil on success or the first invariant/error encountered. <a name="Simulator.RunUntil"></a> ### func \(\*Simulator\) RunUntil ```go func (s *Simulator) RunUntil(deadline time.Time) error ``` RunUntil processes events until the clock reaches the given time. <a name="Simulator.ScheduleSyncNow"></a> ### func \(\*Simulator\) ScheduleSyncNow ```go func (s *Simulator) ScheduleSyncNow(id NodeID) ``` ScheduleSyncNow injects a SyncNow event for the given leaf at the current time. <a name="Simulator.ScheduleUVDelete"></a> ### func \(\*Simulator\) ScheduleUVDelete ```go func (s *Simulator) ScheduleUVDelete(id NodeID, at time.Time, name string, mtime int64) ``` ScheduleUVDelete injects a UV delete event for the given node at the specified time. <a name="Simulator.ScheduleUVWrite"></a> ### func \(\*Simulator\) ScheduleUVWrite ```go func (s *Simulator) ScheduleUVWrite(id NodeID, at time.Time, name string, data []byte, mtime int64) ``` ScheduleUVWrite injects a UV write event for the given node at the specified time. <a name="Simulator.SetMasterRepo"></a> ### func \(\*Simulator\) SetMasterRepo ```go func (s *Simulator) SetMasterRepo(r *repo.Repo) ``` SetMasterRepo registers the master repo for UV events targeting "master". <a name="Simulator.Step"></a> ### func \(\*Simulator\) Step ```go func (s *Simulator) Step() (bool, error) ``` Step processes the next event in the queue. Returns false if the queue is empty. Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)