Follow contracts
Usage
Build
yarn
forge build
Test
forge test
Deploy
forge script script/Deploy.s.sol:Deploy --sig 'deployPowerToken()' \
--chain-id $CHAIN_ID \
--rpc-url $RPC_URL \
--private-key $PRIVATE_KEY \
--verifier-url $VERIFIER_URL \
--verifier $VERIFIER \
--verify \
--broadcast --ffi -vvvv
# generate easily readable abi to /deployments
forge script script/Deploy.s.sol:Deploy --sig 'sync()' --rpc-url $RPC_URL --broadcast --ffi
Contents
IErrors
Errors
TipReceiverIsEmpty
Tip parameter is empty.
error TipReceiverIsEmpty();
PointsInvalidReceiver
Points receiver is invalid.
error PointsInvalidReceiver(bytes32);
TipAmountIsZero
Tip amount is zero.
error TipAmountIsZero();
InsufficientBalanceAndPoints
Insufficient balance and points.
error InsufficientBalanceAndPoints();
InsufficientBalanceToTransfer
Insufficient balance to transfer.
error InsufficientBalanceToTransfer();
ExceedsMaxSupply
Exceeds max supply.
error ExceedsMaxSupply();
IEvents
Events
DistributePoints
Emitted when points are distributed to an address.
event DistributePoints(address indexed to, uint256 indexed amount);
Tip
Emitted when points are tipped from one address to another.
event Tip(address indexed from, address indexed to, bytes32 indexed feedId, uint256 amount);
WithdrawnByFeedId
Emitted when points are withdrawn by feed id.
event WithdrawnByFeedId(address indexed to, bytes32 indexed feedId, uint256 indexed amount);
Withdrawn
Emitted when tokens are withdrawn from an address.
event Withdrawn(address indexed user, address indexed to, uint256 indexed amount);
IPowerToken
Functions
initialize
Initializes the contract. Setup token name, symbol and account with APP_ADMIN_ROLE.
function initialize(string calldata name_, string calldata symbol_, address admin_) external;
Parameters
Name | Type | Description |
---|---|---|
name_ | string | The name of the token. |
symbol_ | string | The symbol of the token. |
admin_ | address | The account to be granted with APP_ADMIN_ROLE. |
migrate
Migrates the token points of users.
The caller must have the APP_ADMIN_ROLE.
function migrate(address[] calldata users, bytes32[] calldata feedIds) external;
Parameters
Name | Type | Description |
---|---|---|
users | address[] | The addresses of the users to migrate. |
feedIds | bytes32[] | The feed ids of the feeds to migrate. |
mint
Mints new token points.
The caller must have the APP_ADMIN_ROLE.
function mint(address to, uint256 amount) external;
Parameters
Name | Type | Description |
---|---|---|
to | address | The account to receive the token points. |
amount | uint256 | The amount of token points to mint. |
tip
Tips with token points. If token points are not enough, it will try the balance.
The to and feedId are optional, but at least one of them must be provided.
If both are provided, the to
will be used.
function tip(uint256 amount, address to, bytes32 feedId) external;
Parameters
Name | Type | Description |
---|---|---|
amount | uint256 | The amount of token points to send. It can be empty. |
to | address | The address to send the token points. It can be empty. |
feedId | bytes32 | The feed id. It can be empty. |
withdrawByFeedId
Withdraws tokens by feedId. to
is supposed to be the true owner of the feedId.
The caller must have the APP_ADMIN_ROLE.
function withdrawByFeedId(address to, bytes32 feedId) external;
Parameters
Name | Type | Description |
---|---|---|
to | address | The address who receives the tokens. |
feedId | bytes32 | The amount belongs to the feedId. |
balanceOfByFeed
Return the balance of the feedId
function balanceOfByFeed(bytes32 feedId) external view returns (uint256);
Parameters
Name | Type | Description |
---|---|---|
feedId | bytes32 | The feed id |
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The amount of the balance |
balanceOfPoints
Return the balance of points, aka the inactive tokens, of the owner
function balanceOfPoints(address owner) external view returns (uint256);
Parameters
Name | Type | Description |
---|---|---|
owner | address | The address of the owner |
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The amount of the balance |
Contents
TransparentUpgradeableProxy
Inherits: ERC1967Proxy
*This contract implements a proxy that is upgradeable by an admin. To avoid https://medium.com/nomic-labs-blog/malicious-backdoors-in-ethereum-proxies-62629adf3357[proxy selector clashing], which can potentially be used in an attack, this contract uses the https://blog.openzeppelin.com/the-transparent-proxy-pattern/[transparent proxy pattern]. This pattern implies two things that go hand in hand:
- If any account other than the admin calls the proxy, the call will be forwarded to the implementation, even if that call matches one of the admin functions exposed by the proxy itself.
- If the admin calls the proxy, it can access the admin functions, but its calls will never be
forwarded to the
implementation. If the admin tries to call a function on the implementation it will fail with an
error that says
"admin cannot fallback to proxy target".
These properties mean that the admin account can only be used for admin actions like upgrading
the proxy or changing
the admin, so it's best if it's a dedicated account that is not used for anything else. This will
avoid headaches due
to sudden errors when trying to call a function from the proxy implementation.
Our recommendation is for the dedicated account to be an instance of the {ProxyAdmin} contract. If
set up this way,
you should think of the
ProxyAdmin
instance as the real administrative interface of your proxy.*
Functions
constructor
Initializes an upgradeable proxy managed by _admin
, backed by the implementation at
_logic
, and
optionally initialized with _data
as explained in ERC1967Proxy-constructor.
constructor(address _logic, address admin_, bytes memory _data)
payable
ERC1967Proxy(_logic, _data);
ifAdmin
Modifier used internally that will delegate the call to the implementation unless the sender is the admin.
modifier ifAdmin();
admin
Returns the current admin.
NOTE: Only the admin can call this function. See ProxyAdmin-getProxyAdmin.
TIP: To get this value clients can read directly from the storage slot shown below (specified
by EIP1967) using the
https://eth.wiki/json-rpc/API#eth_getstorageat[eth_getStorageAt
] RPC call.
0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103
function admin() external ifAdmin returns (address admin_);
implementation
Returns the current implementation.
NOTE: Only the admin can call this function. See ProxyAdmin-getProxyImplementation.
TIP: To get this value clients can read directly from the storage slot shown below (specified
by EIP1967) using the
https://eth.wiki/json-rpc/API#eth_getstorageat[eth_getStorageAt
] RPC call.
0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc
function implementation() external ifAdmin returns (address implementation_);
changeAdmin
Changes the admin of the proxy. Emits an {AdminChanged} event. NOTE: Only the admin can call this function. See {ProxyAdmin-changeProxyAdmin}.
function changeAdmin(address newAdmin) external virtual ifAdmin;
upgradeTo
Upgrade the implementation of the proxy. NOTE: Only the admin can call this function. See ProxyAdmin-upgrade.
function upgradeTo(address newImplementation) external ifAdmin;
upgradeToAndCall
Upgrade the implementation of the proxy, and then call a function from the new
implementation as specified
by data
, which should be an encoded function call. This is useful to initialize new storage
variables in the
proxied contract.
NOTE: Only the admin can call this function. See ProxyAdmin-upgradeAndCall.
function upgradeToAndCall(address newImplementation, bytes calldata data)
external
payable
ifAdmin;
_admin
Returns the current admin.
function _admin() internal view virtual returns (address);
_beforeFallback
Makes sure the admin cannot access the fallback function. See Proxy-_beforeFallback.
function _beforeFallback() internal virtual override;
PowerToken
Inherits: IPowerToken, IErrors, IEvents, AccessControlEnumerableUpgradeable, ERC20Upgradeable
State Variables
version
string public constant version = "1.0.0";
APP_ADMIN_ROLE
bytes32 public constant APP_ADMIN_ROLE = keccak256("APP_ADMIN_ROLE");
MAX_SUPPLY
uint256 public constant MAX_SUPPLY = 10_000_000_000 ether;
_pointsBalancesV1
mapping(address account => uint256) internal _pointsBalancesV1;
_feedBalances
Token balances of the feed, which could be withdrawn to the feed owner.
mapping(bytes32 feedId => uint256) internal _feedBalances;
_pointsBalancesV2
Points balances of the users, which are non-transferable and can be used to tip others. Points balances are included in user's balance.
mapping(address account => uint256) internal _pointsBalancesV2;
Functions
initialize
Initializes the contract. Setup token name, symbol and account with APP_ADMIN_ROLE.
function initialize(string calldata name_, string calldata symbol_, address admin_)
external
override
reinitializer(3);
Parameters
Name | Type | Description |
---|---|---|
name_ | string | The name of the token. |
symbol_ | string | The symbol of the token. |
admin_ | address | The account to be granted with APP_ADMIN_ROLE. |
migrate
Migrates the token points of users.
The caller must have the APP_ADMIN_ROLE.
function migrate(address[] calldata users, bytes32[] calldata feedIds)
external
override
onlyRole(APP_ADMIN_ROLE);
Parameters
Name | Type | Description |
---|---|---|
users | address[] | The addresses of the users to migrate. |
feedIds | bytes32[] | The feed ids of the feeds to migrate. |
mint
Mints new token points.
The caller must have the APP_ADMIN_ROLE.
function mint(address to, uint256 amount) external override onlyRole(APP_ADMIN_ROLE);
Parameters
Name | Type | Description |
---|---|---|
to | address | The account to receive the token points. |
amount | uint256 | The amount of token points to mint. |
tip
Tips with token points. If token points are not enough, it will try the balance.
The to and feedId are optional, but at least one of them must be provided.
If both are provided, the to
will be used.
function tip(uint256 amount, address to, bytes32 feedId) external override;
Parameters
Name | Type | Description |
---|---|---|
amount | uint256 | The amount of token points to send. It can be empty. |
to | address | The address to send the token points. It can be empty. |
feedId | bytes32 | The feed id. It can be empty. |
withdrawByFeedId
Withdraws tokens by feedId. to
is supposed to be the true owner of the feedId.
The caller must have the APP_ADMIN_ROLE.
function withdrawByFeedId(address to, bytes32 feedId) external override onlyRole(APP_ADMIN_ROLE);
Parameters
Name | Type | Description |
---|---|---|
to | address | The address who receives the tokens. |
feedId | bytes32 | The amount belongs to the feedId. |
balanceOfPoints
Return the balance of points, aka the inactive tokens, of the owner
function balanceOfPoints(address owner) external view override returns (uint256);
Parameters
Name | Type | Description |
---|---|---|
owner | address | The address of the owner |
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The amount of the balance |
balanceOfByFeed
Return the balance of the feedId
function balanceOfByFeed(bytes32 feedId) external view override returns (uint256);
Parameters
Name | Type | Description |
---|---|---|
feedId | bytes32 | The feed id |
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The amount of the balance |
transfer
Moves amount
tokens from the caller's account to to
.
function transfer(address to, uint256 value) public override returns (bool);
transferFrom
Moves amount
tokens from from
to to
using the allowance mechanism.
amount
is then deducted from the caller's allowance.
function transferFrom(address from, address to, uint256 value) public override returns (bool);
_mintPoints
Mints points to a specified address. Increases the points balance of the recipient and mints the corresponding amount of tokens. Reverts if the total supply exceeds the maximum supply.
function _mintPoints(address to, uint256 amount) internal;
_checkTransferBalance
Checks if the transfer balance is sufficient.
This function verifies that the from
address has enough balance to cover the transfer
amount
after accounting for the points balance.
function _checkTransferBalance(address from, uint256 value) internal view;
Parameters
Name | Type | Description |
---|---|---|
from | address | The address from which the tokens are being transferred. |
value | uint256 | The amount of tokens to be transferred. |