> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hamilton.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Contract reference

> The USDh functions and events integrators use, taken from the code live on Ethereum.

**This is the part of the USDh contract that integrators use.** Admin-only functions are listed on [Roles and permissions](https://docs.hamilton.xyz/for-developers/roles.md). The full verified source is on [Etherscan](https://etherscan.io/address/0xbcfc42391e55484129191edfcc766a2c6f9eb503#code).

## Read functions

| Function | Returns |
| - | - |
| `balanceOf(address)` | The address's USDh balance, in base units |
| `totalSupply()` | All USDh in existence |
| `decimals()` | `6` |
| `paused()` | `true` if the whole system is paused |
| `frozen(address)` | `true` if the address is frozen |
| `mintWhitelist(address)` | `true` if the address may mint |
| `redeemWhitelist(address)` | `true` if the address may redeem |
| `supportedStables()` | The stablecoins accepted for minting and redeeming |
| `stableConfig(address)` | Whether a stablecoin is accepted, and its decimals |
| `effectiveRedeemCap(address)` | The address's redemption limit per window. `0` with an override means no limit |
| `redeemedInWindow(address)` | How much the address has redeemed in its current window |
| `redeemWindowStart(address)` | When the address's current window opened |
| `redeemPeriodSeconds()` | The window length, in seconds. `604800` is 7 days |
| `mintCap()` and `mintCapRemaining()` | The 24-hour limit on USDh created against wires, and what is left |
| `totalStableBacking()` | Stablecoins held in the treasury wallet, in USDh units. This is only part of the reserves |
| `treasury()` | The wallet that receives stablecoins when USDh is minted |
| `version()` | The code version |

## Write functions

| Function | Who can call it | What it does |
| - | - | - |
| `transfer`, `approve`, `transferFrom` | Anyone | Standard ERC-20 |
| `permit(...)` | Anyone | Approval by signature (EIP-2612) |
| `transferWithAuthorization(...)` | Anyone | Transfer by signature (EIP-3009) |
| `receiveWithAuthorization(...)` | The receiver | Transfer by signature, submitted by the receiver |
| `cancelAuthorization(...)` | The signer | Cancels an unused authorization |
| `burn(amount)` | Any holder | Destroys the caller's own USDh. Pays nothing out |
| `mintWithStable(stable, amount, to)` | Approved minters | Takes the stablecoin and mints the same amount of USDh to `to` |
| `redeemForStable(stable, amount, to)` | Approved redeemers | Burns the caller's USDh and sends the same amount of the stablecoin to `to` |
| `redeemForFiat(amount)` | Approved redeemers | Burns the caller's USDh. Hamilton then pays US dollars by wire |

## Events

| Event | When |
| - | - |
| `Transfer` | Any transfer, mint or burn |
| `MintedWithStable(user, stable, stableAmount, usdhAmount, to)` | USDh minted against a stablecoin |
| `MintedForFiat(to, amount)` | USDh minted after a wire cleared |
| `RedeemedForStable(user, stable, usdhAmount, stableAmount, to)` | USDh redeemed for a stablecoin |
| `RedeemedForFiat(user, usdhAmount)` | USDh redeemed for a wire |
| `RedeemCapRefreshed(user, newCap)` | An address's redemption limit was recalculated after a mint |
| `AddressFrozen(account, isFrozen)` | An address was frozen or unfrozen |
| `Paused`, `Unpaused` | The whole system was paused or restarted |
| `StableConfigured(stable, supported, decimals)` | A stablecoin was added or switched off |
| `Upgraded(implementation)` | The code behind the proxy was replaced |

On the [timelock](https://etherscan.io/address/0x9461ffd88ec07884338c7a2db648d4d82f0a98d3), watch `CallScheduled`. It means a change to USDh is waiting its 48 hours.

*Last updated: 17 November 2026*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.