v-swap-smart-order-router 3.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (414) hide show
  1. package/CHANGELOG.md +255 -0
  2. package/LICENSE +674 -0
  3. package/README.md +248 -0
  4. package/build/main/index.d.ts +3 -0
  5. package/build/main/index.js +20 -0
  6. package/build/main/providers/cache-node.d.ts +9 -0
  7. package/build/main/providers/cache-node.js +19 -0
  8. package/build/main/providers/cache.d.ts +13 -0
  9. package/build/main/providers/cache.js +3 -0
  10. package/build/main/providers/caching/route/index.d.ts +2 -0
  11. package/build/main/providers/caching/route/index.js +19 -0
  12. package/build/main/providers/caching/route/model/cache-mode.d.ts +16 -0
  13. package/build/main/providers/caching/route/model/cache-mode.js +21 -0
  14. package/build/main/providers/caching/route/model/cached-route.d.ts +26 -0
  15. package/build/main/providers/caching/route/model/cached-route.js +30 -0
  16. package/build/main/providers/caching/route/model/cached-routes.d.ts +63 -0
  17. package/build/main/providers/caching/route/model/cached-routes.js +73 -0
  18. package/build/main/providers/caching/route/model/index.d.ts +3 -0
  19. package/build/main/providers/caching/route/model/index.js +20 -0
  20. package/build/main/providers/caching/route/route-caching-provider.d.ts +91 -0
  21. package/build/main/providers/caching/route/route-caching-provider.js +65 -0
  22. package/build/main/providers/caching-gas-provider.d.ts +23 -0
  23. package/build/main/providers/caching-gas-provider.js +37 -0
  24. package/build/main/providers/caching-token-list-provider.d.ts +40 -0
  25. package/build/main/providers/caching-token-list-provider.js +123 -0
  26. package/build/main/providers/caching-token-provider.d.ts +25 -0
  27. package/build/main/providers/caching-token-provider.js +202 -0
  28. package/build/main/providers/eip-1559-gas-price-provider.d.ts +31 -0
  29. package/build/main/providers/eip-1559-gas-price-provider.js +66 -0
  30. package/build/main/providers/eth-estimate-gas-provider.d.ts +16 -0
  31. package/build/main/providers/eth-estimate-gas-provider.js +74 -0
  32. package/build/main/providers/eth-gas-station-info-gas-price-provider.d.ts +19 -0
  33. package/build/main/providers/eth-gas-station-info-gas-price-provider.js +37 -0
  34. package/build/main/providers/gas-price-provider.d.ts +10 -0
  35. package/build/main/providers/gas-price-provider.js +10 -0
  36. package/build/main/providers/index.d.ts +37 -0
  37. package/build/main/providers/index.js +54 -0
  38. package/build/main/providers/legacy-gas-price-provider.d.ts +7 -0
  39. package/build/main/providers/legacy-gas-price-provider.js +20 -0
  40. package/build/main/providers/multicall-provider.d.ts +82 -0
  41. package/build/main/providers/multicall-provider.js +15 -0
  42. package/build/main/providers/multicall-uniswap-provider.d.ts +37 -0
  43. package/build/main/providers/multicall-uniswap-provider.js +163 -0
  44. package/build/main/providers/on-chain-gas-price-provider.d.ts +19 -0
  45. package/build/main/providers/on-chain-gas-price-provider.js +38 -0
  46. package/build/main/providers/on-chain-quote-provider.d.ts +221 -0
  47. package/build/main/providers/on-chain-quote-provider.js +523 -0
  48. package/build/main/providers/provider.d.ts +10 -0
  49. package/build/main/providers/provider.js +3 -0
  50. package/build/main/providers/simulation-provider.d.ts +42 -0
  51. package/build/main/providers/simulation-provider.js +130 -0
  52. package/build/main/providers/static-gas-price-provider.d.ts +7 -0
  53. package/build/main/providers/static-gas-price-provider.js +13 -0
  54. package/build/main/providers/swap-router-provider.d.ts +31 -0
  55. package/build/main/providers/swap-router-provider.js +42 -0
  56. package/build/main/providers/tenderly-simulation-provider.d.ts +45 -0
  57. package/build/main/providers/tenderly-simulation-provider.js +254 -0
  58. package/build/main/providers/token-provider.d.ts +114 -0
  59. package/build/main/providers/token-provider.js +297 -0
  60. package/build/main/providers/token-validator-provider.d.ts +42 -0
  61. package/build/main/providers/token-validator-provider.js +95 -0
  62. package/build/main/providers/uri-subgraph-provider.d.ts +20 -0
  63. package/build/main/providers/uri-subgraph-provider.js +65 -0
  64. package/build/main/providers/v2/caching-pool-provider.d.ts +34 -0
  65. package/build/main/providers/v2/caching-pool-provider.js +88 -0
  66. package/build/main/providers/v2/caching-subgraph-provider.d.ts +23 -0
  67. package/build/main/providers/v2/caching-subgraph-provider.js +34 -0
  68. package/build/main/providers/v2/pool-provider.d.ts +60 -0
  69. package/build/main/providers/v2/pool-provider.js +110 -0
  70. package/build/main/providers/v2/quote-provider.d.ts +33 -0
  71. package/build/main/providers/v2/quote-provider.js +91 -0
  72. package/build/main/providers/v2/static-subgraph-provider.d.ts +20 -0
  73. package/build/main/providers/v2/static-subgraph-provider.js +103 -0
  74. package/build/main/providers/v2/subgraph-provider-with-fallback.d.ts +19 -0
  75. package/build/main/providers/v2/subgraph-provider-with-fallback.js +35 -0
  76. package/build/main/providers/v2/subgraph-provider.d.ts +34 -0
  77. package/build/main/providers/v2/subgraph-provider.js +135 -0
  78. package/build/main/providers/v2/uri-subgraph-provider.d.ts +4 -0
  79. package/build/main/providers/v2/uri-subgraph-provider.js +8 -0
  80. package/build/main/providers/v3/caching-pool-provider.d.ts +33 -0
  81. package/build/main/providers/v3/caching-pool-provider.js +77 -0
  82. package/build/main/providers/v3/caching-subgraph-provider.d.ts +23 -0
  83. package/build/main/providers/v3/caching-subgraph-provider.js +34 -0
  84. package/build/main/providers/v3/gas-data-provider.d.ts +57 -0
  85. package/build/main/providers/v3/gas-data-provider.js +66 -0
  86. package/build/main/providers/v3/pool-provider.d.ts +61 -0
  87. package/build/main/providers/v3/pool-provider.js +123 -0
  88. package/build/main/providers/v3/static-subgraph-provider.d.ts +21 -0
  89. package/build/main/providers/v3/static-subgraph-provider.js +203 -0
  90. package/build/main/providers/v3/subgraph-provider-with-fallback.d.ts +15 -0
  91. package/build/main/providers/v3/subgraph-provider-with-fallback.js +31 -0
  92. package/build/main/providers/v3/subgraph-provider.d.ts +37 -0
  93. package/build/main/providers/v3/subgraph-provider.js +145 -0
  94. package/build/main/providers/v3/uri-subgraph-provider.d.ts +4 -0
  95. package/build/main/providers/v3/uri-subgraph-provider.js +8 -0
  96. package/build/main/routers/alpha-router/alpha-router.d.ts +267 -0
  97. package/build/main/routers/alpha-router/alpha-router.js +825 -0
  98. package/build/main/routers/alpha-router/config.d.ts +4 -0
  99. package/build/main/routers/alpha-router/config.js +93 -0
  100. package/build/main/routers/alpha-router/entities/index.d.ts +1 -0
  101. package/build/main/routers/alpha-router/entities/index.js +18 -0
  102. package/build/main/routers/alpha-router/entities/route-with-valid-quote.d.ts +163 -0
  103. package/build/main/routers/alpha-router/entities/route-with-valid-quote.js +143 -0
  104. package/build/main/routers/alpha-router/functions/best-swap-route.d.ts +19 -0
  105. package/build/main/routers/alpha-router/functions/best-swap-route.js +364 -0
  106. package/build/main/routers/alpha-router/functions/calculate-ratio-amount-in.d.ts +3 -0
  107. package/build/main/routers/alpha-router/functions/calculate-ratio-amount-in.js +18 -0
  108. package/build/main/routers/alpha-router/functions/compute-all-routes.d.ts +8 -0
  109. package/build/main/routers/alpha-router/functions/compute-all-routes.js +72 -0
  110. package/build/main/routers/alpha-router/functions/get-candidate-pools.d.ts +78 -0
  111. package/build/main/routers/alpha-router/functions/get-candidate-pools.js +761 -0
  112. package/build/main/routers/alpha-router/gas-models/gas-model.d.ts +83 -0
  113. package/build/main/routers/alpha-router/gas-models/gas-model.js +68 -0
  114. package/build/main/routers/alpha-router/gas-models/index.d.ts +2 -0
  115. package/build/main/routers/alpha-router/gas-models/index.js +19 -0
  116. package/build/main/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.d.ts +25 -0
  117. package/build/main/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.js +175 -0
  118. package/build/main/routers/alpha-router/gas-models/v2/v2-heuristic-gas-model.d.ts +29 -0
  119. package/build/main/routers/alpha-router/gas-models/v2/v2-heuristic-gas-model.js +167 -0
  120. package/build/main/routers/alpha-router/gas-models/v3/gas-costs.d.ts +6 -0
  121. package/build/main/routers/alpha-router/gas-models/v3/gas-costs.js +110 -0
  122. package/build/main/routers/alpha-router/gas-models/v3/v3-heuristic-gas-model.d.ts +31 -0
  123. package/build/main/routers/alpha-router/gas-models/v3/v3-heuristic-gas-model.js +288 -0
  124. package/build/main/routers/alpha-router/index.d.ts +4 -0
  125. package/build/main/routers/alpha-router/index.js +21 -0
  126. package/build/main/routers/alpha-router/quoters/base-quoter.d.ts +68 -0
  127. package/build/main/routers/alpha-router/quoters/base-quoter.js +61 -0
  128. package/build/main/routers/alpha-router/quoters/index.d.ts +5 -0
  129. package/build/main/routers/alpha-router/quoters/index.js +22 -0
  130. package/build/main/routers/alpha-router/quoters/mixed-quoter.d.ts +20 -0
  131. package/build/main/routers/alpha-router/quoters/mixed-quoter.js +130 -0
  132. package/build/main/routers/alpha-router/quoters/model/index.d.ts +1 -0
  133. package/build/main/routers/alpha-router/quoters/model/index.js +18 -0
  134. package/build/main/routers/alpha-router/quoters/model/results/get-quotes-result.d.ts +6 -0
  135. package/build/main/routers/alpha-router/quoters/model/results/get-quotes-result.js +3 -0
  136. package/build/main/routers/alpha-router/quoters/model/results/get-routes-result.d.ts +6 -0
  137. package/build/main/routers/alpha-router/quoters/model/results/get-routes-result.js +3 -0
  138. package/build/main/routers/alpha-router/quoters/model/results/index.d.ts +2 -0
  139. package/build/main/routers/alpha-router/quoters/model/results/index.js +19 -0
  140. package/build/main/routers/alpha-router/quoters/v2-quoter.d.ts +21 -0
  141. package/build/main/routers/alpha-router/quoters/v2-quoter.js +122 -0
  142. package/build/main/routers/alpha-router/quoters/v3-quoter.d.ts +19 -0
  143. package/build/main/routers/alpha-router/quoters/v3-quoter.js +125 -0
  144. package/build/main/routers/index.d.ts +4 -0
  145. package/build/main/routers/index.js +21 -0
  146. package/build/main/routers/legacy-router/bases.d.ts +136 -0
  147. package/build/main/routers/legacy-router/bases.js +87 -0
  148. package/build/main/routers/legacy-router/index.d.ts +1 -0
  149. package/build/main/routers/legacy-router/index.js +18 -0
  150. package/build/main/routers/legacy-router/legacy-router.d.ts +42 -0
  151. package/build/main/routers/legacy-router/legacy-router.js +289 -0
  152. package/build/main/routers/router.d.ts +165 -0
  153. package/build/main/routers/router.js +52 -0
  154. package/build/main/tsconfig.tsbuildinfo +1 -0
  155. package/build/main/types/other/commons.d.ts +16 -0
  156. package/build/main/types/other/commons.js +6 -0
  157. package/build/main/types/other/factories/Erc20__factory.d.ts +45 -0
  158. package/build/main/types/other/factories/Erc20__factory.js +240 -0
  159. package/build/main/types/other/factories/GasDataArbitrum__factory.d.ts +18 -0
  160. package/build/main/types/other/factories/GasDataArbitrum__factory.js +58 -0
  161. package/build/main/types/other/factories/GasPriceOracle__factory.d.ts +46 -0
  162. package/build/main/types/other/factories/GasPriceOracle__factory.js +316 -0
  163. package/build/main/types/other/factories/IMixedRouteQuoterV1__factory.d.ts +41 -0
  164. package/build/main/types/other/factories/IMixedRouteQuoterV1__factory.js +156 -0
  165. package/build/main/types/other/factories/ITokenValidator__factory.d.ts +22 -0
  166. package/build/main/types/other/factories/ITokenValidator__factory.js +78 -0
  167. package/build/main/types/other/factories/Permit2__factory.d.ts +87 -0
  168. package/build/main/types/other/factories/Permit2__factory.js +936 -0
  169. package/build/main/types/other/factories/SwapRouter02__factory.d.ts +67 -0
  170. package/build/main/types/other/factories/SwapRouter02__factory.js +1098 -0
  171. package/build/main/types/v2/commons.d.ts +16 -0
  172. package/build/main/types/v2/commons.js +6 -0
  173. package/build/main/types/v2/factories/IUniswapV2Pair__factory.d.ts +35 -0
  174. package/build/main/types/v2/factories/IUniswapV2Pair__factory.js +671 -0
  175. package/build/main/types/v3/commons.d.ts +16 -0
  176. package/build/main/types/v3/commons.js +6 -0
  177. package/build/main/types/v3/factories/IERC20Metadata__factory.d.ts +35 -0
  178. package/build/main/types/v3/factories/IERC20Metadata__factory.js +242 -0
  179. package/build/main/types/v3/factories/IQuoterV2__factory.d.ts +41 -0
  180. package/build/main/types/v3/factories/IQuoterV2__factory.js +220 -0
  181. package/build/main/types/v3/factories/IUniswapV3PoolState__factory.d.ts +22 -0
  182. package/build/main/types/v3/factories/IUniswapV3PoolState__factory.js +266 -0
  183. package/build/main/types/v3/factories/UniswapInterfaceMulticall__factory.d.ts +61 -0
  184. package/build/main/types/v3/factories/UniswapInterfaceMulticall__factory.js +127 -0
  185. package/build/main/util/addresses.d.ts +26 -0
  186. package/build/main/util/addresses.js +73 -0
  187. package/build/main/util/amounts.d.ts +8 -0
  188. package/build/main/util/amounts.js +51 -0
  189. package/build/main/util/callData.d.ts +1 -0
  190. package/build/main/util/callData.js +6 -0
  191. package/build/main/util/chains.d.ts +77 -0
  192. package/build/main/util/chains.js +564 -0
  193. package/build/main/util/gas-factory-helpers.d.ts +24 -0
  194. package/build/main/util/gas-factory-helpers.js +308 -0
  195. package/build/main/util/index.d.ts +7 -0
  196. package/build/main/util/index.js +24 -0
  197. package/build/main/util/log.d.ts +3 -0
  198. package/build/main/util/log.js +97 -0
  199. package/build/main/util/methodParameters.d.ts +5 -0
  200. package/build/main/util/methodParameters.js +108 -0
  201. package/build/main/util/metric.d.ts +48 -0
  202. package/build/main/util/metric.js +59 -0
  203. package/build/main/util/protocols.d.ts +2 -0
  204. package/build/main/util/protocols.js +18 -0
  205. package/build/main/util/routes.d.ts +8 -0
  206. package/build/main/util/routes.js +60 -0
  207. package/build/main/util/unsupported-tokens.d.ts +37 -0
  208. package/build/main/util/unsupported-tokens.js +1119 -0
  209. package/build/module/index.d.ts +3 -0
  210. package/build/module/index.js +4 -0
  211. package/build/module/providers/cache-node.d.ts +9 -0
  212. package/build/module/providers/cache-node.js +15 -0
  213. package/build/module/providers/cache.d.ts +13 -0
  214. package/build/module/providers/cache.js +2 -0
  215. package/build/module/providers/caching/route/index.d.ts +2 -0
  216. package/build/module/providers/caching/route/index.js +3 -0
  217. package/build/module/providers/caching/route/model/cache-mode.d.ts +16 -0
  218. package/build/module/providers/caching/route/model/cache-mode.js +18 -0
  219. package/build/module/providers/caching/route/model/cached-route.d.ts +26 -0
  220. package/build/module/providers/caching/route/model/cached-route.js +26 -0
  221. package/build/module/providers/caching/route/model/cached-routes.d.ts +63 -0
  222. package/build/module/providers/caching/route/model/cached-routes.js +66 -0
  223. package/build/module/providers/caching/route/model/index.d.ts +3 -0
  224. package/build/module/providers/caching/route/model/index.js +4 -0
  225. package/build/module/providers/caching/route/route-caching-provider.d.ts +91 -0
  226. package/build/module/providers/caching/route/route-caching-provider.js +61 -0
  227. package/build/module/providers/caching-gas-provider.d.ts +23 -0
  228. package/build/module/providers/caching-gas-provider.js +33 -0
  229. package/build/module/providers/caching-token-list-provider.d.ts +40 -0
  230. package/build/module/providers/caching-token-list-provider.js +116 -0
  231. package/build/module/providers/caching-token-provider.d.ts +25 -0
  232. package/build/module/providers/caching-token-provider.js +195 -0
  233. package/build/module/providers/eip-1559-gas-price-provider.d.ts +31 -0
  234. package/build/module/providers/eip-1559-gas-price-provider.js +59 -0
  235. package/build/module/providers/eth-estimate-gas-provider.d.ts +16 -0
  236. package/build/module/providers/eth-estimate-gas-provider.js +82 -0
  237. package/build/module/providers/eth-gas-station-info-gas-price-provider.d.ts +19 -0
  238. package/build/module/providers/eth-gas-station-info-gas-price-provider.js +30 -0
  239. package/build/module/providers/gas-price-provider.d.ts +10 -0
  240. package/build/module/providers/gas-price-provider.js +6 -0
  241. package/build/module/providers/index.d.ts +37 -0
  242. package/build/module/providers/index.js +38 -0
  243. package/build/module/providers/legacy-gas-price-provider.d.ts +7 -0
  244. package/build/module/providers/legacy-gas-price-provider.js +16 -0
  245. package/build/module/providers/multicall-provider.d.ts +82 -0
  246. package/build/module/providers/multicall-provider.js +11 -0
  247. package/build/module/providers/multicall-uniswap-provider.d.ts +37 -0
  248. package/build/module/providers/multicall-uniswap-provider.js +156 -0
  249. package/build/module/providers/on-chain-gas-price-provider.d.ts +19 -0
  250. package/build/module/providers/on-chain-gas-price-provider.js +34 -0
  251. package/build/module/providers/on-chain-quote-provider.d.ts +221 -0
  252. package/build/module/providers/on-chain-quote-provider.js +517 -0
  253. package/build/module/providers/provider.d.ts +10 -0
  254. package/build/module/providers/provider.js +2 -0
  255. package/build/module/providers/simulation-provider.d.ts +42 -0
  256. package/build/module/providers/simulation-provider.js +132 -0
  257. package/build/module/providers/static-gas-price-provider.d.ts +7 -0
  258. package/build/module/providers/static-gas-price-provider.js +9 -0
  259. package/build/module/providers/swap-router-provider.d.ts +31 -0
  260. package/build/module/providers/swap-router-provider.js +38 -0
  261. package/build/module/providers/tenderly-simulation-provider.d.ts +45 -0
  262. package/build/module/providers/tenderly-simulation-provider.js +249 -0
  263. package/build/module/providers/token-provider.d.ts +114 -0
  264. package/build/module/providers/token-provider.js +285 -0
  265. package/build/module/providers/token-validator-provider.d.ts +42 -0
  266. package/build/module/providers/token-validator-provider.js +88 -0
  267. package/build/module/providers/uri-subgraph-provider.d.ts +20 -0
  268. package/build/module/providers/uri-subgraph-provider.js +58 -0
  269. package/build/module/providers/v2/caching-pool-provider.d.ts +34 -0
  270. package/build/module/providers/v2/caching-pool-provider.js +81 -0
  271. package/build/module/providers/v2/caching-subgraph-provider.d.ts +23 -0
  272. package/build/module/providers/v2/caching-subgraph-provider.js +30 -0
  273. package/build/module/providers/v2/pool-provider.d.ts +60 -0
  274. package/build/module/providers/v2/pool-provider.js +103 -0
  275. package/build/module/providers/v2/quote-provider.d.ts +33 -0
  276. package/build/module/providers/v2/quote-provider.js +87 -0
  277. package/build/module/providers/v2/static-subgraph-provider.d.ts +20 -0
  278. package/build/module/providers/v2/static-subgraph-provider.js +96 -0
  279. package/build/module/providers/v2/subgraph-provider-with-fallback.d.ts +19 -0
  280. package/build/module/providers/v2/subgraph-provider-with-fallback.js +31 -0
  281. package/build/module/providers/v2/subgraph-provider.d.ts +34 -0
  282. package/build/module/providers/v2/subgraph-provider.js +136 -0
  283. package/build/module/providers/v2/uri-subgraph-provider.d.ts +4 -0
  284. package/build/module/providers/v2/uri-subgraph-provider.js +4 -0
  285. package/build/module/providers/v3/caching-pool-provider.d.ts +33 -0
  286. package/build/module/providers/v3/caching-pool-provider.js +70 -0
  287. package/build/module/providers/v3/caching-subgraph-provider.d.ts +23 -0
  288. package/build/module/providers/v3/caching-subgraph-provider.js +30 -0
  289. package/build/module/providers/v3/gas-data-provider.d.ts +57 -0
  290. package/build/module/providers/v3/gas-data-provider.js +61 -0
  291. package/build/module/providers/v3/pool-provider.d.ts +61 -0
  292. package/build/module/providers/v3/pool-provider.js +116 -0
  293. package/build/module/providers/v3/static-subgraph-provider.d.ts +21 -0
  294. package/build/module/providers/v3/static-subgraph-provider.js +200 -0
  295. package/build/module/providers/v3/subgraph-provider-with-fallback.d.ts +15 -0
  296. package/build/module/providers/v3/subgraph-provider-with-fallback.js +27 -0
  297. package/build/module/providers/v3/subgraph-provider.d.ts +37 -0
  298. package/build/module/providers/v3/subgraph-provider.js +132 -0
  299. package/build/module/providers/v3/uri-subgraph-provider.d.ts +4 -0
  300. package/build/module/providers/v3/uri-subgraph-provider.js +4 -0
  301. package/build/module/routers/alpha-router/alpha-router.d.ts +267 -0
  302. package/build/module/routers/alpha-router/alpha-router.js +823 -0
  303. package/build/module/routers/alpha-router/config.d.ts +4 -0
  304. package/build/module/routers/alpha-router/config.js +89 -0
  305. package/build/module/routers/alpha-router/entities/index.d.ts +1 -0
  306. package/build/module/routers/alpha-router/entities/index.js +2 -0
  307. package/build/module/routers/alpha-router/entities/route-with-valid-quote.d.ts +163 -0
  308. package/build/module/routers/alpha-router/entities/route-with-valid-quote.js +134 -0
  309. package/build/module/routers/alpha-router/functions/best-swap-route.d.ts +19 -0
  310. package/build/module/routers/alpha-router/functions/best-swap-route.js +356 -0
  311. package/build/module/routers/alpha-router/functions/calculate-ratio-amount-in.d.ts +3 -0
  312. package/build/module/routers/alpha-router/functions/calculate-ratio-amount-in.js +14 -0
  313. package/build/module/routers/alpha-router/functions/compute-all-routes.d.ts +8 -0
  314. package/build/module/routers/alpha-router/functions/compute-all-routes.js +65 -0
  315. package/build/module/routers/alpha-router/functions/get-candidate-pools.d.ts +78 -0
  316. package/build/module/routers/alpha-router/functions/get-candidate-pools.js +776 -0
  317. package/build/module/routers/alpha-router/gas-models/gas-model.d.ts +83 -0
  318. package/build/module/routers/alpha-router/gas-models/gas-model.js +67 -0
  319. package/build/module/routers/alpha-router/gas-models/index.d.ts +2 -0
  320. package/build/module/routers/alpha-router/gas-models/index.js +3 -0
  321. package/build/module/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.d.ts +25 -0
  322. package/build/module/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.js +168 -0
  323. package/build/module/routers/alpha-router/gas-models/v2/v2-heuristic-gas-model.d.ts +29 -0
  324. package/build/module/routers/alpha-router/gas-models/v2/v2-heuristic-gas-model.js +160 -0
  325. package/build/module/routers/alpha-router/gas-models/v3/gas-costs.d.ts +6 -0
  326. package/build/module/routers/alpha-router/gas-models/v3/gas-costs.js +104 -0
  327. package/build/module/routers/alpha-router/gas-models/v3/v3-heuristic-gas-model.d.ts +31 -0
  328. package/build/module/routers/alpha-router/gas-models/v3/v3-heuristic-gas-model.js +281 -0
  329. package/build/module/routers/alpha-router/index.d.ts +4 -0
  330. package/build/module/routers/alpha-router/index.js +5 -0
  331. package/build/module/routers/alpha-router/quoters/base-quoter.d.ts +68 -0
  332. package/build/module/routers/alpha-router/quoters/base-quoter.js +54 -0
  333. package/build/module/routers/alpha-router/quoters/index.d.ts +5 -0
  334. package/build/module/routers/alpha-router/quoters/index.js +6 -0
  335. package/build/module/routers/alpha-router/quoters/mixed-quoter.d.ts +20 -0
  336. package/build/module/routers/alpha-router/quoters/mixed-quoter.js +123 -0
  337. package/build/module/routers/alpha-router/quoters/model/index.d.ts +1 -0
  338. package/build/module/routers/alpha-router/quoters/model/index.js +2 -0
  339. package/build/module/routers/alpha-router/quoters/model/results/get-quotes-result.d.ts +6 -0
  340. package/build/module/routers/alpha-router/quoters/model/results/get-quotes-result.js +2 -0
  341. package/build/module/routers/alpha-router/quoters/model/results/get-routes-result.d.ts +6 -0
  342. package/build/module/routers/alpha-router/quoters/model/results/get-routes-result.js +2 -0
  343. package/build/module/routers/alpha-router/quoters/model/results/index.d.ts +2 -0
  344. package/build/module/routers/alpha-router/quoters/model/results/index.js +3 -0
  345. package/build/module/routers/alpha-router/quoters/v2-quoter.d.ts +21 -0
  346. package/build/module/routers/alpha-router/quoters/v2-quoter.js +115 -0
  347. package/build/module/routers/alpha-router/quoters/v3-quoter.d.ts +19 -0
  348. package/build/module/routers/alpha-router/quoters/v3-quoter.js +118 -0
  349. package/build/module/routers/index.d.ts +4 -0
  350. package/build/module/routers/index.js +5 -0
  351. package/build/module/routers/legacy-router/bases.d.ts +136 -0
  352. package/build/module/routers/legacy-router/bases.js +93 -0
  353. package/build/module/routers/legacy-router/index.d.ts +1 -0
  354. package/build/module/routers/legacy-router/index.js +2 -0
  355. package/build/module/routers/legacy-router/legacy-router.d.ts +42 -0
  356. package/build/module/routers/legacy-router/legacy-router.js +290 -0
  357. package/build/module/routers/router.d.ts +165 -0
  358. package/build/module/routers/router.js +44 -0
  359. package/build/module/tsconfig.module.tsbuildinfo +1 -0
  360. package/build/module/types/other/commons.d.ts +16 -0
  361. package/build/module/types/other/commons.js +5 -0
  362. package/build/module/types/other/factories/Erc20__factory.d.ts +45 -0
  363. package/build/module/types/other/factories/Erc20__factory.js +236 -0
  364. package/build/module/types/other/factories/GasDataArbitrum__factory.d.ts +18 -0
  365. package/build/module/types/other/factories/GasDataArbitrum__factory.js +54 -0
  366. package/build/module/types/other/factories/GasPriceOracle__factory.d.ts +46 -0
  367. package/build/module/types/other/factories/GasPriceOracle__factory.js +312 -0
  368. package/build/module/types/other/factories/IMixedRouteQuoterV1__factory.d.ts +41 -0
  369. package/build/module/types/other/factories/IMixedRouteQuoterV1__factory.js +152 -0
  370. package/build/module/types/other/factories/ITokenValidator__factory.d.ts +22 -0
  371. package/build/module/types/other/factories/ITokenValidator__factory.js +74 -0
  372. package/build/module/types/other/factories/Permit2__factory.d.ts +87 -0
  373. package/build/module/types/other/factories/Permit2__factory.js +932 -0
  374. package/build/module/types/other/factories/SwapRouter02__factory.d.ts +67 -0
  375. package/build/module/types/other/factories/SwapRouter02__factory.js +1094 -0
  376. package/build/module/types/v2/commons.d.ts +16 -0
  377. package/build/module/types/v2/commons.js +5 -0
  378. package/build/module/types/v2/factories/IUniswapV2Pair__factory.d.ts +35 -0
  379. package/build/module/types/v2/factories/IUniswapV2Pair__factory.js +667 -0
  380. package/build/module/types/v3/commons.d.ts +16 -0
  381. package/build/module/types/v3/commons.js +5 -0
  382. package/build/module/types/v3/factories/IERC20Metadata__factory.d.ts +35 -0
  383. package/build/module/types/v3/factories/IERC20Metadata__factory.js +238 -0
  384. package/build/module/types/v3/factories/IQuoterV2__factory.d.ts +41 -0
  385. package/build/module/types/v3/factories/IQuoterV2__factory.js +216 -0
  386. package/build/module/types/v3/factories/IUniswapV3PoolState__factory.d.ts +22 -0
  387. package/build/module/types/v3/factories/IUniswapV3PoolState__factory.js +262 -0
  388. package/build/module/types/v3/factories/UniswapInterfaceMulticall__factory.d.ts +61 -0
  389. package/build/module/types/v3/factories/UniswapInterfaceMulticall__factory.js +123 -0
  390. package/build/module/util/addresses.d.ts +26 -0
  391. package/build/module/util/addresses.js +98 -0
  392. package/build/module/util/amounts.d.ts +8 -0
  393. package/build/module/util/amounts.js +41 -0
  394. package/build/module/util/callData.d.ts +1 -0
  395. package/build/module/util/callData.js +3 -0
  396. package/build/module/util/chains.d.ts +77 -0
  397. package/build/module/util/chains.js +556 -0
  398. package/build/module/util/gas-factory-helpers.d.ts +24 -0
  399. package/build/module/util/gas-factory-helpers.js +291 -0
  400. package/build/module/util/index.d.ts +7 -0
  401. package/build/module/util/index.js +8 -0
  402. package/build/module/util/log.d.ts +3 -0
  403. package/build/module/util/log.js +93 -0
  404. package/build/module/util/methodParameters.d.ts +5 -0
  405. package/build/module/util/methodParameters.js +106 -0
  406. package/build/module/util/metric.d.ts +48 -0
  407. package/build/module/util/metric.js +53 -0
  408. package/build/module/util/protocols.d.ts +2 -0
  409. package/build/module/util/protocols.js +14 -0
  410. package/build/module/util/routes.d.ts +8 -0
  411. package/build/module/util/routes.js +50 -0
  412. package/build/module/util/unsupported-tokens.d.ts +37 -0
  413. package/build/module/util/unsupported-tokens.js +1116 -0
  414. package/package.json +119 -0
@@ -0,0 +1,116 @@
1
+ /* eslint-disable @typescript-eslint/no-non-null-assertion */
2
+ import { Token } from '@uniswap/sdk-core';
3
+ import axios from 'axios';
4
+ import _ from 'lodash';
5
+ import { log } from '../util/log';
6
+ import { metric, MetricLoggerUnit } from '../util/metric';
7
+ export class CachingTokenListProvider {
8
+ /**
9
+ * Creates an instance of CachingTokenListProvider.
10
+ * Token metadata (e.g. symbol and decimals) generally don't change so can be cached indefinitely.
11
+ *
12
+ * @param chainId The chain id to use.
13
+ * @param tokenList The token list to get the tokens from.
14
+ * @param tokenCache Cache instance to hold cached tokens.
15
+ */
16
+ constructor(chainId, tokenList, tokenCache) {
17
+ this.tokenCache = tokenCache;
18
+ this.CACHE_KEY = (tokenInfo) => `token-list-token-${this.chainId}/${this.tokenList.name}/${this.tokenList.timestamp}/${this.tokenList.version}/${tokenInfo.address.toLowerCase()}/${tokenInfo.decimals}/${tokenInfo.symbol}/${tokenInfo.name}`;
19
+ this.chainId = chainId;
20
+ this.tokenList = tokenList;
21
+ this.chainToTokenInfos = _.reduce(this.tokenList.tokens, (result, tokenInfo) => {
22
+ const chainId = tokenInfo.chainId.toString();
23
+ if (!result[chainId]) {
24
+ result[chainId] = [];
25
+ }
26
+ result[chainId].push(tokenInfo);
27
+ return result;
28
+ }, {});
29
+ this.chainSymbolToTokenInfo = _.mapValues(this.chainToTokenInfos, (tokenInfos) => _.keyBy(tokenInfos, 'symbol'));
30
+ this.chainAddressToTokenInfo = _.mapValues(this.chainToTokenInfos, (tokenInfos) => _.keyBy(tokenInfos, (tokenInfo) => tokenInfo.address.toLowerCase()));
31
+ }
32
+ static async fromTokenListURI(chainId, tokenListURI, tokenCache) {
33
+ const now = Date.now();
34
+ const tokenList = await this.buildTokenList(tokenListURI);
35
+ metric.putMetric('TokenListLoad', Date.now() - now, MetricLoggerUnit.Milliseconds);
36
+ return new CachingTokenListProvider(chainId, tokenList, tokenCache);
37
+ }
38
+ static async buildTokenList(tokenListURI) {
39
+ log.info(`Getting tokenList from ${tokenListURI}.`);
40
+ const response = await axios.get(tokenListURI);
41
+ log.info(`Got tokenList from ${tokenListURI}.`);
42
+ const { data: tokenList, status } = response;
43
+ if (status != 200) {
44
+ log.error({ response }, `Unabled to get token list from ${tokenListURI}.`);
45
+ throw new Error(`Unable to get token list from ${tokenListURI}`);
46
+ }
47
+ return tokenList;
48
+ }
49
+ static async fromTokenList(chainId, tokenList, tokenCache) {
50
+ const now = Date.now();
51
+ const tokenProvider = new CachingTokenListProvider(chainId, tokenList, tokenCache);
52
+ metric.putMetric('TokenListLoad', Date.now() - now, MetricLoggerUnit.Milliseconds);
53
+ return tokenProvider;
54
+ }
55
+ async getTokens(_addresses) {
56
+ const addressToToken = {};
57
+ const symbolToToken = {};
58
+ for (const address of _addresses) {
59
+ const token = await this.getTokenByAddress(address);
60
+ if (!token) {
61
+ continue;
62
+ }
63
+ addressToToken[address.toLowerCase()] = token;
64
+ if (!token.symbol) {
65
+ continue;
66
+ }
67
+ symbolToToken[token.symbol.toLowerCase()] = token;
68
+ }
69
+ return {
70
+ getTokenByAddress: (address) => addressToToken[address.toLowerCase()],
71
+ getTokenBySymbol: (symbol) => symbolToToken[symbol.toLowerCase()],
72
+ getAllTokens: () => {
73
+ return Object.values(addressToToken);
74
+ },
75
+ };
76
+ }
77
+ async getTokenBySymbol(_symbol) {
78
+ let symbol = _symbol;
79
+ // We consider ETH as a regular ERC20 Token throughout this package. We don't use the NativeCurrency object from the sdk.
80
+ // When we build the calldata for swapping we insert wrapping/unwrapping as needed.
81
+ if (_symbol == 'ETH') {
82
+ symbol = 'WETH';
83
+ }
84
+ if (!this.chainSymbolToTokenInfo[this.chainId.toString()]) {
85
+ return undefined;
86
+ }
87
+ const tokenInfo = this.chainSymbolToTokenInfo[this.chainId.toString()][symbol];
88
+ if (!tokenInfo) {
89
+ return undefined;
90
+ }
91
+ const token = await this.buildToken(tokenInfo);
92
+ return token;
93
+ }
94
+ async getTokenByAddress(address) {
95
+ if (!this.chainAddressToTokenInfo[this.chainId.toString()]) {
96
+ return undefined;
97
+ }
98
+ const tokenInfo = this.chainAddressToTokenInfo[this.chainId.toString()][address.toLowerCase()];
99
+ if (!tokenInfo) {
100
+ return undefined;
101
+ }
102
+ const token = await this.buildToken(tokenInfo);
103
+ return token;
104
+ }
105
+ async buildToken(tokenInfo) {
106
+ const cacheKey = this.CACHE_KEY(tokenInfo);
107
+ const cachedToken = await this.tokenCache.get(cacheKey);
108
+ if (cachedToken) {
109
+ return cachedToken;
110
+ }
111
+ const token = new Token(this.chainId, tokenInfo.address, tokenInfo.decimals, tokenInfo.symbol, tokenInfo.name);
112
+ await this.tokenCache.set(cacheKey, token);
113
+ return token;
114
+ }
115
+ }
116
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy10b2tlbi1saXN0LXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9jYWNoaW5nLXRva2VuLWxpc3QtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsNkRBQTZEO0FBQzdELE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUUxQyxPQUFPLEtBQUssTUFBTSxPQUFPLENBQUM7QUFDMUIsT0FBTyxDQUFDLE1BQU0sUUFBUSxDQUFDO0FBR3ZCLE9BQU8sRUFBRSxHQUFHLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDbEMsT0FBTyxFQUFFLE1BQU0sRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBc0IxRCxNQUFNLE9BQU8sd0JBQXdCO0lBZ0JuQzs7Ozs7OztPQU9HO0lBQ0gsWUFDRSxPQUF5QixFQUN6QixTQUFvQixFQUNaLFVBQXlCO1FBQXpCLGVBQVUsR0FBVixVQUFVLENBQWU7UUF4QjNCLGNBQVMsR0FBRyxDQUFDLFNBQW9CLEVBQUUsRUFBRSxDQUMzQyxvQkFBb0IsSUFBSSxDQUFDLE9BQU8sSUFBSSxJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksSUFDckQsSUFBSSxDQUFDLFNBQVMsQ0FBQyxTQUNqQixJQUFJLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxJQUFJLFNBQVMsQ0FBQyxPQUFPLENBQUMsV0FBVyxFQUFFLElBQzNELFNBQVMsQ0FBQyxRQUNaLElBQUksU0FBUyxDQUFDLE1BQU0sSUFBSSxTQUFTLENBQUMsSUFBSSxFQUFFLENBQUM7UUFxQnpDLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBRTNCLElBQUksQ0FBQyxpQkFBaUIsR0FBRyxDQUFDLENBQUMsTUFBTSxDQUMvQixJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sRUFDckIsQ0FBQyxNQUE0QixFQUFFLFNBQW9CLEVBQUUsRUFBRTtZQUNyRCxNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQzdDLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLEVBQUU7Z0JBQ3BCLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUM7YUFDdEI7WUFDRCxNQUFNLENBQUMsT0FBTyxDQUFFLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1lBRWpDLE9BQU8sTUFBTSxDQUFDO1FBQ2hCLENBQUMsRUFDRCxFQUFFLENBQ0gsQ0FBQztRQUVGLElBQUksQ0FBQyxzQkFBc0IsR0FBRyxDQUFDLENBQUMsU0FBUyxDQUN2QyxJQUFJLENBQUMsaUJBQWlCLEVBQ3RCLENBQUMsVUFBdUIsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQzNELENBQUM7UUFFRixJQUFJLENBQUMsdUJBQXVCLEdBQUcsQ0FBQyxDQUFDLFNBQVMsQ0FDeEMsSUFBSSxDQUFDLGlCQUFpQixFQUN0QixDQUFDLFVBQXVCLEVBQUUsRUFBRSxDQUMxQixDQUFDLENBQUMsS0FBSyxDQUFDLFVBQVUsRUFBRSxDQUFDLFNBQVMsRUFBRSxFQUFFLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxXQUFXLEVBQUUsQ0FBQyxDQUN0RSxDQUFDO0lBQ0osQ0FBQztJQUVNLE1BQU0sQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLENBQ2xDLE9BQXlCLEVBQ3pCLFlBQW9CLEVBQ3BCLFVBQXlCO1FBRXpCLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUN2QixNQUFNLFNBQVMsR0FBRyxNQUFNLElBQUksQ0FBQyxjQUFjLENBQUMsWUFBWSxDQUFDLENBQUM7UUFFMUQsTUFBTSxDQUFDLFNBQVMsQ0FDZCxlQUFlLEVBQ2YsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLEdBQUcsRUFDaEIsZ0JBQWdCLENBQUMsWUFBWSxDQUM5QixDQUFDO1FBRUYsT0FBTyxJQUFJLHdCQUF3QixDQUFDLE9BQU8sRUFBRSxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVPLE1BQU0sQ0FBQyxLQUFLLENBQUMsY0FBYyxDQUNqQyxZQUFvQjtRQUVwQixHQUFHLENBQUMsSUFBSSxDQUFDLDBCQUEwQixZQUFZLEdBQUcsQ0FBQyxDQUFDO1FBQ3BELE1BQU0sUUFBUSxHQUFHLE1BQU0sS0FBSyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUMvQyxHQUFHLENBQUMsSUFBSSxDQUFDLHNCQUFzQixZQUFZLEdBQUcsQ0FBQyxDQUFDO1FBRWhELE1BQU0sRUFBRSxJQUFJLEVBQUUsU0FBUyxFQUFFLE1BQU0sRUFBRSxHQUFHLFFBQVEsQ0FBQztRQUU3QyxJQUFJLE1BQU0sSUFBSSxHQUFHLEVBQUU7WUFDakIsR0FBRyxDQUFDLEtBQUssQ0FDUCxFQUFFLFFBQVEsRUFBRSxFQUNaLGtDQUFrQyxZQUFZLEdBQUcsQ0FDbEQsQ0FBQztZQUVGLE1BQU0sSUFBSSxLQUFLLENBQUMsaUNBQWlDLFlBQVksRUFBRSxDQUFDLENBQUM7U0FDbEU7UUFFRCxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRU0sTUFBTSxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQy9CLE9BQXlCLEVBQ3pCLFNBQW9CLEVBQ3BCLFVBQXlCO1FBRXpCLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUV2QixNQUFNLGFBQWEsR0FBRyxJQUFJLHdCQUF3QixDQUNoRCxPQUFPLEVBQ1AsU0FBUyxFQUNULFVBQVUsQ0FDWCxDQUFDO1FBRUYsTUFBTSxDQUFDLFNBQVMsQ0FDZCxlQUFlLEVBQ2YsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLEdBQUcsRUFDaEIsZ0JBQWdCLENBQUMsWUFBWSxDQUM5QixDQUFDO1FBRUYsT0FBTyxhQUFhLENBQUM7SUFDdkIsQ0FBQztJQUVNLEtBQUssQ0FBQyxTQUFTLENBQUMsVUFBb0I7UUFDekMsTUFBTSxjQUFjLEdBQWlDLEVBQUUsQ0FBQztRQUN4RCxNQUFNLGFBQWEsR0FBZ0MsRUFBRSxDQUFDO1FBRXRELEtBQUssTUFBTSxPQUFPLElBQUksVUFBVSxFQUFFO1lBQ2hDLE1BQU0sS0FBSyxHQUFHLE1BQU0sSUFBSSxDQUFDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1lBQ3BELElBQUksQ0FBQyxLQUFLLEVBQUU7Z0JBQ1YsU0FBUzthQUNWO1lBQ0QsY0FBYyxDQUFDLE9BQU8sQ0FBQyxXQUFXLEVBQUUsQ0FBQyxHQUFHLEtBQUssQ0FBQztZQUU5QyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRTtnQkFDakIsU0FBUzthQUNWO1lBQ0QsYUFBYSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsV0FBVyxFQUFFLENBQUMsR0FBRyxLQUFLLENBQUM7U0FDbkQ7UUFFRCxPQUFPO1lBQ0wsaUJBQWlCLEVBQUUsQ0FBQyxPQUFlLEVBQUUsRUFBRSxDQUNyQyxjQUFjLENBQUMsT0FBTyxDQUFDLFdBQVcsRUFBRSxDQUFDO1lBQ3ZDLGdCQUFnQixFQUFFLENBQUMsTUFBYyxFQUFFLEVBQUUsQ0FBQyxhQUFhLENBQUMsTUFBTSxDQUFDLFdBQVcsRUFBRSxDQUFDO1lBQ3pFLFlBQVksRUFBRSxHQUFZLEVBQUU7Z0JBQzFCLE9BQU8sTUFBTSxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsQ0FBQztZQUN2QyxDQUFDO1NBQ0YsQ0FBQztJQUNKLENBQUM7SUFFTSxLQUFLLENBQUMsZ0JBQWdCLENBQUMsT0FBZTtRQUMzQyxJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUM7UUFFckIseUhBQXlIO1FBQ3pILG1GQUFtRjtRQUNuRixJQUFJLE9BQU8sSUFBSSxLQUFLLEVBQUU7WUFDcEIsTUFBTSxHQUFHLE1BQU0sQ0FBQztTQUNqQjtRQUVELElBQUksQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsQ0FBQyxFQUFFO1lBQ3pELE9BQU8sU0FBUyxDQUFDO1NBQ2xCO1FBRUQsTUFBTSxTQUFTLEdBQ2IsSUFBSSxDQUFDLHNCQUFzQixDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoRSxJQUFJLENBQUMsU0FBUyxFQUFFO1lBQ2QsT0FBTyxTQUFTLENBQUM7U0FDbEI7UUFFRCxNQUFNLEtBQUssR0FBVSxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUM7UUFFdEQsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRU0sS0FBSyxDQUFDLGlCQUFpQixDQUFDLE9BQWU7UUFDNUMsSUFBSSxDQUFDLElBQUksQ0FBQyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRSxDQUFDLEVBQUU7WUFDMUQsT0FBTyxTQUFTLENBQUM7U0FDbEI7UUFFRCxNQUFNLFNBQVMsR0FDYixJQUFJLENBQUMsdUJBQXVCLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsQ0FBRSxDQUNwRCxPQUFPLENBQUMsV0FBVyxFQUFFLENBQ3RCLENBQUM7UUFFSixJQUFJLENBQUMsU0FBUyxFQUFFO1lBQ2QsT0FBTyxTQUFTLENBQUM7U0FDbEI7UUFFRCxNQUFNLEtBQUssR0FBVSxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUM7UUFFdEQsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRU8sS0FBSyxDQUFDLFVBQVUsQ0FBQyxTQUFvQjtRQUMzQyxNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQzNDLE1BQU0sV0FBVyxHQUFHLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLENBQUM7UUFFeEQsSUFBSSxXQUFXLEVBQUU7WUFDZixPQUFPLFdBQVcsQ0FBQztTQUNwQjtRQUVELE1BQU0sS0FBSyxHQUFHLElBQUksS0FBSyxDQUNyQixJQUFJLENBQUMsT0FBTyxFQUNaLFNBQVMsQ0FBQyxPQUFPLEVBQ2pCLFNBQVMsQ0FBQyxRQUFRLEVBQ2xCLFNBQVMsQ0FBQyxNQUFNLEVBQ2hCLFNBQVMsQ0FBQyxJQUFJLENBQ2YsQ0FBQztRQUVGLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRTNDLE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztDQUNGIn0=
@@ -0,0 +1,25 @@
1
+ import { Token } from '@uniswap/sdk-core';
2
+ import { ChainId } from '../util';
3
+ import { ICache } from './cache';
4
+ import { ITokenProvider, TokenAccessor } from './token-provider';
5
+ export declare const CACHE_SEED_TOKENS: {
6
+ [chainId in ChainId]?: {
7
+ [symbol: string]: Token;
8
+ };
9
+ };
10
+ /**
11
+ * Provider for getting token metadata that falls back to a different provider
12
+ * in the event of failure.
13
+ *
14
+ * @export
15
+ * @class CachingTokenProviderWithFallback
16
+ */
17
+ export declare class CachingTokenProviderWithFallback implements ITokenProvider {
18
+ protected chainId: ChainId;
19
+ private tokenCache;
20
+ protected primaryTokenProvider: ITokenProvider;
21
+ protected fallbackTokenProvider?: ITokenProvider | undefined;
22
+ private CACHE_KEY;
23
+ constructor(chainId: ChainId, tokenCache: ICache<Token>, primaryTokenProvider: ITokenProvider, fallbackTokenProvider?: ITokenProvider | undefined);
24
+ getTokens(_addresses: string[]): Promise<TokenAccessor>;
25
+ }
@@ -0,0 +1,195 @@
1
+ import { Token } from '@uniswap/sdk-core';
2
+ import _ from 'lodash';
3
+ import { ChainId, log, WRAPPED_NATIVE_CURRENCY } from '../util';
4
+ import { BTC_BSC, BUSD_BSC, CELO, CELO_ALFAJORES, CEUR_CELO, CUSD_CELO, CUSD_CELO_ALFAJORES, DAI_ARBITRUM, DAI_ARBITRUM_RINKEBY, DAI_BSC, DAI_CELO, DAI_CELO_ALFAJORES, DAI_MAINNET, DAI_MOONBEAM, DAI_OPTIMISM, DAI_OPTIMISM_GOERLI, DAI_OPTIMISTIC_KOVAN, DAI_POLYGON_MUMBAI, DAI_RINKEBY_1, DAI_RINKEBY_2, ETH_BSC, UNI_ARBITRUM_RINKEBY, USDC_ARBITRUM, USDC_ARBITRUM_GOERLI, USDC_ARBITRUM_RINKEBY, USDC_BSC, USDC_ETHEREUM_GNOSIS, USDC_MAINNET, USDC_MOONBEAM, USDC_OPTIMISM, USDC_OPTIMISM_GOERLI, USDC_OPTIMISTIC_KOVAN, USDC_POLYGON, USDT_ARBITRUM, USDT_ARBITRUM_RINKEBY, USDT_BSC, USDT_MAINNET, USDT_OPTIMISM, USDT_OPTIMISM_GOERLI, USDT_OPTIMISTIC_KOVAN, WBTC_ARBITRUM, WBTC_MAINNET, WBTC_MOONBEAM, WBTC_OPTIMISM, WBTC_OPTIMISM_GOERLI, WBTC_OPTIMISTIC_KOVAN, WMATIC_POLYGON, WMATIC_POLYGON_MUMBAI, USDC_CFX, USDT_CFX, DAI_CFX, USDC_CFX_TEST, USDT_CFX_TEST, DAI_CFX_TEST, } from './token-provider';
5
+ // These tokens will added to the Token cache on initialization.
6
+ export const CACHE_SEED_TOKENS = {
7
+ [ChainId.MAINNET]: {
8
+ WETH: WRAPPED_NATIVE_CURRENCY[ChainId.MAINNET],
9
+ USDC: USDC_MAINNET,
10
+ USDT: USDT_MAINNET,
11
+ WBTC: WBTC_MAINNET,
12
+ DAI: DAI_MAINNET,
13
+ // This token stores its symbol as bytes32, therefore can not be fetched on-chain using
14
+ // our token providers.
15
+ // This workaround adds it to the cache, so we won't try to fetch it on-chain.
16
+ RING: new Token(ChainId.MAINNET, '0x9469D013805bFfB7D3DEBe5E7839237e535ec483', 18, 'RING', 'RING'),
17
+ },
18
+ [ChainId.RINKEBY]: {
19
+ WETH: WRAPPED_NATIVE_CURRENCY[ChainId.RINKEBY],
20
+ DAI_1: DAI_RINKEBY_1,
21
+ DAI_2: DAI_RINKEBY_2,
22
+ },
23
+ [ChainId.OPTIMISM]: {
24
+ USDC: USDC_OPTIMISM,
25
+ USDT: USDT_OPTIMISM,
26
+ WBTC: WBTC_OPTIMISM,
27
+ DAI: DAI_OPTIMISM,
28
+ },
29
+ [ChainId.OPTIMISM_GOERLI]: {
30
+ USDC: USDC_OPTIMISM_GOERLI,
31
+ USDT: USDT_OPTIMISM_GOERLI,
32
+ WBTC: WBTC_OPTIMISM_GOERLI,
33
+ DAI: DAI_OPTIMISM_GOERLI,
34
+ },
35
+ [ChainId.OPTIMISTIC_KOVAN]: {
36
+ USDC: USDC_OPTIMISTIC_KOVAN,
37
+ USDT: USDT_OPTIMISTIC_KOVAN,
38
+ WBTC: WBTC_OPTIMISTIC_KOVAN,
39
+ DAI: DAI_OPTIMISTIC_KOVAN,
40
+ },
41
+ [ChainId.ARBITRUM_ONE]: {
42
+ USDC: USDC_ARBITRUM,
43
+ USDT: USDT_ARBITRUM,
44
+ WBTC: WBTC_ARBITRUM,
45
+ DAI: DAI_ARBITRUM,
46
+ },
47
+ [ChainId.ARBITRUM_RINKEBY]: {
48
+ USDT: USDT_ARBITRUM_RINKEBY,
49
+ UNI: UNI_ARBITRUM_RINKEBY,
50
+ DAI: DAI_ARBITRUM_RINKEBY,
51
+ USDC: USDC_ARBITRUM_RINKEBY,
52
+ },
53
+ [ChainId.ARBITRUM_GOERLI]: {
54
+ USDC: USDC_ARBITRUM_GOERLI,
55
+ },
56
+ [ChainId.POLYGON]: {
57
+ WMATIC: WMATIC_POLYGON,
58
+ USDC: USDC_POLYGON,
59
+ },
60
+ [ChainId.POLYGON_MUMBAI]: {
61
+ WMATIC: WMATIC_POLYGON_MUMBAI,
62
+ DAI: DAI_POLYGON_MUMBAI,
63
+ },
64
+ [ChainId.CELO]: {
65
+ CELO: CELO,
66
+ CUSD: CUSD_CELO,
67
+ CEUR: CEUR_CELO,
68
+ DAI: DAI_CELO,
69
+ },
70
+ [ChainId.CELO_ALFAJORES]: {
71
+ CELO: CELO_ALFAJORES,
72
+ CUSD: CUSD_CELO_ALFAJORES,
73
+ CEUR: CUSD_CELO_ALFAJORES,
74
+ DAI: DAI_CELO_ALFAJORES,
75
+ },
76
+ [ChainId.GNOSIS]: {
77
+ WXDAI: WRAPPED_NATIVE_CURRENCY[ChainId.GNOSIS],
78
+ USDC_ETHEREUM_GNOSIS: USDC_ETHEREUM_GNOSIS,
79
+ },
80
+ [ChainId.MOONBEAM]: {
81
+ USDC: USDC_MOONBEAM,
82
+ DAI: DAI_MOONBEAM,
83
+ WBTC: WBTC_MOONBEAM,
84
+ WGLMR: WRAPPED_NATIVE_CURRENCY[ChainId.MOONBEAM],
85
+ },
86
+ [ChainId.BSC]: {
87
+ USDC: USDC_BSC,
88
+ USDT: USDT_BSC,
89
+ BUSD: BUSD_BSC,
90
+ ETH: ETH_BSC,
91
+ DAI: DAI_BSC,
92
+ BTC: BTC_BSC,
93
+ WBNB: WRAPPED_NATIVE_CURRENCY[ChainId.BSC],
94
+ },
95
+ [ChainId.CFX]: {
96
+ USDC: USDC_CFX,
97
+ USDT: USDT_CFX,
98
+ DAI: DAI_CFX,
99
+ },
100
+ [ChainId.CFX_TEST]: {
101
+ USDC: USDC_CFX_TEST,
102
+ USDT: USDT_CFX_TEST,
103
+ DAI: DAI_CFX_TEST,
104
+ },
105
+ // Currently we do not have providers for Moonbeam mainnet or Gnosis testnet
106
+ };
107
+ /**
108
+ * Provider for getting token metadata that falls back to a different provider
109
+ * in the event of failure.
110
+ *
111
+ * @export
112
+ * @class CachingTokenProviderWithFallback
113
+ */
114
+ export class CachingTokenProviderWithFallback {
115
+ constructor(chainId,
116
+ // Token metadata (e.g. symbol and decimals) don't change so can be cached indefinitely.
117
+ // Constructing a new token object is slow as sdk-core does checksumming.
118
+ tokenCache, primaryTokenProvider, fallbackTokenProvider) {
119
+ this.chainId = chainId;
120
+ this.tokenCache = tokenCache;
121
+ this.primaryTokenProvider = primaryTokenProvider;
122
+ this.fallbackTokenProvider = fallbackTokenProvider;
123
+ this.CACHE_KEY = (chainId, address) => `token-${chainId}-${address}`;
124
+ }
125
+ async getTokens(_addresses) {
126
+ const seedTokens = CACHE_SEED_TOKENS[this.chainId];
127
+ if (seedTokens) {
128
+ for (const token of Object.values(seedTokens)) {
129
+ await this.tokenCache.set(this.CACHE_KEY(this.chainId, token.address.toLowerCase()), token);
130
+ }
131
+ }
132
+ const addressToToken = {};
133
+ const symbolToToken = {};
134
+ const addresses = _(_addresses)
135
+ .map((address) => address.toLowerCase())
136
+ .uniq()
137
+ .value();
138
+ const addressesToFindInPrimary = [];
139
+ const addressesToFindInSecondary = [];
140
+ for (const address of addresses) {
141
+ if (await this.tokenCache.has(this.CACHE_KEY(this.chainId, address))) {
142
+ addressToToken[address.toLowerCase()] = (await this.tokenCache.get(this.CACHE_KEY(this.chainId, address)));
143
+ symbolToToken[addressToToken[address].symbol] =
144
+ (await this.tokenCache.get(this.CACHE_KEY(this.chainId, address)));
145
+ }
146
+ else {
147
+ addressesToFindInPrimary.push(address);
148
+ }
149
+ }
150
+ log.info({ addressesToFindInPrimary }, `Found ${addresses.length - addressesToFindInPrimary.length} out of ${addresses.length} tokens in local cache. ${addressesToFindInPrimary.length > 0
151
+ ? `Checking primary token provider for ${addressesToFindInPrimary.length} tokens`
152
+ : ``}
153
+ `);
154
+ if (addressesToFindInPrimary.length > 0) {
155
+ const primaryTokenAccessor = await this.primaryTokenProvider.getTokens(addressesToFindInPrimary);
156
+ for (const address of addressesToFindInPrimary) {
157
+ const token = primaryTokenAccessor.getTokenByAddress(address);
158
+ if (token) {
159
+ addressToToken[address.toLowerCase()] = token;
160
+ symbolToToken[addressToToken[address].symbol] = token;
161
+ await this.tokenCache.set(this.CACHE_KEY(this.chainId, address.toLowerCase()), addressToToken[address]);
162
+ }
163
+ else {
164
+ addressesToFindInSecondary.push(address);
165
+ }
166
+ }
167
+ log.info({ addressesToFindInSecondary }, `Found ${addressesToFindInPrimary.length - addressesToFindInSecondary.length} tokens in primary. ${this.fallbackTokenProvider
168
+ ? `Checking secondary token provider for ${addressesToFindInSecondary.length} tokens`
169
+ : `No fallback token provider specified. About to return.`}`);
170
+ }
171
+ if (this.fallbackTokenProvider && addressesToFindInSecondary.length > 0) {
172
+ const secondaryTokenAccessor = await this.fallbackTokenProvider.getTokens(addressesToFindInSecondary);
173
+ for (const address of addressesToFindInSecondary) {
174
+ const token = secondaryTokenAccessor.getTokenByAddress(address);
175
+ if (token) {
176
+ addressToToken[address.toLowerCase()] = token;
177
+ symbolToToken[addressToToken[address].symbol] = token;
178
+ await this.tokenCache.set(this.CACHE_KEY(this.chainId, address.toLowerCase()), addressToToken[address]);
179
+ }
180
+ }
181
+ }
182
+ return {
183
+ getTokenByAddress: (address) => {
184
+ return addressToToken[address.toLowerCase()];
185
+ },
186
+ getTokenBySymbol: (symbol) => {
187
+ return symbolToToken[symbol.toLowerCase()];
188
+ },
189
+ getAllTokens: () => {
190
+ return Object.values(addressToToken);
191
+ },
192
+ };
193
+ }
194
+ }
195
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"caching-token-provider.js","sourceRoot":"","sources":["../../../src/providers/caching-token-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAGhE,OAAO,EACL,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,cAAc,EACd,SAAS,EACT,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,OAAO,EACP,QAAQ,EACR,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,OAAO,EAGP,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,QAAQ,EACR,oBAAoB,EACpB,YAAY,EACZ,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,aAAa,EACb,aAAa,EACb,YAAY,GACb,MAAM,kBAAkB,CAAC;AAE1B,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAE1B;IACF,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACjB,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,OAAO,CAAE;QAC/C,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,WAAW;QAChB,uFAAuF;QACvF,uBAAuB;QACvB,8EAA8E;QAC9E,IAAI,EAAE,IAAI,KAAK,CACb,OAAO,CAAC,OAAO,EACf,4CAA4C,EAC5C,EAAE,EACF,MAAM,EACN,MAAM,CACP;KACF;IACD,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACjB,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,OAAO,CAAE;QAC/C,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,aAAa;KACrB;IACD,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAClB,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,GAAG,EAAE,YAAY;KAClB;IACD,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;QACzB,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,oBAAoB;QAC1B,GAAG,EAAE,mBAAmB;KACzB;IACD,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;QAC1B,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,qBAAqB;QAC3B,GAAG,EAAE,oBAAoB;KAC1B;IACD,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACtB,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,GAAG,EAAE,YAAY;KAClB;IACD,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;QAC1B,IAAI,EAAE,qBAAqB;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,oBAAoB;QACzB,IAAI,EAAE,qBAAqB;KAC5B;IACD,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;QACzB,IAAI,EAAE,oBAAoB;KAC3B;IACD,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACjB,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,YAAY;KACnB;IACD,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QACxB,MAAM,EAAE,qBAAqB;QAC7B,GAAG,EAAE,kBAAkB;KACxB;IACD,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACd,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,QAAQ;KACd;IACD,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QACxB,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,mBAAmB;QACzB,GAAG,EAAE,kBAAkB;KACxB;IACD,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAChB,KAAK,EAAE,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC;QAC9C,oBAAoB,EAAE,oBAAoB;KAC3C;IACD,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAClB,IAAI,EAAE,aAAa;QACnB,GAAG,EAAE,YAAY;QACjB,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,uBAAuB,CAAC,OAAO,CAAC,QAAQ,CAAC;KACjD;IACD,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACb,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,OAAO;QACZ,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,GAAG,CAAC;KAC3C;IACD,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACb,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,OAAO;KACb;IACD,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAClB,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,GAAG,EAAE,YAAY;KAClB;IAED,4EAA4E;CAC7E,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,OAAO,gCAAgC;IAI3C,YACY,OAAgB;IAC1B,wFAAwF;IACxF,yEAAyE;IACjE,UAAyB,EACvB,oBAAoC,EACpC,qBAAsC;QALtC,YAAO,GAAP,OAAO,CAAS;QAGlB,eAAU,GAAV,UAAU,CAAe;QACvB,yBAAoB,GAApB,oBAAoB,CAAgB;QACpC,0BAAqB,GAArB,qBAAqB,CAAiB;QAT1C,cAAS,GAAG,CAAC,OAAgB,EAAE,OAAe,EAAE,EAAE,CACxD,SAAS,OAAO,IAAI,OAAO,EAAE,CAAC;IAS7B,CAAC;IAEG,KAAK,CAAC,SAAS,CAAC,UAAoB;QACzC,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEnD,IAAI,UAAU,EAAE;YACd,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;gBAC7C,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EACzD,KAAK,CACN,CAAC;aACH;SACF;QAED,MAAM,cAAc,GAAiC,EAAE,CAAC;QACxD,MAAM,aAAa,GAAgC,EAAE,CAAC;QAEtD,MAAM,SAAS,GAAG,CAAC,CAAC,UAAU,CAAC;aAC5B,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;aACvC,IAAI,EAAE;aACN,KAAK,EAAE,CAAC;QAEX,MAAM,wBAAwB,GAAG,EAAE,CAAC;QACpC,MAAM,0BAA0B,GAAG,EAAE,CAAC;QAEtC,KAAK,MAAM,OAAO,IAAI,SAAS,EAAE;YAC/B,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE;gBACpE,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAChE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CACtC,CAAE,CAAC;gBACJ,aAAa,CAAC,cAAc,CAAC,OAAO,CAAE,CAAC,MAAO,CAAC;oBAC7C,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAE,CAAC;aACvE;iBAAM;gBACL,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACxC;SACF;QAED,GAAG,CAAC,IAAI,CACN,EAAE,wBAAwB,EAAE,EAC5B,SAAS,SAAS,CAAC,MAAM,GAAG,wBAAwB,CAAC,MAAM,WACzD,SAAS,CAAC,MACZ,2BACE,wBAAwB,CAAC,MAAM,GAAG,CAAC;YACjC,CAAC,CAAC,uCAAuC,wBAAwB,CAAC,MAAM,SAAS;YACjF,CAAC,CAAC,EACN;OACC,CACF,CAAC;QAEF,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CACpE,wBAAwB,CACzB,CAAC;YAEF,KAAK,MAAM,OAAO,IAAI,wBAAwB,EAAE;gBAC9C,MAAM,KAAK,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAE9D,IAAI,KAAK,EAAE;oBACT,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;oBAC9C,aAAa,CAAC,cAAc,CAAC,OAAO,CAAE,CAAC,MAAO,CAAC,GAAG,KAAK,CAAC;oBACxD,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,EACnD,cAAc,CAAC,OAAO,CAAE,CACzB,CAAC;iBACH;qBAAM;oBACL,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBAC1C;aACF;YAED,GAAG,CAAC,IAAI,CACN,EAAE,0BAA0B,EAAE,EAC9B,SACE,wBAAwB,CAAC,MAAM,GAAG,0BAA0B,CAAC,MAC/D,uBACE,IAAI,CAAC,qBAAqB;gBACxB,CAAC,CAAC,yCAAyC,0BAA0B,CAAC,MAAM,SAAS;gBACrF,CAAC,CAAC,wDACN,EAAE,CACH,CAAC;SACH;QAED,IAAI,IAAI,CAAC,qBAAqB,IAAI,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAAE;YACvE,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,SAAS,CACvE,0BAA0B,CAC3B,CAAC;YAEF,KAAK,MAAM,OAAO,IAAI,0BAA0B,EAAE;gBAChD,MAAM,KAAK,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAChE,IAAI,KAAK,EAAE;oBACT,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;oBAC9C,aAAa,CAAC,cAAc,CAAC,OAAO,CAAE,CAAC,MAAO,CAAC,GAAG,KAAK,CAAC;oBACxD,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,EACnD,cAAc,CAAC,OAAO,CAAE,CACzB,CAAC;iBACH;aACF;SACF;QAED,OAAO;YACL,iBAAiB,EAAE,CAAC,OAAe,EAAqB,EAAE;gBACxD,OAAO,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YAC/C,CAAC;YACD,gBAAgB,EAAE,CAAC,MAAc,EAAqB,EAAE;gBACtD,OAAO,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;YAC7C,CAAC;YACD,YAAY,EAAE,GAAY,EAAE;gBAC1B,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YACvC,CAAC;SACF,CAAC;IACJ,CAAC;CACF"}
@@ -0,0 +1,31 @@
1
+ import { BigNumber } from '@ethersproject/bignumber';
2
+ import { JsonRpcProvider } from '@ethersproject/providers';
3
+ import { GasPrice, IGasPriceProvider } from './gas-price-provider';
4
+ export declare type RawFeeHistoryResponse = {
5
+ baseFeePerGas: string[];
6
+ gasUsedRatio: number[];
7
+ oldestBlock: string;
8
+ reward: string[];
9
+ };
10
+ export declare type FeeHistoryResponse = {
11
+ baseFeePerGas: BigNumber[];
12
+ gasUsedRatio: number[];
13
+ oldestBlock: BigNumber;
14
+ reward: BigNumber[];
15
+ };
16
+ /**
17
+ * Computes a gas estimate using on-chain data from the eth_feeHistory RPC endpoint.
18
+ *
19
+ * Takes the average priority fee from the past `blocksToConsider` blocks, and adds it
20
+ * to the current base fee.
21
+ *
22
+ * @export
23
+ * @class EIP1559GasPriceProvider
24
+ */
25
+ export declare class EIP1559GasPriceProvider extends IGasPriceProvider {
26
+ protected provider: JsonRpcProvider;
27
+ private priorityFeePercentile;
28
+ private blocksToConsider;
29
+ constructor(provider: JsonRpcProvider, priorityFeePercentile?: number, blocksToConsider?: number);
30
+ getGasPrice(): Promise<GasPrice>;
31
+ }
@@ -0,0 +1,59 @@
1
+ import { BigNumber } from '@ethersproject/bignumber';
2
+ import _ from 'lodash';
3
+ import { log } from '../util/log';
4
+ import { IGasPriceProvider } from './gas-price-provider';
5
+ // We get the Xth percentile of priority fees for transactions successfully included in previous blocks.
6
+ const DEFAULT_PRIORITY_FEE_PERCENTILE = 50;
7
+ // Infura docs say only past 4 blocks guaranteed to be available: https://infura.io/docs/ethereum#operation/eth_feeHistory
8
+ const DEFAULT_BLOCKS_TO_LOOK_BACK = 4;
9
+ /**
10
+ * Computes a gas estimate using on-chain data from the eth_feeHistory RPC endpoint.
11
+ *
12
+ * Takes the average priority fee from the past `blocksToConsider` blocks, and adds it
13
+ * to the current base fee.
14
+ *
15
+ * @export
16
+ * @class EIP1559GasPriceProvider
17
+ */
18
+ export class EIP1559GasPriceProvider extends IGasPriceProvider {
19
+ constructor(provider, priorityFeePercentile = DEFAULT_PRIORITY_FEE_PERCENTILE, blocksToConsider = DEFAULT_BLOCKS_TO_LOOK_BACK) {
20
+ super();
21
+ this.provider = provider;
22
+ this.priorityFeePercentile = priorityFeePercentile;
23
+ this.blocksToConsider = blocksToConsider;
24
+ }
25
+ async getGasPrice() {
26
+ const feeHistoryRaw = (await this.provider.send('eth_feeHistory', [
27
+ /**
28
+ * @fix Use BigNumber.from(this.blocksToConsider).toHexString() after hardhat adds support
29
+ * @see https://github.com/NomicFoundation/hardhat/issues/1585 .___.
30
+ */
31
+ BigNumber.from(this.blocksToConsider).toHexString().replace('0x0', '0x'),
32
+ 'latest',
33
+ [this.priorityFeePercentile],
34
+ ]));
35
+ const feeHistory = {
36
+ baseFeePerGas: _.map(feeHistoryRaw.baseFeePerGas, (b) => BigNumber.from(b)),
37
+ gasUsedRatio: feeHistoryRaw.gasUsedRatio,
38
+ oldestBlock: BigNumber.from(feeHistoryRaw.oldestBlock),
39
+ reward: _.map(feeHistoryRaw.reward, (b) => BigNumber.from(b[0])),
40
+ };
41
+ const nextBlockBaseFeePerGas = feeHistory.baseFeePerGas[feeHistory.baseFeePerGas.length - 1];
42
+ const averagePriorityFeePerGas = _.reduce(feeHistory.reward, (sum, cur) => sum.add(cur), BigNumber.from(0)).div(feeHistory.reward.length);
43
+ log.info({
44
+ feeHistory,
45
+ feeHistoryReadable: {
46
+ baseFeePerGas: _.map(feeHistory.baseFeePerGas, (f) => f.toString()),
47
+ oldestBlock: feeHistory.oldestBlock.toString(),
48
+ reward: _.map(feeHistory.reward, (r) => r.toString()),
49
+ },
50
+ nextBlockBaseFeePerGas: nextBlockBaseFeePerGas.toString(),
51
+ averagePriorityFeePerGas: averagePriorityFeePerGas.toString(),
52
+ }, 'Got fee history from provider and computed gas estimate');
53
+ const gasPriceWei = nextBlockBaseFeePerGas.add(averagePriorityFeePerGas);
54
+ const blockNumber = feeHistory.oldestBlock.add(this.blocksToConsider);
55
+ log.info(`Estimated gas price in wei: ${gasPriceWei} as of block ${blockNumber.toString()}`);
56
+ return { gasPriceWei: gasPriceWei };
57
+ }
58
+ }
59
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZWlwLTE1NTktZ2FzLXByaWNlLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9laXAtMTU1OS1nYXMtcHJpY2UtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBRXJELE9BQU8sQ0FBQyxNQUFNLFFBQVEsQ0FBQztBQUV2QixPQUFPLEVBQUUsR0FBRyxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRWxDLE9BQU8sRUFBWSxpQkFBaUIsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBZ0JuRSx3R0FBd0c7QUFDeEcsTUFBTSwrQkFBK0IsR0FBRyxFQUFFLENBQUM7QUFDM0MsMEhBQTBIO0FBQzFILE1BQU0sMkJBQTJCLEdBQUcsQ0FBQyxDQUFDO0FBRXRDOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxPQUFPLHVCQUF3QixTQUFRLGlCQUFpQjtJQUM1RCxZQUNZLFFBQXlCLEVBQzNCLHdCQUFnQywrQkFBK0IsRUFDL0QsbUJBQTJCLDJCQUEyQjtRQUU5RCxLQUFLLEVBQUUsQ0FBQztRQUpFLGFBQVEsR0FBUixRQUFRLENBQWlCO1FBQzNCLDBCQUFxQixHQUFyQixxQkFBcUIsQ0FBMEM7UUFDL0QscUJBQWdCLEdBQWhCLGdCQUFnQixDQUFzQztJQUdoRSxDQUFDO0lBRU0sS0FBSyxDQUFDLFdBQVc7UUFDdEIsTUFBTSxhQUFhLEdBQUcsQ0FBQyxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLGdCQUFnQixFQUFFO1lBQ2hFOzs7ZUFHRztZQUNILFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUMsV0FBVyxFQUFFLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUM7WUFDeEUsUUFBUTtZQUNSLENBQUMsSUFBSSxDQUFDLHFCQUFxQixDQUFDO1NBQzdCLENBQUMsQ0FBMEIsQ0FBQztRQUU3QixNQUFNLFVBQVUsR0FBdUI7WUFDckMsYUFBYSxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsYUFBYSxDQUFDLGFBQWEsRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFLENBQ3RELFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQ2xCO1lBQ0QsWUFBWSxFQUFFLGFBQWEsQ0FBQyxZQUFZO1lBQ3hDLFdBQVcsRUFBRSxTQUFTLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxXQUFXLENBQUM7WUFDdEQsTUFBTSxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztTQUNqRSxDQUFDO1FBRUYsTUFBTSxzQkFBc0IsR0FDMUIsVUFBVSxDQUFDLGFBQWEsQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUUsQ0FBQztRQUVqRSxNQUFNLHdCQUF3QixHQUFHLENBQUMsQ0FBQyxNQUFNLENBQ3ZDLFVBQVUsQ0FBQyxNQUFNLEVBQ2pCLENBQUMsR0FBYyxFQUFFLEdBQWMsRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFDaEQsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FDbEIsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoQyxHQUFHLENBQUMsSUFBSSxDQUNOO1lBQ0UsVUFBVTtZQUNWLGtCQUFrQixFQUFFO2dCQUNsQixhQUFhLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUMsYUFBYSxFQUFFLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUM7Z0JBQ25FLFdBQVcsRUFBRSxVQUFVLENBQUMsV0FBVyxDQUFDLFFBQVEsRUFBRTtnQkFDOUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDLFFBQVEsRUFBRSxDQUFDO2FBQ3REO1lBQ0Qsc0JBQXNCLEVBQUUsc0JBQXNCLENBQUMsUUFBUSxFQUFFO1lBQ3pELHdCQUF3QixFQUFFLHdCQUF3QixDQUFDLFFBQVEsRUFBRTtTQUM5RCxFQUNELHlEQUF5RCxDQUMxRCxDQUFDO1FBRUYsTUFBTSxXQUFXLEdBQUcsc0JBQXNCLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUM7UUFFekUsTUFBTSxXQUFXLEdBQUcsVUFBVSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFFdEUsR0FBRyxDQUFDLElBQUksQ0FDTiwrQkFBK0IsV0FBVyxnQkFBZ0IsV0FBVyxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQ25GLENBQUM7UUFFRixPQUFPLEVBQUUsV0FBVyxFQUFFLFdBQVcsRUFBRSxDQUFDO0lBQ3RDLENBQUM7Q0FDRiJ9
@@ -0,0 +1,16 @@
1
+ import { JsonRpcProvider } from '@ethersproject/providers';
2
+ import { SwapOptions, SwapRoute } from '../routers';
3
+ import { ChainId } from '../util';
4
+ import { ProviderConfig } from './provider';
5
+ import { Simulator } from './simulation-provider';
6
+ import { IV2PoolProvider } from './v2/pool-provider';
7
+ import { ArbitrumGasData, OptimismGasData } from './v3/gas-data-provider';
8
+ import { IV3PoolProvider } from './v3/pool-provider';
9
+ export declare class EthEstimateGasSimulator extends Simulator {
10
+ v2PoolProvider: IV2PoolProvider;
11
+ v3PoolProvider: IV3PoolProvider;
12
+ constructor(chainId: ChainId, provider: JsonRpcProvider, v2PoolProvider: IV2PoolProvider, v3PoolProvider: IV3PoolProvider);
13
+ ethEstimateGas(fromAddress: string, swapOptions: SwapOptions, route: SwapRoute, l2GasData?: ArbitrumGasData | OptimismGasData): Promise<SwapRoute>;
14
+ private inflateGasLimit;
15
+ protected simulateTransaction(fromAddress: string, swapOptions: any, swapRoute: SwapRoute, l2GasData?: OptimismGasData | ArbitrumGasData | undefined, _providerConfig?: ProviderConfig | undefined): Promise<SwapRoute>;
16
+ }
@@ -0,0 +1,82 @@
1
+ import { BigNumber } from '@ethersproject/bignumber';
2
+ import { SwapType } from '../routers';
3
+ import { log } from '../util';
4
+ import { calculateGasUsed, initSwapRouteFromExisting, } from '../util/gas-factory-helpers';
5
+ import { SimulationStatus, Simulator } from './simulation-provider';
6
+ export class EthEstimateGasSimulator extends Simulator {
7
+ constructor(chainId, provider, v2PoolProvider, v3PoolProvider) {
8
+ super(provider, chainId);
9
+ this.v2PoolProvider = v2PoolProvider;
10
+ this.v3PoolProvider = v3PoolProvider;
11
+ }
12
+ async ethEstimateGas(fromAddress, swapOptions, route, l2GasData) {
13
+ const currencyIn = route.trade.inputAmount.currency;
14
+ let estimatedGasUsed;
15
+ if (swapOptions.type == SwapType.UNIVERSAL_ROUTER) {
16
+ log.info({ methodParameters: route.methodParameters }, 'Simulating using eth_estimateGas on Universal Router');
17
+ try {
18
+ estimatedGasUsed = await this.provider.estimateGas({
19
+ data: route.methodParameters.calldata,
20
+ to: route.methodParameters.to,
21
+ from: fromAddress,
22
+ value: BigNumber.from(currencyIn.isNative ? route.methodParameters.value : '0'),
23
+ });
24
+ }
25
+ catch (e) {
26
+ log.error({ e }, 'Error estimating gas');
27
+ return {
28
+ ...route,
29
+ simulationStatus: SimulationStatus.Failed,
30
+ };
31
+ }
32
+ }
33
+ else if (swapOptions.type == SwapType.SWAP_ROUTER_02) {
34
+ log.info({ methodParameters: route.methodParameters }, 'Simulating using eth_estimateGas on SwapRouter02');
35
+ try {
36
+ estimatedGasUsed = await this.provider.estimateGas({
37
+ data: route.methodParameters.calldata,
38
+ to: route.methodParameters.to,
39
+ from: fromAddress,
40
+ value: BigNumber.from(currencyIn.isNative ? route.methodParameters.value : '0'),
41
+ });
42
+ }
43
+ catch (e) {
44
+ log.error({ e }, 'Error estimating gas');
45
+ return {
46
+ ...route,
47
+ simulationStatus: SimulationStatus.Failed,
48
+ };
49
+ }
50
+ }
51
+ else {
52
+ throw new Error(`Unsupported swap type ${swapOptions}`);
53
+ }
54
+ estimatedGasUsed = this.inflateGasLimit(estimatedGasUsed);
55
+ const { estimatedGasUsedUSD, estimatedGasUsedQuoteToken, quoteGasAdjusted, } = await calculateGasUsed(route.quote.currency.chainId, route, estimatedGasUsed, this.v2PoolProvider, this.v3PoolProvider, l2GasData);
56
+ return {
57
+ ...initSwapRouteFromExisting(route, this.v2PoolProvider, this.v3PoolProvider, quoteGasAdjusted, estimatedGasUsed, estimatedGasUsedQuoteToken, estimatedGasUsedUSD),
58
+ simulationStatus: SimulationStatus.Succeeded,
59
+ };
60
+ }
61
+ inflateGasLimit(gasLimit) {
62
+ // multiply by 1.2
63
+ return gasLimit.add(gasLimit.div(5));
64
+ }
65
+ async simulateTransaction(fromAddress, swapOptions, swapRoute, l2GasData,
66
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
67
+ _providerConfig) {
68
+ const inputAmount = swapRoute.trade.inputAmount;
69
+ if (inputAmount.currency.isNative ||
70
+ (await this.checkTokenApproved(fromAddress, inputAmount, swapOptions, this.provider))) {
71
+ return await this.ethEstimateGas(fromAddress, swapOptions, swapRoute, l2GasData);
72
+ }
73
+ else {
74
+ log.info('Token not approved, skipping simulation');
75
+ return {
76
+ ...swapRoute,
77
+ simulationStatus: SimulationStatus.NotApproved,
78
+ };
79
+ }
80
+ }
81
+ }
82
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXRoLWVzdGltYXRlLWdhcy1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wcm92aWRlcnMvZXRoLWVzdGltYXRlLWdhcy1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFHckQsT0FBTyxFQUEwQixRQUFRLEVBQUUsTUFBTSxZQUFZLENBQUM7QUFDOUQsT0FBTyxFQUFXLEdBQUcsRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUN2QyxPQUFPLEVBQ0wsZ0JBQWdCLEVBQ2hCLHlCQUF5QixHQUMxQixNQUFNLDZCQUE2QixDQUFDO0FBR3JDLE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxTQUFTLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUtwRSxNQUFNLE9BQU8sdUJBQXdCLFNBQVEsU0FBUztJQUdwRCxZQUNFLE9BQWdCLEVBQ2hCLFFBQXlCLEVBQ3pCLGNBQStCLEVBQy9CLGNBQStCO1FBRS9CLEtBQUssQ0FBQyxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDekIsSUFBSSxDQUFDLGNBQWMsR0FBRyxjQUFjLENBQUM7UUFDckMsSUFBSSxDQUFDLGNBQWMsR0FBRyxjQUFjLENBQUM7SUFDdkMsQ0FBQztJQUNELEtBQUssQ0FBQyxjQUFjLENBQ2xCLFdBQW1CLEVBQ25CLFdBQXdCLEVBQ3hCLEtBQWdCLEVBQ2hCLFNBQTZDO1FBRTdDLE1BQU0sVUFBVSxHQUFHLEtBQUssQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLFFBQVEsQ0FBQztRQUNwRCxJQUFJLGdCQUEyQixDQUFDO1FBQ2hDLElBQUksV0FBVyxDQUFDLElBQUksSUFBSSxRQUFRLENBQUMsZ0JBQWdCLEVBQUU7WUFDakQsR0FBRyxDQUFDLElBQUksQ0FDTixFQUFFLGdCQUFnQixFQUFFLEtBQUssQ0FBQyxnQkFBZ0IsRUFBRSxFQUM1QyxzREFBc0QsQ0FDdkQsQ0FBQztZQUNGLElBQUk7Z0JBQ0YsZ0JBQWdCLEdBQUcsTUFBTSxJQUFJLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQztvQkFDakQsSUFBSSxFQUFFLEtBQUssQ0FBQyxnQkFBaUIsQ0FBQyxRQUFRO29CQUN0QyxFQUFFLEVBQUUsS0FBSyxDQUFDLGdCQUFpQixDQUFDLEVBQUU7b0JBQzlCLElBQUksRUFBRSxXQUFXO29CQUNqQixLQUFLLEVBQUUsU0FBUyxDQUFDLElBQUksQ0FDbkIsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLGdCQUFpQixDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUMxRDtpQkFDRixDQUFDLENBQUM7YUFDSjtZQUFDLE9BQU8sQ0FBQyxFQUFFO2dCQUNWLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRSxzQkFBc0IsQ0FBQyxDQUFDO2dCQUN6QyxPQUFPO29CQUNMLEdBQUcsS0FBSztvQkFDUixnQkFBZ0IsRUFBRSxnQkFBZ0IsQ0FBQyxNQUFNO2lCQUMxQyxDQUFDO2FBQ0g7U0FDRjthQUFNLElBQUksV0FBVyxDQUFDLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxFQUFFO1lBQ3RELEdBQUcsQ0FBQyxJQUFJLENBQ04sRUFBRSxnQkFBZ0IsRUFBRSxLQUFLLENBQUMsZ0JBQWdCLEVBQUUsRUFDNUMsa0RBQWtELENBQ25ELENBQUM7WUFFRixJQUFJO2dCQUNGLGdCQUFnQixHQUFHLE1BQU0sSUFBSSxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUM7b0JBQ2pELElBQUksRUFBRSxLQUFLLENBQUMsZ0JBQWlCLENBQUMsUUFBUTtvQkFDdEMsRUFBRSxFQUFFLEtBQUssQ0FBQyxnQkFBaUIsQ0FBQyxFQUFFO29CQUM5QixJQUFJLEVBQUUsV0FBVztvQkFDakIsS0FBSyxFQUFFLFNBQVMsQ0FBQyxJQUFJLENBQ25CLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxnQkFBaUIsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FDMUQ7aUJBQ0YsQ0FBQyxDQUFDO2FBQ0o7WUFBQyxPQUFPLENBQUMsRUFBRTtnQkFDVixHQUFHLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUUsc0JBQXNCLENBQUMsQ0FBQztnQkFDekMsT0FBTztvQkFDTCxHQUFHLEtBQUs7b0JBQ1IsZ0JBQWdCLEVBQUUsZ0JBQWdCLENBQUMsTUFBTTtpQkFDMUMsQ0FBQzthQUNIO1NBQ0Y7YUFBTTtZQUNMLE1BQU0sSUFBSSxLQUFLLENBQUMseUJBQXlCLFdBQVcsRUFBRSxDQUFDLENBQUM7U0FDekQ7UUFFRCxnQkFBZ0IsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFFMUQsTUFBTSxFQUNKLG1CQUFtQixFQUNuQiwwQkFBMEIsRUFDMUIsZ0JBQWdCLEdBQ2pCLEdBQUcsTUFBTSxnQkFBZ0IsQ0FDeEIsS0FBSyxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUM1QixLQUFLLEVBQ0wsZ0JBQWdCLEVBQ2hCLElBQUksQ0FBQyxjQUFjLEVBQ25CLElBQUksQ0FBQyxjQUFjLEVBQ25CLFNBQVMsQ0FDVixDQUFDO1FBRUYsT0FBTztZQUNMLEdBQUcseUJBQXlCLENBQzFCLEtBQUssRUFDTCxJQUFJLENBQUMsY0FBYyxFQUNuQixJQUFJLENBQUMsY0FBYyxFQUNuQixnQkFBZ0IsRUFDaEIsZ0JBQWdCLEVBQ2hCLDBCQUEwQixFQUMxQixtQkFBbUIsQ0FDcEI7WUFDRCxnQkFBZ0IsRUFBRSxnQkFBZ0IsQ0FBQyxTQUFTO1NBQzdDLENBQUM7SUFDSixDQUFDO0lBQ08sZUFBZSxDQUFDLFFBQW1CO1FBQ3pDLGtCQUFrQjtRQUNsQixPQUFPLFFBQVEsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3ZDLENBQUM7SUFDUyxLQUFLLENBQUMsbUJBQW1CLENBQ2pDLFdBQW1CLEVBQ25CLFdBQWdCLEVBQ2hCLFNBQW9CLEVBQ3BCLFNBQXlEO0lBQ3pELDZEQUE2RDtJQUM3RCxlQUE0QztRQUU1QyxNQUFNLFdBQVcsR0FBRyxTQUFTLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQztRQUNoRCxJQUNFLFdBQVcsQ0FBQyxRQUFRLENBQUMsUUFBUTtZQUM3QixDQUFDLE1BQU0sSUFBSSxDQUFDLGtCQUFrQixDQUM1QixXQUFXLEVBQ1gsV0FBVyxFQUNYLFdBQVcsRUFDWCxJQUFJLENBQUMsUUFBUSxDQUNkLENBQUMsRUFDRjtZQUNBLE9BQU8sTUFBTSxJQUFJLENBQUMsY0FBYyxDQUM5QixXQUFXLEVBQ1gsV0FBVyxFQUNYLFNBQVMsRUFDVCxTQUFTLENBQ1YsQ0FBQztTQUNIO2FBQU07WUFDTCxHQUFHLENBQUMsSUFBSSxDQUFDLHlDQUF5QyxDQUFDLENBQUM7WUFDcEQsT0FBTztnQkFDTCxHQUFHLFNBQVM7Z0JBQ1osZ0JBQWdCLEVBQUUsZ0JBQWdCLENBQUMsV0FBVzthQUMvQyxDQUFDO1NBQ0g7SUFDSCxDQUFDO0NBQ0YifQ==
@@ -0,0 +1,19 @@
1
+ import { GasPrice, IGasPriceProvider } from './gas-price-provider';
2
+ export declare type ETHGasStationResponse = {
3
+ fast: number;
4
+ fastest: number;
5
+ safeLow: number;
6
+ average: number;
7
+ block_time: number;
8
+ blockNum: number;
9
+ speed: number;
10
+ safeLowWait: number;
11
+ avgWait: number;
12
+ fastWait: number;
13
+ fastestWait: number;
14
+ };
15
+ export declare class ETHGasStationInfoProvider extends IGasPriceProvider {
16
+ private url;
17
+ constructor(url: string);
18
+ getGasPrice(): Promise<GasPrice>;
19
+ }
@@ -0,0 +1,30 @@
1
+ import { BigNumber } from '@ethersproject/bignumber';
2
+ import retry from 'async-retry';
3
+ import axios from 'axios';
4
+ import { log } from '../util/log';
5
+ import { IGasPriceProvider } from './gas-price-provider';
6
+ export class ETHGasStationInfoProvider extends IGasPriceProvider {
7
+ constructor(url) {
8
+ super();
9
+ this.url = url;
10
+ }
11
+ async getGasPrice() {
12
+ log.info(`About to get gas prices from gas station ${this.url}`);
13
+ const response = await retry(async () => {
14
+ return axios.get(this.url);
15
+ }, { retries: 1 });
16
+ const { data: gasPriceResponse, status } = response;
17
+ if (status != 200) {
18
+ log.error({ response }, `Unabled to get gas price from ${this.url}.`);
19
+ throw new Error(`Unable to get gas price from ${this.url}`);
20
+ }
21
+ log.info({ gasPriceResponse }, 'Gas price response from API. About to parse "fast" to big number');
22
+ // Gas prices from ethgasstation are in GweiX10.
23
+ const gasPriceWei = BigNumber.from(gasPriceResponse.fast)
24
+ .div(BigNumber.from(10))
25
+ .mul(BigNumber.from(10).pow(9));
26
+ log.info(`Gas price in wei: ${gasPriceWei} as of block ${gasPriceResponse.blockNum}`);
27
+ return { gasPriceWei: gasPriceWei };
28
+ }
29
+ }
30
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXRoLWdhcy1zdGF0aW9uLWluZm8tZ2FzLXByaWNlLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9ldGgtZ2FzLXN0YXRpb24taW5mby1nYXMtcHJpY2UtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBQ3JELE9BQU8sS0FBSyxNQUFNLGFBQWEsQ0FBQztBQUNoQyxPQUFPLEtBQUssTUFBTSxPQUFPLENBQUM7QUFFMUIsT0FBTyxFQUFFLEdBQUcsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUVsQyxPQUFPLEVBQVksaUJBQWlCLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQWlCbkUsTUFBTSxPQUFPLHlCQUEwQixTQUFRLGlCQUFpQjtJQUU5RCxZQUFZLEdBQVc7UUFDckIsS0FBSyxFQUFFLENBQUM7UUFDUixJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztJQUNqQixDQUFDO0lBRU0sS0FBSyxDQUFDLFdBQVc7UUFDdEIsR0FBRyxDQUFDLElBQUksQ0FBQyw0Q0FBNEMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDakUsTUFBTSxRQUFRLEdBQUcsTUFBTSxLQUFLLENBQzFCLEtBQUssSUFBSSxFQUFFO1lBQ1QsT0FBTyxLQUFLLENBQUMsR0FBRyxDQUF3QixJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDcEQsQ0FBQyxFQUNELEVBQUUsT0FBTyxFQUFFLENBQUMsRUFBRSxDQUNmLENBQUM7UUFFRixNQUFNLEVBQUUsSUFBSSxFQUFFLGdCQUFnQixFQUFFLE1BQU0sRUFBRSxHQUFHLFFBQVEsQ0FBQztRQUVwRCxJQUFJLE1BQU0sSUFBSSxHQUFHLEVBQUU7WUFDakIsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLFFBQVEsRUFBRSxFQUFFLGlDQUFpQyxJQUFJLENBQUMsR0FBRyxHQUFHLENBQUMsQ0FBQztZQUV0RSxNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztTQUM3RDtRQUVELEdBQUcsQ0FBQyxJQUFJLENBQ04sRUFBRSxnQkFBZ0IsRUFBRSxFQUNwQixrRUFBa0UsQ0FDbkUsQ0FBQztRQUVGLGdEQUFnRDtRQUNoRCxNQUFNLFdBQVcsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQzthQUN0RCxHQUFHLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQzthQUN2QixHQUFHLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUVsQyxHQUFHLENBQUMsSUFBSSxDQUNOLHFCQUFxQixXQUFXLGdCQUFnQixnQkFBZ0IsQ0FBQyxRQUFRLEVBQUUsQ0FDNUUsQ0FBQztRQUVGLE9BQU8sRUFBRSxXQUFXLEVBQUUsV0FBVyxFQUFFLENBQUM7SUFDdEMsQ0FBQztDQUNGIn0=
@@ -0,0 +1,10 @@
1
+ import { BigNumber } from '@ethersproject/bignumber';
2
+ export declare type GasPrice = {
3
+ gasPriceWei: BigNumber;
4
+ };
5
+ /**
6
+ * Provider for getting gas prices.
7
+ */
8
+ export declare abstract class IGasPriceProvider {
9
+ abstract getGasPrice(): Promise<GasPrice>;
10
+ }
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Provider for getting gas prices.
3
+ */
4
+ export class IGasPriceProvider {
5
+ }
6
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2FzLXByaWNlLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9nYXMtcHJpY2UtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBTUE7O0dBRUc7QUFDSCxNQUFNLE9BQWdCLGlCQUFpQjtDQUV0QyJ9