Overview
| Hook | Description |
|---|---|
| AMM Hooks | |
amm.useBurn | Hook for burning liquidity tokens and receiving the underlying token pair |
amm.useLiquidityBalance | Hook for getting the liquidity balance for an address in a specific pool |
amm.useMint | Hook for minting liquidity tokens by providing a token pair |
amm.usePool | Hook for getting the reserves for a liquidity pool |
amm.useRebalanceSwap | Hook for performing a rebalance swap between user and validator tokens |
amm.useWatchBurn | Hook for watching liquidity burn events |
amm.useWatchFeeSwap | Hook for watching fee swap events |
amm.useWatchMint | Hook for watching liquidity mint events |
amm.useWatchRebalanceSwap | Hook for watching rebalance swap events |
| Faucet Hooks | |
faucet.useFund | Hook for funding an account with testnet tokens |
| Fee Hooks | |
fee.useSetUserToken | Hook for setting the user's default fee token preference |
fee.useUserToken | Hook for getting the user's default fee token preference |
fee.useWatchSetUserToken | Hook for watching user token set events |
| Nonce Hooks | |
nonce.useNonce | Hook for getting the nonce for an account and nonce key |
nonce.useNonceKeyCount | Hook for getting the number of active nonce keys for an account |
nonce.useWatchActiveKeyCountChanged | Hook for watching active key count changed events |
nonce.useWatchNonceIncremented | Hook for watching nonce incremented events |
| Policy Hooks | |
policy.useCreate | Hook for creating a new transfer policy for token access control |
policy.useData | Hook for getting the data for a transfer policy, including its type and admin address |
policy.useIsAuthorized | Hook for checking if an address is authorized by a transfer policy |
policy.useModifyBlacklist | Hook for modifying the blacklist for a blacklist-type transfer policy |
policy.useModifyWhitelist | Hook for modifying the whitelist for a whitelist-type transfer policy |
policy.useSetAdmin | Hook for setting the admin for a transfer policy |
policy.useWatchAdminUpdated | Hook for watching policy admin update events |
policy.useWatchBlacklistUpdated | Hook for watching blacklist update events |
policy.useWatchCreate | Hook for watching policy creation events |
policy.useWatchWhitelistUpdated | Hook for watching whitelist update events |
| Reward Hooks | |
reward.useClaim | Hook for claiming accumulated rewards |
reward.useGetTotalPerSecond | Hook for getting the total reward per second rate for all active streams |
reward.useSetRecipient | Hook for setting or changing the reward recipient for a token holder |
reward.useStart | Hook for starting a new reward stream that distributes tokens to opted-in holders |
reward.useUserRewardInfo | Hook for getting reward information for a specific account |
reward.useWatchRewardRecipientSet | Hook for watching reward recipient set events |
reward.useWatchRewardScheduled | Hook for watching reward scheduled events |
| Stablecoin DEX Hooks | |
dex.useBalance | Hook for getting a user's token balance on the Stablecoin DEX |
dex.useBuy | Hook for buying a specific amount of tokens from the Stablecoin DEX orderbook |
dex.useBuyQuote | Hook for getting the quote for buying a specific amount of tokens |
dex.useCancel | Hook for canceling an order from the orderbook |
dex.useCreatePair | Hook for creating a new trading pair on the DEX |
dex.useOrder | Hook for getting an order's details from the orderbook |
dex.usePlace | Hook for placing a limit order on the orderbook |
dex.usePlaceFlip | Hook for placing a flip order that automatically flips when filled |
dex.useTickLevel | Hook for getting the price level information at a specific tick |
dex.useSell | Hook for selling a specific amount of tokens from the Stablecoin DEX orderbook |
dex.useSellQuote | Hook for getting the quote for selling a specific amount of tokens |
dex.useWatchFlipOrderPlaced | Hook for watching flip order placed events |
dex.useWatchOrderCancelled | Hook for watching order cancelled events |
dex.useWatchOrderFilled | Hook for watching order filled events |
dex.useWatchOrderPlaced | Hook for watching order placed events |
dex.useWithdraw | Hook for withdrawing tokens from the DEX to the caller's wallet |
| Token Hooks | |
token.useAllowance | Hook for getting the amount of tokens that a spender is approved to transfer on behalf of an owner |
token.useApprove | Hook for approving a spender to transfer TIP-20 tokens on behalf of the caller |
token.useBalance | Hook for getting the token balance of an address |
token.useBurn | Hook for burning TIP-20 tokens from the caller's balance |
token.useBurnBlocked | Hook for burning TIP-20 tokens from a blocked address |
token.useChangeTransferPolicy | Hook for changing the transfer policy for a TIP-20 token |
token.useCreate | Hook for creating a new TIP-20 token and assigning the admin role to the calling account |
token.useGrantRoles | Hook for granting one or more roles to an address |
token.useHasRole | Hook for checking if an address has a specific role |
token.useMetadata | Hook for getting the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply |
token.useMint | Hook for minting new TIP-20 tokens to a recipient |
token.usePause | Hook for pausing a TIP-20 token, preventing all transfers |
token.useRenounceRoles | Hook for renouncing one or more roles from the caller's address |
token.useRevokeRoles | Hook for revoking one or more roles from an address |
token.useSetRoleAdmin | Hook for setting the admin role for another role |
token.useSetSupplyCap | Hook for setting the supply cap for a TIP-20 token |
token.useTransfer | Hook for transferring TIP-20 tokens from the caller to a recipient |
token.useUnpause | Hook for unpausing a TIP-20 token, allowing transfers to resume |
token.useWatchAdminRole | Hook for watching role admin update events |
token.useWatchApprove | Hook for watching token approval events |
token.useWatchBurn | Hook for watching token burn events |
token.useWatchCreate | Hook for watching new token creation events |
token.useWatchMint | Hook for watching token mint events |
token.useWatchRole | Hook for watching role membership update events |
token.useWatchTransfer | Hook for watching token transfer events |