coil-service is a cross-platform, distributed messaging service that uses a peer-to-peer model to facilitate reliable communications. It offers abstractions over low-level networking components provided by libp2p and tokio.
coil-service is free, open-source software and may be used in your work, according with the licensing. I hope that you do find a use for it, or that it inspires you to build something amazing. Either way, this project will remain open-source for as long as the project exists.
coil-service is under active development.
Do not, under any circumstances, use this software in a production environment. If you choose to use this software, or any components of it, within your own software, you do so entirely at your own risk.
coil-service is built on top of libp2p, using the tokio multi-threaded asynchronous runtime. Ideally, I would like to also provide support for the single-threaded runtime.
- Expose intuitive, high-level APIs to allow users to build their own custom networking utilities and protocol stacks
- Avoid protocol ossification (you will never be forced to use
TCPorUDP, etc.)- Please note, that for IPC, your choices may be limited, based on your target platform
- Provide cross-platform support for Windows, Linux and MacOS
- NOTE: Target cpu architecture is assumed to be
x86-64
- NOTE: Target cpu architecture is assumed to be
- Create abstractions over
libp2pthat allow developers to work at a higher-level - Provide "escape-hatches" when deemeded necessary, so that developers can fine-tune components for performance, resource efficiency, etc.
Ideally, this service will run on as many devices as possible. This project is being developed by one person (myself), and I will do my best to support as many platforms as possible.
I own machines that natively run all three main desktop platforms, but am doing much of the initial development on my Windows and Linux machines. If support for MacOS (x86-64, not aarch64) lags behind, or a critical feature is missing, or not working, please open a ticket! I will do my absolute best to keep support for the main desktop platforms in lockstep.
These targets will be treated as first-class citizens:
- Windows:
x86_64-pc-windows-msvc - Linux:
x86_64-unknown-linux-gnu - MacOS:
x86_64-apple-darwin
These targets will ideally be added to the list above, but for the time being, support depends on how much time I have, and how simple it is to add support for these platforms:
- Raspberry Pi 4:
aarch64-unknown-linux-gnu - MacOS M1:
aarch64-apple-darwin - Windows GNU:
x86_64-pc-windows-gnu- This target will be moved to "Primary targets" if there are few to no complications.
- TBA
If you would like to help add support for additional platforms, I would absolutely love your help. Any and all contributions are welcome!
- This project has absolutely nothing to do with "blockchain", and it never will.
This software is currently being developed using the Rust nightly toolchain.
The presence of the rust-toolchain.toml file in the root of the project should automatically install the correct toolchain for you upon first build.
If it does not, you can manually install the toolchain with the following command:
rustup toolchain install nightly --allow-downgrade --profile default --component cargo clippy llvm-tools-preview rust-srcI made this choice because I prefer the improved developer experience offered by the nightly toolchain.
The
This is not permanent, and will change when a PoC and/or MVP is complete. At that stage, work on the MVP will begin, and the project will move to using Rust stable toolchain.
Setup instructions for each supported platform can be found in the section below:
These tools should be installed already via Visual Studio Build Tools. You can also use a package manager, such as chocolatey or scoop.
lldlinkerClangcompiler frontend- These components should already be installed from
MSVC - They may need to be manually added to your PATH variable
- These components should already be installed from
Install the cargo binaries and rustup components:
cargo install --force cargo-binutils
rustup component add llvm-tools-previewInstall the required linker:
brew install michaeleisel/zld/zldlldlinkerClangcompiler frontend Install the linker and compiler frontend:
sudo apt-get install lld clangThis project is licensed under the MIT license.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in coil-service by you, shall be licensed as MIT, without any additional terms or conditions.