@xyo-network/react-chain-network 1.7.7 → 1.7.9

package/README.md

@@ -8,13 +8,516 @@
 [![npm-license-badge][]](LICENSE)
 [![socket-badge][]][socket-link]
 
-Version: 1.7.3
-
 XYO Layer One React SDK
 
 ## Documentation
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__react-chain-network)
+## Reference
+
+**@xyo-network/react-chain-network**
+
+***
+
+## Interfaces
+
+- [NetworkAvatarProps](#interfaces/NetworkAvatarProps)
+- [NetworkIconProps](#interfaces/NetworkIconProps)
+- [NetworkMenuItemProps](#interfaces/NetworkMenuItemProps)
+- [NetworkStatusAlertProps](#interfaces/NetworkStatusAlertProps)
+- [NetworkStatusProps](#interfaces/NetworkStatusProps)
+- [ChainNetworkProviderProps](#interfaces/ChainNetworkProviderProps)
+
+## Type Aliases
+
+- [ChainNetworkState](#type-aliases/ChainNetworkState)
+
+## Variables
+
+- [NetworkAvatar](#variables/NetworkAvatar)
+- [ActiveNetworkAvatar](#variables/ActiveNetworkAvatar)
+- [NetworkIcon](#variables/NetworkIcon)
+- [NetworkMenuItem](#variables/NetworkMenuItem)
+- [NetworkStatusAlert](#variables/NetworkStatusAlert)
+- [NetworkStatus](#variables/NetworkStatus)
+- [ChainNetworkProvider](#variables/ChainNetworkProvider)
+- [ChainNetworkContext](#variables/ChainNetworkContext)
+
+## Functions
+
+- [useChainNetwork](#functions/useChainNetwork)
+- [useActiveNetworkCurrentBlock](#functions/useActiveNetworkCurrentBlock)
+- [useActiveNetworkCurrentBlockInPage](#functions/useActiveNetworkCurrentBlockInPage)
+- [useActiveNetworkCurrentBlockInWallet](#functions/useActiveNetworkCurrentBlockInWallet)
+- [useActiveNetworkNetwork](#functions/useActiveNetworkNetwork)
+- [useActiveNetworkRunner](#functions/useActiveNetworkRunner)
+- [useViewerInPage](#functions/useViewerInPage)
+- [useViewerInWallet](#functions/useViewerInWallet)
+- [usePollNetworkStatus](#functions/usePollNetworkStatus)
+
+### functions
+
+  ### <a id="useActiveNetworkCurrentBlock"></a>useActiveNetworkCurrentBlock
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useActiveNetworkCurrentBlock(refresh, viewer?): [undefined | HydratedBlock<BlockBoundWitness, Payload>, undefined | Error, undefined | UsePromiseState];
+```
+
+## Parameters
+
+### refresh
+
+`number` = `1`
+
+### viewer?
+
+`XyoViewer`
+
+## Returns
+
+\[`undefined` \| `HydratedBlock`\<`BlockBoundWitness`, `Payload`\>, `undefined` \| `Error`, `undefined` \| `UsePromiseState`\]
+
+  ### <a id="useActiveNetworkCurrentBlockInPage"></a>useActiveNetworkCurrentBlockInPage
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useActiveNetworkCurrentBlockInPage(refresh): [undefined | HydratedBlock<BlockBoundWitness, Payload>, undefined | Error, undefined | UsePromiseState];
+```
+
+## Parameters
+
+### refresh
+
+`number` = `1`
+
+## Returns
+
+\[`undefined` \| `HydratedBlock`\<`BlockBoundWitness`, `Payload`\>, `undefined` \| `Error`, `undefined` \| `UsePromiseState`\]
+
+  ### <a id="useActiveNetworkCurrentBlockInWallet"></a>useActiveNetworkCurrentBlockInWallet
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useActiveNetworkCurrentBlockInWallet(refresh): [undefined | HydratedBlock<BlockBoundWitness, Payload>, undefined | Error, undefined | UsePromiseState];
+```
+
+## Parameters
+
+### refresh
+
+`number` = `1`
+
+## Returns
+
+\[`undefined` \| `HydratedBlock`\<`BlockBoundWitness`, `Payload`\>, `undefined` \| `Error`, `undefined` \| `UsePromiseState`\]
+
+  ### <a id="useActiveNetworkNetwork"></a>useActiveNetworkNetwork
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useActiveNetworkNetwork(): undefined | MemoryXyoNetwork;
+```
+
+## Returns
+
+`undefined` \| `MemoryXyoNetwork`
+
+  ### <a id="useActiveNetworkRunner"></a>useActiveNetworkRunner
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useActiveNetworkRunner(): undefined | JsonRpcXyoRunner;
+```
+
+## Returns
+
+`undefined` \| `JsonRpcXyoRunner`
+
+  ### <a id="useChainNetwork"></a>useChainNetwork
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+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`](#../type-aliases/ChainNetworkState)\>, `"provided"`\>
+
+  ### <a id="usePollNetworkStatus"></a>usePollNetworkStatus
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function usePollNetworkStatus(): readonly [undefined | NetworkStatus, undefined | Error];
+```
+
+## Returns
+
+readonly \[`undefined` \| `NetworkStatus`, `undefined` \| `Error`\]
+
+  ### <a id="useViewerInPage"></a>useViewerInPage
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useViewerInPage(): undefined | JsonRpcXyoViewer;
+```
+
+Get the viewer for the active network, first from the wallet or fallback to HTTP RPC
+
+## Returns
+
+`undefined` \| `JsonRpcXyoViewer`
+
+- XyoViewer for the active network
+
+  ### <a id="useViewerInWallet"></a>useViewerInWallet
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+function useViewerInWallet(): undefined | JsonRpcXyoViewer;
+```
+
+Get the viewer directly from the active network
+
+## Returns
+
+`undefined` \| `JsonRpcXyoViewer`
+
+- The viewer for the active network
+
+### interfaces
+
+  ### <a id="ChainNetworkProviderProps"></a>ChainNetworkProviderProps
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+## Extends
+
+- `PropsWithChildren`
+
+## Properties
+
+### getActiveNetwork()?
+
+```ts
+optional getActiveNetwork: () => Promise<undefined | NetworkBootstrap>;
+```
+
+### Returns
+
+`Promise`\<`undefined` \| `NetworkBootstrap`\>
+
+***
+
+### networks?
+
+```ts
+optional networks: NetworkBootstrap[];
+```
+
+***
+
+### setActiveNetwork()?
+
+```ts
+optional setActiveNetwork: (networkId) => Promise<NetworkBootstrap>;
+```
+
+### Parameters
+
+#### networkId
+
+`DefaultNetworkIds`
+
+### Returns
+
+`Promise`\<`NetworkBootstrap`\>
+
+  ### <a id="NetworkAvatarProps"></a>NetworkAvatarProps
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+## Extends
+
+- `AvatarProps`
+
+## Properties
+
+### icon?
+
+```ts
+optional icon: string;
+```
+
+***
+
+### iconStyles?
+
+```ts
+optional iconStyles: CSSProperties;
+```
+
+***
+
+### name?
+
+```ts
+optional name: string;
+```
+
+  ### <a id="NetworkIconProps"></a>NetworkIconProps
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+## Extends
+
+- `DetailedHTMLProps`\<`HtmlHTMLAttributes`\<`HTMLSpanElement`\>, `HTMLSpanElement`\>
+
+## Properties
+
+### icon?
+
+```ts
+optional icon: string;
+```
+
+  ### <a id="NetworkMenuItemProps"></a>NetworkMenuItemProps
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+## Extends
+
+- `MenuItemProps`
+
+## Properties
+
+### active?
+
+```ts
+optional active: boolean;
+```
+
+***
+
+### network?
+
+```ts
+optional network: NetworkBootstrap;
+```
+
+***
+
+### updateActiveNetwork()?
+
+```ts
+optional updateActiveNetwork: (networkId) => void;
+```
+
+### Parameters
+
+#### networkId
+
+`DefaultNetworkIds`
+
+### Returns
+
+`void`
+
+  ### <a id="NetworkStatusAlertProps"></a>NetworkStatusAlertProps
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+## Extends
+
+- `AlertProps`
+
+## Properties
+
+### status?
+
+```ts
+optional status: NetworkStatus;
+```
+
+  ### <a id="NetworkStatusProps"></a>NetworkStatusProps
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+## Extends
+
+- `PropsWithChildren`\<`AlertProps`\>
+
+### type-aliases
+
+  ### <a id="ChainNetworkState"></a>ChainNetworkState
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+type ChainNetworkState = ContextExState<{
+  activeNetwork?: NetworkBootstrap;
+  chainNetworkError?: Error;
+  networks?: NetworkBootstrap[];
+  updateActiveNetwork?: (networkId) => void;
+}>;
+```
+
+### variables
+
+  ### <a id="ActiveNetworkAvatar"></a>ActiveNetworkAvatar
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const ActiveNetworkAvatar: React.FC<AvatarProps>;
+```
+
+  ### <a id="ChainNetworkContext"></a>ChainNetworkContext
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+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>;
+```
+
+  ### <a id="ChainNetworkProvider"></a>ChainNetworkProvider
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const ChainNetworkProvider: React.FC<ChainNetworkProviderProps>;
+```
+
+  ### <a id="NetworkAvatar"></a>NetworkAvatar
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const NetworkAvatar: React.FC<NetworkAvatarProps>;
+```
+
+  ### <a id="NetworkIcon"></a>NetworkIcon
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const NetworkIcon: React.FC<NetworkIconProps>;
+```
+
+  ### <a id="NetworkMenuItem"></a>NetworkMenuItem
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const NetworkMenuItem: React.FC<NetworkMenuItemProps>;
+```
+
+  ### <a id="NetworkStatus"></a>NetworkStatus
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const NetworkStatus: React.FC<NetworkStatusProps>;
+```
+
+  ### <a id="NetworkStatusAlert"></a>NetworkStatusAlert
+
+[**@xyo-network/react-chain-network**](#../README)
+
+***
+
+```ts
+const NetworkStatusAlert: React.FC<NetworkStatusAlertProps>;
+```
+
 
 ## Maintainers
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/react-chain-network",
-  "version": "1.7.7",
+  "version": "1.7.9",
   "description": "XYO Layer One React SDK",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -24,29 +24,36 @@
     ".": {
       "browser": {
         "types": "./dist/browser/index.d.ts",
+        "source": "./src/index.ts",
         "default": "./dist/browser/index.mjs"
       },
       "types": "./dist/browser/index.d.ts",
+      "source": "./src/index.ts",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/browser/index.mjs",
-  "types": "dist/browser/index.d.ts",
+  "module": "./dist/browser/index.mjs",
+  "source": "./src/index.ts",
+  "types": "./dist/browser/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "scripts": {
     "build-storybook": "storybook build",
     "start": "storybook dev -p 6006"
   },
   "dependencies": {
-    "@xylabs/delay": "^4.13.19",
+    "@xylabs/delay": "^4.13.21",
     "@xylabs/react-error": "^6.3.13",
     "@xylabs/react-promise": "^6.3.13",
     "@xylabs/react-shared": "^6.3.13",
-    "@xylabs/typeof": "^4.13.19",
-    "@xyo-network/chain-network-model": "^1.7.7",
-    "@xyo-network/react-chain-provider": "^1.7.7",
-    "@xyo-network/react-chain-shared": "^1.7.7",
-    "@xyo-network/xl1-protocol": "^1.7.5"
+    "@xylabs/typeof": "^4.13.21",
+    "@xyo-network/chain-network-model": "^1.7.9",
+    "@xyo-network/react-chain-provider": "^1.7.9",
+    "@xyo-network/react-chain-shared": "^1.7.9",
+    "@xyo-network/xl1-protocol": "^1.7.10"
   },
   "devDependencies": {
     "@emotion/react": "^11.14.0",
@@ -57,7 +64,7 @@
     "@types/react": "^19.1.8",
     "@xylabs/ts-scripts-yarn3": "^7.0.0",
     "@xylabs/tsconfig-react": "^7.0.0",
-    "knip": "^5.61.3",
+    "knip": "^5.62.0",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "react-router-dom": "^7.7.0",

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: { src: true },
-    node: {},
-    neutral: {},
-  },
-}
-
-export default config