status-im/contracts
2
0
Fork 0
mirror of https://github.com/status-im/contracts.git synced 2025-02-23 12:08:47 +00:00
Code Issues Projects Releases Wiki Activity

Linting + nat/radspec

Browse Source
This commit is contained in:
Richard Ramos 2018-04-16 10:13:07 -04:00
parent 6a52cd4d09
commit ea10012bfd
1 changed files with 97 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
contracts/communication/MessageTribute.sol
View File

@ -3,6 +3,7 @@ pragma solidity ^0.4.17;
import "../token/MiniMeToken.sol";
import "../common/Controlled.sol";
/**
* @title MessageTribute
* @author Richard Ramos (Status Research & Development GmbH)
@ -38,12 +39,20 @@ contract MessageTribute is Controlled {
mapping(address => uint256) public balances;
address[] private friends;
MiniMeToken public SNT;
MiniMeToken public snt;
function MessageTribute(MiniMeToken _SNT) public {
SNT = _SNT;
/**
* @notice Contructor of MessageTribute
* @param _snt Address of Status Network Token (or any ERC20 compatible token)
**/
function MessageTribute(MiniMeToken _snt) public {
snt = _snt;
}
/**
* @notice Register friends addresses that won't require to pay any tribute
* @param _friends Array of addresses to register
*/
function addFriends(address[] _friends) public {
uint256 len = _friends.length;
for (uint256 i = 0; i < len; i++) {
@ -52,7 +61,11 @@ contract MessageTribute is Controlled {
friendIndex[frHash] = friends.push(_friends[i]);
}
}
/**
* @notice Remove friends addresses from contract
* @param _friends Array of addresses to remove
*/
function removeFriends(address[] _friends) public {
uint256 len = _friends.length;
for (uint256 i = 0; i < len; i++) {
@ -67,15 +80,31 @@ contract MessageTribute is Controlled {
}
}
function areFriends(address sourceAccount, address accountToCheck) public view returns(bool) {
return friendIndex[keccak256(accountToCheck, sourceAccount)] > 0;
/**
* @notice Determines if `accountToCheck` is registered as a friend of `sourceAccount`
* @param _sourceAccount Address that has friends registered in the contract
* @param _accountToCheck Address to verify if it is friend of `accountToCheck`
* @return accounts are friends or not
*/
function areFriends(address _sourceAccount, address _accountToCheck) public view returns(bool) {
return friendIndex[keccak256(_accountToCheck, _sourceAccount)] > 0;
}
/**
* @notice Set tribute for accounts or everyone
* @param _to Address to set the tribute. If address(0), applies to everyone
* @param _amount Required tribute amount (using token from constructor)
* @param _isPermanent Tribute applies for all communications on only for the first
*/
function setRequiredTribute(address _to, uint _amount, bool _isPermanent) public {
require(friendIndex[keccak256(msg.sender, _to)] == 0);
feeCatalog[msg.sender][_to] = Fee(_amount, _isPermanent);
}
/**
* @notice Obtain amount of tokens required from `msg.sender` to contact `_from`
* @return fee amount of tokens
*/
function getRequiredFee(address _from) public view
returns (uint256 fee)
{
@ -83,24 +112,42 @@ contract MessageTribute is Controlled {
fee = f.amount;
}
/**
* @notice Deposit `_value` in the contract to be used to pay tributes
* @param _value Amount to deposit
*/
function deposit(uint256 _value) public {
require(_value > 0);
balances[msg.sender] += _value;
require(SNT.transferFrom(msg.sender, address(this), _value));
require(snt.transferFrom(msg.sender, address(this), _value));
}
/**
* @notice Return balance of tokens for `msg.sender` available for tributes or withdrawal
* @return amount of tokens stored in contract
*/
function balance() public view returns (uint256) {
return balances[msg.sender];
}
/**
* @notice Withdraw `_value` tokens from contract
* @param _value Amount of tokens to withdraw
*/
function withdraw(uint256 _value) public {
require(balances[msg.sender] > 0);
require(_value <= balances[msg.sender]);
balances[msg.sender] -= _value;
require(SNT.transfer(msg.sender, _value));
require(snt.transfer(msg.sender, _value));
}
function requestAudience(address _from, bytes32 hashedSecret)
/**
* @notice Send a chat request to `_from`, with a captcha that must be solved
* @param _from Account to whom `msg.sender` requests a chat
* @param _hashedSecret Captcha that `_from` must solve. It's a keccak256 of `_from`,
* `msg.sender` and the captcha value shown to `_from`
*/
function requestAudience(address _from, bytes32 _hashedSecret)
public
{
Fee memory f = getFee(_from);
@ -109,15 +156,25 @@ contract MessageTribute is Controlled {
require(lastAudienceDeniedTimestamp[_from][msg.sender] + 3 days <= now);
emit AudienceRequested(_from, msg.sender);
audienceRequested[_from][msg.sender] = Audience(block.number, now, f, hashedSecret);
audienceRequested[_from][msg.sender] = Audience(block.number, now, f, _hashedSecret);
balances[msg.sender] -= f.amount;
}
/**
* @notice Determine if there's a pending chat request between `_from` and `_to`
* @param _from Account to whom `_to` had requested a chat
* @param _to Account which requested a chat to `_from`
*/
function hasPendingAudience(address _from, address _to) public view returns (bool) {
return audienceRequested[_from][_to].blockNum > 0;
}
/**
* @notice Can be called after 3 days if no response from `_from` is received
* @param _from Account to whom `_to` had requested a chat
* @param _to Account which requested a chat to `_from`
*/
function timeOut(address _from, address _to) public {
require(audienceRequested[_from][_to].blockNum > 0);
require(audienceRequested[_from][_to].timestamp + 3 days <= now);
@ -126,6 +183,10 @@ contract MessageTribute is Controlled {
delete audienceRequested[_from][_to];
}
/**
* @notice Cancel chat request
* @param _from Account to whom `msg.sender` had requested a chat previously
*/
function cancelAudienceRequest(address _from) public {
require(audienceRequested[_from][msg.sender].blockNum > 0);
require(audienceRequested[_from][msg.sender].timestamp + 2 hours <= now);
@ -134,11 +195,17 @@ contract MessageTribute is Controlled {
delete audienceRequested[_from][msg.sender];
}
function grantAudience(address _to, bool _approve, bool _waive, bytes32 secret) public {
/**
* @notice Approve/Deny chat request to `_to`
* @param _approve Approve or deny request
* @param _waive Refund deposit or not
* @param _secret Captcha solution
*/
function grantAudience(address _to, bool _approve, bool _waive, bytes32 _secret) public {
Audience storage aud = audienceRequested[msg.sender][_to];
require(aud.blockNum > 0);
require(aud.hashedSecret == keccak256(msg.sender, _to, secret));
require(aud.hashedSecret == keccak256(msg.sender, _to, _secret));
emit AudienceGranted(msg.sender, _to, _approve);
@ -153,7 +220,7 @@ contract MessageTribute is Controlled {
if (!_waive) {
if (_approve) {
require(SNT.transfer(msg.sender, amount));
require(snt.transfer(msg.sender, amount));
} else {
balances[_to] += amount;
}
@ -162,6 +229,11 @@ contract MessageTribute is Controlled {
}
}
/**
* @notice Determine if msg.sender ha enough funds to chat with `_to`
* @param _to Account `msg.sender` wishes to talk to
* @return Has enough funds or not
*/
function hasEnoughFundsToTalk(address _to)
public
view
@ -170,6 +242,11 @@ contract MessageTribute is Controlled {
return getFee(_to).amount <= balances[msg.sender];
}
/**
* @notice Obtain required fee to talk with `_from`
* @param _from Account `msg.sender` wishes to talk to
* @return Fee
*/
function getFee(address _from) internal view
returns (Fee)
{
@ -182,6 +259,11 @@ contract MessageTribute is Controlled {
return specificFee.amount > 0 ? specificFee : generalFee;
}
/**
* @notice Remove any tribute configuration between `_from` and `_to`
* @param _from Owner of the configuration
* @param _to Account that paid tributes (won't after this function is executed)
*/
function clearFee(address _from, address _to) private {
if (!feeCatalog[_from][_to].permanent) {
feeCatalog[_from][_to].amount = 0;