Checkpoint
Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time
Hierarchy
Entity‹Params›
↳ Checkpoint
Index
Constructors
constructor
Properties
createdAt
dividendDistributions
index
securityTokenId
securityTokenSymbol
tokenholderBalances
totalSupply
uid
Methods
_refresh
toPojo
generateId
unserialize
Constructors
constructor
+ new Checkpoint(params
: Params & UniqueIdentifiers): Checkpoint
Defined in src/entities/Checkpoint.ts:106
Create a new Chekpoint instance
Parameters:
Name | Type |
| Params & UniqueIdentifiers |
Returns: Checkpoint
Properties
createdAt
• createdAt: Date
Defined in src/entities/Checkpoint.ts:106
dividendDistributions
• dividendDistributions: DividendDistribution[]
Defined in src/entities/Checkpoint.ts:88
dividend distributions associated to this snapshot
index
• index: number
Defined in src/entities/Checkpoint.ts:97
numerical index of the checkpoint associated to this snapshot
securityTokenId
• securityTokenId: string
Defined in src/entities/Checkpoint.ts:92
securityTokenSymbol
• securityTokenSymbol: string
Defined in src/entities/Checkpoint.ts:90
tokenholderBalances
• tokenholderBalances: TokenholderBalance[]
Defined in src/entities/Checkpoint.ts:102
tokenholder balances at this specific checkpoint
totalSupply
• totalSupply: BigNumber
Defined in src/entities/Checkpoint.ts:104
uid
• uid: string
Overrides Entity.uid
Defined in src/entities/Checkpoint.ts:83
Methods
_refresh
▸ _refresh(params
: Partial‹Params›): void
Overrides Entity._refresh
Defined in src/entities/Checkpoint.ts:164
Hydrate the entity
Parameters:
Name | Type |
| Partial‹Params› |
Returns: void
toPojo
▸ toPojo(): object
Overrides Entity.toPojo
Defined in src/entities/Checkpoint.ts:137
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
tokenholderBalances: TokenholderBalance[]
totalSupply: BigNumber
uid: string
Static
generateId
Static
generateId▸ generateId(__namedParameters
: object): string
Defined in src/entities/Checkpoint.ts:58
Generate the Checkpoint's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Name | Type |
| number |
| string |
Returns: string
Static
unserialize
Static
unserialize▸ unserialize(serialized
: string): UniqueIdentifiers
Defined in src/entities/Checkpoint.ts:70
Unserialize string to Checkpoint object
Parameters:
Name | Type |
| string |
Returns: UniqueIdentifiers
Last updated