A collection of js-libp2p examples

Explore the docs · Report Bug · Request Feature/Example

Table of Contents

• Table of Contents
• About The Project
• Getting Started
  • Examples
    • Understanding how libp2p works
    • Other examples
    • libp2p in the Browser
  • Prerequisites
• Documentation
• Contribute
• License

About The Project

• Read the docs
• Look into other examples to learn how to spawn a Helia node in Node.js and in the Browser
• Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
• Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
• Check out https://docs.ipfs.io for tips, how-tos and more
• See https://blog.ipfs.io for news and more
• Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io

Getting Started

Examples

Feel free to jump directly into the examples, however going through the following sections will help build context and background knowledge.

Understanding how libp2p works

• Circuit Relay - configuring Circuit Relay connections
• Connection Encryption - how to encrypt connection between libp2p nodes
• Delegated routing - how to offload network operations and queries onto more capable nodes
• Discovery mechanisms - how libp2p discovers other peers on the network
• Custom protocols - how to create a custom protocol for your application

Other examples

• Chat - a simple chat app
• Browser Pub/Sub - Using Pub/Sub between browsers

libp2p in the Browser

There are a number of ways libp2p can be used in the browser. Here are some examples:

• webRTC
• websockets
• webtransport

There is also an tutorial of how all of these transports can be universally connected

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• Node.js - Download & Install Node.js and the npm package manager.

Documentation

• js-libp2p docs
• libp2p.io
• docs.libp2p.io
• Specification (WIP)
• Discussion Forums
• Talks
  • libp2p <3 ethereum at DEVCON2
• Articles
  • The overview of libp2p

Contribute

See CONTRIBUTING.md.

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)