Skip to main content

atomiq-chain-evm/src

@atomiqlabs/chain-evm

@atomiqlabs/chain-evm is the EVM integration package for the Atomiq protocol.

Within the Atomiq stack, this library provides the EVM-side building blocks used for Bitcoin-aware swaps and SPV-backed vault flows on supported EVM-compatible chains. It includes:

  • chain initializers for Atomiq-supported EVM networks
  • the EVMChainInterface used to talk to chain RPCs
  • BTC relay, escrow swap, and SPV vault contract wrappers
  • browser and server-side EVM signer helpers
  • event utilities for tracking swap and vault activity

This package is intended for direct protocol integrations and for higher-level Atomiq SDK layers that need EVM chain support.

Installation​

Install the package with its ethers peer dependency:

npm install @atomiqlabs/chain-evm ethers

Supported Chains​

The package currently exports chain initializers for:

  • Botanix via BotanixInitializer
  • Citrea via CitreaInitializer
  • Alpen via AlpenInitializer
  • GOAT Network via GoatInitializer

Canonical deployments currently defined in this package:

ChainCanonical deployments included
BotanixMAINNET, TESTNET
CitreaMAINNET, TESTNET4
AlpenTESTNET, TESTNET4
GOAT NetworkTESTNET, TESTNET4

For Alpen and GOAT Network, MAINNET chain types exist in the API, but default mainnet contract addresses are not populated in this package yet. In those cases, pass explicit contract addresses if you want to use non-canonical deployments.

SDK Example​

Initialize the atomiq SDK with Citrea network support:

import {CitreaInitializer, CitreaInitializerType} from "@atomiqlabs/chain-evm";
import {BitcoinNetwork, SwapperFactory, TypedSwapper} from "@atomiqlabs/sdk";

//Define chains that you want to support here
const chains = [CitreaInitializer] as const;
type SupportedChains = typeof chains; //It's helpful that we also get the type of the chains array

const Factory = new SwapperFactory<SupportedChains>(chains); //Create swapper factory

const swapper: TypedSwapper<SupportedChains> = Factory.newSwapper({
  chains: {
    CITREA: {
      rpcUrl: citreaRpc, //You can also pass JsonApiProvider object here
    }
  },
  bitcoinNetwork: BitcoinNetwork.MAINNET //or BitcoinNetwork.TESTNET3, BitcoinNetwork.TESTNET4 - this also sets the deployment to use for EVM chains
});

BTC Relay​

Chain Interface​

Events​

Networks/Alpen​

Networks/Botanix​

Networks/Citrea​

Networks/GOAT​

Providers​

Swaps​

Wallets​