Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/theborakompanioni/nostr-proto

Protobuf definitions of core nostr messages
https://github.com/theborakompanioni/nostr-proto

nostr protobuf

Last synced: about 21 hours ago
JSON representation

Protobuf definitions of core nostr messages

Host: GitHub
URL: https://github.com/theborakompanioni/nostr-proto
Owner: theborakompanioni
License: apache-2.0
Created: 2025-01-05T18:26:17.000Z (16 days ago)
Default Branch: master
Last Pushed: 2025-01-18T17:59:42.000Z (3 days ago)
Last Synced: 2025-01-18T18:51:06.420Z (3 days ago)
Topics: nostr, protobuf
Language: Java
Homepage:
Size: 155 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build](https://github.com/theborakompanioni/nostr-proto/actions/workflows/build.yml/badge.svg)](https://github.com/theborakompanioni/nostr-proto/actions/workflows/build.yml)

[![GitHub Release](https://img.shields.io/github/release/theborakompanioni/nostr-proto.svg?maxAge=3600)](https://github.com/theborakompanioni/nostr-proto/releases/latest)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.theborakompanioni/nostr-proto.svg?maxAge=3600)](https://central.sonatype.com/artifact/io.github.theborakompanioni/nostr-proto)

[![License](https://img.shields.io/github/license/theborakompanioni/nostr-proto.svg?maxAge=2592000)](https://github.com/theborakompanioni/nostr-proto/blob/master/LICENSE)



    



nostr-proto

===

See [nostr-proto](./nostr/nostr-proto/src/main/proto/event.proto) for protobuf definitions of core nostr messages.

```protobuf

message Event {

  bytes id = 1 [json_name = "id"];

  bytes pubkey = 2 [json_name = "pubkey"];

  uint64 created_at = 3 [json_name = "created_at"];

  uint32 kind = 4 [json_name = "kind"];

  repeated TagValue tags = 5 [json_name = "tags"];

  string content = 6 [json_name = "content"];

  bytes sig = 7 [json_name = "sig"];

}

[...]

```

## Table of Contents

- [Install](#install)

- [Development](#development)

- [Contributing](#contributing)

- [Resources](#resources)

- [License](#license)

## Install

[Download](https://search.maven.org/#search|g%3A%22io.github.theborakompanioni%22) from Maven Central.

### Gradle

```groovy

repositories {

    mavenCentral()

}

```

```groovy

implementation "io.github.theborakompanioni:nostr-proto:${nostrProtoVersion}"

implementation "io.github.theborakompanioni:nostr-proto-json:${nostrProtoVersion}"

```

## Development

### Requirements

- java >=21

### Build

```shell script

./gradlew build -x test

```

### Test

```shell script

./gradlew test integrationTest --rerun-tasks --no-parallel

```

Run full test suite:

```shell script

CI=true ./gradlew test integrationTest e2eTest --rerun-tasks --no-parallel

```

## Contributing

All contributions and ideas are always welcome. For any question, bug or feature request,

please create an [issue](https://github.com/theborakompanioni/nostr-proto/issues).

Before you start, please read the [contributing guidelines](contributing.md).

## Resources

- nostr (GitHub): https://github.com/nostr-protocol/nostr

- NIPs (GitHub): https://github.com/nostr-protocol/nips

---

- nostr.com: https://nostr.com

- nostr Relay Registry: https://nostr-registry.netlify.app

- awesome-nostr (GitHub): https://github.com/aljazceru/awesome-nostr

- protocol-buffers: https://developers.google.com/protocol-buffers/docs/proto3#json

## License

The project is licensed under the Apache License. See [LICENSE](LICENSE) for details.