Checkpoint
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time
‹›
↳ Checkpoint
Create a new Chekpoint instance
Parameters:
Name
Type
params
• createdAt: Date
dividend distributions associated to this snapshot
• index: number
numerical index of the checkpoint associated to this snapshot
• securityTokenId: string
• securityTokenSymbol: string
tokenholder balances at this specific checkpoint
• totalSupply: BigNumber
• uid: string
Hydrate the entity
Parameters:
Name
Type
params
Returns: void
▸ toPojo(): object
Convert entity to a POJO (Plain Old Javascript Object)
Returns: object
createdAt: Date
dividendDistributions: object[] = dividendDistributions.map(distribution => distribution.toPojo())
index: number
securityTokenId: string
securityTokenSymbol: string
totalSupply: BigNumber
uid: string
Static generateId▸ generateId(__namedParameters: object): string
Generate the Checkpoint's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Name
Type
index
number
securityTokenId
string
Returns: string
Static unserializeUnserialize string to Checkpoint object
Parameters:
Name
Type
serialized
string
+ new Checkpoint(params: & ):
Defined in
&
Returns:
Defined in
• dividendDistributions: []
Defined in
Defined in
Defined in
Defined in
• tokenholderBalances: []
Defined in
Defined in
Overrides .
Defined in
▸ _refresh(params: Partial‹›): void
Overrides .
Defined in
Partial‹›
Overrides .
Defined in
tokenholderBalances: []
Defined in
▸ unserialize(serialized: string):
Defined in
Returns: