@mixerx/config
v1.1.0
Published
Validated, immutable MixerX contract and pool configuration for MixerX
Readme
@mixerx/config
Validated, immutable MixerX protocol config for Sepolia and a provisional Ethereum mainnet catalogue.
Supported network ids are exported from SUPPORTED_NET_IDS. Resolve data through
getNetworkConfig(chainId) and getInstancesForNetId(chainId) so unsupported
or prototype-derived keys fail closed. instances and networkConfigByNetId
remain exported for current consumers, but every exported object is frozen.
Mainnet (1) has its own immutable catalogue with provisional address and block values that currently match Sepolia
to allow backend configuration before the new MixerX contracts are deployed, as
agreed for the develop environment. These values do not describe a mainnet
deployment and do not provide on-chain readiness. Replace them with verified
mainnet addresses and deployment blocks when available.
A mainnet fork with chain ID 1 uses this same catalogue. Other chain IDs are
rejected; configure the actual node ID, never disguise mainnet as Sepolia.
Legacy Tornado Cash contracts and event layouts are not part of this catalogue.
The mainnet and Sepolia records are independently defined and maintained. This
package does not read environment variables or load an .env file: callers
select the catalogue explicitly by passing the network ID to the lookup APIs.
Sepolia status
The sepolia_v5.4 catalogue generation configures Sepolia (11155111) with its
deployed pools, router, registries, pool factories, relayer
aggregator, offchain oracle, and FDS token (DSToken).
The Sepolia ENS registry address is a MixerX deployment rather than the canonical Ethereum ENS registry. It is retained because it is the registry used by the deployed Phase 5 contracts.
The current Phase 5 deployment intentionally uses the FDS contract for both the protocol token and wrapped stablecoin roles. Consumers must treat these as roles, not as proof that two independent assets exist. A future deployment that separates the assets must update both addresses and the contract tests together.
The catalogue exposes only the eight fixed-denomination pools currently enabled
in the Sepolia InstanceRegistry. Disabled custom-pool deployments are omitted
until their on-chain registry metadata and state are valid.
Each currency declares assetType as native or erc20. ERC20 currencies also
declare tokenAddress.
Use each currency's denominations array when order matters; JavaScript object-key
ordering is not a protocol ordering guarantee.
Scripts
yarn typecheckyarn buildyarn check:shapeyarn test(build, shape validation and contract/regression tests)
