@xyo-network/react-chain-network 1.20.15 → 1.20.17

package/README.md

@@ -1,555 +1,24 @@
 # @xyo-network/react-chain-network
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![socket-badge][]][socket-link]
+> XYO Layer One React SDK
 
-XYO Layer One React SDK
+## Install
 
-
-
-## 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?): [HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined];
-```
-
-## Parameters
-
-### refresh
-
-`number` = `1`
-
-### viewer?
-
-`XyoViewer`
-
-## Returns
-
-\[`HydratedBlock`\<`BlockBoundWitness`, `Payload`\> \| `undefined`, `Error` \| `undefined`, `UsePromiseState` \| `undefined`\]
-
-  ### <a id="useActiveNetworkCurrentBlockInPage"></a>useActiveNetworkCurrentBlockInPage
-
-[**@xyo-network/react-chain-network**](#../README)
-
-***
-
-```ts
-function useActiveNetworkCurrentBlockInPage(refresh): [HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined];
-```
-
-## Parameters
-
-### refresh
-
-`number` = `1`
-
-## Returns
-
-\[`HydratedBlock`\<`BlockBoundWitness`, `Payload`\> \| `undefined`, `Error` \| `undefined`, `UsePromiseState` \| `undefined`\]
-
-  ### <a id="useActiveNetworkCurrentBlockInWallet"></a>useActiveNetworkCurrentBlockInWallet
-
-[**@xyo-network/react-chain-network**](#../README)
-
-***
-
-```ts
-function useActiveNetworkCurrentBlockInWallet(refresh): [HydratedBlock<BlockBoundWitness, Payload> | undefined, Error | undefined, UsePromiseState | undefined];
-```
-
-## Parameters
-
-### refresh
-
-`number` = `1`
-
-## Returns
-
-\[`HydratedBlock`\<`BlockBoundWitness`, `Payload`\> \| `undefined`, `Error` \| `undefined`, `UsePromiseState` \| `undefined`\]
-
-  ### <a id="useActiveNetworkNetwork"></a>useActiveNetworkNetwork
-
-[**@xyo-network/react-chain-network**](#../README)
-
-***
-
-```ts
-function useActiveNetworkNetwork(): SimpleXyoNetwork | undefined;
-```
-
-## Returns
-
-`SimpleXyoNetwork` \| `undefined`
-
-  ### <a id="useActiveNetworkRunner"></a>useActiveNetworkRunner
-
-[**@xyo-network/react-chain-network**](#../README)
-
-***
-
-```ts
-function useActiveNetworkRunner(): JsonRpcXyoRunner | undefined;
-```
-
-## Returns
-
-`JsonRpcXyoRunner` \| `undefined`
-
-  ### <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 [NetworkStatus | undefined, Error | undefined];
-```
-
-## Returns
-
-readonly \[`NetworkStatus` \| `undefined`, `Error` \| `undefined`\]
-
-  ### <a id="useViewerInPage"></a>useViewerInPage
-
-[**@xyo-network/react-chain-network**](#../README)
-
-***
-
-```ts
-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
-
-  ### <a id="useViewerInWallet"></a>useViewerInWallet
-
-[**@xyo-network/react-chain-network**](#../README)
-
-***
-
-```ts
-function useViewerInWallet(): JsonRpcXyoViewer | undefined;
-```
-
-Get the viewer directly from the active network
-
-## Returns
-
-`JsonRpcXyoViewer` \| `undefined`
-
-- 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<NetworkBootstrap | undefined>;
-```
-
-### Returns
-
-`Promise`\<`NetworkBootstrap` \| `undefined`\>
-
-***
-
-### 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>;
+```sh
+{{pm}} add {{name}}
 ```
 
-  ### <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
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
-
-## Credits
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
 
 [npm-badge]: https://img.shields.io/npm/v/@xyo-network/react-chain-network.svg
 [npm-link]: https://www.npmjs.com/package/@xyo-network/react-chain-network
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/react-chain-network
-[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/react-chain-network
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/react-chain-network/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/react-chain-network
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/react-chain-network
-[socket-link]: https://socket.dev/npm/package/@xyo-network/react-chain-network
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/react-chain-network.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/dist/browser/context/network/context.d.ts

@@ -1,28 +1,28 @@
 export declare const ChainNetworkContext: import("react").Context<({
-    activeNetwork?: import("@xyo-network/xl1-network-model").NetworkBootstrap;
+    activeNetwork?: import("@xyo-network/xl1-sdk").NetworkBootstrap;
     chainNetworkError?: Error;
     networkSettings: import("./index.ts").ChainNetworkSettings;
-    networks?: import("@xyo-network/xl1-network-model").NetworkBootstrap[];
-    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"]) => void;
-    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
+    networks?: import("@xyo-network/xl1-sdk").NetworkBootstrap[];
+    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"]) => void;
+    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
 } & {
     provided: true;
 }) | (import("@xylabs/react-shared").FixedValues<import("@xylabs/react-shared").ProvidedContextExState<{
-    activeNetwork?: import("@xyo-network/xl1-network-model").NetworkBootstrap;
+    activeNetwork?: import("@xyo-network/xl1-sdk").NetworkBootstrap;
     chainNetworkError?: Error;
     networkSettings: import("./index.ts").ChainNetworkSettings;
-    networks?: import("@xyo-network/xl1-network-model").NetworkBootstrap[];
-    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"]) => void;
-    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
+    networks?: import("@xyo-network/xl1-sdk").NetworkBootstrap[];
+    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"]) => void;
+    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
 }>, never> & {
     provided: false;
 }) | (import("@xylabs/react-shared").FixedValues<import("@xylabs/react-shared").NotProvidedContextExState<{
-    activeNetwork?: import("@xyo-network/xl1-network-model").NetworkBootstrap;
+    activeNetwork?: import("@xyo-network/xl1-sdk").NetworkBootstrap;
     chainNetworkError?: Error;
     networkSettings: import("./index.ts").ChainNetworkSettings;
-    networks?: import("@xyo-network/xl1-network-model").NetworkBootstrap[];
-    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"]) => void;
-    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
+    networks?: import("@xyo-network/xl1-sdk").NetworkBootstrap[];
+    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"]) => void;
+    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
 }>, never> & {
     provided: false;
 })>;

package/dist/browser/context/network/use.d.ts

@@ -1,10 +1,10 @@
 export declare const useChainNetwork: (required?: boolean) => Omit<{
-    activeNetwork?: import("@xyo-network/xl1-network-model").NetworkBootstrap;
+    activeNetwork?: import("@xyo-network/xl1-sdk").NetworkBootstrap;
     chainNetworkError?: Error;
     networkSettings: import("./index.ts").ChainNetworkSettings;
-    networks?: import("@xyo-network/xl1-network-model").NetworkBootstrap[];
-    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"]) => void;
-    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-network-model").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
+    networks?: import("@xyo-network/xl1-sdk").NetworkBootstrap[];
+    updateActiveNetwork?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"]) => void;
+    updateNetworkSettings?: (networkId: import("@xyo-network/xl1-sdk").NetworkBootstrap["id"], settings: import("./index.ts").NetworkSetting) => void;
 } & {
     provided: true;
 }, "provided"> | Omit<import("@xylabs/react-shared").NotProvidedContextExState<import("./state.ts").ChainNetworkState>, "provided">;

package/dist/browser/hooks/provider/useViewerInPage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useViewerInPage.d.ts","sourceRoot":"","sources":["../../../../src/hooks/provider/useViewerInPage.ts"],"names":[],"mappings":"AAeA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,4DAwB3B,CAAA;AACD,gDAAgD;AAChD,eAAO,MAAM,iBAAiB,4DAAkB,CAAA"}
+{"version":3,"file":"useViewerInPage.d.ts","sourceRoot":"","sources":["../../../../src/hooks/provider/useViewerInPage.ts"],"names":[],"mappings":"AAeA;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,4DAuB3B,CAAA;AACD,gDAAgD;AAChD,eAAO,MAAM,iBAAiB,4DAAkB,CAAA"}