crdt

0.5.2 Opens a new window with list of versions in this module.

A distributed go-datastore implementation using Merkle-CRDTs. For more information about how to use this package see README

Latest version published 7 months ago

GitHub

Package Health Score

78 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Active

Popularity

Recognized

Imported By: 16
GitHub Stars: 363
Forks: 44
Contributors: 20

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package crdt, we found that it has been 363 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Oct 3, 2023

License

Apache-2.0, MIT, Apache-2.0, + 1 more

Security Policy

We found a way for you to contribute to the project! Looks like crdt is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 4
Open PR: 10
Last Release: 7 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of github.com/ipfs/go-ds-crdt based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that github.com/ipfs/go-ds-crdt demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the github.com/ipfs/go-ds-crdt repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like github.com/ipfs/go-ds-crdt is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

go-ds-crdt

A distributed go-datastore implementation using Merkle-CRDTs.

go-ds-crdt is a key-value store implementation using Merkle CRDTs, as described in the paper by Héctor Sanjuán, Samuli Pöyhtäri and Pedro Teixeira. It satisfies the Datastore and Batching interfaces from go-datastore.

This means that you can create a network of nodes that use this datastore, and that each key-value pair written to it will automatically replicate to every other node. Updates can be published by any node. Network messages can be dropped, reordered, corrupted or duplicated. It is not necessary to know beforehand the number of replicas participating in the system. Replicas can join and leave at will, without informing any other replica. There can be network partitions but they are resolved as soon as connectivity is re-established between replicas.

Internally it uses a delta-CRDT Add-Wins Observed-Removed set. The current value for a key is the one with highest priority. Priorities are defined as the height of the Merkle-CRDT node in which the key was introduced.

Implementation is independent from Broadcaster and DAG syncer layers, although the easiest is to use out of the box components from the IPFS stack (see below).

Performance

Using batching, Any go-ds-crdt replica can easily process and sync 400 keys/s at least. The largest known deployment has 100M keys.

go-ds-crdt is used in production as state-synchronization layer for IPFS Clusters.

Usage

go-ds-crdt needs:

A user-provided, thread-safe, go-datastore implementation to be used as permanent storage. We recommend using the Badger implementation.
A user-defined Broadcaster component to broadcast and receive updates from a set of replicas. If your application uses libp2p, you can use libp2p PubSub and the provided PubsubBroadcaster.
A user-defined "DAG syncer" component (ipld.DAGService) to publish and retrieve Merkle DAGs to the network. For example, you can use IPFS-Lite which casually satisfies this interface.

The permanent storage layout is optimized for KV stores with fast indexes and key-prefix support.

See https://pkg.go.dev/github.com/ipfs/go-ds-crdt for more information.

Captain

This project is captained by @hsanjuan.

License

This library is dual-licensed under Apache 2.0 and MIT terms.

FAQs

What is crdt?

A distributed go-datastore implementation using Merkle-CRDTs. Visit Snyk Advisor to see a full health score report for crdt, including popularity, security, maintenance & community analysis.

Is crdt popular?

The golang package crdt receives a total of ? weekly downloads. As such, crdt popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is crdt well maintained?

We found indications that crdt maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is crdt safe to use?

The golang package crdt was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 4 May-2024, at 09:08 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Usage Popularity

Security risks

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Readme

go-ds-crdt

Performance

Usage

Captain

License

FAQs

What is crdt?

Is crdt popular?

Is crdt well maintained?

Is crdt safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues