# @node-lightning/wire

> Lightning Network Wire Protocol

Latest version **0.28.0** (published 2022-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @node-lightning/wire
pnpm add @node-lightning/wire
yarn add @node-lightning/wire
bun add @node-lightning/wire
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.28.0 |
| Published | 2022-11-07 |
| First published | 2020-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 3.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 137 |
| Author | Brian Mancini |
| Maintainers | bmancini55 |
| Keywords | lightning, network, bolt2, bolt7, wire protocol, lightning-network |

## Links

- npm: https://www.npmjs.com/package/@node-lightning/wire
- Repository: https://github.com/altangent/node-lightning
- Homepage: https://github.com/altangent/node-lightning/tree/master/packages/wire
- Issues: https://github.com/altangent/node-lightning/issues
- npm.io page: https://npm.io/package/@node-lightning/wire

## Dependencies (7)

- [bech32](https://npm.io/package/bech32.md) ^1.1.3
- [@node-lightning/core](https://npm.io/package/@node-lightning/core.md) ^0.28.0
- [@node-lightning/bufio](https://npm.io/package/@node-lightning/bufio.md) ^0.28.0
- [@node-lightning/noise](https://npm.io/package/@node-lightning/noise.md) ^0.28.0
- [@node-lightning/crypto](https://npm.io/package/@node-lightning/crypto.md) ^0.28.0
- [@node-lightning/logger](https://npm.io/package/@node-lightning/logger.md) ^0.28.0
- [@node-lightning/checksum](https://npm.io/package/@node-lightning/checksum.md) ^0.28.0

## Recent versions

- 0.28.0 (latest) — 2022-11-07
- 0.27.4 — 2022-09-16
- 0.27.2 — 2022-09-16
- 0.27.0 — 2022-01-10
- 0.26.1 — 2021-10-06
- 0.26.0 — 2021-10-06
- 0.25.0 — 2021-10-04
- 0.24.1 — 2021-09-27
- 0.24.0 — 2021-09-15
- 0.23.0 — 2021-09-13
- 0.23.0-alpha.0 — 2021-07-29
- 0.22.1 — 2021-04-30
- 0.22.0 — 2021-04-09
- 0.21.1 — 2021-02-18
- 0.21.0 — 2021-02-18
- … 3 more at https://npm.io/package/@node-lightning/wire/versions

## README

# `@node-lightning/wire`

This repository contains the wire protocol code for the Lightning Network and
includes the following functionality:

-   Peer which manages a connection to a peer. This class allows sending and
    emitting message traffic. It also manages internal state for Ping/Pong message
    traffic. [/lib/peer.ts](lib/peer.ts)

-   Messages defined in BOLT #1 - Base Protocol, BOLT #2 - Peer Protocol for
    Channel Management, and BOLT #7 P2P Node and Channel Discovery can be
    found in [/lib/messages](/lib/messages). This code includes the message
    types and serialization and deserialization methods for each message.

-   P2P Node and Channel gossip management that can be found in
    [/lib/gossip](/lib/gossip). This code contains the
    [GossipManger](/lib/gossip/gossip-manager) which controls gossip for many
    peers. Gossip synchronization for a single peer is managed through
    [PeerGossipSynchronizer](/lib/gossip/peer-gossip-synchronizer).

---
_Source: https://npm.io/package/@node-lightning/wire · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._