Fathom Lending Address Book :book:

This repository contains an up-to-date registry of all addresses of the Fathom Lending ecosystem's smart contracts, for its usage in Solidity codebases.

The goal is for Solidity developers to have the most integrated environment possible when they want to develop on top of Fathom Lending Platform, by just importing a package with all the necessary addresses to interact with.

Usage with foundry

With Foundry installed and being in a Git repository:

forge install into-the-fathom/fathom-lending-platform-address-book

Import a pool specific collection of addresses & interfaces:

import {FathomLendingApothem} from "fathom-lending-address-book/FathomLendingApothem.sol";

Included addresses:

// v3 libraries
IPoolAddressesProvider POOL_ADDRESSES_PROVIDER;
IPool POOL;
IPoolConfigurator POOL_CONFIGURATOR;
IFathomOracle ORACLE;
IProtocolDataProvider PROTOCOL_DATA_PROVIDER;
IACLManager ACL_MANAGER;
address ACL_ADMIN;
ICollector COLLECTOR;
address DEFAULT_INCENTIVES_CONTROLLER;
address DEFAULT_FM_TOKEN_IMPL_REV_1;
address DEFAULT_VARIABLE_DEBT_TOKEN_IMPL_REV_1;
address DEFAULT_STABLE_DEBT_TOKEN_IMPL_REV_1;

Usage with node

Install

npm i @into-the-fathom/fathom-lending-address-book

Usage

import * as pools from "@into-the-fathom/fathom-lending-address-book"; // wildcard import
import { FathomLendingApothem } from "@into-the-fathom/fathom-lending-address-book"; // import specific pool

// all variables available on solidity version are available in javascript as well
console.log(FathomLendingApothem.POOL_ADDRESSES_PROVIDER);
// "0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb"

## Running this repository

### Generate files

The library is generated based on the config file located in `scripts/config.ts`. You can regenerate the files by running `yarn start`.

### Dependencies

```sh
forge update

Compilation

forge build

Testing

forge test