Add validator interfaces to examples

Author: 0age

contracts/examples/token/ERC20/TPLERC20PermissionedInterface.sol

@@ -12,7 +12,7 @@ interface TPLERC20PermissionedInterface {
  * @param value uint256 The amount to transfer.
  * @return Bool indicating if transfer will succeed & byte with a status code.
  */
- function canTransfer(address to, uint256 value) public returns (bool, bytes1);
+ function canTransfer(address to, uint256 value) external returns (bool, bytes1);
 
  /**
  * @notice Check if an account is approved to transfer tokens on behalf of
@@ -26,7 +26,7 @@ interface TPLERC20PermissionedInterface {
  address from,
  address to,
  uint256 value
- ) public returns (bool, bytes1);
+ ) external returns (bool, bytes1);
 
  /**
  * @notice Get the account of the utilized attribute registry.

contracts/examples/validator/TPLBasicValidatorInterface.sol

@@ -0,0 +1,76 @@
+pragma solidity ^0.4.25;
+
+
+/**
+ * @title TPL Basic Validator interface. EIP-165 ID: 0xd13d3f23
+ */
+interface TPLBasicValidatorInterface {
+ /**
+ * @notice Check if contract is assigned as a validator on the jurisdiction.
+ * @return True if validator is assigned, false otherwise.
+ */ 
+ function isValidator() external view returns (bool);
+
+ /**
+ * @notice Check if the validator is approved to issue attributes of the type
+ * with ID `attributeTypeID` on the jurisdiction.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ * @return True if validator is approved to issue attributes of given type.
+ */ 
+ function canIssueAttributeType(
+ uint256 attributeTypeID
+ ) external view returns (bool);
+
+ /**
+ * @notice Check if the validator is approved to issue an attribute of the
+ * type with ID `attributeTypeID` to account `account` on the jurisdiction.
+ * @param account address The account to check for issuing the attribute to.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ * @return Bool indicating if attribute is issuable & byte with status code.
+ */ 
+ function canIssueAttribute(
+ address account,
+ uint256 attributeTypeID
+ ) external view returns (bool, bytes1);
+
+ /**
+ * @notice Check if the validator is approved to revoke an attribute of the
+ * type with ID `attributeTypeID` from account `account` on the jurisdiction.
+ * @param account address The checked account for revoking the attribute from.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ * @return Bool indicating if attribute is revocable & byte with status code.
+ */ 
+ function canRevokeAttribute(
+ address account,
+ uint256 attributeTypeID
+ ) external view returns (bool, bytes1);
+
+ /**
+ * @notice Issue an attribute of the type with ID `attributeTypeID` to account
+ * `account` on the jurisdiction.
+ * @param account address The account to issue the attribute to.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ * @dev Note that the function is payable - this is so that the function in
+ * question can support both basic and extended jurisdictions. Attaching a
+ * value when utilizing a basic jurisdiction will revert the transaction.
+ */ 
+ function issueAttribute(
+ address account,
+ uint256 attributeTypeID
+ ) external payable;
+
+ /**
+ * @notice Revoke an attribute of the type with ID `attributeTypeID` from
+ * account `account` on the jurisdiction.
+ * @param account address The account to revoke the attribute from.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ */ 
+ function revokeAttribute(address account, uint256 attributeTypeID) external;
+
+ /**
+ * @notice Get account of utilized jurisdiction and associated attribute
+ * registry managed by the jurisdiction.
+ * @return The account of the jurisdiction.
+ */
+ function getJurisdiction() external view returns (address);
+}

contracts/examples/validator/TPLExtendedValidatorInterface.sol

@@ -0,0 +1,71 @@
+pragma solidity ^0.4.25;
+
+
+/**
+ * @title TPL Extended Validator interface (extends Basic Validator interface).
+ * EIP-165 ID: 0x596c0405
+ */
+interface TPLExtendedValidatorInterface {
+ /**
+ * @notice Check if the validator is approved to issue an attribute of the
+ * type with ID `attributeTypeID` to account `account` on the jurisdiction
+ * when `msg.value` is set to `value`.
+ * @param account address The account to issue the attribute to.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ * @param value uint256 The amount of ether included in the transaction.
+ * @return Bool indicating if attribute is issuable & byte with status code.
+ */
+ function canIssueAttribute(
+ address account,
+ uint256 attributeTypeID,
+ uint256 value
+ ) external view returns (bool, bytes1);
+
+ /**
+ * @notice Get the validator's signing key on the jurisdiction.
+ * @return The account referencing the public component of the signing key.
+ */
+ function getSigningKey() external view returns (address);
+
+ /**
+ * @notice Set a signing key on the jurisdiction with an associated public
+ * key at address `newSigningKey`.
+ * @param newSigningKey address The signing key to set.
+ */
+ function setSigningKey(address newSigningKey) external;
+
+ /**
+ * @notice Get the hash of a given attribute approval from the jurisdiction
+ * @param account address The account specified by the attribute approval.
+ * @param operator address An optional account permitted to submit approval.
+ * @param attributeTypeID uint256 The ID of the attribute type in question.
+ * @param value uint256 The value of the attribute in the approval.
+ * @param fundsRequired uint256 The amount to be included with the approval.
+ * @param validatorFee uint256 The required fee to be paid to the validator.
+ * @return The hash of the attribute approval.
+ */
+ function getAttributeApprovalHash(
+ address account,
+ address operator,
+ uint256 attributeTypeID,
+ uint256 value,
+ uint256 fundsRequired,
+ uint256 validatorFee
+ ) external view returns (bytes32 hash);
+
+ /**
+ * @notice Invalidate a signed attribute approval before it has been set by
+ * supplying the hash of the approval `hash` and the signature `signature`.
+ * @param hash bytes32 The hash of the attribute approval.
+ * @param signature bytes The hash's signature, resolving to the signing key.
+ */
+ function invalidateAttributeApproval(bytes32 hash, bytes signature) external;
+
+ /**
+ * @notice Withdraw funds paid into the validator of amount `value` to the
+ * account at `to`.
+ * @param to address The address to withdraw to.
+ * @param value uint256 The amount to withdraw.
+ */
+ function withdraw(bytes32 to, uint256 value) external;
+}