# FerrumFIX [![Crates.io](https://img.shields.io/crates/v/fefix)](https://crates.io/crates/fefix) [![Website](https://img.shields.io/badge/website-ferrumfix.org-orange)](https://ferrumfix.org) [![Docs.rs](https://img.shields.io/badge/docs.rs-latest-green)](https://docs.rs/fefix/) [![Minimal rustc version](https://img.shields.io/badge/rustc-1.56%2B-lightgrey)](https://img.shields.io/badge/rustc-1.56%2B-lightgrey) [![matrix.org](https://img.shields.io/badge/matrix.org-%23ferrum--fix-blue)](https://matrix.to/#/#ferrum-fix:matrix.org) [![License](https://img.shields.io/crates/l/fefix)](https://crates.io/crates/fefix) [![CI status](https://img.shields.io/github/workflow/status/ferrumfix/ferrumfix/CI/develop)](https://github.com/ferrumfix/ferrumfix/actions) Love FerrumFIX? Buy me a coffee and [support](https://github.com/sponsors/ferrumfix) the project!
FerrumFIX is a free and open source FIX engine implementation in Rust. Please note that it's currently under heavy development and wildly unstable, so all interested parties should refrain from using it in production prior to its 1.0 release. Performance and full adherence to the FIX protocol are nevertheless core goals of the project which, if anything, might serve as a useful foundation for others' work. - [FerrumFIX](#ferrumfix) - [About](#about) - [Sponsors](#sponsors) - [Contributing](#contributing) - [Legal](#legal) ## About FerrumFIX provides parsing, validation, error recovery, and (de)serialization for the FIX family of protocols. ![FIX Technical Standard stack](https://github.com/ferrumfix/ferrumfix/raw/develop/docs/FIX-Technical-Standard-Stack.png) The above illustration succintly describes the full scope of FIX and it serves as a reference point for all modern FIX implementations. FerrumFIX aims with total compliance... *eventually*. Engineering efforts are initially focused on core features e.g. tag-value encoding and FIX 4.4. FerrumFIX enforces strict separation of concerns according to the OSI model, as reasonably allowed by the FIX specification. - Layer 4 (Transport Layer): `fefixs`. - Layer 5 (Session Layer): `fefix::session`. - Layer 6 (Presentation Layer): `fefix::tagvalue`, `fefix::json`, `fefast`. - Layer 7 (Application Layer): `fefix::Dictionary`. You don't have to understand the whole tech stack to use a single layer; in fact, FerrumFIX makes sure that you only ever need to worry about layers above your chosen abstraction level. For most users, that would be Layer 7 (i.e. semantics of FIX messages and business logic). On the other hand, you will need to delve deep into lower layers in case you plan on building a fully-fledged FIX engine. **Core features:** - [X] Code generation (Rust, possibly others). - [X] FIX 4.2. - [X] FIX 4.4. - [X] FIX 5.0 Service Pack 2. **Encodings:** - [X] Tagvalue (classic FIX). - [ ] FIXML. - [ ] Simple Binary Encoding (SBE). - [ ] Google Protocol Buffers (GPB). - [X] JavaScript Object Notation (JSON). - [ ] Abstract Syntax Notation (ASN.1). - [ ] FIX Adapted for STreaming (FAST). ## Sponsors *FerrumFIX is kindly sponsored by **Bitwyre**. Bitwyre is a next gen, HFT-friendly Cryptocurrency Derivatives Exchange.* ![Bitwyre logo](https://github.com/ferrumfix/ferrumfix/raw/develop/docs/bitwyre-logo.png) Please reach out to `Filippo Costa ` for business inquiries. ## Contributing All development happens on GitHub at [`ferrumfix/ferrumfix`](https://github.com/ferrumfix/ferrumfix). Contributions both from volunteers and companies are welcome. Depending on the size and scope of your intended contributions, it's likely a good idea to open beforehand a GitHub issue to discuss any details. Please note that our branching strategy is inspired by the (in)famous [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/), which is a good fit for software that requires complex versioning such as FIX implementations. Versioning adheres to [SemVer 2.0](https://semver.org/). ## Legal FerrumFIX is available under the terms of the MIT license and Apache License 2.0, at your choice. See `LICENSE-MIT.txt` and `LICENSE-APACHE.txt` in this repository for more information. All FIX Protocol-related intellectual property, including but not limited to the original documentation that ships with FerrumFIX, is licensed by FIX Protocol Ltd. under *Creative Commons Attribution - No Derivatives 4.0 International* (CC BY-ND 4.0). By contributing to this project you agree to comply with all license requirements. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.