add tests for new token, renaming

contracts/optimism/L1ERC20TokenBridge.sol

@@ -71,7 +71,7 @@ contract L1ERC20TokenBridge is
  whenDepositsEnabled
  onlySupportedL1Token(l1Token_)
  onlySupportedL2Token(l2Token_)
- { 
+ {
  if (Address.isContract(msg.sender)) {
  revert ErrorSenderNotEOA();
  }
@@ -140,7 +140,7 @@ contract L1ERC20TokenBridge is
  if (isRebasableTokenFlow(l1Token_, l2Token_)) {
 
  DepositData memory depositData = DepositData({
- rate: IERC20Wrapable(l1TokenNonRebasable).tokensPerStEth(), // replace by stETHPerToken
+ rate: IERC20Wrapable(l1TokenNonRebasable).stETHPerToken(),
  time: block.timestamp,
  data: data_
  });

contracts/optimism/L2ERC20TokenBridge.sol

@@ -110,8 +110,8 @@ contract L2ERC20TokenBridge is
  {
  if (isRebasableTokenFlow(l1Token_, l2Token_)) {
  DepositData memory depositData = decodeDepositData(data_);
- ITokenRateOracle tokensRateOracle = ERC20Rebasable(l2TokenRebasable).tokensRateOracle();
- tokensRateOracle.updateRate(int256(depositData.rate), depositData.time);
+ ITokenRateOracle tokenRateOracle = ERC20Rebasable(l2TokenRebasable).tokenRateOracle();
+ tokenRateOracle.updateRate(int256(depositData.rate), depositData.time, 0);
  ERC20Rebasable(l2TokenRebasable).mintShares(to_, amount_);
  emit DepositFinalized(l1Token_, l2Token_, from_, to_, amount_, depositData.data);
  } else if (isNonRebasableTokenFlow(l1Token_, l2Token_)) {

contracts/stubs/ERC20WrapableStub.sol

@@ -47,7 +47,7 @@ contract ERC20WrapableStub is IERC20Wrapable, ERC20 {
  return stETHAmount;
  }
 
- function tokensPerStEth() external view returns (uint256) {
+ function stETHPerToken() external view returns (uint256) {
  return tokensRate;
  }
 }

contracts/stubs/TokenRateOracleStub.sol

@@ -49,9 +49,9 @@ contract TokenRateOracleStub is ITokenRateOracle {
  return latestRoundDataAnswer;
  }
 
- function updateRate(int256 rate, uint256 updatedAt) external {
+ function updateRate(int256 tokenRate_, uint256 rateL1Timestamp_, uint256 lastProcessingRefSlot_) external {
  // check timestamp not late as current one.
- latestRoundDataAnswer = rate;
- latestRoundDataUpdatedAt = updatedAt;
+ latestRoundDataAnswer = tokenRate_;
+ latestRoundDataUpdatedAt = rateL1Timestamp_;
  }
 }

contracts/token/ERC20Rebasable.sol

@@ -7,7 +7,7 @@ import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {IERC20Wrapable} from "./interfaces/IERC20Wrapable.sol";
 import {ITokenRateOracle} from "./interfaces/ITokenRateOracle.sol";
 import {ERC20Metadata} from "./ERC20Metadata.sol";
-import { console } from "hardhat/console.sol";
+// import { console } from "hardhat/console.sol";
 
 /// @author kovalgek
 /// @notice Extends the ERC20Shared functionality
@@ -23,24 +23,43 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
  error ErrorNotEnoughAllowance();
  error ErrorAccountIsZeroAddress();
  error ErrorDecreasedAllowanceBelowZero();
+ error ErrorNotBridge();
 
+ /// @notice Bridge which can mint and burn tokens on L2.
+ address public immutable bridge;
+
+ /// @notice Contract of non-rebasable token to wrap.
  IERC20 public immutable wrappedToken;
- ITokenRateOracle public immutable tokensRateOracle;
 
- /// @param wrappedToken_ address of the ERC20 token to wrap
- /// @param tokensRateOracle_ address of oracle that returns tokens rate
+ /// @notice Oracle contract used to get token rate for wrapping/unwrapping tokens.
+ ITokenRateOracle public immutable tokenRateOracle;
+
+ /// @inheritdoc IERC20
+ mapping(address => mapping(address => uint256)) public allowance;
+
+ /// @notice Basic unit representing the token holder's share in the total amount of ether controlled by the protocol.
+ mapping (address => uint256) private shares;
+
+ /// @notice The total amount of shares in existence.
+ uint256 private totalShares;
+
  /// @param name_ The name of the token
  /// @param symbol_ The symbol of the token
  /// @param decimals_ The decimals places of the token
+ /// @param wrappedToken_ address of the ERC20 token to wrap
+ /// @param tokenRateOracle_ address of oracle that returns tokens rate
+ /// @param bridge_ The bridge address which allowd to mint/burn tokens
  constructor(
- address wrappedToken_,
- address tokensRateOracle_,
  string memory name_,
  string memory symbol_,
- uint8 decimals_
+ uint8 decimals_,
+ address wrappedToken_,
+ address tokenRateOracle_,
+ address bridge_
  ) ERC20Metadata(name_, symbol_, decimals_) {
  wrappedToken = IERC20(wrappedToken_);
- tokensRateOracle = ITokenRateOracle(tokensRateOracle_);
+ tokenRateOracle = ITokenRateOracle(tokenRateOracle_);
+ bridge = bridge_;
  }
 
  /// @notice Sets the name and the symbol of the tokens if they both are empty
@@ -51,8 +70,6 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
  _setERC20MetadataSymbol(symbol_);
  }
 
- /// ------------IERC20Wrapable------------
-
  /// @inheritdoc IERC20Wrapable
  function wrap(uint256 sharesAmount_) external returns (uint256) {
  if (sharesAmount_ == 0) revert ErrorZeroSharesWrap();
@@ -75,25 +92,28 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
  return sharesAmount;
  }
 
- function tokensPerStEth() external pure returns (uint256) {
- return 0;
+ /// @inheritdoc IERC20Wrapable
+ function stETHPerToken() external view returns (uint256) {
+ return uint256(tokenRateOracle.latestAnswer());
  }
 
  // allow call only bridge
- function mintShares(address account_, uint256 amount_) external returns (uint256) {
+ function mintShares(address account_, uint256 amount_) external onlyBridge returns (uint256) {
  return _mintShares(account_, amount_);
  }
 
  // allow call only bridge
- function burnShares(address account_, uint256 amount_) external {
+ function burnShares(address account_, uint256 amount_) external onlyBridge {
  _burnShares(account_, amount_);
  }
 
-
- /// ------------ERC20------------
-
- /// @inheritdoc IERC20
- mapping(address => mapping(address => uint256)) public allowance;
+ /// @dev Validates that sender of the transaction is the bridge
+ modifier onlyBridge() {
+ if (msg.sender != bridge) {
+ revert ErrorNotBridge();
+ }
+ _;
+ }
 
  /// @inheritdoc IERC20
  function totalSupply() external view returns (uint256) {
@@ -212,35 +232,32 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
  emit Approval(owner_, spender_, amount_);
  }
 
-
- /// ------------Shares------------
- // API
- function sharesOf(address _account) external view returns (uint256) {
- return _sharesOf(_account);
+ /// @notice Get shares amount of the provided account.
+ /// @param account_ provided account address.
+ /// @return amount of shares owned by `_account`.
+ function sharesOf(address account_) external view returns (uint256) {
+ return _sharesOf(account_);
  }
 
+ /// @return total amount of shares.
  function getTotalShares() external view returns (uint256) {
  return _getTotalShares();
  }
 
+ /// @notice Get amount of tokens for a given amount of shares.
+ /// @param sharesAmount_ amount of shares.
+ /// @return amount of tokens for a given shares amount.
  function getTokensByShares(uint256 sharesAmount_) external view returns (uint256) {
  return _getTokensByShares(sharesAmount_);
  }
 
+ /// @notice Get amount of shares for a given amount of tokens.
+ /// @param tokenAmount_ provided tokens amount.
+ /// @return amount of shares for a given tokens amount.
  function getSharesByTokens(uint256 tokenAmount_) external view returns (uint256) {
  return _getSharesByTokens(tokenAmount_);
  }
 
- function getTokensRateAndDecimal() external view returns (uint256, uint256) {
- return _getTokensRateAndDecimal();
- }
-
- // private/internal
-
- mapping (address => uint256) private shares;
-
- uint256 private totalShares;
-
  function _sharesOf(address account_) internal view returns (uint256) {
  return shares[account_];
  }
@@ -251,32 +268,28 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
 
  function _getTokensByShares(uint256 sharesAmount_) internal view returns (uint256) {
  (uint256 tokensRate, uint256 decimals) = _getTokensRateAndDecimal();
- return (sharesAmount_ * (10 ** decimals)) / tokensRate;
+ return (sharesAmount_ * tokensRate) / (10 ** decimals);
  }
 
  function _getSharesByTokens(uint256 tokenAmount_) internal view returns (uint256) {
  (uint256 tokensRate, uint256 decimals) = _getTokensRateAndDecimal();
- return (tokenAmount_ * tokensRate) / (10 ** decimals);
+ return (tokenAmount_ * (10 ** decimals)) / tokensRate;
  }
 
  function _getTokensRateAndDecimal() internal view returns (uint256, uint256) {
- uint8 rateDecimals = tokensRateOracle.decimals();
- console.log("_getTokensRateAndDecimal1");
+ uint8 rateDecimals = tokenRateOracle.decimals();
 
  if (rateDecimals == uint8(0) || rateDecimals > uint8(18)) revert ErrorInvalidRateDecimals(rateDecimals);
- console.log("_getTokensRateAndDecimal2");
 
  (,
  int256 answer
  ,
  ,
  uint256 updatedAt
- ,) = tokensRateOracle.latestRoundData();
- console.log("_getTokensRateAndDecimal3");
+ ,) = tokenRateOracle.latestRoundData();
 
  if (updatedAt == 0) revert ErrorWrongOracleUpdateTime();
  if (answer <= 0) revert ErrorOracleAnswerIsNegative();
- console.log("_getTokensRateAndDecimal4");
 
  return (uint256(answer), uint256(rateDecimals));
  }
@@ -290,6 +303,7 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
  ) internal onlyNonZeroAccount(recipient_) returns (uint256) {
  totalShares = totalShares + amount_;
  shares[recipient_] = shares[recipient_] + amount_;
+ emit Transfer(address(0), recipient_, amount_);
  return totalShares;
  }
 
@@ -304,6 +318,7 @@ contract ERC20Rebasable is IERC20Wrapable, IERC20, ERC20Metadata {
  if (accountShares < amount_) revert ErrorNotEnoughBalance();
  totalShares = totalShares - amount_;
  shares[account_] = accountShares - amount_;
+ emit Transfer(account_, address(0), amount_);
  return totalShares;
  }
 

contracts/token/interfaces/IERC20Wrapable.sol

@@ -34,5 +34,5 @@ interface IERC20Wrapable {
  * @notice Get amount of wstETH for a one stETH
  * @return Amount of wstETH for a 1 stETH
  */
- function tokensPerStEth() external view returns (uint256);
+ function stETHPerToken() external view returns (uint256);
 }

contracts/token/interfaces/ITokenRateOracle.sol

@@ -26,5 +26,5 @@ interface ITokenRateOracle {
  function decimals() external view returns (uint8);
 
  /// @notice Updates token rate.
- function updateRate(int256 rate, uint256 rateL1Timestamp) external;
+ function updateRate(int256 tokenRate_, uint256 rateL1Timestamp_, uint256 lastProcessingRefSlot_) external;
 }

test/bridge-executor/optimism.integration.test.ts

@@ -219,7 +219,7 @@ async function ctxFactory() {
  "TTR"
  );
 
- const tokensRateOracleStub = await new TokenRateOracle__factory(l2Deployer).deploy();
+ const tokenRateOracleStub = await new TokenRateOracle__factory(l2Deployer).deploy();
 
  const optAddresses = optimism.addresses(networkName);
 
@@ -243,7 +243,7 @@ async function ctxFactory() {
  .erc20TokenBridgeDeployScript(
  l1Token.address,
  l1TokenRebasable.address,
- tokensRateOracleStub.address,
+ tokenRateOracleStub.address,
  {
  deployer: l1Deployer,
  admins: {