@xyo-network/react-chain-network

@xyo-network/react-chain-network

XYO Layer One React SDK

Reference

@xyo-network/react-chain-network

Interfaces

• NetworkAvatarProps
• NetworkIconProps
• NetworkMenuItemProps
• NetworkStatusAlertProps
• NetworkStatusProps
• ChainNetworkProviderProps

Type Aliases

• ChainNetworkState

Variables

• NetworkAvatar
• ActiveNetworkAvatar
• NetworkIcon
• NetworkMenuItem
• NetworkStatusAlert
• NetworkStatus
• ChainNetworkProvider
• ChainNetworkContext

Functions

• useChainNetwork
• useActiveNetworkCurrentBlock
• useActiveNetworkCurrentBlockInPage
• useActiveNetworkCurrentBlockInWallet
• useActiveNetworkNetwork
• useActiveNetworkRunner
• useViewerInPage
• useViewerInWallet
• usePollNetworkStatus

functions

useActiveNetworkCurrentBlock

@xyo-network/react-chain-network

function useActiveNetworkCurrentBlock(refresh, viewer?): [HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined];

Parameters

refresh

number = 1

viewer?

XyoViewer

Returns

[HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined]

useActiveNetworkCurrentBlockInPage

@xyo-network/react-chain-network

function useActiveNetworkCurrentBlockInPage(refresh): [HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined];

Parameters

refresh

number = 1

Returns

[HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined]

useActiveNetworkCurrentBlockInWallet

@xyo-network/react-chain-network

function useActiveNetworkCurrentBlockInWallet(refresh): [HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined];

Parameters

refresh

number = 1

Returns

[HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined]

useActiveNetworkNetwork

@xyo-network/react-chain-network

function useActiveNetworkNetwork(): SimpleXyoNetwork | undefined;

Returns

SimpleXyoNetwork | undefined

useActiveNetworkRunner

@xyo-network/react-chain-network

function useActiveNetworkRunner(): JsonRpcXyoRunner | undefined;

Returns

JsonRpcXyoRunner | undefined

useChainNetwork

@xyo-network/react-chain-network

function useChainNetwork(required): 
  | Omit<{
  activeNetwork?: NetworkBootstrap;
  chainNetworkError?: Error;
  networks?: NetworkBootstrap[];
  updateActiveNetwork?: (networkId) => void;
}, "provided">
| Omit<NotProvidedContextExState<ChainNetworkState>, "provided">;

Parameters

required

boolean = true

Returns

| Omit<{ activeNetwork?: NetworkBootstrap; chainNetworkError?: Error; networks?: NetworkBootstrap[]; updateActiveNetwork?: (networkId) => void; }, "provided"> | Omit<NotProvidedContextExState<ChainNetworkState>, "provided">

usePollNetworkStatus

@xyo-network/react-chain-network

function usePollNetworkStatus(): readonly [NetworkStatus | undefined, Error | undefined];

Returns

readonly [NetworkStatus | undefined, Error | undefined]

useViewerInPage

@xyo-network/react-chain-network

function useViewerInPage(networkOverride?): XyoViewer | JsonRpcXyoViewer | undefined;

Get the viewer for the active network, first from the wallet or fallback to HTTP RPC

Parameters

networkOverride?

NetworkBootstrap

Returns

XyoViewer | JsonRpcXyoViewer | undefined

• XyoViewer for the active network

  useViewerInWallet

@xyo-network/react-chain-network

function useViewerInWallet(): JsonRpcXyoViewer | undefined;

Get the viewer directly from the active network

Returns

JsonRpcXyoViewer | undefined

• The viewer for the active network

interfaces

ChainNetworkProviderProps

@xyo-network/react-chain-network

Extends

• PropsWithChildren

Properties

getActiveNetwork()?

optional getActiveNetwork: () => Promise<NetworkBootstrap | undefined>;

Returns

Promise<NetworkBootstrap | undefined>

networks?

optional networks: NetworkBootstrap[];

setActiveNetwork()?

optional setActiveNetwork: (networkId) => Promise<NetworkBootstrap>;

Parameters

networkId

DefaultNetworkIds

Returns

Promise<NetworkBootstrap>

NetworkAvatarProps

@xyo-network/react-chain-network

Extends

• AvatarProps

Properties

icon?

optional icon: string;

iconStyles?

optional iconStyles: CSSProperties;

name?

optional name: string;

NetworkIconProps

@xyo-network/react-chain-network

Extends

• DetailedHTMLProps<HtmlHTMLAttributes<HTMLSpanElement>, HTMLSpanElement>

Properties

icon?

optional icon: string;

NetworkMenuItemProps

@xyo-network/react-chain-network

Extends

• MenuItemProps

Properties

active?

optional active: boolean;

network?

optional network: NetworkBootstrap;

updateActiveNetwork()?

optional updateActiveNetwork: (networkId) => void;

Parameters

networkId

DefaultNetworkIds

Returns

void

NetworkStatusAlertProps

@xyo-network/react-chain-network

Extends

• AlertProps

Properties

status?

optional status: NetworkStatus;

NetworkStatusProps

@xyo-network/react-chain-network

Extends

• PropsWithChildren<AlertProps>

type-aliases

ChainNetworkState

@xyo-network/react-chain-network

type ChainNetworkState = ContextExState<{
  activeNetwork?: NetworkBootstrap;
  chainNetworkError?: Error;
  networks?: NetworkBootstrap[];
  updateActiveNetwork?: (networkId) => void;
}>;

variables

ActiveNetworkAvatar

@xyo-network/react-chain-network

const ActiveNetworkAvatar: React.FC<AvatarProps>;

ChainNetworkContext

@xyo-network/react-chain-network

const ChainNetworkContext: Context<
  | object & object
  | never
  | FixedValues<ProvidedContextExState<{
  activeNetwork?: NetworkBootstrap;
  chainNetworkError?: Error;
  networks?: NetworkBootstrap[];
  updateActiveNetwork?: (networkId) => void;
}>, never> & object
  | FixedValues<NotProvidedContextExState<{
  activeNetwork?: NetworkBootstrap;
  chainNetworkError?: Error;
  networks?: NetworkBootstrap[];
  updateActiveNetwork?: (networkId) => void;
}>, never> & object>;

ChainNetworkProvider

@xyo-network/react-chain-network

const ChainNetworkProvider: React.FC<ChainNetworkProviderProps>;

NetworkAvatar

@xyo-network/react-chain-network

const NetworkAvatar: React.FC<NetworkAvatarProps>;

NetworkIcon

@xyo-network/react-chain-network

const NetworkIcon: React.FC<NetworkIconProps>;

NetworkMenuItem

@xyo-network/react-chain-network

const NetworkMenuItem: React.FC<NetworkMenuItemProps>;

NetworkStatus

@xyo-network/react-chain-network

const NetworkStatus: React.FC<NetworkStatusProps>;

NetworkStatusAlert

@xyo-network/react-chain-network

const NetworkStatusAlert: React.FC<NetworkStatusAlertProps>;

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYO