Skip to content

File: src/Xcm/v5/NetworkId/NetworkId.sol

NetworkId

Kind: source

Structs

struct ByForkParams

Parameters for a ByGenesis network ID, containing the genesis block hash.

FieldTypeDescription
blockNumberuint64The block number of the block.
blockHashbytes32The hash of the block.

struct EthereumParams

Parameters for an Ethereum network ID, containing the chain ID.

FieldTypeDescription
chainIduint64The chain ID of an Ethereum network.

struct ByGenesisParams

Parameters for a ByGenesis network ID.

FieldTypeDescription
genesisHashbytes32The 32-byte genesis block hash.

struct NetworkId

Notice A global identifier of a data structure existing within consensus.

FieldTypeDescription
variantenum NetworkIdVariantThe type of network ID, determining how to interpret the payload. See `NetworkIdVariant` enum for possible values.
payloadbytesThe encoded payload containing the network identifier data, whose structure depends on the `variant`.

Enums

enum NetworkIdVariant

Discriminant for the different types of NetworkIds in XCM v5.

VariantDescription
ByGenesisNetwork specified by the first 32 bytes of its genesis block.
ByForkNetwork defined by the first 32-bytes of the hash and number of some block it contains.
PolkadotThe Polkadot Relay Chain.
KusamaThe Kusama Relay Chain.
\_Reserved4Reserved. Do not Use.
\_Reserved5Reserved. Do not Use.
\_Reserved6Reserved. Do not Use.
EthereumAn Ethereum-based network, identified by its chain ID.
BitcoinCoreThe Bitcoin network.
BitcoinCashThe Bitcoin Cash network.
PolkadotBulletinThe Polkadot Bulletin Chain.

Top-Level Functions

  • function byGenesis(struct ByGenesisParams params) internal pure returns (struct NetworkId)
    • Creates a ByGenesis network ID.
  • function byFork(struct ByForkParams params) internal pure returns (struct NetworkId)
    • Creates a ByFork network ID.
  • function polkadot() internal pure returns (struct NetworkId)
    • Creates a Polkadot network ID.
  • function kusama() internal pure returns (struct NetworkId)
    • Creates a Kusama network ID.
  • function ethereum(struct EthereumParams params) internal pure returns (struct NetworkId)
    • Creates an Ethereum network ID.

Created with solidity-doc-generator