Pear by Holepunch
Pear loads applications remotely from peers and allows anyone to create and share applications with peers.
Pear by Holepunch is a combined Peer-to-Peer (P2P) Runtime, Development & Deployment tool.
Build, share & extend unstoppable, zero-infrastructure P2P applications for Desktop, Terminal & Mobile.
Welcome to the Internet of Peers
– Holepunch, the P2P Company
Table of Contents
Pear runtime
References for utilizing the Pear runtime.
Guides
Guides on using the pear runtime to build and share P2P applications.
- Getting Started
- Starting a Pear Desktop Project
- Making a Pear Desktop Application
- Starting a Pear Terminal Project
- Making a Pear Terminal Application
- Sharing a Pear Application
- Releasing a Pear Application
Building blocks
The essential building blocks for building powerful P2P applications using Pear.
hypercore: A distributed, secure append-only log for creating fast and scalable applications without a backend, as it is entirely P2P.hyperbee: An append-only B-tree based on Hypercore. It provides a key/value-store API with methods to insert and get key/value pairs, perform atomic batch insertions, and create sorted iterators.hyperdrive: A secure, real-time distributed file system that simplifies P2P file sharing that provides an efficient way to store and access data across multiple connected devices in a decentralized manner.autobase: A "virtual Hypercore" layer over many Hypercores owned by many different peers.hyperdht: The Distributed Hash Table (DHT) powering Hyperswarm. Through this DHT, each server is bound to a unique key pair, with the client connecting to the server using the server's public key.hyperswarm: A high-level API for finding and connecting to peers who are interested in a "topic".
How-tos
Simple How-tos on using the essential builing blocks in Pear applications.
- How to connect two peers by key with HyperDHT
- How to connect to many peers by topic with Hyperswarm
- How to replicate and persist with Hypercore
- How to work with many Hypercores using Corestore
- How to share append-only databases with Hyperbee
- How to create a full peer-to-peer filesystem with Hyperdrive
Helpers
Helper modules can be used together with the building blocks to create cutting-edge P2P tools and applications.
corestore: A Hypercore factory designed to facilitate the management of sizable named Hypercore collections.localdrive: A file system interoperable with Hyperdrive.mirrordrive: Mirror ahyperdriveor alocaldriveinto another one.secretstream: SecretStream is used to securely create connections between two peers in Hyperswarm.compact-encoding: A series of binary encoding schemes for building fast and small parsers and serializers. We use this in Keet to store chat messages and in Hypercore's replication protocol.protomux: Multiplex multiple message oriented protocols over a stream.
Tools
The following tools are used extensively employed in the day-to-day development and operation of applications built on Pear.
- Hypershell: A CLI to create and connect to P2P E2E encrypted shells.
- Hypertele: A swiss-knife proxy powered by HyperDHT.
- Hyperbeam: A one-to-one and end-to-end encrypted internet pipe.
- Hyperssh: A CLI to run SSH over the HyperDHT.
- Drives: CLI to download, seed, and mirror a hyperdrive or a localdrive.
Apps
Applications built using Pear.
- Keet: A peer-to-peer chat and video-conferencing application with end-to-end encryption.
Stability indexing
Throughout the documentation, indications of stability are provided. Some modules are well-established and used widely, making them highly unlikely to ever change. Other modules may be new, experimental, or known to have risks associated with their use.
The following stability indices have been used:
| Stability | Description |
|---|---|
| stable | Unlikely to change or be removed in the foreseeable future. |
| experimental | New, untested, or have known issues. |
| deprecated | Being removed or replaced in the future. |
| unstable | May change or be removed without warning. |