shard-common

module

v0.10.1 Latest Latest Go to latest Published: May 28, 2026 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lightwebinc/shard-common

Links

Open Source Insights

README ¶

shard-common

Shared protocol primitives for the BSV transaction sharding pipeline. Imported by shard-proxy, shard-listener, retry-endpoint, and subtx-generator.

Packages

Package	Purpose
`frame`	Wire format codec: BRC-12/124/128 frames, BRC-127 announce, BRC-130 fragments, BRC-131 blocks, BRC-132 subtree data, BRC-134 anchor txs, BRC-135 block headers, BRC-137 shard manifest
`shard`	TxID → IPv6 multicast group derivation (consistent-hash); control groups
`seqhash`	XXH64 per-flow HashKey computation
`sequence`	Per-shard monotonic counters (`sync/atomic`, zero-alloc)
`txidset`	Two-tier TxID dedup (LRU + optional Redis SETNX); fail-open on Redis errors

Documentation

Wire Protocol Specification — BRC-124/BRC-128 frame format, legacy BRC-12, shard derivation, proxy forward rules

Requirements

Go 1.25 or later

Build

go build ./...
go test ./...

License

Apache 2.0 — see LICENSE.

Directories ¶

Path	Synopsis
frame BRC-135 block header frame encode/decode.	BRC-135 block header frame encode/decode.
seqhash Package seqhash provides the hash function used to compute HashKey values in BRC-124/BRC-128 frames.	Package seqhash provides the hash function used to compute HashKey values in BRC-124/BRC-128 frames.
sequence Package sequence provides per-shard monotonic sequence counters.	Package sequence provides per-shard monotonic sequence counters.
shard Package shard derives IPv6 multicast group addresses from BSV transaction IDs for deterministic packet-level sharding across the BSV sharding pipeline.	Package shard derives IPv6 multicast group addresses from BSV transaction IDs for deterministic packet-level sharding across the BSV sharding pipeline.
txidset Package txidset implements a two-tier TxID claim store used by both the proxy ingress dedup gate and the listener per-deployment egress dedup gate.	Package txidset implements a two-tier TxID claim store used by both the proxy ingress dedup gate and the listener per-deployment egress dedup gate.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL