Skip to content

Commit ee597eb

Browse files
committed
docs: reserve security token documentation
1 parent 4a13c72 commit ee597eb

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/procedures/ReserveSecurityToken.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,23 @@ import { findEvents } from '../utils';
1818

1919
const { bigNumberToDate } = conversionUtils;
2020

21+
/**
22+
* - Procedure that reserve the token ticker to an specific owner
23+
*
24+
* ***Note once the token ticker is registered to its owner then no other issuer can claim its ownership***
25+
* ***Note if the ticker expires and its issuer hasn't used it, then someone else can take it***
26+
*/
2127
export class ReserveSecurityToken extends Procedure<
2228
ReserveSecurityTokenProcedureArgs,
2329
SecurityTokenReservation
2430
> {
2531
public type = ProcedureType.ReserveSecurityToken;
2632

33+
/**
34+
* - Reserve a new ticker
35+
*
36+
* Note that this procedure will fail if ticker has already been registered
37+
*/
2738
public async prepareTransactions() {
2839
const { args, context, addProcedure, addTransaction } = this;
2940
const { symbol, owner } = args;

0 commit comments

Comments
 (0)