feat: implement username transaction types (#149)

Author: alexbarnsley

crypto/enums/abi_function.py

@@ -3,5 +3,7 @@
 class AbiFunction(Enum):
     VOTE = 'vote'
     UNVOTE = 'unvote'
+    USERNAME_REGISTRATION = 'registerUsername'
+    USERNAME_RESIGNATION = 'resignUsername'
     VALIDATOR_REGISTRATION = 'registerValidator'
     VALIDATOR_RESIGNATION = 'resignValidator'

crypto/enums/contract_abi_type.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class ContractAbiType(Enum):
+    CUSTOM = 'custom'
+    CONSENSUS = 'consensus'
+    USERNAMES = 'usernames'

crypto/enums/contract_addresses.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class ContractAddresses(Enum):
+    CONSENSUS = '0x535B3D7A252fa034Ed71F0C53ec0C6F784cB64E1'
+    MULTIPAYMENT = '0x83769BeEB7e5405ef0B7dc3C66C43E3a51A6d27f'
+    USERNAMES = '0x2c1DE3b4Dbb4aDebEbB5dcECAe825bE2a9fc6eb6'

crypto/exceptions.py

@@ -8,3 +8,7 @@ class ArkSerializerException(ArkCryptoException):
 
 class ArkInvalidTransaction(ArkCryptoException):
     """Raised when transaction is not valid"""
+
+
+class InvalidUsernameException(Exception):
+    """Raised when username is invalid"""

crypto/transactions/builder/username_registration_builder.py

@@ -0,0 +1,39 @@
+import re
+from typing import Optional
+from crypto.enums.contract_addresses import ContractAddresses
+from crypto.exceptions import InvalidUsernameException
+from crypto.transactions.builder.base import AbstractTransactionBuilder
+from crypto.transactions.types.username_registration import UsernameRegistration
+
+class UsernameRegistrationBuilder(AbstractTransactionBuilder):
+    def __init__(self, data: Optional[dict] = None):
+        super().__init__(data)
+
+        self.recipient_address(ContractAddresses.USERNAMES.value)
+
+    def username(self, username: str):
+        self.is_valid_username(username)
+
+        self.transaction.data['username'] = username
+        self.transaction.refresh_payload_data()
+
+        return self
+
+    def get_transaction_instance(self, data: dict):
+        return UsernameRegistration(data)
+
+    @staticmethod
+    def is_valid_username(username: str) -> bool:
+        if len(username) < 1 or len(username) > 20:
+            raise InvalidUsernameException(f'Username must be between 1 and 20 characters long. Got {len(username)} characters.')
+
+        if re.match('/[^a-z0-9_]/', username):
+            raise InvalidUsernameException('Username can only contain lowercase letters, numbers and underscores.')
+
+        if re.match('/^_|_$/', username):
+            raise InvalidUsernameException('Username cannot start or end with an underscore.')
+
+        if re.match('/__/', username):
+            raise InvalidUsernameException('Username cannot contain consecutive underscores.')
+
+        return True

crypto/transactions/builder/username_resignation_builder.py

@@ -0,0 +1,13 @@
+from typing import Optional
+from crypto.enums.contract_addresses import ContractAddresses
+from crypto.transactions.builder.base import AbstractTransactionBuilder
+from crypto.transactions.types.username_resignation import UsernameResignation
+
+class UsernameResignationBuilder(AbstractTransactionBuilder):
+    def __init__(self, data: Optional[dict] = None):
+        super().__init__(data)
+
+        self.recipient_address(ContractAddresses.USERNAMES.value)
+
+    def get_transaction_instance(self, data: dict):
+        return UsernameResignation(data)

crypto/transactions/types/username_registration.py

@@ -0,0 +1,21 @@
+from crypto.enums.contract_abi_type import ContractAbiType
+from crypto.transactions.types.abstract_transaction import AbstractTransaction
+from crypto.utils.abi_encoder import AbiEncoder
+from crypto.enums.abi_function import AbiFunction
+
+class UsernameRegistration(AbstractTransaction):
+    def __init__(self, data: dict = None):
+        data = data or {}
+        payload = self.decode_payload(data)
+        if payload:
+            data['username'] = payload.get('args', [None])[0] if payload.get('args') else None
+
+        super().__init__(data)
+
+    def get_payload(self) -> str:
+        if 'username' not in self.data:
+            return ''
+
+        encoder = AbiEncoder(ContractAbiType.USERNAMES)
+
+        return encoder.encode_function_call(AbiFunction.USERNAME_REGISTRATION.value, [self.data['username']])

crypto/transactions/types/username_resignation.py

@@ -0,0 +1,10 @@
+from crypto.enums.contract_abi_type import ContractAbiType
+from crypto.transactions.types.abstract_transaction import AbstractTransaction
+from crypto.utils.abi_encoder import AbiEncoder
+from crypto.enums.abi_function import AbiFunction
+
+class UsernameResignation(AbstractTransaction):
+    def get_payload(self) -> str:
+        encoder = AbiEncoder(ContractAbiType.USERNAMES)
+
+        return encoder.encode_function_call(AbiFunction.USERNAME_RESIGNATION.value)