@keyringnetwork/contracts-abi

This package provides static contract build artifacts for the Keyring Network across multiple supported blockchains.

Overview

The @keyringnetwork/contracts-abi package contains deployment artifacts for Keyring Network smart contracts deployed on various EVM-compatible blockchains. It provides a simple interface to access contract ABIs, addresses, and other deployment information based on the chain ID.

Installation

# Using npm
npm install @keyringnetwork/contracts-abi

# Using yarn
yarn add @keyringnetwork/contracts-abi

# Using pnpm
pnpm add @keyringnetwork/contracts-abi

Usage

import {
  getKrnDeploymentArtifact,
  getKrnContractAddress,
  SupportedChainIds,
} from '@keyringnetwork/contracts-abi';

// Get deployment artifact for Ethereum Mainnet
const { address, ABI } = getKrnDeploymentArtifact({
  chainId: SupportedChainIds.MAINNET,
});

// Get just the contract address
const address = getKrnContractAddress({
  chainId: SupportedChainIds.MAINNET,
});

Supported Chains

The package supports the following blockchain networks:

EVM

| Network | Chain ID | Enum | | ----------------- | -------- | ----------------------------- | | Ethereum Mainnet | 1 | SupportedChainIds.MAINNET | | OP Mainnet | 10 | SupportedChainIds.OPTIMISM | | Arbitrum One | 42161 | SupportedChainIds.ARBITRUM | | Polygon Mainnet | 137 | SupportedChainIds.POLYGON | | Avalanche C-Chain | 43114 | SupportedChainIds.AVALANCHE | | Base | 8453 | SupportedChainIds.BASE |

EVM Testnets

| Network | Chain ID | Enum | | ------- | -------- | --------------------------- | | Sepolia | 11155111 | SupportedChainIds.SEPOLIA | | Holesky | 17000 | SupportedChainIds.HOLESKY |

Solana

| Network | Chain ID | Enum | | ------- | ---------- | -------------------------- | | Solana | 1915121141 | SupportedChainIds.SOLANA |

Solana specifics

• The Chain ID used for Solana is a custom one and supposed to change in the future, once the CAIP-2 format is adopted.
• IDL and types are generated based on Anchor 0.29.0

Error Handling

• If a chain is not supported, the function will return an empty ABI array and empty address string
• Unsupported chain/environment combinations will return empty values