Network
A Network provides access to a chain’s properties and allows for plug-ins to extend functionality.
Constructors
new Network()
new Network(name, chainId): Network
Creates a new Network for name and chainId.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The network name. |
chainId | BigNumberish | The network chain ID. |
Returns
Source
Accessors
chainId
get chainId(): bigint
The network chain ID.
set chainId(value): void
Sets the network chain ID.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | BigNumberish | The new network chain ID. |
Returns
bigint
The network chain ID.
Source
name
get name(): string
The network common name.
This is the canonical name, as networks might have multiple names.
set name(value): void
Sets the network name.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | string | The new network name. |
Returns
string
The network name.
Source
Methods
clone()
clone(): Network
Create a copy of this Network.
Returns
A new Network instance.
Source
toJSON()
toJSON(): any
Returns a JSON-compatible representation of a Network.
Returns
any
The JSON representation of the network.
Source
from()
static from(network?): Network
Returns a new Network for the network name or chainId.
Parameters
| Parameter | Type | Description |
|---|---|---|
network? | Networkish | The network to get. |
Returns
The Network instance.
Throws
If the network is invalid.
Source
register()
static register(nameOrChainId, networkFunc): void
Register nameOrChainId with a function which returns an instance of a Network representing that chain.
Parameters
| Parameter | Type | Description |
|---|---|---|
nameOrChainId | string | number | bigint | The name or chain ID to register. |
networkFunc | () => Network | The function to create the Network. |
Returns
void
Throws
If a network is already registered for nameOrChainId.
Source
Was this page helpful?