FungibleToken
Hierarchy
- TokenContractV2
- FungibleToken
Index
Constructors
externalconstructor
Parameters
externaladdress: PublicKey
externaloptionaltokenId: Field
Returns FungibleToken
Properties
admin
decimals
readonlyevents
Type declaration
BalanceChange: typeof BalanceChangeEvent
Burn: typeof BurnEvent
Mint: typeof MintEvent
Pause: typeof PauseEvent
SetAdmin: typeof SetAdminEvent
paused
staticAdminContract
Type declaration
Parameters
rest...args: any
Returns FungibleTokenAdminBase
Methods
approveBase
Parameters
updates: AccountUpdateForest
Returns Promise<void>
burn
Parameters
from: PublicKey
amount: UInt64
Returns Promise<AccountUpdate>
deploy
Parameters
props: FungibleTokenDeployProps
Returns Promise<void>
publicgetAdminContract
Returns Promise<FungibleTokenAdminBase>
getBalanceOf
Parameters
address: PublicKey
Returns Promise<UInt64>
getCirculating
Reports the current circulating supply This does take into account currently unreduced actions.
Returns Promise<UInt64>
getDecimals
Returns Promise<UInt8>
initialize
Initializes the account for tracking total circulation.
Parameters
admin: PublicKey
decimals: UInt8
startPaused: Bool
Returns Promise<void>
mint
Parameters
recipient: PublicKey
amount: UInt64
Returns Promise<AccountUpdate>
pause
Returns Promise<void>
resume
Returns Promise<void>
setAdmin
Parameters
admin: PublicKey
Returns Promise<void>
transfer
Parameters
from: PublicKey
to: PublicKey
amount: UInt64
Returns Promise<void>
updateVerificationKey
Update the verification key. Note that because we have set the permissions for setting the verification key to
impossibleDuringCurrentVersion()
, this will only be possible in case of a protocol update that requires an update.Parameters
vk: VerificationKey
Returns Promise<void>
Approve
AccountUpdate
s that have been created outside of the token contract.updates - The
AccountUpdate
s to approve. Note that the forest size is limited by the base token contract,TokenContractV2.MAX_ACCOUNT_UPDATES The current limit is 9.