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

package/dist/neutral/index.d.ts

@@ -1,29 +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';
-import { Provider } from 'ethers';
-
-type EthereumGasEthersWitnessConfigSchema = 'network.xyo.blockchain.ethereum.gas.ethers.witness.config';
-declare const EthereumGasEthersWitnessConfigSchema: EthereumGasEthersWitnessConfigSchema;
-
-type EthereumGasEthersWitnessConfig = WitnessConfig<{
-    schema: EthereumGasEthersWitnessConfigSchema;
-}>;
-
-interface EthereumGasEthersWitnessParams extends WitnessParams<AnyConfigSchema<EthereumGasEthersWitnessConfig>> {
-    provider?: Provider;
-}
-declare class EthereumGasEthersWitness<TParams extends EthereumGasEthersWitnessParams = EthereumGasEthersWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    private _provider?;
-    protected get provider(): Provider | undefined;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const EthereumGasEthersPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<EthereumGasEthersWitness<EthereumGasEthersWitnessParams>>;
-
-export { EthereumGasEthersPlugin, EthereumGasEthersWitness, EthereumGasEthersWitnessConfigSchema, EthereumGasEthersPlugin as default };
-export type { EthereumGasEthersWitnessConfig, EthereumGasEthersWitnessParams };
+export * from './Config.ts';
+export { EthereumGasEthersPlugin as default, EthereumGasEthersPlugin } 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/ethers-ethereum-gas-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,24 +28,27 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/ethers-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",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/ethers-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",
     "ethers": "^6.15.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",
-    "@xyo-network/witness-blockchain-abstract": "^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",
+    "@xyo-network/witness-blockchain-abstract": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/spec/getGasFromEthers.spec.ts

@@ -0,0 +1,23 @@
+import '@xylabs/vitest-extended'
+
+import { getProviderFromEnv } from '@xyo-network/witness-blockchain-abstract'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { getGasFromEthers } from '../getGasFromEthers.ts'
+
+const projectId = process.env.INFURA_PROJECT_ID || ''
+const projectSecret = process.env.INFURA_PROJECT_SECRET || ''
+
+describe('getGasFromEthers', () => {
+  test.skipIf(!projectId || !projectSecret)('returns prices', async () => {
+    const provider = getProviderFromEnv()
+    const result = await getGasFromEthers(provider)
+    expect(result).toBeObject()
+    expect(result.gasPrice).toBeNumber()
+    expect(result.maxFeePerGas).toBeNumber()
+    expect(result.maxPriorityFeePerGas).toBeNumber()
+  })
+})

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,27 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import { getProviderFromEnv } from '@xyo-network/witness-blockchain-abstract'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { EthereumGasEthersPlugin } from '../Plugin.ts'
+import { EthereumGasEthersWitness } from '../Witness.ts'
+
+const projectId = process.env.INFURA_PROJECT_ID || ''
+const projectSecret = process.env.INFURA_PROJECT_SECRET || ''
+
+describe('EthereumGasEthersPlugin', () => {
+  test.skipIf(!(projectId && projectSecret))('Add to Resolver', async () => {
+    const provider = getProviderFromEnv()
+    const plugin = EthereumGasEthersPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin, {
+      config: { schema: EthereumGasEthersWitness.defaultConfigSchema },
+      provider,
+    })
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.witness(plugin.set)).toBeObject()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,40 @@
+import type { EthereumGasEthersPayload } from '@xyo-network/ethers-ethereum-gas-payload-plugin'
+import { EthereumGasEthersSchema } from '@xyo-network/ethers-ethereum-gas-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import { getProviderFromEnv } from '@xyo-network/witness-blockchain-abstract'
+
+import { EthereumGasEthersWitnessConfigSchema } from '../Schema.ts'
+import { EthereumGasEthersWitness } from '../Witness.ts'
+
+const projectId = process.env.INFURA_PROJECT_ID || ''
+const projectSecret = process.env.INFURA_PROJECT_SECRET || ''
+
+import '@xylabs/vitest-extended'
+
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+/**
+ * @group crypto
+ * @group slow
+ */
+
+describe('EthereumGasEthersWitness', () => {
+  test.skipIf(!projectId || !projectSecret)('returns observation', async () => {
+    const provider = getProviderFromEnv()
+    const sut = await EthereumGasEthersWitness.create({
+      account: 'random',
+      config: { schema: EthereumGasEthersWitnessConfigSchema },
+      provider,
+    })
+    const observed = await sut.observe()
+    const actual = observed.find(isPayloadOfSchemaType<EthereumGasEthersPayload>(EthereumGasEthersSchema))
+    expect((actual as EthereumGasEthersPayload).gasPrice).toBeNumber()
+    expect(actual?.schema).toBe(EthereumGasEthersSchema)
+    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: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config