@xyo-network/witness-evm-abstract 5.3.22 → 5.3.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/witness-evm-abstract",
-  "version": "5.3.22",
+  "version": "5.3.25",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,39 +30,35 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*",
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/abstract-witness": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
-    "@xyo-network/witness-model": "~5.3.22"
+    "@xyo-network/abstract-witness": "~5.3.25",
+    "@xyo-network/payload-model": "~5.3.25",
+    "@xyo-network/module-model": "~5.3.25",
+    "@xyo-network/witness-model": "~5.3.25"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.91",
-    "@xylabs/ts-scripts-common": "~7.6.8",
-    "@xylabs/ts-scripts-yarn3": "~7.6.8",
-    "@xylabs/tsconfig": "~7.6.8",
-    "@xyo-network/abstract-witness": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
-    "@xyo-network/witness-model": "~5.3.22",
+    "@xylabs/sdk-js": "^5.0.93",
+    "@xylabs/ts-scripts-common": "~7.6.16",
+    "@xylabs/ts-scripts-pnpm": "~7.6.16",
+    "@xylabs/tsconfig": "~7.6.16",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
-    "cosmiconfig": "^9.0.1",
-    "esbuild": "^0.27.4",
-    "eslint": "^10.1.0",
+    "esbuild": "^0.28.0",
     "ethers": "^6.16.0",
-    "rollup": "^4.60.1",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/module-model": "~5.3.25",
+    "@xyo-network/abstract-witness": "~5.3.25",
+    "@xyo-network/payload-model": "~5.3.25",
+    "@xyo-network/witness-model": "~5.3.25"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
@@ -73,4 +69,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Witness.ts

@@ -1,74 +0,0 @@
-import type { EmptyObject, Promisable } from '@xylabs/sdk-js'
-import { isTruthy } from '@xylabs/sdk-js'
-import { AbstractWitness } from '@xyo-network/abstract-witness'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-import { creatableModule } from '@xyo-network/module-model'
-import {
-  asSchema, type Payload, type Schema,
-} from '@xyo-network/payload-model'
-import type {
-  CustomWitnessInstance, WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams,
-} from '@xyo-network/witness-model'
-import type { Provider } from 'ethers'
-
-export const EvmWitnessConfigSchema = asSchema('network.xyo.evm.witness', true)
-export type EvmWitnessConfigSchema = typeof EvmWitnessConfigSchema
-
-export type EvmWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends Schema | void = void> = WitnessConfig<
-  TAdditional,
-  TSchema extends void
-    ? TAdditional extends Payload
-      ? TAdditional['schema']
-      : EvmWitnessConfigSchema
-    : TSchema
->
-
-export type AdditionalEvmWitnessParams = {
-  providers: Provider[]
-}
-
-export interface EvmWitnessParams<
-  TConfig extends AnyConfigSchema<EvmWitnessConfig> = EvmWitnessConfig,
-> extends WitnessParams<TConfig>
-{
-  providers: () => Promisable<Provider[]>
-}
-
-creatableModule()
-export abstract class AbstractEvmWitness<
-  TParams extends EvmWitnessParams<AnyConfigSchema<EvmWitnessConfig>> = EvmWitnessParams,
-  TIn extends Payload = Payload,
-  TOut extends Payload = Payload,
-  TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<
-    WitnessInstance<TParams, TIn, TOut>,
-    TIn,
-    TOut
-  >,
->
-  extends AbstractWitness<TParams, TIn, TOut, TEventData>
-  implements CustomWitnessInstance<TParams, TIn, TOut, TEventData> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, EvmWitnessConfigSchema]
-  static override readonly defaultConfigSchema: Schema = EvmWitnessConfigSchema
-  private _providers: Provider[] | undefined = undefined
-
-  async getProvider(cache?: boolean): Promise<Provider | undefined>
-  async getProvider(cache: boolean, error: string | true): Promise<Provider>
-  async getProvider(cache = false, error?: string | boolean): Promise<Provider | undefined> {
-    const providers = await this.getProviders(cache)
-    if (providers.length === 0) {
-      if (isTruthy(error)) {
-        throw new Error(typeof error === 'string' ? error : 'No providers available')
-      }
-      return undefined
-    }
-    return providers[Date.now() % providers.length] // pick a random provider
-  }
-
-  async getProviders(cache = false): Promise<Provider[]> {
-    const cachedProviders = cache ? this._providers : undefined
-    this._providers = cachedProviders ?? (await this.params.providers())
-    return this._providers
-  }
-
-  protected abstract override observeHandler(payloads?: TIn[]): Promisable<TOut[]>
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './lib/index.ts'
-export * from './model.ts'
-export * from './Witness.ts'

package/src/lib/checkIpfsUrl.ts

@@ -1,43 +0,0 @@
-import { assertEx } from '@xylabs/sdk-js'
-
-const allowIpfsIoRepair = true
-
-/**
- * Returns the equivalent IPFS gateway URL for the supplied URL.
- * @param urlToCheck The URL to check
- * @returns If the supplied URL is an IPFS URL, it converts the URL to the
- * equivalent IPFS gateway URL. Otherwise, returns the original URL.
- */
-export const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {
-  try {
-    const url = new URL(urlToCheck)
-    let protocol = url.protocol
-    let host = url.host
-    let path = url.pathname
-    const query = url.search
-    if (protocol === 'ipfs:') {
-      protocol = 'https:'
-      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')
-      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`
-      const root = `${protocol}//${host}/${path}`
-      return query?.length > 0 ? `${root}?${query}` : root
-    } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {
-      protocol = 'https:'
-      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')
-      const pathParts = path.split('/')
-      if (pathParts[0] === 'ipfs') {
-        pathParts.shift()
-      }
-      path = pathParts.join('/')
-      const root = `${protocol}//${host}/${path}`
-      return query?.length > 0 ? `${root}?${query}` : root
-    } else {
-      return urlToCheck
-    }
-  } catch {
-    // const error = ex as Error
-    // console.error(`${error.name}:${error.message} [${urlToCheck}]`)
-    // console.log(error.stack)
-    return urlToCheck
-  }
-}

package/src/lib/getProviderFromEnv.ts

@@ -1,103 +0,0 @@
-import {
-  assertEx, isString, isUndefined,
-} from '@xylabs/sdk-js'
-import type { Provider } from 'ethers'
-import {
-  InfuraProvider, InfuraWebSocketProvider, JsonRpcProvider,
-  WebSocketProvider,
-} from 'ethers'
-
-export type ProviderSource = 'infura' | 'quicknode'
-export type ProviderType = 'rpc' | 'wss'
-
-export interface GetProvidersFromEnvOptions {
-  providerSource?: ProviderSource
-  providerType?: ProviderType
-}
-
-const createInfuraRpc = (chainId: number) => {
-  return (isString(process.env.INFURA_PROJECT_ID) && isString(process.env.INFURA_PROJECT_SECRET))
-    ? new InfuraProvider(chainId, process.env.INFURA_PROJECT_ID, process.env.INFURA_PROJECT_SECRET)
-    : undefined
-}
-
-const createInfuraWss = (chainId: number) => {
-  return isString(process.env.INFURA_PROJECT_ID) ? new InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined
-}
-
-const createQuicknodeWss = (chainId: number) => {
-  const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI
-  return isString(quickNodeWSSUri) ? new WebSocketProvider(quickNodeWSSUri, chainId) : undefined
-}
-
-const createQuicknodeRpc = (chainId: number) => {
-  const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI
-  return isString(quickNodeHttpsUri) ? new JsonRpcProvider(quickNodeHttpsUri, chainId) : undefined
-}
-
-export const getProviderFromEnv = (
-  chainId: number = 0x01,
-  { providerSource = 'infura', providerType = 'rpc' }: GetProvidersFromEnvOptions = {},
-): Provider => {
-  let provider: Provider | undefined = undefined
-
-  const quicknodeCases = () => {
-    switch (providerType) {
-      case 'rpc': {
-        provider = createQuicknodeRpc(chainId)
-        break
-      }
-      case 'wss': {
-        provider = createQuicknodeWss(chainId)
-        break
-      }
-    }
-  }
-
-  const infuraCases = () => {
-    switch (providerType) {
-      case 'wss': {
-        provider = createInfuraWss(chainId)
-        break
-      }
-      case 'rpc': {
-        provider = createInfuraRpc(chainId)
-        break
-      }
-    }
-  }
-
-  switch (providerSource ?? 'infura') {
-    case 'quicknode': {
-      quicknodeCases()
-      break
-    }
-    case 'infura': {
-      infuraCases()
-      break
-    }
-  }
-  if (isUndefined(provider)) {
-    provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId)
-  }
-  return assertEx(provider, () => `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`)
-}
-
-const providers: Record<string, Provider> = {}
-
-export const getSharedProviderFromEnv = (
-  chainId: number = 0x01,
-  options?: { providerSource?: ProviderSource; providerType?: ProviderType },
-): Provider => {
-  const key = `${chainId}:${options ? JSON.stringify(options) : 'default'}`
-  providers[key] = providers[key] ?? getProviderFromEnv(chainId, options)
-  return providers[key]
-}
-
-export const getProvidersFromEnv = (count: number = 1, chainId: number = 0x01, options: GetProvidersFromEnvOptions = {}): Provider[] => {
-  const result: Provider[] = []
-  for (let i = 0; i < count; i++) {
-    result.push(getProviderFromEnv(chainId, options))
-  }
-  return result
-}

package/src/lib/index.ts

@@ -1,2 +0,0 @@
-export * from './checkIpfsUrl.ts'
-export * from './getProviderFromEnv.ts'

package/src/model.ts

@@ -1,13 +0,0 @@
-import { asSchema, type Payload } from '@xyo-network/payload-model'
-
-export const EvmAddressSchema = asSchema('network.xyo.evm.address', true)
-export type EvmAddressSchema = typeof EvmAddressSchema
-
-export type EvmAddress = Payload<
-  {
-    address?: string
-    blockTag?: string | number
-    chainId?: number
-  },
-  EvmAddressSchema
->