Skip to main content
HideMeFactory is the entry point for creating confidential tokens. It deploys HideMeToken contracts, stores metadata on-chain, and provides paginated querying for the frontend token registry. Mainnet address: 0x46E16F6E248dfa735D50345b1d2657C8dBC5d60B

createToken

function createToken(CreateParams calldata p) external returns (address tokenAddr)
Deploy a new HideMeToken and register it in the factory. The caller becomes the token owner and receives the initial supply.

CreateParams

name
string
required
Token name (e.g. "My Private Token").
symbol
string
required
Token symbol (e.g. "MPT").
initialSupply
uint64
required
Initial supply minted to the caller in raw units (6 decimals). Pass 0 to start with no supply.
observers
address[]
required
Compliance addresses that can decrypt any holder’s balance. Can be an empty array.
mintable
bool
required
If true, the owner can call mint() to increase supply later.
burnable
bool
required
If true, any holder can call burn() to destroy their tokens.
maxSupply
uint64
required
Maximum total supply. Pass 0 for unlimited.
description
string
required
Human-readable description stored as metadata.
logoUri
string
required
URI pointing to the token logo image.
website
string
required
Token project website URL.
Returns the address of the newly deployed HideMeToken.

Registry queries

function totalTokens() external view returns (uint256)
function getAllTokens() external view returns (address[] memory)
function getTokensByCreator(address creator) external view returns (address[] memory)
function getTokensPaginated(uint256 offset, uint256 limit) external view returns (TokenInfo[] memory)
Use getTokensPaginated for the frontend registry to avoid loading all tokens in one call.

TokenInfo struct

tokenAddress
address
Deployed token contract address.
name
string
Token name.
symbol
string
Token symbol.
initialSupply
uint64
Initial supply set at creation.
creator
address
Address that called createToken.
createdAt
uint256
Block timestamp of token creation.
mintable
bool
Whether the token owner can mint additional supply.
burnable
bool
Whether holders can burn tokens.
maxSupply
uint64
Maximum supply cap (0 = unlimited).
description
string
Token description metadata.
logoUri
string
Logo URI metadata.
website
string
Website URI metadata.

Events

EventParameters
TokenCreatedcreator, tokenAddress, name, symbol, initialSupply, mintable, burnable

HideMeToken

Reference for the deployed token contract.

Token Registry

How the frontend uses the factory to display and create tokens.

Build docs developers (and LLMs) love