Contract Discovery

Find any Gearbox contract address programmatically. Never hardcode addresses.

For SDK setup and discovery, see SDK Setup.

AddressProviderV3

The only address you need to hardcode. All other contracts are discoverable from here.

Network	AddressProvider
Mainnet	See Deployment Addresses
Arbitrum	See Deployment Addresses

Basic Usage

import {IAddressProviderV3} from "@gearbox-protocol/core-v3/contracts/interfaces/IAddressProviderV3.sol";

IAddressProviderV3 ap = IAddressProviderV3(ADDRESS_PROVIDER);

// Get ContractsRegister (version 3.00)
address contractsRegister = ap.getAddressOrRevert("CONTRACTS_REGISTER", 3_00);

// Get Price Oracle (version 3.10)
address priceOracle = ap.getAddressOrRevert("PRICE_ORACLE", 3_10);

// Get WETH (no version control)
address weth = ap.getAddressOrRevert("WETH_TOKEN", 0);

Standard Keys

Key	Purpose
CONTRACTS_REGISTER	Registry of pools and credit managers
PRICE_ORACLE	Main price oracle router
PRICE_FEED_STORE	On-demand price feed storage
ACCOUNT_FACTORY	Credit account factory
BOT_LIST	Bot permissions registry
TREASURY	Protocol treasury
WETH_TOKEN	Wrapped ETH address
ACL	Access control list

Version Control

Pass version as the second parameter to getAddressOrRevert():

• 3_00 - V3.0 contracts

• 3_10 - V3.1 contracts

• 0 - No version control (for static addresses like WETH)

uint256 constant NO_VERSION_CONTROL = 0;

ContractsRegister

Enumerates all pools and credit managers in the system.

Get All Pools

import {IContractsRegister} from "@gearbox-protocol/core-v3/contracts/interfaces/IContractsRegister.sol";

IContractsRegister cr = IContractsRegister(contractsRegister);

address[] memory pools = cr.getPools();

Get All Credit Managers

address[] memory creditManagers = cr.getCreditManagers();

Filter by Version

Check contract version to filter V3+ contracts:

import {IVersion} from "@gearbox-protocol/core-v3/contracts/interfaces/base/IVersion.sol";

for (uint256 i = 0; i < pools.length; i++) {
    uint256 version = IVersion(pools[i]).version();
    if (version >= 3_00) {
        // V3.0+ pool
    }
}

From Pool to Credit Suite

Navigate the relationship tree from a pool to its credit infrastructure.

Pool
 +-- poolQuotaKeeper()
      +-- creditManagers via ContractsRegister filter

CreditManager
 +-- creditFacade()
 +-- priceOracle()
 +-- pool()

Get Pool's Quota Keeper

import {IPoolV3} from "@gearbox-protocol/core-v3/contracts/interfaces/IPoolV3.sol";

IPoolV3 pool = IPoolV3(poolAddress);
address quotaKeeper = pool.poolQuotaKeeper();

Get Credit Manager's Facade

import {ICreditManagerV3} from "@gearbox-protocol/core-v3/contracts/interfaces/ICreditManagerV3.sol";

ICreditManagerV3 cm = ICreditManagerV3(creditManagerAddress);
address facade = cm.creditFacade();
address oracle = cm.priceOracle();
address linkedPool = cm.pool();

Complete Discovery Example

Find all USDC lending pools and their credit managers:

function findUSDCMarkets(address addressProvider, address usdc) external view returns (address[] memory) {
    IAddressProviderV3 ap = IAddressProviderV3(addressProvider);
    address cr = ap.getAddressOrRevert("CONTRACTS_REGISTER", 3_00);

    address[] memory allPools = IContractsRegister(cr).getPools();

    uint256 count;
    for (uint256 i = 0; i < allPools.length; i++) {
        if (IPoolV3(allPools[i]).underlyingToken() == usdc) {
            count++;
        }
    }

    address[] memory usdcPools = new address[](count);
    uint256 j;
    for (uint256 i = 0; i < allPools.length; i++) {
        if (IPoolV3(allPools[i]).underlyingToken() == usdc) {
            usdcPools[j++] = allPools[i];
        }
    }

    return usdcPools;
}

MarketCompressor Discovery

For aggregated market data, use MarketCompressor:

import {IMarketCompressor} from "@gearbox-protocol/periphery-v3/contracts/interfaces/IMarketCompressor.sol";
import {MarketData, MarketFilter} from "@gearbox-protocol/periphery-v3/contracts/types/MarketData.sol";

IMarketCompressor compressor = IMarketCompressor(MARKET_COMPRESSOR_ADDRESS);

// Get single market
MarketData memory data = compressor.getMarketData(poolAddress);

// Filter by underlying
MarketFilter memory filter = MarketFilter({
    underlying: usdc,
    configurators: new address[](0)
});
MarketData[] memory usdcMarkets = compressor.getMarkets(filter);

Next Steps

• Credit Operations - Interact with CreditFacade

• Pool Operations - Deposit and withdraw from pools

For architectural background, see Credit Suite Architecture.