Compare commits

..

1 Commits
main ... main

Author SHA1 Message Date
3491bffeef Bump gas-price-oracle to 0.5.3 2023-07-07 01:26:31 +03:00
9 changed files with 15095 additions and 14934 deletions

View File

@ -8,12 +8,11 @@ This is a library with a collection of onchain and offchain gas price oracle URL
Current offchain list:
- https://ethgasstation.info/json/ethgasAPI.json
- https://etherchain.org/api/gasnow
Current onchain list:
- [chainlink](https://etherscan.io/address/0x169e633a2d1e6c10dd91238ba11c4a708dfef37c#readContract)
- [Chainlink aggregator](https://etherscan.io/address/0x169e633a2d1e6c10dd91238ba11c4a708dfef37c#readContract)
### Binance Smart Chain
@ -25,13 +24,14 @@ Current offchain list:
Current offchain list:
- https://blockscout.com/xdai/mainnet/api/v1/gas-price-oracle
- https://gnosis.blockscout.com/api/v1/gas-price-oracle
### Polygon (Matic) Network
Current offchain list:
- https://gasstation-mainnet.matic.network/
- https://gasstation.polygon.technology/v2
- https://matic-gas-station.tornado.ws
### Avalanche C Network
@ -252,7 +252,9 @@ type GetTxGasParamsRes =
}
const gasParams: GetTxGasParamsRes = await oracle.getTxGasParams({ legacySpeed: 'fast', bumpPercent: 30 })
console.log(gasParams) // { maxFeePerGas: 17, maxPriorityFeePerGas: 3 } || { gasPrice: 19 }
console.log(gasParams)
// { maxFeePerGas: '3f5476a00', maxPriorityFeePerGas: 'b2d05e00' } || { gasPrice: '46c7cfe00' }
// equal to: { maxFeePerGas: 17 gwei, maxPriorityFeePerGas: 3 gwei } || { gasPrice: 19 gwei }
web3.eth.sendTransaction({
from: '0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8',
@ -267,6 +269,8 @@ web3.eth.sendTransaction({
`bumpPercent` argument (`0` by default) - response data will increase by `bumpPercent`%.
`legacySpeed` argument (`fast` by default) - select the speed of legacy gasPrice.
Returns gas info in `wei`, hex-format.
### Offchain oracles only
```typescript

View File

@ -1,6 +1,6 @@
{
"name": "@tornado/gas-price-oracle",
"version": "0.5.2-p1",
"version": "0.5.3",
"description": "Gas Price Oracle library for Ethereum dApps.",
"homepage": "https://git.tornado.ws/tornado-packages/gas-price-oracle",
"main": "./lib/index.js",
@ -8,7 +8,7 @@
"types": "./lib/index.d.ts",
"repository": {
"type": "git",
"url": "https://git.tornado.ws/tornado-packages/archive-monorepo"
"url": "https://git.tornado.ws/tornado-packages/gas-price-oracle"
},
"scripts": {
"test": "ts-mocha --timeout 30000 --paths 'src/tests/*.test.ts'",

View File

@ -1,16 +1,5 @@
import { OffChainOracle, OffChainOracles, OnChainOracle, OnChainOracles } from '@/services'
const ethgasstation: OffChainOracle = {
name: 'ethgasstation',
url: 'https://ethgasstation.info/json/ethgasAPI.json',
instantPropertyName: 'fastest',
fastPropertyName: 'fast',
standardPropertyName: 'average',
lowPropertyName: 'safeLow',
denominator: 10,
additionalDataProperty: null,
}
const etherchain: OffChainOracle = {
name: 'etherchain',
url: 'https://etherchain.org/api/gasnow',
@ -30,7 +19,6 @@ const chainlink: OnChainOracle = {
}
export const offChainOracles: OffChainOracles = {
ethgasstation,
etherchain,
}

View File

@ -2,10 +2,21 @@ import { OffChainOracle, OffChainOracles, OnChainOracles } from '@/services'
const maticGasStation: OffChainOracle = {
name: 'maticGasStation',
url: 'https://gasstation-mainnet.matic.network',
instantPropertyName: 'fastest',
fastPropertyName: 'fast',
standardPropertyName: 'standard',
url: 'https://gasstation.polygon.technology/v2',
instantPropertyName: 'fast.maxFee',
fastPropertyName: 'fast.maxFee',
standardPropertyName: 'standard.maxFee',
lowPropertyName: 'safeLow.maxFee',
denominator: 1,
additionalDataProperty: null,
}
const tornadoMaticGasStation: OffChainOracle = {
name: 'tornadoMGasStation',
url: 'https://matic-gas-station.tornado.ws',
instantPropertyName: 'standard',
fastPropertyName: 'standard',
standardPropertyName: 'safeLow',
lowPropertyName: 'safeLow',
denominator: 1,
additionalDataProperty: null,
@ -13,6 +24,7 @@ const maticGasStation: OffChainOracle = {
export const offChainOracles: OffChainOracles = {
maticGasStation,
tornadoMaticGasStation,
}
export const onChainOracles: OnChainOracles = {}

View File

@ -2,7 +2,7 @@ import { OffChainOracle, OffChainOracles, OnChainOracles } from '@/services'
const blockscout: OffChainOracle = {
name: 'blockscout',
url: 'https://blockscout.com/xdai/mainnet/api/v1/gas-price-oracle',
url: 'https://gnosis.blockscout.com/api/v1/gas-price-oracle',
instantPropertyName: 'fast',
fastPropertyName: 'average',
standardPropertyName: 'slow',

View File

@ -16,6 +16,7 @@ import {
import { ChainId, NETWORKS } from '@/config'
import { RpcFetcher, NodeJSCache } from '@/services'
import { resolvePropertyPath } from '@/utils'
import { GWEI, DEFAULT_TIMEOUT, GWEI_PRECISION, DEFAULT_BLOCK_DURATION } from '@/constants'
import { MULTIPLIERS, DEFAULT_GAS_PRICE } from './constants'
@ -297,17 +298,17 @@ export class LegacyGasPriceOracle implements LegacyOracle {
const response = await axios.get(url, { timeout: this.configuration.timeout })
if (response.status === 200) {
const gas = additionalDataProperty ? response.data[additionalDataProperty] : response.data
const gas = resolvePropertyPath(response.data, additionalDataProperty)
if (Number(gas[fastPropertyName]) === 0) {
if (Number(resolvePropertyPath(gas, fastPropertyName)) === 0) {
throw new Error(`${name} oracle provides corrupted values`)
}
const gasPrices: GasPrice = {
instant: parseFloat(gas[instantPropertyName]) / denominator,
fast: parseFloat(gas[fastPropertyName]) / denominator,
standard: parseFloat(gas[standardPropertyName]) / denominator,
low: parseFloat(gas[lowPropertyName]) / denominator,
instant: parseFloat(resolvePropertyPath(gas, instantPropertyName)) / denominator,
fast: parseFloat(resolvePropertyPath(gas, fastPropertyName)) / denominator,
standard: parseFloat(resolvePropertyPath(gas, standardPropertyName)) / denominator,
low: parseFloat(resolvePropertyPath(gas, lowPropertyName)) / denominator,
}
return LegacyGasPriceOracle.normalize(gasPrices)
} else {

View File

@ -5,4 +5,43 @@ const sleep = (time: number): Promise<boolean> => {
return new Promise((res) => setTimeout(() => res(true), time))
}
export { sleep }
/**
* Returns the recursively resolved value of the object's subproperty given the properties path, separated by dots.
* If properties path is null, undefined or an empty string - returns the object itself
* @param obj - The object, from which get property or subproperty
* @param propertiesInString - Property name or properties chained string, like 'user.email.domain'
* @returns The value of the subproperty by path or object itself
*
* @example
*
* ### Object
* ```ts
* const x = {
* y: {
* z: 11
* }
* };
* ```
*
* ### Property path in object
* ```ts
* const propertyPath = 'y.z';
* ```
*
* ### Usage
* ```ts
* const subpropertyValue = resolvePropertyPath(x, propertyPath);
* ```
*
* ### Result (subproperty value)
* ```ts
* 11
* ```
*/
const resolvePropertyPath = (obj: object, propertyPath: string | undefined | null): any => {
const properties = propertyPath?.split('.') || []
return properties.reduce((curr: { [key: string]: any }, nextProperty: string) => curr[nextProperty], obj)
}
export { sleep, resolvePropertyPath }

View File

@ -1,6 +1,6 @@
{
"name": "archive-monorepo",
"packageManager": "yarn@3.5.0",
"packageManager": "yarn@3.6.1",
"private": true,
"workspaces": [
"@tornado/*"

29921
yarn.lock

File diff suppressed because it is too large Load Diff