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

package/src/contexts/gateway/state.ts

@@ -1,15 +0,0 @@
-import type { ContextExState } from '@xylabs/react-shared'
-
-import type { ContextGatewayType } from '../../types/index.ts'
-
-export interface GatewayStateFields {
-  defaultGateway: ContextGatewayType | undefined | null
-  error: Error | null | undefined
-  gateways: {
-    inPageGateway: ContextGatewayType | undefined | null
-    walletGateway: ContextGatewayType | undefined | null
-  }
-  resetGatewaysFromConfig: () => void
-}
-
-export type GatewayState = ContextExState<GatewayStateFields>

package/src/contexts/gateway/story/GatewayStats.tsx

@@ -1,33 +0,0 @@
-import { Stack, Typography } from '@mui/material'
-import type { AccountInstance } from '@xyo-network/sdk-js'
-import type { GatewayName } from '@xyo-network/xl1-sdk'
-
-import { InPageGatewaysProvider } from '../../in-page-gateways/index.ts'
-import { GatewayProvider } from '../Provider.tsx'
-import { GatewayStatus } from './GatewayStatus.tsx'
-
-export interface GatewayStatsProps {
-  account?: AccountInstance
-  id?: GatewayName
-  url?: string
-}
-
-export const GatewayStats: React.FC<GatewayStatsProps> = ({
-  account, id, url,
-}) => {
-  return (
-    <InPageGatewaysProvider account={account}>
-      <GatewayProvider key={id} gatewayName={id}>
-        <Stack gap={1}>
-          <Typography variant="subtitle1">
-            <strong>{id}</strong>
-          </Typography>
-          <Typography variant="caption" color="text.secondary">
-            {url}
-          </Typography>
-          <GatewayStatus />
-        </Stack>
-      </GatewayProvider>
-    </InPageGatewaysProvider>
-  )
-}

package/src/contexts/gateway/story/GatewayStatus.tsx

@@ -1,53 +0,0 @@
-import {
-  Alert, Chip, Stack, Typography,
-} from '@mui/material'
-
-import { useProvidedGateway } from '../use.ts'
-
-/** Inner component that consumes the GatewayContext to display load status */
-export const GatewayStatus: React.FC = () => {
-  const { defaultGateway: gateway, error } = useProvidedGateway(false) ?? {}
-
-  if (error) {
-    return (
-      <Alert severity="error">
-        <Typography variant="body2">
-          Failed to load gateway:
-          {' '}
-          {error.message}
-        </Typography>
-      </Alert>
-    )
-  }
-
-  if (gateway === undefined) {
-    return (
-      <Alert severity="info">
-        <Typography variant="body2">Gateway loading...</Typography>
-      </Alert>
-    )
-  }
-
-  if (gateway === null) {
-    return (
-      <Alert severity="warning">
-        <Typography variant="body2">Gateway not available</Typography>
-      </Alert>
-    )
-  }
-
-  return (
-    <Alert severity="success">
-      <Stack direction="row" gap={1} alignItems="center">
-        <Typography variant="body2">Gateway loaded</Typography>
-        <Chip label="connected" color="success" size="small" />
-        {gateway?.connection?.viewer && (
-          <Chip label="viewer available" color="success" size="small" />
-        )}
-        {gateway?.connection.runner && (
-          <Chip label="runner available" color="success" size="small" />
-        )}
-      </Stack>
-    </Alert>
-  )
-}

package/src/contexts/gateway/story/Provider.stories.tsx

@@ -1,38 +0,0 @@
-import { Stack } from '@mui/material'
-import type { Meta, StoryObj } from '@storybook/react-vite'
-import { Account } from '@xyo-network/sdk-js'
-import { DefaultNetworks } from '@xyo-network/xl1-sdk'
-
-import type { GatewayProviderProps } from '../Provider.tsx'
-import { GatewayProvider } from '../Provider.tsx'
-import { GatewayStats } from './GatewayStats.tsx'
-
-const meta: Meta<GatewayProviderProps> = {
-  title: 'provider/GatewayProvider',
-  component: GatewayProvider,
-
-  parameters: { docs: { description: { component: 'Wraps children with a `GatewayContext` populated from the given `gatewayName` and show the gateways from the default networks if available.' } } },
-}
-
-export default meta
-
-const account = await Account.random()
-
-/**
- * Convenience story that proves ALL default networks are represented.
- * Each row corresponds to one entry in DefaultNetworks.
- */
-const AllDefaultNetworks: StoryObj<GatewayProviderProps> = {
-  name: 'All Default Networks',
-  render: () => {
-    return (
-      <Stack gap={3} p={2}>
-        {DefaultNetworks.map(network => (
-          <GatewayStats key={network.id} id={network.id} url={network.url} account={account} />
-        ))}
-      </Stack>
-    )
-  },
-}
-
-export { AllDefaultNetworks }

package/src/contexts/gateway/story/ProviderWithWallet.stories.tsx

@@ -1,43 +0,0 @@
-import { Alert, Stack } from '@mui/material'
-import type { Meta, StoryFn } from '@storybook/react-vite'
-import { isDefinedNotNull, isNull } from '@xylabs/sdk-js'
-import { IframeWalletWarningDecorator } from '@xyo-network/react-chain-shared'
-import type { GatewayName } from '@xyo-network/xl1-sdk'
-
-import { useClientFromWallet } from '../../../hooks/index.ts'
-import type { GatewayProviderProps } from '../Provider.tsx'
-import { GatewayProvider } from '../Provider.tsx'
-import { GatewayStats } from './GatewayStats.tsx'
-
-const meta: Meta<GatewayProviderProps> = {
-  title: 'provider/GatewayProvider',
-  component: GatewayProvider,
-  decorators: [IframeWalletWarningDecorator],
-
-  parameters: { docs: { description: { component: 'Wraps children with a `GatewayContext` populated from the given `gatewayName` and show the wallet-provided gateways if available.' } } },
-}
-
-export default meta
-
-const TestClientGateways: React.FC = () => {
-  const { client } = useClientFromWallet()
-  const foundClient = isDefinedNotNull(client)
-  const notFoundClient = isNull(client)
-  return (
-    <Stack gap={3} p={2}>
-      <Alert severity={foundClient ? 'success' : 'error'}>
-        {foundClient ? 'Client found, displaying gateways:' : ''}
-        {notFoundClient ? 'No client found. Please ensure your wallet is connected and has access to the current page.' : ''}
-      </Alert>
-      {Object.keys(client?.gateways || {}).map(id => (
-        <GatewayStats key={id} id={id as GatewayName} />
-      ))}
-    </Stack>
-  )
-}
-
-const Template: StoryFn = args => <TestClientGateways {...args} />
-
-const AllClientGateways = Template.bind({})
-
-export { AllClientGateways }

package/src/contexts/gateway/use.ts

@@ -1,5 +0,0 @@
-import { useContextEx } from '@xylabs/react-shared'
-
-import { GatewayContext } from './context.ts'
-
-export const useProvidedGateway = (required = true) => useContextEx(GatewayContext, 'Gateway', required)

package/src/contexts/in-page-gateways/Provider.tsx

@@ -1,86 +0,0 @@
-import type { AccountInstance } from '@xyo-network/sdk-js'
-import type { GatewayName } from '@xyo-network/xl1-sdk'
-import { DefaultNetworks } from '@xyo-network/xl1-sdk'
-import type { PropsWithChildren } from 'react'
-import React, {
-  startTransition,
-  useCallback, useEffect, useMemo, useState,
-} from 'react'
-
-import { buildGateway } from '../../lib/index.ts'
-import type { ContextGatewayType } from '../../types/index.ts'
-import { InPageGatewaysContext } from './context.ts'
-import type { InPageGatewaysState } from './state.ts'
-
-export interface InPageGatewaysProviderProps extends PropsWithChildren {
-  account?: AccountInstance
-}
-
-export const InPageGatewaysProvider: React.FC<InPageGatewaysProviderProps> = ({ account, children }) => {
-  const [gateways, setGateways] = useState<Partial<Record<GatewayName, ContextGatewayType>>>({})
-  const [errors, setErrors] = useState<Partial<Record<GatewayName, Error>>>({})
-  const [previousAccount, setPreviousAccount] = useState<AccountInstance | undefined>(account)
-
-  // This can come back once we homogenize the type for XyoGateway.
-  // Right now, SimpleXyoClient takes XyoGatewayRunners but ideally it would take XyoGateway.
-  // const clientInPage = useMemo(() => new SimpleXyoClient(gateways, {}), [gateways])
-
-  const clearAll = useCallback(() => {
-    setGateways({})
-    setErrors({})
-  }, [])
-
-  if (previousAccount !== account) {
-    clearAll()
-    setPreviousAccount(account)
-  }
-
-  useEffect(() => {
-    let cancelled = false
-
-    const buildAll = async () => {
-      const results = await Promise.allSettled(
-        DefaultNetworks.map(async (network) => {
-          const gateway = await buildGateway(network.id as GatewayName, account)
-          return { id: network.id as GatewayName, gateway }
-        }),
-      )
-
-      if (cancelled) return
-
-      const nextGateways: Partial<Record<GatewayName, ContextGatewayType>> = {}
-      const nextErrors: Partial<Record<GatewayName, Error>> = {}
-
-      for (const [index, result] of results.entries()) {
-        const networkId = DefaultNetworks[index].id as GatewayName
-        if (result.status === 'fulfilled') {
-          nextGateways[networkId] = result.value.gateway
-        } else {
-          nextErrors[networkId] = result.reason instanceof Error ? result.reason : new Error(String(result.reason))
-        }
-      }
-
-      startTransition(() => {
-        setGateways(nextGateways)
-        setErrors(nextErrors)
-      })
-    }
-
-    void buildAll()
-    return () => {
-      cancelled = true
-    }
-  }, [account])
-
-  const value = useMemo(() => {
-    const value: InPageGatewaysState = {
-      clearAll,
-      errors,
-      gateways,
-      provided: true,
-    }
-    return value
-  }, [clearAll, errors, gateways])
-
-  return <InPageGatewaysContext value={value}>{children}</InPageGatewaysContext>
-}

package/src/contexts/in-page-gateways/context.ts

@@ -1,5 +0,0 @@
-import { createContextEx } from '@xylabs/react-shared'
-
-import type { InPageGatewaysState } from './state.ts'
-
-export const InPageGatewaysContext = createContextEx<InPageGatewaysState>()

package/src/contexts/in-page-gateways/index.ts

@@ -1,4 +0,0 @@
-export * from './context.ts'
-export * from './Provider.tsx'
-export * from './state.ts'
-export * from './use.ts'

package/src/contexts/in-page-gateways/state.ts

@@ -1,12 +0,0 @@
-import type { ContextExState } from '@xylabs/react-shared'
-import type { GatewayName } from '@xyo-network/xl1-sdk'
-
-import type { ContextGatewayType } from '../../types/index.ts'
-
-export interface InPageGatewaysStateFields {
-  clearAll: () => void
-  errors: Partial<Record<GatewayName, Error>>
-  gateways: Partial<Record<GatewayName, ContextGatewayType>>
-}
-
-export type InPageGatewaysState = ContextExState<InPageGatewaysStateFields>

package/src/contexts/in-page-gateways/use.ts

@@ -1,5 +0,0 @@
-import { useContextEx } from '@xylabs/react-shared'
-
-import { InPageGatewaysContext } from './context.ts'
-
-export const useProvidedInPageGateways = (required = true) => useContextEx(InPageGatewaysContext, 'InPageGateways', required)

package/src/contexts/index.ts

@@ -1,3 +0,0 @@
-export * from './current-block/index.ts'
-export * from './gateway/index.ts'
-export * from './in-page-gateways/index.ts'

package/src/global.d.ts

@@ -1,9 +0,0 @@
-import type { XyoGlobal } from '@xyo-network/react-chain-model'
-
-export declare global {
-  interface Window {
-    xyo: XyoGlobal
-  }
-
-  var xyo: XyoGlobal
-}

package/src/hooks/account/BalanceHistoryItemFormatted.ts

@@ -1,17 +0,0 @@
-import type { Address, Hash } from '@xylabs/sdk-js'
-import type { AccountBalanceHistoryItem } from '@xyo-network/xl1-sdk'
-
-export type BalanceTransactionType = 'send' | 'receive'
-
-export interface AccountBalanceHistoryItemFormatted {
-  amount: bigint
-  blockNumber: number
-  debug: AccountBalanceHistoryItem
-  from: Address
-  key: string
-  timestamp: number
-  to: Address
-  transferHash: Hash
-  txHash: Hash | undefined
-  type: BalanceTransactionType
-}

package/src/hooks/account/helpers/formatAccountBalanceHistory.ts

@@ -1,44 +0,0 @@
-import type { Address, Hex } from '@xylabs/sdk-js'
-import { hexToBigInt } from '@xylabs/sdk-js'
-import { PayloadBuilder } from '@xyo-network/sdk-js'
-import type { AccountBalanceHistoryItem } from '@xyo-network/xl1-sdk'
-
-import type { AccountBalanceHistoryItemFormatted } from '../BalanceHistoryItemFormatted.ts'
-
-export const formatAccountBalanceHistory = async (address: Address, history: AccountBalanceHistoryItem[]): Promise<AccountBalanceHistoryItemFormatted[]> => {
-  let results: AccountBalanceHistoryItemFormatted[] = []
-  for (const item of history) {
-    const [blockBw, txBw, transfer] = item
-    const transferHash = await PayloadBuilder.hash(transfer)
-    if (address === transfer.from) {
-      for (const [to, amount] of Object.entries(transfer.transfers)) {
-        results.push({
-          amount: hexToBigInt(amount as Hex),
-          blockNumber: blockBw.block,
-          from: transfer.from,
-          timestamp: blockBw.$epoch,
-          key: globalThis.crypto.randomUUID(),
-          to: to as Address,
-          transferHash,
-          txHash: txBw?._hash,
-          debug: item,
-          type: 'send',
-        })
-      }
-    } else {
-      results.push({
-        amount: hexToBigInt(transfer.transfers[address] as Hex),
-        blockNumber: blockBw.block,
-        from: transfer.from,
-        key: globalThis.crypto.randomUUID(),
-        timestamp: blockBw.$epoch,
-        to: address,
-        transferHash,
-        txHash: txBw?._hash,
-        debug: item,
-        type: 'receive',
-      })
-    }
-  }
-  return results
-}

package/src/hooks/account/helpers/index.ts

@@ -1 +0,0 @@
-export * from './formatAccountBalanceHistory.ts'

package/src/hooks/account/index.ts

@@ -1,3 +0,0 @@
-export * from './BalanceHistoryItemFormatted.ts'
-export * from './helpers/index.ts'
-export * from './useAccountBalanceHistory.ts'

package/src/hooks/account/useAccountBalanceHistory.ts

@@ -1,51 +0,0 @@
-import { usePromise } from '@xylabs/react-promise'
-import {
-  type Address,
-  isUndefined,
-} from '@xylabs/sdk-js'
-import type {
-  AccountBalanceHistoryItem, XL1BlockRange, XyoViewer,
-} from '@xyo-network/xl1-sdk'
-
-import { balanceForRange, findMinimumBlock } from '../../lib/index.ts'
-import { formatAccountBalanceHistory } from './helpers/index.ts'
-
-export const useAccountBalanceHistory = (address?: Address, viewer?: XyoViewer, maxPage = 10, blockRange?: XL1BlockRange, refresh?: number) => {
-  return usePromise(async () => {
-    if (isUndefined(viewer) || isUndefined(address)) return
-
-    // Pagination Values
-    let page = 1
-    let lastBlock: number
-    const pagedHistory: AccountBalanceHistoryItem[] = []
-    const resolvedStartBlock = blockRange ? blockRange[0] : 0
-
-    // Fetch first page to get starting lastBlock
-    // If blockRange is provided, use that for the first fetch, otherwise the api will use [0, currentBlock]
-    const history = await viewer.account.balance.accountBalanceHistory(address, blockRange ? { range: blockRange } : {})
-    if (history.length > 0) {
-      pagedHistory.push(...history)
-      // Set lastBlock to one less than the lowest block in the first page
-      lastBlock = findMinimumBlock(history)
-      while (page < maxPage) {
-        // Fetch next page
-        const nextHistory = await viewer.account.balance.accountBalanceHistory(address, { range: [resolvedStartBlock, lastBlock] as XL1BlockRange })
-        // Break if no more history
-        if (nextHistory.length === 0) break
-        // Update lastBlock and append to pagedHistory
-        lastBlock = findMinimumBlock(nextHistory)
-        pagedHistory.push(...nextHistory)
-        // Increment page
-        // Even if we are going to go over and break the loop, we still want to increment to show the answer was truncated
-        page++
-      }
-    }
-    const formattedHistory = await formatAccountBalanceHistory(address, pagedHistory)
-
-    return {
-      history: formattedHistory,
-      balance: balanceForRange(address, pagedHistory),
-      truncated: page >= maxPage,
-    }
-  }, [address, viewer, refresh, blockRange, maxPage])
-}

package/src/hooks/client/helpers/findCaveat.ts

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

package/src/hooks/client/helpers/index.ts

@@ -1 +0,0 @@
-export * from './findCaveat.ts'

package/src/hooks/client/index.ts

@@ -1,3 +0,0 @@
-export * from './permissions/index.ts'
-export * from './useClientFromWallet.ts'
-export * from './useGatewayFromWallet.ts'

package/src/hooks/client/permissions/index.ts

@@ -1,2 +0,0 @@
-export * from './usePermissions.ts'
-export * from './usePermissionsAccounts.ts'

package/src/hooks/client/permissions/usePermissions.ts

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

package/src/hooks/client/permissions/usePermissionsAccounts.ts

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

package/src/hooks/client/useClientFromWallet.ts

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

package/src/hooks/client/useGatewayFromWallet.ts

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

package/src/hooks/gateway/index.ts

@@ -1,3 +0,0 @@
-export * from './useNetwork.ts'
-export * from './useRunner.ts'
-export * from './useViewer.ts'

package/src/hooks/gateway/useNetwork.ts

@@ -1,6 +0,0 @@
-import { useProvidedGateway } from '../../contexts/index.ts'
-
-export const useNetworkFromGateway = () => {
-  const { defaultGateway } = useProvidedGateway()
-  return defaultGateway?.connection?.network
-}

package/src/hooks/gateway/useRunner.ts

@@ -1,6 +0,0 @@
-import { useProvidedGateway } from '../../contexts/index.ts'
-
-export const useRunnerFromGateway = () => {
-  const { defaultGateway } = useProvidedGateway()
-  return defaultGateway?.connection?.runner
-}

package/src/hooks/gateway/useViewer.ts

@@ -1,6 +0,0 @@
-import { useProvidedGateway } from '../../contexts/index.ts'
-
-export const useViewerFromGateway = () => {
-  const { defaultGateway } = useProvidedGateway()
-  return defaultGateway?.connection?.viewer
-}

package/src/hooks/helpers/getXyoClient.ts

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

package/src/hooks/helpers/index.ts

@@ -1,2 +0,0 @@
-export * from './getXyoClient.ts'
-export * from './transaction/index.ts'

package/src/hooks/helpers/transaction/Confirmation.ts

@@ -1,125 +0,0 @@
-import type { Hash, Promisable } from '@xylabs/sdk-js'
-import {
-  assertEx, delay, forget, isDefined, isNull,
-} from '@xylabs/sdk-js'
-import type { SignedHydratedTransaction, XyoViewer } from '@xyo-network/xl1-sdk'
-
-export type ConfirmationStatusUpdate = {
-  blockNumber: number
-  confirmed: boolean
-  error?: Error
-  progress?: number
-  remainingBlocks?: number
-}
-
-export type TransactionConfirmationParams = {
-  onStatusUpdate?: (status: ConfirmationStatusUpdate) => void
-  transaction: SignedHydratedTransaction
-  txHash: Hash
-  viewer: XyoViewer
-}
-
-export class TransactionConfirmationStatus {
-  private readonly _params: TransactionConfirmationParams
-  private active = false
-
-  constructor(params: TransactionConfirmationParams) {
-    this._params = params
-  }
-
-  get exp(): number {
-    return assertEx(this.transaction[0].exp, () => 'exp is not found, transaction is not set')
-  }
-
-  get nbf(): number {
-    return assertEx(this.transaction[0].nbf, () => 'nbf is not found, transaction is not set')
-  }
-
-  get onStatusUpdate(): TransactionConfirmationParams['onStatusUpdate'] {
-    return this._params.onStatusUpdate
-  }
-
-  get params(): TransactionConfirmationParams {
-    return this._params
-  }
-
-  get transaction(): SignedHydratedTransaction {
-    return this.params.transaction
-  }
-
-  get txHash(): Hash {
-    return this.params.txHash
-  }
-
-  get viewer(): XyoViewer {
-    return this.params.viewer
-  }
-
-  static create(params: TransactionConfirmationParams): Promisable<TransactionConfirmationStatus> {
-    return new TransactionConfirmationStatus(params)
-  }
-
-  async start(): Promise<void> {
-    this.active = true
-    try {
-      const currentBlockNumber = await this.viewer.currentBlockNumber()
-      while (isDefined(currentBlockNumber) && this.active) {
-        await this.checkBlock(currentBlockNumber)
-        // check block every second to see if the transaction is confirmed
-        await delay(1000)
-      }
-    } catch (error) {
-      await this.stop()
-      forget(this.onStatusUpdate?.({
-        error: error instanceof Error ? error : new Error('Unknown error occurred'),
-        confirmed: false,
-        blockNumber: 0,
-        progress: 0,
-        remainingBlocks: 0,
-      }))
-    }
-  }
-
-  stop(): Promisable<void> {
-    this.active = false
-  }
-
-  private async checkBlock(blockNumber: number): Promise<void> {
-    if (blockNumber < this.nbf) {
-      await this.stop()
-      forget(this.onStatusUpdate?.({
-        error: new Error(`Block number: ${blockNumber} is before ${this.nbf}`),
-        confirmed: false,
-        blockNumber,
-        progress: 0,
-        remainingBlocks: this.exp - blockNumber,
-      }))
-    }
-    if (blockNumber > this.exp) {
-      forget(this.onStatusUpdate?.({
-        confirmed: false, blockNumber, progress: 100, remainingBlocks: 0,
-      }))
-      return
-    }
-    if (blockNumber < this.exp) {
-      await this.checkConfirmation(blockNumber)
-    }
-  }
-
-  private async checkConfirmation(blockNumber: number): Promise<void> {
-    const remainingBlocks = this.exp - blockNumber
-    const progress = Math.round(((blockNumber - this.nbf) / (this.exp - this.nbf)) * 100)
-
-    const tx = await this.viewer.transaction.byHash?.(this.txHash)
-    if (isNull(tx)) {
-      this.onStatusUpdate?.({
-        confirmed: false, blockNumber, progress, remainingBlocks,
-      })
-    } else {
-      this.onStatusUpdate?.({
-        confirmed: true, blockNumber, progress, remainingBlocks,
-      })
-      await this.stop()
-    }
-  }
-}

package/src/hooks/helpers/transaction/index.ts

@@ -1 +0,0 @@
-export * from './Confirmation.ts'

package/src/hooks/index.ts

@@ -1,11 +0,0 @@
-export * from './account/index.ts'
-export * from './client/index.ts'
-export * from './gateway/index.ts'
-export * from './helpers/index.ts'
-export * from './useAddressBalance.ts'
-export * from './useConfirmTransactionBase.ts'
-export * from './useConnectAccount.ts'
-export * from './useCurrentBlock.ts'
-export * from './useNetwork.ts'
-export * from './useSigner.ts'
-export * from './viewer/index.ts'