Merge pull request #51 from PolymathNetwork/clean-comments

Clean comments

Author: priom

src/contract_wrappers/Compliance.js

@@ -29,7 +29,6 @@ export default class Compliance extends ContractWrapper {
   constructor(
     web3Wrapper: Web3Wrapper,
     customers: Customers,
-    //   securityTokenRegistrar: SecurityTokenRegistrar,
     deployedAddress?: string,
   ) {
     super(web3Wrapper, complianceArtifact, deployedAddress);
@@ -311,6 +310,7 @@ export default class Compliance extends ContractWrapper {
 
   /**
    * Returns all Template proposals
+   * @param   SecurityTokenAddress  Address of the Security Token
    * @return An array of addresses
    */
   async getAllTemplateProposals(
@@ -323,6 +323,7 @@ export default class Compliance extends ContractWrapper {
 
   /**
    * Returns all STO proposal addresses
+   * @param   SecurityTokenAddress  Address of the Security Token
    * @return An array of addresses
    */
   async getAllOfferingProposals(

src/contract_wrappers/ContractWrapper.js

@@ -23,7 +23,7 @@ export default class ContractWrapper {
   _contract: any;
 
   _filters: { [string]: Web3Filter };
-  // _filterCallback: { [string]: EventCallback<mixed> };
+  //_filterCallback: { [string]: EventCallback<mixed> }; - from dave : need to examine if we need this
 
   isInitialized: boolean;
   isInitializing: boolean;

src/contract_wrappers/Customers.js

@@ -59,7 +59,7 @@ export default class Customers extends ContractWrapper {
   ): string {
     const wrappedCallback = callback;
 
-    //* *temporarily green this out, it isnt working, might not need */
+    //* *temporarily green this out, it isnt working, might not need - DAVE */
 
     // if (eventName === 'LogCustomerVerified') {
     //   // Convert from number roles to string enum roles.
@@ -185,7 +185,8 @@ export default class Customers extends ContractWrapper {
    * Submit an on-chain record that you have verified a customer's information.
    * @param  kycProviderAddress The Ethereum address of your KYC provider account
    * @param  customerAddress    The Ethereum address of the customer you verified
-   * @param  jurisdiction       The customer's jurisdiction that you verified. Either an ISO 3166-1 alpha-2 country code or an ISO 3166-2 country subdivision code.
+   * @param  countryJurisdiction   The customer's jurisdiction that you verified. An ISO 3166-1 alpha-2 country code
+   * @param  divisionJurisdiction  The customer's jurisdiction that you verified. An ISO 3166-2 country subdivision code.
    * @param  role               The type of Polymath user that the customer is (e.g. investor)
    * @param  accredited         Whether the customer is accredited
    * @param  expires            The time at which this verification should expire, in seconds since the Unix epoch

src/contract_wrappers/SecurityToken.js

@@ -284,7 +284,7 @@ export default class SecurityToken extends ContractWrapper {
 
   /**
    * Start the Offering after the template and STO selection
-   * @param owner                     Address of the Owner of a Security Token
+   * @param owner Address of the Owner of a Security Token
    */
   async startSecurityTokenOffering(owner: string) {
     await this._contract.startOffering({
@@ -437,6 +437,7 @@ export default class SecurityToken extends ContractWrapper {
   }
 
   /** Queries the shareholder details.
+   *
    * @return Returns the type {@link Shareholder}
    */
   async getShareholderDetails(
@@ -445,7 +446,9 @@ export default class SecurityToken extends ContractWrapper {
     return this._contract.shareholders.call(shareholderAddress);
   }
 
-  /** Queries the POLY allocation details, which cover the rules determining if the stakeholder will receive their POLY vesting.
+  /**
+   * Queries the POLY allocation details, which cover the rules determining if the stakeholder will receive their POLY vesting.
+   * @param polyStakeholderAddress The address of the stakeholder
    * @return Returns the type {@link PolyAllocation}
    */
   async getPolyAllocationDetails(
@@ -455,13 +458,16 @@ export default class SecurityToken extends ContractWrapper {
   }
 
   /** Checks to see how much a shareholder has contributed to the Security token.
+   * @param contributorAddress The address of the contributor
    * @return The amount the user has contributed contributed
    */
   async getContributedToSTO(contributorAddress: string): Promise<BigNumber> {
     return this._contract.contributedToSTO.call(contributorAddress);
   }
 
   /** Get information on if a shareholder has voted to freeze a POLY allocation.
+   * @param userAddress The address of the user who wants to vote
+   * @param addressBeingVotedOn The stakeholder who is being voted agaisnt
    * @return True if the shareholder has voted to freeze
    */
   async getVoted(

src/contract_wrappers/SecurityTokenRegistrar.js

@@ -71,11 +71,12 @@ export default class SecurityTokenRegistrar extends ContractWrapper {
    * @param name Name of the security token
    * @param ticker Ticker name of the security
    * @param totalSupply Total amount of tokens being created
+   * @param decimals The number of decimal places that the tokens can be split up into
    * @param owner Public Key address of the security token owner
+   * @param maxPoly Amount of POLY being raised
    * @param host The host of the security token wizard
    * @param fee POLY Fee being requested by the wizard host
    * @param type Type of security being tokenized (NEED TOKEN NUMBERS ie. security:1, somethingelse:2)
-   * @param maxPoly Amount of POLY being raised
    * @param lockupPeriod Length of time (unix) raised POLY will be locked up for dispute
    * @param quorum Percent of initial investors required to freeze POLY raise
    */

src/contract_wrappers/Template.js

@@ -154,9 +154,10 @@ export default class Template extends ContractWrapper {
 
   /**
    * Checks if the template requirements for jurisdiction, accreditation, and role are met.
-   * @param jurisdiction The ISO-3166 code of the investors jurisdiction (solidity type bytes32)
-   * @param accredited Defines if the investor is accredited or not
-   * @param role Role string used to see if the role is allowed for a security token (solidity type uint8)
+   * @param  countryJurisdiction   The customer's jurisdiction that you verified. An ISO 3166-1 alpha-2 country code
+   * @param  divisionJurisdiction  The customer's jurisdiction that you verified. An ISO 3166-2 country subdivision code.
+   * @param  accredited            Defines if the investor is accredited or not
+   * @param  role                  Role string used to see if the role is allowed for a security token (solidity type uint8)
    * @return True if it all template requirements are met
    */
   async checkTemplateRequirements(
@@ -246,26 +247,29 @@ export default class Template extends ContractWrapper {
 
   /**
    * Checks if the jurisdiction is allowed for this template
+   * @param  countryJurisdiction   The customer's jurisdiction that you verified. An ISO 3166-1 alpha-2 country code
    * @return True if the jurisdiction is allowed
    */
   async checkIfCountryJurisdictionIsAllowed(
-    jurisdiction: string,
+    countryJurisdiction: string,
   ): Promise<boolean> {
-    return this._contract.allowedJurisdictions.call(jurisdiction);
+    return this._contract.allowedJurisdictions.call(countryJurisdiction);
   }
 
   /**
    * Checks if the jurisdiction division is allowed for this template
+   * @param  divisionJurisdiction  The customer's jurisdiction that you verified. An ISO 3166-2 country subdivision code.
    * @return True if the division is allowed
    */
   async checkIfDivisionJurisdictionIsAllowed(
-    jurisdiction: string,
+    divisionJurisdiction: string,
   ): Promise<boolean> {
-    return this._contract.blockedDivisionJurisdictions.call(jurisdiction);
+    return this._contract.blockedDivisionJurisdictions.call(divisionJurisdiction);
   }
 
   /**
    * Checks if a role is allowed for the template
+   * @param role The role we are checking
    * @return True if the role is allowed
    */
   async checkIfRoleIsAllowed(role: number): Promise<boolean> {

test/Compliance_test.js

@@ -134,7 +134,7 @@ describe('Compliance wrapper', () => {
       });
     });
 
-    await makeKYCProvider(customers, accounts[1], expiryTime);
+    await makeKYCProvider(customers, accounts[1]);
     await makeLegalDelegate(polyToken, customers, accounts[1], accounts[2], expiryTime);
     const templateAddress = await makeTemplateWithFinalized(
       compliance,
@@ -154,7 +154,6 @@ describe('Compliance wrapper', () => {
     let logNewTemplateProposal = await logNewTemplateProposalArgsPromise;
     assert.equal(logNewTemplateProposal._securityToken, securityToken.address, 'ST address not picked up from LogNewTemplateProposal event') //needs to be renamed from core
 
-
     // Reputation
     let templateReputation = await compliance.getTemplateReputation(templateAddress);
     assert.equal(templateReputation.owner, accounts[2], "TemplateReputation not stored or read properly");
@@ -167,7 +166,6 @@ describe('Compliance wrapper', () => {
     let arrayOfTemplates = await compliance.getAllTemplateProposals(securityToken.address)
     assert.equal(arrayOfTemplates[0], templateAddress, 'Template address does not match the getter function return');
 
-
     await compliance.cancelTemplateProposal(accounts[2], securityToken.address, 0);
 
     let logCancleTemplateProposal = await logCancleTemplateProposalArgsPromise;
@@ -180,15 +178,11 @@ describe('Compliance wrapper', () => {
 
    });
 
-
   it('getMinimumVestingPeriod', async () => {
     let minimum = await compliance.getMinimumVestingPeriod();
     assert.equal(minimum, 60 * 60 * 24 * 100, "Does not equal 100 days, when it should")
   })
 
-  // so we need to have a securityToken actually created through STRegistrar
-  // and so me of the stuff has to match up
-  // then we have an actual one in offeringProposals
   it('setSTO, proposeSTO, cancleSTO, getSTOProposal, getSTOAddressByProposal, getAllOfferingProposals', async () => {
 
     //subscribtion setup
@@ -287,9 +281,6 @@ describe('Compliance wrapper', () => {
     let logNewContractProposal = await logNewContractProposalArgsPromise;
     assert.equal(logNewContractProposal._delegate, auditor, 'legal delegate not picked up from LogNewProposal event') //needs to be renamed from core
 
-    //to confirm setSTO, we need to check offerings for the msg.sender addr
-    //which is using getOfferingByProposal
-    //in setSTO we
     let getSTO = await compliance.getSTOProposal(securityToken.address, 0)
     assert.equal(getSTO.auditorAddress, auditor, "Auditor address not read properly");
 
@@ -304,19 +295,15 @@ describe('Compliance wrapper', () => {
     // Cancel Proposal
     await compliance.cancelSTOProposal(auditor, securityToken.address, 0);
 
-    //LOGCANCLESTOPROPOSAL
     let logCancleContractProposal = await logCancleContractProposalArgsPromise;
     assert.equal(logNewContractProposal._securityToken, securityToken.address, 'ST address not picked up from LogCancleContractProposal event') //needs to be renamed from core
 
 
-
     const addressShouldBeZero = await compliance.getSTOAddressByProposal(securityToken.address, 0)
     assert.equal(addressShouldBeZero, 0, 'Proposal did not return zero, which it should have for being cancelled');
 
     await compliance.unsubscribe(subscriptionID3);
     await compliance.unsubscribe(subscriptionID5);
-
-
   })
 
   it('LogTemplateCreated event test, subscribe, unsubscribe', async () => {
@@ -337,7 +324,7 @@ describe('Compliance wrapper', () => {
       });
     });
 
-    await makeKYCProvider(customers, accounts[1], expiryTime);
+    await makeKYCProvider(customers, accounts[1]);
     await makeLegalDelegate(polyToken, customers, accounts[1], accounts[2], expiryTime);
     const templateAddress = await makeTemplate(
       compliance,
@@ -346,16 +333,11 @@ describe('Compliance wrapper', () => {
       expiryTime,
     );
 
-
     const logTemplateCreated = await logTemplateCreatedArgsPromise;
     assert.equal(logTemplateCreated._creator, accounts[2], 'legal delegate creator address wasnt found in event subscription'); //'offeringtype' from make_examples.js
     assert.isAbove(logTemplateCreated._template.length, 20, 'template address wasnt found in event subscription');
     assert.equal(logTemplateCreated._offeringType, "offeringtype", 'offering type wasnt found in event subscription'); //'offeringtype' from make_examples.js
     await compliance.unsubscribe(subscriptionID1);
 
-
   })
-
-
-
 });

test/Customers_test.js

@@ -24,7 +24,7 @@ describe('Customers wrapper', () => {
     polyToken = await makePolyToken(web3Wrapper, accounts[0]);
     customers = await makeCustomers(web3Wrapper, polyToken, accounts[0]);
 
-    // Fund two accounts.
+    // Fund three accounts.
     await polyToken.generateNewTokens(
       new BigNumber(10).toPower(18).times(100000),
       accounts[0],

test/SecurityTokenRegistrar_test.js

@@ -31,7 +31,6 @@ describe('Registrar wrapper', () => {
   });
 
   beforeEach(async () => {
-    // parameters for Template constructor
     polyToken = await makePolyToken(web3Wrapper, accounts[0]);
     customers = await makeCustomers(web3Wrapper, polyToken, accounts[0]);
 
@@ -95,9 +94,6 @@ describe('Registrar wrapper', () => {
       quorum,
     );
 
-    // const address = await registrar.getSecurityTokenAddress(ticker);
-    // const tokenData = await registrar.getSecurityTokenData(address);
-
     const logs = await registrar.getLogs(
       'LogNewSecurityToken',
       {},
@@ -173,7 +169,7 @@ describe('Registrar wrapper', () => {
     const fee = 1000;
     const type = 1;
     const maxPoly = 100000;
-    const lockupPeriod = expiryTime + 31557600; // one year from jan 19 2017
+    const lockupPeriod = expiryTime + 31557600; // one year ahead
     const quorum = 75;
 
     await polyToken.approve(owner, registrar.address, fee);

test/SecurityToken_test.js

@@ -59,7 +59,7 @@ describe('SecurityToken wrapper', () => {
       expiryTime,
     );
 
-    // Fund four accounts.
+    // Fund five accounts.
     await polyToken.generateNewTokens(
       new BigNumber(10).toPower(18).times(100000),
       accounts[0],
@@ -252,7 +252,7 @@ describe('SecurityToken wrapper', () => {
       2592000,
     ); // 1 Month duration
 
-    await makeKYCProvider(customers, kycProvider, expiryTime);
+    await makeKYCProvider(customers, kycProvider);
 
     await makeLegalDelegate(polyToken, customers, kycProvider, legalDelegate, expiryTime);
 
@@ -322,7 +322,7 @@ describe('SecurityToken wrapper', () => {
     const kycProvider = accounts[1];
     const investor = accounts[3];
     const expiryTime = new BigNumber(web3.eth.getBlock('latest').timestamp).plus(10000);
-    await makeKYCProvider(customers, kycProvider, expiryTime);
+    await makeKYCProvider(customers, kycProvider);
 
     await makeLegalDelegate(polyToken, customers, kycProvider, legalDelegate, expiryTime);
 
@@ -403,7 +403,7 @@ describe('SecurityToken wrapper', () => {
         2592000,
       ); // 1 Month duration
 
-      await makeKYCProvider(customers, kycProvider, expiryTime);
+      await makeKYCProvider(customers, kycProvider);
 
       await makeLegalDelegate(polyToken, customers, kycProvider, legalDelegate, expiryTime);
 
@@ -657,7 +657,7 @@ describe('SecurityToken wrapper', () => {
     const legalDelegate = accounts[2];
     const investor = accounts[3];
     const expiryTime = new BigNumber(web3.eth.getBlock('latest').timestamp).plus(10000);
-    await makeKYCProvider(customers, kycProvider, expiryTime);
+    await makeKYCProvider(customers, kycProvider);
 
     await makeLegalDelegate(polyToken, customers, kycProvider, legalDelegate, expiryTime);
     const templateAddress = await makeTemplateWithFinalized(
@@ -765,7 +765,6 @@ describe('SecurityToken wrapper', () => {
             reject(err);
             return;
           }
-          // console.log
           resolve(log.args);
         },
       );
@@ -889,6 +888,7 @@ describe('SecurityToken wrapper', () => {
 
     await polyToken.approve(investor, securityToken.address, 10000);
     await increaseTime(1000); // Time Jump of 1000 seconds to reach beyond the sto start date
+
     // Bought Security Token using POLY
     await offering.buySecurityTokenWithPoly(investor, new BigNumber(10000));
     assert.equal(

test/Template_test.js

@@ -29,7 +29,7 @@ describe('Template wrapper', () => {
     const accredited = false;
     const KYC = accounts[1];
     const details = 'this would be hashes';
-    const expires = expiryTime.toNumber()// + 1000000;
+    const expires = expiryTime.toNumber();
 
     const fee = 1000;
     const quorum = 10;
@@ -142,7 +142,7 @@ describe('Template wrapper', () => {
   });
 
   it('updateTemplateDetails, getTemplateDetails', async () => {
-    await template.updateTemplateDetails(accounts[0], fakeBytes32); // fake hash
+    await template.updateTemplateDetails(accounts[0], fakeBytes32);
 
     const getUpdatedDetails = await template.getTemplateDetails();
     const newHash = getUpdatedDetails[0];
@@ -225,7 +225,7 @@ describe('Template wrapper', () => {
     const jurisdictionDivision = 'ON';
     const accredited = false;
     const role = 'investor';
-    const roleNotAdded = 'delegate'; // testing the failure
+    const roleNotAdded = 'delegate';
 
     await template.addJurisdiction(accounts[0], [jurisdictionCountry], [true]);
     await template.addDivisionJurisdiction(accounts[0], [jurisdictionDivision], [true]);
@@ -335,7 +335,7 @@ describe('Template wrapper', () => {
       });
     });
 
-    await template.updateTemplateDetails(accounts[0], fakeBytes32); // fake hash
+    await template.updateTemplateDetails(accounts[0], fakeBytes32);
 
     const detailsUpdated = await detailsUpdatedArgsPromise
     assert.equal(detailsUpdated._prevDetails, '0x7468697320776f756c6420626520686173686573000000000000000000000000', 'previous details wasnt found in event subscription'); //hash of 'this would be hashes'