@xyo-network/xl1-network-model
v1.25.26
Published
XYO Layer One API
Keywords
Readme
@xyo-network/xl1-network-model
XYO Layer One API
Reference
@xyo-network/xl1-network-model
Interfaces
Type Aliases
Variables
- LocalNetworkIconString
- MainNetwork
- SequenceNetwork
- LocalNetwork
- DefaultNetworks
- NetworkBootstrapSchema
- isNetworkBootstrap
- asOptionalNetwork
Functions
References
MainNetworkIconString
Renames and re-exports LocalNetworkIconString
SequenceNetworkIconString
Renames and re-exports LocalNetworkIconString
functions
getNetworkNode
@xyo-network/xl1-network-model
function getNetworkNode(): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;Returns
Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>
getNetworkNodes
@xyo-network/xl1-network-model
function getNetworkNodes(): Map<string, AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;Returns
Map<string, AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>
initNetworkNode
@xyo-network/xl1-network-model
function initNetworkNode(activeNetwork): Promise<AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;Parameters
activeNetwork
Returns
Promise<AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>
interfaces
ChainConnection
@xyo-network/xl1-network-model
Extended by
Properties
chain?
optional chain: ChainId;Chain Identifier - can be a hex (eth contract address) or a string
name
name: string;Name of the chain
url
url: string;Url for accessing the network
ChainForkFields
@xyo-network/xl1-network-model
Extended by
Properties
forkedAtLastBlockNumber?
optional forkedAtLastBlockNumber: string;Block Number at which the chain was forked from
forkedAtLastHash?
optional forkedAtLastHash: string;Hash in the last block the chain was forked from
forkedChainId?
optional forkedChainId: Address;Address of the forked chain
Network
@xyo-network/xl1-network-model
Extends
Properties
chain?
optional chain: ChainId;Chain Identifier - can be a hex (eth contract address) or a string
Inherited from
name
name: string;Name of the chain
Inherited from
url
url: string;Url for accessing the network
Inherited from
forkedAtLastBlockNumber?
optional forkedAtLastBlockNumber: string;Block Number at which the chain was forked from
Inherited from
ChainForkFields.forkedAtLastBlockNumber
forkedAtLastHash?
optional forkedAtLastHash: string;Hash in the last block the chain was forked from
Inherited from
ChainForkFields.forkedAtLastHash
forkedChainId?
optional forkedChainId: Address;Address of the forked chain
Inherited from
description
description: string;Description of the network
Inherited from
explorerUrl?
optional explorerUrl: string;Url for accessing the network explorer
Inherited from
icon?
optional icon: string;string representation of the icon (svg)
Inherited from
id
id: DefaultNetworkIds;Machine-readable identifier
Inherited from
symbol?
optional symbol: string;Symbol of the network
Inherited from
custom
custom: boolean;NetworkBootstrapFields
@xyo-network/xl1-network-model
Note: Optional Properties can be found walking the chain to the genesis block
Extends
Properties
chain?
optional chain: ChainId;Chain Identifier - can be a hex (eth contract address) or a string
Inherited from
name
name: string;Name of the chain
Inherited from
url
url: string;Url for accessing the network
Inherited from
forkedAtLastBlockNumber?
optional forkedAtLastBlockNumber: string;Block Number at which the chain was forked from
Inherited from
ChainForkFields.forkedAtLastBlockNumber
forkedAtLastHash?
optional forkedAtLastHash: string;Hash in the last block the chain was forked from
Inherited from
ChainForkFields.forkedAtLastHash
forkedChainId?
optional forkedChainId: Address;Address of the forked chain
Inherited from
description
description: string;Description of the network
Inherited from
explorerUrl?
optional explorerUrl: string;Url for accessing the network explorer
Inherited from
icon?
optional icon: string;string representation of the icon (svg)
Inherited from
id
id: DefaultNetworkIds;Machine-readable identifier
Inherited from
schema
schema: "network.xyo.network.bootstrap";Inherited from
symbol?
optional symbol: string;Symbol of the network
Inherited from
NetworkFields
@xyo-network/xl1-network-model
Extended by
Properties
description
description: string;Description of the network
explorerUrl?
optional explorerUrl: string;Url for accessing the network explorer
icon?
optional icon: string;string representation of the icon (svg)
id
id: DefaultNetworkIds;Machine-readable identifier
schema
schema: "network.xyo.network.bootstrap";symbol?
optional symbol: string;Symbol of the network
type-aliases
NetworkBootstrap
@xyo-network/xl1-network-model
type NetworkBootstrap = Payload<NetworkBootstrapFields, NetworkBootstrapSchema>;NetworkBootstrapSchema
@xyo-network/xl1-network-model
type NetworkBootstrapSchema = typeof NetworkBootstrapSchema;variables
DefaultNetworks
@xyo-network/xl1-network-model
const DefaultNetworks: NetworkBootstrap[];LocalNetwork
@xyo-network/xl1-network-model
const LocalNetwork: NetworkBootstrap;LocalNetworkIconString
@xyo-network/xl1-network-model
const LocalNetworkIconString: string;MainNetwork
@xyo-network/xl1-network-model
const MainNetwork: NetworkBootstrap;NetworkBootstrapSchema
@xyo-network/xl1-network-model
const NetworkBootstrapSchema: "network.xyo.network.bootstrap";SequenceNetwork
@xyo-network/xl1-network-model
const SequenceNetwork: NetworkBootstrap;asOptionalNetwork
@xyo-network/xl1-network-model
const asOptionalNetwork: (value) => NetworkBootstrap | undefined;Parameters
value
AnyNonPromise
Returns
NetworkBootstrap | undefined
isNetworkBootstrap
@xyo-network/xl1-network-model
const isNetworkBootstrap: (x?) => x is NetworkBootstrap;Parameters
x?
unknown
Returns
x is NetworkBootstrap
Maintainers
License
See the LICENSE file for license details