@covalenthq/goldrush-mcp-server

type ToolName = "gas_prices" | "block" | "block_heights" | "log_events_by_address" | "log_events_by_topic" | "resolve_address" | "token_balances" | "historical_token_balances" | "historical_portfolio_value" | "erc20_token_transfers" | "token_holders" | "native_token_balance" | "transaction" | "transaction_summary" | "transactions_for_address" | "transactions_for_block" | "multichain_transactions" | "multichain_balances" | "multichain_address_activity" | "nft_for_address" | "nft_check_ownership" | "nft_check_ownership_token_id" | "bitcoin_hd_wallet_balances" | "bitcoin_transactions" | "bitcoin_non_hd_wallet_balances" | "historical_token_prices" | "pool_spot_prices" | "token_approvals"; export declare const TOOL_DESCRIPTIONS: Record<ToolName, string>; export declare const PARAM_DESCRIPTIONS: { readonly gas_prices: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly eventType: "The desired event type to retrieve gas prices for. Supports `erc20` transfer events, `uniswapv3` swap events and `nativetokens` transfers."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; }; readonly block: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly blockHeight: "The block height or `latest` for the latest block available."; }; readonly block_heights: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly startDate: "The start date in YYYY-MM-DD format."; readonly endDate: "The end date in YYYY-MM-DD format or `latest` for the latest block available."; readonly pageSize: "Number of items per page. Omitting this parameter defaults to 100."; readonly pageNumber: "0-indexed page number to begin pagination."; }; readonly log_events_by_address: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly contractAddress: "The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly startingBlock: "The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`."; readonly endingBlock: "The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`."; readonly pageSize: "Number of items per page. Omitting this parameter defaults to 100."; readonly pageNumber: "0-indexed page number to begin pagination."; }; readonly log_events_by_topic: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly topicHash: "The endpoint will return event logs that contain this topic hash."; readonly startingBlock: "The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`."; readonly endingBlock: "The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`."; readonly secondaryTopics: "Additional topic hash(es) to filter on - padded & unpadded address fields are supported. Separate multiple topics with a comma."; readonly pageSize: "Number of items per page. Omitting this parameter defaults to 100."; readonly pageNumber: "0-indexed page number to begin pagination."; }; readonly resolve_address: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; }; readonly token_balances: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly noSpam: "If `true`, the suspected spam tokens are removed. Supported on all Foundational Chains."; }; readonly historical_token_balances: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly noSpam: "If `true`, the suspected spam tokens are removed. Supported on all Foundational Chains."; readonly blockHeight: "Ending block to define a block range. Omitting this parameter defaults to the latest block height."; readonly date: "Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date."; }; readonly historical_portfolio_value: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly days: "The number of days to return data for. Defaults to 30 days."; }; readonly erc20_token_transfers: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly contractAddress: "The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly startingBlock: "The block height to start from, defaults to `0`."; readonly endingBlock: "The block height to end at, defaults to current block height."; readonly pageSize: "Number of items per page. Omitting this parameter defaults to 100."; readonly pageNumber: "0-indexed page number to begin pagination."; }; readonly token_holders: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly tokenAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly noSnapshot: "Defaults to `false`. Set to `true` to bypass last snapshot and get the latest token holders list."; readonly blockHeight: "Ending block to define a block range. Omitting this parameter defaults to the latest block height."; readonly date: "Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date."; readonly pageSize: "Number of items per page. Note: Currently, only values of `100` and `1000` are supported. Omitting this parameter defaults to 100."; readonly pageNumber: "0-indexed page number to begin pagination."; }; readonly native_token_balance: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly blockHeight: "Ending block to define a block range. Omitting this parameter defaults to the latest block height."; }; readonly transaction: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly txHash: "The transaction hash."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly noLogs: "Omit log events."; readonly withInternal: "Whether to include internal transfers/transactions."; readonly withState: "Whether to include all transaction state changes with before and after values."; readonly withInputData: "Whether to include the transaction's input data such as the Method ID."; }; readonly transaction_summary: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly withGas: "Include gas summary details. Response times may be impacted for wallets with large number of transactions."; readonly withTransferCount: "Represents the total count of ERC-20 token movement events, including `Transfer`, `Deposit` and `Withdraw`. Response times may be impacted for wallets with large number of transactions."; }; readonly transactions_for_address: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly page: "The requested page, 0-indexed."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly noLogs: "Omit log events."; readonly blockSignedAtAsc: "Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order."; }; readonly transactions_for_block: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly blockHeight: "The requested block height."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly noLogs: "Omit log events."; }; readonly multichain_transactions: { readonly chains: "Comma separated list of chain names or IDs to retrieve transactions from. Defaults to all foundational chains."; readonly addresses: "Comma separated list of addresses for which transactions are fetched."; readonly limit: "Number of transactions to return per page, up to the default max of 100 items."; readonly before: "Pagination cursor pointing to fetch transactions before a certain point."; readonly after: "Pagination cursor pointing to fetch transactions after a certain point."; readonly withLogs: "Whether to include raw logs in the response."; readonly withDecodedLogs: "Whether to include decoded logs in the response."; readonly withInternal: "Whether to include internal transfers/transactions."; readonly withState: "Whether to include all transaction state changes with before and after values."; readonly withInputData: "Whether to include the transaction's input data such as the Method ID."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`."; }; readonly multichain_balances: { readonly walletAddress: "The requested address. Domain names (e.g. `demo.eth`) NOT supported."; readonly chains: "Comma separated list of chain names or IDs to retrieve token balances from. Defaults to all foundational chains."; readonly limit: "Number of token balances to return per page, up to the default max of 100 items."; readonly before: "Pagination cursor pointing to fetch token balances before a certain point."; readonly cutoffTimestamp: "UNIX timestamp to retrieve the balance snapshot from the nearest block before the specified cutoff time."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, `GBP`, `BTC` and `ETH`."; }; readonly multichain_address_activity: { readonly walletAddress: "The requested wallet address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly testnets: "Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity."; }; readonly nft_for_address: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly noSpam: "If `true`, the suspected spam tokens are removed. Supported on all Foundational Chains."; readonly noNftAssetMetadata: "If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs."; }; readonly nft_check_ownership: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly collectionContract: "The requested collection address."; readonly traitsFilter: "Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Must be used with \"values-filter\", is case-sensitive, and requires proper URL encoding."; readonly valuesFilter: "Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with \"traits-filter\", is case-sensitive, and requires proper URL encoding."; }; readonly nft_check_ownership_token_id: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly collectionContract: "The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; readonly tokenId: "The requested token ID."; }; readonly bitcoin_hd_wallet_balances: { readonly walletAddress: "The extended public key (xPub/yPub/zPub) of the HD wallet."; readonly quoteCurrency: "The currency to convert the balance to. Supports `USD`, `CAD`, `EUR`, etc."; }; readonly bitcoin_transactions: { readonly address: "The bitcoin address to query."; readonly pageSize: "Number of items per page. Omitting this parameter defaults to 100."; readonly pageNumber: "0-indexed page number to begin pagination."; }; readonly bitcoin_non_hd_wallet_balances: { readonly walletAddress: "The requested bitcoin non-HD address."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; }; readonly historical_token_prices: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; readonly contractAddress: "Contract address for the token. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. Supports multiple contract addresses separated by commas."; readonly from: "The start day of the historical price range (YYYY-MM-DD)."; readonly to: "The end day of the historical price range (YYYY-MM-DD)."; readonly pricesAtAsc: "Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order."; }; readonly pool_spot_prices: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly contractAddress: "The pool contract address."; readonly quoteCurrency: "The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`."; }; readonly token_approvals: { readonly chainName: "The chain name eg: `eth-mainnet`."; readonly walletAddress: "The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."; }; }; export {}; //# sourceMappingURL=generated-descriptions.d.ts.map