@xyo-network/gas-price-plugin 2.42.0

package/src/lib/transforms/transformGasFromEtherchainV2.spec.ts

@@ -0,0 +1,34 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { sampleEtherchainGasV2 } from '../../test'
+import { transformGasFromEtherchainV2 } from './transformGasFromEtherchainV2'
+
+describe('transformGasFromEtherchainV2', () => {
+  it('returns values in the expected format', () => {
+    const result = transformGasFromEtherchainV2(sampleEtherchainGasV2)
+    expect(result).toBeObject()
+    expect(result.baseFee).toBeUndefined()
+    expect(result.feePerGas).toBeObject()
+    expect(result.feePerGas.low).toBeNumber()
+    expect(result.feePerGas.medium).toBeNumber()
+    expect(result.feePerGas.high).toBeNumber()
+    expect(result.feePerGas.veryHigh).toBeNumber()
+    expect(result.priorityFeePerGas).toBeObject()
+    expect(result.priorityFeePerGas.low).toBeUndefined()
+    expect(result.priorityFeePerGas.medium).toBeUndefined()
+    expect(result.priorityFeePerGas.high).toBeUndefined()
+    expect(result.priorityFeePerGas.veryHigh).toBeUndefined()
+  })
+  it('matches expected output', () => {
+    const result = transformGasFromEtherchainV2(sampleEtherchainGasV2)
+    expect(result).toMatchObject({
+      baseFee: undefined,
+      feePerGas: {
+        low: 11.2,
+        medium: 12.0,
+        high: 19.80304733,
+        veryHigh: 29.71428617,
+      },
+      priorityFeePerGas: {},
+    })
+  })
+})

package/src/lib/transforms/transformGasFromEtherchainV2.ts

@@ -0,0 +1,18 @@
+import { XyoEthereumGasEtherchainV2Payload } from '@xyo-network/etherchain-gas-ethereum-blockchain-payload-plugins'
+import { FeeData, FeePerGas } from '@xyo-network/gas-price-payload-plugin'
+
+const getFeePerGas = (payload: XyoEthereumGasEtherchainV2Payload): Partial<FeePerGas> => {
+  const { slow, standard, fast, rapid } = payload.data
+  const low = slow / 1_000_000_000
+  const medium = standard / 1_000_000_000
+  const high = fast / 1_000_000_000
+  const veryHigh = rapid / 1_000_000_000
+  return { high, low, medium, veryHigh }
+}
+
+export const transformGasFromEtherchainV2 = (payload: XyoEthereumGasEtherchainV2Payload): FeeData => {
+  const baseFee = undefined
+  const feePerGas = getFeePerGas(payload)
+  const priorityFeePerGas = {}
+  return { baseFee, feePerGas, priorityFeePerGas }
+}

package/src/lib/transforms/transformGasFromEthers.spec.ts

@@ -0,0 +1,33 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { sampleEthersGas } from '../../test'
+import { transformGasFromEthers } from './transformGasFromEthers'
+
+describe('transformGasFromEthers', () => {
+  it('returns values in the expected format', () => {
+    const result = transformGasFromEthers(sampleEthersGas)
+    expect(result).toBeObject()
+    expect(result.baseFee).toBeNumber()
+    expect(result.feePerGas).toBeObject()
+    expect(result.feePerGas.low).toBeUndefined()
+    expect(result.feePerGas.medium).toBeUndefined()
+    expect(result.feePerGas.high).toBeNumber()
+    expect(result.feePerGas.veryHigh).toBeUndefined()
+    expect(result.priorityFeePerGas).toBeObject()
+    expect(result.priorityFeePerGas.low).toBeUndefined()
+    expect(result.priorityFeePerGas.medium).toBeUndefined()
+    expect(result.priorityFeePerGas.high).toBeNumber()
+    expect(result.priorityFeePerGas.veryHigh).toBeUndefined()
+  })
+  it('matches expected output', () => {
+    const result = transformGasFromEthers(sampleEthersGas)
+    expect(result).toMatchObject({
+      baseFee: 13.447862081,
+      feePerGas: {
+        high: 28.395724162,
+      },
+      priorityFeePerGas: {
+        high: 1.5,
+      },
+    })
+  })
+})

package/src/lib/transforms/transformGasFromEthers.ts

@@ -0,0 +1,26 @@
+import { XyoEthereumGasEthersPayload } from '@xyo-network/ethers-ethereum-gas-payload-plugin'
+import { FeeData, FeePerGas, PriorityFeePerGas } from '@xyo-network/gas-price-payload-plugin'
+
+const getBaseFee = (payload: XyoEthereumGasEthersPayload): number | undefined => {
+  const { lastBaseFeePerGas } = payload
+  return lastBaseFeePerGas ? lastBaseFeePerGas / 1_000_000_000 : undefined
+}
+
+const getFeePerGas = (payload: XyoEthereumGasEthersPayload): Partial<FeePerGas> => {
+  const { maxFeePerGas } = payload
+  const high = maxFeePerGas ? maxFeePerGas / 1_000_000_000 : undefined
+  return { high }
+}
+
+const getPriorityFeePerGas = (payload: XyoEthereumGasEthersPayload): Partial<PriorityFeePerGas> => {
+  const { maxPriorityFeePerGas } = payload
+  const high = maxPriorityFeePerGas ? maxPriorityFeePerGas / 1_000_000_000 : undefined
+  return { high }
+}
+
+export const transformGasFromEthers = (payload: XyoEthereumGasEthersPayload): FeeData => {
+  const baseFee = getBaseFee(payload)
+  const feePerGas = getFeePerGas(payload)
+  const priorityFeePerGas = getPriorityFeePerGas(payload)
+  return { baseFee, feePerGas, priorityFeePerGas }
+}

package/src/lib/transforms/transformGasFromEtherscan.spec.ts

@@ -0,0 +1,34 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { sampleEtherscanGas } from '../../test'
+import { transformGasFromEtherscan } from './transformGasFromEtherscan'
+
+describe('transformGasFromEtherscan', () => {
+  it('returns values in the expected format', () => {
+    const result = transformGasFromEtherscan(sampleEtherscanGas)
+    expect(result).toBeObject()
+    expect(result.baseFee).toBeNumber()
+    expect(result.feePerGas).toBeObject()
+    expect(result.feePerGas.low).toBeNumber()
+    expect(result.feePerGas.medium).toBeNumber()
+    expect(result.feePerGas.high).toBeNumber()
+    expect(result.feePerGas.veryHigh).toBeNumber()
+    expect(result.priorityFeePerGas).toBeObject()
+    expect(result.priorityFeePerGas.low).toBeUndefined()
+    expect(result.priorityFeePerGas.medium).toBeUndefined()
+    expect(result.priorityFeePerGas.high).toBeUndefined()
+    expect(result.priorityFeePerGas.veryHigh).toBeUndefined()
+  })
+  it('matches expected output', () => {
+    const result = transformGasFromEtherscan(sampleEtherscanGas)
+    expect(result).toMatchObject({
+      baseFee: 27.616709247,
+      feePerGas: {
+        low: 28,
+        medium: 29,
+        high: 30,
+        veryHigh: 31,
+      },
+      priorityFeePerGas: {},
+    })
+  })
+})

package/src/lib/transforms/transformGasFromEtherscan.ts

@@ -0,0 +1,28 @@
+import { XyoEthereumGasEtherscanPayload } from '@xyo-network/etherscan-ethereum-gas-payload-plugin'
+import { FeeData, FeePerGas } from '@xyo-network/gas-price-payload-plugin'
+import { linear } from 'regression'
+
+const getBaseFee = (payload: XyoEthereumGasEtherscanPayload): number | undefined => {
+  const { suggestBaseFee } = payload.result
+  return parseFloat(suggestBaseFee)
+}
+
+const getFeePerGas = (payload: XyoEthereumGasEtherscanPayload): Partial<FeePerGas> => {
+  const { FastGasPrice, ProposeGasPrice, SafeGasPrice } = payload.result
+  const low = parseFloat(SafeGasPrice)
+  const medium = parseFloat(ProposeGasPrice)
+  const high = parseFloat(FastGasPrice)
+  const veryHigh = linear([
+    [0, low],
+    [1, medium],
+    [2, high],
+  ]).predict(3)[1]
+  return { high, low, medium, veryHigh }
+}
+
+export const transformGasFromEtherscan = (payload: XyoEthereumGasEtherscanPayload): FeeData => {
+  const baseFee = getBaseFee(payload)
+  const feePerGas = getFeePerGas(payload)
+  const priorityFeePerGas = {}
+  return { baseFee, feePerGas, priorityFeePerGas }
+}

package/src/lib/transforms/transformGasFromEthgasstation.spec.ts

@@ -0,0 +1,39 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { sampleEthgasstationGas } from '../../test'
+import { transformGasFromEthgasstation } from './transformGasFromEthgasstation'
+
+describe('transformGasFromEthgasstation', () => {
+  it('returns values in the expected format', () => {
+    const result = transformGasFromEthgasstation(sampleEthgasstationGas)
+    expect(result).toBeObject()
+    expect(result.baseFee).toBeNumber()
+    expect(result.feePerGas).toBeObject()
+    expect(result.feePerGas.low).toBeNumber()
+    expect(result.feePerGas.medium).toBeNumber()
+    expect(result.feePerGas.high).toBeNumber()
+    expect(result.feePerGas.veryHigh).toBeNumber()
+    expect(result.priorityFeePerGas).toBeObject()
+    expect(result.priorityFeePerGas.low).toBeNumber()
+    expect(result.priorityFeePerGas.medium).toBeNumber()
+    expect(result.priorityFeePerGas.high).toBeNumber()
+    expect(result.priorityFeePerGas.veryHigh).toBeNumber()
+  })
+  it('matches expected output', () => {
+    const result = transformGasFromEthgasstation(sampleEthgasstationGas)
+    expect(result).toMatchObject({
+      baseFee: 10,
+      feePerGas: {
+        low: 11.33,
+        medium: 12,
+        high: 12,
+        veryHigh: 13,
+      },
+      priorityFeePerGas: {
+        low: 2,
+        medium: 2,
+        high: 2,
+        veryHigh: 2,
+      },
+    })
+  })
+})

package/src/lib/transforms/transformGasFromEthgasstation.ts

@@ -0,0 +1,38 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { XyoEthereumGasEthgasstationPayload } from '@xyo-network/ethgasstation-ethereum-gas-payload-plugin'
+import { FeeData, FeePerGas, PriorityFeePerGas } from '@xyo-network/gas-price-payload-plugin'
+import { linear } from 'regression'
+
+const getBaseFee = (payload: XyoEthereumGasEthgasstationPayload): number | undefined => {
+  const { baseFee } = payload
+  return baseFee
+}
+
+const getFeePerGas = (payload: XyoEthereumGasEthgasstationPayload): Partial<FeePerGas> => {
+  const { standard: medium, fast: high, instant: veryHigh } = payload.gasPrice
+  const trend = linear([
+    [1, medium],
+    [2, high],
+    [3, veryHigh],
+  ])
+  const low = trend.predict(0)[1]
+  return { low, medium, high, veryHigh }
+}
+
+const getPriorityFeePerGas = (payload: XyoEthereumGasEthgasstationPayload): Partial<PriorityFeePerGas> => {
+  const { standard: medium, fast: high, instant: veryHigh } = payload.priorityFee
+  const trend = linear([
+    [1, medium],
+    [2, high],
+    [3, veryHigh],
+  ])
+  const low = trend.predict(0)[1]
+  return { low, medium, high, veryHigh }
+}
+
+export const transformGasFromEthgasstation = (payload: XyoEthereumGasEthgasstationPayload): FeeData => {
+  const baseFee = getBaseFee(payload)
+  const feePerGas = getFeePerGas(payload)
+  const priorityFeePerGas = getPriorityFeePerGas(payload)
+  return { baseFee, feePerGas, priorityFeePerGas }
+}

package/src/test/index.ts

@@ -0,0 +1,6 @@
+export * from './sampleBlocknativeGas'
+export * from './sampleEtherchainGasV1'
+export * from './sampleEtherchainGasV2'
+export * from './sampleEtherscanGas'
+export * from './sampleEthersGas'
+export * from './sampleEthgasstationGas'

package/src/test/sampleBlocknativeGas.ts

@@ -0,0 +1,97 @@
+import {
+  EstimatedBaseFee,
+  XyoEthereumGasBlocknativePayload,
+  XyoEthereumGasBlocknativeSchema,
+} from '@xyo-network/blocknative-ethereum-gas-payload-plugin'
+
+export const sampleBlocknativeGas: XyoEthereumGasBlocknativePayload = {
+  blockPrices: [
+    {
+      baseFeePerGas: 13.691764456,
+      blockNumber: 16028191,
+      estimatedPrices: [
+        {
+          confidence: 99,
+          maxFeePerGas: 22.04,
+          maxPriorityFeePerGas: 1.09,
+          price: 14,
+        },
+        {
+          confidence: 95,
+          maxFeePerGas: 21.58,
+          maxPriorityFeePerGas: 0.63,
+          price: 14,
+        },
+        {
+          confidence: 90,
+          maxFeePerGas: 21.25,
+          maxPriorityFeePerGas: 0.3,
+          price: 13,
+        },
+        {
+          confidence: 80,
+          maxFeePerGas: 21.16,
+          maxPriorityFeePerGas: 0.21,
+          price: 13,
+        },
+        {
+          confidence: 70,
+          maxFeePerGas: 21.12,
+          maxPriorityFeePerGas: 0.17,
+          price: 13,
+        },
+      ],
+      estimatedTransactionCount: 69,
+    },
+  ],
+  currentBlockNumber: 16028190,
+  estimatedBaseFees: [
+    {
+      'pending+1': [
+        {
+          baseFee: 15.41,
+          confidence: 99,
+        },
+      ],
+    },
+    {
+      'pending+2': [
+        {
+          baseFee: 17.32,
+          confidence: 99,
+        },
+      ],
+    },
+    {
+      'pending+3': [
+        {
+          baseFee: 19.17,
+          confidence: 99,
+        },
+      ],
+    },
+    {
+      'pending+4': [
+        {
+          baseFee: 20.12,
+          confidence: 99,
+        },
+      ],
+    },
+    {
+      'pending+5': [
+        {
+          baseFee: 20.95,
+          confidence: 99,
+        },
+      ],
+    },
+  ] as unknown as EstimatedBaseFee[],
+  maxPrice: 36,
+  msSinceLastBlock: 3643,
+  network: 'main',
+  schema: XyoEthereumGasBlocknativeSchema,
+  system: 'ethereum',
+  timestamp: 1668697958837,
+  unit: 'gwei',
+}

package/src/test/sampleEtherchainGasV1.ts

@@ -0,0 +1,12 @@
+import { XyoEthereumGasEtherchainV1Payload, XyoEthereumGasEtherchainV1Schema } from '@xyo-network/etherchain-gas-ethereum-blockchain-payload-plugins'
+
+export const sampleEtherchainGasV1: XyoEthereumGasEtherchainV1Payload = {
+  currentBaseFee: 19.5,
+  fast: 0.3,
+  fastest: 1.5,
+  recommendedBaseFee: 39.6,
+  safeLow: 0.1,
+  schema: XyoEthereumGasEtherchainV1Schema,
+  standard: 0.2,
+  timestamp: 1668621360784,
+}

package/src/test/sampleEtherchainGasV2.ts

@@ -0,0 +1,15 @@
+import { XyoEthereumGasEtherchainV2Payload, XyoEthereumGasEtherchainV2Schema } from '@xyo-network/etherchain-gas-ethereum-blockchain-payload-plugins'
+
+export const sampleEtherchainGasV2: XyoEthereumGasEtherchainV2Payload = {
+  code: 200,
+  data: {
+    fast: 19803047330,
+    priceUSD: 1195.77,
+    rapid: 29714286170,
+    slow: 11200000000,
+    standard: 12000000000,
+    timestamp: 1668621234096,
+  },
+  schema: XyoEthereumGasEtherchainV2Schema,
+  timestamp: 1668621240790,
+}

package/src/test/sampleEthersGas.ts

@@ -0,0 +1,10 @@
+import { XyoEthereumGasEthersPayload, XyoEthereumGasEthersSchema } from '@xyo-network/ethers-ethereum-gas-payload-plugin'
+
+export const sampleEthersGas: XyoEthereumGasEthersPayload = {
+  gasPrice: 13547863640,
+  lastBaseFeePerGas: 13447862081,
+  maxFeePerGas: 28395724162,
+  maxPriorityFeePerGas: 1500000000,
+  schema: XyoEthereumGasEthersSchema,
+  timestamp: 1668697958837,
+}

package/src/test/sampleEtherscanGas.ts

@@ -0,0 +1,16 @@
+import { XyoEthereumGasEtherscanPayload, XyoEthereumGasEtherscanSchema } from '@xyo-network/etherscan-ethereum-gas-payload-plugin'
+
+export const sampleEtherscanGas: XyoEthereumGasEtherscanPayload = {
+  message: 'OK',
+  result: {
+    FastGasPrice: '30',
+    LastBlock: '15990556',
+    ProposeGasPrice: '29',
+    SafeGasPrice: '28',
+    gasUsedRatio: '0.416266666666667,0.5672862,0.540979033333333,0.342410966666667,0.389071233333333',
+    suggestBaseFee: '27.616709247',
+  },
+  schema: XyoEthereumGasEtherscanSchema,
+  status: '1',
+  timestamp: 1668697958837,
+}

package/src/test/sampleEthgasstationGas.ts

@@ -0,0 +1,20 @@
+import { XyoEthereumGasEthgasstationPayload, XyoEthereumGasEthgasstationSchema } from '@xyo-network/ethgasstation-ethereum-gas-payload-plugin'
+
+export const sampleEthgasstationGas: XyoEthereumGasEthgasstationPayload = {
+  baseFee: 10,
+  blockNumber: 16028883,
+  blockTime: 11.88,
+  gasPrice: {
+    fast: 12,
+    instant: 13,
+    standard: 12,
+  },
+  nextBaseFee: 10,
+  priorityFee: {
+    fast: 2,
+    instant: 2,
+    standard: 2,
+  },
+  schema: XyoEthereumGasEthgasstationSchema,
+  timestamp: 1668697958837,
+}