diff --git a/docs/ecosystem.md b/docs/community/collaboration.md similarity index 53% rename from docs/ecosystem.md rename to docs/community/collaboration.md index a48b5a5..aa31fa4 100644 --- a/docs/ecosystem.md +++ b/docs/community/collaboration.md @@ -1,6 +1,8 @@ # Ecosystem Collaboration -Welcome to the Darwinia ecosystem! We're here to help developers build amazing decentralized applications (dApps) that can interact with our blockchain. Our ecosystem is filled with tools and resources to make this possible. Check out what's already been built on our network at [Darwinia Ecosystem App Site](https://apps.darwinia.network/). We encourage you to join us and start building your own dApps! +Welcome to the Darwinia ecosystem! We're here to help developers build amazing decentralized applications (dApps) that can interact with our blockchain. Our ecosystem is filled with tools and resources to make this possible. + +Check out what's already been built on our network at [Darwinia Ecosystem App Site](https://apps.darwinia.network/). We encourage you to join us and start building your own dApps! ## Roadmap @@ -8,9 +10,11 @@ The roadmap for the ecosystem is outlined at [Darwinia Roadmap](https://itering. ## Community Collaboration -We wholeheartedly believe in the power of collaboration and warmly invite additional decentralized applications (dApps) to join our rapidly expanding Darwinia ecosystem. To facilitate this, we have launched the Community Developer Incentive Program. This program consists of: +We wholeheartedly believe in the power of collaboration and warmly invite additional decentralized applications to join our rapidly expanding Darwinia ecosystem. To facilitate this, we have launched the Community Developer Incentive Program. This program consists of: - [**The Immunefi Bounty Program**](https://immunefi.com/bounty/darwinia/) offers rewards for finding potential flaws in our products. - [**RFP (Request For Proposals)**](https://github.com/darwinia-network/collaboration/issues) provides a selection of potential projects or tasks for members of the ecosystem, allowing them to choose based on their interests and expertise. +- [**Grant Program**](https://github.com/darwinia-network/collaboration/blob/master/grant/README.md) To fund the development of projects and applications that contribute to the Darwinia ecosystem and promote overall network growth, we encourage passionate teams to build innovative cross-chain projects on Darwinia Chain. +- [**Treasury Proposal**](https://github.com/darwinia-network/collaboration/blob/master/treasury/README.md) Your proposal should address a problem, outline a goal, give a detailed account of how you will reach that goal, and include any ongoing maintenance needs. As much as possible, you should itemize the tasks to be completed so fees can be evaluated and milestones can be followed. By participating in these programs, community developers can play a vital role in shaping the evolution and growth of the Darwinia ecosystem. We look forward to collaborating with talented developers like you to drive innovation and build a thriving community of decentralized applications. \ No newline at end of file diff --git a/docs/community/dcdao.md b/docs/community/dcdao.md new file mode 100644 index 0000000..53c4186 --- /dev/null +++ b/docs/community/dcdao.md @@ -0,0 +1,9 @@ +# Overview + +The Darwinia Community DAO (DCDAO) is a community self-organized workgroup (WG) that aims to contribute to the growth and development of the Darwinia community. Sponsored by the Darwinia Treasury and Itering, the DCDAO welcomes donations and contributions from community members who share its vision and objectives. + +# Resources + +1. Snapshot: https://snapshot.org/#/darwiniacommunitydao.eth +2. Forum: https://github.com/dcdao/discussion +3. Membership: https://github.com/dcdao/profiles \ No newline at end of file diff --git a/docs/community/ktondao.md b/docs/community/ktondao.md new file mode 100644 index 0000000..1754856 --- /dev/null +++ b/docs/community/ktondao.md @@ -0,0 +1,31 @@ +# Join the Disucssion + +KtonDAO is a community initiative primarily initiated and conceived by KTON holders. Although it is not yet fully formed, there have been some [forum discussions](https://github.com/orgs/dcdao/discussions/32). KTON is designed to specialize in long-term staking incentives and reward strategies, encouraging long-term commitment from network supporters. + +# KTON and KTON Staking + +KTON was introduce to incentive and exchange for the long commitment of RING. The initial supply of this token is zero, and it is specifically minted when a user participates in the deposit system by locking RING for a predetermined period. This serves as a incentive for contributing commitment of *RING*. Once acquired, KTON can be utilized to participate in the [KTON Staking](https://kton-staking.darwinia.network/) grogram. + +Take the Darwinia chain as an example, users have the option to lock their *RING* for a maximum of 36 months during the staking process. As a form of reward for their participation in staking, the system grants users *KTON*. It is crucial to note that users cannot unlock their *RING* during the committed pledge period unless they forfeit triple the amount of *KTON* from their accounts as a penalty. Consequently, during the *RING* staking process, users have the discretion to lock their *RING* for a specific period and receive *KTON* in return. + +## KTON Specification + +KTON spec can be found on Darwinia [Notion](https://darwinia.notion.site/KTON-Specification-on-Different-Chains-cbb4b2f65c12421282f5f19e310a82d2?pvs=74) + +## Deposit Precompile +TBD + +## Extrinsic API + +- `lock(amount: Balance, months: u8)` + - Lock *RING* for some *KTON* profit/interest. + - Params: + - `amount` : the quantity to be locked. + - `months` : the duration for which the amount is to be locked. +- `claim()` + - Claim the expired-locked *RING*. +- `claim_with_penalty(deposit_id: DepositId)` + - Claim the unexpired-locked *RING* by paying the *KTON* penalty. + - Params: + - `deposit_id`: the specific deposit that you intend to claim. + diff --git a/docs/community/overview.md b/docs/community/overview.md new file mode 100644 index 0000000..a70de8a --- /dev/null +++ b/docs/community/overview.md @@ -0,0 +1,17 @@ +# Overview + +Welcome to Darwinia, a community-run blockchain network designed to enhance the cross-chain capabilities of decentralized applications. Darwinia leverages cutting-edge technology to facilitate seamless and secure inter-blockchain transactions. This document introduces you to the vibrant organizations and innovative projects that underpin our ecosystem. + +# Community Organizations + +Darwinia is supported by dedicated organizations, each playing a critical role in governance, development, and the enhancement of our network: + + - **RingDAO:** Focused on governance decisions, RingDAO allows RING token holders to participate directly in the decision-making processes, ensuring that Darwinia remains a truly decentralized network. + + - **DCDAO:** DCDAO is a community self-organized workgroup (WG) that aims to contribute to the growth and development of the Darwinia community. + + - **Itering:** Itering is a blockchain technology development company that provides runtime and smart contract engineering implementations for Darwinia. It is also the founding company of Darwinia. + + - **KtonDAO:** KtonDAO is a community initiative primarily initiated and conceived by KTON holders. Although it is not yet fully formed, there have been some [forum discussions](https://github.com/orgs/dcdao/discussions/32). KTON is designed to specialize in long-term staking incentives and reward strategies, encouraging long-term commitment from network supporters. + + - **Crab SubDAO:** Crab SubDAO is a DAO currently in design and will exist as a SubDAO of RingDAO. CRAB is its governance token, which is expected to be used for governing the Crab Chain, the experimental canary chain of Darwinia Chain. The design and concept of the SubDAO are inspired by Maker SubDAO. \ No newline at end of file diff --git a/docs/community/ringdao.md b/docs/community/ringdao.md new file mode 100644 index 0000000..c5a6977 --- /dev/null +++ b/docs/community/ringdao.md @@ -0,0 +1,12 @@ +# Overview +RingDAO is a upcoming DAO based using Tally on Darwinia Chain, intended for governing the Darwinia Chain in its next version. It is currently under development and implementation. [**RING**](https://coinmarketcap.com/currencies/darwinia-network/) will be the govenance token of RingDAO. RING has an initial supply of 2 billion tokens, and its token model can be found in [Genepaper V4](https://darwinia.network/Genepaper_v4.pdf). + +# Other Utilities of RING + +RING token is also used as the native and gas token of Darwinia Chain, it is also used for collator staking etc. + +## Other Projects governed by RingDAO + + 1. Msgport, https://docs.msgport.xyz/ + 2. XAPI, https://github.com/xapi-box + diff --git a/docs/learn/collator-staking.md b/docs/learn/collator-staking.md new file mode 100644 index 0000000..3d3a96e --- /dev/null +++ b/docs/learn/collator-staking.md @@ -0,0 +1,20 @@ +# Overview +Collator staking involves participants locking up their RING tokens to support the network’s operations and security through a nomination mechanism. In this system, users can participate either as nominators or collators to help the chain's liveness, earning rewards in return. To get started with the DApp, visit[Collator Staking](https://collator-staking.darwinia.network/) is used to + + +## Development + +If you want to learn how to interact with these Collator Staking Precompile contracts, pleast vist the [precompile detail page](./ethereum-compatibility/precompiles/staking.md), be aware that this contract may be deprecated in future versions. + +### **Parameters** +The parameters to be aware of when understanding the darwinia staking module are as follows: + +- `MinStakingDuration` - *Minimum time to stake at least.* +- `MaxDeposits` - *Maximum deposit count.* +- `MaxUnstakings` - *Maximum unstaking/unbonding count.* + +| | Darwinia | Crab | Pangolin Testnet | +| --- | --- | --- | --- | +| MinStakingDuration | 14 days | 14 days | 2 mins | +| MaxDeposits | 100 | 512 | 512 | +| MaxUnstakings | 16 | 16 | 16 | \ No newline at end of file diff --git a/docs/learn/stake/commitment-token.md b/docs/learn/stake/commitment-token.md deleted file mode 100644 index 5ce0bac..0000000 --- a/docs/learn/stake/commitment-token.md +++ /dev/null @@ -1,25 +0,0 @@ -# Commitment Token - -Darwinia's staking system introduces the Commitment Token as a distinctive feature. The initial supply of this token is zero, and it is specifically minted when a user participates in the staking system by locking their native tokens for a predetermined period. This serves as a reward for contributing native tokens to enhance the security of the Darwinia chains. Once acquired, the Commitment Token can be utilized to participate in the staking commitment token pool. - -Take the Darwinia chain as an example, users have the option to lock their *RING* for a maximum of 36 months during the staking process. As a form of reward for their participation in staking, the system grants users *KTON*. It is crucial to note that users cannot unlock their *RING* during the committed pledge period unless they forfeit triple the amount of *KTON* from their accounts as a penalty. Consequently, during the *RING* staking process, users have the discretion to lock their *RING* for a specific period and receive *KTON* in return. Initially, the supply of *KTON* is zero. *KTON* can also be pledged to gain staking power and participate in PoS mining. Users can opt to stake by pledging their *KTON*. However, if a user chooses to withdraw their staked *KTON*, the corresponding PoS mining process will be suspended, and it will take 14 days for the unbonded *KTON* to become available. - -## Network Commitment Token - -### Darwinia Chain - -| Symbol | Decimal | Initial Supply | -| --- | --- | --- | -| KTON | 18 | 0 | - -### Crab Chain - -| Symbol | Decimal | Initial Supply | -| --- | --- | --- | -| CKTON | 18 | 0 | - -### Pangolin Chain(Test) - -| Symbol | Decimal | Initial Supply | -| --- | --- | --- | -| PKTON | 18 | 0 | \ No newline at end of file diff --git a/docs/learn/stake/deposit.md b/docs/learn/stake/deposit.md deleted file mode 100644 index c9280ff..0000000 --- a/docs/learn/stake/deposit.md +++ /dev/null @@ -1,27 +0,0 @@ -# Deposit Module - -## Important Parameters - -The important parameters to be aware of when understanding the darwinia deposit module are as follows: - -- `MinLockingAmount` - *Minimum amount to lock at least.* - -## Parameters In The Networks - -| | Darwinia | Crab | Pangolin Testnet | -| --- | --- | --- | --- | -| MinLockingAmount | 1 RING | 1 CRAB | 1 PRING | - -## Extrinsic API Documentation - -- `lock(amount: Balance, months: u8)` - - Lock *RING* for some *KTON* profit/interest. - - Params: - - `amount` : the quantity to be locked. - - `months` : the duration for which the amount is to be locked. -- `claim()` - - Claim the expired-locked *RING*. -- `claim_with_penalty(deposit_id: DepositId)` - - Claim the unexpired-locked *RING* by paying the *KTON* penalty. - - Params: - - `deposit_id`: the specific deposit that you intend to claim. \ No newline at end of file diff --git a/docs/learn/stake/staking.md b/docs/learn/stake/staking.md deleted file mode 100644 index 007789e..0000000 --- a/docs/learn/stake/staking.md +++ /dev/null @@ -1,58 +0,0 @@ -# Staking Module - -## Important Parameters - -The important parameters to be aware of when understanding the darwinia staking module are as follows: - -- `MinStakingDuration` - *Minimum time to stake at least.* -- `MaxDeposits` - *Maximum deposit count.* -- `MaxUnstakings` - *Maximum unstaking/unbonding count.* - -## **Parameters In The Networks** - -| | Darwinia | Crab | Pangolin Testnet | -| --- | --- | --- | --- | -| MinStakingDuration | 14 days | 14 days | 2 mins | -| MaxDeposits | 100 | 512 | 512 | -| MaxUnstakings | 16 | 16 | 16 | - -## Extrinsic API Documentation - -- `stake(ring_amount: Balance, kton_amount: Balance, deposits: Vec>)` - - Add stakes to the staking pool. This will transfer the stakes to a pallet/contact account. - - Params: - - `ring_amount`: the amount of RING to be staked. - - `kton_amount`: the amount of KTON to be staked. - - `deposits`: a vector of specific deposits that you want to add to the staking pool. -- `unstake(ring_amount: Balance, kton_amount: Balance, deposits: Vec>)` - - Withdraw stakes from the staking pool. - - Params: - - `ring_amount`: the amount of RING to be withdrawn. - - `kton_amount`: the amount of KTON to be withdrawn. - - `deposits`: a vector of specific deposits that you want to withdraw from the staking pool. -- `restake(ring_amount: Balance, kton_amount: Balance, deposits: Vec>)` - - Cancel the `unstake` operation. Re-stake the unstaking assets immediately. - - Params: - - `ring_amount`: the amount of RING to be restaked. - - `kton_amount`: the amount of KTON to be restaked. - - `deposits`: a vector of specific deposits that you want to restake immediately. -- `claim`: - - claim the stakes from the pallet/contract account. -- `collect(commission: Perbill)` - - !!! note - Please note that the staking commission design on the Darwinia network differ significantly from the Polkadot. See [DIP-1](https://dips.darwinia.network/DIPs/dip-1.html) for details. - - - Declare the desire to collect. Effects will be felt at the beginning of the next session. - - Params: - - `commission`: the proportion of the staking reward that you want to collect, represented as a perbill (a fraction of a billion). -- `nominate(target: T::AccountId)` - - Declare the desire to nominate a collator. Effects will be felt at the beginning of the next session. - - Params: - - `target`: the account ID of the collator you wish to nominate. -- `chill` - - Declare no desire to either collect or nominate. Effects will be felt at the beginning of the next era. If the target is a collator, its nominators need to re-nominate. -- `set_collator_count(count: u32)` - - Set collator count. This will apply to the incoming session. Require root origin. - - Params: - - `count`: the number of collators you want to set for the upcoming session. \ No newline at end of file diff --git a/docs/ring.md b/docs/ring.md deleted file mode 100644 index 5c42c34..0000000 --- a/docs/ring.md +++ /dev/null @@ -1,7 +0,0 @@ -# RING - -[**RING**](https://coinmarketcap.com/currencies/darwinia-network/) is the native and governance token of Darwinia Network and can also be used for gas fees on the Darwinia chains. It also serving to fund the on-chain treasury and incentive validators, collators, stakers etc. - -## Token Model - -RING has an initial supply of 2 billion tokens, and its token model analysis can be found in [Genepaper V4](https://darwinia.network/Genepaper_v4.pdf). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f5478ee..df809f2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -139,6 +139,7 @@ nav: - Rollup Testnet: "learn/chains/rollup.md" - Wallets: "learn/wallets.md" - Governance: "learn/governance.md" + - Collator Staking: "learn/collator-staking.md" - Ethereum Compatibility: - Account System: "learn/ethereum-compatibility/account-system.md" - JSON-RPC APIs: "learn/ethereum-compatibility/jsonrpc.md" @@ -154,12 +155,8 @@ nav: - State Storage Precompile: "learn/ethereum-compatibility/precompiles/state-storage.md" - Dispatch Precompile: "learn/ethereum-compatibility/precompiles/dispatch.md" - Conviction Voting Precompile: "learn/ethereum-compatibility/precompiles/conviction-voting.md" - - Darwinia Staking: - - Commitment Token: "learn/stake/commitment-token.md" - - Staking Pallet: "learn/stake/staking.md" - - Deposit Pallet: "learn/stake/deposit.md" - FAQs: "learn/faq.md" - - Build In Darwinia: + - Build on Darwinia: - Getting Started: - Token Transfer: "build/getting-started/transfer-token.md" - Staking: "build/getting-started/staking.md" @@ -170,7 +167,7 @@ nav: - Darwinia 1.0 Migration: - Migrate Generate Account: "build/getting-started/migration/generate-account.md" - Migrate Multisig Account: "build/getting-started/migration/multisig-account.md" - - Build In Darwinia: + - Build on Darwinia: - Smart Contracts: - Interacting with Web3.js: "build/smart-contract/interact-with-web3js.md" - Interacting with Ethers.js: "build/smart-contract/interact-with-ethersjs.md" @@ -185,5 +182,9 @@ nav: - Running an Archive Node: "build/chain/run-archive-node.md" - Running an EVM Tracing Node: "build/chain/run-evm-tracing-node.md" - Running a Development Node: "build/chain/run-dev-node.md" - - RingDAO: "ring.md" - - Ecosystem Collaboration: "ecosystem.md" + - Community: + - Overview: "community/overview.md" + - Collaboration: "community/collaboration.md" + - RingDAO: "community/ringdao.md" + - DCDAO: "community/dcdao.md" + - KtonDAO: "community/ktondao.md"