Add username ENS methods

docs/api/README.md

@@ -17,6 +17,7 @@
 - [Network](enums/Network.md)
 - [SupportedExtension](enums/SupportedExtension.md)
 - [TeamColor](enums/TeamColor.md)
+- [UserLabelSuffix](enums/UserLabelSuffix.md)
 - [Vote](enums/Vote.md)
 
 ## Classes

docs/api/classes/ColonyNetwork.md

@@ -280,6 +280,74 @@ ___
 
 ___
 
+### getUserAddress
+
+▸ **getUserAddress**(`username`): `Promise`<``null`` \| `string`\>
+
+Get the user's addess by the username
+
+Returns the user's address that belongs to the given username. Username has to be provided without any suffix, just like it's shown in the dapp.
+Will return `null` if the given username was not registered.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `username` | `string` |
+
+#### Returns
+
+`Promise`<``null`` \| `string`\>
+
+The user's address
+
+___
+
+### getUsername
+
+▸ **getUsername**(`address`): `Promise`<``null`` \| `string`\>
+
+Get a user's username
+
+Returns the user's username (the ENS label, just like it's shown in the dapp, without any suffixes)
+Will return `null` if the user does not exist or if no label was assigned yet
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `string` |
+
+#### Returns
+
+`Promise`<``null`` \| `string`\>
+
+The user's username
+
+___
+
+### registerUsername
+
+▸ **registerUsername**(`username`): [`MetaTxCreator`](MetaTxCreator.md)<`ColonyNetworkClient`, ``"registerUserLabel"``, { `label?`: `string` ; `user?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
+
+Register a Colony-internal ENS username
+
+Registers a username for the signing address. An address can only register one username. Usernames are globally unique. This method will check whether the username was registered before.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `username` | `string` |
+
+#### Returns
+
+[`MetaTxCreator`](MetaTxCreator.md)<`ColonyNetworkClient`, ``"registerUserLabel"``, { `label?`: `string` ; `user?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
+
+A transaction creator
+
+___
+
 ### init
 
 ▸ `Static` **init**(`signerOrProvider`, `options?`): `Promise`<[`ColonyNetwork`](ColonyNetwork.md)\>

docs/api/enums/UserLabelSuffix.md

@@ -0,0 +1,37 @@
+# Enumeration: UserLabelSuffix
+
+## Enumeration Members
+
+### Custom
+
+• **Custom** = ``".user.joincolony.test"``
+
+___
+
+### Gnosis
+
+• **Gnosis** = ``".user.joincolony.colonyxdai"``
+
+___
+
+### Goerli
+
+• **Goerli** = ``".user.joincolony.test"``
+
+___
+
+### Mainnet
+
+• **Mainnet** = ``".user.joincolony.eth"``
+
+___
+
+### Xdai
+
+• **Xdai** = ``".user.joincolony.colonyxdai"``
+
+___
+
+### XdaiQa
+
+• **XdaiQa** = ``".user.joincolony.colonyxdai"``

src/ColonyNetwork/ColonyNetwork.ts

@@ -18,6 +18,7 @@ import {
   ColonyAddedEventObject,
   ColonyMetadataEventObject,
   TokenDeployedEventObject,
+  UserLabelRegisteredEventObject,
 } from '@colony/colony-js/extras';
 import { ERC2612Token as ERC2612TokenType } from '@colony/colony-js/tokens';
 import {
@@ -28,7 +29,11 @@ import {
 import { IpfsMetadata, IpfsAdapter } from '../ipfs';
 import { BaseContract, TxConfig, TxCreator, MetaTxCreator } from '../TxCreator';
 import { Colony } from './Colony';
-import { ColonyLabelSuffix, MetaTxBroadCasterEndpoint } from '../constants';
+import {
+  ColonyLabelSuffix,
+  MetaTxBroadCasterEndpoint,
+  UserLabelSuffix,
+} from '../constants';
 import { Expand, Parameters } from '../types';
 import { extractEvent } from '../utils';
 import { EIP2612TxCreator } from '../TxCreator/EIP2612TxCreator';
@@ -363,10 +368,10 @@ export class ColonyNetwork {
     metadata?: ColonyMetadata | string,
   ) {
     const checkLabel = async () => {
-      const existingLabel = await this.getColonyAddress(label);
+      const existingAddress = await this.getColonyAddress(label);
 
-      if (existingLabel) {
-        throw new Error(`Colony label ${label} already exists`);
+      if (existingAddress) {
+        throw new Error(`Colony with label ${label} already exists`);
       }
       return [tokenAddress, Colony.getLatestSupportedVersion(), label] as [
         string,
@@ -482,6 +487,68 @@ export class ColonyNetwork {
     return null;
   }
 
+  /**
+   * Get a user's username
+   *
+   * Returns the user's username (the ENS label, just like it's shown in the dapp, without any suffixes)
+   * Will return `null` if the user does not exist or if no label was assigned yet
+   *
+   * @returns The user's username
+   */
+  async getUsername(address: string) {
+    const ensName = await this.networkClient.lookupRegisteredENSDomain(address);
+    if (ensName) {
+      return ensName.replace(UserLabelSuffix[this.network], '');
+    }
+    return null;
+  }
+
+  /**
+   * Get the user's addess by the username
+   *
+   * Returns the user's address that belongs to the given username. Username has to be provided without any suffix, just like it's shown in the dapp.
+   * Will return `null` if the given username was not registered.
+   *
+   * @returns The user's address
+   */
+  async getUserAddress(username: string) {
+    const hash = namehash(`${username}${UserLabelSuffix[this.network]}`);
+    const address = await this.networkClient.addr(hash);
+    if (address !== AddressZero) {
+      return address;
+    }
+    return null;
+  }
+
+  /**
+   * Register a Colony-internal ENS username
+   *
+   * Registers a username for the signing address. An address can only register one username. Usernames are globally unique. This method will check whether the username was registered before.
+   *
+   * @returns A transaction creator
+   */
+  registerUsername(username: string) {
+    const checkUsername = async () => {
+      const existingAddress = await this.getColonyAddress(username);
+
+      if (existingAddress) {
+        throw new Error(`Username ${username} is already taken`);
+      }
+      return [username, ''] as [string, string];
+    };
+    return this.createMetaTxCreator(
+      this.networkClient,
+      'registerUserLabel',
+      checkUsername,
+      async (receipt) => ({
+        ...extractEvent<UserLabelRegisteredEventObject>(
+          'UserLabelRegistered',
+          receipt,
+        ),
+      }),
+    );
+  }
+
   /**
    * Deploy a "special" colony ERC20 token
    *

src/constants.ts

@@ -59,6 +59,15 @@ export enum ColonyLabelSuffix {
   Custom = '.colony.joincolony.test',
 }
 
+export enum UserLabelSuffix {
+  Mainnet = '.user.joincolony.eth',
+  Goerli = '.user.joincolony.test',
+  Gnosis = '.user.joincolony.colonyxdai',
+  Xdai = '.user.joincolony.colonyxdai',
+  XdaiQa = '.user.joincolony.colonyxdai',
+  Custom = '.user.joincolony.test',
+}
+
 /**
  * Identifies a motion as a decision
  *