Skip to content

README.md

Latest commit

 

History

History
45 lines (33 loc) · 1.27 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.27 KB
Raw

common

ci codecov License: AGPL-3.0

Shared Go helpers for the Pilot Protocol. A small, pure-stdlib library with subpackages for durable file writes (fsutil) and Ed25519 identity operations (crypto).

Install

import (
    "github.com/pilot-protocol/common/fsutil"
    "github.com/pilot-protocol/common/crypto"
)

Usage

// Atomic file write — temp file + fsync + rename.
if err := fsutil.AtomicWrite(path, blob); err != nil {
    return err
}

// Ed25519 keypair + node-ID derivation.
id, err := crypto.NewIdentity()
sig := id.Sign(msg)
ok := crypto.Verify(id.PublicKey, msg, sig)

Layout

Package What it does
fsutil AtomicWrite(path, data), AppendSync(path, data) — durable file writes.
crypto Identity — Ed25519 keypair + node-ID derivation, signing, verification.

License

AGPL-3.0-or-later. See LICENSE.

// fix typo in docs