@xyo-network/evm-events-witness 4.2.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/evm-events-witness",
-  "version": "4.2.0",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,18 +28,22 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.1",
-    "@xylabs/exists": "^4.15.1",
-    "@xylabs/hex": "^4.15.1",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/witness-evm-abstract": "^4.3.0",
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/exists": "^5.0.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/witness-evm-abstract": "^5.0.0",
     "ethers": "^6.15.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.1",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
     "@xyo-network/open-zeppelin-typechain": "^3.5.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"

package/src/spec/Witness.spec.ts

@@ -0,0 +1,44 @@
+import '@xylabs/vitest-extended'
+
+import { ERC1155__factory } from '@xyo-network/open-zeppelin-typechain'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import { getProvidersFromEnv } from '@xyo-network/witness-evm-abstract'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { EvmEventsWitnessConfigSchema } from '../model.ts'
+import type { EvmEvent, EvmEvents } from '../Payload.ts'
+import { EvmEventSchema, EvmEventsSchema } from '../Payload.ts'
+import { EvmEventsWitness } from '../Witness.ts'
+
+const validateObservation = (observation: Payload[]) => {
+  const results = observation.filter(isPayloadOfSchemaType<EvmEvent>(EvmEventSchema))
+  expect(results.length).toBeGreaterThan(0)
+  expect(observation.length).toEqual(results.length)
+}
+
+describe.skipIf(!process.env.INFURA_PROJECT_ID).skip('EvmEventsWitness', () => {
+  const address = '0x6811f2f20c42f42656a3c8623ad5e9461b83f719' // ParallelPlanetFall
+  const eventName = 'TransferSingle'
+  describe('observe', () => {
+    describe('with no address or chainId in query', () => {
+      it('uses values from config', async () => {
+        const witness = await EvmEventsWitness.create({
+          account: 'random',
+          config: {
+            abi: ERC1155__factory.abi, fromBlock: 19_180_000, schema: EvmEventsWitnessConfigSchema,
+          },
+          providers: getProvidersFromEnv,
+        })
+        const call: EvmEvents = {
+          address, eventName, schema: EvmEventsSchema,
+        }
+        const observation = await witness.observe([call])
+        validateObservation(observation)
+      }, 20_000)
+    })
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config