SecurityTokenReservation

Class used to manage all the Security Token Reservation functionality

Hierarchy

• Entity‹Params›

  ↳ SecurityTokenReservation

Index

Constructors

• constructor

Properties

• context

• expiry

• ownerAddress

• reservedAt

• securityTokenAddress

• symbol

• uid

Methods

• _refresh

• createSecurityToken

• isLaunched

• toPojo

• transferOwnership

• generateId

• unserialize

Constructors

constructor

+ new SecurityTokenReservation(params: Params & UniqueIdentifiers, context: Context): SecurityTokenReservation

Defined in src/entities/SecurityTokenReservation.ts:92

Create a new SecurityTokenReservation instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers
context	Context

Returns: SecurityTokenReservation

Properties

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

• 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

Overrides Entity.uid

Defined in src/entities/SecurityTokenReservation.ts:68

Methods

_refresh

▸ _refresh(params: Partial‹Params›): void

Overrides Entity._refresh

Defined in src/entities/SecurityTokenReservation.ts:167

Hydrate the entity

Parameters:

Name	Type
params	Partial‹Params›

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

Name	Type
detailsUrl?	undefined | string
divisible	boolean
name	string
treasuryWallet?	undefined | string

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

Overrides Entity.toPojo

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

Name	Type
newOwner	string

Returns: Promise‹TransactionQueue‹TransferReservationOwnershipProcedureArgs, void››

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

Name	Type
symbol	string

Returns: string

Static unserialize

▸ unserialize(serialized: string): UniqueIdentifiers

Defined in src/entities/SecurityTokenReservation.ts:55

Unserialize string to a Security Token Reservation object representation

Parameters:

Name	Type
serialized	string

Returns: UniqueIdentifiers