hoodchain - v0.1.0
    Preparing search index...

    Interface HoodClientConfig

    Configuration for createHoodClient.

    interface HoodClientConfig {
        account?: Account;
        acknowledgeStockTokenEligibility?: boolean;
        chain?: HoodNetwork;
        rpcUrl?: string;
        transport?: Transport;
    }
    Index
    account? acknowledgeStockTokenEligibility? chain? rpcUrl? transport?
    account?: Account

    Wallet account for write operations (swaps, transfers). Create one with privateKeyToAccount(process.env.ROBINHOOD_CHAIN_PRIVATE_KEY) from viem/accounts. Omit for read-only usage.

    acknowledgeStockTokenEligibility?: boolean

    Stock Tokens are tokenized debt securities (issuer: Robinhood Assets (Jersey) Ltd) and may not be offered, sold, or delivered to US persons (additional limits: Canada, UK, Switzerland). Swaps that ACQUIRE a Stock Token throw StockTokenEligibilityError until the operator sets this flag to true, affirming they are eligible. Reads and sells are never gated.

    false

    chain?: HoodNetwork

    Which Robinhood Chain network to target. 'mainnet' = chain 4663, 'testnet' = chain 46630.

    'mainnet'

    rpcUrl?: string

    Custom RPC URL (e.g. an Alchemy endpoint https://robinhood-mainnet.g.alchemy.com/v2/{key}). Defaults to the public RPC from viem's official chain definition.

    transport?: Transport

    Fully custom viem transport. Takes precedence over rpcUrl.

    Settings
    Member Visibility

    On This Page
    Properties