airdrop module

1. Introduction
2. Overview
- 2.1. aUSD and the Honzon stablecoin protocol
- 2.2. Acala Network Economic Model
3. Building
- NOTE
4. Run
5. Development
6. Bug Bounty 🐛
7. Bench Bot
8. Migration testing runtime
- Try testing runtime
9. Run local testnet with parachain-launch
10. Build For Release
11. Setup Local EVM+ Test Environment
- Setting up local node
  - Compile the node from source code:
  - Run node using docker:
- Setting up eth-rpc-adapter

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 and Polkawallet, 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:

Create a sound, stable currency for low cost, borderless value transfer for all chains in the network
Enable commercial lending with predictable risk
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 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

As Network Utility Token: to pay for network fees and stability fees
As Governance Token: to vote for/against risk parameters and network change proposals
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:

as parathread - pay-as-you-go connection to Polkadot
as parachain - permanent connection for a given period
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 for more details.

3. Building

NOTE

To connect on the "Mandala TC6" network, you will want the version ~0.7.10 code which is in this repo.

Mandala TC6 is in Acala repo master branch.

Install Rust:

curl https://sh.rustup.rs -sSf | sh

You may need additional dependencies, checkout substrate.io for more info

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.

git config --global submodule.recurse true

Install required tools and install git hooks:

make init

Build Mandala TC native code:

make build-full

4. Run

You can start a development chain with:

make run

5. Development

To type check:

make check-all

To purge old chain data:

make purge

To purge old chain data and run

make restart

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 🐛

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

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 <module_name> 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 <runtime> <module_name> 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.

8. Migration testing runtime

If modifying the storage, you should test the data migration before upgrading the runtime.

Try testing runtime

try-runtime on karura

# 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

# 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

9. Run local testnet with parachain-launch

Build RelayChain and Parachain local testnet to develop.

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.

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:

make run

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

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

Run node using docker:

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

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

	if <Module<T>>::try_free_transfer(who) {
	true
	} else {
	false
	}

	fn submit_unsigned_liquidation_tx(currency_id: CurrencyIdOf<T>, who: T::AccountId) -> Result<(), OffchainErr> {
	let call = Call::<T>::liquidate(currency_id, who);

	T::SubmitTransaction::submit_unsigned(call).map_err(\|_\| OffchainErr::SubmitTransaction)?;
	Ok(())
	}

	impl<T: Trait + Send + Sync> SignedExtension for AutomaticLiquidationValidation<T> {
	const IDENTIFIER: &'static str = "AutomaticLiquidationValidation";
	type AccountId = T::AccountId;
	type Call = <T as Trait>::Call;
	type AdditionalSigned = ();
	type DispatchInfo = DispatchInfo;
	type Pre = ();
	fn additional_signed(&self) -> rstd::result::Result<(), TransactionValidityError> {
	Ok(())
	}

	fn validate(
	&self,
	_who: &Self::AccountId,
	call: &Self::Call,
	_info: Self::DispatchInfo,
	_len: usize,
	) -> TransactionValidity {
	let call = match call.is_sub_type() {
	Some(call) => call,
	None => return Ok(ValidTransaction::default()),
	};

	match call {
	Call::<T>::liquidate(currency_id, account_id) => {
	// check cdp is unsafe
	if !<Module<T>>::is_unsafe_cdp(*currency_id, account_id) {
	InvalidTransaction::Stale.into()
	} else {
	let mut valid_tx = ValidTransaction::default();
	valid_tx.priority = TransactionPriority::max_value();
	Ok(valid_tx)
	}
	}
	_ => Ok(ValidTransaction::default()),
	}
	}
	}

	pub SurplusAuctionFixedSize get(fn surplus_auction_fixed_size): BalanceOf<T>;
	pub SurplusBufferSize get(fn surplus_buffer_size): BalanceOf<T>;
	pub InitialAmountPerDebitAuction get(fn initial_amount_per_debit_auction): BalanceOf<T>;
	pub DebitAuctionFixedSize get(fn debit_auction_fixed_size): BalanceOf<T>;
	pub CollateralAuctionMaximumSize get(fn collateral_auction_maximum_size): map hasher(blake2_256) CurrencyIdOf<T> => BalanceOf<T>;

	pub trait Trait: system::Trait {
	type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;

	type CurrencyId: From<u8> + Into<CurrencyIdOf<Self>> + Into<DebitCurrencyIdOf<Self>> + Parameter + Copy;
	type Price: FullCodec + SimpleArithmetic + Member + Into<u64> + From<Self::Balance>;
	type Balance: From<BalanceOf<Self>> + From<DebitBalanceOf<Self>> + Into<Self::Price> + Zero;

	type Convert: Convert<(Self::CurrencyId, DebitBalanceOf<Self>), BalanceOf<Self>>;
	type Currency: MultiCurrencyExtended<Self::AccountId>;
	type DebitCurrency: MultiCurrencyExtended<Self::AccountId>;
	type PriceSource: PriceProvider<Self::CurrencyId, Self::Price>;
	type RiskManager: RiskManager<Self::AccountId, Self::CurrencyId, AmountOf<Self>, DebitAmountOf<Self>>;
	}

	type CurrencyIdOf<T> = <<T as Trait>::Currency as MultiCurrency<<T as system::Trait>::AccountId>>::CurrencyId;
	type DebitCurrencyIdOf<T> = <<T as Trait>::DebitCurrency as MultiCurrency<<T as system::Trait>::AccountId>>::CurrencyId;

	type BalanceOf<T> = <<T as Trait>::Currency as MultiCurrency<<T as system::Trait>::AccountId>>::Balance;
	type DebitBalanceOf<T> = <<T as Trait>::DebitCurrency as MultiCurrency<<T as system::Trait>::AccountId>>::Balance;

	type AmountOf<T> = <<T as Trait>::Currency as MultiCurrencyExtended<<T as system::Trait>::AccountId>>::Amount;
	type DebitAmountOf<T> = <<T as Trait>::DebitCurrency as MultiCurrencyExtended<<T as system::Trait>::AccountId>>::Amount;

	pub type CurrencyIdOf<T> = <<T as Trait>::Currency as MultiCurrency<<T as system::Trait>::AccountId>>::CurrencyId;
	pub type AuctionIdOf<T> =
	<<T as Trait>::Auction as Auction<<T as system::Trait>::AccountId, <T as system::Trait>::BlockNumber>>::AuctionId;

	pub trait Trait: system::Trait {
	type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;
	type Currency: MultiCurrencyExtended<Self::AccountId>;

	pub type CurrencyIdOf<T> = <<T as Trait>::Currency as MultiCurrency<<T as system::Trait>::AccountId>>::CurrencyId;
	pub type DebitBalanceOf<T> =
	<<T as vaults::Trait>::DebitCurrency as MultiCurrency<<T as system::Trait>::AccountId>>::Balance;
	pub type AmountOf<T> = <<T as vaults::Trait>::Currency as MultiCurrencyExtended<<T as system::Trait>::AccountId>>::Amount;
	pub type DebitAmountOf<T> =
	<<T as vaults::Trait>::DebitCurrency as MultiCurrencyExtended<<T as system::Trait>::AccountId>>::Amount;

	pub trait Trait: system::Trait + auction_manager::Trait + vaults::Trait {
	type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;
	type Currency: MultiCurrencyExtended<Self::AccountId>;

acalanetwork / acala Goto Github PK

acala's Introduction

1. Introduction

2. Overview

2.1. aUSD and the Honzon stablecoin protocol

2.2. Acala Network Economic Model

3. Building

NOTE

4. Run

5. Development

6. Bug Bounty 🐛

7. Bench Bot

Generate module weights

Generate runtime weights

Bench Acala EVM+

8. Migration testing runtime

Try testing runtime

9. Run local testnet with parachain-launch

10. Build For Release

11. Setup Local EVM+ Test Environment

Setting up local node

Compile the node from source code:

Run node using docker:

Setting up eth-rpc-adapter

acala's People

Contributors

Stargazers

Watchers

Forkers

acala's Issues

Accounts module

First stage:

Second stage:

Final stage:

Testnet

Kusama Parachain

homa

module-homa

module-homa-council

module-staking-pool

module-polkadot-bridge

关停单一资产：

全局关停：

Acala Runtime Design

注：

模块结构：

Common Modules (ORML)

Acala Runtime Modules

dex module

Trait

Storage

Call

Module: DexManager

债务管理

Recommend Projects

Recommend Topics

Recommend Org

Jobs