Skip to main content

index/interfaces/GalaChainTokenHold.md

A hold on part of a balance (a lock, or the legacy in-use hold), as GalaChain stores it. quantity is whole tokens as a decimal string; times are epoch milliseconds.

Properties​

PropertyModifierTypeDescription
createdreadonlynumberWhen the hold was placed.
createdByreadonlystringWho placed it.
expiresreadonlynumberWhen it expires; 0 means never.
instanceIdreadonlystringThe token instance held ("0" for a fungible token).
lockAuthorityreadonlystringWho may release it.
name?readonlystringThe hold's name, when it has one.
quantityreadonlystringHow much is held, in whole tokens.
vestingPeriodStart?readonlynumberStart of a vesting period, when the hold is a vesting hold.