Expand description
§GoldRush SDK
A Rust client library for the GoldRush blockchain data APIs.
§Usage
use goldrush_sdk::{GoldRushClient, ClientConfig, chains};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = GoldRushClient::new("your-api-key", ClientConfig::default())?;
let balances = client
.get_token_balances_for_wallet_address(chains::ethereum::MAINNET, "0x123...", None)
.await?;
println!("{:?}", balances);
Ok(())
}Modules§
- chains
- Chain constants for commonly used networks Chain constants for commonly used blockchain networks in GoldRush API.
Macros§
- trace_
error - Macro for error logging with context.
- trace_
request - Macro for creating instrumented spans with request context.
Structs§
- Balance
Item - Represents a token balance item returned by the API.
- Balances
Data - Container for balance items.
- Balances
Options - Options for customizing balance queries.
- Cache
Config - Cache configuration for different endpoint types.
- Cache
Stats - Cache statistics.
- Circuit
Breaker - Circuit breaker for preventing cascading failures.
- Circuit
Breaker Config - Configuration for the circuit breaker.
- Circuit
Breaker Executor - Wrapper for executing operations through a circuit breaker.
- Circuit
Breaker Stats - Circuit breaker statistics.
- Client
Config - Configuration options for the GoldRush client.
- Endpoint
Stats - Statistics for individual endpoints.
- Gold
Rush Client - The main GoldRush client for interacting with the API.
- Memory
Cache - In-memory cache with TTL and size limits.
- Metrics
Collector - Metrics collector for SDK operations.
- Metrics
Summary - Complete metrics summary.
- NftItem
- Represents an NFT item returned by the API.
- NftMetadata
Item - Represents detailed NFT metadata for a specific token.
- NftOptions
- Options for customizing NFT queries.
- Nfts
Data - Container for NFT items.
- Nfts
Page Iter - Iterator for paginating through NFTs.
- Rate
Limit Config - Rate limiting configuration for API requests.
- Rate
Limiter - Token bucket rate limiter.
- Request
Id - Request correlation ID for tracing requests across the system.
- Sanitizer
- Sanitization utilities for user input.
- Security
Config - Security configuration for the SDK.
- Security
Context - Security context for tracking request security information.
- Security
Manager - Security utilities for the SDK.
- Timer
- Timer utility for measuring operation duration.
- Tracing
Context - Tracing context for SDK operations.
- Transaction
Item - Represents a transaction item returned by the API.
- Transactions
Data - Container for transaction items.
- Transactions
Page Iter - Iterator for paginating through transactions.
- TxOptions
- Options for customizing transaction queries.
- Validator
- Validation utilities for blockchain data.
Enums§
- Circuit
State - Circuit breaker states.
- Error
- Error types that can occur when using the GoldRush SDK.
Type Aliases§
- Balances
Response - Response structure for balance queries.
- NftMetadata
Response - Response structure for NFT metadata queries.
- Nfts
Response - Response structure for NFT queries.
- Result
- Result type alias for GoldRush SDK operations.
- Transaction
Response - Response structure for single transaction queries.
- Transactions
Response - Response structure for transaction list queries.