fix: replace 'STO' with 'Sto'

Author: remon-nashid

src/LowLevel/SecurityToken.ts

@@ -14,7 +14,7 @@ import {
   GetCheckpointArgs,
   TokenForceTransferArgs,
   StoModuleTypes,
-  GetSTOModuleArgs,
+  GetStoModuleArgs,
 } from './types';
 import { Context } from './LowLevel';
 import { fromUnixTimestamp, fromWei, getOptions, toWei } from './utils';
@@ -242,7 +242,7 @@ export class SecurityToken extends Contract<SecurityTokenContract> {
    *
    * @TODO remon-nashid: shouldn't module address be enough to fetch a module?
    */
-  public getSTOModule = async ({ address, stoType }: GetSTOModuleArgs): Promise<Sto | null> => {
+  public getStoModule = async ({ address, stoType }: GetStoModuleArgs): Promise<Sto | null> => {
     const { context } = this;
     const { methods } = this.contract;
 

src/LowLevel/types.ts

@@ -293,7 +293,7 @@ export interface TokenForceTransferArgs {
   log?: string;
 }
 
-export interface GetSTOModuleArgs {
+export interface GetStoModuleArgs {
   address: string;
   stoType: StoModuleTypes;
 }

src/Polymath.ts

@@ -43,7 +43,7 @@ import {
   SetDividendsWallet,
   ChangeDelegatePermission,
   EnableGeneralPermissionManager,
-  CancelSTO,
+  CancelSto,
 } from './procedures';
 import { Entity } from './entities/Entity';
 import { DividendsModule } from './entities/DividendsModule';
@@ -434,7 +434,7 @@ export class Polymath {
     return await procedure.prepare();
   };
 
-  public cancelSTO = async (args: {
+  public cancelSto = async (args: {
     moduleUid:
       | {
           securityTokenId: string;
@@ -445,7 +445,10 @@ export class Polymath {
     value: BigNumber;
     custodianAddress: string;
   }) => {
-    let securityTokenId: string; let stoType: StoModuleTypes; let address: string; let symbol: string;
+    let securityTokenId: string;
+    let stoType: StoModuleTypes;
+    let address: string;
+    let symbol: string;
     if (typeof args.moduleUid === 'string') {
       ({ securityTokenId, stoType, address } = this.StoModule.unserialize(args.moduleUid));
     } else {
@@ -455,7 +458,7 @@ export class Polymath {
     ({ symbol } = this.SecurityToken.unserialize(securityTokenId));
     const { custodianAddress, value } = args;
 
-    const procedure = new CancelSTO(
+    const procedure = new CancelSto(
       { symbol, stoType, stoModuleAddress: address, custodianAddress, value },
       this.context
     );

src/procedures/CancelSTO.ts renamed to src/procedures/CancelSto.ts

@@ -1,10 +1,10 @@
 import { Procedure } from './Procedure';
-import { ProcedureTypes, PolyTransactionTags, CancelSTOArgs, ErrorCodes } from '../types';
+import { ProcedureTypes, PolyTransactionTags, CancelStoArgs, ErrorCodes } from '../types';
 import { PolymathError } from '../PolymathError';
 import { isValidAddress } from '../utils';
 
-export class CancelSTO extends Procedure<CancelSTOArgs> {
-  public type = ProcedureTypes.CancelSTO;
+export class CancelSto extends Procedure<CancelStoArgs> {
+  public type = ProcedureTypes.CancelSto;
 
   public async prepareTransactions() {
     const { symbol, stoType, stoModuleAddress, custodianAddress, value } = this.args;
@@ -47,7 +47,7 @@ export class CancelSTO extends Procedure<CancelSTOArgs> {
       });
     }
 
-    const stoModule = await securityToken.getSTOModule({ address: stoModuleAddress, stoType });
+    const stoModule = await securityToken.getStoModule({ address: stoModuleAddress, stoType });
     if (!stoModule) {
       throw new PolymathError({
         code: ErrorCodes.ProcedureValidationError,
@@ -63,11 +63,11 @@ export class CancelSTO extends Procedure<CancelSTOArgs> {
     const logMessage = 'cancelling the STO';
 
     await this.addTransaction(stoModule.pause, {
-      tag: PolyTransactionTags.CancelSTO,
+      tag: PolyTransactionTags.CancelSto,
     })();
 
     await this.addTransaction(securityToken.forceTransfer, {
-      tag: PolyTransactionTags.CancelSTO,
+      tag: PolyTransactionTags.CancelSto,
     })({ from: custodianAddress, to: tokenOwner, value, data: '', log: logMessage });
   }
 }

src/procedures/index.ts

@@ -12,4 +12,4 @@ export { PushDividendPayment } from './PushDividendPayment';
 export { SetDividendsWallet } from './SetDividendsWallet';
 export { ChangeDelegatePermission } from './ChangeDelegatePermission';
 export { EnableGeneralPermissionManager } from './EnableGeneralPermissionManager';
-export { CancelSTO } from './CancelSTO';
+export { CancelSto } from './CancelSto';

src/types/index.ts

@@ -116,7 +116,7 @@ export enum ProcedureTypes {
   SetDividendsWallet = 'SetDividendsWallet',
   PushDividendPayment = 'PushDividendPayment',
   ChangeDelegatePermission = 'ChangeDelegatePermission',
-  CancelSTO = 'CancelSTO',
+  CancelSto = 'CancelSto',
 }
 
 export enum PolyTransactionTags {
@@ -137,7 +137,7 @@ export enum PolyTransactionTags {
   PushDividendPayment = 'PushDividendPayment',
   SetDividendsWallet = 'SetDividendsWallet',
   ChangeDelegatePermission = 'ChangeDelegatePermission',
-  CancelSTO = 'CancelSTO',
+  CancelSto = 'CancelSto',
 }
 
 export type MaybeResolver<T> = PostTransactionResolver<T> | T;
@@ -261,7 +261,7 @@ export interface ChangeDelegatePermissionArgs {
   details?: string;
 }
 
-export interface CancelSTOArgs {
+export interface CancelStoArgs {
   symbol: string;
   stoType: StoModuleTypes;
   stoModuleAddress: string;