Merge branch 'docs/security-token-entity' of github.com:PolymathNetwork/polymath-sdk into docs/security-token-entity

Author: shuffledex

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polymathnetwork/sdk",
-  "version": "2.0.1-beta.90",
+  "version": "2.0.1-beta.93",
   "description": "A Javascript SDK for interacting with the Polymath network for the browser and Node.js",
   "bugs": {
     "url": "https://github.com/PolymathNetwork/polymath-sdk/issues"

src/entities/SecurityToken/Issuance/Offerings.ts

@@ -24,29 +24,27 @@ interface LaunchTieredStoParams {
   currencies: Currency[];
   raisedFundsWallet: string;
   unsoldTokensWallet: string;
-  stableCoinAddresses: string[];
+  stableCoinAddresses?: string[];
   customCurrency?: Partial<CustomCurrency>;
   allowPreIssuance?: boolean;
 }
 
-type OnlyEth =
-  | [Currency.ETH]
-  | [Currency.StableCoin, Currency.ETH]
-  | [Currency.ETH, Currency.StableCoin];
-type OnlyPoly =
-  | [Currency.POLY]
+type OnlyEth = [Currency.ETH];
+type EthAndStableCoin = [Currency.StableCoin, Currency.ETH] | [Currency.ETH, Currency.StableCoin];
+type OnlyPoly = [Currency.POLY];
+type PolyAndStableCoin =
   | [Currency.StableCoin, Currency.POLY]
   | [Currency.POLY, Currency.StableCoin];
-type EthAndPoly =
-  | [Currency.ETH, Currency.POLY]
-  | [Currency.POLY, Currency.ETH]
+type EthAndPoly = [Currency.ETH, Currency.POLY] | [Currency.POLY, Currency.ETH];
+type AllCurrencies =
   | [Currency.StableCoin, Currency.ETH, Currency.POLY]
   | [Currency.ETH, Currency.StableCoin, Currency.POLY]
   | [Currency.ETH, Currency.POLY, Currency.StableCoin]
   | [Currency.StableCoin, Currency.POLY, Currency.ETH]
   | [Currency.POLY, Currency.StableCoin, Currency.ETH]
   | [Currency.POLY, Currency.ETH, Currency.StableCoin];
 
+
 /**
  * Params for [[getSto]]
  */
@@ -60,7 +58,23 @@ interface LaunchTieredStoNoCustomCurrencyParams
   currencies: OnlyEth | OnlyPoly | EthAndPoly;
 }
 
+interface LaunchTieredStoNoCustomCurrencyParams
+  extends Omit<LaunchTieredStoParams, 'customCurrency'> {
+  currencies: EthAndStableCoin | PolyAndStableCoin | AllCurrencies;
+  stableCoinAddresses: string[];
+}
+
 interface LaunchTieredStoCustomCurrencyEthParams extends LaunchTieredStoParams {
+  currencies: OnlyEth | EthAndStableCoin;
+  customCurrency: {
+    currencySymbol?: string;
+    ethOracleAddress: string;
+  };
+  stableCoinAddresses: string[];
+}
+
+interface LaunchTieredStoCustomCurrencyEthNoStableCoinParams
+  extends Omit<LaunchTieredStoParams, 'stableCoinAddresses'> {
   currencies: OnlyEth;
   customCurrency: {
     currencySymbol?: string;
@@ -69,6 +83,16 @@ interface LaunchTieredStoCustomCurrencyEthParams extends LaunchTieredStoParams {
 }
 
 interface LaunchTieredStoCustomCurrencyPolyParams extends LaunchTieredStoParams {
+  currencies: OnlyPoly | PolyAndStableCoin;
+  customCurrency: {
+    currencySymbol?: string;
+    polyOracleAddress: string;
+  };
+  stableCoinAddresses: string[];
+}
+
+interface LaunchTieredStoCustomCurrencyPolyNoStableCoinParams
+  extends Omit<LaunchTieredStoParams, 'stableCoinAddresses'> {
   currencies: OnlyPoly;
   customCurrency: {
     currencySymbol?: string;
@@ -77,6 +101,17 @@ interface LaunchTieredStoCustomCurrencyPolyParams extends LaunchTieredStoParams
 }
 
 interface LaunchTieredStoCustomCurrencyBothParams extends LaunchTieredStoParams {
+  currencies: AllCurrencies;
+  customCurrency: {
+    currencySymbol?: string;
+    ethOracleAddress: string;
+    polyOracleAddress: string;
+  };
+  stableCoinAddresses: string[];
+}
+
+interface LaunchTieredStoCustomCurrencyBothNoStableCoinParams
+  extends Omit<LaunchTieredStoParams, 'stableCoinAddresses'> {
   currencies: EthAndPoly;
   customCurrency: {
     currencySymbol?: string;
@@ -87,16 +122,28 @@ interface LaunchTieredStoCustomCurrencyBothParams extends LaunchTieredStoParams
 
 interface LaunchTieredStoMethod {
   (args: LaunchTieredStoNoCustomCurrencyParams): Promise<
-    TransactionQueue<LaunchTieredStoProcedureArgs>
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
+  >;
+  (args: LaunchTieredStoNoCustomCurrencyNoStableCoinParams): Promise<
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
   >;
   (args: LaunchTieredStoCustomCurrencyEthParams): Promise<
-    TransactionQueue<LaunchTieredStoProcedureArgs>
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
+  >;
+  (args: LaunchTieredStoCustomCurrencyEthNoStableCoinParams): Promise<
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
   >;
   (args: LaunchTieredStoCustomCurrencyPolyParams): Promise<
-    TransactionQueue<LaunchTieredStoProcedureArgs>
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
+  >;
+  (args: LaunchTieredStoCustomCurrencyPolyNoStableCoinParams): Promise<
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
   >;
   (args: LaunchTieredStoCustomCurrencyBothParams): Promise<
-    TransactionQueue<LaunchTieredStoProcedureArgs>
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
+  >;
+  (args: LaunchTieredStoCustomCurrencyBothNoStableCoinParams): Promise<
+    TransactionQueue<LaunchTieredStoProcedureArgs, TieredSto>
   >;
 }
 

src/entities/TieredSto.ts

@@ -32,6 +32,9 @@ export interface Tier {
 export interface Params extends StoParams {
   currentTier: number;
   tiers: Tier[];
+  nonAccreditedInvestmentLimit: BigNumber;
+  minimumInvestment: BigNumber;
+  stableCoinAddresses: string[];
 }
 
 interface BaseParams {
@@ -64,15 +67,31 @@ export class TieredSto extends Sto<Params> {
 
   public currentTier: number;
 
+  public nonAccreditedInvestmentLimit: BigNumber;
+
+  public minimumInvestment: BigNumber;
+
+  public stableCoinAddresses: string[];
+
   public tiers: Tier[];
 
   constructor(params: Params & UniqueIdentifiers, context: Context) {
-    const { currentTier, tiers, ...rest } = params;
+    const {
+      currentTier,
+      tiers,
+      nonAccreditedInvestmentLimit,
+      minimumInvestment,
+      stableCoinAddresses,
+      ...rest
+    } = params;
 
     super(rest, context);
 
     const { securityTokenId, address, stoType } = rest;
 
+    this.nonAccreditedInvestmentLimit = nonAccreditedInvestmentLimit;
+    this.minimumInvestment = minimumInvestment;
+    this.stableCoinAddresses = stableCoinAddresses;
     this.currentTier = currentTier;
     this.tiers = tiers;
     this.uid = TieredSto.generateId({ address, stoType, securityTokenId });

src/entities/factories/TieredStoFactory.ts

@@ -28,6 +28,8 @@ export class TieredStoFactory extends Factory<TieredSto, Params, UniqueIdentifie
       raisedFundsWallet,
       unsoldTokensWallet,
       numberOfTiers,
+      minimumInvestment,
+      nonAccreditedInvestmentLimit,
       {
         tokensSold,
         capPerTier,
@@ -49,8 +51,11 @@ export class TieredStoFactory extends Factory<TieredSto, Params, UniqueIdentifie
       module.wallet(),
       contractWrappers.getTreasuryWallet({ module }),
       module.getNumberOfTiers(),
+      module.minimumInvestmentUSD(),
+      module.nonAccreditedLimitUSD(),
       module.getSTODetails(),
     ]);
+    const stableCoinAddresses = await module.getUsdTokens();
 
     let preIssueAllowed = false;
     let tiers: Tier[];
@@ -133,6 +138,9 @@ export class TieredStoFactory extends Factory<TieredSto, Params, UniqueIdentifie
       isFinalized,
       preIssueAllowed,
       beneficialInvestmentsAllowed,
+      minimumInvestment,
+      nonAccreditedInvestmentLimit,
+      stableCoinAddresses,
     };
   };
 

src/procedures/LaunchSimpleSto.ts

@@ -74,10 +74,16 @@ export class LaunchSimpleSto extends Procedure<LaunchSimpleStoProcedureArgs, Sim
       usdCost = cost;
     }
 
-    await this.addProcedure(TransferErc20)({
-      receiver: securityTokenAddress,
-      amount: polyCost,
-    });
+    const balance = await contractWrappers.polyToken.balanceOf({ owner: securityTokenAddress });
+    const difference = polyCost.minus(balance);
+
+    // only transfer the required amount of POLY
+    if (difference.gt(new BigNumber(0))) {
+      await this.addProcedure(TransferErc20)({
+        receiver: securityTokenAddress,
+        amount: difference,
+      });
+    }
 
     const fundRaiseType =
       currency === Currency.ETH ? CappedSTOFundRaiseType.ETH : CappedSTOFundRaiseType.POLY;

src/procedures/LaunchTieredSto.ts

@@ -35,7 +35,7 @@ export class LaunchTieredSto extends Procedure<LaunchTieredStoProcedureArgs, Tie
       currencies,
       raisedFundsWallet,
       unsoldTokensWallet,
-      stableCoinAddresses,
+      stableCoinAddresses = [],
       customCurrency,
       allowPreIssuing = false,
     } = args;
@@ -57,6 +57,13 @@ export class LaunchTieredSto extends Procedure<LaunchTieredStoProcedureArgs, Tie
       });
     }
 
+    if (currencies.includes(FundRaiseType.StableCoin) && stableCoinAddresses.length === 0) {
+      throw new PolymathError({
+        code: ErrorCode.ProcedureValidationError,
+        message: 'Stable Coin address array cannot be empty if raising in Stable Coin',
+      });
+    }
+
     const customOracleAddresses: string[] = [];
     let denominatedCurrency = '';
 
@@ -116,10 +123,16 @@ export class LaunchTieredSto extends Procedure<LaunchTieredStoProcedureArgs, Tie
       usdCost = cost;
     }
 
-    await this.addProcedure(TransferErc20)({
-      receiver: securityTokenAddress,
-      amount: polyCost,
-    });
+    const balance = await contractWrappers.polyToken.balanceOf({ owner: securityTokenAddress });
+    const difference = polyCost.minus(balance);
+
+    // only transfer the required amount of POLY
+    if (difference.gt(new BigNumber(0))) {
+      await this.addProcedure(TransferErc20)({
+        receiver: securityTokenAddress,
+        amount: difference,
+      });
+    }
 
     const ratePerTier: BigNumber[] = [];
     const ratePerTierDiscountPoly: BigNumber[] = [];