Signed Transfer Manager #533
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| pragma solidity ^0.5.0; | ||
|
|
||
| import "../../TransferManager/TransferManager.sol"; | ||
| import "../../../interfaces/IDataStore.sol"; | ||
| import "../../../interfaces/ISecurityToken.sol"; | ||
| import "openzeppelin-solidity/contracts/math/SafeMath.sol"; | ||
| import "openzeppelin-solidity/contracts/cryptography/ECDSA.sol"; | ||
|
|
||
| /** | ||
| * @title Transfer Manager module for verifing transations with a signed message | ||
| */ | ||
| contract SignedTransferManager is TransferManager { | ||
| using SafeMath for uint256; | ||
| using ECDSA for bytes32; | ||
|
|
||
| bytes32 constant public ADMIN = "ADMIN"; | ||
|
|
||
| //Keeps track of if the signature has been used or invalidated | ||
| //mapping(bytes => bool) invalidSignatures; | ||
| bytes32 constant public INVALID_SIG = "INVALIDSIG"; | ||
|
|
||
| //keep tracks of the address that allows to sign messages | ||
| //mapping(address => bool) public signers; | ||
| bytes32 constant public SIGNER = "SIGNER"; | ||
|
|
||
| // Emit when signer stats was changed | ||
| event SignersUpdated(address[] _signers, bool[] _signersStats); | ||
|
|
||
| // Emit when a signature has been deemed invalid | ||
| event SignatureUsed(bytes _data); | ||
|
|
||
|
|
||
| /** | ||
| * @notice Constructor | ||
| * @param _securityToken Address of the security token | ||
| * @param _polyAddress Address of the polytoken | ||
| */ | ||
| constructor (address _securityToken, address _polyAddress) | ||
| public | ||
| Module(_securityToken, _polyAddress) | ||
| { | ||
| } | ||
|
|
||
| /** | ||
| * @notice This function returns the signature of configure function | ||
| */ | ||
| function getInitFunction() external pure returns (bytes4) { | ||
| return bytes4(0); | ||
| } | ||
|
|
||
| /** | ||
| * @notice function to check if a signature is still valid | ||
| * @param _data signature | ||
| */ | ||
| function checkSignatureValidity(bytes calldata _data) external view returns(bool) { | ||
| address targetAddress; | ||
| uint256 nonce; | ||
| uint256 expiry; | ||
| bytes memory signature; | ||
| (targetAddress, nonce, expiry, signature) = abi.decode(_data, (address, uint256, uint256, bytes)); | ||
| if (targetAddress != address(this) || expiry < now || signature.length == 0 || _checkSignatureIsInvalid(signature)) | ||
| return false; | ||
| return true; | ||
| } | ||
|
|
||
| function checkSigner(address _signer) external view returns(bool) { | ||
| return _checkSigner(_signer); | ||
| } | ||
|
|
||
| /** | ||
| * @notice function to remove or add signer(s) onto the signer mapping | ||
| * @param _signers address array of signers | ||
| * @param _signersStats bool array of signers stats | ||
| */ | ||
| function updateSigners(address[] calldata _signers, bool[] calldata _signersStats) external withPerm(ADMIN) { | ||
| require(_signers.length == _signersStats.length, "Array length mismatch"); | ||
| IDataStore dataStore = IDataStore(ISecurityToken(securityToken).dataStore()); | ||
| for(uint256 i=0; i<_signers.length; i++) { | ||
| require(_signers[i] != address(0), "Invalid address"); | ||
| dataStore.setBool(keccak256(abi.encodePacked(SIGNER, _signers[i])), _signersStats[i]); | ||
| } | ||
| emit SignersUpdated(_signers, _signersStats); | ||
| } | ||
|
|
||
| /** | ||
| * @notice allow verify transfer with signature | ||
| * @param _from address transfer from | ||
| * @param _to address transfer to | ||
| * @param _amount transfer amount | ||
| * @param _data signature | ||
| * @param _isTransfer bool value of isTransfer | ||
| * Sig needs to be valid (not used or deemed as invalid) | ||
| * Signer needs to be in the signers mapping | ||
| */ | ||
| function verifyTransfer(address _from, address _to, uint256 _amount, bytes memory _data , bool _isTransfer) public returns(Result) { | ||
| if (!paused) { | ||
|
|
||
| require (_isTransfer == false || msg.sender == securityToken, "Sender is not ST"); | ||
|
|
||
| if (_data.length == 0) | ||
| return Result.NA; | ||
|
|
||
| address targetAddress; | ||
| uint256 nonce; | ||
| uint256 expiry; | ||
| bytes memory signature; | ||
| (targetAddress, nonce, expiry, signature) = abi.decode(_data, (address, uint256, uint256, bytes)); | ||
|
|
||
| if (address(this) != targetAddress || signature.length == 0 || _checkSignatureIsInvalid(signature) || expiry < now) | ||
| return Result.NA; | ||
|
|
||
| bytes32 hash = keccak256(abi.encodePacked(targetAddress, nonce, expiry, _from, _to, _amount)); | ||
| address signer = hash.toEthSignedMessageHash().recover(signature); | ||
|
|
||
| if (!_checkSigner(signer)) { | ||
| return Result.NA; | ||
| } else if(_isTransfer) { | ||
| _invalidateSignature(signature); | ||
|
There was a problem hiding this comment. instead of |
||
| return Result.VALID; | ||
| } else { | ||
| return Result.VALID; | ||
| } | ||
| } | ||
| return Result.NA; | ||
| } | ||
|
|
||
| /** | ||
| * @notice allow signers to deem a signature invalid | ||
| * @param _from address transfer from | ||
| * @param _to address transfer to | ||
| * @param _amount transfer amount | ||
| * @param _data signature | ||
| * Sig needs to be valid (not used or deemed as invalid) | ||
| * Signer needs to be in the signers mapping | ||
| */ | ||
| function invalidateSignature(address _from, address _to, uint256 _amount, bytes calldata _data) external { | ||
| require(_checkSigner(msg.sender), "Unauthorized Signer"); | ||
|
|
||
| address targetAddress; | ||
| uint256 nonce; | ||
| uint256 expiry; | ||
| bytes memory signature; | ||
| (targetAddress, nonce, expiry, signature) = abi.decode(_data, (address, uint256, uint256, bytes)); | ||
|
|
||
| require(!_checkSignatureIsInvalid(signature), "Signature already invalid"); | ||
| require(targetAddress == address(this), "Signature not for this module"); | ||
|
|
||
| bytes32 hash = keccak256(abi.encodePacked(targetAddress, nonce, expiry, _from, _to, _amount)); | ||
| require(hash.toEthSignedMessageHash().recover(signature) == msg.sender, "Incorrect Signer"); | ||
|
|
||
| _invalidateSignature(signature); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Return the permissions flag that are associated with ManualApproval transfer manager | ||
| */ | ||
| function getPermissions() public view returns(bytes32[] memory) { | ||
| bytes32[] memory allPermissions = new bytes32[](1); | ||
| allPermissions[0] = ADMIN; | ||
| return allPermissions; | ||
| } | ||
|
|
||
| function _checkSignatureIsInvalid(bytes memory _data) internal view returns(bool) { | ||
| IDataStore dataStore = IDataStore(ISecurityToken(securityToken).dataStore()); | ||
| return dataStore.getBool(keccak256(abi.encodePacked(INVALID_SIG, _data))); | ||
| } | ||
|
|
||
| function _checkSigner(address _signer) internal view returns(bool) { | ||
| IDataStore dataStore = IDataStore(ISecurityToken(securityToken).dataStore()); | ||
| return dataStore.getBool(keccak256(abi.encodePacked(SIGNER, _signer))); | ||
| } | ||
|
|
||
| function _invalidateSignature(bytes memory _data) internal { | ||
| IDataStore dataStore = IDataStore(ISecurityToken(securityToken).dataStore()); | ||
| dataStore.setBool(keccak256(abi.encodePacked(INVALID_SIG, _data)), true); | ||
| emit SignatureUsed(_data); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| pragma solidity ^0.5.0; | ||
|
|
||
| import "./SignedTransferManager.sol"; | ||
| import "../../ModuleFactory.sol"; | ||
|
|
||
| /** | ||
| * @title Factory for deploying SignedTransferManager module | ||
| */ | ||
| contract SignedTransferManagerFactory is ModuleFactory { | ||
|
|
||
| /** | ||
| * @notice Constructor | ||
| */ | ||
| constructor (uint256 _setupCost, uint256 _usageCost, uint256 _subscriptionCost) public | ||
| ModuleFactory(_setupCost, _usageCost, _subscriptionCost) | ||
| { | ||
| version = "1.0.0"; | ||
| name = "SignedTransferManager"; | ||
| title = "Signed Transfer Manager"; | ||
| description = "Manage transfers using a signature"; | ||
| compatibleSTVersionRange["lowerBound"] = VersionUtils.pack(uint8(0), uint8(0), uint8(0)); | ||
| compatibleSTVersionRange["upperBound"] = VersionUtils.pack(uint8(0), uint8(0), uint8(0)); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @notice used to launch the Module with the help of factory | ||
| * @return address Contract address of the Module | ||
| */ | ||
| // function deploy(bytes calldata /* _data */) external returns(address) { | ||
| // if (setupCost > 0) | ||
| // require(polyToken.transferFrom(msg.sender, owner, setupCost), "Failed transferFrom because of sufficent Allowance is not provided"); | ||
| // address signedTransferManager = new SignedTransferManager(msg.sender, address(polyToken)); | ||
| // emit GenerateModuleFromFactory(address(signedTransferManager), getName(), address(this), msg.sender, setupCost, now); | ||
| // return address(signedTransferManager); | ||
| // } | ||
|
|
||
| function deploy(bytes calldata /* _data */) external returns(address) { | ||
| address polyToken = _takeFee(); | ||
| SignedTransferManager signedTransferManager = new SignedTransferManager(msg.sender, polyToken); | ||
| emit GenerateModuleFromFactory(address(signedTransferManager), getName(), address(this), msg.sender, setupCost, now); | ||
| return address(signedTransferManager); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @notice Type of the Module factory | ||
| */ | ||
| function getTypes() external view returns(uint8[] memory) { | ||
| uint8[] memory res = new uint8[](2); | ||
| res[0] = 2; | ||
| res[1] = 6; | ||
| return res; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the name of the Module | ||
| */ | ||
| function getName() public view returns(bytes32) { | ||
| return name; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the description of the Module | ||
| */ | ||
| function getDescription() external view returns(string memory) { | ||
| return description; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the version of the Module | ||
| */ | ||
| function getVersion() external view returns(string memory) { | ||
| return version; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the title of the Module | ||
| */ | ||
| function getTitle() external view returns(string memory) { | ||
| return title; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the setup cost of the module | ||
| */ | ||
| function getSetupCost() external view returns (uint256) { | ||
| return setupCost; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the Instructions that helped to used the module | ||
| */ | ||
| function getInstructions() external view returns(string memory) { | ||
| return "Allows an issuer to maintain a list of signers who can validate transfer request using signatures. A mapping is used to track valid signers which can be managed by the issuer. verifytransfer function takes in a signature and if the signature is valid, it will verify the transfer. invalidSigature function allow the signer to make a signature invalid after it is signed. Init function takes no parameters."; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Get the tags related to the module factory | ||
| */ | ||
| function getTags() public view returns(bytes32[] memory) { | ||
| bytes32[] memory availableTags = new bytes32[](2); | ||
| availableTags[0] = "Signed"; | ||
| availableTags[1] = "Transfer Restriction"; | ||
| return availableTags; | ||
| } | ||
|
|
||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting to store Signer addresses in the data store. I guess this makes sense, esp. if "signers" are going to be used in other places and would make upgrading the module easier (via a remove and re-add).