README.md

chains config generator

Get chain information for forge/foundry when deploying

chains cli

The chains cli is command line a utility for getting chain information for forge/foundry when deploying.

installing

1. install cli utility

yarn global add @zoralabs/chains
# or
npm install -g @zoralabs/chains

2. setup dotfiles

(see configuration file below)

mkdir ~/.chains/
echo '{"alchemyApiKey": "API_KEY"}' >> ~/.chains/config.json

using

# alias to `forge zora --rpc` which returns `--rpc-url $RPC_URL`
chains zora --rpc

# gets just rpc url eg: (`https://rpc.optimism.io/`)
chains rpc optimism

# opens optimism block explorer in new browser window
chains explorer optimism

Loads private/custom configuration information from ~/.chains/:

Configuration file format and naming:

• $chain_name.json -> {"rpcUrl": "https://alchemyapi.io/y/$alchemyApiKey", "etherscanApiKey": "ETHERSCAN_API_KEY"}
• eg: zora.json -> {"rpcUrl": "https://rpc.zora.energy/"}
• config.json -> {"alchemyApiKey": ""} (infura and tenderly coming soon)

chains npm package

The chains npm package is an importable module that returns chain information for forge/foundry when deploying.

installing

yarn add @zoralabs/chains

# or
npm install @zoralabs/chains

using

import { getChain } from "@zoralabs/chains";

// pass the snake case chain name to the chain getter:
const chain = await getChain("zora-sepolia");

console.log(chain);
// {
//  id: 7777777,
//  rpcUrl: 'https://rpc.zora.energy',
//  blockExplorer: 'https://explorer.zora.energy',
//  etherscanUrl: undefined,
//  verifierUrl: 'https://explorer.zora.energy/api?'
// }