@xyo-network/react-sentinel 7.5.8 → 7.5.12

package/src/components/Card/NftSentinel.json

@@ -1,214 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/a5a229a767e3998e13cce8160fd1c2b027317424/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "accountPath": "/0'/0'",
-        "name": "NftInfoNode",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "public": [
-          {
-            "config": {
-              "accountPath": "/1'/0'",
-              "call": {
-                "functionName": "name",
-                "params": []
-              },
-              "labels": {
-                "network.xyo.evm.interface": "Erc721"
-              },
-              "language": "javascript",
-              "name": "Erc721NameWitness",
-              "schema": "network.xyo.evm.call.witness.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/1'/1'",
-              "call": {
-                "functionName": "symbol",
-                "params": []
-              },
-              "labels": {
-                "network.xyo.evm.interface": "Erc721"
-              },
-              "language": "javascript",
-              "name": "Erc721SymbolWitness",
-              "schema": "network.xyo.evm.call.witness.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/1'/2'",
-              "call": {
-                "functionName": "totalSupply",
-                "params": []
-              },
-              "labels": {
-                "network.xyo.evm.interface": "Erc721Enumerable"
-              },
-              "language": "javascript",
-              "name": "Erc721TotalSupplyWitness",
-              "schema": "network.xyo.evm.call.witness.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/1'/3'",
-              "call": {
-                "functionName": "tokenURI"
-              },
-              "labels": {
-                "network.xyo.evm.interface": "Erc721"
-              },
-              "language": "javascript",
-              "name": "Erc721TokenURIWitness",
-              "schema": "network.xyo.evm.call.witness.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/1'/4'",
-              "call": {
-                "functionName": "ownerOf"
-              },
-              "labels": {
-                "network.xyo.evm.interface": "Erc721"
-              },
-              "language": "javascript",
-              "name": "Erc721OwnerOfWitness",
-              "schema": "network.xyo.evm.call.witness.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/1'/5'",
-              "call": {
-                "functionName": "uri",
-                "params": []
-              },
-              "labels": {
-                "network.xyo.evm.interface": "Erc1155"
-              },
-              "language": "javascript",
-              "name": "Erc1155UriWitness",
-              "schema": "network.xyo.evm.call.witness.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/2'/0'",
-              "language": "javascript",
-              "name": "Erc721ContractInfoDiviner",
-              "schema": "network.xyo.evm.call.diviner.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/2'/1'",
-              "language": "javascript",
-              "name": "Erc1155ContractInfoDiviner",
-              "schema": "network.xyo.evm.call.diviner.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/2'/2'",
-              "language": "javascript",
-              "name": "Erc721TokenContractInfoDiviner",
-              "schema": "network.xyo.evm.call.diviner.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/2'/3'",
-              "language": "javascript",
-              "name": "Erc1155TokenContractInfoDiviner",
-              "schema": "network.xyo.evm.call.diviner.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/3'/0'",
-              "language": "javascript",
-              "name": "NftInfoSentinel",
-              "schema": "network.xyo.sentinel.config",
-              "synchronous": "true",
-              "tasks": [
-                {
-                  "input": true,
-                  "mod": "Erc721NameWitness"
-                },
-                {
-                  "input": true,
-                  "mod": "Erc721SymbolWitness"
-                },
-                {
-                  "input": true,
-                  "mod": "Erc721TotalSupplyWitness"
-                },
-                {
-                  "input": true,
-                  "mod": "Erc1155UriWitness"
-                },
-                {
-                  "input": [
-                    "Erc721NameWitness",
-                    "Erc721SymbolWitness",
-                    "Erc721TotalSupplyWitness"
-                  ],
-                  "mod": "Erc721ContractInfoDiviner"
-                },
-                {
-                  "input": [
-                    "Erc1155UriWitness"
-                  ],
-                  "mod": "Erc1155ContractInfoDiviner"
-                }
-              ]
-            }
-          },
-          {
-            "config": {
-              "accountPath": "/3'/1'",
-              "language": "javascript",
-              "name": "NftTokenInfoSentinel",
-              "schema": "network.xyo.sentinel.config",
-              "synchronous": "true",
-              "tasks": [
-                {
-                  "input": true,
-                  "mod": "Erc721TokenURIWitness"
-                },
-                {
-                  "input": true,
-                  "mod": "Erc721OwnerOfWitness"
-                },
-                {
-                  "input": true,
-                  "mod": "Erc1155UriWitness"
-                },
-                {
-                  "input": [
-                    "Erc721TokenURIWitness",
-                    "Erc721OwnerOfWitness"
-                  ],
-                  "mod": "Erc721TokenContractInfoDiviner"
-                },
-                {
-                  "input": [
-                    "Erc1155UriWitness"
-                  ],
-                  "mod": "Erc1155TokenContractInfoDiviner"
-                }
-              ]
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/components/Card/index.ts

@@ -1,3 +0,0 @@
-export * from './Card.tsx'
-export * from './CardContent.tsx'
-export * from './CardHeader.tsx'

package/src/components/Card/manifest.ts

@@ -1 +0,0 @@
-export { default as NftSentinelManifest } from './NftSentinel.json' with { type: 'json' }

package/src/components/index.ts

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

package/src/contexts/Context.ts

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

package/src/contexts/Provider.tsx

@@ -1,131 +0,0 @@
-import { useAsyncEffect } from '@xylabs/react-async-effect'
-import type { AccountInstance } from '@xyo-network/account-model'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import { useWitnessesFromNode } from '@xyo-network/react-witness'
-import { MemorySentinel } from '@xyo-network/sentinel-memory'
-import type { SentinelConfig } from '@xyo-network/sentinel-model'
-import { SentinelConfigSchema } from '@xyo-network/sentinel-model'
-import type { WitnessInstance } from '@xyo-network/witness-model'
-import { asWitnessInstance } from '@xyo-network/witness-model'
-import type { PropsWithChildren } from 'react'
-import React, {
-  useEffect, useMemo, useState,
-} from 'react'
-
-import { SentinelContext } from './Context.ts'
-import type { SentinelContextState, SentinelReportProgress } from './State.ts'
-import { SentinelReportStatus } from './State.ts'
-
-export interface SentinelProviderProps {
-  /** Account used by the sentinel for signing */
-  account: AccountInstance
-  /** @deprecated - sentinel no longer uses archive but relies on an archivist */
-  archive?: string
-  archivist?: string
-  ids?: ModuleIdentifier[]
-  name?: string
-  required?: boolean
-  witnesses?: WitnessInstance[]
-}
-
-export const SentinelProvider: React.FC<PropsWithChildren<SentinelProviderProps>> = ({
-  account, archivist, children, ids, name, required = false,
-}) => {
-  const [sentinel, setSentinel] = useState<MemorySentinel>()
-  const [history, setHistory] = useState<BoundWitness[]>()
-  const [progress, setProgress] = useState<SentinelReportProgress>({})
-  const [status, setStatus] = useState<SentinelReportStatus>(SentinelReportStatus.Idle)
-  const [reportingErrors, setReportingErrors] = useState<Error[]>()
-  const [witnesses] = useWitnessesFromNode(ids)
-
-  useAsyncEffect(
-
-    async (mounted) => {
-      const sentinel = await MemorySentinel.create({
-        account,
-        config: {
-          archivists: archivist ? [archivist] : undefined,
-          name,
-
-          schema: SentinelConfigSchema,
-          synchronous: true,
-
-          tasks: witnesses?.map(mod => ({ mod: mod.address })),
-        } as SentinelConfig,
-      })
-      const offCallbacks: (() => void)[] = [
-        sentinel.on('reportEnd', ({ mod, outPayloads }) => {
-          if (mounted()) {
-            setProgress({
-              archivists: progress.archivists,
-              witnesses: progress.witnesses,
-            })
-            setStatus(outPayloads?.length ? SentinelReportStatus.Succeeded : SentinelReportStatus.Failed)
-            setReportingErrors([new Error(`Witness failed [${mod?.config?.name ?? mod.address}]`)])
-          }
-        }),
-        sentinel.on('reportStart', () => {
-          if (mounted()) {
-            setProgress({ archivists: {}, witnesses: {} })
-            setStatus(SentinelReportStatus.Started)
-          }
-        }),
-      ]
-      if (witnesses)
-        for (const witness of witnesses) {
-          offCallbacks.push(
-            witness.on('observeEnd', ({ mod, outPayloads }) => {
-              const witnesses = progress.witnesses ?? {}
-              witnesses[witness.address] = {
-                status: outPayloads?.length ? SentinelReportStatus.Succeeded : SentinelReportStatus.Failed,
-                witness: asWitnessInstance(mod, () => `Module is not a witness [${mod.id}]`, { required: true }),
-              }
-              if (mounted()) {
-                setProgress({
-                  archivists: progress.archivists,
-                  witnesses,
-                })
-              }
-            }),
-            witness.on('observeStart', ({ mod }) => {
-              const witnesses = progress.witnesses ?? {}
-              witnesses[witness.address] = {
-                status: SentinelReportStatus.Started,
-                witness: asWitnessInstance(mod, () => `Module is not a witness [${mod.id}]`, { required: true }),
-              }
-              if (mounted()) {
-                setProgress({
-                  archivists: progress.archivists,
-                  witnesses,
-                })
-              }
-            }),
-          )
-        }
-      setSentinel(sentinel as MemorySentinel)
-      setHistory(sentinel?.history as BoundWitness[])
-      return () => {
-        // unsubscribe from events
-        for (const callback of offCallbacks) {
-          callback()
-        }
-      }
-    },
-
-    [account, archivist, witnesses],
-  )
-
-  const value: SentinelContextState = useMemo(() => ({
-    history, progress, provided: true, reportingErrors, sentinel, status,
-  }), [history, progress, reportingErrors, sentinel, status])
-
-  return !required || sentinel
-
-    ? (
-        <SentinelContext value={value}>
-          {children}
-        </SentinelContext>
-      )
-    : null
-}

package/src/contexts/State.ts

@@ -1,40 +0,0 @@
-import type { ContextExState } from '@xylabs/react-shared'
-import type { EnumValue } from '@xylabs/sdk-js'
-import { Enum } from '@xylabs/sdk-js'
-import type { ArchivistModuleInstance } from '@xyo-network/archivist-model'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import type { SentinelModule } from '@xyo-network/sentinel-model'
-import type { WitnessModule } from '@xyo-network/witness-model'
-
-export const SentinelReportStatus = Enum({
-  Idle: 'idle',
-  Queued: 'queued',
-  Started: 'started',
-  Succeeded: 'succeeded',
-  Failed: 'failed',
-})
-
-export type SentinelReportStatus = EnumValue<typeof SentinelReportStatus>
-
-export interface SentinelWitnessReportProgress {
-  status: SentinelReportStatus
-  witness: WitnessModule
-}
-
-export interface SentinelArchivistApiReportProgress {
-  archivist: ArchivistModuleInstance
-  status: SentinelReportStatus
-}
-
-export interface SentinelReportProgress {
-  archivists?: Record<string, SentinelArchivistApiReportProgress>
-  witnesses?: Record<string, SentinelWitnessReportProgress>
-}
-
-export type SentinelContextState = ContextExState<{
-  history?: BoundWitness[]
-  progress?: SentinelReportProgress
-  reportingErrors?: Error[]
-  sentinel?: SentinelModule
-  status?: SentinelReportStatus
-}>

package/src/contexts/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/use.ts

@@ -1,12 +0,0 @@
-import { useContextEx } from '@xylabs/react-shared'
-
-import { SentinelContext } from './Context.ts'
-
-export const useSentinelContext = () => {
-  const {
-    sentinel, history, progress, reportingErrors, status,
-  } = useContextEx(SentinelContext, 'Sentinel')
-  return {
-    history, progress, reportingErrors, sentinel, status,
-  }
-}

package/src/hooks/index.ts

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

package/src/hooks/node/index.ts

@@ -1,4 +0,0 @@
-export * from './useSentinelFromNode.tsx'
-export * from './useSentinelsFromNode.tsx'
-export * from './useWeakSentinelFromNode.tsx'
-export * from './useWeakSentinelsFromNode.tsx'

package/src/hooks/node/useSentinelFromNode.tsx

@@ -1,18 +0,0 @@
-import type { ModuleFromNodeConfig } from '@xyo-network/react-node'
-import { useModuleFromNode } from '@xyo-network/react-node'
-import type { SentinelInstance } from '@xyo-network/sentinel-model'
-import { asSentinelInstance } from '@xyo-network/sentinel-model'
-
-export const useSentinelFromNode = (
-  nameOrAddressOrInstance?: string | SentinelInstance,
-  config?: ModuleFromNodeConfig,
-): [SentinelInstance | undefined, Error | undefined] => {
-  const [mod, error] = useModuleFromNode(nameOrAddressOrInstance, config)
-  const instance = asSentinelInstance(mod)
-  if (mod && !instance) {
-    const error = new Error(`Resolved module is not a SentinelInstance [${mod.config?.schema}:${mod.config?.name}:${mod.address}]`)
-    console.error(error.message)
-    return [undefined, error]
-  }
-  return [instance, error]
-}

package/src/hooks/node/useSentinelsFromNode.tsx

@@ -1,27 +0,0 @@
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import type { ModuleFromNodeConfig } from '@xyo-network/react-node'
-import { useModulesFromNode } from '@xyo-network/react-node'
-import type { SentinelInstance } from '@xyo-network/sentinel-model'
-import { isSentinelInstance } from '@xyo-network/sentinel-model'
-
-export const useSentinelsFromNode = (
-  ids?: ModuleIdentifier[],
-  config?: ModuleFromNodeConfig,
-): [SentinelInstance[] | null | undefined, Error | undefined] => {
-  const [modules, error] = useModulesFromNode(ids, config)
-  if (error) {
-    return [null, error]
-  }
-  return modules
-    ? [
-        // eslint-disable-next-line unicorn/no-array-reduce
-        modules.reduce<SentinelInstance[]>((prev, mod) => {
-          if (isSentinelInstance(mod)) {
-            prev.push(mod)
-          }
-          return prev
-        }, []),
-        undefined,
-      ]
-    : [modules, error]
-}

package/src/hooks/node/useWeakSentinelFromNode.tsx

@@ -1,11 +0,0 @@
-import type { WeakModuleFromNodeConfig } from '@xyo-network/react-node'
-import { useWeakModuleFromNode } from '@xyo-network/react-node'
-import type { SentinelInstance } from '@xyo-network/sentinel-model'
-import { isSentinelInstance } from '@xyo-network/sentinel-model'
-
-export const useWeakSentinelFromNode = (
-  nameOrAddressOrInstance?: string | SentinelInstance,
-  config?: WeakModuleFromNodeConfig,
-): [WeakRef<SentinelInstance> | undefined, Error | undefined] => {
-  return useWeakModuleFromNode<SentinelInstance>(nameOrAddressOrInstance, { identity: isSentinelInstance, ...config })
-}

package/src/hooks/node/useWeakSentinelsFromNode.tsx

@@ -1,27 +0,0 @@
-import { exists } from '@xylabs/sdk-js'
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import type { ModuleFromNodeConfig } from '@xyo-network/react-node'
-import { useWeakModulesFromNode } from '@xyo-network/react-node'
-import type { SentinelInstance } from '@xyo-network/sentinel-model'
-import { asSentinelInstance } from '@xyo-network/sentinel-model'
-
-export const useWeakSentinelsFromNode = (
-  ids?: ModuleIdentifier[],
-  config?: ModuleFromNodeConfig,
-): [WeakRef<SentinelInstance>[] | null | undefined, Error | undefined] => {
-  const [modules, error] = useWeakModulesFromNode(ids, config)
-  if (error) {
-    return [null, error]
-  }
-  return [
-    modules
-      ?.map((mod) => {
-        const instance = asSentinelInstance(mod?.deref())
-        if (instance) {
-          return new WeakRef(instance)
-        }
-      })
-      .filter(exists) ?? [],
-    undefined,
-  ]
-}

package/src/index.ts

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