base on The Chainflip backend repo, including the Chainflip Node and CFE. [](https://codecov.io/gh/chainflip-io/chainflip-backend) # Chainflip [Chainflip](https://chainflip.io/) is a decentralized protocol for cross-chain crypto-currency swaps. For an in-depth introduction to Chainflip, the [official docs](https://docs.chainflip.io/) are the best place to start. If you are interested in contributing to the codebase or in digging into the nitty gritty details of the protocol, you have come to the right place. Please read on. ## Getting started The project is organised using rust workspaces. See the `Cargo.toml` in this directory for a list of contained workspaces. Each workspace should have its own `README` with instructions on how to get started. If not, please raise an issue! ## Compile and run tests To compile the code execute: ```bash cargo cf-build-release ``` To run the test suite execute: ```bash cargo cf-test-ci ``` > **_NOTE:_** cf-test-ci is an alias for cargo test with additional flags. These aliases are defined in [.cargo/config.toml](.cargo/config.toml). ## Contributing ### Setup Make sure you have the following packages and tools installed. The following is for debian-like systems (e.g. Ubuntu). You may need to adjust for your system. ```bash # Update package lists sudo apt update # Install essential build tools and libraries sudo apt install -y build-essential pkg-config libssl-dev protobuf-compiler clang cmake jq # Install Rust curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Install Node.js and pnpm curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - sudo apt install -y nodejs npm install -g pnpm # Install Solana sh -c "$(curl -sSfL https://release.solana.com/v1.18.8/install)" ``` > 💡 **_NOTE:_** Compiling for the very first time may take a while as it will download all the dependencies. You might hit some memory limitations and to overcome this, you can setup a swap file (20GB) on your system. ### Code style The best way to ensure that your code is easy to merge, is to copy the project's pre-commit hook into your local `.git/` directory. You can do this with: ```bash cp .git-hooks/pre-commit .git/hooks/ chmod +x .git/hooks/pre-commit ``` Since much of the project is reliant on parity substrate, please take inspiration from parity's [Substrate code style](https://github.com/paritytech/substrate/blob/master/docs/STYLE_GUIDE.md) where possible. Please see this as a guideline rather than rigidly enforced rules. We will define and enforce formatting rules with `rustfmt` in due course. It should be straightforward to integrate this with your favourite editor for auto-formatting. ### Branching and merging Before making any changes: - create a new branch always. - give it a descriptive name: `feature/my-awesome-feature` When your changes are ready, or you just want some feedback: - open a PR. - once the PR is open, avoid force-push, use `git merge` instead of `git rebase` to merge any upstream changes. ### Useful commands The following commands should be executed from the repo root directory. - Check formatting:<br> `cargo fmt --check` - Format code:<br> - `cargo fmt -- <filename>` - `cargo fmt --all` (format all packages) - Check the state-chain and cfe compile: - `cargo cf-clippy` - `cargo cf-clippy-ci` (This is used by the CI, but you don't typically need it) - Run all unit tests:<br> `cargo cf-test` - Expand macros for a given part of the code. You'll need to pipe output to a file.<br> Requires _cargo-expand_ (`cargo install cargo-expand`):<br> `cargo expand <options>` - Clean up old build objects (sometimes this will fix compile problems): - `cargo clean` - `cargo clean -p <package>` - Audit external dependencies.<br> Requires cargo-audit(`cargo install cargo-audit`)):<br> `cargo cf-audit` ## Localnet You can run a local single-node testnet (Localnet), in Docker. This will allow you to quickly iterate on a particular commit. ### Prerequisites #### Hardware We recommend at least 16GB of RAM and 4 CPU cores to handle all the containers and binaries running locally. #### Software and Tools You will need to download [Docker](https://docs.docker.com/get-docker/). Make sure you use a recent version that has `docker-compose` plugin included. Otherwise, you might need to modify the `./localnet/manage.sh` script to use `docker-compose` instead of `docker compose`. ### Creating a Localnet Localnets use binaries built locally. To create a Localnet for your current branch, you will first need to build. You can use either release or debug builds. From the repo root, run the following: ```shell cargo build ./localnet/manage.sh ``` You'll be prompted with the following: ```shell ❓ Would you like to build, recreate or destroy your Localnet? (Type 1, 2, 3, 4 or 5) 1) build-localnet 2) recreate 3) destroy 4) logs 5) yeet 6) bouncer ``` > **Note:** All chain data and signing DBs as well as log files will be under`/tmp/chainflip` - **build** - Create a new testnet using a path to the binaries you provide. - **recreate** - This will simply run destroy, followed by build. You have the option to change the path to the binaries. - **destroy** - Destroy your current Localnet and deletes chain data. - **logs** - Tail the logs for your current Localnet. - **yeet** - Destroy your current Localnet, and remove all data including docker images. You should use this if you are getting some weird caching issues. - **bouncer** - Run the bouncer e2e test suite against the localnet. This test is run in our CI. ### Log Filtering in the Chainflip Engine These commands can be used to control which logs the engine outputs at runtime. - `curl -X GET 127.0.0.1:36079/tracing` (Returns the current filtering directives) - `curl --json '"debug,warp=off,hyper=off,jsonrpc=off,web3=off,reqwest=off"' 127.0.0.1:36079/tracing` (Sets the filter directives so the default is DEBUG, and the logging in modules warp, hyper, jsonrpc, web3, and reqwest is turned off) - `curl -X POST -H 'Content-Type: application/json' -d '"debug,warp=off,hyper=off,jsonrpc=off,web3=off,reqwest=off"' 127.0.0.1:36079/tracing` (Equivalent to the above, but without using the --json short-hand) The `RUST_LOG` environment variable controls the initial filtering directives if specified at engine startup. The syntax for specifying filtering directives is given here: <https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html> ## Testnet To start a multi node testnet you can use the [chainflip-testnet-tools](https://github.com/chainflip-io/chainflip-testnet-tools). A multi-node testnet can be useful to test more complex test scenarios under more realistic conditions. ## Chainflip Engine Runner This is the root binary that kicks off the Chainflip Engine. It is responsible for loading the shared libraries and running each of the shared libraries. See the [Chainflip Engine Runner README](./engine-runner-bin/README.md) for more information. ", Assign "at most 3 tags" to the expected json: {"id":"5187","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"