The highest tagged major version is
Documentation
¶
Overview ¶
Package pcodecs is the canonical construction site for every codec.Manager + codec instance under node/vms. Wave 2G-Internal of the codec rip (#101) replaces the previous direct imports of github.com/luxfi/codec / linearcodec / zapcodec with a single import of github.com/luxfi/proto/zap_codec — the proto-layer wire codec entry point established in Wave 2G-Wallet.
Layout:
- Type aliases re-export the proto/zap_codec surfaces every VM consumer needs (Manager, Registry, LinearCodec, ZAPCodec, Errs, Packer, VersionSize, sentinel errors).
- Constructor helpers return fresh Manager / Codec instances at canonical size budgets (Default, MaxInt32, MaxInt, Sized). They are wire-agnostic — each VM's own codec.go layer registers its type set on top.
pcodecs has NO knowledge of any specific VM's type set. VM-specific registration stays in the VM's own codec.go (e.g. vms/platformvm/txs/codec.go). This split keeps pcodecs a leaf package — every node/vms subpackage is free to import it without closing an import cycle.
Wire format: ZAP-native (little-endian) — the underlying impl is luxfi/codec/zapcodec routed through proto/zap_codec. The "Linear" name on LinearCodec / NewLinearCodec refers to LINEAR TYPE-ID ASSIGNMENT (sequential ids assigned in registration order), NOT to the historical linearcodec big-endian wire format. Activation per LP-023 (proto/zap_native/codec_select.go: ZAPActivationUnix=0).
Index ¶
Constants ¶
const BoolLen = zap_codec.BoolLen
BoolLen is the on-wire length of a bool (1 byte).
const ByteLen = zap_codec.ByteLen
ByteLen is the on-wire length of a uint8 (1 byte).
const IntLen = zap_codec.IntLen
IntLen is the on-wire length of a uint32 (4 bytes). Used by p2p response-size accounting code.
const LongLen = zap_codec.LongLen
LongLen is the on-wire length of a uint64 (8 bytes). Used by index code to size cursor buffers.
const ShortLen = zap_codec.ShortLen
ShortLen is the on-wire length of a uint16 (2 bytes).
const VersionSize = zap_codec.VersionSize
VersionSize is the on-wire length of the codec-version prefix (2 bytes). VM fee-complexity calculations subtract this from observed byte sizes to isolate the payload component.
Variables ¶
var ( ErrCantPackVersion = zap_codec.ErrCantPackVersion ErrCantUnpackVersion = zap_codec.ErrCantUnpackVersion ErrUnknownVersion = zap_codec.ErrUnknownVersion ErrMaxSliceLenExceeded = zap_codec.ErrMaxSliceLenExceeded ErrMarshalNil = zap_codec.ErrMarshalNil ErrUnmarshalNil = zap_codec.ErrUnmarshalNil ErrDoesNotImplementInterface = zap_codec.ErrDoesNotImplementInterface ErrExtraSpace = zap_codec.ErrExtraSpace ErrInsufficientLength = zap_codec.ErrInsufficientLength )
Sentinel errors re-exported from proto/zap_codec so VM packages can assert on them without importing proto/zap_codec themselves.
Functions ¶
This section is empty.
Types ¶
type Errs ¶
Errs is the multi-error accumulator used by per-VM codec.go files that fan in many RegisterCodec / RegisterType calls under a single error tap.
type LinearCodec ¶
type LinearCodec = zap_codec.LinearCodec
LinearCodec is the union of Registry + Codec + SkipRegistrations. Used by VMs that need SkipRegistrations on their per-version codec to preserve historical type-id slot layouts (Apricot / Banff / Durango / Quasar registration sequences).
Despite the name, this codec is backed by luxfi/codec/zapcodec — the "Linear" refers to LINEAR TYPE-ID ASSIGNMENT, not to the legacy linearcodec big-endian wire layout.
func NewLinearCodec ¶
func NewLinearCodec() LinearCodec
NewLinearCodec returns a fresh ZAP-native Codec instance with the default ("serialize") struct tag. The "Linear" name refers to LINEAR TYPE-ID ASSIGNMENT (sequential ids assigned in registration order), NOT to the legacy linearcodec big-endian wire format.
func NewLinearCodecWithTags ¶
func NewLinearCodecWithTags(tags ...string) LinearCodec
NewLinearCodecWithTags returns a fresh ZAP-native Codec instance that honours the supplied struct-tag names. Used by the metadata codec wiring where v0:"true" / v1:"true" tags select per-version field sets.
type Manager ¶
type Manager = zap_codec.MultiManager
Manager is the multi-version wire codec surface every node/vms consumer holds. Aliased to zap_codec.MultiManager so the rest of node/vms references pcodecs.Manager rather than reaching into proto/zap_codec or luxfi/codec directly.
func NewDefaultManager ¶
func NewDefaultManager() Manager
NewDefaultManager returns a fresh multi-version Manager with the default 1 MiB wire-payload size.
func NewManager ¶
NewManager returns a fresh multi-version Manager with the supplied max wire-payload size.
func NewMaxInt32Manager ¶
func NewMaxInt32Manager() Manager
NewMaxInt32Manager returns a fresh multi-version Manager sized for genesis-style blobs (math.MaxInt32 budget). VM genesis codec wiring reaches for this rather than re-deriving the budget at every call site.
func NewMaxIntManager ¶
func NewMaxIntManager() Manager
NewMaxIntManager returns a fresh multi-version Manager sized for warp / proposervm-block style payloads (math.MaxInt budget — effectively unbounded). The p2p layer caps real-world wire sizes well below this.
type Packer ¶
Packer is the wire-byte packer used by VM tests that drive MarshalInto / UnmarshalFrom byte streams directly.
type Registry ¶
Registry is the type-registration surface. Aliased to zap_codec.Registry — structurally identical to the legacy codec.Registry interface (RegisterType only).
type ZAPCodec ¶
ZAPCodec is an explicit alias for the same zapcodec-backed Codec surface — used by post-cutover wire layouts (currently platformvm txs V2) that want to emphasise the ZAP-native wire layout. Same backing type as LinearCodec; the alias exists for readability.
func NewZAPCodec ¶
func NewZAPCodec() ZAPCodec
NewZAPCodec returns a fresh ZAP-native Codec instance. Alias for NewLinearCodec — both return the same zapcodec-backed Codec; the name exists for call sites that want to emphasise the ZAP-native wire layout (e.g. platformvm txs V2).
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package pcodecsmock provides a gomock-driven mock of the pcodecs.Manager interface (= proto/zap_codec.MultiManager) so node/vms test files can program codec expectations without importing proto/zap_codec or luxfi/codec directly.
|
Package pcodecsmock provides a gomock-driven mock of the pcodecs.Manager interface (= proto/zap_codec.MultiManager) so node/vms test files can program codec expectations without importing proto/zap_codec or luxfi/codec directly. |