https://github.com/AcalaNetwork/Acala
Acala - cross-chain DeFi hub and stablecoin based on Substrate for Polkadot and Kusama.
https://github.com/AcalaNetwork/Acala
acala defi kusama polkadot rust stablecoin substrate
Last synced: 3 days ago
JSON representation
Acala - cross-chain DeFi hub and stablecoin based on Substrate for Polkadot and Kusama.
- Host: GitHub
- URL: https://github.com/AcalaNetwork/Acala
- Owner: AcalaNetwork
- License: gpl-3.0
- Created: 2019-09-04T06:31:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T07:59:36.000Z (12 months ago)
- Last Synced: 2024-04-24T07:24:33.458Z (12 months ago)
- Topics: acala, defi, kusama, polkadot, rust, stablecoin, substrate
- Language: Rust
- Homepage: https://acala.network
- Size: 99.2 MB
- Stars: 724
- Watchers: 50
- Forks: 248
- Open Issues: 127
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audit/Acala Network - Final Report.pdf
Awesome Lists containing this project
- best-of-crypto - GitHub - 16% open · ⏱️ 31.05.2024): (Others)
README
[](https://github.com/AcalaNetwork/Acala/actions)
[](https://github.com/AcalaNetwork/Acala/tags)
[](https://substrate.io/)
[](https://codecov.io/gh/AcalaNetwork/Acala)
[](https://github.com/AcalaNetwork/Acala/blob/master/LICENSE)
[](https://twitter.com/AcalaNetwork)
[](https://discord.gg/xZfRD6rVfJ)
[](https://t.me/AcalaOfficial)
[](https://forum.acala.network/)
[](https://medium.com/acalanetwork)
- [1. Introduction](#1-introduction)
- [2. Building](#2-building)
- [NOTE](#note)
- [3. Run](#3-run)
- [4. Development](#4-development)
- [5. Bug Bounty :bug:](#5-bug-bounty-bug)
- [6. Bench Bot](#6-bench-bot)
- [Generate module weights](#generate-module-weights)
- [Generate runtime weights](#generate-runtime-weights)
- [Bench Acala EVM+](#bench-acala-evm)
- [7. Migration testing runtime](#7-migration-testing-runtime)
- [Try testing runtime](#try-testing-runtime)
# 1. Introduction
This project is initiated and facilitated by the Acala Foundation. Acala Foundation nurtures applications in the fields of decentralized finance protocols, particularly those that serve as open finance infrastructures such as stable currency and staking liquidity. The Acala Foundation is founded by [Laminar](https://laminar.one/) and [Polkawallet](https://polkawallet.io/), participants and contributors to the Polkadot ecosystem. The Acala Foundation welcomes more industry participants as it progresses.
# 2. Building
## NOTE
The Acala client node is moved to [acala-node](https://github.com/AcalaNetwork/acala-node). This repo only contains the runtime code. This allow us to decouple the runtime release and client node release.
If you would like to build the client node, please refer to [acala-node](https://github.com/AcalaNetwork/acala-node).
Install Rust:
```bash
curl https://sh.rustup.rs -sSf | sh
```
You may need additional dependencies, checkout [substrate.io](https://docs.substrate.io/v3/getting-started/installation) for more info
```bash
sudo apt-get install -y git clang curl make libssl-dev llvm libudev-dev protobuf-compiler
```
Make sure you have `submodule.recurse` set to true to make life with submodule easier.
```bash
git config --global submodule.recurse true
```
Install required tools and install git hooks:
```bash
make init
```
# 3. Run
You can start a development chain with:
```bash
make run
```
# 4. Development
To type check:
```bash
make check-all
```
To purge old chain data:
```bash
make purge
```
To purge old chain data and run
```bash
make restart
```
Update ORML
```bash
make update
```
# 5. Bug Bounty :bug:
The Bug Bounty Program includes only on-chain vulnerabilities that can lead to significant economic loss or instability of the network. You check details of the Bug Bounty or Submit a vulnerability here:
https://immunefi.com/bounty/acala/
# 6. Bench Bot
Bench bot can take care of syncing branch with `master` and generating WeightInfos for module or runtime.
## Generate module weights
Comment on a PR `/bench module ` i.e.: `module_currencies`
Bench bot will do the benchmarking, generate `weights.rs` file and push changes into your branch.
## Generate runtime weights
Comment on a PR `/bench runtime ` i.e.: `/bench runtime mandala module_currencies`.
To generate weights for all modules just pass `*` as `module_name` i.e: `/bench runtime mandala *`
Bench bot will do the benchmarking, generate weights file and push changes into your branch.
## Bench Acala EVM+
Comment on a PR `/bench evm` to benchmark Acala EVM+ and bench bot will generate precompile weights and GasToWeight ratio.
# 7. Migration testing runtime
If modifying the storage, you should test the data migration before upgrading the runtime.
## Try testing runtime
try-runtime on karura
```bash
# Use a live chain to run the migration test.
# Add `-p module_name` can specify the module.
make try-runtime-karura
# Create a state snapshot to run the migration test.
# Add `--pallet module_name` can specify the module.
cargo run --features with-karura-runtime --features try-runtime -- try-runtime --runtime existing create-snapshot --uri wss://karura.api.onfinality.io:443/public-ws karura-latest.snap
# Use a state snapshot to run the migration test.
./target/release/acala try-runtime --runtime ./target/release/wbuild/karura-runtime/karura_runtime.compact.compressed.wasm --chain=karura-dev on-runtime-upgrade snap -s karura-latest.snap
```
try-runtime on acala
```bash
# Use a live chain to run the migration test.
# Add `--pallet module_name` can specify the module.
make try-runtime-acala
# Create a state snapshot to run the migration test.
# Add `-palet module_name` can specify the module.
cargo run --features with-acala-runtime --features try-runtime -- try-runtime --runtime existing create-snapshot --uri wss://acala.api.onfinality.io:443/public-ws acala-latest.snap
# Use a state snapshot to run the migration test.
./target/release/acala try-runtime --runtime ./target/release/wbuild/acala-runtime/acala_runtime.compact.compressed.wasm --chain=acala-dev on-runtime-upgrade snap -s acala-latest.snap
```