Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FeeCurrency Adapter #10907

Merged
merged 26 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ea1b600
FeeCurrency Adapter
pahor167 Jan 25, 2024
a2bf3a7
PR comments
pahor167 Jan 25, 2024
cf95eea
Format documents
pahor167 Jan 25, 2024
c6def5b
gitmodules
pahor167 Jan 25, 2024
85526d5
submodules added
pahor167 Jan 25, 2024
1b48947
solidity version fix
pahor167 Jan 25, 2024
8d8f2d6
OZ contracts same commit as master
pahor167 Jan 25, 2024
5d41cff
Revert "OZ contracts same commit as master"
pahor167 Jan 25, 2024
aea9743
OZ to same commit as master
pahor167 Jan 25, 2024
3f78efb
Getter&Setter for wrapped token
pahor167 Jan 25, 2024
c36e60e
Proxy added
pahor167 Jan 25, 2024
83d2eb4
split of FeeCurrencyAdapter
pahor167 Jan 25, 2024
8d943b4
prettier fix
pahor167 Jan 25, 2024
6d4f4f1
refactor
pahor167 Jan 25, 2024
0ed3120
Update packages/protocol/test-sol/stability/FeeCurrencyAdapter.t.sol
pahor167 Jan 25, 2024
0803164
PR comments
pahor167 Jan 26, 2024
eeb4643
Merge branch 'pahor/feeCurrencyWrapper' of https://github.com/celo-or…
pahor167 Jan 26, 2024
aa2c09e
Merge branch 'release/core-contracts/11_2' into pahor/feeCurrencyWrapper
pahor167 Jan 26, 2024
7acf5ef
PR comments
pahor167 Jan 26, 2024
a598b2b
Decimals + Total supply added
pahor167 Jan 26, 2024
05ba9f6
Merge branch 'release/core-contracts/11_2' into pahor/feeCurrencyWrapper
timmoreton Jan 27, 2024
e3707a4
Update packages/protocol/contracts-0.8/stability/FeeCurrencyAdapter.sol
martinvol Jan 29, 2024
f35c79c
Update packages/protocol/contracts-0.8/stability/FeeCurrencyAdapter.sol
martinvol Jan 29, 2024
b5b5ed6
Trigger
alvarof2 Jan 29, 2024
7671925
Wrapper reference removed
pahor167 Jan 29, 2024
71796da
interface added
pahor167 Jan 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[submodule "packages/protocol/lib/celo-foundry"]
path = packages/protocol/lib/celo-foundry
url = https://github.com/bowd/celo-foundry
[submodule "packages/protocol/lib/solidity-bytes-utils"]
path = packages/protocol/lib/solidity-bytes-utils
url = https://github.com/GNSPS/solidity-bytes-utils
Expand All @@ -10,6 +7,15 @@
[submodule "packages/protocol/lib/mento-core"]
path = packages/protocol/lib/mento-core
url = https://github.com/mento-protocol/mento-core
[submodule "lib/memview.sol"]
[submodule "packages/protocol/lib/memview.sol"]
path = packages/protocol/lib/memview.sol
url = https://github.com/summa-tx/memview.sol
[submodule "packages/protocol/lib/celo-foundry"]
path = packages/protocol/lib/celo-foundry
url = https://github.com/celo-org/celo-foundry
[submodule "packages/protocol/lib/openzeppelin-contracts8"]
path = packages/protocol/lib/openzeppelin-contracts8
url = https://github.com/OpenZeppelin/openzeppelin-contracts
[submodule "packages/protocol/lib/celo-foundry-8"]
path = packages/protocol/lib/celo-foundry-8
url = https://github.com/celo-org/celo-foundry
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// SPDX-License-Identifier: UNLICENSED
pahor167 marked this conversation as resolved.
Show resolved Hide resolved
pragma solidity >=0.8.7 <0.8.20;

import "./FeeCurrencyAdapterOwnable.sol";

contract CeloFeeCurrencyAdapterOwnable is FeeCurrencyAdapterOwnable {
/**
* @notice Sets initialized == true on implementation contracts
* @param test Set to true to skip implementation initialization
*/
constructor(bool test) FeeCurrencyAdapterOwnable(test) {}

/**
* @notice Returns the storage, major, minor, and patch version of the contract.
* @return Storage version of the contract.
* @return Major version of the contract.
* @return Minor version of the contract.
* @return Patch version of the contract.
*/
function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
return (1, 1, 0, 0);
}
}
145 changes: 145 additions & 0 deletions packages/protocol/contracts-0.8/stability/FeeCurrencyAdapter.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
// SPDX-License-Identifier: UNLICENSED
pahor167 marked this conversation as resolved.
Show resolved Hide resolved
pragma solidity >=0.8.7 <0.8.20;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stability may not be the same folder for this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What other folder are you suggesting ?


import "@openzeppelin/contracts8/access/Ownable.sol";
import "@openzeppelin/contracts8/token/ERC20/IERC20.sol";

import "../../contracts/common/CalledByVm.sol";
import "../../contracts/common/Initializable.sol";
import "../../contracts/common/interfaces/ICeloVersionedContract.sol";
import "../../contracts/common/FixidityLib.sol";
import "../../contracts/stability/interfaces/ISortedOracles.sol";
import "./interfaces/IFeeCurrency.sol";
import "./interfaces/IDecimals.sol";

contract FeeCurrencyAdapter is Initializable, CalledByVm {
martinvol marked this conversation as resolved.
Show resolved Hide resolved
pahor167 marked this conversation as resolved.
Show resolved Hide resolved
martinvol marked this conversation as resolved.
Show resolved Hide resolved
IFeeCurrency public wrappedToken;
pahor167 marked this conversation as resolved.
Show resolved Hide resolved

uint96 public digitDifference;

uint256 public debited;
martinvol marked this conversation as resolved.
Show resolved Hide resolved

string public name;
string public symbol;

/**
* @notice Sets initialized == true on implementation contracts
* @param test Set to true to skip implementation initialization
*/
constructor(bool test) public Initializable(test) {}

/**
* @notice Used in place of the constructor to allow the contract to be upgradable via proxy.
* @param _wrappedToken The address of the wrapped token.
* @param _name The name of the wrapped token.
* @param _symbol The symbol of the wrapped token.
* @param _expectedDecimals The expected number of decimals of the wrapped token.
*/
function initialize(
address _wrappedToken,
string memory _name,
string memory _symbol,
uint8 _expectedDecimals
) public virtual initializer {
_setWrappedToken(_wrappedToken);
name = _name;
symbol = _symbol;
uint8 decimals = IDecimals(_wrappedToken).decimals();
digitDifference = uint96(10**(_expectedDecimals - decimals));
mcortesi marked this conversation as resolved.
Show resolved Hide resolved
}

/**
* @notice Gets the balance of the specified address with correct digits.
* @param account The address to query the balance of.
* @return The balance of the specified address.
*/
function balanceOf(address account) public view returns (uint256) {
return upscale(wrappedToken.balanceOf(account));
}

/**
* Downscales value to the wrapped token's native digits and debits it.
* @param from from address
* @param value Debited value in the wrapped digits.
*/
function debitGasFees(address from, uint256 value) external onlyVm {
pahor167 marked this conversation as resolved.
Show resolved Hide resolved
uint256 toDebit = downscale(value);
require(toDebit > 0, "Must debit at least one token.");
debited = toDebit;
wrappedToken.debitGasFees(from, toDebit);
}

/**
* Downscales value to the wrapped token's native digits and credits it.
* @param refundRecipient The recipient of the refund.
* @param tipRecipient The recipient of the tip.
* @param _gatewayFeeRecipient The recipient of the gateway fee. Unused.
* @param baseFeeRecipient The recipient of the base fee.
* @param refundAmount The amount to refund (in wrapped token digits).
* @param tipAmount The amount to tip (in wrapped token digits).
* @param _gatewayFeeAmount The amount of the gateway fee (in wrapped token digits). Unused.
* @param baseFeeAmount The amount of the base fee (in wrapped token digits).
*/
function creditGasFees(
pahor167 marked this conversation as resolved.
Show resolved Hide resolved
address refundRecipient,
address tipRecipient,
address _gatewayFeeRecipient,
address baseFeeRecipient,
uint256 refundAmount,
uint256 tipAmount,
uint256 _gatewayFeeAmount,
uint256 baseFeeAmount
) public onlyVm {
if (debited == 0) {
// When eth.estimateGas is called, this function is called but we don't want to credit anything.
return;
}

uint256 refundScaled = downscale(refundAmount);
uint256 tipTxFeeScaled = downscale(tipAmount);
uint256 baseTxFeeScaled = downscale(baseFeeAmount);

require(
refundScaled + tipTxFeeScaled + baseTxFeeScaled <= debited,
"Cannot credit more than debited."
);

uint256 roundingError = debited - (refundScaled + tipTxFeeScaled + baseTxFeeScaled);

if (roundingError > 0) {
baseTxFeeScaled += roundingError;
}
wrappedToken.creditGasFees(
refundRecipient,
tipRecipient,
address(0),
baseFeeRecipient,
refundScaled,
tipTxFeeScaled,
0,
baseTxFeeScaled
);

debited = 0;
}

/**
* @notice Returns wrapped token address.
* @return The wrapped token address.
*/
function getWrappedToken() external view returns (address) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be part of IAdapter

return address(wrappedToken);
}

function upscale(uint256 value) internal view returns (uint256) {
return value * digitDifference;
}

function downscale(uint256 value) internal view returns (uint256) {
return value / digitDifference;
}

function _setWrappedToken(address _wrappedToken) internal virtual {
wrappedToken = IFeeCurrency(_wrappedToken);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.8.7 <0.8.20;

import "@openzeppelin/contracts8/access/Ownable.sol";
import "@openzeppelin/contracts8/token/ERC20/IERC20.sol";

import "./FeeCurrencyAdapter.sol";

contract FeeCurrencyAdapterOwnable is FeeCurrencyAdapter, Ownable {
/**
* @notice Sets initialized == true on implementation contracts
* @param test Set to true to skip implementation initialization
*/
constructor(bool test) FeeCurrencyAdapter(test) {}

/**
* @notice Used in place of the constructor to allow the contract to be upgradable via proxy.
* @param _wrappedToken The address of the wrapped token.
* @param _name The name of the wrapped token.
* @param _symbol The symbol of the wrapped token.
* @param _expectedDecimals The expected number of decimals of the wrapped token.
*/
function initialize(
address _wrappedToken,
string memory _name,
string memory _symbol,
uint8 _expectedDecimals
) public override {
_transferOwnership(msg.sender);
super.initialize(_wrappedToken, _name, _symbol, _expectedDecimals);
}

/**
* @notice Sets wrapped token address.
* @param _wrappedToken The address of the wrapped token.
*/
function setWrappedToken(address _wrappedToken) public onlyOwner {
_setWrappedToken(_wrappedToken);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pragma solidity ^0.8.13;

interface IDecimals {
function decimals() external view returns (uint8);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
pragma solidity ^0.8.13;

import "@openzeppelin/contracts8/token/ERC20/IERC20.sol";

interface IFeeCurrency is IERC20 {
/*
This interface should be implemented for tokens which are supposed to
act as fee currencies on the Celo blockchain, meaning that they can be
used to pay gas fees for CIP-64 transactions (and some older tx types).
See https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0064.md

Before executing a tx with non-empty feeCurrency field, the fee
currency's `debitGasFees` function is called to reserve the maximum
amount that tx can spend on gas. After the tx has been executed, the
`creditGasFees` function is called to refund the unused gas and credit
the spent fees to the correct recipients. Events which are raised inside
these functions will show up for every transaction using the token as a
fee currency.

Requirements:
- The functions will be called by the blockchain client with `msg.sender
== address(0)`. If this condition is not met, the functions must
revert to prevent malicious users from crediting their accounts directly.
- `creditGasFees` must credit all specified amounts. If it impossible to
credit one of the recipients for some reason, add the amount to the
value credited to the first valid recipient. This is important to keep
the debited and credited amounts consistent.
*/

// Called before transaction execution to reserve the maximum amount of gas
// that can be used by the transaction.
// - The implementation must reduce `from`'s balance by `value`.
// - Must revert if `msg.sender` is not the zero address.
function debitGasFees(address from, uint256 value) external;

/**
* Called after transaction execution to refund the unused gas and credit the
* spent fees to the correct recipients.
* @param refundRecipient The recipient of the refund.
* @param tipRecipient The recipient of the tip.
* @param _gatewayFeeRecipient The recipient of the gateway fee. Unused.
* @param baseFeeRecipient The recipient of the base fee.
* @param refundAmount The amount to refund (in wrapped token digits).
pahor167 marked this conversation as resolved.
Show resolved Hide resolved
* @param tipAmount The amount to tip (in wrapped token digits).
* @param _gatewayFeeAmount The amount of the gateway fee (in wrapped token digits). Unused.
* @param baseFeeAmount The amount of the base fee (in wrapped token digits).
*/
function creditGasFees(
address refundRecipient,
address tipRecipient,
address _gatewayFeeRecipient,
address baseFeeRecipient,
uint256 refundAmount,
uint256 tipAmount,
uint256 _gatewayFeeAmount,
uint256 baseFeeAmount
) external;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pragma solidity ^0.5.13;

import "../Proxy.sol";

/* solhint-disable-next-line no-empty-blocks */
contract FeeCurrencyAdapterProxy is Proxy {}
7 changes: 6 additions & 1 deletion packages/protocol/foundry.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ remappings = [
'forge-std/=lib/celo-foundry/lib/forge-std/src/',
'ds-test/=lib/celo-foundry/lib/forge-std/lib/ds-test/src/',
'celo-foundry/=lib/celo-foundry/src/',
'@summa-tx/memview.sol/=lib/memview.sol'
'@summa-tx/memview.sol/=lib/memview.sol',
'celo-foundry-8/=lib/celo-foundry-8/src/',
'forge-std-8/=lib/celo-foundry-8/lib/forge-std/src/',
'@celo-contracts-8=contracts-0.8/',
'@openzeppelin/contracts8/=lib/openzeppelin-contracts8/contracts/',
'@celo-contracts=contracts/'
]

no_match_contract = "RandomTest"
Expand Down
1 change: 1 addition & 0 deletions packages/protocol/lib/celo-foundry-8
Submodule celo-foundry-8 added at 1bef01
1 change: 1 addition & 0 deletions packages/protocol/lib/openzeppelin-contracts8
Loading
Loading