Skip to main content
info

For Cadence 0.42 go to Legacy Docs

The FlowToken contract defines the FLOW network token.

Source: FlowToken.cdc

NetworkContract Address
Emulator0x0ae53cb6e3f42a79
Cadence Testing Framework0x0000000000000003
Previewnet0x4445e7ad11568276
Testnet0x7e60df042a9c0868
Mainnet0x1654653399040a61

Transactions

Transactions and scripts for FlowToken are in the flow-core-contracts repo.

As mentioned in the FungibleToken page, developers are encouraged to use the generic token transactions in the flow-ft repo instead.

Events

Flow relies on a set of core contracts that define key portions of the Flow protocol. Those contracts are core contracts and are made to emit the events documented below. You can read about the core contracts here and view their source code and event definitions.

Events emitted from core contracts follow a standard format:


_10
A.{contract address}.{contract name}.{event name}

The components of the format are:

  • contract address - the address of the account the contract has been deployed to
  • contract name - the name of the contract in the source code
  • event name - the name of the event as declared in the source code

Flow Token Contract

Description of events emitted from the FLOW Token contract. The contract defines the fungible FLOW token. Please note that events for the fungible token contracts are the same if deployed to a different account but the contract address is changed to the address of the account the contract has been deployed to.

Tokens Initialized

Event that is emitted when the contract gets created.

  • Event name: TokensInitialized
  • Mainnet event: A.1654653399040a61.FlowToken.TokensInitialized
  • Testnet event: A.7e60df042a9c0868.FlowToken.TokensInitialized

_10
access(all) event TokensInitialized(initialSupply: UFix64)

FieldTypeDescription
initialSupplyUFix64The initial supply of the tokens

Tokens Withdrawn

Event that is emitted when tokens get withdrawn from a Vault.

  • Event name: TokensWithdrawn
  • Mainnet event: A.1654653399040a61.FlowToken.TokensWithdrawn
  • Testnet event: A.7e60df042a9c0868.FlowToken.TokensWithdrawn

_10
access(all) event TokensWithdrawn(amount: UFix64, from: Address?)

FieldTypeDescription
amountUFix64The amount of tokens withdrawn
fromAddress?Optional address of the account that owns the vault where tokens were withdrawn from. nil if the vault is not in an account's storage

Tokens Deposited

Event that is emitted when tokens get deposited to a Vault.

  • Event name: TokensDeposited
  • Mainnet event: A.1654653399040a61.FlowToken.TokensDeposited
  • Testnet event: A.7e60df042a9c0868.FlowToken.TokensDeposited

_10
access(all) event TokensDeposited(amount: UFix64, to: Address?)

FieldTypeDescription
amountUFix64The amount of tokens withdrawn
toAddress?Optional address of the account that owns the vault where tokens were deposited to. nil if the vault is not in an account's storage

Tokens Minted

Event that is emitted when new tokens gets minted.

  • Event name: TokensMinted
  • Mainnet event: A.1654653399040a61.FlowToken.TokensMinted
  • Testnet event: A.7e60df042a9c0868.FlowToken.TokensMinted

_10
access(all) event TokensMinted(amount: UFix64)

FieldTypeDescription
amountUFix64The amount of tokens to mint

Tokens Burned

Event that is emitted when tokens get destroyed.

  • Event name: TokensBurned
  • Mainnet event: A.1654653399040a61.FlowToken.TokensBurned
  • Testnet event: A.7e60df042a9c0868.FlowToken.TokensBurned

_10
access(all) event TokensBurned(amount: UFix64)

FieldTypeDescription
amountUFix64The amount of tokens to burn

Minter Created

Event that is emitted when a new minter resource gets created.

  • Event name: MinterCreated
  • Mainnet event: A.1654653399040a61.FlowToken.MinterCreated
  • Testnet event: A.7e60df042a9c0868.FlowToken.MinterCreated

_10
access(all) event MinterCreated(allowedAmount: UFix64)

FieldTypeDescription
allowedAmountUFix64The amount of tokens that the minter is allowed to mint

Burner Created

Event that is emitted when a new burner Resource gets created.

  • Event name: BurnerCreated
  • Mainnet event: A.1654653399040a61.FlowToken.BurnerCreated
  • Testnet event: A.7e60df042a9c0868.FlowToken.BurnerCreated

_10
access(all) event BurnerCreated()

Staking Events

To learn more about staking events, read staking/events/