@xyo-network/react-chain-provider 1.7.7 → 1.7.8

package/README.md

@@ -8,13 +8,230 @@
 [![npm-license-badge][]](LICENSE)
 [![socket-badge][]][socket-link]
 
-Version: 1.7.3
-
 XYO Layer One API
 
 ## Documentation
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__react-chain-provider)
+## Reference
+
+**@xyo-network/react-chain-provider**
+
+***
+
+## Functions
+
+- [useAddressBalance](#functions/useAddressBalance)
+- [useCurrentBlock](#functions/useCurrentBlock)
+- [useHttpRpcRunner](#functions/useHttpRpcRunner)
+- [useNetwork](#functions/useNetwork)
+- [useSigner](#functions/useSigner)
+- [useHttpRpcViewer](#functions/useHttpRpcViewer)
+- [useViewerFromWallet](#functions/useViewerFromWallet)
+
+### functions
+
+  ### <a id="useAddressBalance"></a>useAddressBalance
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useAddressBalance(
+   address?, 
+   viewer?, 
+   refresh?): object;
+```
+
+## Parameters
+
+### address?
+
+`Lowercase`\<`string`\>
+
+### viewer?
+
+`XyoViewer`
+
+### refresh?
+
+`number`
+
+## Returns
+
+`object`
+
+### address
+
+```ts
+address: undefined | Lowercase<string>;
+```
+
+### balanceForAddress
+
+```ts
+balanceForAddress: undefined | null | AttoXL1 = balancesResult;
+```
+
+### balanceIntlFriendly
+
+```ts
+balanceIntlFriendly: undefined | string;
+```
+
+### shortBalanceIntlFriendly
+
+```ts
+shortBalanceIntlFriendly: undefined | string;
+```
+
+### error
+
+```ts
+error: undefined | Error = balancesError;
+```
+
+### loading
+
+```ts
+loading: boolean;
+```
+
+  ### <a id="useCurrentBlock"></a>useCurrentBlock
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useCurrentBlock(refresh, viewer?): [undefined | HydratedBlock, undefined | Error, undefined | UsePromiseState];
+```
+
+## Parameters
+
+### refresh
+
+`number` = `1`
+
+### viewer?
+
+`XyoViewer`
+
+## Returns
+
+\[`undefined` \| `HydratedBlock`, `undefined` \| `Error`, `undefined` \| `UsePromiseState`\]
+
+  ### <a id="useHttpRpcRunner"></a>useHttpRpcRunner
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useHttpRpcRunner(url?): undefined | JsonRpcXyoRunner;
+```
+
+## Parameters
+
+### url?
+
+`string`
+
+## Returns
+
+`undefined` \| `JsonRpcXyoRunner`
+
+  ### <a id="useHttpRpcViewer"></a>useHttpRpcViewer
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useHttpRpcViewer(url?): undefined | JsonRpcXyoViewer;
+```
+
+## Parameters
+
+### url?
+
+`string`
+
+## Returns
+
+`undefined` \| `JsonRpcXyoViewer`
+
+  ### <a id="useNetwork"></a>useNetwork
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useNetwork(id?): undefined | MemoryXyoNetwork;
+```
+
+## Parameters
+
+### id?
+
+`DefaultNetworkIds`
+
+## Returns
+
+`undefined` \| `MemoryXyoNetwork`
+
+  ### <a id="useSigner"></a>useSigner
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useSigner(_provider?, account?): undefined | XyoSigner;
+```
+
+## Parameters
+
+### \_provider?
+
+`XyoConnectionProvider`
+
+### account?
+
+`AccountInstance`
+
+## Returns
+
+`undefined` \| `XyoSigner`
+
+  ### <a id="useViewerFromWallet"></a>useViewerFromWallet
+
+[**@xyo-network/react-chain-provider**](#../README)
+
+***
+
+```ts
+function useViewerFromWallet(networkId?): undefined | JsonRpcXyoViewer;
+```
+
+Creates a JsonRpcXyoViewer instance based on the provided networkId.
+
+## Parameters
+
+### networkId?
+
+`string`
+
+a network id like 'sequence', 'local', etc.
+
+## Returns
+
+`undefined` \| `JsonRpcXyoViewer`
+
+An instance of JsonRpcXyoViewer if the networkId is found in walletConnections,
+otherwise undefined.
+
 
 ## Maintainers
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/react-chain-provider",
-  "version": "1.7.7",
+  "version": "1.7.8",
   "description": "XYO Layer One API",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -34,13 +34,13 @@
   "module": "dist/browser/index.mjs",
   "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/hex": "^4.13.19",
+    "@xylabs/hex": "^4.13.21",
     "@xylabs/react-promise": "^6.3.13",
-    "@xylabs/typeof": "^4.13.19",
-    "@xyo-network/account-model": "^4.1.4",
-    "@xyo-network/chain-wrappers": "^1.7.7",
+    "@xylabs/typeof": "^4.13.21",
+    "@xyo-network/account-model": "^4.1.5",
+    "@xyo-network/chain-wrappers": "^1.7.8",
     "@xyo-network/xl1-protocol": "^1.7.5",
-    "@xyo-network/xl1-rpc": "^1.7.7",
+    "@xyo-network/xl1-rpc": "^1.7.8",
     "react": "^19.1.0"
   },
   "devDependencies": {
@@ -51,9 +51,9 @@
     "@types/react": "^19.1.8",
     "@xylabs/ts-scripts-yarn3": "^7.0.0",
     "@xylabs/tsconfig-react": "^7.0.0",
-    "@xyo-network/chain-network-model": "^1.7.7",
-    "@xyo-network/react-chain-model": "^1.7.7",
-    "knip": "^5.61.3",
+    "@xyo-network/chain-network-model": "^1.7.8",
+    "@xyo-network/react-chain-model": "^1.7.8",
+    "knip": "^5.62.0",
     "typescript": "^5.8.3"
   },
   "packageManager": "yarn@4.6.0",