# p2panda-go

[![Build Status](https://build.coopcloud.tech/api/badges/decentral1se/p2panda-go/status.svg?ref=refs/heads/main)](https://build.coopcloud.tech/decentral1se/p2panda-go)

> **WARNING** Highly Experimental ™️

Go FFI bindings for `p2panda` via [`p2panda-ffi`](https://github.com/p2panda/p2panda-ffi).

## Version support

* `p2panda`: [`v0.7.0`](https://github.com/p2panda/p2panda/releases/tag/v0.7.0)
* `p2panda-ffi`: [`decentral1se/p2panda-ffi@71d27e5`](https://github.com/decentral1se/p2panda-ffi/commit/71d27e537f24ae1656b2fbd358f8d38187a9d504)

## Platform support

> **NOTE** More platform can be provided on request and pending some support to
> build binaries for specific architectures. If you would like to help out,
> please let us know! See [`#2`](https://git.coopcloud.tech/decentral1se/p2panda/issues/2)
> and [`#1`](https://git.coopcloud.tech/decentral1se/iroh-go/issues/1) for more.

* `x86_64-unknown-linux-musl`
* `aarch64-unknown-linux-musl`

## Documentation

See [`docs.rs`](https://docs.rs/p2panda/latest/p2panda/) for the original Rust
API documentation. The exposed Go API is not 1:1 and is determined by what is
exposed [in the `p2panda-ffi`
wrapper](https://github.com/p2panda/p2panda-ffi/tree/main/src). Here's the Go
bindings documentation on
[`godocs.io`](https://godocs.io/git.coopcloud.tech/decentral1se/p2panda-go).

## Examples

See [`examples`](./examples).

## Generate bindings

See [`p2panda-go`](./p2panda-go) for the Rust toolchain configuration. Run
`./scripts/generate.sh` to build a new set of libraries which end up vendored
in [`libs`](./libs).

## Who is using it?

> **NOTE** Please add your own if you're using `p2panda-go` :pray:

* [`pandadraw`](https://git.coopcloud.tech/decentral1se/pandadraw)

## Known issues

* We patched the upstream `p2panda-ffi` `Cargo.toml` to remove the `crate-type`
  configuration when runnings builds here. See [this
  commit](https://github.com/decentral1se/p2panda-ffi/commit/71d27e537f24ae1656b2fbd358f8d38187a9d504)
  for more.

## Licenses

Apache 2.0 & MIT, following the upstream licensing choices in
[`p2panda`](https://github.com/p2panda/p2panda).