Overview
Actions
| Action | Description |
|---|---|
| AMM Actions | |
amm.burn | Burns liquidity tokens and receives the underlying token pair |
amm.getLiquidityBalance | Gets the liquidity balance for an address in a specific pool |
amm.getPool | Gets the reserves for a liquidity pool |
amm.mint | Mints liquidity tokens by providing a token pair |
amm.rebalanceSwap | Performs a rebalance swap between user and validator tokens |
amm.watchBurn | Watches for liquidity burn events |
amm.watchFeeSwap | Watches for fee swap events |
amm.watchMint | Watches for liquidity mint events |
amm.watchRebalanceSwap | Watches for rebalance swap events |
| Faucet Actions | |
faucet.fund | Funds an account with testnet tokens |
| Fee Actions | |
fee.getUserToken | Gets the user's default fee token preference |
fee.setUserToken | Sets the user's default fee token preference |
fee.watchSetUserToken | Watches for user token set events |
| Nonce Actions | |
nonce.getNonce | Gets the nonce for an account and nonce key |
nonce.getNonceKeyCount | Gets the number of active nonce keys for an account |
nonce.watchActiveKeyCountChanged | Watches for active key count changed events |
nonce.watchNonceIncremented | Watches for nonce incremented events |
| Policy Actions | |
policy.create | Creates a new transfer policy for token access control |
policy.getData | Gets the data for a transfer policy, including its type and admin address |
policy.isAuthorized | Checks if an address is authorized by a transfer policy |
policy.modifyBlacklist | Modifies the blacklist for a blacklist-type transfer policy |
policy.modifyWhitelist | Modifies the whitelist for a whitelist-type transfer policy |
policy.setAdmin | Sets the admin for a transfer policy |
policy.watchAdminUpdated | Watches for policy admin update events |
policy.watchBlacklistUpdated | Watches for blacklist update events |
policy.watchCreate | Watches for policy creation events |
policy.watchWhitelistUpdated | Watches for whitelist update events |
| Reward Actions | |
reward.claim | Claims accumulated rewards for the caller |
reward.getTotalPerSecond | Gets the total reward per second rate for all active streams |
reward.getUserRewardInfo | Gets reward information for a specific account |
reward.setRecipient | Sets or changes the reward recipient for a token holder |
reward.start | Starts a new reward stream that distributes tokens to opted-in holders |
reward.watchRewardRecipientSet | Watches for reward recipient set events |
reward.watchRewardScheduled | Watches for reward scheduled events |
| Stablecoin DEX Actions | |
dex.buy | Buys a specific amount of tokens from the Stablecoin DEX orderbook |
dex.cancel | Cancels an order from the orderbook |
dex.createPair | Creates a new trading pair on the DEX |
dex.getBalance | Gets a user's token balance on the Stablecoin DEX |
dex.getBuyQuote | Gets the quote for buying a specific amount of tokens |
dex.getOrder | Gets an order's details from the orderbook |
dex.getTickLevel | Gets the price level information at a specific tick |
dex.getSellQuote | Gets the quote for selling a specific amount of tokens |
dex.place | Places a limit order on the orderbook |
dex.placeFlip | Places a flip order that automatically flips when filled |
dex.sell | Sells a specific amount of tokens from the Stablecoin DEX orderbook |
dex.watchFlipOrderPlaced | Watches for flip order placed events |
dex.watchOrderCancelled | Watches for order cancelled events |
dex.watchOrderFilled | Watches for order filled events |
dex.watchOrderPlaced | Watches for order placed events |
dex.withdraw | Withdraws tokens from the DEX to the caller's wallet |
| Token Actions | |
token.approve | Approves a spender to transfer TIP-20 tokens on behalf of the caller |
token.burn | Burns TIP-20 tokens from the caller's balance |
token.burnBlocked | Burns TIP-20 tokens from a blocked address |
token.changeTransferPolicy | Changes the transfer policy for a TIP-20 token |
token.create | Creates a new TIP-20 token and assigns the admin role to the calling account |
token.getAllowance | Gets the amount of tokens that a spender is approved to transfer on behalf of an owner |
token.getBalance | Gets the token balance of an address |
token.getMetadata | Gets the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply |
token.grantRoles | Grants one or more roles to an address |
token.mint | Mints new TIP-20 tokens to a recipient |
token.pause | Pauses a TIP-20 token, preventing all transfers |
token.renounceRoles | Renounces one or more roles from the caller's address |
token.revokeRoles | Revokes one or more roles from an address |
token.setRoleAdmin | Sets the admin role for another role |
token.setSupplyCap | Sets the supply cap for a TIP-20 token |
token.transfer | Transfers TIP-20 tokens from the caller to a recipient |
token.unpause | Unpauses a TIP-20 token, allowing transfers to resume |
token.watchAdminRole | Watches for role admin update events |
token.watchApprove | Watches for token approval events |
token.watchBurn | Watches for token burn events |
token.watchCreate | Watches for new token creation events |
token.watchMint | Watches for token mint events |
token.watchRole | Watches for role membership update events |
token.watchTransfer | Watches for token transfer events |
Transports
| Transport | Description |
|---|---|
withFeePayer | Creates a transport that routes requests to a fee payer service when a feePayer is requested on an action |