https://github.com/p2panda/p2panda

All the things a panda needs
https://github.com/p2panda/p2panda

cargo npm rust typescript utility-library wasm

Last synced: 3 months ago
JSON representation

All the things a panda needs

• Host: GitHub
• URL: https://github.com/p2panda/p2panda
• Owner: p2panda
• License: agpl-3.0
• Created: 2020-10-12T16:30:51.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-07T07:48:45.000Z (3 months ago)
• Last Synced: 2024-08-07T14:51:57.162Z (3 months ago)
• Topics: cargo, npm, rust, typescript, utility-library, wasm
• Language: Rust
• Homepage:
• Size: 2.3 MB
• Stars: 168
• Watchers: 10
• Forks: 8
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - p2panda/p2panda - All the things a panda needs (typescript)

README

        
p2panda




  

  All the things a panda needs

  








  

  

    

  

  

  

    

  

  

  

    

  

  

  

    

  





  


    

      Installation

    

     | 

    

      Releases

    

     | 

    

      Contribute

    

     | 

    

      Website

    

  






This library provides all tools required to write a client, node or even your

own protocol implementation for the [`p2panda`] network. It is shipped both as

a Rust crate [`p2panda-rs`] with WebAssembly bindings and a NPM package

[`p2panda-js`] with TypeScript definitions running in NodeJS or any modern web

browser.

> The core p2panda [`specification`] is fully functional but still under review

> so please be prepared for breaking API changes until we reach `v1.0`.

> Currently no p2panda implementation has recieved a security audit.

[`specification`]: https://p2panda.org/specifications

## Features

- Generate Ed25519 key pairs.

- Create and encode [`Bamboo`] entries.

- Publish schemas and validate data.

- Create, update and delete data collaboratively.

- Encrypt data with [`OpenMLS`].

- Materialise documents from data changes.

- Prepare data for [`node`] servers.

[`Bamboo`]: https://github.com/AljoschaMeyer/bamboo

[`node`]: https://github.com/p2panda/aquadoggo

[`OpenMLS`]: https://github.com/openmls/openmls

## Usage

```javascript

import { KeyPair } from "p2panda-js";

const keyPair = new KeyPair();

console.log(keyPair.publicKey());

```

```rust

use p2panda_rs::identity::KeyPair;

let key_pair = KeyPair::new();

println!("{}", key_pair.public_key());

```

See [the demo application](https://p2panda.org) and its [source

code](https://github.com/p2panda/zoo-adventures). More examples can be found in the

[`p2panda-rs`] and [`p2panda-js`] directories.

## Installation

If you are using `p2panda` in web browsers or NodeJS applications run:

```bash

$ npm i p2panda-js

```

For Rust environments run:

```bash

$ cargo add p2panda-rs

```

## Documentation

Visit the corresponding folders for development instructions and documentation:

- [`p2panda-rs`]

- [`p2panda-js`]

## Benchmarks

Performance benchmarks can be found in [benches](/p2panda-rs/benchmarks). You

can run them using

[`cargo-criterion`](https://crates.io/crates/cargo-criterion):

```bash

$ cargo install cargo-criterion

$ cargo criterion

# An HTML report with plots is generated automatically

$ open target/criterion/reports/index.html

```

These benchmarks  can be used to compare the performance across branches by

running them first in a base branch and then in the comparison branch. The

HTML-reports will include a comparison of the two results.

## License

GNU Affero General Public License v3.0 [`AGPL-3.0-or-later`](LICENSE)

## Supported by









*This project has received funding from the European Union’s Horizon 2020

research and innovation programme within the framework of the NGI-POINTER

Project funded under grant agreement No 871528 and NGI-ASSURE No 957073*

[`p2panda`]: https://p2panda.org

[`p2panda-rs`]: https://github.com/p2panda/p2panda/tree/main/p2panda-rs

[`p2panda-js`]: https://github.com/p2panda/p2panda/tree/main/p2panda-js