Checkpoint

Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Checkpoint(params: Params & UniqueIdentifiers): Checkpoint

Defined in src/entities/Checkpoint.ts:106

Create a new Chekpoint instance

Parameters:

Name

Type

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

Defined in src/entities/Checkpoint.ts:83

Methods

_refresh

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

Defined in src/entities/Checkpoint.ts:164

Hydrate the entity

Parameters:

Name

Type

params

Partial‹Params›

Returns: void

toPojo

â–¸ toPojo(): object

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

â–¸ 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

index

number

securityTokenId

string

Returns: string

Static unserialize

â–¸ unserialize(serialized: string): UniqueIdentifiers

Defined in src/entities/Checkpoint.ts:70

Unserialize string to Checkpoint object

Parameters:

Name

Type

serialized

string

Returns: UniqueIdentifiers

Last updated

Was this helpful?