FungibleTokenAdmin

A contract that grants permissions for administrative actions on a token.

We separate this out into a dedicated contract. That way, when issuing a token, a user can specify their own rules for administrative actions, without changing the token contract itself.

The advantage is that third party applications that only use the token in a non-privileged way can integrate against the unchanged token contract.

Hierarchy

• SmartContract
  • FungibleTokenAdmin

Implements

• FungibleTokenAdminBase

Index

Constructors

• constructor

Methods

• canChangeAdmin
• canMint
• canPause
• canResume
• deploy
• updateVerificationKey

Constructors

externalconstructor

• new FungibleTokenAdmin(address: PublicKey, tokenId?: Field): FungibleTokenAdmin

• Inherited from SmartContract.constructor

  Parameters

  • externaladdress: PublicKey

  • externaloptionaltokenId: Field

  Returns FungibleTokenAdmin

Methods

publiccanChangeAdmin

• canChangeAdmin(_admin: PublicKey): Promise<Bool>

• Implementation of FungibleTokenAdminBase.canChangeAdmin

  Parameters

  • _admin: PublicKey

  Returns Promise<Bool>

publiccanMint

• canMint(_accountUpdate: AccountUpdate): Promise<Bool>

• Implementation of FungibleTokenAdminBase.canMint

  Parameters

  • _accountUpdate: AccountUpdate

  Returns Promise<Bool>

publiccanPause

• canPause(): Promise<Bool>

• Implementation of FungibleTokenAdminBase.canPause

  Returns Promise<Bool>

publiccanResume

• canResume(): Promise<Bool>

• Implementation of FungibleTokenAdminBase.canResume

  Returns Promise<Bool>

deploy

• deploy(props: FungibleTokenAdminDeployProps): Promise<void>

• Implementation of FungibleTokenAdminBase.deploy

  Overrides SmartContract.deploy

  Parameters

  • props: FungibleTokenAdminDeployProps

  Returns Promise<void>

updateVerificationKey

• updateVerificationKey(vk: VerificationKey): Promise<void>

• 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>