@gala-chain/api ∙ API
API > PostMintLockConfiguration
Class: PostMintLockConfiguration
Contents
- Description
- Extends
- Constructors
- new PostMintLockConfiguration()
- Properties
- expirationModifier
- lockAuthority
- lockName
- lockPercentage
- COMPOSITEKEY_NS
- ID_SPLIT_CHAR
- ID_SUB_SPLIT_CHAR
- MIN_UNICODE_RUNE_VALUE
- Methods
- copy()
- getCompositeKey()
- serialize()
- toPlainObject()
- validate()
- validateOrReject()
- deserialize()
- getCompositeKeyFromParts()
- getStringKeyFromParts()
Description
Configure properties that may be used in conjunction with
a TokenMintConfiguration to lock some percentage of
tokens minted as a post-mint action.
Extends
Constructors
new PostMintLockConfiguration()
new PostMintLockConfiguration():
PostMintLockConfiguration
Inherited from
Properties
expirationModifier
expirationModifier:
number
Description
This value will be used to set the expires property of
the TokenHold property created on the user's balance.
It will be added to the GalaChainContext.txUnixTime value which, at the time of this writing (Oct 2024), is represented in milliseconds.
Example
Source
chain-api/src/types/TokenMintConfiguration.ts:79
lockAuthority
lockAuthority:
UserAlias
Description
This property will be used to create the lockAuthority
property of the TokenHold created on the user's balance.
Source
chain-api/src/types/TokenMintConfiguration.ts:61
lockName
lockName:
string
Description
This property will be used to create the name property
of the TokenHold created on the user's balance.
Source
chain-api/src/types/TokenMintConfiguration.ts:50
lockPercentage
lockPercentage:
number
Description
Set the percentage of tokens that should be locked, post-mint.
Example
Source
chain-api/src/types/TokenMintConfiguration.ts:94
COMPOSITEKEY_NS
staticCOMPOSITEKEY_NS:string="\x00"
Inherited from
Source
chain-api/src/types/ChainObject.ts:45
ID_SPLIT_CHAR
staticID_SPLIT_CHAR:string="$"
Inherited from
Source
chain-api/src/types/ChainObject.ts:48
ID_SUB_SPLIT_CHAR
staticID_SUB_SPLIT_CHAR:string="|"
Inherited from
Source
chain-api/src/types/ChainObject.ts:50
MIN_UNICODE_RUNE_VALUE
staticMIN_UNICODE_RUNE_VALUE:string="\u0000"
Inherited from
ChainObject.MIN_UNICODE_RUNE_VALUE
Source
chain-api/src/types/ChainObject.ts:43
Methods
copy()
copy():
PostMintLockConfiguration
Inherited from
Source
chain-api/src/types/ChainObject.ts:72
getCompositeKey()
getCompositeKey():
string
Inherited from
Source
chain-api/src/types/ChainObject.ts:84
serialize()
serialize():
string
Inherited from
Source
chain-api/src/types/ChainObject.ts:52
toPlainObject()
toPlainObject():
Record\<string,unknown>
Inherited from
Source
chain-api/src/types/ChainObject.ts:68
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/ChainObject.ts:56
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
Source
chain-api/src/types/ChainObject.ts:60
deserialize()
staticdeserialize\<T>(constructor,object):T
Type parameters
▪ T
Parameters
▪ constructor: ClassConstructor\<Inferred\<T, ChainObject>>
▪ object: string | Record\<string, unknown> | Record\<string, unknown>[]
Inherited from
Source
chain-api/src/types/ChainObject.ts:77
getCompositeKeyFromParts()
staticgetCompositeKeyFromParts(indexKey,parts):string
Parameters
▪ indexKey: string
▪ parts: unknown[]
Inherited from
ChainObject.getCompositeKeyFromParts
Source
chain-api/src/types/ChainObject.ts:109
getStringKeyFromParts()
staticgetStringKeyFromParts(parts):string
Parameters
▪ parts: string[]
Inherited from
ChainObject.getStringKeyFromParts