Skip to main content
@tevm/voltaire
@tevm/voltaire / primitives/ChainId

​
primitives/ChainId

​
Type Aliases

​
ChainIdType

ChainIdType = number & object
Defined in: src/primitives/ChainId/ChainIdType.ts:7 Branded ChainId type - prevents chain mixing bugs Wraps a number representing an EIP-155 chain ID

​
Type Declaration

[brand]
readonly [brand]: "ChainId"

​
Variables

​
ARBITRUM

const ARBITRUM: 42161 = 42161
Defined in: src/primitives/ChainId/constants.js:7

​
BASE

const BASE: 8453 = 8453
Defined in: src/primitives/ChainId/constants.js:8

​
ChainId

const ChainId: object
Defined in: src/primitives/ChainId/index.ts:42

​
Type Declaration

equals()
equals: (chainId1, chainId2) => boolean
Parameters
chainId1
number
chainId2
number
Returns
boolean
from()
from: (value) => ChainIdType
Create ChainId from number
Parameters
value
number Chain ID number
Returns
ChainIdType Branded chain ID
Throws
If value is not a non-negative integer
Example
const mainnet = ChainId.from(1);
const sepolia = ChainId.from(11155111);
isMainnet()
isMainnet: (chainId) => boolean
Parameters
chainId
number
Returns
boolean
toNumber()
toNumber: (chainId) => number
Parameters
chainId
number
Returns
number

​
GOERLI

const GOERLI: 5 = 5
Defined in: src/primitives/ChainId/constants.js:3

​
HOLESKY

const HOLESKY: 17000 = 17000
Defined in: src/primitives/ChainId/constants.js:5

​
MAINNET

const MAINNET: 1 = 1
Defined in: src/primitives/ChainId/constants.js:2

​
OPTIMISM

const OPTIMISM: 10 = 10
Defined in: src/primitives/ChainId/constants.js:6

​
POLYGON

const POLYGON: 137 = 137
Defined in: src/primitives/ChainId/constants.js:9

​
SEPOLIA

const SEPOLIA: 11155111 = 11155111
Defined in: src/primitives/ChainId/constants.js:4

​
Functions

​
_equals()

_equals(this, other): boolean
Defined in: src/primitives/ChainId/equals.js:13 Check if two chain IDs are equal

​
Parameters

this
ChainIdType
other
ChainIdType Other chain ID

​
Returns

boolean True if equal

​
Example

const same = ChainId._equals.call(chainId1, chainId2);

​
_isMainnet()

_isMainnet(this): boolean
Defined in: src/primitives/ChainId/isMainnet.js:14 Check if chain ID is Ethereum mainnet

​
Parameters

this
number

​
Returns

boolean True if mainnet

​
Example

const isMain = ChainId._isMainnet.call(chainId);

​
_toNumber()

_toNumber(this): number
Defined in: src/primitives/ChainId/toNumber.js:12 Convert ChainId to number

​
Parameters

this
number

​
Returns

number Number

​
Example

const n = ChainId._toNumber.call(chainId);

​
equals()

equals(chainId1, chainId2): boolean
Defined in: src/primitives/ChainId/index.ts:30

​
Parameters

chainId1
number
chainId2
number

​
Returns

boolean

​
from()

from(value): ChainIdType
Defined in: src/primitives/ChainId/from.js:16 Create ChainId from number

​
Parameters

value
number Chain ID number

​
Returns

ChainIdType Branded chain ID

​
Throws

If value is not a non-negative integer

​
Example

const mainnet = ChainId.from(1);
const sepolia = ChainId.from(11155111);

​
isMainnet()

isMainnet(chainId): boolean
Defined in: src/primitives/ChainId/index.ts:34

​
Parameters

chainId
number

​
Returns

boolean

​
toNumber()

toNumber(chainId): number
Defined in: src/primitives/ChainId/index.ts:26

​
Parameters

chainId
number

​
Returns

number