https://github.com/arlodotexe/owlcore.nomad.kubo
Shared tooling for building Nomad-enabled applications on ipfs
https://github.com/arlodotexe/owlcore.nomad.kubo
Last synced: 4 months ago
JSON representation
Shared tooling for building Nomad-enabled applications on ipfs
- Host: GitHub
- URL: https://github.com/arlodotexe/owlcore.nomad.kubo
- Owner: Arlodotexe
- License: mit
- Created: 2024-06-01T21:36:37.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T05:41:13.000Z (6 months ago)
- Last Synced: 2025-01-03T15:41:50.608Z (5 months ago)
- Language: C#
- Size: 682 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# OwlCore.Nomad.Kubo [](https://www.nuget.org/packages/OwlCore.Nomad.Kubo)
Shared tooling for building Nomad-enabled applications on ipfs.
Put simply, this library was built to help you easily cover the gap between "User device" and "User".
Nomad enables applications to distribute their application domain across a set of peers. It does this by having each one maintain their own modifiable event stream while reading the read-only event streams published by other peers.
The state of an object is rebuilt from a seed by replaying and aggregating individual event streams published by individual devices, each containing an append-only history of interactions performed against an application domain on that device.
Even as peers come and go, publishing only peer-specific interactions with the application domain allows the consolidated state to eventually converge on each device without CDRTs or generalizable conflict resolution logic. Conflict resolution is effectively delegated to an implementation detail.
This library was specially crafted to take advantage of content addressing under a changing device topology, especially considering the one-to-many nature of IPNS, the immutability of IPFS CIDs, and the need for a permission-aware "shared" p2p-native state that reaches an eventually consistency defined by the application.
## Featuring:
- Interfaces and models for building Nomad applications using Ipfs/Kubo.
- `IKuboOptions` for piping basic preferences for pinning, ipns lifetime, and caching through your application.
- Read-only and modifiable Kubo-based event stream handler interfaces.
- A base implementation `ReadOnlyNomadKuboEventStreamHandler` that handles advancing the handler's event stream using resolved data from ipfs. Just implement `ApplyEntryUpdateAsync` in the derived class.
- Models and tooling to handle local vs roaming ipns keys. The roaming key is used to publish a fully advanced, fully consolidated model from an event stream handler to ipns. If all peers have the same data, they will all publish the same CID to ipns.
- Helpers for appending and publishing a new event stream entry to a local ipns key in Kubo.
- Helpers for publishing the fully advanced roaming object to ipns (alongside sources).
This library is in prerelease and documentation is a work-in-progress. Reach out if you'd like to use this library in your own application.
## Install
Published releases are available on [NuGet](https://www.nuget.org/packages/OwlCore.Nomad.Kubo). To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
PM> Install-Package OwlCore.Nomad.Kubo
Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet)
> dotnet add package OwlCore.Nomad.Kubo
## Usage
```cs
var test = new Thing();
```
## Financing
We accept donations [here](https://github.com/sponsors/Arlodotexe) and [here](https://www.patreon.com/arlodotexe), and we do not have any active bug bounties.
## Versioning
Version numbering follows the Semantic versioning approach. However, if the major version is `0`, the code is considered alpha and breaking changes may occur as a minor update.
## License
All OwlCore code is licensed under the MIT License. OwlCore is licensed under the MIT License. See the [LICENSE](./src/LICENSE.txt) file for more details.