Skip to content

Overview

ActionDescription
AMM Actions
amm.burnBurns liquidity tokens and receives the underlying token pair
amm.getLiquidityBalanceGets the liquidity balance for an address in a specific pool
amm.getPoolGets the reserves for a liquidity pool
amm.mintMints liquidity tokens by providing a token pair
amm.rebalanceSwapPerforms a rebalance swap between user and validator tokens
amm.watchBurnWatches for liquidity burn events
amm.watchFeeSwapWatches for fee swap events
amm.watchMintWatches for liquidity mint events
amm.watchRebalanceSwapWatches for rebalance swap events
Faucet Actions
faucet.fundFunds an account with testnet tokens
Fee Actions
fee.getUserTokenGets the user's default fee token preference
fee.setUserTokenSets the user's default fee token preference
fee.watchSetUserTokenWatches for user token set events
Nonce Actions
nonce.getNonceGets the nonce for an account and nonce key
nonce.getNonceKeyCountGets the number of active nonce keys for an account
nonce.watchActiveKeyCountChangedWatches for active key count changed events
nonce.watchNonceIncrementedWatches for nonce incremented events
Policy Actions
policy.createCreates a new transfer policy for token access control
policy.getDataGets the data for a transfer policy, including its type and admin address
policy.isAuthorizedChecks if an address is authorized by a transfer policy
policy.modifyBlacklistModifies the blacklist for a blacklist-type transfer policy
policy.modifyWhitelistModifies the whitelist for a whitelist-type transfer policy
policy.setAdminSets the admin for a transfer policy
policy.watchAdminUpdatedWatches for policy admin update events
policy.watchBlacklistUpdatedWatches for blacklist update events
policy.watchCreateWatches for policy creation events
policy.watchWhitelistUpdatedWatches for whitelist update events
Reward Actions
reward.claimClaims accumulated rewards for the caller
reward.getTotalPerSecondGets the total reward per second rate for all active streams
reward.getUserRewardInfoGets reward information for a specific account
reward.setRecipientSets or changes the reward recipient for a token holder
reward.startStarts a new reward stream that distributes tokens to opted-in holders
reward.watchRewardRecipientSetWatches for reward recipient set events
reward.watchRewardScheduledWatches for reward scheduled events
Stablecoin DEX Actions
dex.buyBuys a specific amount of tokens from the Stablecoin DEX orderbook
dex.cancelCancels an order from the orderbook
dex.createPairCreates a new trading pair on the DEX
dex.getBalanceGets a user's token balance on the Stablecoin DEX
dex.getBuyQuoteGets the quote for buying a specific amount of tokens
dex.getOrderGets an order's details from the orderbook
dex.getTickLevelGets the price level information at a specific tick
dex.getSellQuoteGets the quote for selling a specific amount of tokens
dex.placePlaces a limit order on the orderbook
dex.placeFlipPlaces a flip order that automatically flips when filled
dex.sellSells a specific amount of tokens from the Stablecoin DEX orderbook
dex.watchFlipOrderPlacedWatches for flip order placed events
dex.watchOrderCancelledWatches for order cancelled events
dex.watchOrderFilledWatches for order filled events
dex.watchOrderPlacedWatches for order placed events
dex.withdrawWithdraws tokens from the DEX to the caller's wallet
Token Actions
token.approveApproves a spender to transfer TIP-20 tokens on behalf of the caller
token.burnBurns TIP-20 tokens from the caller's balance
token.burnBlockedBurns TIP-20 tokens from a blocked address
token.changeTransferPolicyChanges the transfer policy for a TIP-20 token
token.createCreates a new TIP-20 token and assigns the admin role to the calling account
token.getAllowanceGets the amount of tokens that a spender is approved to transfer on behalf of an owner
token.getBalanceGets the token balance of an address
token.getMetadataGets the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply
token.grantRolesGrants one or more roles to an address
token.mintMints new TIP-20 tokens to a recipient
token.pausePauses a TIP-20 token, preventing all transfers
token.renounceRolesRenounces one or more roles from the caller's address
token.revokeRolesRevokes one or more roles from an address
token.setRoleAdminSets the admin role for another role
token.setSupplyCapSets the supply cap for a TIP-20 token
token.transferTransfers TIP-20 tokens from the caller to a recipient
token.unpauseUnpauses a TIP-20 token, allowing transfers to resume
token.watchAdminRoleWatches for role admin update events
token.watchApproveWatches for token approval events
token.watchBurnWatches for token burn events
token.watchCreateWatches for new token creation events
token.watchMintWatches for token mint events
token.watchRoleWatches for role membership update events
token.watchTransferWatches for token transfer events