@compass-labs/api-sdk 2.1.11 → 2.1.12-rc.1

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 (627) hide show
  1. package/CONTRIBUTING.md +26 -0
  2. package/USAGE.md +20 -0
  3. package/codeSamples_typescript.yaml +551 -0
  4. package/dist/commonjs/funcs/bridgeCctpBurn.d.ts +1 -1
  5. package/dist/commonjs/funcs/bridgeCctpBurn.js +1 -1
  6. package/dist/commonjs/funcs/bridgeCctpMint.d.ts +2 -4
  7. package/dist/commonjs/funcs/bridgeCctpMint.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/bridgeCctpMint.js +2 -4
  9. package/dist/commonjs/funcs/bridgeCctpMint.js.map +1 -1
  10. package/dist/commonjs/lib/config.d.ts +2 -2
  11. package/dist/commonjs/lib/config.js +2 -2
  12. package/dist/commonjs/sdk/bridge.d.ts +3 -5
  13. package/dist/commonjs/sdk/bridge.d.ts.map +1 -1
  14. package/dist/commonjs/sdk/bridge.js +3 -5
  15. package/dist/commonjs/sdk/bridge.js.map +1 -1
  16. package/dist/esm/funcs/bridgeCctpBurn.d.ts +1 -1
  17. package/dist/esm/funcs/bridgeCctpBurn.js +1 -1
  18. package/dist/esm/funcs/bridgeCctpMint.d.ts +2 -4
  19. package/dist/esm/funcs/bridgeCctpMint.d.ts.map +1 -1
  20. package/dist/esm/funcs/bridgeCctpMint.js +2 -4
  21. package/dist/esm/funcs/bridgeCctpMint.js.map +1 -1
  22. package/dist/esm/lib/config.d.ts +2 -2
  23. package/dist/esm/lib/config.js +2 -2
  24. package/dist/esm/sdk/bridge.d.ts +3 -5
  25. package/dist/esm/sdk/bridge.d.ts.map +1 -1
  26. package/dist/esm/sdk/bridge.js +3 -5
  27. package/dist/esm/sdk/bridge.js.map +1 -1
  28. package/docs/lib/utils/retryconfig.md +24 -0
  29. package/docs/models/components/aaveavgrateresponse.md +27 -0
  30. package/docs/models/components/aaveborrowparams.md +24 -0
  31. package/docs/models/components/aaveborrowparamsamount.md +19 -0
  32. package/docs/models/components/aaveborrowrequest.md +29 -0
  33. package/docs/models/components/aaveborrowrequestamount.md +19 -0
  34. package/docs/models/components/aaveborrowrequestchain.md +15 -0
  35. package/docs/models/components/aavehistoricaltransactionsresponse.md +23 -0
  36. package/docs/models/components/aavehistoricaltransactionsresponsetransaction.md +148 -0
  37. package/docs/models/components/aaveliquiditychangeresponse.md +21 -0
  38. package/docs/models/components/aavelooprequest.md +46 -0
  39. package/docs/models/components/aavelooprequestchain.md +15 -0
  40. package/docs/models/components/aaveposition.md +25 -0
  41. package/docs/models/components/aaverateresponse.md +27 -0
  42. package/docs/models/components/aaverepayparams.md +24 -0
  43. package/docs/models/components/aaverepayparamsamount.md +19 -0
  44. package/docs/models/components/aaverepayrequest.md +29 -0
  45. package/docs/models/components/aaverepayrequestamount.md +19 -0
  46. package/docs/models/components/aaverepayrequestchain.md +15 -0
  47. package/docs/models/components/aavereserveoverviewresponse.md +21 -0
  48. package/docs/models/components/aavestdrateresponse.md +27 -0
  49. package/docs/models/components/aavesupplyparams.md +22 -0
  50. package/docs/models/components/aavesupplyparamsamount.md +19 -0
  51. package/docs/models/components/aavesupplyrequest.md +26 -0
  52. package/docs/models/components/aavesupplyrequestamount.md +19 -0
  53. package/docs/models/components/aavesupplyrequestchain.md +15 -0
  54. package/docs/models/components/aavesupportedtokenmetadata.md +23 -0
  55. package/docs/models/components/aavesupportedtokensresponse.md +24 -0
  56. package/docs/models/components/aavetokenpriceresponse.md +17 -0
  57. package/docs/models/components/aaveusdcratesresponse.md +40 -0
  58. package/docs/models/components/aaveuserpositionpertokenresponse.md +33 -0
  59. package/docs/models/components/aaveuserpositionsummaryresponse.md +27 -0
  60. package/docs/models/components/aavevenue.md +19 -0
  61. package/docs/models/components/aavewithdrawparams.md +23 -0
  62. package/docs/models/components/aavewithdrawparamsamount.md +19 -0
  63. package/docs/models/components/aavewithdrawrequest.md +27 -0
  64. package/docs/models/components/aavewithdrawrequestamount.md +19 -0
  65. package/docs/models/components/aavewithdrawrequestchain.md +15 -0
  66. package/docs/models/components/aerodromelppositionsresponse.md +17 -0
  67. package/docs/models/components/aerodromeposition.md +41 -0
  68. package/docs/models/components/aerodromeslipstreambuyexactlyparams.md +29 -0
  69. package/docs/models/components/aerodromeslipstreambuyexactlyparamsamountinmaximum.md +19 -0
  70. package/docs/models/components/aerodromeslipstreambuyexactlyparamsamountout.md +19 -0
  71. package/docs/models/components/aerodromeslipstreambuyexactlyrequest.md +33 -0
  72. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountinmaximum.md +19 -0
  73. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountout.md +19 -0
  74. package/docs/models/components/aerodromeslipstreambuyexactlyrequestchain.md +15 -0
  75. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparams.md +32 -0
  76. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount0desired.md +19 -0
  77. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount0min.md +19 -0
  78. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount1desired.md +19 -0
  79. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionparamsamount1min.md +19 -0
  80. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequest.md +31 -0
  81. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0desired.md +19 -0
  82. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0min.md +19 -0
  83. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1desired.md +19 -0
  84. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1min.md +19 -0
  85. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestchain.md +15 -0
  86. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparams.md +38 -0
  87. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount0desired.md +19 -0
  88. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount0min.md +19 -0
  89. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount1desired.md +19 -0
  90. package/docs/models/components/aerodromeslipstreammintliquidityprovisionparamsamount1min.md +19 -0
  91. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequest.md +43 -0
  92. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0desired.md +19 -0
  93. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0min.md +19 -0
  94. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1desired.md +19 -0
  95. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1min.md +19 -0
  96. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestchain.md +15 -0
  97. package/docs/models/components/aerodromeslipstreampoolpriceresponse.md +23 -0
  98. package/docs/models/components/aerodromeslipstreamsellexactlyparams.md +29 -0
  99. package/docs/models/components/aerodromeslipstreamsellexactlyparamsamountin.md +19 -0
  100. package/docs/models/components/aerodromeslipstreamsellexactlyparamsamountoutminimum.md +19 -0
  101. package/docs/models/components/aerodromeslipstreamsellexactlyrequest.md +33 -0
  102. package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountin.md +19 -0
  103. package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountoutminimum.md +19 -0
  104. package/docs/models/components/aerodromeslipstreamsellexactlyrequestchain.md +15 -0
  105. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionparams.md +26 -0
  106. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionparamspercentageforwithdrawal.md +19 -0
  107. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequest.md +25 -0
  108. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestchain.md +15 -0
  109. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +19 -0
  110. package/docs/models/components/allowanceinforesponse.md +27 -0
  111. package/docs/models/components/approvetransferrequest.md +22 -0
  112. package/docs/models/components/approvetransferresponse.md +48 -0
  113. package/docs/models/components/apy.md +23 -0
  114. package/docs/models/components/batchedsafeoperationsresponseinput.md +47 -0
  115. package/docs/models/components/batchedsafeoperationsresponseoutput.md +47 -0
  116. package/docs/models/components/batcheduseroperationsrequest.md +36 -0
  117. package/docs/models/components/batcheduseroperationsrequestchain.md +15 -0
  118. package/docs/models/components/batcheduseroperationsresponse.md +17 -0
  119. package/docs/models/components/body.md +424 -0
  120. package/docs/models/components/borrow.md +37 -0
  121. package/docs/models/components/borrowratemode.md +17 -0
  122. package/docs/models/components/bundlertransactionresponse.md +28 -0
  123. package/docs/models/components/chain.md +17 -0
  124. package/docs/models/components/chaininfo.md +18 -0
  125. package/docs/models/components/chainratedata.md +21 -0
  126. package/docs/models/components/compassapibackendv1modelsgenericreadresponseportfoliotokenbalance.md +27 -0
  127. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionapydata.md +20 -0
  128. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionasset.md +27 -0
  129. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionmarketstate.md +34 -0
  130. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultposition.md +52 -0
  131. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultstate.md +24 -0
  132. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketapydata.md +23 -0
  133. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketasset.md +27 -0
  134. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketmarketstate.md +28 -0
  135. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketsasset.md +23 -0
  136. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketsmarketstate.md +31 -0
  137. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsasset.md +25 -0
  138. package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsvaultstate.md +28 -0
  139. package/docs/models/components/compassapibackendv1modelspendlereadresponsemarketuserposition.md +28 -0
  140. package/docs/models/components/compassapibackendv1modelspendlereadresponsepositionstokenbalance.md +19 -0
  141. package/docs/models/components/compassapibackendv1modelsvaultsreadresponsevaultuserposition.md +19 -0
  142. package/docs/models/components/compassapibackendv1modelswildcatreadresponsemarketuserposition.md +19 -0
  143. package/docs/models/components/compassapibackendv2modelsearnreadresponsepositionsvaultposition.md +27 -0
  144. package/docs/models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712domain.md +21 -0
  145. package/docs/models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712types.md +61 -0
  146. package/docs/models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712domain.md +26 -0
  147. package/docs/models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712types.md +21 -0
  148. package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md +23 -0
  149. package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md +23 -0
  150. package/docs/models/components/cooldownend.md +19 -0
  151. package/docs/models/components/cooldownposition.md +21 -0
  152. package/docs/models/components/createaccountrequest.md +24 -0
  153. package/docs/models/components/createaccountrequestchain.md +15 -0
  154. package/docs/models/components/createaccountresponse.md +31 -0
  155. package/docs/models/components/denomination.md +17 -0
  156. package/docs/models/components/depositforburnrequest.md +27 -0
  157. package/docs/models/components/depositforburnrequestamount.md +19 -0
  158. package/docs/models/components/depositforburnrequestchain.md +17 -0
  159. package/docs/models/components/depositforburnrequesttransfermode.md +17 -0
  160. package/docs/models/components/depositforburnresponse.md +68 -0
  161. package/docs/models/components/depositforburnresponsetransfermode.md +17 -0
  162. package/docs/models/components/destinationchain.md +17 -0
  163. package/docs/models/components/details.md +33 -0
  164. package/docs/models/components/earnmanagerequest.md +30 -0
  165. package/docs/models/components/earnmanagerequestaction.md +17 -0
  166. package/docs/models/components/earnmanageresponse.md +29 -0
  167. package/docs/models/components/earnpositionresponse.md +26 -0
  168. package/docs/models/components/earnpositionsresponse.md +17 -0
  169. package/docs/models/components/earnswaprequest.md +29 -0
  170. package/docs/models/components/earnswaprequestamountin.md +19 -0
  171. package/docs/models/components/earnswapresponse.md +58 -0
  172. package/docs/models/components/earntransferrequest.md +27 -0
  173. package/docs/models/components/earntransferrequestaction.md +17 -0
  174. package/docs/models/components/earntransferrequestamount.md +19 -0
  175. package/docs/models/components/earntransferresponse.md +56 -0
  176. package/docs/models/components/earntransferresponseeip712.md +102 -0
  177. package/docs/models/components/eip712domainfield.md +21 -0
  178. package/docs/models/components/eip712field.md +19 -0
  179. package/docs/models/components/ensnameinforesponse.md +21 -0
  180. package/docs/models/components/erc20data.md +23 -0
  181. package/docs/models/components/ethenadepositparams.md +20 -0
  182. package/docs/models/components/ethenadepositparamsamount.md +19 -0
  183. package/docs/models/components/ethenadepositrequest.md +24 -0
  184. package/docs/models/components/ethenadepositrequestamount.md +19 -0
  185. package/docs/models/components/ethenadepositrequestchain.md +15 -0
  186. package/docs/models/components/ethenagetvaultresponse.md +45 -0
  187. package/docs/models/components/ethenarequesttowithdrawparams.md +19 -0
  188. package/docs/models/components/ethenarequesttowithdrawrequest.md +23 -0
  189. package/docs/models/components/ethenarequesttowithdrawrequestchain.md +15 -0
  190. package/docs/models/components/ethenarequesttowithdrawtransactionresponse.md +29 -0
  191. package/docs/models/components/ethenarequesttowithdrawtransactionresponsetransaction.md +33 -0
  192. package/docs/models/components/ethenaunstakeparams.md +18 -0
  193. package/docs/models/components/ethenaunstakerequest.md +22 -0
  194. package/docs/models/components/ethenaunstakerequestchain.md +15 -0
  195. package/docs/models/components/fee.md +21 -0
  196. package/docs/models/components/feeamount.md +19 -0
  197. package/docs/models/components/feeenum.md +19 -0
  198. package/docs/models/components/initialcollateralamount.md +19 -0
  199. package/docs/models/components/interestratemode.md +19 -0
  200. package/docs/models/components/liquidationcall.md +45 -0
  201. package/docs/models/components/loantovalue.md +19 -0
  202. package/docs/models/components/loc.md +17 -0
  203. package/docs/models/components/lpbalance.md +21 -0
  204. package/docs/models/components/market.md +17 -0
  205. package/docs/models/components/marketposition.md +35 -0
  206. package/docs/models/components/markettokens.md +50 -0
  207. package/docs/models/components/maxslippagepercent.md +19 -0
  208. package/docs/models/components/maxsupplyapydata.md +24 -0
  209. package/docs/models/components/mintpreparecompletedresponse.md +27 -0
  210. package/docs/models/components/mintpreparependingresponse.md +33 -0
  211. package/docs/models/components/mintpreparereadyresponse.md +36 -0
  212. package/docs/models/components/mintpreparerequest.md +22 -0
  213. package/docs/models/components/morphoborrowparams.md +23 -0
  214. package/docs/models/components/morphoborrowparamsamount.md +19 -0
  215. package/docs/models/components/morphoborrowrequest.md +28 -0
  216. package/docs/models/components/morphoborrowrequestamount.md +19 -0
  217. package/docs/models/components/morphoborrowrequestchain.md +15 -0
  218. package/docs/models/components/morphocheckmarketpositionresponse.md +25 -0
  219. package/docs/models/components/morphocheckuserpositionresponse.md +28 -0
  220. package/docs/models/components/morphodepositparams.md +22 -0
  221. package/docs/models/components/morphodepositparamsamount.md +19 -0
  222. package/docs/models/components/morphodepositrequest.md +26 -0
  223. package/docs/models/components/morphodepositrequestamount.md +19 -0
  224. package/docs/models/components/morphodepositrequestchain.md +15 -0
  225. package/docs/models/components/morphogetmarketresponse.md +71 -0
  226. package/docs/models/components/morphogetmarketsresponse.md +17 -0
  227. package/docs/models/components/morphogetvaultsresponse.md +17 -0
  228. package/docs/models/components/morphomarket.md +49 -0
  229. package/docs/models/components/morphorepayparams.md +23 -0
  230. package/docs/models/components/morphorepayrequest.md +28 -0
  231. package/docs/models/components/morphorepayrequestchain.md +15 -0
  232. package/docs/models/components/morphosupplycollateralparams.md +23 -0
  233. package/docs/models/components/morphosupplycollateralparamsamount.md +19 -0
  234. package/docs/models/components/morphosupplycollateralrequest.md +28 -0
  235. package/docs/models/components/morphosupplycollateralrequestamount.md +19 -0
  236. package/docs/models/components/morphosupplycollateralrequestchain.md +15 -0
  237. package/docs/models/components/morphovault.md +51 -0
  238. package/docs/models/components/morphowithdrawcollateralparams.md +23 -0
  239. package/docs/models/components/morphowithdrawcollateralparamsamount.md +19 -0
  240. package/docs/models/components/morphowithdrawcollateralrequest.md +28 -0
  241. package/docs/models/components/morphowithdrawcollateralrequestamount.md +19 -0
  242. package/docs/models/components/morphowithdrawcollateralrequestchain.md +15 -0
  243. package/docs/models/components/morphowithdrawparams.md +22 -0
  244. package/docs/models/components/morphowithdrawrequest.md +26 -0
  245. package/docs/models/components/morphowithdrawrequestchain.md +15 -0
  246. package/docs/models/components/movement10percent.md +18 -0
  247. package/docs/models/components/multicallauthorizationrequest.md +25 -0
  248. package/docs/models/components/multicallauthorizationrequestchain.md +15 -0
  249. package/docs/models/components/multicallauthorizationresponse.md +23 -0
  250. package/docs/models/components/multicallexecuterequest.md +84 -0
  251. package/docs/models/components/multicallexecuterequestchain.md +15 -0
  252. package/docs/models/components/multiplier.md +19 -0
  253. package/docs/models/components/odosswapparams.md +25 -0
  254. package/docs/models/components/odosswapparamsamountin.md +19 -0
  255. package/docs/models/components/odosswaprequest.md +29 -0
  256. package/docs/models/components/odosswaprequestamountin.md +19 -0
  257. package/docs/models/components/odosswaprequestchain.md +15 -0
  258. package/docs/models/components/odostransactionresponse.md +23 -0
  259. package/docs/models/components/odostransactionresponsetransaction.md +33 -0
  260. package/docs/models/components/openposition.md +33 -0
  261. package/docs/models/components/operationtype.md +17 -0
  262. package/docs/models/components/pendlegetmarketresponse.md +55 -0
  263. package/docs/models/components/pendlelistmarketsresponse.md +42 -0
  264. package/docs/models/components/pendlelistuserpositionsresponse.md +67 -0
  265. package/docs/models/components/pendlemanageliquidityparams.md +27 -0
  266. package/docs/models/components/pendlemanageliquidityparamsaction.md +17 -0
  267. package/docs/models/components/pendlemanageliquidityparamsamountin.md +19 -0
  268. package/docs/models/components/pendlemanageliquidityrequest.md +31 -0
  269. package/docs/models/components/pendlemanageliquidityrequestaction.md +17 -0
  270. package/docs/models/components/pendlemanageliquidityrequestamountin.md +19 -0
  271. package/docs/models/components/pendlemanageliquidityrequestchain.md +15 -0
  272. package/docs/models/components/pendlemarket.md +48 -0
  273. package/docs/models/components/pendleredeemyieldparams.md +19 -0
  274. package/docs/models/components/pendleredeemyieldrequest.md +23 -0
  275. package/docs/models/components/pendleredeemyieldrequestchain.md +15 -0
  276. package/docs/models/components/pendletradeptparams.md +27 -0
  277. package/docs/models/components/pendletradeptparamsaction.md +17 -0
  278. package/docs/models/components/pendletradeptparamsamountin.md +19 -0
  279. package/docs/models/components/pendletradeptrequest.md +31 -0
  280. package/docs/models/components/pendletradeptrequestaction.md +17 -0
  281. package/docs/models/components/pendletradeptrequestamountin.md +19 -0
  282. package/docs/models/components/pendletradeptrequestchain.md +15 -0
  283. package/docs/models/components/pendletradeytparams.md +27 -0
  284. package/docs/models/components/pendletradeytparamsaction.md +17 -0
  285. package/docs/models/components/pendletradeytparamsamountin.md +19 -0
  286. package/docs/models/components/pendletradeytrequest.md +31 -0
  287. package/docs/models/components/pendletradeytrequestaction.md +17 -0
  288. package/docs/models/components/pendletradeytrequestamountin.md +19 -0
  289. package/docs/models/components/pendletradeytrequestchain.md +15 -0
  290. package/docs/models/components/pendletxresponse.md +29 -0
  291. package/docs/models/components/pendletxresponsetransaction.md +33 -0
  292. package/docs/models/components/permit2typeddatainput.md +76 -0
  293. package/docs/models/components/permit2typeddataoutput.md +76 -0
  294. package/docs/models/components/permitfield.md +21 -0
  295. package/docs/models/components/permitmessage.md +27 -0
  296. package/docs/models/components/permittransferfrommessage.md +26 -0
  297. package/docs/models/components/permittypeddataresponseinput.md +39 -0
  298. package/docs/models/components/permittypeddataresponseoutput.md +39 -0
  299. package/docs/models/components/portfolio.md +28 -0
  300. package/docs/models/components/position.md +70 -0
  301. package/docs/models/components/positionunion.md +32 -0
  302. package/docs/models/components/protocol.md +15 -0
  303. package/docs/models/components/r.md +19 -0
  304. package/docs/models/components/repay.md +35 -0
  305. package/docs/models/components/reserve.md +22 -0
  306. package/docs/models/components/s.md +19 -0
  307. package/docs/models/components/safetxfield.md +21 -0
  308. package/docs/models/components/safetxmessage.md +37 -0
  309. package/docs/models/components/security.md +17 -0
  310. package/docs/models/components/setallowanceparams.md +25 -0
  311. package/docs/models/components/setallowanceparamsamount.md +19 -0
  312. package/docs/models/components/setallowanceparamscontractenum.md +15 -0
  313. package/docs/models/components/setallowanceparamscontractunion.md +20 -0
  314. package/docs/models/components/setallowancerequest.md +29 -0
  315. package/docs/models/components/setallowancerequestamount.md +19 -0
  316. package/docs/models/components/setallowancerequestchain.md +15 -0
  317. package/docs/models/components/setallowancerequestcontractenum.md +15 -0
  318. package/docs/models/components/setallowancerequestcontractunion.md +19 -0
  319. package/docs/models/components/signedauthorization.md +27 -0
  320. package/docs/models/components/skybuyparams.md +21 -0
  321. package/docs/models/components/skybuyparamsamount.md +19 -0
  322. package/docs/models/components/skybuyparamstokenin.md +17 -0
  323. package/docs/models/components/skybuyrequest.md +25 -0
  324. package/docs/models/components/skybuyrequestamount.md +19 -0
  325. package/docs/models/components/skybuyrequestchain.md +15 -0
  326. package/docs/models/components/skybuyrequesttokenin.md +17 -0
  327. package/docs/models/components/skycheckpositionresponse.md +19 -0
  328. package/docs/models/components/skydepositparams.md +20 -0
  329. package/docs/models/components/skydepositparamsamount.md +19 -0
  330. package/docs/models/components/skydepositrequest.md +24 -0
  331. package/docs/models/components/skydepositrequestamount.md +19 -0
  332. package/docs/models/components/skydepositrequestchain.md +15 -0
  333. package/docs/models/components/skysellparams.md +21 -0
  334. package/docs/models/components/skysellparamsamount.md +19 -0
  335. package/docs/models/components/skysellparamstokenout.md +17 -0
  336. package/docs/models/components/skysellrequest.md +25 -0
  337. package/docs/models/components/skysellrequestamount.md +19 -0
  338. package/docs/models/components/skysellrequestchain.md +15 -0
  339. package/docs/models/components/skysellrequesttokenout.md +17 -0
  340. package/docs/models/components/skywithdrawparams.md +20 -0
  341. package/docs/models/components/skywithdrawrequest.md +24 -0
  342. package/docs/models/components/skywithdrawrequestchain.md +15 -0
  343. package/docs/models/components/slippage.md +19 -0
  344. package/docs/models/components/sponsorgasrequest.md +84 -0
  345. package/docs/models/components/sponsorgasrequesteip712.md +129 -0
  346. package/docs/models/components/sponsorgasresponse.md +27 -0
  347. package/docs/models/components/supply.md +35 -0
  348. package/docs/models/components/supportedchaininfo.md +19 -0
  349. package/docs/models/components/swapborrowrate.md +39 -0
  350. package/docs/models/components/syposition.md +19 -0
  351. package/docs/models/components/tokenbalanceresponse.md +25 -0
  352. package/docs/models/components/tokenconfig.md +23 -0
  353. package/docs/models/components/tokenlistresponse.md +26 -0
  354. package/docs/models/components/tokenpermissions.md +19 -0
  355. package/docs/models/components/tokenpriceresponse.md +17 -0
  356. package/docs/models/components/tokentransferparams.md +25 -0
  357. package/docs/models/components/tokentransferparamsamount.md +19 -0
  358. package/docs/models/components/tokentransferrequest.md +29 -0
  359. package/docs/models/components/tokentransferrequestamount.md +19 -0
  360. package/docs/models/components/tokentransferrequestchain.md +15 -0
  361. package/docs/models/components/transactionresponse.md +21 -0
  362. package/docs/models/components/transactionresponsetransaction.md +33 -0
  363. package/docs/models/components/underlyingtoken.md +23 -0
  364. package/docs/models/components/uniswapbuyexactlyparams.md +27 -0
  365. package/docs/models/components/uniswapbuyexactlyparamsamountout.md +19 -0
  366. package/docs/models/components/uniswapbuyexactlyrequest.md +33 -0
  367. package/docs/models/components/uniswapbuyexactlyrequestamountout.md +19 -0
  368. package/docs/models/components/uniswapbuyexactlyrequestchain.md +15 -0
  369. package/docs/models/components/uniswapbuyexactlytransactionresponse.md +29 -0
  370. package/docs/models/components/uniswapbuyexactlytransactionresponsetransaction.md +33 -0
  371. package/docs/models/components/uniswapbuyquoteinforesponse.md +19 -0
  372. package/docs/models/components/uniswapcheckinrangeresponse.md +17 -0
  373. package/docs/models/components/uniswapincreaseliquidityprovisionparams.md +27 -0
  374. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount0desired.md +19 -0
  375. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount0min.md +19 -0
  376. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount1desired.md +19 -0
  377. package/docs/models/components/uniswapincreaseliquidityprovisionparamsamount1min.md +19 -0
  378. package/docs/models/components/uniswapincreaseliquidityprovisionrequest.md +33 -0
  379. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0desired.md +19 -0
  380. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0min.md +19 -0
  381. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1desired.md +19 -0
  382. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1min.md +19 -0
  383. package/docs/models/components/uniswapincreaseliquidityprovisionrequestchain.md +15 -0
  384. package/docs/models/components/uniswaplppositionsinforesponse.md +17 -0
  385. package/docs/models/components/uniswapmintliquidityprovisionparams.md +36 -0
  386. package/docs/models/components/uniswapmintliquidityprovisionparamsamount0desired.md +19 -0
  387. package/docs/models/components/uniswapmintliquidityprovisionparamsamount0min.md +19 -0
  388. package/docs/models/components/uniswapmintliquidityprovisionparamsamount1desired.md +19 -0
  389. package/docs/models/components/uniswapmintliquidityprovisionparamsamount1min.md +19 -0
  390. package/docs/models/components/uniswapmintliquidityprovisionrequest.md +43 -0
  391. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0desired.md +19 -0
  392. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0min.md +19 -0
  393. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1desired.md +19 -0
  394. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1min.md +19 -0
  395. package/docs/models/components/uniswapmintliquidityprovisionrequestchain.md +15 -0
  396. package/docs/models/components/uniswappoolpriceresponse.md +23 -0
  397. package/docs/models/components/uniswappositionssolidityresponse.md +40 -0
  398. package/docs/models/components/uniswapsellexactlyparams.md +29 -0
  399. package/docs/models/components/uniswapsellexactlyparamsamountin.md +19 -0
  400. package/docs/models/components/uniswapsellexactlyrequest.md +33 -0
  401. package/docs/models/components/uniswapsellexactlyrequestamountin.md +19 -0
  402. package/docs/models/components/uniswapsellexactlyrequestchain.md +15 -0
  403. package/docs/models/components/uniswapsellexactlytransactionresponse.md +23 -0
  404. package/docs/models/components/uniswapsellexactlytransactionresponsetransaction.md +33 -0
  405. package/docs/models/components/uniswapsellquoteinforesponse.md +19 -0
  406. package/docs/models/components/uniswapwithdrawliquidityprovisionparams.md +26 -0
  407. package/docs/models/components/uniswapwithdrawliquidityprovisionparamspercentageforwithdrawal.md +19 -0
  408. package/docs/models/components/uniswapwithdrawliquidityprovisionrequest.md +25 -0
  409. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestchain.md +15 -0
  410. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +19 -0
  411. package/docs/models/components/unsignedmulticalltransaction.md +35 -0
  412. package/docs/models/components/unsignedtransaction.md +33 -0
  413. package/docs/models/components/unwrapwethparams.md +21 -0
  414. package/docs/models/components/unwrapwethparamsamount.md +19 -0
  415. package/docs/models/components/unwrapwethrequest.md +25 -0
  416. package/docs/models/components/unwrapwethrequestamount.md +19 -0
  417. package/docs/models/components/unwrapwethrequestchain.md +15 -0
  418. package/docs/models/components/usageascollateral.md +35 -0
  419. package/docs/models/components/useroperation.md +21 -0
  420. package/docs/models/components/useroperationresponse.md +21 -0
  421. package/docs/models/components/userposition.md +30 -0
  422. package/docs/models/components/userstate.md +27 -0
  423. package/docs/models/components/validationerror.md +23 -0
  424. package/docs/models/components/vault.md +47 -0
  425. package/docs/models/components/vaultdepositparams.md +22 -0
  426. package/docs/models/components/vaultdepositparamsamount.md +19 -0
  427. package/docs/models/components/vaultdepositrequest.md +26 -0
  428. package/docs/models/components/vaultdepositrequestamount.md +19 -0
  429. package/docs/models/components/vaultdepositrequestchain.md +15 -0
  430. package/docs/models/components/vaultgetvaultresponse.md +42 -0
  431. package/docs/models/components/vaultinfo.md +57 -0
  432. package/docs/models/components/vaultslistresponse.md +25 -0
  433. package/docs/models/components/vaultvenue.md +19 -0
  434. package/docs/models/components/vaultwithdrawparams.md +22 -0
  435. package/docs/models/components/vaultwithdrawrequest.md +26 -0
  436. package/docs/models/components/vaultwithdrawrequestchain.md +15 -0
  437. package/docs/models/components/venue.md +25 -0
  438. package/docs/models/components/weeklyapys.md +23 -0
  439. package/docs/models/components/wildcatgetmarketresponse.md +57 -0
  440. package/docs/models/components/withdraw.md +35 -0
  441. package/docs/models/components/wrapethparams.md +21 -0
  442. package/docs/models/components/wrapethparamsamount.md +19 -0
  443. package/docs/models/components/wrapethrequest.md +25 -0
  444. package/docs/models/components/wrapethrequestamount.md +19 -0
  445. package/docs/models/components/wrapethrequestchain.md +15 -0
  446. package/docs/models/components/yieldrange.md +19 -0
  447. package/docs/models/errors/httpvalidationerror.md +15 -0
  448. package/docs/models/errors/mintpreparenotfoundresponseerror.md +22 -0
  449. package/docs/models/operations/amountin.md +19 -0
  450. package/docs/models/operations/amountout.md +19 -0
  451. package/docs/models/operations/contract.md +19 -0
  452. package/docs/models/operations/contractenum.md +15 -0
  453. package/docs/models/operations/direction.md +17 -0
  454. package/docs/models/operations/response200v2cctpmint.md +38 -0
  455. package/docs/models/operations/responsev1transactionbundleraaveloop.md +34 -0
  456. package/docs/models/operations/v1aaveaavesupportedtokenschain.md +15 -0
  457. package/docs/models/operations/v1aaveaavesupportedtokensrequest.md +18 -0
  458. package/docs/models/operations/v1aaveavgratechain.md +15 -0
  459. package/docs/models/operations/v1aaveavgraterequest.md +22 -0
  460. package/docs/models/operations/v1aavehistoricaltransactionschain.md +15 -0
  461. package/docs/models/operations/v1aavehistoricaltransactionsrequest.md +23 -0
  462. package/docs/models/operations/v1aaveliquiditychangechain.md +15 -0
  463. package/docs/models/operations/v1aaveliquiditychangerequest.md +23 -0
  464. package/docs/models/operations/v1aaveratechain.md +15 -0
  465. package/docs/models/operations/v1aaveraterequest.md +20 -0
  466. package/docs/models/operations/v1aavereserveoverviewchain.md +15 -0
  467. package/docs/models/operations/v1aavereserveoverviewrequest.md +20 -0
  468. package/docs/models/operations/v1aavestdratechain.md +15 -0
  469. package/docs/models/operations/v1aavestdraterequest.md +22 -0
  470. package/docs/models/operations/v1aavetokenpricechain.md +15 -0
  471. package/docs/models/operations/v1aavetokenpricerequest.md +20 -0
  472. package/docs/models/operations/v1aaveuserpositionpertokenchain.md +15 -0
  473. package/docs/models/operations/v1aaveuserpositionpertokenrequest.md +22 -0
  474. package/docs/models/operations/v1aaveuserpositionsummarychain.md +15 -0
  475. package/docs/models/operations/v1aaveuserpositionsummaryrequest.md +20 -0
  476. package/docs/models/operations/v1aerodromeslipstreamliquidityprovisionpositionschain.md +15 -0
  477. package/docs/models/operations/v1aerodromeslipstreamliquidityprovisionpositionsrequest.md +19 -0
  478. package/docs/models/operations/v1aerodromeslipstreampoolpricechain.md +15 -0
  479. package/docs/models/operations/v1aerodromeslipstreampoolpricerequest.md +23 -0
  480. package/docs/models/operations/v1ethenavaultchain.md +15 -0
  481. package/docs/models/operations/v1ethenavaultrequest.md +20 -0
  482. package/docs/models/operations/v1genericallowancechain.md +15 -0
  483. package/docs/models/operations/v1genericallowancerequest.md +23 -0
  484. package/docs/models/operations/v1genericenschain.md +15 -0
  485. package/docs/models/operations/v1genericensrequest.md +19 -0
  486. package/docs/models/operations/v1genericportfoliochain.md +15 -0
  487. package/docs/models/operations/v1genericportfoliorequest.md +19 -0
  488. package/docs/models/operations/v1genericsupportedchainsrequest.md +17 -0
  489. package/docs/models/operations/v1morphomarketchain.md +15 -0
  490. package/docs/models/operations/v1morphomarketpositionchain.md +15 -0
  491. package/docs/models/operations/v1morphomarketpositionrequest.md +22 -0
  492. package/docs/models/operations/v1morphomarketrequest.md +20 -0
  493. package/docs/models/operations/v1morphomarketschain.md +15 -0
  494. package/docs/models/operations/v1morphomarketsrequest.md +21 -0
  495. package/docs/models/operations/v1morphouserpositionchain.md +15 -0
  496. package/docs/models/operations/v1morphouserpositionrequest.md +19 -0
  497. package/docs/models/operations/v1morphovaultchain.md +15 -0
  498. package/docs/models/operations/v1morphovaultrequest.md +22 -0
  499. package/docs/models/operations/v1morphovaultschain.md +15 -0
  500. package/docs/models/operations/v1morphovaultsrequest.md +19 -0
  501. package/docs/models/operations/v1pendlemarketchain.md +15 -0
  502. package/docs/models/operations/v1pendlemarketrequest.md +22 -0
  503. package/docs/models/operations/v1pendlemarketschain.md +15 -0
  504. package/docs/models/operations/v1pendlemarketsrequest.md +17 -0
  505. package/docs/models/operations/v1pendlepositionschain.md +15 -0
  506. package/docs/models/operations/v1pendlepositionsrequest.md +19 -0
  507. package/docs/models/operations/v1skypositionchain.md +15 -0
  508. package/docs/models/operations/v1skypositionrequest.md +19 -0
  509. package/docs/models/operations/v1tokenbalancechain.md +15 -0
  510. package/docs/models/operations/v1tokenbalancerequest.md +21 -0
  511. package/docs/models/operations/v1tokenlistchain.md +15 -0
  512. package/docs/models/operations/v1tokenlistrequest.md +17 -0
  513. package/docs/models/operations/v1tokenpricechain.md +15 -0
  514. package/docs/models/operations/v1tokenpricerequest.md +20 -0
  515. package/docs/models/operations/v1uniswapliquidityprovisioninrangechain.md +15 -0
  516. package/docs/models/operations/v1uniswapliquidityprovisioninrangerequest.md +19 -0
  517. package/docs/models/operations/v1uniswapliquidityprovisionpositionschain.md +15 -0
  518. package/docs/models/operations/v1uniswapliquidityprovisionpositionsrequest.md +19 -0
  519. package/docs/models/operations/v1uniswappoolpricechain.md +15 -0
  520. package/docs/models/operations/v1uniswappoolpricefeeenum.md +19 -0
  521. package/docs/models/operations/v1uniswappoolpricerequest.md +23 -0
  522. package/docs/models/operations/v1uniswapquotebuyexactlychain.md +15 -0
  523. package/docs/models/operations/v1uniswapquotebuyexactlyfeeenum.md +19 -0
  524. package/docs/models/operations/v1uniswapquotebuyexactlyrequest.md +25 -0
  525. package/docs/models/operations/v1uniswapquotesellexactlychain.md +15 -0
  526. package/docs/models/operations/v1uniswapquotesellexactlyfeeenum.md +19 -0
  527. package/docs/models/operations/v1uniswapquotesellexactlyrequest.md +25 -0
  528. package/docs/models/operations/v1vaultsvaultchain.md +15 -0
  529. package/docs/models/operations/v1vaultsvaultrequest.md +22 -0
  530. package/docs/models/operations/v1wildcatmarketchain.md +15 -0
  531. package/docs/models/operations/v1wildcatmarketrequest.md +22 -0
  532. package/docs/models/operations/v2cctpmintresponse.md +26 -0
  533. package/docs/models/operations/v2earnaavetokenratesrequest.md +17 -0
  534. package/docs/models/operations/v2earnpositionschain.md +15 -0
  535. package/docs/models/operations/v2earnpositionspositionidrequest.md +21 -0
  536. package/docs/models/operations/v2earnpositionsrequest.md +25 -0
  537. package/docs/models/operations/v2earnvaultschain.md +15 -0
  538. package/docs/models/operations/v2earnvaultsrequest.md +25 -0
  539. package/docs/sdks/aavev3/README.md +1247 -0
  540. package/docs/sdks/aerodromeslipstream/README.md +702 -0
  541. package/docs/sdks/bridge/README.md +222 -0
  542. package/docs/sdks/earn/README.md +696 -0
  543. package/docs/sdks/erc4626vaults/README.md +264 -0
  544. package/docs/sdks/ethena/README.md +357 -0
  545. package/docs/sdks/gassponsorship/README.md +296 -0
  546. package/docs/sdks/morpho/README.md +1066 -0
  547. package/docs/sdks/pendle/README.md +630 -0
  548. package/docs/sdks/sky/README.md +458 -0
  549. package/docs/sdks/smartaccount/README.md +106 -0
  550. package/docs/sdks/swap/README.md +100 -0
  551. package/docs/sdks/token/README.md +481 -0
  552. package/docs/sdks/transactionbundler/README.md +411 -0
  553. package/docs/sdks/uniswapv3/README.md +947 -0
  554. package/docs/sdks/universal/README.md +419 -0
  555. package/docs/sdks/wildcat/README.md +88 -0
  556. package/eslint.config.mjs +22 -0
  557. package/examples/README.md +31 -0
  558. package/examples/node_modules/@esbuild/linux-x64/README.md +3 -0
  559. package/examples/node_modules/@esbuild/linux-x64/bin/esbuild +0 -0
  560. package/examples/node_modules/@types/node/LICENSE +21 -0
  561. package/examples/node_modules/@types/node/README.md +15 -0
  562. package/examples/node_modules/dotenv/CHANGELOG.md +520 -0
  563. package/examples/node_modules/dotenv/LICENSE +23 -0
  564. package/examples/node_modules/dotenv/README-es.md +411 -0
  565. package/examples/node_modules/dotenv/README.md +645 -0
  566. package/examples/node_modules/dotenv/SECURITY.md +1 -0
  567. package/examples/node_modules/esbuild/LICENSE.md +21 -0
  568. package/examples/node_modules/esbuild/README.md +3 -0
  569. package/examples/node_modules/esbuild/bin/esbuild +0 -0
  570. package/examples/node_modules/get-tsconfig/LICENSE +21 -0
  571. package/examples/node_modules/get-tsconfig/README.md +235 -0
  572. package/examples/node_modules/get-tsconfig/dist/index.cjs +7 -0
  573. package/examples/node_modules/get-tsconfig/dist/index.d.cts +2088 -0
  574. package/examples/node_modules/get-tsconfig/dist/index.d.mts +2088 -0
  575. package/examples/node_modules/get-tsconfig/dist/index.mjs +0 -0
  576. package/examples/node_modules/resolve-pkg-maps/LICENSE +21 -0
  577. package/examples/node_modules/resolve-pkg-maps/README.md +216 -0
  578. package/examples/node_modules/resolve-pkg-maps/dist/index.cjs +1 -0
  579. package/examples/node_modules/resolve-pkg-maps/dist/index.d.cts +11 -0
  580. package/examples/node_modules/resolve-pkg-maps/dist/index.d.mts +11 -0
  581. package/examples/node_modules/resolve-pkg-maps/dist/index.mjs +0 -0
  582. package/examples/node_modules/tsx/LICENSE +21 -0
  583. package/examples/node_modules/tsx/README.md +32 -0
  584. package/examples/node_modules/tsx/dist/cjs/api/index.cjs +1 -0
  585. package/examples/node_modules/tsx/dist/cjs/api/index.d.cts +35 -0
  586. package/examples/node_modules/tsx/dist/cjs/api/index.d.mts +35 -0
  587. package/examples/node_modules/tsx/dist/cjs/api/index.mjs +0 -0
  588. package/examples/node_modules/tsx/dist/cjs/index.cjs +1 -0
  589. package/examples/node_modules/tsx/dist/cjs/index.mjs +0 -0
  590. package/examples/node_modules/tsx/dist/cli.cjs +54 -0
  591. package/examples/node_modules/tsx/dist/cli.mjs +0 -0
  592. package/examples/node_modules/tsx/dist/client-D6NvIMSC.cjs +1 -0
  593. package/examples/node_modules/tsx/dist/esm/api/index.cjs +1 -0
  594. package/examples/node_modules/tsx/dist/esm/api/index.d.cts +35 -0
  595. package/examples/node_modules/tsx/dist/esm/api/index.d.mts +35 -0
  596. package/examples/node_modules/tsx/dist/esm/api/index.mjs +0 -0
  597. package/examples/node_modules/tsx/dist/esm/index.cjs +2 -0
  598. package/examples/node_modules/tsx/dist/esm/index.mjs +0 -0
  599. package/examples/node_modules/tsx/dist/get-pipe-path-BoR10qr8.cjs +1 -0
  600. package/examples/node_modules/tsx/dist/index-BWFBUo6r.cjs +1 -0
  601. package/examples/node_modules/tsx/dist/index-gckBtVBf.cjs +14 -0
  602. package/examples/node_modules/tsx/dist/lexer-DgIbo0BU.cjs +3 -0
  603. package/examples/node_modules/tsx/dist/loader.cjs +1 -0
  604. package/examples/node_modules/tsx/dist/loader.mjs +0 -0
  605. package/examples/node_modules/tsx/dist/node-features-roYmp9jK.cjs +1 -0
  606. package/examples/node_modules/tsx/dist/package-Dxt5kIHw.cjs +1 -0
  607. package/examples/node_modules/tsx/dist/patch-repl.cjs +1 -0
  608. package/examples/node_modules/tsx/dist/patch-repl.mjs +0 -0
  609. package/examples/node_modules/tsx/dist/preflight.cjs +1 -0
  610. package/examples/node_modules/tsx/dist/preflight.mjs +0 -0
  611. package/examples/node_modules/tsx/dist/register-2sWVXuRQ.cjs +1 -0
  612. package/examples/node_modules/tsx/dist/register-D46fvsV_.cjs +4 -0
  613. package/examples/node_modules/tsx/dist/repl.cjs +3 -0
  614. package/examples/node_modules/tsx/dist/repl.mjs +0 -0
  615. package/examples/node_modules/tsx/dist/require-D4F1Lv60.cjs +1 -0
  616. package/examples/node_modules/tsx/dist/suppress-warnings.cjs +1 -0
  617. package/examples/node_modules/tsx/dist/suppress-warnings.mjs +0 -0
  618. package/examples/node_modules/tsx/dist/temporary-directory-B83uKxJF.cjs +1 -0
  619. package/examples/node_modules/undici-types/LICENSE +21 -0
  620. package/examples/node_modules/undici-types/README.md +6 -0
  621. package/package.json +1 -1
  622. package/src/funcs/bridgeCctpBurn.ts +1 -1
  623. package/src/funcs/bridgeCctpMint.ts +2 -4
  624. package/src/lib/config.ts +2 -2
  625. package/src/sdk/bridge.ts +3 -5
  626. package/tsconfig.json +1 -1
  627. package/examples/node_modules/.package-lock.json +0 -159
@@ -0,0 +1,645 @@
1
+ <div align="center">
2
+ 🎉 announcing <a href="https://github.com/dotenvx/dotenvx">dotenvx</a>. <em>run anywhere, multi-environment, encrypted envs</em>.
3
+ </div>
4
+
5
+ &nbsp;
6
+
7
+ <div align="center">
8
+
9
+ **Special thanks to [our sponsors](https://github.com/sponsors/motdotla)**
10
+
11
+ <br>
12
+ <a href="https://graphite.dev/?utm_source=github&utm_medium=repo&utm_campaign=dotenv"><img src="https://res.cloudinary.com/dotenv-org/image/upload/v1744035073/graphite_lgsrl8.gif" width="240" alt="Graphite" /></a>
13
+ <br>
14
+ <a href="https://graphite.dev/?utm_source=github&utm_medium=repo&utm_campaign=dotenv">
15
+ <b>Graphite is the AI developer productivity platform helping teams on GitHub ship higher quality software, faster.</b>
16
+ </a>
17
+ <hr>
18
+ </div>
19
+
20
+ # dotenv [![NPM version](https://img.shields.io/npm/v/dotenv.svg?style=flat-square)](https://www.npmjs.com/package/dotenv)
21
+
22
+ <img src="https://raw.githubusercontent.com/motdotla/dotenv/master/dotenv.svg" alt="dotenv" align="right" width="200" />
23
+
24
+ Dotenv is a zero-dependency module that loads environment variables from a `.env` file into [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env). Storing configuration in the environment separate from code is based on [The Twelve-Factor App](https://12factor.net/config) methodology.
25
+
26
+ [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
27
+ [![LICENSE](https://img.shields.io/github/license/motdotla/dotenv.svg)](LICENSE)
28
+ [![codecov](https://codecov.io/gh/motdotla/dotenv-expand/graph/badge.svg?token=pawWEyaMfg)](https://codecov.io/gh/motdotla/dotenv-expand)
29
+
30
+ * [🌱 Install](#-install)
31
+ * [🏗️ Usage (.env)](#%EF%B8%8F-usage)
32
+ * [🌴 Multiple Environments 🆕](#-manage-multiple-environments)
33
+ * [🚀 Deploying (encryption) 🆕](#-deploying)
34
+ * [📚 Examples](#-examples)
35
+ * [📖 Docs](#-documentation)
36
+ * [❓ FAQ](#-faq)
37
+ * [⏱️ Changelog](./CHANGELOG.md)
38
+
39
+ ## 🌱 Install
40
+
41
+ ```bash
42
+ npm install dotenv --save
43
+ ```
44
+
45
+ You can also use an npm-compatible package manager like yarn, bun or pnpm:
46
+
47
+ ```bash
48
+ yarn add dotenv
49
+ ```
50
+ ```bash
51
+ bun add dotenv
52
+ ```
53
+ ```bash
54
+ pnpm add dotenv
55
+ ```
56
+
57
+ ## 🏗️ Usage
58
+
59
+ <a href="https://www.youtube.com/watch?v=YtkZR0NFd1g">
60
+ <div align="right">
61
+ <img src="https://img.youtube.com/vi/YtkZR0NFd1g/hqdefault.jpg" alt="how to use dotenv video tutorial" align="right" width="330" />
62
+ <img src="https://simpleicons.vercel.app/youtube/ff0000" alt="youtube/@dotenvorg" align="right" width="24" />
63
+ </div>
64
+ </a>
65
+
66
+ Create a `.env` file in the root of your project (if using a monorepo structure like `apps/backend/app.js`, put it in the root of the folder where your `app.js` process runs):
67
+
68
+ ```dosini
69
+ S3_BUCKET="YOURS3BUCKET"
70
+ SECRET_KEY="YOURSECRETKEYGOESHERE"
71
+ ```
72
+
73
+ As early as possible in your application, import and configure dotenv:
74
+
75
+ ```javascript
76
+ require('dotenv').config()
77
+ console.log(process.env) // remove this after you've confirmed it is working
78
+ ```
79
+
80
+ .. [or using ES6?](#how-do-i-use-dotenv-with-import)
81
+
82
+ ```javascript
83
+ import 'dotenv/config'
84
+ ```
85
+
86
+ That's it. `process.env` now has the keys and values you defined in your `.env` file:
87
+
88
+ ```javascript
89
+ require('dotenv').config()
90
+ // or import 'dotenv/config' if you're using ES6
91
+
92
+ ...
93
+
94
+ s3.getBucketCors({Bucket: process.env.S3_BUCKET}, function(err, data) {})
95
+ ```
96
+
97
+ ### Multiline values
98
+
99
+ If you need multiline variables, for example private keys, those are now supported (`>= v15.0.0`) with line breaks:
100
+
101
+ ```dosini
102
+ PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
103
+ ...
104
+ Kh9NV...
105
+ ...
106
+ -----END RSA PRIVATE KEY-----"
107
+ ```
108
+
109
+ Alternatively, you can double quote strings and use the `\n` character:
110
+
111
+ ```dosini
112
+ PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END RSA PRIVATE KEY-----\n"
113
+ ```
114
+
115
+ ### Comments
116
+
117
+ Comments may be added to your file on their own line or inline:
118
+
119
+ ```dosini
120
+ # This is a comment
121
+ SECRET_KEY=YOURSECRETKEYGOESHERE # comment
122
+ SECRET_HASH="something-with-a-#-hash"
123
+ ```
124
+
125
+ Comments begin where a `#` exists, so if your value contains a `#` please wrap it in quotes. This is a breaking change from `>= v15.0.0` and on.
126
+
127
+ ### Parsing
128
+
129
+ The engine which parses the contents of your file containing environment variables is available to use. It accepts a String or Buffer and will return an Object with the parsed keys and values.
130
+
131
+ ```javascript
132
+ const dotenv = require('dotenv')
133
+ const buf = Buffer.from('BASIC=basic')
134
+ const config = dotenv.parse(buf) // will return an object
135
+ console.log(typeof config, config) // object { BASIC : 'basic' }
136
+ ```
137
+
138
+ ### Preload
139
+
140
+ > Note: Consider using [`dotenvx`](https://github.com/dotenvx/dotenvx) instead of preloading. I am now doing (and recommending) so.
141
+ >
142
+ > It serves the same purpose (you do not need to require and load dotenv), adds better debugging, and works with ANY language, framework, or platform. – [motdotla](https://github.com/motdotla)
143
+
144
+ You can use the `--require` (`-r`) [command line option](https://nodejs.org/api/cli.html#-r---require-module) to preload dotenv. By doing this, you do not need to require and load dotenv in your application code.
145
+
146
+ ```bash
147
+ $ node -r dotenv/config your_script.js
148
+ ```
149
+
150
+ The configuration options below are supported as command line arguments in the format `dotenv_config_<option>=value`
151
+
152
+ ```bash
153
+ $ node -r dotenv/config your_script.js dotenv_config_path=/custom/path/to/.env dotenv_config_debug=true
154
+ ```
155
+
156
+ Additionally, you can use environment variables to set configuration options. Command line arguments will precede these.
157
+
158
+ ```bash
159
+ $ DOTENV_CONFIG_<OPTION>=value node -r dotenv/config your_script.js
160
+ ```
161
+
162
+ ```bash
163
+ $ DOTENV_CONFIG_ENCODING=latin1 DOTENV_CONFIG_DEBUG=true node -r dotenv/config your_script.js dotenv_config_path=/custom/path/to/.env
164
+ ```
165
+
166
+ ### Variable Expansion
167
+
168
+ You need to add the value of another variable in one of your variables? Use [dotenv-expand](https://github.com/motdotla/dotenv-expand).
169
+
170
+ ### Command Substitution
171
+
172
+ Use [dotenvx](https://github.com/dotenvx/dotenvx) to use command substitution.
173
+
174
+ Add the output of a command to one of your variables in your .env file.
175
+
176
+ ```ini
177
+ # .env
178
+ DATABASE_URL="postgres://$(whoami)@localhost/my_database"
179
+ ```
180
+ ```js
181
+ // index.js
182
+ console.log('DATABASE_URL', process.env.DATABASE_URL)
183
+ ```
184
+ ```sh
185
+ $ dotenvx run --debug -- node index.js
186
+ [dotenvx@0.14.1] injecting env (1) from .env
187
+ DATABASE_URL postgres://yourusername@localhost/my_database
188
+ ```
189
+
190
+ ### Syncing
191
+
192
+ You need to keep `.env` files in sync between machines, environments, or team members? Use [dotenvx](https://github.com/dotenvx/dotenvx) to encrypt your `.env` files and safely include them in source control. This still subscribes to the twelve-factor app rules by generating a decryption key separate from code.
193
+
194
+ ### Multiple Environments
195
+
196
+ Use [dotenvx](https://github.com/dotenvx/dotenvx) to generate `.env.ci`, `.env.production` files, and more.
197
+
198
+ ### Deploying
199
+
200
+ You need to deploy your secrets in a cloud-agnostic manner? Use [dotenvx](https://github.com/dotenvx/dotenvx) to generate a private decryption key that is set on your production server.
201
+
202
+ ## 🌴 Manage Multiple Environments
203
+
204
+ Use [dotenvx](https://github.com/dotenvx/dotenvx)
205
+
206
+ Run any environment locally. Create a `.env.ENVIRONMENT` file and use `--env-file` to load it. It's straightforward, yet flexible.
207
+
208
+ ```bash
209
+ $ echo "HELLO=production" > .env.production
210
+ $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
211
+
212
+ $ dotenvx run --env-file=.env.production -- node index.js
213
+ Hello production
214
+ > ^^
215
+ ```
216
+
217
+ or with multiple .env files
218
+
219
+ ```bash
220
+ $ echo "HELLO=local" > .env.local
221
+ $ echo "HELLO=World" > .env
222
+ $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
223
+
224
+ $ dotenvx run --env-file=.env.local --env-file=.env -- node index.js
225
+ Hello local
226
+ ```
227
+
228
+ [more environment examples](https://dotenvx.com/docs/quickstart/environments)
229
+
230
+ ## 🚀 Deploying
231
+
232
+ Use [dotenvx](https://github.com/dotenvx/dotenvx).
233
+
234
+ Add encryption to your `.env` files with a single command. Pass the `--encrypt` flag.
235
+
236
+ ```
237
+ $ dotenvx set HELLO Production --encrypt -f .env.production
238
+ $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
239
+
240
+ $ DOTENV_PRIVATE_KEY_PRODUCTION="<.env.production private key>" dotenvx run -- node index.js
241
+ [dotenvx] injecting env (2) from .env.production
242
+ Hello Production
243
+ ```
244
+
245
+ [learn more](https://github.com/dotenvx/dotenvx?tab=readme-ov-file#encryption)
246
+
247
+ ## 📚 Examples
248
+
249
+ See [examples](https://github.com/dotenv-org/examples) of using dotenv with various frameworks, languages, and configurations.
250
+
251
+ * [nodejs](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-nodejs)
252
+ * [nodejs (debug on)](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-nodejs-debug)
253
+ * [nodejs (override on)](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-nodejs-override)
254
+ * [nodejs (processEnv override)](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-custom-target)
255
+ * [esm](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-esm)
256
+ * [esm (preload)](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-esm-preload)
257
+ * [typescript](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-typescript)
258
+ * [typescript parse](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-typescript-parse)
259
+ * [typescript config](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-typescript-config)
260
+ * [webpack](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-webpack)
261
+ * [webpack (plugin)](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-webpack2)
262
+ * [react](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-react)
263
+ * [react (typescript)](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-react-typescript)
264
+ * [express](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-express)
265
+ * [nestjs](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-nestjs)
266
+ * [fastify](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-fastify)
267
+
268
+ ## 📖 Documentation
269
+
270
+ Dotenv exposes four functions:
271
+
272
+ * `config`
273
+ * `parse`
274
+ * `populate`
275
+ * `decrypt`
276
+
277
+ ### Config
278
+
279
+ `config` will read your `.env` file, parse the contents, assign it to
280
+ [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env),
281
+ and return an Object with a `parsed` key containing the loaded content or an `error` key if it failed.
282
+
283
+ ```js
284
+ const result = dotenv.config()
285
+
286
+ if (result.error) {
287
+ throw result.error
288
+ }
289
+
290
+ console.log(result.parsed)
291
+ ```
292
+
293
+ You can additionally, pass options to `config`.
294
+
295
+ #### Options
296
+
297
+ ##### path
298
+
299
+ Default: `path.resolve(process.cwd(), '.env')`
300
+
301
+ Specify a custom path if your file containing environment variables is located elsewhere.
302
+
303
+ ```js
304
+ require('dotenv').config({ path: '/custom/path/to/.env' })
305
+ ```
306
+
307
+ By default, `config` will look for a file called .env in the current working directory.
308
+
309
+ Pass in multiple files as an array, and they will be parsed in order and combined with `process.env` (or `option.processEnv`, if set). The first value set for a variable will win, unless the `options.override` flag is set, in which case the last value set will win. If a value already exists in `process.env` and the `options.override` flag is NOT set, no changes will be made to that value.
310
+
311
+ ```js
312
+ require('dotenv').config({ path: ['.env.local', '.env'] })
313
+ ```
314
+
315
+ ##### encoding
316
+
317
+ Default: `utf8`
318
+
319
+ Specify the encoding of your file containing environment variables.
320
+
321
+ ```js
322
+ require('dotenv').config({ encoding: 'latin1' })
323
+ ```
324
+
325
+ ##### debug
326
+
327
+ Default: `false`
328
+
329
+ Turn on logging to help debug why certain keys or values are not being set as you expect.
330
+
331
+ ```js
332
+ require('dotenv').config({ debug: process.env.DEBUG })
333
+ ```
334
+
335
+ ##### override
336
+
337
+ Default: `false`
338
+
339
+ Override any environment variables that have already been set on your machine with values from your .env file(s). If multiple files have been provided in `option.path` the override will also be used as each file is combined with the next. Without `override` being set, the first value wins. With `override` set the last value wins.
340
+
341
+ ```js
342
+ require('dotenv').config({ override: true })
343
+ ```
344
+
345
+ ##### processEnv
346
+
347
+ Default: `process.env`
348
+
349
+ Specify an object to write your environment variables to. Defaults to `process.env` environment variables.
350
+
351
+ ```js
352
+ const myObject = {}
353
+ require('dotenv').config({ processEnv: myObject })
354
+
355
+ console.log(myObject) // values from .env
356
+ console.log(process.env) // this was not changed or written to
357
+ ```
358
+
359
+ ### Parse
360
+
361
+ The engine which parses the contents of your file containing environment
362
+ variables is available to use. It accepts a String or Buffer and will return
363
+ an Object with the parsed keys and values.
364
+
365
+ ```js
366
+ const dotenv = require('dotenv')
367
+ const buf = Buffer.from('BASIC=basic')
368
+ const config = dotenv.parse(buf) // will return an object
369
+ console.log(typeof config, config) // object { BASIC : 'basic' }
370
+ ```
371
+
372
+ #### Options
373
+
374
+ ##### debug
375
+
376
+ Default: `false`
377
+
378
+ Turn on logging to help debug why certain keys or values are not being set as you expect.
379
+
380
+ ```js
381
+ const dotenv = require('dotenv')
382
+ const buf = Buffer.from('hello world')
383
+ const opt = { debug: true }
384
+ const config = dotenv.parse(buf, opt)
385
+ // expect a debug message because the buffer is not in KEY=VAL form
386
+ ```
387
+
388
+ ### Populate
389
+
390
+ The engine which populates the contents of your .env file to `process.env` is available for use. It accepts a target, a source, and options. This is useful for power users who want to supply their own objects.
391
+
392
+ For example, customizing the source:
393
+
394
+ ```js
395
+ const dotenv = require('dotenv')
396
+ const parsed = { HELLO: 'world' }
397
+
398
+ dotenv.populate(process.env, parsed)
399
+
400
+ console.log(process.env.HELLO) // world
401
+ ```
402
+
403
+ For example, customizing the source AND target:
404
+
405
+ ```js
406
+ const dotenv = require('dotenv')
407
+ const parsed = { HELLO: 'universe' }
408
+ const target = { HELLO: 'world' } // empty object
409
+
410
+ dotenv.populate(target, parsed, { override: true, debug: true })
411
+
412
+ console.log(target) // { HELLO: 'universe' }
413
+ ```
414
+
415
+ #### options
416
+
417
+ ##### Debug
418
+
419
+ Default: `false`
420
+
421
+ Turn on logging to help debug why certain keys or values are not being populated as you expect.
422
+
423
+ ##### override
424
+
425
+ Default: `false`
426
+
427
+ Override any environment variables that have already been set.
428
+
429
+ ## ❓ FAQ
430
+
431
+ ### Why is the `.env` file not loading my environment variables successfully?
432
+
433
+ Most likely your `.env` file is not in the correct place. [See this stack overflow](https://stackoverflow.com/questions/42335016/dotenv-file-is-not-loading-environment-variables).
434
+
435
+ Turn on debug mode and try again..
436
+
437
+ ```js
438
+ require('dotenv').config({ debug: true })
439
+ ```
440
+
441
+ You will receive a helpful error outputted to your console.
442
+
443
+ ### Should I commit my `.env` file?
444
+
445
+ No. We **strongly** recommend against committing your `.env` file to version
446
+ control. It should only include environment-specific values such as database
447
+ passwords or API keys. Your production database should have a different
448
+ password than your development database.
449
+
450
+ ### Should I have multiple `.env` files?
451
+
452
+ We recommend creating one `.env` file per environment. Use `.env` for local/development, `.env.production` for production and so on. This still follows the twelve factor principles as each is attributed individually to its own environment. Avoid custom set ups that work in inheritance somehow (`.env.production` inherits values form `.env` for example). It is better to duplicate values if necessary across each `.env.environment` file.
453
+
454
+ > In a twelve-factor app, env vars are granular controls, each fully orthogonal to other env vars. They are never grouped together as “environments”, but instead are independently managed for each deploy. This is a model that scales up smoothly as the app naturally expands into more deploys over its lifetime.
455
+ >
456
+ > – [The Twelve-Factor App](http://12factor.net/config)
457
+
458
+ ### What rules does the parsing engine follow?
459
+
460
+ The parsing engine currently supports the following rules:
461
+
462
+ - `BASIC=basic` becomes `{BASIC: 'basic'}`
463
+ - empty lines are skipped
464
+ - lines beginning with `#` are treated as comments
465
+ - `#` marks the beginning of a comment (unless when the value is wrapped in quotes)
466
+ - empty values become empty strings (`EMPTY=` becomes `{EMPTY: ''}`)
467
+ - inner quotes are maintained (think JSON) (`JSON={"foo": "bar"}` becomes `{JSON:"{\"foo\": \"bar\"}"`)
468
+ - whitespace is removed from both ends of unquoted values (see more on [`trim`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim)) (`FOO= some value ` becomes `{FOO: 'some value'}`)
469
+ - single and double quoted values are escaped (`SINGLE_QUOTE='quoted'` becomes `{SINGLE_QUOTE: "quoted"}`)
470
+ - single and double quoted values maintain whitespace from both ends (`FOO=" some value "` becomes `{FOO: ' some value '}`)
471
+ - double quoted values expand new lines (`MULTILINE="new\nline"` becomes
472
+
473
+ ```
474
+ {MULTILINE: 'new
475
+ line'}
476
+ ```
477
+
478
+ - backticks are supported (`` BACKTICK_KEY=`This has 'single' and "double" quotes inside of it.` ``)
479
+
480
+ ### What happens to environment variables that were already set?
481
+
482
+ By default, we will never modify any environment variables that have already been set. In particular, if there is a variable in your `.env` file which collides with one that already exists in your environment, then that variable will be skipped.
483
+
484
+ If instead, you want to override `process.env` use the `override` option.
485
+
486
+ ```javascript
487
+ require('dotenv').config({ override: true })
488
+ ```
489
+
490
+ ### How come my environment variables are not showing up for React?
491
+
492
+ Your React code is run in Webpack, where the `fs` module or even the `process` global itself are not accessible out-of-the-box. `process.env` can only be injected through Webpack configuration.
493
+
494
+ If you are using [`react-scripts`](https://www.npmjs.com/package/react-scripts), which is distributed through [`create-react-app`](https://create-react-app.dev/), it has dotenv built in but with a quirk. Preface your environment variables with `REACT_APP_`. See [this stack overflow](https://stackoverflow.com/questions/42182577/is-it-possible-to-use-dotenv-in-a-react-project) for more details.
495
+
496
+ If you are using other frameworks (e.g. Next.js, Gatsby...), you need to consult their documentation for how to inject environment variables into the client.
497
+
498
+ ### Can I customize/write plugins for dotenv?
499
+
500
+ Yes! `dotenv.config()` returns an object representing the parsed `.env` file. This gives you everything you need to continue setting values on `process.env`. For example:
501
+
502
+ ```js
503
+ const dotenv = require('dotenv')
504
+ const variableExpansion = require('dotenv-expand')
505
+ const myEnv = dotenv.config()
506
+ variableExpansion(myEnv)
507
+ ```
508
+
509
+ ### How do I use dotenv with `import`?
510
+
511
+ Simply..
512
+
513
+ ```javascript
514
+ // index.mjs (ESM)
515
+ import 'dotenv/config' // see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
516
+ import express from 'express'
517
+ ```
518
+
519
+ A little background..
520
+
521
+ > When you run a module containing an `import` declaration, the modules it imports are loaded first, then each module body is executed in a depth-first traversal of the dependency graph, avoiding cycles by skipping anything already executed.
522
+ >
523
+ > – [ES6 In Depth: Modules](https://hacks.mozilla.org/2015/08/es6-in-depth-modules/)
524
+
525
+ What does this mean in plain language? It means you would think the following would work but it won't.
526
+
527
+ `errorReporter.mjs`:
528
+ ```js
529
+ class Client {
530
+ constructor (apiKey) {
531
+ console.log('apiKey', apiKey)
532
+
533
+ this.apiKey = apiKey
534
+ }
535
+ }
536
+
537
+ export default new Client(process.env.API_KEY)
538
+ ```
539
+ `index.mjs`:
540
+ ```js
541
+ // Note: this is INCORRECT and will not work
542
+ import * as dotenv from 'dotenv'
543
+ dotenv.config()
544
+
545
+ import errorReporter from './errorReporter.mjs' // process.env.API_KEY will be blank!
546
+ ```
547
+
548
+ `process.env.API_KEY` will be blank.
549
+
550
+ Instead, `index.mjs` should be written as..
551
+
552
+ ```js
553
+ import 'dotenv/config'
554
+
555
+ import errorReporter from './errorReporter.mjs'
556
+ ```
557
+
558
+ Does that make sense? It's a bit unintuitive, but it is how importing of ES6 modules work. Here is a [working example of this pitfall](https://github.com/dotenv-org/examples/tree/master/usage/dotenv-es6-import-pitfall).
559
+
560
+ There are two alternatives to this approach:
561
+
562
+ 1. Preload dotenv: `node --require dotenv/config index.js` (_Note: you do not need to `import` dotenv with this approach_)
563
+ 2. Create a separate file that will execute `config` first as outlined in [this comment on #133](https://github.com/motdotla/dotenv/issues/133#issuecomment-255298822)
564
+
565
+ ### Why am I getting the error `Module not found: Error: Can't resolve 'crypto|os|path'`?
566
+
567
+ You are using dotenv on the front-end and have not included a polyfill. Webpack < 5 used to include these for you. Do the following:
568
+
569
+ ```bash
570
+ npm install node-polyfill-webpack-plugin
571
+ ```
572
+
573
+ Configure your `webpack.config.js` to something like the following.
574
+
575
+ ```js
576
+ require('dotenv').config()
577
+
578
+ const path = require('path');
579
+ const webpack = require('webpack')
580
+
581
+ const NodePolyfillPlugin = require('node-polyfill-webpack-plugin')
582
+
583
+ module.exports = {
584
+ mode: 'development',
585
+ entry: './src/index.ts',
586
+ output: {
587
+ filename: 'bundle.js',
588
+ path: path.resolve(__dirname, 'dist'),
589
+ },
590
+ plugins: [
591
+ new NodePolyfillPlugin(),
592
+ new webpack.DefinePlugin({
593
+ 'process.env': {
594
+ HELLO: JSON.stringify(process.env.HELLO)
595
+ }
596
+ }),
597
+ ]
598
+ };
599
+ ```
600
+
601
+ Alternatively, just use [dotenv-webpack](https://github.com/mrsteele/dotenv-webpack) which does this and more behind the scenes for you.
602
+
603
+ ### What about variable expansion?
604
+
605
+ Try [dotenv-expand](https://github.com/motdotla/dotenv-expand)
606
+
607
+ ### What about syncing and securing .env files?
608
+
609
+ Use [dotenvx](https://github.com/dotenvx/dotenvx)
610
+
611
+ ### What if I accidentally commit my `.env` file to code?
612
+
613
+ Remove it, [remove git history](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository) and then install the [git pre-commit hook](https://github.com/dotenvx/dotenvx#pre-commit) to prevent this from ever happening again.
614
+
615
+ ```
616
+ brew install dotenvx/brew/dotenvx
617
+ dotenvx precommit --install
618
+ ```
619
+
620
+ ### How can I prevent committing my `.env` file to a Docker build?
621
+
622
+ Use the [docker prebuild hook](https://dotenvx.com/docs/features/prebuild).
623
+
624
+ ```bash
625
+ # Dockerfile
626
+ ...
627
+ RUN curl -fsS https://dotenvx.sh/ | sh
628
+ ...
629
+ RUN dotenvx prebuild
630
+ CMD ["dotenvx", "run", "--", "node", "index.js"]
631
+ ```
632
+
633
+ ## Contributing Guide
634
+
635
+ See [CONTRIBUTING.md](CONTRIBUTING.md)
636
+
637
+ ## CHANGELOG
638
+
639
+ See [CHANGELOG.md](CHANGELOG.md)
640
+
641
+ ## Who's using dotenv?
642
+
643
+ [These npm modules depend on it.](https://www.npmjs.com/browse/depended/dotenv)
644
+
645
+ Projects that expand it often use the [keyword "dotenv" on npm](https://www.npmjs.com/search?q=keywords:dotenv).
@@ -0,0 +1 @@
1
+ Please report any security vulnerabilities to security@dotenvx.com.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 Evan Wallace
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,3 @@
1
+ # esbuild
2
+
3
+ This is a JavaScript bundler and minifier. See https://github.com/evanw/esbuild and the [JavaScript API documentation](https://esbuild.github.io/api/) for details.