Credit Cooperative Address Book

The canonical registry of Credit Cooperative deployed contract addresses, for use in both Solidity and TypeScript/JavaScript projects. It aggregates the per-chain deployment registries that each protocol repo commits under deployments/<chainId>.json (produced by @credit-cooperative/devkit) and republishes them as typed, per-chain libraries.

What's inside

• data/<project>/<chainId>.json — the source registries, mirrored from each protocol repo. This is the input. Everything else is generated from it.
• src/<Project><Chain>.sol — generated Solidity libraries of address constants (e.g. V3ProtocolPaymentRailsSepolia, V3ProtocolPaymentRailsBase).
• ts/index.ts — generated TypeScript twin (chain-keyed address maps + a getAddress helper, no runtime deps).

src/ and ts/ are generated and committed. Do not hand-edit them — run bun run generate. CI fails if they drift from data/.

Usage

Solidity (forge install)

forge install credit-cooperative/address-book

import { V3ProtocolPaymentRailsSepolia } from "address-book/src/V3ProtocolPaymentRailsSepolia.sol";

contract MyContract {
    address node = V3ProtocolPaymentRailsSepolia.NODE;
}

TypeScript (npm)

bun add @credit-cooperative/address-book

import {
  v3ProtocolPaymentRails,
  getAddress,
} from "@credit-cooperative/address-book";

const node = v3ProtocolPaymentRails[11155111].Node;
const cowSwap = getAddress("v3ProtocolPaymentRails", 8453, "CowSwapModule");

How it updates

1. A protocol repo runs just deploy …, which writes/updates its deployments/<chainId>.json, and the change is merged to main.
2. The repo's deployments.yml workflow dispatches a deployments-updated event here.
3. dispatch-receive.yml mirrors the changed files into data/<project>/, regenerates src/ + ts/, and opens a PR.
4. Merging + tagging publishes the npm package and updates the forge install source.

To regenerate locally after editing data/:

bun run generate         # rewrite src/ and ts/
bun run generate:check   # CI guard: fail if committed output is stale
forge test               # sanity + (with --fork-url) on-chain code checks
bun test ts/             # TypeScript consumption tests

Multi-chain note

Addresses are not assumed identical across chains — every entry is keyed by chainId. Always confirm you are reading the library/map for the chain you are deploying against.