https://github.com/justincpresley/ndn-sync

ndn-sync: A Go Library for NDN Distributed Dataset Synchronization "Sync" Protocols.
https://github.com/justincpresley/ndn-sync

dataset distributed golang multi-node-communication named-data-networking ndn-sync network-protocol synchronization

Last synced: 5 months ago
JSON representation

ndn-sync: A Go Library for NDN Distributed Dataset Synchronization "Sync" Protocols.

• Host: GitHub
• URL: https://github.com/justincpresley/ndn-sync
• Owner: justincpresley
• License: isc
• Created: 2022-10-04T03:15:57.000Z (over 3 years ago)
• Default Branch: production
• Last Pushed: 2024-02-28T03:53:47.000Z (over 2 years ago)
• Last Synced: 2024-06-21T14:03:21.224Z (almost 2 years ago)
• Topics: dataset, distributed, golang, multi-node-communication, named-data-networking, ndn-sync, network-protocol, synchronization
• Language: Go
• Homepage: https://pkg.go.dev/github.com/justincpresley/ndn-sync
• Size: 414 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


![Visual](/docs/README_VISUAL.png)

[![Test](https://img.shields.io/github/actions/workflow/status/justincpresley/ndn-sync/test.yaml?branch=production&label=Test)][1]

[![CodeQL](https://img.shields.io/github/actions/workflow/status/justincpresley/ndn-sync/codeql.yml?branch=production&label=CodeQL)][2]

[![CodeFactor](https://img.shields.io/codefactor/grade/github/justincpresley/ndn-sync/production?label=CodeFactor)][3]

[![Language](https://img.shields.io/github/go-mod/go-version/justincpresley/ndn-sync/production?label=Go)][4]

[![Version](https://img.shields.io/github/v/tag/justincpresley/ndn-sync?label=Latest%20version)][5]

[![Commits](https://img.shields.io/github/commits-since/justincpresley/ndn-sync/latest/production?label=Unreleased%20commits)][6]

[![License](https://img.shields.io/github/license/justincpresley/ndn-sync?label=License)][7]



***ndn-sync*** is a [Go](https://go.dev/) library implementing [Named Data Networking](https://named-data.net/) (NDN) Distributed Dataset Synchronization '*Sync*' Protocols that can be used to write various real-time NDN Applications.

The goal of '*Sync*' is to inform others about updates in a dataset and/or to learn

about newly published data, effectively synchronizing data in a group.

***ndn-sync*** welcomes both newcomers and experts of NDN.

***ndn-sync*** is implemented using the NDN library [go-ndn](https://github.com/zjkmxy/go-ndn).

## Branches

***ndn-sync*** contains two main branches with their differences described below:

* [**production**](https://github.com/justincpresley/ndn-sync/tree/production): The master branch which holds Syncs along with any modifications to make them more stable/usable for applications. This branch is actively being served as a Go package.

* [**specification**](https://github.com/justincpresley/ndn-sync/tree/specification): The side branch which holds Syncs in their original form according to their technical specification.

## Usage

Before you utilize ***ndn-sync*** or try any of its examples, please ensure that you have the necessary [prerequisites](/docs/INSTALL.md). It will take but a few minutes!

***ndn-sync*** is a library containing multiple modules (different Syncs), each with individual functionality and use.

It is highly recommended that you check out the examples. Sometimes, seeing the Syncs in action can give you ideas and help you in understanding what the Syncs provide.

## Syncs

There are many Syncs!

Ones that are being used in applications, others that are currently experiments,

and some that have yet to be discovered. ***ndn-sync*** gladly accepts any

kind of Sync protocol with a slight bias towards new and/or stable Syncs.

This [Sync Survey](https://named-data.net/wp-content/uploads/2021/05/ndn-0053-2-sync-survey.pdf)

describes many of the Syncs that are currently known and their unique differences. It is a recommended read.

***ndn-sync*** has the following Syncs implemented:

* `svs` - **StateVectorSync**: [Details](/docs/syncs/SVS.md) | [API Documentation](https://pkg.go.dev/github.com/justincpresley/ndn-sync/pkg/svs) | [Examples](/examples/svs/README.md)

## Contribution

The most effortless way you can contribute to ***ndn-sync*** is to simply [have discussions surrounding ***ndn-sync***](https://github.com/justincpresley/ndn-sync/discussions).

In addition, ***ndn-sync*** has more practical ways to get involved: [Issues](https://github.com/justincpresley/ndn-sync/issues) and [Pull Requests](https://github.com/justincpresley/ndn-sync/pulls).

## License

***ndn-sync*** is an open source project licensed under ISC. See LICENSE.md for more information.

[1]: https://github.com/justincpresley/ndn-sync/actions/workflows/test.yaml

[2]: https://github.com/justincpresley/ndn-sync/actions/workflows/codeql.yml

[3]: https://www.codefactor.io/repository/github/justincpresley/ndn-sync

[4]: https://go.dev/

[5]: https://github.com/justincpresley/ndn-sync/releases

[6]: https://github.com/justincpresley/ndn-sync/compare/v0.0.0-alpha.16...HEAD

[7]: https://en.wikipedia.org/wiki/ISC_license