feat: 🎸 finish adding comments and small fixes to rest of proj

Author: Victor Wiebe

src/contract_wrappers/modules/module_factory_wrapper.ts

@@ -77,30 +77,52 @@ interface ModuleFactorySubscribeAsyncParams extends Subscribe {
   >;
 }
 
+/**
+ * @param setupCost Cost to setup module
+ */
 interface ChangeSetupCostParams extends TxParams {
   setupCost: BigNumber;
 }
 
+/**
+ * @param isCostInPoly Boolean if cost is in poly
+ */
 interface ChangeCostAndTypeParams extends ChangeSetupCostParams {
   isCostInPoly: boolean;
 }
 
+/**
+ * @param title New title
+ */
 interface ChangeTitleParams extends TxParams {
   title: string;
 }
 
+/**
+ * @param description New description
+ */
 interface ChangeDescriptionParams extends TxParams {
   description: string;
 }
 
+/**
+ * @param name New name
+ */
 interface ChangeNameParams extends TxParams {
   name: string;
 }
 
+/**
+ * @param tag New tag
+ */
 interface ChangeTagsParams extends TxParams {
   tags: string[];
 }
 
+/**
+ * @param boundType Type of STVersionBound
+ * @param newVersion New version
+ */
 interface ChangeSTVersionBoundsParams extends TxParams {
   boundType: BoundType;
   newVersion: number[];
@@ -124,13 +146,15 @@ export default class ModuleFactoryWrapper extends ContractWrapper {
 
   /**
    * Get the owner of the Module Factory
+   * @return owner address
    */
-  public owner = async () => {
+  public owner = async (): Promise<string> => {
     return (await this.contract).owner.callAsync();
   };
 
   /**
    * Get the name of the Module
+   * @return name
    */
   public name = async (): Promise<string> => {
     const name = await (await this.contract).name.callAsync();
@@ -139,34 +163,39 @@ export default class ModuleFactoryWrapper extends ContractWrapper {
 
   /**
    * Get the title of the Module
+   * @return title
    */
   public title = async (): Promise<string> => {
     return (await this.contract).title.callAsync();
   };
 
   /**
    * Get isCostInPoly
+   * @return boolean
    */
   public isCostInPoly = async (): Promise<boolean> => {
     return (await this.contract).isCostInPoly.callAsync();
   };
 
   /**
    * Get the description of the Module
+   * @return description string
    */
   public description = async (): Promise<string> => {
     return (await this.contract).description.callAsync();
   };
 
   /**
    * Get the version of the Module
+   * @return version string
    */
   public version = async (): Promise<string> => {
     return (await this.contract).version.callAsync();
   };
 
   /**
    * Get the types
+   * @return list of module types
    */
   public getTypes = async (): Promise<ModuleType[]> => {
     return (await (await this.contract).getTypes.callAsync()).map(type => {
@@ -176,6 +205,7 @@ export default class ModuleFactoryWrapper extends ContractWrapper {
 
   /**
    * Get the tags
+   * @return tags list
    */
   public getTags = async (): Promise<string[]> => {
     return bytes32ArrayToStringArray(await (await this.contract).getTags.callAsync());
@@ -291,6 +321,7 @@ export default class ModuleFactoryWrapper extends ContractWrapper {
 
   /**
    * Get setup cost
+   * @return setupCost value
    */
   public setupCost = async (): Promise<BigNumber> => {
     const value = await (await this.contract).setupCost.callAsync();
@@ -299,20 +330,23 @@ export default class ModuleFactoryWrapper extends ContractWrapper {
 
   /**
    * Get upper ST version bounds
+   * @return upper bounds list
    */
   public getUpperSTVersionBounds = async (): Promise<BigNumber[]> => {
     return (await (await this.contract).getUpperSTVersionBounds.callAsync()).map(v => new BigNumber(v));
   };
 
   /**
    * Get lower ST version bounds
+   * @return lower bounds list
    */
   public getLowerSTVersionBounds = async (): Promise<BigNumber[]> => {
     return (await (await this.contract).getLowerSTVersionBounds.callAsync()).map(v => new BigNumber(v));
   };
 
   /**
    * Get setup cost in poly
+   * @return cost in poly
    */
   public setupCostInPoly = async (): Promise<BigNumber> => {
     const value = await (await this.contract).setupCostInPoly.callAsync();

src/contract_wrappers/modules/module_wrapper.ts

@@ -13,6 +13,9 @@ import { stringToBytes32 } from '../../utils/convert';
 import functionsUtils from '../../utils/functions_utils';
 import assert from '../../utils/assert';
 
+/**
+ * @param tokenContract ERC20 Token Contract Address
+ */
 interface ReclaimERC20Params extends TxParams {
   tokenContract: string;
 }
@@ -62,31 +65,57 @@ export default class ModuleWrapper extends ContractWrapper {
     this.contractFactory = contractFactory;
   }
 
-  public getInitFunction = async () => {
+  /**
+   * Return init function result
+   * @return init function string
+   */
+  public getInitFunction = async (): Promise<string> => {
     return (await this.contract).getInitFunction.callAsync();
   };
 
-  public polyToken = async () => {
+  /**
+   * Return poly token address
+   * @return address
+   */
+  public polyToken = async (): Promise<string> => {
     return (await this.contract).polyToken.callAsync();
   };
 
-  public securityToken = async () => {
+  /**
+   * Return security token address
+   * @return address
+   */
+  public securityToken = async (): Promise<string> => {
     return (await this.contract).securityToken.callAsync();
   };
 
-  public getPermissions = async () => {
+  /**
+   * Return permissions
+   * @return list of permissions
+   */
+  public getPermissions = async (): Promise<string[]> => {
     return (await this.contract).getPermissions.callAsync();
   };
 
-  public factory = async () => {
+  /**
+   * Return factory address
+   * @return address
+   */
+  public factory = async (): Promise<string> => {
     return (await this.contract).factory.callAsync();
   };
 
+  /**
+   * Reclaim ETH from contract
+   */
   public reclaimETH = async (params: TxParams) => {
     assert.assert(await this.isCallerTheSecurityTokenOwner(params.txData), 'The caller must be the ST owner');
     return (await this.contract).reclaimETH.sendTransactionAsync(params.txData, params.safetyFactor);
   };
 
+  /**
+   * Reclaim ERC20 tokens from contract
+   */
   public reclaimERC20 = async (params: ReclaimERC20Params) => {
     assert.assert(await this.isCallerTheSecurityTokenOwner(params.txData), 'The caller must be the ST owner');
     assert.isNonZeroETHAddressHex('tokenContract', params.tokenContract);

src/contract_wrappers/registries/feature_registry_wrapper.ts

@@ -85,15 +85,19 @@ export default class FeatureRegistryWrapper extends ContractWrapper {
     this.contract = contract;
   }
 
-  public owner = async () => {
+  /**
+   * Get owner of contract
+   * @return address
+   */
+  public owner = async (): Promise<string> => {
     return (await this.contract).owner.callAsync();
   };
 
   /**
    * Get the status of a feature
    * @return bool
    */
-  public getFeatureStatus = async (params: GetFeatureStatusParams) => {
+  public getFeatureStatus = async (params: GetFeatureStatusParams): Promise<boolean> => {
     return (await this.contract).getFeatureStatus.callAsync(params.nameKey);
   };
 
@@ -119,15 +123,15 @@ export default class FeatureRegistryWrapper extends ContractWrapper {
    * Get the CustomModulesAllowed status
    * @return bool
    */
-  public getCustomModulesAllowedStatus = async () => {
+  public getCustomModulesAllowedStatus = async (): Promise<boolean> => {
     return (await this.contract).getFeatureStatus.callAsync(Feature.CustomModulesAllowed);
   };
 
   /**
    * Get the FreezeMintingAllowed status
    * @return bool
    */
-  public getFreezeMintingAllowedStatus = async () => {
+  public getFreezeMintingAllowedStatus = async (): Promise<boolean> => {
     return (await this.contract).getFeatureStatus.callAsync(Feature.FreezeMintingAllowed);
   };