feat: rename CappedSto to SimpleSto

All relevant types and enums were changed as well

BREAKING CHANGE: rename CappedSto to SimpleSto

Author: monitz87

src/Context.ts

@@ -5,7 +5,7 @@ import {
   SecurityTokenReservationFactory,
   Erc20TokenBalanceFactory,
   InvestmentFactory,
-  CappedStoFactory,
+  SimpleStoFactory,
   TieredStoFactory,
   DividendDistributionFactory,
   CheckpointFactory,
@@ -24,7 +24,7 @@ export interface Factories {
   securityTokenReservationFactory: SecurityTokenReservationFactory;
   erc20TokenBalanceFactory: Erc20TokenBalanceFactory;
   investmentFactory: InvestmentFactory;
-  cappedStoFactory: CappedStoFactory;
+  simpleStoFactory: SimpleStoFactory;
   tieredStoFactory: TieredStoFactory;
   dividendDistributionFactory: DividendDistributionFactory;
   checkpointFactory: CheckpointFactory;
@@ -60,7 +60,7 @@ export class Context {
       securityTokenReservationFactory: new SecurityTokenReservationFactory(this),
       erc20TokenBalanceFactory: new Erc20TokenBalanceFactory(this),
       investmentFactory: new InvestmentFactory(this),
-      cappedStoFactory: new CappedStoFactory(this),
+      simpleStoFactory: new SimpleStoFactory(this),
       tieredStoFactory: new TieredStoFactory(this),
       dividendDistributionFactory: new DividendDistributionFactory(this),
       checkpointFactory: new CheckpointFactory(this),

src/entities/SecurityToken/Offerings.ts

@@ -2,19 +2,19 @@ import { BigNumber, ModuleName } from '@polymathnetwork/contract-wrappers';
 import { includes } from 'lodash';
 import { SubModule } from './SubModule';
 import { StoTier, Currency, StoType, ErrorCode } from '../../types';
-import { LaunchCappedSto, LaunchTieredSto } from '../../procedures';
-import { CappedSto, TieredSto, Sto } from '..';
+import { LaunchSimpleSto, LaunchTieredSto } from '../../procedures';
+import { SimpleSto, TieredSto, Sto } from '..';
 import { PolymathError } from '../../PolymathError';
 
 interface GetSto {
-  (args: { stoType: StoType.Capped; address: string }): Promise<CappedSto>;
+  (args: { stoType: StoType.Simple; address: string }): Promise<SimpleSto>;
   (args: { stoType: StoType.Tiered; address: string }): Promise<TieredSto>;
-  (args: string): Promise<CappedSto | TieredSto>;
+  (args: string): Promise<SimpleSto | TieredSto>;
 }
 
 export class Offerings extends SubModule {
   /**
-   * Launch a Capped STO
+   * Launch a Simple STO
    *
    * @param startDate date when the STO should start
    * @param endDate date when the STO should end
@@ -25,7 +25,7 @@ export class Offerings extends SubModule {
    * @param unsoldTokensWallet wallet address that will receive unsold tokens
    * @param allowPreMinting whether to have all tokens minted on STO start. Default behavior is to mint on purchase
    */
-  public launchCappedSto = async (args: {
+  public launchSimpleSto = async (args: {
     startDate: Date;
     endDate: Date;
     tokensOnSale: BigNumber;
@@ -37,7 +37,7 @@ export class Offerings extends SubModule {
   }) => {
     const { context, securityToken } = this;
     const { symbol } = securityToken;
-    const procedure = new LaunchCappedSto(
+    const procedure = new LaunchSimpleSto(
       {
         symbol,
         ...args,
@@ -118,9 +118,9 @@ export class Offerings extends SubModule {
       securityToken: { uid },
     } = this;
 
-    if (stoType === StoType.Capped) {
-      return factories.cappedStoFactory.fetch(
-        CappedSto.generateId({ securityTokenId: uid, stoType, address })
+    if (stoType === StoType.Simple) {
+      return factories.simpleStoFactory.fetch(
+        SimpleSto.generateId({ securityTokenId: uid, stoType, address })
       );
     } else if (stoType === StoType.Tiered) {
       return factories.tieredStoFactory.fetch(
@@ -143,7 +143,7 @@ export class Offerings extends SubModule {
     opts: {
       stoTypes: StoType[];
     } = {
-      stoTypes: [StoType.Capped, StoType.Tiered],
+      stoTypes: [StoType.Simple, StoType.Tiered],
     }
   ) => {
     const { contractWrappers, factories } = this.context;
@@ -152,9 +152,9 @@ export class Offerings extends SubModule {
 
     const { stoTypes } = opts;
 
-    let stos: Promise<CappedSto | TieredSto>[] = [];
+    let stos: Promise<SimpleSto | TieredSto>[] = [];
 
-    if (includes(stoTypes, StoType.Capped)) {
+    if (includes(stoTypes, StoType.Simple)) {
       const fetchedModules = await contractWrappers.getAttachedModules(
         { symbol: securityTokenSymbol, moduleName: ModuleName.CappedSTO },
         { unarchived: true }
@@ -164,8 +164,8 @@ export class Offerings extends SubModule {
 
       stos = stos.concat(
         addresses.map(address =>
-          factories.cappedStoFactory.fetch(
-            CappedSto.generateId({ address, stoType: StoType.Capped, securityTokenId: uid })
+          factories.simpleStoFactory.fetch(
+            SimpleSto.generateId({ address, stoType: StoType.Simple, securityTokenId: uid })
           )
         )
       );
@@ -182,7 +182,7 @@ export class Offerings extends SubModule {
       stos = stos.concat(
         addresses.map(address =>
           factories.tieredStoFactory.fetch(
-            TieredSto.generateId({ address, stoType: StoType.Capped, securityTokenId: uid })
+            TieredSto.generateId({ address, stoType: StoType.Tiered, securityTokenId: uid })
           )
         )
       );

src/entities/CappedSto.ts renamed to src/entities/SimpleSto.ts

@@ -9,8 +9,6 @@ import {
 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';
 
@@ -23,9 +21,9 @@ export interface Params extends StoParams {
 
 export { UniqueIdentifiers };
 
-export class CappedSto extends Sto<Params> {
+export class SimpleSto extends Sto<Params> {
   public static generateId({ securityTokenId, stoType, address }: UniqueIdentifiers) {
-    return serialize('cappedSto', {
+    return serialize('simpleSto', {
       securityTokenId,
       stoType,
       address,
@@ -47,7 +45,7 @@ export class CappedSto extends Sto<Params> {
 
     this.cap = cap;
     this.rate = rate;
-    this.uid = CappedSto.generateId({ address, stoType, securityTokenId });
+    this.uid = SimpleSto.generateId({ address, stoType, securityTokenId });
   }
 
   /**

src/entities/Sto.ts

@@ -1,8 +1,7 @@
-import { BigNumber, CappedSTOEvents } from '@polymathnetwork/contract-wrappers';
+import { BigNumber } from '@polymathnetwork/contract-wrappers';
 import { Entity } from './Entity';
 import { unserialize } from '../utils';
 import { StoType, isStoType, Currency, ErrorCode, StoRole } from '../types';
-import { Investment } from './Investment';
 import { PolymathError } from '../PolymathError';
 import { Context } from '../Context';
 import {
@@ -12,8 +11,6 @@ import {
   ModifyBeneficialInvestments,
 } from '../procedures';
 import { ModifyPreMinting } from '../procedures/ModifyPreMinting';
-import { CappedSto } from './CappedSto';
-import { TieredSto } from './TieredSto';
 
 export interface UniqueIdentifiers {
   securityTokenId: string;

src/entities/factories/InvestmentFactory.ts

@@ -23,7 +23,7 @@ export class InvestmentFactory extends Factory<Investment, Params, UniqueIdentif
     const { stoType, address } = Sto.unserialize(stoId);
     const { symbol } = SecurityToken.unserialize(securityTokenId);
 
-    if (stoType === StoType.Capped) {
+    if (stoType === StoType.Simple) {
       const module = await this.context.contractWrappers.moduleFactory.getModuleInstance({
         name: ModuleName.CappedSTO,
         address,

src/entities/factories/CappedStoFactory.ts renamed to src/entities/factories/SimpleStoFactory.ts

@@ -2,12 +2,12 @@ import { ModuleName, isCappedSTO_3_1_0 } from '@polymathnetwork/contract-wrapper
 import { Factory } from './Factory';
 import { Context } from '../../Context';
 import { Currency } from '../../types';
-import { CappedSto, Params, UniqueIdentifiers } from '../CappedSto';
+import { SimpleSto, Params, UniqueIdentifiers } from '../SimpleSto';
 import { SecurityToken } from '../SecurityToken';
 
-export class CappedStoFactory extends Factory<CappedSto, Params, UniqueIdentifiers> {
+export class SimpleStoFactory extends Factory<SimpleSto, Params, UniqueIdentifiers> {
   protected generateProperties = async (uid: string) => {
-    const { securityTokenId, stoType, address } = CappedSto.unserialize(uid);
+    const { securityTokenId, stoType, address } = SimpleSto.unserialize(uid);
 
     const { symbol } = SecurityToken.unserialize(securityTokenId);
     const {
@@ -53,12 +53,6 @@ export class CappedStoFactory extends Factory<CappedSto, Params, UniqueIdentifie
       ]);
     }
 
-    const stoId = CappedSto.generateId({
-      securityTokenId,
-      stoType,
-      address,
-    });
-
     return {
       currencies: isRaisedInPoly ? [Currency.POLY] : [Currency.ETH],
       raisedFundsWallet,
@@ -82,6 +76,6 @@ export class CappedStoFactory extends Factory<CappedSto, Params, UniqueIdentifie
   };
 
   constructor(context: Context) {
-    super(CappedSto, context);
+    super(SimpleSto, context);
   }
 }

src/entities/factories/index.ts

@@ -2,7 +2,7 @@ export { SecurityTokenFactory } from './SecurityTokenFactory';
 export { SecurityTokenReservationFactory } from './SecurityTokenReservationFactory';
 export { Erc20TokenBalanceFactory } from './Erc20TokenBalanceFactory';
 export { InvestmentFactory } from './InvestmentFactory';
-export { CappedStoFactory } from './CappedStoFactory';
+export { SimpleStoFactory } from './SimpleStoFactory';
 export { TieredStoFactory } from './TieredStoFactory';
 export { DividendDistributionFactory } from './DividendDistributionFactory';
 export { CheckpointFactory } from './CheckpointFactory';

src/entities/index.ts

@@ -10,7 +10,7 @@ export { TaxWithholding } from './TaxWithholding';
 export { PolyTransaction } from './PolyTransaction';
 export { TransactionQueue } from './TransactionQueue';
 export { Erc20TokenBalance } from './Erc20TokenBalance';
-export { CappedSto } from './CappedSto';
+export { SimpleSto } from './SimpleSto';
 export { TieredSto } from './TieredSto';
 export { Investment } from './Investment';
 export { Sto } from './Sto';

src/procedures/FinalizeSto.ts

@@ -9,7 +9,7 @@ import {
 } from '../types';
 import { PolymathError } from '../PolymathError';
 import { isValidAddress } from '../utils';
-import { SecurityToken, CappedSto, TieredSto } from '../entities';
+import { SecurityToken, SimpleSto, TieredSto } from '../entities';
 
 export class FinalizeSto extends Procedure<FinalizeStoProcedureArgs> {
   public type = ProcedureType.FinalizeSto;
@@ -46,7 +46,7 @@ export class FinalizeSto extends Procedure<FinalizeStoProcedureArgs> {
     let remainingTokens: BigNumber;
 
     switch (stoType) {
-      case StoType.Capped: {
+      case StoType.Simple: {
         stoModule = await contractWrappers.moduleFactory.getModuleInstance({
           name: ModuleName.CappedSTO,
           address: stoAddress,
@@ -126,11 +126,11 @@ export class FinalizeSto extends Procedure<FinalizeStoProcedureArgs> {
           const securityTokenId = SecurityToken.generateId({ symbol });
 
           switch (stoType) {
-            case StoType.Capped: {
-              return factories.cappedStoFactory.refresh(
-                CappedSto.generateId({
+            case StoType.Simple: {
+              return factories.simpleStoFactory.refresh(
+                SimpleSto.generateId({
                   securityTokenId,
-                  stoType: StoType.Capped,
+                  stoType,
                   address: stoAddress,
                 })
               );
@@ -139,7 +139,7 @@ export class FinalizeSto extends Procedure<FinalizeStoProcedureArgs> {
               return factories.tieredStoFactory.refresh(
                 TieredSto.generateId({
                   securityTokenId,
-                  stoType: StoType.Tiered,
+                  stoType,
                   address: stoAddress,
                 })
               );

src/procedures/InvestInCappedSto.ts

@@ -10,7 +10,7 @@ import {
 } from '../types';
 import { PolymathError } from '../PolymathError';
 import { isValidAddress } from '../utils';
-import { SecurityToken, CappedSto } from '../entities';
+import { SecurityToken, SimpleSto } from '../entities';
 import { ApproveErc20 } from './ApproveErc20';
 
 export class InvestInCappedSto extends Procedure<InvestInCappedStoProcedureArgs> {
@@ -23,7 +23,7 @@ export class InvestInCappedSto extends Procedure<InvestInCappedStoProcedureArgs>
 
     const {
       contractWrappers,
-      factories: { cappedStoFactory },
+      factories: { simpleStoFactory },
     } = context;
 
     /**
@@ -59,13 +59,13 @@ export class InvestInCappedSto extends Procedure<InvestInCappedStoProcedureArgs>
     }
 
     const securityTokenId = SecurityToken.generateId({ symbol });
-    const cappedStoId = CappedSto.generateId({
+    const simpleStoId = SimpleSto.generateId({
       securityTokenId,
-      stoType: StoType.Capped,
+      stoType: StoType.Simple,
       address: stoAddress,
     });
 
-    const sto = await cappedStoFactory.fetch(cappedStoId);
+    const sto = await simpleStoFactory.fetch(simpleStoId);
 
     const {
       isFinalized,
@@ -107,7 +107,7 @@ export class InvestInCappedSto extends Procedure<InvestInCappedStoProcedureArgs>
 
     const resolvers = [
       async () => {
-        return cappedStoFactory.refresh(cappedStoId);
+        return simpleStoFactory.refresh(simpleStoId);
       },
     ];