-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.Asset.Checkpoints.Checkpoints
api/entities/Asset/Checkpoints.Checkpoints
Handles all Asset Checkpoints related functionality
-
Namespace
<Asset
>↳
Checkpoints
• schedules: Schedules
api/entities/Asset/Checkpoints/index.ts:29
▸ create(opts?
): Promise
<GenericPolymeshTransaction
<Checkpoint
, Checkpoint
>>
Create a snapshot of Asset Holders and their respective balances at this moment
Note
this method is of type NoArgsProcedureMethod, which means you can call create.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Name | Type |
---|---|
opts? |
ProcedureOpts |
Promise
<GenericPolymeshTransaction
<Checkpoint
, Checkpoint
>>
▸ get(paginationOpts?
): Promise
<ResultSet
<CheckpointWithData
>>
Retrieve all Checkpoints created on this Asset, together with their corresponding creation Date and Total Supply
Note
supports pagination
Name | Type |
---|---|
paginationOpts? |
PaginationOptions |
Promise
<ResultSet
<CheckpointWithData
>>
▸ getOne(args
): Promise
<Checkpoint
>
Retrieve a single Checkpoint for this Asset by its ID
Throws
if there is no Checkpoint with the passed ID
Name | Type |
---|---|
args |
Object |
args.id |
BigNumber |
Promise
<Checkpoint
>
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types