@xyo-network/react-chain-provider 1.20.14 → 1.20.16

package/src/hooks/useAddressBalance.ts

@@ -1,86 +0,0 @@
-import { usePromise } from '@xylabs/react-promise'
-import type { Address } from '@xylabs/sdk-js'
-import { isUndefined, isUndefinedOrNull } from '@xylabs/sdk-js'
-import type { AttoXL1, XyoViewer } from '@xyo-network/xl1-sdk'
-import { ShiftedBigInt } from '@xyo-network/xl1-sdk'
-import {
-  useMemo, useRef, useState,
-} from 'react'
-
-export const useAddressBalance = (
-  // address to get balance for
-  address?: Address,
-  // viewer to use for fetching balance
-  viewer?: XyoViewer,
-  // refresh balance trigger
-  refresh?: number,
-  // reset balance trigger - clears state immediately
-  reset?: number,
-) => {
-  const [balancesResult, setBalancesResult] = useState<AttoXL1 | null>()
-  const [loading, setLoading] = useState(false)
-  const [balancesError, setBalancesError] = useState<Error>()
-
-  const [previousReset, setPreviousReset] = useState<number | undefined>(reset)
-  if (reset !== previousReset) {
-    setPreviousReset(reset)
-    setBalancesResult(undefined)
-    setBalancesError(undefined)
-    setLoading(false)
-  }
-
-  const balancePromiseRef = useRef<Promise<AttoXL1> | null>(null)
-  usePromise(async () => {
-    if (isUndefined(viewer) || isUndefined(address)) return
-
-    setLoading(true)
-    setBalancesError(undefined)
-
-    // Create and store the current promise
-    const currentPromise = viewer.account.balance.accountBalance(address) as Promise<AttoXL1>
-    balancePromiseRef.current = currentPromise
-
-    try {
-      const result = await currentPromise
-      // Only update state if this is still the latest promise
-      if (balancePromiseRef.current === currentPromise) {
-        setBalancesResult(result as AttoXL1)
-        setLoading(false)
-      }
-    } catch (err) {
-      // Only update state if this is still the latest promise
-      if (balancePromiseRef.current === currentPromise) {
-        console.error('Error in queued call:', err)
-        setBalancesResult(undefined)
-        setBalancesError(err as Error)
-        setLoading(false)
-      }
-    }
-  }, [address, viewer, refresh])
-
-  const shiftedBigInt = useMemo(() => {
-    if (typeof balancesResult !== 'bigint') return
-    return new ShiftedBigInt(balancesResult, {
-      places: 18, maxDecimal: 18, maxCharacters: 9, minDecimals: 1, locale: navigator.language,
-    })
-  }, [balancesResult])
-
-  const balanceIntlFriendly = useMemo(() => {
-    return shiftedBigInt?.toFullString()
-  }, [shiftedBigInt])
-
-  const shortBalanceIntlFriendly = useMemo(() => {
-    return isUndefinedOrNull(balancesResult)
-      ? undefined
-      : (balancesResult < 1_000_000_000_000n && balancesResult > 0n) ? '<0.00001' : shiftedBigInt?.toShortString()
-  }, [balancesResult, shiftedBigInt])
-
-  return {
-    address,
-    balanceForAddress: balancesResult,
-    balanceIntlFriendly,
-    shortBalanceIntlFriendly,
-    error: balancesError,
-    loading,
-  }
-}

package/src/hooks/useConfirmTransactionBase.ts

@@ -1,64 +0,0 @@
-import { usePromise } from '@xylabs/react-promise'
-import type { Hash } from '@xylabs/sdk-js'
-import {
-  forget, isDefined, isHash,
-} from '@xylabs/sdk-js'
-import { PayloadBuilder } from '@xyo-network/sdk-js'
-import type {
-  SignedHydratedTransaction, XyoRunner, XyoViewer,
-} from '@xyo-network/xl1-sdk'
-import { useEffect, useState } from 'react'
-
-import type { ConfirmationStatusUpdate, TransactionConfirmationParams } from './helpers/index.ts'
-import { TransactionConfirmationStatus } from './helpers/index.ts'
-
-export const useConfirmTransactionBase = (
-  // The transaction to confirm
-  transaction?: SignedHydratedTransaction,
-  // Callback for when the transaction is broadcast to the network
-  onBroadcast?: (hash: Hash) => void,
-  // Optional callback for status updates during confirmation
-  onStatusUpdate?: TransactionConfirmationParams['onStatusUpdate'],
-  // Runner to use for broadcasting transactions
-  runner?: XyoRunner,
-  // Viewer to use for checking transaction status
-  viewer?: XyoViewer,
-) => {
-  const [status, setStatus] = useState<ConfirmationStatusUpdate>()
-  const onStatusUpdateLocal = (newStatus: ConfirmationStatusUpdate) => {
-    setStatus(newStatus)
-    onStatusUpdate?.(newStatus)
-  }
-
-  const [transactionConfirmationStatus, transactionConfirmationError] = usePromise(async () => {
-    const hasRunner = isDefined(runner)
-    if (transaction && viewer) {
-      const hash = hasRunner ? (await runner.broadcastTransaction(transaction)) : await PayloadBuilder.hash(transaction[0])
-      if (isHash(hash)) {
-        if (hasRunner && isDefined(onBroadcast)) onBroadcast(hash)
-        const params: TransactionConfirmationParams = {
-          onStatusUpdate: onStatusUpdateLocal,
-          transaction,
-          txHash: hash,
-          viewer,
-        }
-        const instance = await TransactionConfirmationStatus.create(params)
-        await instance.start()
-        return instance
-      } else {
-        throw new Error('unexpected return type from broadcast transaction')
-      }
-    }
-  }, [transaction, runner, viewer])
-
-  useEffect(() => {
-    return () => {
-      if (transactionConfirmationStatus) {
-        // Stop the transaction confirmation status instance when the component unmounts
-        forget(transactionConfirmationStatus.stop())
-      }
-    }
-  }, [transactionConfirmationStatus])
-
-  return { status, transactionConfirmationError }
-}

package/src/hooks/useConnectAccount.ts

@@ -1,36 +0,0 @@
-import { type Address, asAddress } from '@xylabs/sdk-js'
-import { assertEx } from '@xylabs/sdk-js'
-import type { GatewayName } from '@xyo-network/xl1-sdk'
-import { MainNetwork } from '@xyo-network/xl1-sdk'
-import { useCallback, useState } from 'react'
-
-import { useAccountPermissions, useGatewayFromWallet } from './client/index.ts'
-
-export const useConnectAccount = (gatewayName: GatewayName = MainNetwork.id, timeout?: number) => {
-  const [connectError, setConnectError] = useState<Error>()
-
-  const {
-    gateway, error, timedout,
-  } = useGatewayFromWallet(gatewayName, timeout)
-
-  const [accountPermissions, accountPermissionsError] = useAccountPermissions()
-
-  const [address, setAddress] = useState<Address>()
-
-  const connectSigner = useCallback(async () => {
-    try {
-      setConnectError(undefined)
-      const assertedGateway = assertEx(gateway, () => `Gateway ${gatewayName} is not available`)
-      const signer = assertedGateway.signer
-      const address = await signer.address()
-      setAddress(address)
-      return address
-    } catch (e) {
-      setConnectError(e as Error)
-    }
-  }, [gateway, gatewayName])
-
-  return {
-    address: asAddress(accountPermissions?.[0] ?? address), connectSigner, error: error ?? accountPermissionsError ?? connectError, gateway, timedout,
-  }
-}

package/src/hooks/useCurrentBlock.ts

@@ -1,27 +0,0 @@
-import type { UsePromiseState } from '@xylabs/react-promise'
-import { usePromise } from '@xylabs/react-promise'
-import { isDefinedNotNull } from '@xylabs/sdk-js'
-import type { HydratedBlockWithHashMeta, XyoViewer } from '@xyo-network/xl1-sdk'
-
-import { useViewerFromGateway } from './gateway/index.ts'
-
-/* @deprecated - use useCurrentBlockFromGateway instead */
-export const useCurrentBlock = (refresh = 1, viewer?: XyoViewer | null): [HydratedBlockWithHashMeta | undefined,
-  Error | undefined, UsePromiseState | undefined] => {
-  return usePromise(async () => {
-    if (isDefinedNotNull(viewer) && refresh > 0) {
-      const block = await viewer.currentBlock()
-      return block
-    }
-  }, [viewer, refresh])
-}
-
-export const useCurrentBlockFromGateway = (refresh = 1) => {
-  const viewer = useViewerFromGateway()
-  return usePromise(async () => {
-    if (isDefinedNotNull(viewer) && refresh > 0) {
-      const block = await viewer.currentBlock()
-      return block
-    }
-  }, [viewer, refresh])
-}

package/src/hooks/useNetwork.ts

@@ -1,13 +0,0 @@
-import { isUndefined } from '@xylabs/sdk-js'
-import type { DefaultNetworkIds } from '@xyo-network/xl1-sdk'
-import { SimpleXyoNetwork } from '@xyo-network/xl1-sdk'
-import { useMemo } from 'react'
-
-export const useNetwork = (id?: DefaultNetworkIds) => {
-  const network = useMemo(() => {
-    if (isUndefined(id)) return
-    return new SimpleXyoNetwork(id)
-  }, [id])
-
-  return network
-}

package/src/hooks/useSigner.ts

@@ -1,9 +0,0 @@
-import { usePromise } from '@xylabs/react-promise'
-import type { AccountInstance } from '@xyo-network/sdk-js'
-import {
-  SimpleXyoSigner, type XyoConnection, type XyoSigner,
-} from '@xyo-network/xl1-sdk'
-
-export const useSigner = (_provider?: XyoConnection, account?: AccountInstance) => {
-  return usePromise<XyoSigner | undefined>(async () => account ? await SimpleXyoSigner.create({ account }) : undefined, [account])
-}

package/src/hooks/viewer/UseStepRewardWeightTest.stories.tsx

@@ -1,87 +0,0 @@
-import {
-  Alert,
-  Stack,
-} from '@mui/material'
-import type { Meta, StoryFn } from '@storybook/react-vite'
-import { ButtonEx } from '@xylabs/react-button'
-import {
-  isDefined, isDefinedNotNull, isUndefined,
-} from '@xylabs/sdk-js'
-import {
-  asXL1BlockNumber,
-  XL1Amount, XL1Places,
-} from '@xyo-network/xl1-sdk'
-import React, { useState } from 'react'
-
-import { LocalGatewayDecorator } from '../../story/index.ts'
-import { useViewerFromGateway } from '../gateway/index.ts'
-
-const STUB_BLOCK = asXL1BlockNumber(92_444, true)
-const STUB_STEP = 3
-const STUB_POSITION = 3
-
-const wallet = globalThis.xyo?.client !== undefined
-const inIframe = globalThis.self !== window.top
-
-const UseStepRewardWeightTest: React.FC = () => {
-  const viewer = useViewerFromGateway()
-  const [error, setError] = useState<Error | null>(null)
-  const [result, setResult] = useState<number | null | undefined>()
-  const [loading, setLoading] = useState(false)
-
-  const handleClick = async () => {
-    if (isDefinedNotNull(viewer)) {
-      try {
-        setLoading(true)
-        const weight = await viewer.networkStakeStepRewardPositionWeight({ block: STUB_BLOCK, step: STUB_STEP }, STUB_POSITION)
-        setError(null)
-        const normalizedWeight = new XL1Amount(weight).to(XL1Places.xl1)
-        setResult(Number(normalizedWeight))
-        setLoading(false)
-      } catch (err) {
-        setError(err as Error)
-        setResult(undefined)
-        setLoading(false)
-      }
-    }
-  }
-
-  return (
-    <Stack gap={2} alignItems="center">
-      {inIframe
-        ? (
-            <Alert severity="warning">
-              This story is running in an iframe. Please run it in a standalone browser window to test the wallet extension.
-            </Alert>
-          )
-        : null}
-      {isUndefined(wallet)
-        ? (
-            <Alert severity="warning">
-              No wallet extension found. Please install the Xyo Wallet Chrome Extension.
-            </Alert>
-          )
-        : null}
-      <ButtonEx loading={loading} variant="contained" onClick={() => void handleClick()} disabled={!isDefined(viewer)}>
-        Get Reward Weight Test
-      </ButtonEx>
-      <pre>
-        {JSON.stringify(result, null, 2)}
-      </pre>
-      {error ? <Alert severity="error">{error.message}</Alert> : null}
-    </Stack>
-  )
-}
-
-export default {
-  title: 'provider/useViewer/networkStakeStepRewardPositionWeight',
-  component: UseStepRewardWeightTest,
-  decorators: [LocalGatewayDecorator],
-} as Meta
-
-export const Template: StoryFn<typeof UseStepRewardWeightTest> = args => <UseStepRewardWeightTest {...args} />
-
-const Default = Template.bind({})
-Default.args = {}
-
-export { Default }

package/src/hooks/viewer/ViewerWithDataLake.ts

@@ -1,51 +0,0 @@
-import { type Hash, isNull } from '@xylabs/sdk-js'
-import { PayloadBuilder } from '@xyo-network/sdk-js'
-import type {
-  DataLakeViewer, SignedHydratedBlockWithHashMeta, SignedHydratedTransactionWithHashMeta, XL1BlockNumber,
-} from '@xyo-network/xl1-sdk'
-import {
-  addDataLakePayloads,
-  addDataLakePayloadsToPayloads, DataLakeViewerMoniker, JsonRpcXyoViewer,
-} from '@xyo-network/xl1-sdk'
-
-/**
- * A Viewer with data lake capabilities, it will attempt to fill in missing payloads from the
- * data lake viewer if available.
- *
- * THIS IS AN EXPERIMENTAL CLASS!  Only intended to prove the data lake viewer functionality works.
- * In the future, it should be refactored to augment any viewer with data lake capabilities,
- * and not rely on inheritance from JsonRpcXyoViewer which has the 'creatable' pattern baked in.
- */
-export class ViewerWithDataLake extends JsonRpcXyoViewer {
-  protected dataLakeViewer: DataLakeViewer | undefined
-
-  override async blocksByHash(hash: Hash, limit?: number): Promise<SignedHydratedBlockWithHashMeta[]> {
-    const blocks = await super.blocksByHash(hash, limit)
-    return await Promise.all(blocks.map(async block => (await addDataLakePayloads(block, this.dataLakeViewer))[0]))
-  }
-
-  override async blocksByNumber(blockNumber: XL1BlockNumber, limit?: number): Promise<SignedHydratedBlockWithHashMeta[]> {
-    const blocks = await super.blocksByNumber(blockNumber, limit)
-    return await Promise.all(blocks.map(async block => (await addDataLakePayloads(block, this.dataLakeViewer))[0]))
-  }
-
-  override async createHandler() {
-    await super.createHandler()
-    this.dataLakeViewer = await this.locator.tryGetInstance<DataLakeViewer>(DataLakeViewerMoniker)
-  }
-
-  override async payloadsByHash(hashes: Hash[]) {
-    const payloads = await super.payloadsByHash(hashes)
-    return (await addDataLakePayloadsToPayloads(hashes, payloads, this.dataLakeViewer))[0]
-  }
-
-  override async transactionByHash(hash: Hash): Promise<SignedHydratedTransactionWithHashMeta | null> {
-    const transaction = await super.transaction.byHash(hash)
-    if (!this.dataLakeViewer) return transaction ? [await PayloadBuilder.addHashMeta(transaction[0]), await PayloadBuilder.addHashMeta(transaction[1])] : null
-
-    return isNull(transaction)
-      ? transaction
-      : (await addDataLakePayloads([await PayloadBuilder.addHashMeta(transaction[0]),
-          await PayloadBuilder.addHashMeta(transaction[1])], this.dataLakeViewer))[0]
-  }
-}

package/src/hooks/viewer/index.ts

@@ -1,2 +0,0 @@
-export * from './useCheckRpc.ts'
-export * from './ViewerWithDataLake.ts'

package/src/hooks/viewer/useCheckRpc.ts

@@ -1,61 +0,0 @@
-import { usePromise } from '@xylabs/react-promise'
-import {
-  delay, isDefined, isUndefined,
-} from '@xylabs/sdk-js'
-import { basicRemoteViewerLocator } from '@xyo-network/chain-orchestration'
-import type { JsonRpcXyoViewer } from '@xyo-network/xl1-sdk'
-import {
-  LocalNetwork,
-  SequenceNetwork,
-  XyoViewerMoniker,
-} from '@xyo-network/xl1-sdk'
-import { useEffect, useState } from 'react'
-
-const INTERVAL = 5000 // 5 seconds
-
-const localRpcEndpoint: string = `${LocalNetwork.url}/rpc`
-const sequenceRpcEndpoint: string = `${SequenceNetwork.url}/rpc`
-
-export const useCheckLocalRpc = () => {
-  const isLocalProducer = useCheckRpc(localRpcEndpoint)
-  return isLocalProducer
-}
-
-export const useCheckSequenceRpc = () => {
-  const isSequenceRpc = useCheckRpc(sequenceRpcEndpoint)
-  return isSequenceRpc
-}
-
-export const useCheckRpc = (endpoint?: string) => {
-  const [isLocalProducer, setIsLocalProducer] = useState(false)
-  const [error, setError] = useState<Error>()
-
-  const [viewer] = usePromise(async () => {
-    if (isUndefined(endpoint)) return
-
-    const locator = await basicRemoteViewerLocator(endpoint, { rpc: { protocol: 'http', url: endpoint } })
-
-    const viewer = await locator.getInstance<JsonRpcXyoViewer>(XyoViewerMoniker)
-    return viewer
-  }, [endpoint])
-
-  useEffect(() => {
-    if (isUndefined(viewer)) return
-
-    void (async () => {
-      setError(undefined)
-      while (!isLocalProducer) {
-        try {
-          const block = await viewer.currentBlock()
-          setIsLocalProducer(isDefined(block))
-        } catch (err) {
-          setError(err as Error)
-          setIsLocalProducer(false)
-        }
-        await delay(INTERVAL)
-      }
-    })()
-  }, [isLocalProducer, viewer])
-
-  return { isLocalProducer, error }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './components/index.ts'
-export * from './contexts/index.ts'
-export * from './hooks/index.ts'
-export * from './lib/index.ts'
-export * from './types/index.ts'

package/src/lib/balanceForRange.ts

@@ -1,16 +0,0 @@
-import type { Address } from '@xylabs/sdk-js'
-import {
-  hexToBigInt, isHex, toHex,
-} from '@xylabs/sdk-js'
-import type { AccountBalanceHistoryItem, AttoXL1 } from '@xyo-network/xl1-sdk'
-
-export const balanceForRange = (address: Address, results: AccountBalanceHistoryItem[]): [AttoXL1, AttoXL1] => {
-  const totalReceivedBalance = results?.reduce((a, [_block, _tx, transfer]) => {
-    return a + hexToBigInt(transfer.transfers[address] ?? toHex(0))
-  }, 0n)
-  // eslint-disable-next-line unicorn/no-array-reduce
-  const totalSentBalance = results?.reduce((a, [_block, _tx, transfer]) => {
-    return (transfer.from === address) ? a + Object.values(transfer.transfers).reduce((a, v) => a + (isHex(v) ? hexToBigInt(v) : 0n), 0n) : a
-  }, 0n)
-  return [totalReceivedBalance, totalSentBalance] as [AttoXL1, AttoXL1]
-}

package/src/lib/buildGateway.ts

@@ -1,29 +0,0 @@
-import { assertEx, isDefined } from '@xylabs/sdk-js'
-import { basicRemoteRunnerLocator, basicRemoteViewerLocator } from '@xyo-network/chain-orchestration'
-import type { AccountInstance } from '@xyo-network/sdk-js'
-import type {
-  GatewayName, RemoteConfig, SimpleXyoGateway,
-} from '@xyo-network/xl1-sdk'
-import {
-  DefaultNetworks, NetworkDataLakeUrls, XyoGatewayMoniker,
-} from '@xyo-network/xl1-sdk'
-
-export const buildGateway = async (gatewayName: GatewayName, account?: AccountInstance) => {
-  const network = DefaultNetworks.find(network => network.id === gatewayName)
-  const resolvedNetwork = assertEx(network, () => `No network found for id ${gatewayName}`)
-
-  const remoteConfig: RemoteConfig = {
-    rpc: {
-      protocol: 'http',
-      url: `${resolvedNetwork.url}/rpc`,
-    },
-  }
-
-  const dataLakeEndpoint = NetworkDataLakeUrls[gatewayName]
-
-  const locator = isDefined(account)
-    ? await basicRemoteRunnerLocator(gatewayName, remoteConfig, account, dataLakeEndpoint)
-    : await basicRemoteViewerLocator(gatewayName, remoteConfig, dataLakeEndpoint)
-
-  return await locator.getInstance<SimpleXyoGateway>(XyoGatewayMoniker)
-}

package/src/lib/findMinimumBlock.ts

@@ -1,9 +0,0 @@
-import type { AccountBalanceHistoryItem } from '@xyo-network/xl1-sdk'
-
-export const findMinimumBlock = (history: AccountBalanceHistoryItem[]): number => {
-  // since taking Math.min of an empty array returns Infinity
-  if (history.length === 0) return 0
-  const blockNumbers = history.map(([blockBw]) => blockBw.block)
-  const min = Math.min(...blockNumbers)
-  return Math.max(min - 1, 0)
-}

package/src/lib/index.ts

@@ -1,3 +0,0 @@
-export * from './balanceForRange.ts'
-export * from './buildGateway.ts'
-export * from './findMinimumBlock.ts'

package/src/story/GatewayDecorator.tsx

@@ -1,36 +0,0 @@
-import type { Decorator } from '@storybook/react-vite'
-import {
-  LocalNetwork, MainNetwork, SequenceNetwork,
-} from '@xyo-network/xl1-sdk'
-
-import { GatewayProvider, InPageGatewaysProvider } from '../contexts/index.ts'
-
-export const MainnetGatewayDecorator: Decorator = (Story, ...args) => {
-  return (
-    <InPageGatewaysProvider>
-      <GatewayProvider gatewayName={MainNetwork.id}>
-        <Story {...args} />
-      </GatewayProvider>
-    </InPageGatewaysProvider>
-  )
-}
-
-export const SequenceGatewayDecorator: Decorator = (Story, ...args) => {
-  return (
-    <InPageGatewaysProvider>
-      <GatewayProvider gatewayName={SequenceNetwork.id}>
-        <Story {...args} />
-      </GatewayProvider>
-    </InPageGatewaysProvider>
-  )
-}
-
-export const LocalGatewayDecorator: Decorator = (Story, ...args) => {
-  return (
-    <InPageGatewaysProvider>
-      <GatewayProvider gatewayName={LocalNetwork.id}>
-        <Story {...args} />
-      </GatewayProvider>
-    </InPageGatewaysProvider>
-  )
-}

package/src/story/index.ts

@@ -1 +0,0 @@
-export * from './GatewayDecorator.tsx'

package/src/types/ContextGatewayType.ts

@@ -1,4 +0,0 @@
-import type { XyoGateway, XyoGatewayRunner } from '@xyo-network/xl1-sdk'
-
-// Can be removed once there is a gateway type with optional runner properties
-export type ContextGatewayType = XyoGateway | XyoGatewayRunner

package/src/types/GatewayFromWallet.ts

@@ -1,2 +0,0 @@
-/** @deprecated Import from `@xyo-network/react-chain-client` instead */
-export type { GatewayFromWallet } from '@xyo-network/react-chain-client'

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export * from './ContextGatewayType.ts'
-export * from './GatewayFromWallet.ts'