Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@xlc
xlc committed Nov 7, 2024
1 parent 5477ca9 commit 613470c
Showing 1 changed file with 14 additions and 158 deletions.
172 changes: 14 additions & 158 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,82 +22,30 @@
<!-- TOC -->

- [1. Introduction](#1-introduction)
- [2. Overview](#2-overview)
- [2.1. aUSD and the Honzon stablecoin protocol](#21-ausd-and-the-honzon-stablecoin-protocol)
- [2.2. Acala Network Economic Model](#22-acala-network-economic-model)
- [3. Building](#3-building)
- [2. Building](#2-building)
- [NOTE](#note)
- [4. Run](#4-run)
- [5. Development](#5-development)
- [6. Bug Bounty :bug:](#6-bug-bounty-bug)
- [7. Bench Bot](#7-bench-bot)
- [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)
- [8. Migration testing runtime](#8-migration-testing-runtime)
- [7. Migration testing runtime](#7-migration-testing-runtime)
- [Try testing runtime](#try-testing-runtime)
- [9. Run local testnet with parachain-launch](#9-run-local-testnet-with-parachain-launch)
- [10. Build For Release](#10-build-for-release)
- [11. Setup Local EVM+ Test Environment](#11-setup-local-evm-test-environment)
- [Setting up local node](#setting-up-local-node)
- [Compile the node from source code:](#compile-the-node-from-source-code)
- [Run node using docker:](#run-node-using-docker)
- [Setting up eth-rpc-adapter](#setting-up-eth-rpc-adapter)

<!-- /TOC -->

# 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. Overview
The significance of cross-chain communication to the blockchain is like that of the internet to the intranet. Polkadot empowers a network of public, consortium and private blockchains, and enables true interoperability, economic and transactional scalability. A cross-chain stablecoin system will:
1. Create a sound, stable currency for low cost, borderless value transfer for all chains in the network
2. Enable commercial lending with predictable risk
3. Serve as a building block for more open finance services

The Acala Dollar stablecoin (ticker: aUSD) is a multi-collateral-backed cryptocurrency, with value stable against US Dollar (aka. 1:1 aUSD to USD soft peg). It is completely decentralized, that it can be created using assets from blockchains connected to the Polkadot network including Ethereum and Bitcoin as collaterals, and can be used by any chains (or digital jurisdictions) within the Polkadot network and applications on those chains.

By this nature, it is essential that the Acala Network eventually become community-owned with an economic model that can sustain its development and participation in the Polkadot network, as well as ensure its stability and security. The following section will provide a high-level overview of the following topics:
- aUSD and the Honzon stablecoin protocol
- the economic model and initial parachain offering

## 2.1. aUSD and the Honzon stablecoin protocol
Every aUSD is backed in excess by a crypto asset, the mechanism of which is known as an over-collateralized debt position (or CDP). Together with a set of incentives, supply & demand balancing, and risk management mechanisms, as the core components of the Honzon stablecoin protocol on the Acala Network, the stability of the aUSD is ensured. The CDP mechanism design is inspired by the first decentralized stablecoin project MakerDAO, which has become the DeFi building block in the Ethereum ecosystem. Besides, the Honzon protocol enables many unique features - native multi-asset support, cross-chain stablecoin capability, automatic liquidation to increase responsiveness to risk, and pluggable oracle and auction house to improve modularity, just to name a few.

The Honzon protocol contains the following components
- Multi Collateral Type
- Collateral Adapter
- Oracle and Prices
- Auction and Auction Manager
- CDP and CDP Engine
- Emergency shutdown
- Governance
- Honzon as an interface to other components

Note: This section is still work in progress, we will update more information as we progress. Refer to the [Github Wiki](https://github.com/AcalaNetwork/Acala/wiki) for more details.

## 2.2. Acala Network Economic Model
The Acala Network Token (ACA) features the following utilities, and the value of ACA token will accrue with the increased usage of the network and revenue from stability fees and liquidation penalties
1. As Network Utility Token: to pay for network fees and stability fees
2. As Governance Token: to vote for/against risk parameters and network change proposals
3. As Economic Capital: in case of liquidation without sufficient collaterals

To enable cross-chain functionality, the Acala Network will connect to the Polkadot in one of the three ways:
1. as parathread - pay-as-you-go connection to Polkadot
2. as parachain - permanent connection for a given period
3. as an independent chain with a bridge back to Polkadot

Becoming a parachain would be an ideal option to bootstrap the Acala Network, and maximize its benefits and reach to other chains and applications on the Polkadot network. To secure a parachain slot, the Acala Network will require supportive DOT holders to lock their DOTs to bid for a slot collectively - a process known as the Initial Parachain Offering (IPO). ACA tokens will be offered as a reward for those who participated in the IPO, as compensation for their opportunity cost of staking the DOTs.

Note: This section is still work in progress, we will update more information as we progress. Refer to the [token economy working paper](https://github.com/AcalaNetwork/Acala-white-paper) for more details.

# 3. Building
# 2. Building

## NOTE

To connect on the "Mandala TC6" network, you will want the version `~0.7.10` code which is in this repo.
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.

- **Mandala TC6** is in [Acala repo master branch](https://github.com/AcalaNetwork/Acala/tree/master/).
If you would like to build the client node, please refer to [acala-node](https://github.com/AcalaNetwork/acala-node).

Install Rust:

Expand All @@ -123,21 +71,15 @@ Install required tools and install git hooks:
make init
```

Build Mandala TC native code:

```bash
make build-full
```

# 4. Run
# 3. Run

You can start a development chain with:

```bash
make run
```

# 5. Development
# 4. Development

To type check:

Expand All @@ -163,14 +105,12 @@ Update ORML
make update
```

__Note:__ All build command from Makefile are designed for local development purposes and hence have `SKIP_WASM_BUILD` enabled to speed up build time and use `--execution native` to only run use native execution mode.

# 6. Bug Bounty :bug:
# 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/

# 7. Bench Bot
# 6. Bench Bot
Bench bot can take care of syncing branch with `master` and generating WeightInfos for module or runtime.

## Generate module weights
Expand All @@ -191,8 +131,7 @@ Bench bot will do the benchmarking, generate weights file and push changes into

Comment on a PR `/bench evm` to benchmark Acala EVM+ and bench bot will generate precompile weights and GasToWeight ratio.


# 8. Migration testing runtime
# 7. Migration testing runtime
If modifying the storage, you should test the data migration before upgrading the runtime.

## Try testing runtime
Expand Down Expand Up @@ -226,86 +165,3 @@ cargo run --features with-acala-runtime --features try-runtime -- try-runtime --
# 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
```

# 9. Run local testnet with [parachain-launch](https://github.com/open-web3-stack/parachain-launch)
Build RelayChain and Parachain local testnet to develop.

```bash
cd launch

# install dependencies
yarn

# generate docker-compose.yml and genesis
# NOTE: If the docker image is not the latest, need to download it manually.
# e.g.: docker pull acala/karura-node:latest
# karura testnet:
yarn start generate
# karura-bifrost testnet:
yarn start generate --config=karura-bifrost.yml

# start relaychain and parachain
cd output
# NOTE: If regenerate the output directory, need to rebuild the images.
docker-compose up -d --build

# list all of the containers.
docker ps -a

# track container logs
docker logs -f [container_id/container_name]

# stop all of the containers.
docker-compose stop

# remove all of the containers.
docker-compose rm

# NOTE: If you want to clear the data and restart, you need to clear the volumes.
# remove volume
docker volume ls
docker volume rm [volume_name]
# prune all volumes
docker volume prune
```

# 10. Build For Release

For release artifacts, a more optimized build config is used.
This config takes around 2x to 3x longer to build, but produces a more optimized binary to run.

```bash
make build-release
```

# 11. Setup Local EVM+ Test Environment

To set up a basic local network you need two things running locally, a node and the eth-rpc-adapter. Setup each service in their respective terminals and then you are free to use your favorite EVM tools locally! (ex: hardhat)

## Setting up local node

#### Compile the node from source code:

```bash
make run
```

Note: You may need normal block production for certain workflow, use command below to run node without instant-sealing flag

```bash
cargo run --features with-mandala-runtime -- --dev -lruntime=debug
```

#### Run node using docker:

```bash
docker run -it --rm -p 9944:9944 -p 9933:9933 ghcr.io/acalanetwork/mandala-node:master --dev --ws-external --rpc-port=9933 --rpc-external --rpc-cors=all --rpc-methods=unsafe --tmp -levm=debug --instant-sealing
```

## Setting up eth-rpc-adapter

```bash
npx @acala-network/eth-rpc-adapter -l 1
```

Note: If your use case needs `eth_getLogs` rpc call, then you need to have a subquery instance to index the local chain. For this case, follow the tutorial found here: [Local Network Tutorial](https://evmdocs.acala.network/network/network-setup/local-development-network)

0 comments on commit 613470c

Please sign in to comment.