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

package/dist/neutral/index.d.ts

@@ -1,24 +1,5 @@
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-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 EthereumGasEtherscanWitnessConfigSchema = 'network.xyo.blockchain.ethereum.gas.etherscan.witness.config';
-declare const EthereumGasEtherscanWitnessConfigSchema: EthereumGasEtherscanWitnessConfigSchema;
-
-type EthereumGasEtherscanWitnessConfig = WitnessConfig<{
-    apiKey: string;
-    schema: EthereumGasEtherscanWitnessConfigSchema;
-}>;
-
-declare class EthereumGasEtherscanWitness extends AbstractWitness<WitnessParams<AnyConfigSchema<EthereumGasEtherscanWitnessConfig>>> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const EthereumGasEtherscanPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<EthereumGasEtherscanWitness>;
-
-export { EthereumGasEtherscanPlugin, EthereumGasEtherscanWitness, EthereumGasEtherscanWitnessConfigSchema, EthereumGasEtherscanPlugin as default };
-export type { EthereumGasEtherscanWitnessConfig };
+export * from './Config.ts';
+export { EthereumGasEtherscanPlugin as default, EthereumGasEtherscanPlugin } 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/etherscan-ethereum-gas-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,23 +28,26 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.23",
-    "@xylabs/axios": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/etherscan-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-model": "^4.1.7"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/axios": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/etherscan-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-model": "^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/getGasFromEtherscan.spec.ts

@@ -0,0 +1,26 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { getGasFromEtherscan } from '../getGasFromEtherscan.ts'
+
+const apiKey = process.env.ETHERSCAN_API_KEY || ''
+
+describe('getGasFromEtherscan', () => {
+  test.skipIf(!apiKey)('returns prices', async () => {
+    const gas = await getGasFromEtherscan(apiKey)
+    expect(gas).toBeTruthy()
+    expect(gas.status).toEqual('1')
+    expect(gas.message).toEqual('OK')
+    expect(gas.result).toBeObject()
+    expect(gas.result.FastGasPrice).toBeString()
+    expect(gas.result.LastBlock).toBeString()
+    expect(gas.result.ProposeGasPrice).toBeString()
+    expect(gas.result.SafeGasPrice).toBeString()
+    expect(gas.result.gasUsedRatio).toBeString()
+    expect(gas.result.suggestBaseFee).toBeString()
+  })
+})

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,21 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { EthereumGasEtherscanPlugin } from '../Plugin.ts'
+import { EthereumGasEtherscanWitness } from '../Witness.ts'
+
+const apiKey = process.env.ETHERSCAN_API_KEY || ''
+
+describe('EthereumGasEtherscanPlugin', () => {
+  test.skipIf(!apiKey)('Add to Resolver', async () => {
+    const plugin = EthereumGasEtherscanPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin, { config: { apiKey, schema: EthereumGasEtherscanWitness.defaultConfigSchema } })
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.witness(plugin.set)).toBeObject()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,45 @@
+import '@xylabs/vitest-extended'
+
+import type { EthereumGasEtherscanPayload } from '@xyo-network/etherscan-ethereum-gas-payload-plugin'
+import { EthereumGasEtherscanSchema } from '@xyo-network/etherscan-ethereum-gas-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { EthereumGasEtherscanWitnessConfigSchema } from '../Schema.ts'
+import { EthereumGasEtherscanWitness } from '../Witness.ts'
+
+const apiKey = process.env.ETHERSCAN_API_KEY || ''
+
+describe('EthereumGasEtherscanWitness', () => {
+  test.skipIf(!apiKey)('returns observation', async () => {
+    const sut = await EthereumGasEtherscanWitness.create({
+      config: {
+        apiKey,
+        schema: EthereumGasEtherscanWitnessConfigSchema,
+      },
+    })
+    const [actual] = (await sut.observe()) as EthereumGasEtherscanPayload[]
+    expect(actual.result).toBeObject()
+    expect(actual.result.FastGasPrice).toBeString()
+    expect(actual.result.gasUsedRatio).toBeString()
+    expect(actual.result.LastBlock).toBeString()
+    expect(actual.result.ProposeGasPrice).toBeString()
+    expect(actual.result.SafeGasPrice).toBeString()
+    expect(actual.result.suggestBaseFee).toBeString()
+
+    expect(actual.timestamp).toBeNumber()
+    expect(actual.schema).toBe(EthereumGasEtherscanSchema)
+
+    const answerWrapper = PayloadWrapper.wrap(actual)
+    expect(await answerWrapper.getValid()).toBe(true)
+  })
+
+  /* describe('create', () => {
+    it('throws if no params provided', async () => {
+      await expect(EthereumGasEtherscanWitness.create()).toReject()
+    })
+  }) */
+})

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