feat: change Sto interface

monitz87 · monitz87 · commit 3a755dfbe40d · 2019-11-21T17:13:56.000-03:00
Removed `investments` in favor of a `getInvestments` function. Changed `investorAmount` to
`investorCount`

BREAKING CHANGE: Removed `investments` in favor of a `getInvestments` function. Changed
`investorAmount` to `investorCount`
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,5 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
   "editor.tabSize": 2,
-  "editor.formatOnSave": true,
-  "prettier.eslintIntegration": true
+  "editor.formatOnSave": true
 }
diff --git a/src/entities/CappedSto.ts b/src/entities/CappedSto.ts
@@ -1,10 +1,20 @@
-import { BigNumber } from '@polymathnetwork/contract-wrappers';
+import {
+  BigNumber,
+  ModuleName,
+  CappedSTOEvents,
+  BlockParamLiteral,
+  conversionUtils,
+  FULL_DECIMALS,
+} from '@polymathnetwork/contract-wrappers';
 import { serialize } from '../utils';
 import { Sto, UniqueIdentifiers, Params as StoParams } from './Sto';
 import { Context } from '../Context';
 import { InvestInCappedStoProcedureArgs, Currency } from '../types';
 import { TransactionQueue } from './TransactionQueue';
 import { InvestInCappedSto } from '../procedures';
+import { Investment } from './Investment';
+
+const { weiToValue } = conversionUtils;
 
 export interface Params extends StoParams {
   cap: BigNumber;
@@ -40,6 +50,48 @@ export class CappedSto extends Sto<Params> {
     this.uid = CappedSto.generateId({ address, stoType, securityTokenId });
   }
 
+  /**
+   * Retrieve all investments that have been made on this STO
+   */
+  public async getInvestments(): Promise<Investment[]> {
+    const {
+      context: { contractWrappers, factories },
+      address,
+      securityTokenSymbol: symbol,
+      securityTokenId,
+      uid: stoId,
+    } = this;
+
+    const module = await contractWrappers.moduleFactory.getModuleInstance({
+      name: ModuleName.CappedSTO,
+      address,
+    });
+
+    const tokenPurchases = await module.getLogsAsync({
+      eventName: CappedSTOEvents.TokenPurchase,
+      blockRange: {
+        fromBlock: BlockParamLiteral.Earliest,
+        toBlock: BlockParamLiteral.Latest,
+      },
+      indexFilterValues: {},
+    });
+    const investments = tokenPurchases.map(({ args: { beneficiary, amount, value } }, index) => ({
+      address: beneficiary,
+      tokenAmount: weiToValue(amount, FULL_DECIMALS),
+      investedFunds: weiToValue(value, FULL_DECIMALS),
+      index,
+    }));
+
+    const investmentEntities = investments.map(({ index, ...investment }) =>
+      factories.investmentFactory.create(Investment.generateId({ securityTokenId, stoId, index }), {
+        securityTokenSymbol: symbol,
+        ...investment,
+      })
+    );
+
+    return investmentEntities;
+  }
+
   /**
    * Invests in the STO
    *
diff --git a/src/entities/Sto.ts b/src/entities/Sto.ts
@@ -1,4 +1,4 @@
-import { BigNumber } from '@polymathnetwork/contract-wrappers';
+import { BigNumber, CappedSTOEvents } from '@polymathnetwork/contract-wrappers';
 import { Entity } from './Entity';
 import { unserialize } from '../utils';
 import { StoType, isStoType, Currency, ErrorCode, StoRole } from '../types';
@@ -7,6 +7,8 @@ import { PolymathError } from '../PolymathError';
 import { Context } from '../Context';
 import { PauseSto, AssignStoRole, FinalizeSto, ModifyBeneficialInvestments } from '../procedures';
 import { ModifyPreMinting } from '../procedures/ModifyPreMinting';
+import { CappedSto } from './CappedSto';
+import { TieredSto } from './TieredSto';
 
 export interface UniqueIdentifiers {
   securityTokenId: string;
@@ -29,8 +31,7 @@ export interface Params {
   unsoldTokensWallet: string;
   raisedAmount: BigNumber;
   soldTokensAmount: BigNumber;
-  investorAmount: number;
-  investments: Investment[];
+  investorCount: number;
   isPaused: boolean;
   capReached: boolean;
   isFinalized: boolean;
@@ -61,9 +62,7 @@ export abstract class Sto<P> extends Entity<P> {
 
   public soldTokensAmount: BigNumber;
 
-  public investorAmount: number;
-
-  public investments: Investment[];
+  public investorCount: number;
 
   public currencies: Currency[];
 
@@ -107,8 +106,7 @@ export abstract class Sto<P> extends Entity<P> {
       unsoldTokensWallet,
       raisedAmount,
       soldTokensAmount,
-      investorAmount,
-      investments,
+      investorCount,
       isPaused,
       capReached,
       isFinalized,
@@ -126,8 +124,7 @@ export abstract class Sto<P> extends Entity<P> {
     this.unsoldTokensWallet = unsoldTokensWallet;
     this.raisedAmount = raisedAmount;
     this.soldTokensAmount = soldTokensAmount;
-    this.investorAmount = investorAmount;
-    this.investments = investments;
+    this.investorCount = investorCount;
     this.currencies = currencies;
     this.isPaused = isPaused;
     this.capReached = capReached;
@@ -278,8 +275,7 @@ export abstract class Sto<P> extends Entity<P> {
       unsoldTokensWallet,
       raisedAmount,
       soldTokensAmount,
-      investorAmount,
-      investments,
+      investorCount,
       startDate,
       endDate,
       capReached,
@@ -299,15 +295,14 @@ export abstract class Sto<P> extends Entity<P> {
       unsoldTokensWallet,
       raisedAmount,
       soldTokensAmount,
-      investorAmount,
+      investorCount,
       startDate,
       endDate,
       capReached,
       isFinalized,
       isPaused,
       preMintAllowed,
       beneficialInvestmentsAllowed,
-      investments: investments.map(investment => investment.toPojo()),
     };
   }
 
@@ -321,8 +316,7 @@ export abstract class Sto<P> extends Entity<P> {
       unsoldTokensWallet,
       raisedAmount,
       soldTokensAmount,
-      investorAmount,
-      investments,
+      investorCount,
       isPaused,
       capReached,
       isFinalized,
@@ -362,12 +356,8 @@ export abstract class Sto<P> extends Entity<P> {
       this.soldTokensAmount = soldTokensAmount;
     }
 
-    if (investorAmount) {
-      this.investorAmount = investorAmount;
-    }
-
-    if (investments) {
-      this.investments = investments;
+    if (investorCount) {
+      this.investorCount = investorCount;
     }
 
     if (isPaused !== undefined) {
diff --git a/src/entities/TieredSto.ts b/src/entities/TieredSto.ts
@@ -1,10 +1,20 @@
-import { BigNumber } from '@polymathnetwork/contract-wrappers';
+import {
+  BigNumber,
+  ModuleName,
+  USDTieredSTOEvents,
+  BlockParamLiteral,
+  FULL_DECIMALS,
+  conversionUtils,
+} from '@polymathnetwork/contract-wrappers';
 import { serialize } from '../utils';
 import { Sto, UniqueIdentifiers, Params as StoParams } from './Sto';
 import { Context } from '../Context';
 import { StoTier, Currency, InvestInTieredStoProcedureArgs } from '../types';
 import { ModifyTieredStoData, InvestInTieredSto } from '../procedures';
 import { TransactionQueue } from './TransactionQueue';
+import { Investment } from './Investment';
+
+const { weiToValue } = conversionUtils;
 
 export { UniqueIdentifiers };
 
@@ -66,6 +76,50 @@ export class TieredSto extends Sto<Params> {
     this.uid = TieredSto.generateId({ address, stoType, securityTokenId });
   }
 
+  /**
+   * Retrieve all investments that have been made on this STO
+   */
+  public async getInvestments(): Promise<Investment[]> {
+    const {
+      context: { contractWrappers, factories },
+      address,
+      securityTokenSymbol: symbol,
+      securityTokenId,
+      uid: stoId,
+    } = this;
+
+    const module = await contractWrappers.moduleFactory.getModuleInstance({
+      name: ModuleName.UsdTieredSTO,
+      address,
+    });
+
+    const tokenPurchases = await module.getLogsAsync({
+      eventName: USDTieredSTOEvents.TokenPurchase,
+      blockRange: {
+        fromBlock: BlockParamLiteral.Earliest,
+        toBlock: BlockParamLiteral.Latest,
+      },
+      indexFilterValues: {},
+    });
+    const investments = tokenPurchases.map(
+      ({ args: { _beneficiary, _usdAmount, _tokens } }, index) => ({
+        address: _beneficiary,
+        tokenAmount: weiToValue(_tokens, FULL_DECIMALS),
+        investedFunds: weiToValue(_usdAmount, FULL_DECIMALS),
+        index,
+      })
+    );
+
+    const investmentEntities = investments.map(({ index, ...investment }) =>
+      factories.investmentFactory.create(Investment.generateId({ securityTokenId, stoId, index }), {
+        securityTokenSymbol: symbol,
+        ...investment,
+      })
+    );
+
+    return investmentEntities;
+  }
+
   /**
    * Modifies STO parameters. Must be done before the STO starts
    *
diff --git a/src/entities/factories/CappedStoFactory.ts b/src/entities/factories/CappedStoFactory.ts
@@ -1,49 +1,24 @@
-import {
-  ModuleName,
-  BlockParamLiteral,
-  conversionUtils,
-  FULL_DECIMALS,
-  CappedSTOEvents,
-  isCappedSTO_3_1_0,
-} from '@polymathnetwork/contract-wrappers';
+import { ModuleName, isCappedSTO_3_1_0 } from '@polymathnetwork/contract-wrappers';
 import { Factory } from './Factory';
 import { Context } from '../../Context';
 import { Currency } from '../../types';
 import { CappedSto, Params, UniqueIdentifiers } from '../CappedSto';
 import { SecurityToken } from '../SecurityToken';
-import { Investment } from '../Investment';
-
-const { weiToValue } = conversionUtils;
 
 export class CappedStoFactory extends Factory<CappedSto, Params, UniqueIdentifiers> {
   protected generateProperties = async (uid: string) => {
     const { securityTokenId, stoType, address } = CappedSto.unserialize(uid);
 
     const { symbol } = SecurityToken.unserialize(securityTokenId);
     const {
-      context: { contractWrappers, factories },
+      context: { contractWrappers },
     } = this;
 
     const module = await contractWrappers.moduleFactory.getModuleInstance({
       name: ModuleName.CappedSTO,
       address,
     });
 
-    const tokenPurchases = await module.getLogsAsync({
-      eventName: CappedSTOEvents.TokenPurchase,
-      blockRange: {
-        fromBlock: BlockParamLiteral.Earliest,
-        toBlock: BlockParamLiteral.Latest,
-      },
-      indexFilterValues: {},
-    });
-    const investments = tokenPurchases.map(({ args: { beneficiary, amount, value } }, index) => ({
-      address: beneficiary,
-      tokenAmount: weiToValue(amount, FULL_DECIMALS),
-      investedFunds: weiToValue(value, FULL_DECIMALS),
-      index,
-    }));
-
     const [
       isPaused,
       capReached,
@@ -84,26 +59,18 @@ export class CappedStoFactory extends Factory<CappedSto, Params, UniqueIdentifie
       address,
     });
 
-    const investmentEntities = investments.map(({ index, ...investment }) =>
-      factories.investmentFactory.create(Investment.generateId({ securityTokenId, stoId, index }), {
-        securityTokenSymbol: symbol,
-        ...investment,
-      })
-    );
-
     return {
       currencies: isRaisedInPoly ? [Currency.POLY] : [Currency.ETH],
       raisedFundsWallet,
       unsoldTokensWallet,
       raisedAmount: fundsRaised,
       soldTokensAmount: totalTokensSold,
-      investorAmount: investorCount,
+      investorCount,
       startDate: startTime,
       endDate: endTime,
       ...details,
       securityTokenId,
       securityTokenSymbol: symbol,
-      investments: investmentEntities,
       stoType,
       address,
       isPaused,
diff --git a/src/entities/factories/TieredStoFactory.ts b/src/entities/factories/TieredStoFactory.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"typescript.tsdk": "node_modules/typescript/lib",`
`3`	`3`	`"editor.tabSize": 2,`
`4`		`- "editor.formatOnSave": true,`
`5`		`- "prettier.eslintIntegration": true`
	`4`	`+ "editor.formatOnSave": true`
`6`	`5`	`}`