Skip to content

Commit eaeb476

Browse files
committed
fix: improve comments into the code
1 parent 744abe9 commit eaeb476

File tree

2 files changed

+3
-6
lines changed

2 files changed

+3
-6
lines changed

src/entities/SecurityToken/Issuance/Offerings.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,7 @@ export class Offerings extends SubModule {
151151
* @param args.raisedFundsWallet - wallet address that will receive the funds that are being raised
152152
* @param args.unsoldTokensWallet - wallet address that will receive unsold tokens when the end date is reached
153153
* @param args.stableCoinAddresses - array of stable coins that the offering supports
154-
* @param args.customCurrency - it can be optional
155-
* @param customCurrency.currencySymbol symbol of the custom currency (USD, CAD, EUR, etc. Default is USD)
156-
* @param customCurrency.ethOracleAddress address of the oracle that states the price of ETH in the custom currency. Only required if raising funds in ETH
157-
* @param customCurrency.polyOracleAddress address of the oracle that states the price of POLY in the custom currency. Only required if raising funds in POLY
154+
* @param args.customCurrency - allows the STO to raise funds pegged to a different currency. Optional, defaults to USD
158155
* @param args.allowPreIssuance - whether to have all tokens issued on STO start. Default behavior is to issue on purchase
159156
*/
160157
public launchTieredSto: LaunchTieredStoMethod = async (

src/entities/SecurityToken/SecurityToken.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export interface Params {
6666
/**
6767
* Unserialize string to a Security Token object representation
6868
*
69-
* @param serialized - security token's serialized representation
69+
* @param serialized - Security Token's serialized representation
7070
*/
7171
export const unserialize = (serialized: string) => {
7272
const unserialized = unserializeUtil(serialized);
@@ -129,7 +129,7 @@ export class SecurityToken extends Entity<Params> {
129129
public currentCheckpoint: number;
130130

131131
/**
132-
* treasury wallet used by some features.
132+
* treasury wallet used by some features
133133
*/
134134
public treasuryWallet: string;
135135

0 commit comments

Comments
 (0)