@gala-chain/api • Readme | API
@gala-chain/api / TokenHold
Class: TokenHold
Constructors
new TokenHold(params)
new TokenHold(
params?):TokenHold
Parameters
• params?
• params.created?: number
• params.createdBy?: string
• params.expires?: number
• params.instanceId?: BigNumber
• params.lockAuthority?: string
• params.name?: string
• params.quantity?: BigNumber
Returns
Source
chain-api/src/types/TokenBalance.ts:593
Properties
created
readonlycreated:number
Source
chain-api/src/types/TokenBalance.ts:573
createdBy
readonlycreatedBy:string
Source
chain-api/src/types/TokenBalance.ts:560
expires
readonlyexpires:number
Source
chain-api/src/types/TokenBalance.ts:577
instanceId
readonlyinstanceId:BigNumber
Source
chain-api/src/types/TokenBalance.ts:565
lockAuthority?
optionallockAuthority:string
Source
chain-api/src/types/TokenBalance.ts:591
name?
optionalreadonlyname:string
Source
chain-api/src/types/TokenBalance.ts:581
quantity
readonlyquantity:BigNumber
Source
chain-api/src/types/TokenBalance.ts:569
DEFAULT_EXPIRES
staticreadonlyDEFAULT_EXPIRES:0=0
Source
chain-api/src/types/TokenBalance.ts:557
Methods
isExpired()
isExpired(
currentTime):boolean
Parameters
• currentTime: number
Returns
boolean
Source
chain-api/src/types/TokenBalance.ts:640
matches()
matches(
instanceId,name):boolean
Parameters
• instanceId: BigNumber
• name: undefined | string
Returns
boolean
Source
chain-api/src/types/TokenBalance.ts:636
createValid()
staticcreateValid(params):Promise\<TokenHold>
Parameters
• params
• params.created: number
• params.createdBy: string
• params.expires: undefined | number
• params.instanceId: BigNumber
• params.lockAuthority: undefined | string
• params.name: undefined | string
• params.quantity: BigNumber
Returns
Promise\<TokenHold>
Source
chain-api/src/types/TokenBalance.ts:617
sortByAscendingExpiration()
staticsortByAscendingExpiration(a,b):-1|0|1
Parameters
• a: TokenHold
• b: TokenHold
Returns
-1 | 0 | 1