SecurityTokenReservation
Class used to manage all the Security Token Reservation functionality
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new SecurityTokenReservation(params
: Params & UniqueIdentifiers, context
: Context): SecurityTokenReservation
Defined in src/entities/SecurityTokenReservation.ts:92
Create a new SecurityTokenReservation instance
Parameters:
Returns: SecurityTokenReservation
Properties
Protected
context
Protected
context• context: Context
Defined in src/entities/SecurityTokenReservation.ts:92
expiry
• expiry: Date
Defined in src/entities/SecurityTokenReservation.ts:75
Date at which this reservation expires
ownerAddress
• ownerAddress: string
Defined in src/entities/SecurityTokenReservation.ts:85
Address of the owner of the reservation
reservedAt
• reservedAt: Date
Defined in src/entities/SecurityTokenReservation.ts:80
Date when the Security Token was reserved
Optional
securityTokenAddress
Optional
securityTokenAddress• securityTokenAddress? : undefined | string
Defined in src/entities/SecurityTokenReservation.ts:90
Address of the Security Token if it has already been launched, undefined if not
symbol
• symbol: string
Defined in src/entities/SecurityTokenReservation.ts:70
uid
• uid: string
Defined in src/entities/SecurityTokenReservation.ts:68
Methods
_refresh
▸ _refresh(params
: Partial‹Params›): void
Defined in src/entities/SecurityTokenReservation.ts:167
Hydrate the entity
Parameters:
Returns: void
createSecurityToken
▸ createSecurityToken(args
: object): Promise‹TransactionQueue‹CreateSecurityTokenProcedureArgs, SecurityToken››
Defined in src/entities/SecurityTokenReservation.ts:119
Creates a security token with the reserved symbol
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹CreateSecurityTokenProcedureArgs, SecurityToken››
isLaunched
▸ isLaunched(): Promise‹boolean›
Defined in src/entities/SecurityTokenReservation.ts:138
Returns true if the Security Token associated to this reservation has already been launched
Returns: Promise‹boolean›
toPojo
▸ toPojo(): object
Defined in src/entities/SecurityTokenReservation.ts:158
Convert entity to a POJO (Plain Old Javascript Object)
Returns: object
expiry: Date
ownerAddress: string
reservedAt: Date
securityTokenAddress: undefined | string
symbol: string
uid: string
transferOwnership
▸ transferOwnership(args
: object): Promise‹TransactionQueue‹TransferReservationOwnershipProcedureArgs, void››
Defined in src/entities/SecurityTokenReservation.ts:147
Transfer the ownership of the ticker
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹TransferReservationOwnershipProcedureArgs, void››
Static
generateId
Static
generateId▸ generateId(__namedParameters
: object): string
Defined in src/entities/SecurityTokenReservation.ts:44
Generate the Security Token Reservation's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Returns: string
Static
unserialize
Static
unserialize▸ unserialize(serialized
: string): UniqueIdentifiers
Defined in src/entities/SecurityTokenReservation.ts:55
Unserialize string to a Security Token Reservation object representation
Parameters:
Returns: UniqueIdentifiers
Last updated