Token template — on-chain API reference

Module token_issuance_template::token_issuance_template (sources/token_issuance_template.move), Move 2024. In a generated package the module, struct and package names are replaced (e.g. my_token::mytoken::MYTOKEN).

Types

Type	Abilities	Notes
TOKEN_ISSUANCE_TEMPLATE	drop	One-time witness; the coin type is <PACKAGE_ID>::<module>::TOKEN_ISSUANCE_TEMPLATE

Constants (patch points)

Constant	Template value	Meaning
DECIMALS: u8	9	Decimals (fixed forever after publish)
SYMBOL	b"TEMPLATE_SYMBOL"	Symbol (fixed forever)
NAME	b"TEMPLATE_NAME"	Name (fixed forever)
DESCRIPTION	b"TEMPLATE_DESCRIPTION"	Description (editable with MetadataCap)
ICON_URL	b"TEMPLATE_ICON_URL"	Icon URL (editable with MetadataCap)
INITIAL_SUPPLY: u64	1_000_000_007	Raw units minted to the publisher in init (0 = none)
FIXED_SUPPLY: bool	true	true: the registry takes the TreasuryCap (make_supply_fixed; needs INITIAL_SUPPLY > 0)
FROZEN_METADATA: bool	false	true: init deletes the MetadataCap

The values are deliberately distinct so each occupies its own constant-pool entry and can be patched independently in compiled bytecode.

Functions

Function	Visibility	Behaviour
init(witness, ctx)	module init (runs once at publish)	coin_registry::new_currency_with_otw(witness, DECIMALS, SYMBOL, NAME, DESCRIPTION, ICON_URL) → mints INITIAL_SUPPLY to the sender → FIXED_SUPPLY ? make_supply_fixed : TreasuryCap<T> to the sender → FROZEN_METADATA ? finalize_and_delete_metadata_cap : finalize + MetadataCap<T> to the sender (pending Currency<T> → 0xc)
test_init(ctx)	#[test_only]	Calls init with the witness

No other functions, no abort codes and no events are defined by the template. Supply, metadata and registry operations use framework functions:

Framework call	Requires	Effect
0x2::coin_registry::finalize_registration<T>(registry 0xc, Receiving<Currency<T>>)	anyone	Pending Currency<T> → shared
0x2::coin_registry::set_icon_url<T> / set_description<T>	MetadataCap<T>	Update metadata
0x2::coin::mint<T> / 0x2::coin::burn<T>	TreasuryCap<T>	Change supply
0x2::package::make_immutable(UpgradeCap)	UpgradeCap	Freeze package code

Objects created at publish

Object	Owner after init
Coin<T> of the initial supply (if any)	publisher
TreasuryCap<T>	publisher — not created when the supply is fixed
MetadataCap<T>	publisher — not created when the metadata is frozen
Currency<T> (pending)	coin registry address 0xc until finalize_registration
UpgradeCap	publisher (until burned)

Invariants

• init runs exactly once (one-time witness).
• No authority other than the (at most two) capabilities is created or retained by the package.
• A fixed supply is never mintable: the TreasuryCap is consumed by make_supply_fixed in init.
• init aborts (the publish fails, nothing exists) if the supply is fixed and INITIAL_SUPPLY is 0.
• Name, symbol and decimals are immutable in the registry.

---

Canonical source: @meddleware/token-issuance-template-sui → docs/onchain/api-reference.md — maintained with the Move package; edit it there, not on this site.