Skip to content

Commit b182b6e

Browse files
committed
fix: documentation
1 parent 38fdc97 commit b182b6e

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

src/procedures/InvestInTieredSto.ts

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,22 @@ export const createRefreshTieredStoFactoryResolver = (
3636
};
3737

3838
/**
39-
* Procedure that allows invest in tokens with usd stablecoin
39+
* Procedure that invests in a Tiered STO
4040
*/
4141
export class InvestInTieredSto extends Procedure<InvestInTieredStoProcedureArgs> {
4242
public type = ProcedureType.InvestInTieredSto;
4343

4444
/**
45-
* - Buy tokens with usd stablecoin and with rate restriction (you should to buy a minimum amount of tokens as base)
45+
* Invest the specified amount in the STO
4646
*
47-
* Note that this procedure will fail if the security token symbol doesn't exist
48-
* Note that this procedure will fail if the STO address is invalid
49-
* Note that this procedure will fail if the STO is either archived or hasn't been launched
50-
* Note that this procedure will fail if the STO hasn't started yet
51-
* Note that this procedure will fail if the STO is paused
52-
* Note that this procedure will fail if the STO doesn't allow beneficial investments
53-
* Note that this procedure will fail if the STO doesn't support investments in the selected currency
47+
* Note that this procedure will fail if:
48+
* - The security token symbol doesn't exist
49+
* - The STO address is invalid
50+
* - The STO is either archived or hasn't been launched
51+
* - The STO hasn't started yet
52+
* - The STO is paused
53+
* - The STO doesn't allow beneficial investments when trying to invest on behalf of someone else if the STO doesn't allow beneficial investments
54+
* - The STO doesn't support investments in the selected currency
5455
*/
5556
public async prepareTransactions() {
5657
const { args, context } = this;

0 commit comments

Comments
 (0)