Contract Source Code:
// File: @openzeppelin/contracts/token/ERC20/IERC20.sol
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
// File: @openzeppelin/contracts/security/ReentrancyGuard.sol
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
}
// File: SPHNX.sol
// File: @openzeppelin/contracts/utils/Context.sol
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
// File: @openzeppelin/contracts/security/Pausable.sol
// OpenZeppelin Contracts (last updated v4.7.0) (security/Pausable.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract Pausable is Context {
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
bool private _paused;
/**
* @dev Initializes the contract in unpaused state.
*/
constructor() {
_paused = false;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
require(!paused(), "Pausable: paused");
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
require(paused(), "Pausable: not paused");
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
}
// File: @openzeppelin/contracts/access/Ownable.sol
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// File: SPHNX.sol
pragma solidity ^0.8.13;
contract SPHNX is Ownable, Pausable, ReentrancyGuard {
// State variables
IERC20 public paymentToken;
uint256 public messagePrice;
uint256 public messagesProcessed;
address public winner;
// Variables for withdrawal splits
uint256 private WINNER_SHARE;
uint256 private OWNER_SHARE = 100- WINNER_SHARE;
// State variables to track withdrawn amounts
mapping(address => bool) private hasWithdrawn;
// Mapping to track user's paid messages
mapping(address => uint256) public userMessages;
// Mapping to track if a transaction hash has been used
mapping(bytes32 => bool) public usedTransactionHashes;
// Events
event PaymentTokenChanged(address indexed newToken);
event MessagePaid(address indexed user, uint256 amount, uint256 timestamp);
event PriceUpdated(uint256 newPrice);
event FundsWithdrawn(address indexed to, uint256 amount);
event WinnerSet(address indexed winner);
event WinnerWithdrawal(address indexed winner, uint256 amount);
event OwnerWithdrawal(address indexed owner, uint256 amount);
// Custom errors
error InsufficientPayment();
error TokenTransferFailed();
error TransactionAlreadyUsed();
error UnauthorizedWithdrawal();
error WithdrawalFailed();
error NoWinnerSet();
error InvalidAmount();
error AlreadyWithdrawn();
constructor(address _initialToken, uint256 _initialPrice, uint256 _WINNER_SHARE) Ownable(msg.sender) {
paymentToken = IERC20(_initialToken);
messagePrice = _initialPrice;
WINNER_SHARE = _WINNER_SHARE;
}
/**
* @dev Set the payment token
* @param _newToken The address of the payment token
*/
function setPaymentToken(address _newToken) external onlyOwner {
paymentToken = IERC20(_newToken);
emit PaymentTokenChanged(_newToken);
}
/**
* @dev Set the winner address
* @param _winner The address of the winner
*/
function setWinner(address _winner) external onlyOwner {
require(_winner != address(0), "Invalid winner address");
winner = _winner;
emit WinnerSet(_winner);
}
/**
* @dev Pay for a message
*/
function payForMessage() external payable nonReentrant whenNotPaused {
// Checks
if (paymentToken.balanceOf(msg.sender) < messagePrice) {
revert InsufficientPayment();
}
bytes32 txHash = keccak256(abi.encodePacked(msg.sender, block.timestamp));
if (usedTransactionHashes[txHash]) {
revert TransactionAlreadyUsed();
}
// Effects
usedTransactionHashes[txHash] = true;
userMessages[msg.sender]++;
messagesProcessed++;
// Interactions
bool success = paymentToken.transferFrom(msg.sender, address(this), messagePrice);
if (!success) {
revert TokenTransferFailed();
}
emit MessagePaid(msg.sender, messagePrice, block.timestamp);
}
/**
* @dev Update the price per message
* @param newPrice The new price in wei
*/
function updatePrice(uint256 newPrice) external onlyOwner {
messagePrice = newPrice;
emit PriceUpdated(newPrice);
}
/**
* @dev Get the number of messages a user has paid for
* @param user The address to check
*/
function getMessageCount(address user) external view returns (uint256) {
return userMessages[user];
}
/**
* @dev Check if a specific transaction hash has been used
* @param txHash The hash to check
*/
function isTransactionUsed(bytes32 txHash) external view returns (bool) {
return usedTransactionHashes[txHash];
}
/**
* @dev Internal function to process token withdrawals
* Note: State changes should be done before calling this
*/
function _processWithdrawal(address to, uint256 amount) private {
bool success = paymentToken.transfer(to, amount);
if (!success) {
revert WithdrawalFailed();
}
emit FundsWithdrawn(to, amount);
}
/**
* @dev Withdraw tokens according to role (winner or owner)
*/
function withdraw() external nonReentrant {
// Checks
uint256 tokenBalance = paymentToken.balanceOf(address(this));
if (tokenBalance == 0) revert InvalidAmount();
if (hasWithdrawn[msg.sender]) revert AlreadyWithdrawn();
uint256 amount;
if (msg.sender == winner) {
if (winner == address(0)) revert NoWinnerSet();
amount = (tokenBalance * WINNER_SHARE) / 100;
} else if (msg.sender == owner()) {
amount = (tokenBalance * OWNER_SHARE) / 100;
} else {
revert UnauthorizedWithdrawal();
}
// Effects
hasWithdrawn[msg.sender] = true;
// Interactions
_processWithdrawal(msg.sender, amount);
// Events after successful transfer
if (msg.sender == winner) {
emit WinnerWithdrawal(winner, amount);
} else {
emit OwnerWithdrawal(owner(), amount);
}
}
/**
* @dev Reset withdrawal status for a specific address (only owner)
*/
function resetWithdrawalStatus(address account) external onlyOwner {
hasWithdrawn[account] = false;
}
/**
* @dev Get contract balance
*/
function getBalance() external view returns (uint256) {
return paymentToken.balanceOf(address(this));
}
/**
* @dev Allow owner to withdraw accidentally sent ETH
*/
function withdrawETH() external nonReentrant onlyOwner {
uint256 balance = address(this).balance;
if (balance == 0) revert InvalidAmount();
(bool success, ) = owner().call{value: balance}("");
if (!success) {
revert WithdrawalFailed();
}
}
// Allow contract to receive ETH
receive() external payable {
}
// Allow contract to receive ETH via fallback
fallback() external payable {
}
/**
* @dev Pause contract
*/
function pause() external onlyOwner {
_pause();
}
/**
* @dev Unpause contract
*/
function unpause() external onlyOwner {
_unpause();
}
}