Skip to content

Commit e5d8241

Browse files
committed
simplify response descriptions
1 parent 10c33da commit e5d8241

File tree

11 files changed

+32
-102
lines changed

11 files changed

+32
-102
lines changed

cmd/sim/evm/activity.go

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,9 @@ func NewActivityCmd() *cobra.Command {
2626
" - approve: ERC20/ERC721 spending approvals\n" +
2727
" - call: contract interactions with decoded function name and inputs\n\n" +
2828
"Asset types: native, erc20, erc721, erc1155.\n\n" +
29-
"Response fields per activity item:\n" +
30-
" - chain_id, block_number, block_time, tx_hash: transaction context\n" +
31-
" - type: activity classification (send, receive, swap, etc.)\n" +
32-
" - asset_type: token standard (native, erc20, erc721, erc1155)\n" +
33-
" - value, value_usd: transfer amount and USD value at time of transaction\n" +
34-
" - token_metadata: symbol, decimals, name, logo, price_usd\n" +
35-
" - For swaps: from_token_*, to_token_* fields with both sides of the trade\n" +
36-
" - For calls: function signature, name, and decoded inputs\n\n" +
29+
"Each activity item includes the transaction context, transfer amounts with\n" +
30+
"USD values, and token metadata. Swap entries include both sides of the trade.\n" +
31+
"Call entries include the decoded function name and inputs.\n\n" +
3732
"By default, returns all activity types across all default chains.\n" +
3833
"Run 'dune sim evm supported-chains' to see which chains support activity.\n\n" +
3934
"For raw transaction data (hashes, gas, calldata), use 'dune sim evm transactions'.\n\n" +

cmd/sim/evm/balance.go

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,6 @@ func NewBalanceCmd() *cobra.Command {
2121
"Both --token and --chain-ids are required. Use the literal string 'native'\n" +
2222
"as the --token value to query the chain's native asset (e.g. ETH on Ethereum,\n" +
2323
"MATIC on Polygon), or pass an ERC20 contract address.\n\n" +
24-
"Response fields:\n" +
25-
" - chain, chain_id: network name and numeric ID\n" +
26-
" - address, symbol, name, decimals: token identity\n" +
27-
" - amount: raw balance (divide by 10^decimals for human-readable)\n" +
28-
" - price_usd, value_usd: current pricing and total value\n\n" +
2924
"For multi-token or multi-chain lookups, use 'dune sim evm balances' instead.\n\n" +
3025
"Examples:\n" +
3126
" dune sim evm balance 0xd8da... --token native --chain-ids 1\n" +

cmd/sim/evm/balances.go

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,9 @@ func NewBalancesCmd() *cobra.Command {
1717
Use: "balances <address>",
1818
Short: "Get EVM token balances for a wallet address across multiple chains",
1919
Long: "Return native and ERC20 token balances for the given wallet address across\n" +
20-
"supported EVM chains. Each balance entry includes the token amount, current\n" +
21-
"USD price, and total USD value. Data comes from Dune's real-time index.\n\n" +
22-
"Response fields per balance:\n" +
23-
" - chain, chain_id: network name and numeric ID\n" +
24-
" - address: token contract address (or native asset identifier)\n" +
25-
" - symbol, name, decimals: token identity and precision\n" +
26-
" - amount: raw token balance (divide by 10^decimals for human-readable)\n" +
27-
" - price_usd, value_usd: current token price and total holding value\n" +
28-
" - low_liquidity: true if on-chain liquidity is thin (price may be unreliable)\n" +
29-
" - pool_size: USD liquidity depth of the pricing pool\n\n" +
20+
"supported EVM chains. Each balance entry includes the token identity, raw\n" +
21+
"balance amount, current USD price, total USD value, and liquidity indicators.\n" +
22+
"Data comes from Dune's real-time index.\n\n" +
3023
"By default, queries all chains tagged 'default'. Use --chain-ids to restrict\n" +
3124
"to specific networks. Run 'dune sim evm supported-chains' to see valid IDs.\n\n" +
3225
"For a single-token balance lookup, use 'dune sim evm balance' instead.\n" +

cmd/sim/evm/collectibles.go

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,10 @@ func NewCollectiblesCmd() *cobra.Command {
1616
Use: "collectibles <address>",
1717
Short: "Get NFT collectibles (ERC721/ERC1155) held by a wallet address",
1818
Long: "Return ERC721 and ERC1155 collectibles (NFTs) held by the given wallet\n" +
19-
"address across supported EVM chains. Results include token metadata, images,\n" +
20-
"and acquisition timestamps. Spam filtering is enabled by default to hide\n" +
19+
"address across supported EVM chains. Each entry includes the collection and\n" +
20+
"token identity, image URL, quantity held, acquisition timestamp, and spam\n" +
21+
"classification when requested. Spam filtering is enabled by default to hide\n" +
2122
"airdropped junk NFTs.\n\n" +
22-
"Response fields per collectible:\n" +
23-
" - contract_address: NFT collection contract\n" +
24-
" - token_id: unique token identifier within the collection\n" +
25-
" - token_standard: 'erc721' or 'erc1155'\n" +
26-
" - chain, chain_id: network name and numeric ID\n" +
27-
" - name, symbol, description: collection metadata\n" +
28-
" - image_url: token image (may be IPFS, HTTP, or data URI)\n" +
29-
" - balance: quantity held (always '1' for ERC721, may be >1 for ERC1155)\n" +
30-
" - last_acquired: timestamp of most recent acquisition\n" +
31-
" - is_spam, spam_score: spam classification (visible with --show-spam-scores)\n\n" +
3223
"Spam filtering uses a scoring model based on collection traits (holder count,\n" +
3324
"transfer patterns, metadata quality). Disable with --filter-spam=false to see\n" +
3425
"all NFTs including suspected spam.\n\n" +

cmd/sim/evm/defi_positions.go

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,10 @@ func NewDefiPositionsCmd() *cobra.Command {
3131
" - UniswapV2: AMM liquidity provider positions (Uniswap V2 and forks)\n" +
3232
" - Nft: Uniswap V3 concentrated liquidity positions (NFT-based)\n" +
3333
" - NftV4: Uniswap V4 concentrated liquidity positions (NFT-based)\n\n" +
34-
"Response fields per position:\n" +
35-
" - type: position type discriminator (see above)\n" +
36-
" - chain_id: numeric EVM chain ID\n" +
37-
" - usd_value: total USD value of the position\n" +
38-
" - protocol: protocol name (e.g. 'uniswap_v3', 'aave_v3')\n" +
39-
" - Type-specific fields: token symbols, underlying assets, pool info,\n" +
40-
" calculated balances, tick ranges (for concentrated liquidity)\n\n" +
41-
"Aggregations (in JSON output):\n" +
42-
" - total_usd_value: sum of all position values\n" +
43-
" - total_by_chain: USD value grouped by chain ID\n\n" +
34+
"Each position includes the chain, USD value, protocol name, and type-\n" +
35+
"specific details (token identities, pool info, balances). The response\n" +
36+
"also includes aggregation summaries with total value and per-chain\n" +
37+
"breakdowns. Use -o json for the full structured response.\n\n" +
4438
"Run 'dune sim evm supported-chains' to see which chains support defi-positions.\n\n" +
4539
"Examples:\n" +
4640
" dune sim evm defi-positions 0xd8da6bf26964af9d7eed9e03e53415d37aa96045\n" +

cmd/sim/evm/supported_chains.go

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,11 @@ func NewSupportedChainsCmd() *cobra.Command {
1616
Use: "supported-chains",
1717
Short: "List supported EVM chains and their endpoint availability",
1818
Long: "Display all EVM chains supported by the Sim API along with a capability\n" +
19-
"matrix showing which endpoints are available for each chain.\n\n" +
19+
"matrix showing which endpoints are available for each chain. Each chain\n" +
20+
"entry includes the chain name, numeric ID, tags, and boolean flags\n" +
21+
"indicating which Sim API endpoints are supported.\n\n" +
2022
"This is a public endpoint and does not require a Sim API key.\n\n" +
21-
"Response fields per chain:\n" +
22-
" - name: human-readable chain name (e.g. 'ethereum', 'base', 'arbitrum')\n" +
23-
" - chain_id: numeric EVM chain ID (e.g. 1, 8453, 42161)\n" +
24-
" - tags: grouping labels (e.g. 'default') usable in --chain-ids filters\n" +
25-
" - balances, activity, transactions, token_info, token_holders,\n" +
26-
" collectibles, defi_positions: boolean support flags per endpoint\n\n" +
27-
"Use the chain_id values or tag names from this output as --chain-ids\n" +
23+
"Use the chain IDs or tag names from this output as --chain-ids\n" +
2824
"arguments in other 'dune sim evm' commands.\n\n" +
2925
"Examples:\n" +
3026
" dune sim evm supported-chains\n" +

cmd/sim/evm/token_holders.go

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,9 @@ func NewTokenHoldersCmd() *cobra.Command {
2222
"Both --chain-id (single numeric chain ID) and the token address argument are\n" +
2323
"required. Unlike other sim evm commands that accept --chain-ids (plural),\n" +
2424
"this command uses --chain-id (singular) and queries exactly one chain.\n\n" +
25-
"Response fields per holder:\n" +
26-
" - wallet_address: holder's Ethereum address\n" +
27-
" - balance: raw token balance (divide by 10^decimals for human-readable)\n" +
28-
" - first_acquired: timestamp of the holder's earliest token acquisition\n" +
29-
" - has_initiated_transfer: whether the holder has ever sent tokens (useful\n" +
30-
" for distinguishing active holders from passive recipients/airdrops)\n\n" +
25+
"Each holder entry includes the wallet address, token balance, earliest\n" +
26+
"acquisition timestamp, and whether they have ever initiated an outgoing\n" +
27+
"transfer (useful for distinguishing active holders from airdrop recipients).\n\n" +
3128
"Results are paginated; use --offset with the next_offset value from a\n" +
3229
"previous response to retrieve additional pages.\n\n" +
3330
"Run 'dune sim evm supported-chains' to see which chains support token-holders.\n\n" +

cmd/sim/evm/token_info.go

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,9 @@ func NewTokenInfoCmd() *cobra.Command {
1919
"specified EVM chain. Use the literal string 'native' as the address to query\n" +
2020
"the chain's native asset (e.g. ETH on chain 1, MATIC on chain 137).\n\n" +
2121
"The --chain-ids flag is required and should specify a single chain ID.\n\n" +
22-
"Response fields per token:\n" +
23-
" - chain, chain_id: network name and numeric ID\n" +
24-
" - symbol, name, decimals: token identity and precision\n" +
25-
" - price_usd: current USD price from on-chain DEX liquidity pools\n" +
26-
" - total_supply: total token supply (raw, divide by 10^decimals)\n" +
27-
" - market_cap: estimated market capitalization in USD\n" +
28-
" - logo: URL to the token's icon image\n" +
29-
" - historical_prices: past USD prices at requested hour offsets\n\n" +
22+
"Returns the token identity, current USD price (from on-chain DEX pools),\n" +
23+
"total supply, estimated market cap, and logo. Use --historical-prices to\n" +
24+
"include past USD prices at specified hour offsets.\n\n" +
3025
"This command is useful for looking up token details before querying\n" +
3126
"balances or activity. For wallet-scoped token data, use\n" +
3227
"'dune sim evm balances' or 'dune sim evm balance'.\n\n" +

cmd/sim/evm/transactions.go

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,9 @@ func NewTransactionsCmd() *cobra.Command {
1616
Use: "transactions <address>",
1717
Short: "Get raw EVM transaction history for a wallet address across chains",
1818
Long: "Return raw transaction history for the given wallet address across supported\n" +
19-
"EVM chains. Transactions are returned in reverse-chronological order.\n\n" +
20-
"Response fields per transaction:\n" +
21-
" - chain: network name (e.g. 'ethereum', 'base')\n" +
22-
" - hash: transaction hash\n" +
23-
" - from, to: sender and recipient addresses\n" +
24-
" - value: native currency amount transferred (in wei)\n" +
25-
" - block_number, block_time: block context\n" +
26-
" - gas_price, max_fee_per_gas, max_priority_fee_per_gas: gas parameters\n" +
27-
" - transaction_type: EIP-2718 type (e.g. legacy, EIP-1559)\n" +
28-
" - data: raw calldata hex (available in JSON output)\n\n" +
19+
"EVM chains. Transactions are returned in reverse-chronological order. Each\n" +
20+
"transaction includes the hash, sender/recipient, value, block context, gas\n" +
21+
"parameters, and raw calldata.\n\n" +
2922
"Use --decode with -o json to include ABI-decoded function calls and event\n" +
3023
"logs. Decoded data adds 'decoded' fields with function name and typed inputs,\n" +
3124
"plus 'logs' with decoded event emissions. Note: --decode data is only visible\n" +

cmd/sim/svm/balances.go

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,11 @@ func NewBalancesCmd() *cobra.Command {
1616
Use: "balances <address>",
1717
Short: "Get SPL token balances for an SVM wallet address with USD valuations",
1818
Long: "Return SPL token balances for the given SVM (Solana Virtual Machine) wallet\n" +
19-
"address. Each balance entry includes the token amount, current USD price,\n" +
20-
"and total USD value. Data comes from Dune's real-time index.\n\n" +
19+
"address. Each balance entry includes the token identity, balance (both raw\n" +
20+
"and human-readable), current USD price, total USD value, and liquidity data.\n" +
21+
"Data comes from Dune's real-time index.\n\n" +
2122
"Supported chains: Solana, Eclipse (default: Solana only).\n\n" +
2223
"Note: This endpoint is in beta (served under /beta/svm/balances/*).\n\n" +
23-
"Response fields per balance:\n" +
24-
" - chain: network name ('solana' or 'eclipse')\n" +
25-
" - address: SPL token mint address\n" +
26-
" - amount: raw token balance; balance: human-readable balance\n" +
27-
" - symbol, name: token identity\n" +
28-
" - decimals: token precision\n" +
29-
" - price_usd, value_usd: current pricing and total holding value\n" +
30-
" - liquidity_usd: USD liquidity depth of the pricing pool\n" +
31-
" - program_id: owning program (e.g. SPL Token program)\n" +
32-
" - total_supply: total token supply\n" +
33-
" - mint_authority: address authorized to mint new tokens\n\n" +
3424
"Results are paginated; use --offset with the next_offset value from a\n" +
3525
"previous response to retrieve additional pages.\n\n" +
3626
"Examples:\n" +

0 commit comments

Comments
 (0)