fix: make delegate description mandatory

This reflects what the smart contracts expect

BREAKING CHANGE: make the description parameter mandatory in the `assignRole` function in the
Security Token's permissions namespace

fix #100

Author: monitz87

src/entities/SecurityToken/Permissions.ts

@@ -92,12 +92,12 @@ export class Permissions extends SubModule {
    *
    * @param delegateAddress wallet address of the delegate
    * @param role role to assign
-   * @param description description of the delegate (defaults to empty string, is ignored if the delegate already exists)
+   * @param description description of the delegate (is ignored if the delegate already exists)
    */
   public assignRole = async (args: {
     delegateAddress: string;
     role: SecurityTokenRole;
-    description?: string;
+    description: string;
   }) => {
     const { symbol } = this.securityToken;
 
@@ -126,6 +126,7 @@ export class Permissions extends SubModule {
       {
         symbol,
         assign: false,
+        description: '', // this is not used when revoking
         ...args,
       },
       this.context

src/procedures/AssignSecurityTokenRole.ts

@@ -13,7 +13,7 @@ export class AssignSecurityTokenRole extends Procedure<AssignSecurityTokenRolePr
   public type = ProcedureType.AssignSecurityTokenRole;
 
   public async prepareTransactions() {
-    const { symbol, role, assign, description = '', delegateAddress } = this.args;
+    const { symbol, role, assign, description, delegateAddress } = this.args;
     const { contractWrappers } = this.context;
     const delegate = conversionUtils.checksumAddress(delegateAddress);
 
@@ -63,7 +63,8 @@ export class AssignSecurityTokenRole extends Procedure<AssignSecurityTokenRolePr
     ))[0];
 
     const delegates = await permissionModule.getAllDelegates();
-    const exists = delegates.filter(element => element === delegate).length > 0;
+    const exists =
+      delegates.filter(element => element.toUpperCase() === delegate.toUpperCase()).length > 0;
 
     /**
      * In the following block we attempt to:
@@ -76,7 +77,9 @@ export class AssignSecurityTokenRole extends Procedure<AssignSecurityTokenRolePr
         perm,
       });
 
-      const permitted = !!permittedDelegates.find(element => element === delegate);
+      const permitted = !!permittedDelegates.find(
+        element => element.toUpperCase() === delegate.toUpperCase()
+      );
 
       // Upcoming permission equals existing one
       if (permitted === assign) {

src/types/index.ts

@@ -326,7 +326,7 @@ export interface AssignSecurityTokenRoleProcedureArgs {
   delegateAddress: string;
   role: SecurityTokenRole;
   assign: boolean;
-  description?: string;
+  description: string;
 }
 
 export interface AssignStoRoleProcedureArgs {