@xyo-network/blocknative-ethereum-gas-plugin 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,24 +1,5 @@
-import { TimestampWitnessConfig, TimestampWitnessParams } from '@xyo-network/witness-timestamp';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type EthereumGasBlocknativeWitnessConfigSchema = 'network.xyo.blockchain.ethereum.gas.blocknative.witness.config';
-declare const EthereumGasBlocknativeWitnessConfigSchema: EthereumGasBlocknativeWitnessConfigSchema;
-
-type EthereumGasBlocknativeWitnessConfig = TimestampWitnessConfig<{
-    schema: EthereumGasBlocknativeWitnessConfigSchema;
-}>;
-
-type EthereumGasBlocknativeWitnessParams = TimestampWitnessParams<AnyConfigSchema<EthereumGasBlocknativeWitnessConfig>>;
-declare class EthereumGasBlocknativeWitness extends AbstractWitness<EthereumGasBlocknativeWitnessParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const EthereumGasBlocknativePlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<EthereumGasBlocknativeWitness>;
-
-export { EthereumGasBlocknativePlugin, EthereumGasBlocknativeWitness, EthereumGasBlocknativeWitnessConfigSchema, EthereumGasBlocknativePlugin as default };
-export type { EthereumGasBlocknativeWitnessConfig, EthereumGasBlocknativeWitnessParams };
+export * from './Config.ts';
+export { EthereumGasBlocknativePlugin as default, EthereumGasBlocknativePlugin } from './Plugin.ts';
+export * from './Schema.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/blocknative-ethereum-gas-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,22 +28,25 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/axios": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/blocknative-ethereum-gas-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-builder": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7",
-    "@xyo-network/witness-timestamp": "^4.1.7"
+    "@xylabs/axios": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/blocknative-ethereum-gas-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/witness-timestamp": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/payload-wrapper": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/spec/getGasFromBlocknative.spec.ts

@@ -0,0 +1,46 @@
+// import { PendingBlockNumber } from '@xyo-network/blocknative-ethereum-gas-payload-plugin'
+
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { getGasFromBlocknative } from '../getGasFromBlocknative.ts'
+
+describe('getGasFromBlocknative', () => {
+  test('returns prices', async () => {
+    const result = await getGasFromBlocknative()
+    expect(result).toBeObject()
+    expect(result?.blockPrices).toBeArrayOfSize(1)
+    for (let blockPrice of result.blockPrices) {
+      expect(blockPrice.baseFeePerGas).toBeNumber()
+      expect(blockPrice.blockNumber).toBeNumber()
+      expect(blockPrice.estimatedPrices).toBeArrayOfSize(5)
+      for (let estimatedPrice of blockPrice.estimatedPrices) {
+        expect(estimatedPrice?.confidence).toBeNumber()
+        expect(estimatedPrice?.maxFeePerGas).toBeNumber()
+        expect(estimatedPrice?.maxPriorityFeePerGas).toBeNumber()
+        expect(estimatedPrice?.price).toBeNumber()
+      }
+      expect(blockPrice.estimatedTransactionCount).toBeNumber()
+    }
+    /* expect(result?.estimatedBaseFees).toBeArrayOfSize(5)
+    for (let index = 0; index < result?.estimatedBaseFees.length; index++) {
+      const blockNumber = `pending+${index + 1}` as PendingBlockNumber
+      const pendingBlockInfo = result.estimatedBaseFees?.[index]?.[blockNumber]
+      expect(pendingBlockInfo.length).toBeGreaterThan(0)
+      const pendingBlock = pendingBlockInfo?.[0]
+      expect(pendingBlock).toBeObject()
+      expect(pendingBlock?.baseFee).toBeNumber()
+      expect(pendingBlock?.confidence).toBeNumber()
+    } */
+    expect(result?.currentBlockNumber).toBeNumber()
+    expect(result?.maxPrice).toBeNumber()
+    expect(result?.msSinceLastBlock).toBeNumber()
+    expect(result?.network).toEqual('main')
+    expect(result?.system).toEqual('ethereum')
+    expect(result?.unit).toEqual('gwei')
+  })
+})

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,19 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { EthereumGasBlocknativePlugin } from '../Plugin.ts'
+import { EthereumGasBlocknativeWitness } from '../Witness.ts'
+
+describe('EthereumGasBlocknativePlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = EthereumGasBlocknativePlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin, { config: { schema: EthereumGasBlocknativeWitness.defaultConfigSchema } })
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.witness(plugin.set)).toBeObject()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,24 @@
+import '@xylabs/vitest-extended'
+
+import { EthereumGasBlocknativeSchema } from '@xyo-network/blocknative-ethereum-gas-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { EthereumGasBlocknativeWitnessConfigSchema } from '../Schema.ts'
+import { EthereumGasBlocknativeWitness } from '../Witness.ts'
+
+describe('EthereumGasBlocknativeWitness', () => {
+  it('returns observation', async () => {
+    const sut = await EthereumGasBlocknativeWitness.create({
+      account: 'random',
+      config: { schema: EthereumGasBlocknativeWitnessConfigSchema },
+    })
+    const [actual] = await sut.observe()
+    expect(actual.schema).toBe(EthereumGasBlocknativeSchema)
+    const answerWrapper = PayloadWrapper.wrap(actual)
+    expect(await answerWrapper.getValid()).toBe(true)
+  })
+})

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: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config