# @libp2p/interface

> The interface implemented by a libp2p node

Latest version **3.3.0** (published 2026-08-23) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @libp2p/interface
pnpm add @libp2p/interface
yarn add @libp2p/interface
bun add @libp2p/interface
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.3.0 |
| Published | 2026-08-23 |
| First published | 2023-06-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 6 |
| Unpacked size | 448.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Maintainers | daviddias, alanshaw, achingbrain, vascosantos, npm-service-account-libp2p, jacobheun |
| Keywords | interface, libp2p |

## Links

- npm: https://www.npmjs.com/package/@libp2p/interface
- Repository: https://github.com/libp2p/js-libp2p
- Homepage: https://github.com/libp2p/js-libp2p/tree/main/packages/interface#readme
- Issues: https://github.com/libp2p/js-libp2p/issues
- npm.io page: https://npm.io/package/@libp2p/interface

## Dependencies (6)

- [main-event](https://npm.io/package/main-event.md) ^1.0.1
- [multiformats](https://npm.io/package/multiformats.md) ^14.0.0
- [uint8arraylist](https://npm.io/package/uint8arraylist.md) ^3.0.2
- [progress-events](https://npm.io/package/progress-events.md) ^1.1.0
- [@multiformats/dns](https://npm.io/package/@multiformats/dns.md) ^1.0.6
- [@multiformats/multiaddr](https://npm.io/package/@multiformats/multiaddr.md) ^13.0.3

## Recent versions

- 3.3.0 (latest) — 2026-08-23
- 3.3.0-776cdedf6 (next) — 2026-09-27
- 3.3.0-e7359e5f6 — 2026-09-27
- 3.3.0-2f63792c7 — 2026-09-27
- 3.3.0-fb139d1c8 — 2026-09-23
- 3.3.0-d91797b55 — 2026-09-16
- 3.3.0-5cb617ae2 — 2026-09-02
- 3.3.0-185d901cd — 2026-09-02
- 3.3.0-cef4d32cf — 2026-08-31
- 3.3.0-ac7305ccf — 2026-08-31
- 3.3.0-87dca02b0 — 2026-08-27
- 3.3.0-4a6c5d11a — 2026-08-27
- 3.2.5-947d304ed — 2026-08-22
- 3.2.5-0967e75f5 — 2026-08-22
- 3.2.5-4dae661b4 — 2026-08-22
- … 849 more at https://npm.io/package/@libp2p/interface/versions

## README

# @libp2p/interface

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)

> The interface implemented by a libp2p node

# About

<!--

!IMPORTANT!

Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.

To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts

To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.

-->

Exports a `Libp2p` type for modules to use as a type argument.

## Example

```typescript
import type { Libp2p } from '@libp2p/interface'

function doSomethingWithLibp2p (node: Libp2p) {
  // ...
}
```

# Install

```console
$ npm i @libp2p/interface
```

# API Docs

- <https://libp2p.github.io/js-libp2p/modules/_libp2p_interface.html>

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

# Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

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