Skip to content

Commit 32d3f42

Browse files
committed
Add more docs
1 parent d6af1bf commit 32d3f42

File tree

6 files changed

+18
-3
lines changed

6 files changed

+18
-3
lines changed

contracts/Bridge.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
77
import "./libraries/PbBridge.sol";
88
import "./Pool.sol";
99

10+
/**
11+
* @title The liquidity-pool based bridge.
12+
*/
1013
contract Bridge is Pool {
1114
using SafeERC20 for IERC20;
1215

contracts/FarmingRewards.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ import "./interfaces/ISigsVerifier.sol";
99
import "./libraries/PbFarming.sol";
1010
import "./safeguard/Pauser.sol";
1111

12+
/**
13+
* @title A contract to hold and distribute farming rewards.
14+
*/
1215
contract FarmingRewards is Pauser {
1316
using SafeERC20 for IERC20;
1417

contracts/Pool.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ import "./safeguard/VolumeControl.sol";
1212
import "./safeguard/DelayedTransfer.sol";
1313
import "./Signers.sol";
1414

15-
// add liquidity and withdraw
16-
// withdraw can be used by user or liquidity provider
17-
15+
/**
16+
* @title Liquidity pool functions for {Bridge}.
17+
*/
1818
contract Pool is Signers, ReentrancyGuard, Pauser, VolumeControl, DelayedTransfer {
1919
using SafeERC20 for IERC20;
2020

contracts/Signers.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
66
import "@openzeppelin/contracts/access/Ownable.sol";
77
import "./interfaces/ISigsVerifier.sol";
88

9+
/**
10+
* @title Multi-sig verification and management functions for {Bridge}.
11+
*/
912
contract Signers is Ownable, ISigsVerifier {
1013
using ECDSA for bytes32;
1114

contracts/StakingReward.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ import {DataTypes as dt} from "./libraries/DataTypes.sol";
88
import "./safeguard/Pauser.sol";
99
import "./Staking.sol";
1010

11+
/**
12+
* @title A contract to hold and distribute CELR staking rewards.
13+
*/
1114
contract StakingReward is Pauser {
1215
using SafeERC20 for IERC20;
1316

contracts/WithdrawInbox.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ pragma solidity 0.8.9;
44

55
import "./safeguard/Ownable.sol";
66

7+
/**
8+
* @title A contract to initiate withdrawal requests for contracts tha provide liquidity to {Bridge}.
9+
*/
710
contract WithdrawInbox is Ownable {
811
// min allowed max slippage uint32 value is slippage * 1M, eg. 0.5% -> 5000
912
uint32 public minimalMaxSlippage;

0 commit comments

Comments
 (0)