any-sync

module
v0.4.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2024 License: MIT

README

Any-Sync

Any-Sync is an open-source protocol that enables local first communication and collaboration based on CRDTs. There are two important differentiators of Any-Sync:

  • It is designed around creators’ controlled keys
  • It is focused on bringing high-performance communication and collaboration at scale

Any-Sync fulfills the seven ideals of local first software:

  • No spinners: your work at your fingertips. Any-Sync keeps the primary copy of each space on the local device. Data synchronization with other devices happens quietly in the background - allowing you to operate with your data at your fingertips.
  • Your work is not trapped on one device. Users can easily work on different devices. Each device keeps data in local storage, synchronization between devices happens in the background using CRDTs to resolve conflicts.
  • The network is optional. Everything works offline. Data synchronization need not necessarily go via the Internet: Any-Sync allows users to sync data via local WiFi networks. Still, there is a role for the network - it works as additional backup, helps with peer discovery and especially solves the closed-laptop problem (you made changes on laptop, when your phone was offline, the changes can either sync when both devices are online or via backup node).
  • Seamless collaboration with your colleagues. Achieving this goal is one of the biggest challenges in realizing local-first software, that’s why Any-Sync is built with CRDTs. So each device resolves conflicts independently.
  • The Long Now. Because you have a local-first application, you can use it on your computer even if the software author disappears. This is also strengthened by open data standards and open code.
  • Security and privacy by default. Any-Sync uses end-to-end encryption so that backup nodes store encrypted data that they cannot read. Conflict resolution happens on-device. The keys are controlled by users.
  • You retain ultimate ownership and control. In the local first ideals this meant that you have local data, so you have ultimate ownership and control. To realize the idea of ultimate ownership we added creator controlled keys to Anytype.

Additional two ideals that Any-Sync adds:

  • Creators’ controlled keys. Creators control encryption keys; there is no central registry of users (we don’t even ask your email). We added an option to self-host your backup to support full autonomy of users from the network.
  • Open Source. Any-Sync protocol is open source, so all claims about how it works are independently verifiable.

We have released Anytype - the interface that is built on Any-Sync protocol. Users of Anytype can create spaces - graph-based databases with modular UI. Each space has unique access rights. Today, Anytype's beta is in single-player mode. Multiplayer mode, which will support local-first collaboration between multiple users, will be launched in the first half of 2024.

Introduction

We designed Any-Sync out of a strong conviction that the Internet today is akin to a nervous system of humanity - today it is cloud based, so all the neurons can communicate only via servers that are controlled by different elites. We envision a “no-one in between” local first alternative would be a much better foundation for communication on the internet. For this we’ve built Any-Sync to support fast and scalable synchronization of discussions, communities and apps.

Features:

  • Conflict-free data replication across multiple devices and agents
  • Built-in end-to-end encryption
  • Cryptographically verifiable history of changes
  • Adoption to frequent operations (high performance)
  • Reliable and scalable infrastructure
  • Simultaneous support of p2p and remote communication

Protocol explanation

Plese read the overview of protocol entities and design.

Implementation

You can find the various parts of the protocol implemented in Go in the following repositories:

  • any-sync-node — implementation of a sync node responsible for storing spaces and objects.
  • any-sync-filenode — implementation of a file node responsible for storing files.
  • any-sync-consensusnode — implementation of a consensus node responsible for ACL changes monitoring and validation.
  • any-sync-coordinator — implementation of a coordinator node responsible for network configuration management.

Contribution

Thank you for your desire to develop Anytype together!

❤️ This project and everyone involved in it is governed by the Code of Conduct.

🧑‍💻 Check out our contributing guide to learn about asking questions, creating issues, or submitting pull requests.

🫢 For security findings, please email security@anytype.io and refer to our security guide for more information.

🤝 Follow us on Github and join the Contributors Community.


Made by Any — a Swiss association 🇨🇭

Licensed under MIT License.

Directories

Path Synopsis
mock_accountservice
Package mock_accountservice is a generated GoMock package.
Package mock_accountservice is a generated GoMock package.
acl
mock_acl
Package mock_acl is a generated GoMock package.
Package mock_acl is a generated GoMock package.
app
debugstat/mock_debugstat
Package mock_debugstat is a generated GoMock package.
Package mock_debugstat is a generated GoMock package.
ldiff
Package ldiff provides a container of elements with fixed id and changeable content.
Package ldiff provides a container of elements with fixed id and changeable content.
ldiff/mock_ldiff
Package mock_ldiff is a generated GoMock package.
Package mock_ldiff is a generated GoMock package.
commonfile
acl/aclclient/mock_aclclient
Package mock_aclclient is a generated GoMock package.
Package mock_aclclient is a generated GoMock package.
credentialprovider/mock_credentialprovider
Package mock_credentialprovider is a generated GoMock package.
Package mock_credentialprovider is a generated GoMock package.
deletionmanager/mock_deletionmanager
Package mock_deletionmanager is a generated GoMock package.
Package mock_deletionmanager is a generated GoMock package.
deletionstate/mock_deletionstate
Package mock_deletionstate is a generated GoMock package.
Package mock_deletionstate is a generated GoMock package.
headsync/mock_headsync
Package mock_headsync is a generated GoMock package.
Package mock_headsync is a generated GoMock package.
mock_commonspace
Package mock_commonspace is a generated GoMock package.
Package mock_commonspace is a generated GoMock package.
object/acl/list/mock_list
Package mock_list is a generated GoMock package.
Package mock_list is a generated GoMock package.
object/acl/liststorage/mock_liststorage
Package mock_liststorage is a generated GoMock package.
Package mock_liststorage is a generated GoMock package.
object/acl/syncacl/mock_syncacl
Package mock_syncacl is a generated GoMock package.
Package mock_syncacl is a generated GoMock package.
object/tree/objecttree/mock_objecttree
Package mock_objecttree is a generated GoMock package.
Package mock_objecttree is a generated GoMock package.
object/tree/synctree/mock_synctree
Package mock_synctree is a generated GoMock package.
Package mock_synctree is a generated GoMock package.
object/tree/synctree/updatelistener/mock_updatelistener
Package mock_updatelistener is a generated GoMock package.
Package mock_updatelistener is a generated GoMock package.
object/tree/treestorage/mock_treestorage
Package mock_treestorage is a generated GoMock package.
Package mock_treestorage is a generated GoMock package.
object/treemanager/mock_treemanager
Package mock_treemanager is a generated GoMock package.
Package mock_treemanager is a generated GoMock package.
object/treesyncer/mock_treesyncer
Package mock_treesyncer is a generated GoMock package.
Package mock_treesyncer is a generated GoMock package.
objectsync/mock_objectsync
Package mock_objectsync is a generated GoMock package.
Package mock_objectsync is a generated GoMock package.
objecttreebuilder/mock_objecttreebuilder
Package mock_objecttreebuilder is a generated GoMock package.
Package mock_objecttreebuilder is a generated GoMock package.
peermanager/mock_peermanager
Package mock_peermanager is a generated GoMock package.
Package mock_peermanager is a generated GoMock package.
settings/settingsstate/mock_settingsstate
Package mock_settingsstate is a generated GoMock package.
Package mock_settingsstate is a generated GoMock package.
spacestorage/mock_spacestorage
Package mock_spacestorage is a generated GoMock package.
Package mock_spacestorage is a generated GoMock package.
spacesyncproto/mock_spacesyncproto
Package mock_spacesyncproto is a generated GoMock package.
Package mock_spacesyncproto is a generated GoMock package.
consensus
consensusclient/mock_consensusclient
Package mock_consensusclient is a generated GoMock package.
Package mock_consensusclient is a generated GoMock package.
coordinator
coordinatorclient/mock_coordinatorclient
Package mock_coordinatorclient is a generated GoMock package.
Package mock_coordinatorclient is a generated GoMock package.
identityrepo
nameservice
nameserviceclient/mock
Code generated by MockGen.
Code generated by MockGen.
net
peer/mock_peer
Package mock_peer is a generated GoMock package.
Package mock_peer is a generated GoMock package.
pool/mock_pool
Package mock_pool is a generated GoMock package.
Package mock_pool is a generated GoMock package.
rpc
rpc/limiter/mock_limiter
Package mock_limiter is a generated GoMock package.
Package mock_limiter is a generated GoMock package.
transport/mock_transport
Package mock_transport is a generated GoMock package.
Package mock_transport is a generated GoMock package.
node
nodeclient/mock_nodeclient
Package mock_nodeclient is a generated GoMock package.
Package mock_nodeclient is a generated GoMock package.
mock_nodeconf
Package mock_nodeconf is a generated GoMock package.
Package mock_nodeconf is a generated GoMock package.
paymentservice
paymentserviceclient/mock
Package mock_paymentserviceclient is a generated GoMock package.
Package mock_paymentserviceclient is a generated GoMock package.
testutil
util
crc16
Package crc16 is implementation according to CCITT standards.
Package crc16 is implementation according to CCITT standards.
periodicsync/mock_periodicsync
Package mock_periodicsync is a generated GoMock package.
Package mock_periodicsync is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL