@xyo-network/etherchain-ethereum-gas-v2-plugin 4.1.1 → 5.0.0

package/dist/browser/index.d.ts

@@ -1,26 +1,5 @@
-import * as _xyo_network_witness_model from '@xyo-network/witness-model';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import * as _xyo_network_module_model from '@xyo-network/module-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type EthereumGasEtherchainV2WitnessConfigSchema = 'network.xyo.blockchain.ethereum.gas.etherchain.v2.witness.config';
-declare const EthereumGasEtherchainV2WitnessConfigSchema: EthereumGasEtherchainV2WitnessConfigSchema;
-
-type EthereumGasEtherchainV2WitnessConfig = WitnessConfig<{
-    schema: EthereumGasEtherchainV2WitnessConfigSchema;
-}>;
-
-declare const EthereumGasEtherchainV2Plugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<_xyo_network_witness_model.WitnessModule<_xyo_network_witness_model.WitnessParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_witness_model.WitnessConfig>>, _xyo_network_witness_model.WitnessModuleEventData>>;
-
-type EtherchainEthereumGasWitnessV2Params = WitnessParams<AnyConfigSchema<EthereumGasEtherchainV2WitnessConfig>>;
-declare class EtherchainEthereumGasWitnessV2 extends AbstractWitness<EtherchainEthereumGasWitnessV2Params> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-export { EtherchainEthereumGasWitnessV2, EthereumGasEtherchainV2Plugin, EthereumGasEtherchainV2WitnessConfigSchema, EthereumGasEtherchainV2Plugin as default };
-export type { EtherchainEthereumGasWitnessV2Params, EthereumGasEtherchainV2WitnessConfig };
+export * from './Config.ts';
+export { EthereumGasEtherchainV2Plugin as default, EthereumGasEtherchainV2Plugin } from './Plugin.ts';
+export * from './Schema.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.d.ts

@@ -1,26 +1,5 @@
-import * as _xyo_network_witness_model from '@xyo-network/witness-model';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import * as _xyo_network_module_model from '@xyo-network/module-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type EthereumGasEtherchainV2WitnessConfigSchema = 'network.xyo.blockchain.ethereum.gas.etherchain.v2.witness.config';
-declare const EthereumGasEtherchainV2WitnessConfigSchema: EthereumGasEtherchainV2WitnessConfigSchema;
-
-type EthereumGasEtherchainV2WitnessConfig = WitnessConfig<{
-    schema: EthereumGasEtherchainV2WitnessConfigSchema;
-}>;
-
-declare const EthereumGasEtherchainV2Plugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<_xyo_network_witness_model.WitnessModule<_xyo_network_witness_model.WitnessParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_witness_model.WitnessConfig>>, _xyo_network_witness_model.WitnessModuleEventData>>;
-
-type EtherchainEthereumGasWitnessV2Params = WitnessParams<AnyConfigSchema<EthereumGasEtherchainV2WitnessConfig>>;
-declare class EtherchainEthereumGasWitnessV2 extends AbstractWitness<EtherchainEthereumGasWitnessV2Params> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-export { EtherchainEthereumGasWitnessV2, EthereumGasEtherchainV2Plugin, EthereumGasEtherchainV2WitnessConfigSchema, EthereumGasEtherchainV2Plugin as default };
-export type { EtherchainEthereumGasWitnessV2Params, EthereumGasEtherchainV2WitnessConfig };
+export * from './Config.ts';
+export { EthereumGasEtherchainV2Plugin as default, EthereumGasEtherchainV2Plugin } from './Plugin.ts';
+export * from './Schema.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts

@@ -1,26 +1,5 @@
-import * as _xyo_network_witness_model from '@xyo-network/witness-model';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import * as _xyo_network_module_model from '@xyo-network/module-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type EthereumGasEtherchainV2WitnessConfigSchema = 'network.xyo.blockchain.ethereum.gas.etherchain.v2.witness.config';
-declare const EthereumGasEtherchainV2WitnessConfigSchema: EthereumGasEtherchainV2WitnessConfigSchema;
-
-type EthereumGasEtherchainV2WitnessConfig = WitnessConfig<{
-    schema: EthereumGasEtherchainV2WitnessConfigSchema;
-}>;
-
-declare const EthereumGasEtherchainV2Plugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<_xyo_network_witness_model.WitnessModule<_xyo_network_witness_model.WitnessParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_witness_model.WitnessConfig>>, _xyo_network_witness_model.WitnessModuleEventData>>;
-
-type EtherchainEthereumGasWitnessV2Params = WitnessParams<AnyConfigSchema<EthereumGasEtherchainV2WitnessConfig>>;
-declare class EtherchainEthereumGasWitnessV2 extends AbstractWitness<EtherchainEthereumGasWitnessV2Params> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-export { EtherchainEthereumGasWitnessV2, EthereumGasEtherchainV2Plugin, EthereumGasEtherchainV2WitnessConfigSchema, EthereumGasEtherchainV2Plugin as default };
-export type { EtherchainEthereumGasWitnessV2Params, EthereumGasEtherchainV2WitnessConfig };
+export * from './Config.ts';
+export { EthereumGasEtherchainV2Plugin as default, EthereumGasEtherchainV2Plugin } 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/etherchain-ethereum-gas-v2-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,21 +28,24 @@
   },
   "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/etherchain-ethereum-gas-v2-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^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/axios": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/etherchain-ethereum-gas-v2-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^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/getV2GasFromEtherchain.spec.ts

@@ -0,0 +1,23 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { getV2GasFromEtherchain } from '../getV2GasFromEtherchain.ts'
+
+describe('getV2GasFromEtherchain', () => {
+  test('returns prices', async () => {
+    const gas = await getV2GasFromEtherchain()
+    expect(gas).toBeObject()
+    expect(gas.code).toBeNumber()
+    expect(gas.data).toBeObject()
+    expect(gas.data.fast).toBeNumber()
+    expect(gas.data.priceUSD).toBeNumber()
+    expect(gas.data.rapid).toBeNumber()
+    expect(gas.data.slow).toBeNumber()
+    expect(gas.data.standard).toBeNumber()
+    expect(gas.data.timestamp).toBeNumber()
+  })
+})

package/src/spec/Plugin.spec.ts

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

package/src/spec/Witness.spec.ts

@@ -0,0 +1,42 @@
+import '@xylabs/vitest-extended'
+
+import type { EthereumGasEtherchainV2Payload } from '@xyo-network/etherchain-ethereum-gas-v2-payload-plugin'
+import { EthereumGasEtherchainV2Schema } from '@xyo-network/etherchain-ethereum-gas-v2-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { EthereumGasEtherchainV2WitnessConfigSchema } from '../Schema.ts'
+import { EtherchainEthereumGasWitnessV2 } from '../Witness.ts'
+
+describe('EtherchainEthereumGasWitnessV2', () => {
+  test('returns observation', async () => {
+    const sut = await EtherchainEthereumGasWitnessV2.create({
+      account: 'random',
+      config: { schema: EthereumGasEtherchainV2WitnessConfigSchema },
+    })
+    const [actual] = (await sut.observe()) as EthereumGasEtherchainV2Payload[]
+    expect(actual).toBeObject()
+    expect(actual.code).toBeNumber()
+    expect(actual.data).toBeObject()
+    expect(actual.timestamp).toBeNumber()
+    expect(actual.schema).toBe(EthereumGasEtherchainV2Schema)
+
+    const answerWrapper = PayloadWrapper.wrap(actual)
+    expect(await answerWrapper.getValid()).toBe(true)
+  })
+  test('returns observation [no config]', async () => {
+    const sut = await EtherchainEthereumGasWitnessV2.create({ account: 'random' })
+    const [actual] = (await sut.observe()) as EthereumGasEtherchainV2Payload[]
+    expect(actual).toBeObject()
+    expect(actual.code).toBeNumber()
+    expect(actual.data).toBeObject()
+    expect(actual.timestamp).toBeNumber()
+    expect(actual.schema).toBe(EthereumGasEtherchainV2Schema)
+
+    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"
-}