Internal Audit

.env.example

@@ -0,0 +1,14 @@
+# Devnet configs
+DEVNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
+DEVNET_URL=http://localhost:8545
+
+# Testnet configs
+TESTNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
+TESTNET_URL=https://testnet.skymavis.one/rpc
+
+# Mainnet configs
+MAINNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
+MAINNET_URL=https://api.roninchain.com/rpc
+
+# Report gas
+REPORT_GAS=false

.github/workflows/unittest.yml

@@ -0,0 +1,14 @@
+name: Run tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    uses: axieinfinity/workflows-samples/.github/workflows/testing-node.yml@main
+    with:
+      node_version: v14.18.1

.gitignore

@@ -0,0 +1,13 @@
+artifacts/
+cache/
+node_modules/
+src/types/
+src/web3-types/
+dist/
+yarn-error.log
+.env
+.idea
+
+refs/
+.vscode
+remix-compiler.config.js

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,7 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+set -ex
+
+yarn lint-staged
+yarn compile

.prettierrc.json

@@ -0,0 +1,21 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "explicitTypes": "preserve",
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "singleQuote": false
+      }
+    },
+    {
+      "files": "*.{js,ts}",
+      "options": {
+        "singleQuote": true
+      }
+    }
+  ]
+}

README.md

@@ -1 +1,128 @@
-# Ronin DPos Contracts
+# Ronin DPoS Contracts
+
+The next version of smart contracts that power Ronin DPoS network.
+
+
+- [Overview](#ronin-dpos-contracts)
+  - [Staking contract](#staking-contract)
+    - [Validator Candidate](#validator-candidate)
+    - [Delegator](#delegator)
+    - [Reward Calculation](#reward-calculation)
+  - [Validator Contract](#validator-contract)
+  - [Slashing](#slashing)
+  - [Contract Interaction flow](#contract-interaction-flow)
+- [Development](#development)
+  - [Requirement](#requirement)
+  - [Compile & test](#compile---test)
+- [Deployment](#deployment)
+
+## Staking contract
+
+An user can propose themselves to be a validator candidate by staking their RON. Other users are allowed to register as delegators by staking any amount of RON to the staking contract, he/she can choose a validator to stake their coins.
+
+The ones on top `N` users with the highest amount of staked coins will become validators.
+
+### Validator Candidate
+
+**Proposing validator**
+
+| Params                   | Explanation                                                                                     |
+| ------------------------ | ----------------------------------------------------------------------------------------------- |
+| `uint256 commissionRate` | The rate to share for the validator. Values in range [0; 100_00] stands for [0; 100%]           |
+| `address consensusAddr`  | Address to produce block                                                                        |
+| `address treasuryAddr`   | Address to receive block reward                                                                 |
+| `msg.value`              | The amount of RON to stake, require to be larger than the minimum RON threshold to be validator |
+
+The validator candidates can deposit or withdraw their funds afterwards as long as the staking balance must be greater than the minimum RON threshold.
+
+**Renounce validator**
+
+The candidates can renounce the validator propose and take back their deposited RON.
+
+### Delegator
+
+The delegator can choose the validator to stake and receive the commission reward:
+
+| Methods                                                   | Explanation                                                                        |
+| --------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `delegate(consensusAddr)`                                 | Stakes `msg.value` amount of RON for a validator `consensusAddr`                   |
+| `undelegate(consensusAddr, amount)`                       | Unstakes from a validator                                                          |
+| `redelegate(consensusAddrSrc, consensusAddrDst, amount)`  | Unstakes `amount` RON from the `consensusAddrSrc` and stake for `consensusAddrDst` |
+| `getRewards(consensusAddrList)`                           | Returns the pending rewards and the claimable rewards                              |
+| `claimRewards(consensusAddrList)`                         | Claims all the reward from the validators                                          |
+| `delegateRewards(consensusAddrList, consensusAddr)` | Claims all the reward and delegates them to the consensus address                  |
+
+### Reward Calculation
+
+- Read how the reward is calculated for delegator at [Staking Problem: Reward Calculation](https://skymavis.notion.site/Staking-Problem-Reward-Calculation-bd47bbcefde24bbd8e959bee45dfd4a5).
+- See [`RewardCalculation` contract](./contracts/staking/RewardCalculation.sol) for the implementation.
+
+## Validator Contract
+
+The validator contract collects and distributes staking rewards, syncs the validator set from the staking contract at the end of every epoch.
+
+![image](./assets/Validator%20Contract%20Overview.drawio.png)
+_Validator contract flow overview_
+
+1. The block producer trigger to the Validator contract to wrap up the epoch.
+2. Validator contract counts the validator/delegator rewards to the Staking contract.
+3. Validator contract syncs validator set from staking contract.
+
+At the end of period, the validator contract:
+
+4. Transfers the rewards for validators.
+5. Resets the slashing counter.
+
+## Slashing
+
+The validators will be slashed when they do not provide the good service for Ronin network.
+
+**Unavailability**
+
+- If a validator missed >= `misdemeanorThreshold` blocks in a day: Cannot claim the reward on that day.
+
+- If a validator missed >= `felonyThreshold` blocks in a day:
+  - Cannot claim the reward on that day.
+  - Be slashed `slashFelonyAmount` amount of self-delegated RON.
+  - Be put in jail for `57600` blocks.
+
+**Double Sign**
+
+- If a validator submit more than 1 block at the same `block.number`:
+  - Cannot claim the reward.
+  - Be put in jail for `type(uint256).max` blocks.
+  - Be slashed `slashDoubleSignAmount` amount of self-delegated RON.
+
+## Contract Interaction flow
+
+Read the contract interaction flow at [DPoS Contract: Interaction Flow](https://skymavis.notion.site/DPoS-Contract-Interaction-Flow-3a535cf9048f46f69dd9a45958ad9b85).
+
+## Development
+
+### Requirement
+
+- Node@>=14 + Solc@^0.8.0
+
+### Compile & test
+
+```shell
+$ yarn install
+$ yarn compile
+$ yarn test
+```
+
+## Deployment
+
+- Init the environment variables:
+
+```shell
+$ cp .env.example .env && vim .env
+```
+
+- Update the contract configuration in [`config.ts`](./src/config.ts) file
+
+- Deploy the contracts:
+
+```shell
+$ yarn hardhat deploy --network <ronin-devnet|ronin-mainnet|ronin-testnet>
+```

contracts/extensions/GatewayV2.sol

@@ -0,0 +1,98 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/security/Pausable.sol";
+import "../interfaces/IQuorum.sol";
+import "./collections/HasProxyAdmin.sol";
+
+abstract contract GatewayV2 is HasProxyAdmin, Pausable, IQuorum {
+  uint256 internal _num;
+  uint256 internal _denom;
+
+  address private ______deprecated;
+  uint256 public nonce;
+
+  /**
+   * @dev This empty reserved space is put in place to allow future versions to add new
+   * variables without shifting down storage in the inheritance chain.
+   */
+  uint256[50] private ______gap;
+
+  /**
+   * @dev See {IQuorum-getThreshold}.
+   */
+  function getThreshold() external view virtual returns (uint256, uint256) {
+    return (_num, _denom);
+  }
+
+  /**
+   * @dev See {IQuorum-checkThreshold}.
+   */
+  function checkThreshold(uint256 _voteWeight) external view virtual returns (bool) {
+    return _voteWeight * _denom >= _num * _getTotalWeight();
+  }
+
+  /**
+   * @dev See {IQuorum-setThreshold}.
+   */
+  function setThreshold(uint256 _numerator, uint256 _denominator)
+    external
+    virtual
+    onlyAdmin
+    returns (uint256, uint256)
+  {
+    return _setThreshold(_numerator, _denominator);
+  }
+
+  /**
+   * @dev Triggers paused state.
+   */
+  function pause() external onlyAdmin {
+    _pause();
+  }
+
+  /**
+   * @dev Triggers unpaused state.
+   */
+  function unpause() external onlyAdmin {
+    _unpause();
+  }
+
+  /**
+   * @dev See {IQuorum-minimumVoteWeight}.
+   */
+  function minimumVoteWeight() public view virtual returns (uint256) {
+    return _minimumVoteWeight(_getTotalWeight());
+  }
+
+  /**
+   * @dev Sets threshold and returns the old one.
+   *
+   * Emits the `ThresholdUpdated` event.
+   *
+   */
+  function _setThreshold(uint256 _numerator, uint256 _denominator)
+    internal
+    virtual
+    returns (uint256 _previousNum, uint256 _previousDenom)
+  {
+    require(_numerator <= _denominator, "GatewayV2: invalid threshold");
+    _previousNum = _num;
+    _previousDenom = _denom;
+    _num = _numerator;
+    _denom = _denominator;
+    emit ThresholdUpdated(nonce++, _numerator, _denominator, _previousNum, _previousDenom);
+  }
+
+  /**
+   * @dev Returns minimum vote weight.
+   */
+  function _minimumVoteWeight(uint256 _totalWeight) internal view virtual returns (uint256) {
+    return (_num * _totalWeight + _denom - 1) / _denom;
+  }
+
+  /**
+   * @dev Returns the total weight.
+   */
+  function _getTotalWeight() internal view virtual returns (uint256);
+}