@stacks/blockchain-api-client 7.4.0 → 7.5.0-beta.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 (359) hide show
  1. package/README.md +16 -13
  2. package/lib/generated/apis/AccountsApi.d.ts +360 -360
  3. package/lib/generated/apis/AccountsApi.js.map +1 -1
  4. package/lib/generated/apis/BlocksApi.d.ts +163 -163
  5. package/lib/generated/apis/BlocksApi.js.map +1 -1
  6. package/lib/generated/apis/FaucetsApi.d.ts +84 -84
  7. package/lib/generated/apis/FaucetsApi.js.map +1 -1
  8. package/lib/generated/apis/FeesApi.d.ts +103 -103
  9. package/lib/generated/apis/FeesApi.js.map +1 -1
  10. package/lib/generated/apis/FungibleTokensApi.d.ts +82 -82
  11. package/lib/generated/apis/FungibleTokensApi.js.map +1 -1
  12. package/lib/generated/apis/InfoApi.d.ts +253 -253
  13. package/lib/generated/apis/InfoApi.js +1 -1
  14. package/lib/generated/apis/InfoApi.js.map +1 -1
  15. package/lib/generated/apis/MempoolApi.d.ts +49 -49
  16. package/lib/generated/apis/MicroblocksApi.d.ts +105 -105
  17. package/lib/generated/apis/MicroblocksApi.js.map +1 -1
  18. package/lib/generated/apis/NamesApi.d.ts +298 -298
  19. package/lib/generated/apis/NamesApi.js.map +1 -1
  20. package/lib/generated/apis/NonFungibleTokensApi.d.ts +191 -191
  21. package/lib/generated/apis/NonFungibleTokensApi.js.map +1 -1
  22. package/lib/generated/apis/RosettaApi.d.ts +454 -454
  23. package/lib/generated/apis/RosettaApi.js.map +1 -1
  24. package/lib/generated/apis/SearchApi.d.ts +54 -54
  25. package/lib/generated/apis/SearchApi.js.map +1 -1
  26. package/lib/generated/apis/SmartContractsApi.d.ts +255 -255
  27. package/lib/generated/apis/SmartContractsApi.js.map +1 -1
  28. package/lib/generated/apis/StackingApi.d.ts +61 -61
  29. package/lib/generated/apis/StackingApi.js.map +1 -1
  30. package/lib/generated/apis/StackingRewardsApi.d.ts +173 -173
  31. package/lib/generated/apis/StackingRewardsApi.js.map +1 -1
  32. package/lib/generated/apis/TransactionsApi.d.ts +430 -430
  33. package/lib/generated/apis/TransactionsApi.js +2 -2
  34. package/lib/generated/apis/TransactionsApi.js.map +1 -1
  35. package/lib/generated/apis/index.d.ts +16 -16
  36. package/lib/generated/index.d.ts +3 -3
  37. package/lib/generated/models/AccountDataResponse.d.ts +57 -57
  38. package/lib/generated/models/AccountDataResponse.js.map +1 -1
  39. package/lib/generated/models/AddressAssetsListResponse.d.ts +45 -45
  40. package/lib/generated/models/AddressAssetsListResponse.js.map +1 -1
  41. package/lib/generated/models/AddressBalanceResponse.d.ts +50 -50
  42. package/lib/generated/models/AddressBalanceResponse.js.map +1 -1
  43. package/lib/generated/models/AddressNftListResponse.d.ts +46 -46
  44. package/lib/generated/models/AddressNftListResponse.js.map +1 -1
  45. package/lib/generated/models/AddressNftListResponseValue.d.ts +33 -33
  46. package/lib/generated/models/AddressNftListResponseValue.js.map +1 -1
  47. package/lib/generated/models/AddressNonces.d.ts +51 -51
  48. package/lib/generated/models/AddressNonces.js.map +1 -1
  49. package/lib/generated/models/AddressStxInboundListResponse.d.ts +46 -46
  50. package/lib/generated/models/AddressStxInboundListResponse.js.map +1 -1
  51. package/lib/generated/models/AddressTokenOfferingLocked.d.ts +40 -40
  52. package/lib/generated/models/AddressTokenOfferingLocked.js.map +1 -1
  53. package/lib/generated/models/AddressTransactionWithTransfers.d.ts +58 -58
  54. package/lib/generated/models/AddressTransactionWithTransfers.js.map +1 -1
  55. package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.d.ts +45 -45
  56. package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.js.map +1 -1
  57. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.d.ts +46 -46
  58. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.js.map +1 -1
  59. package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.d.ts +39 -39
  60. package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.js.map +1 -1
  61. package/lib/generated/models/AddressTransactionWithTransfersValue.d.ts +33 -33
  62. package/lib/generated/models/AddressTransactionWithTransfersValue.js.map +1 -1
  63. package/lib/generated/models/AddressTransactionsListResponse.d.ts +45 -45
  64. package/lib/generated/models/AddressTransactionsListResponse.js.map +1 -1
  65. package/lib/generated/models/AddressTransactionsWithTransfersListResponse.d.ts +46 -46
  66. package/lib/generated/models/AddressTransactionsWithTransfersListResponse.js.map +1 -1
  67. package/lib/generated/models/AddressUnlockSchedule.d.ts +33 -33
  68. package/lib/generated/models/AddressUnlockSchedule.js.map +1 -1
  69. package/lib/generated/models/Block.d.ts +149 -149
  70. package/lib/generated/models/Block.js.map +1 -1
  71. package/lib/generated/models/BlockListResponse.d.ts +46 -46
  72. package/lib/generated/models/BlockListResponse.js.map +1 -1
  73. package/lib/generated/models/BnsError.d.ts +27 -27
  74. package/lib/generated/models/BnsError.js.map +1 -1
  75. package/lib/generated/models/BnsGetAllNamespacesResponse.d.ts +27 -27
  76. package/lib/generated/models/BnsGetAllNamespacesResponse.js.map +1 -1
  77. package/lib/generated/models/BnsGetNameInfoResponse.d.ts +75 -75
  78. package/lib/generated/models/BnsGetNameInfoResponse.js.map +1 -1
  79. package/lib/generated/models/BnsGetNamePriceResponse.d.ts +33 -33
  80. package/lib/generated/models/BnsGetNamePriceResponse.js.map +1 -1
  81. package/lib/generated/models/BnsGetNamespacePriceResponse.d.ts +33 -33
  82. package/lib/generated/models/BnsGetNamespacePriceResponse.js.map +1 -1
  83. package/lib/generated/models/BnsNamesOwnByAddressResponse.d.ts +27 -27
  84. package/lib/generated/models/BnsNamesOwnByAddressResponse.js.map +1 -1
  85. package/lib/generated/models/BurnchainReward.d.ts +63 -63
  86. package/lib/generated/models/BurnchainReward.js.map +1 -1
  87. package/lib/generated/models/BurnchainRewardListResponse.d.ts +40 -40
  88. package/lib/generated/models/BurnchainRewardListResponse.js.map +1 -1
  89. package/lib/generated/models/BurnchainRewardSlotHolder.d.ts +51 -51
  90. package/lib/generated/models/BurnchainRewardSlotHolder.js.map +1 -1
  91. package/lib/generated/models/BurnchainRewardSlotHolderListResponse.d.ts +46 -46
  92. package/lib/generated/models/BurnchainRewardSlotHolderListResponse.js.map +1 -1
  93. package/lib/generated/models/BurnchainRewardsTotal.d.ts +33 -33
  94. package/lib/generated/models/BurnchainRewardsTotal.js.map +1 -1
  95. package/lib/generated/models/ChainTip.d.ts +57 -57
  96. package/lib/generated/models/ChainTip.js.map +1 -1
  97. package/lib/generated/models/ContractInterfaceResponse.d.ts +51 -51
  98. package/lib/generated/models/ContractInterfaceResponse.js.map +1 -1
  99. package/lib/generated/models/ContractListResponse.d.ts +40 -40
  100. package/lib/generated/models/ContractListResponse.js.map +1 -1
  101. package/lib/generated/models/ContractSourceResponse.d.ts +39 -39
  102. package/lib/generated/models/ContractSourceResponse.js.map +1 -1
  103. package/lib/generated/models/CoreNodeInfoResponse.d.ts +99 -99
  104. package/lib/generated/models/CoreNodeInfoResponse.js.map +1 -1
  105. package/lib/generated/models/CoreNodePoxResponse.d.ts +75 -75
  106. package/lib/generated/models/CoreNodePoxResponse.js.map +1 -1
  107. package/lib/generated/models/FeeRate.d.ts +27 -27
  108. package/lib/generated/models/FeeRate.js.map +1 -1
  109. package/lib/generated/models/FeeRateRequest.d.ts +27 -27
  110. package/lib/generated/models/FeeRateRequest.js.map +1 -1
  111. package/lib/generated/models/FungibleTokenMetadata.d.ts +75 -75
  112. package/lib/generated/models/FungibleTokenMetadata.js.map +1 -1
  113. package/lib/generated/models/FungibleTokensMetadataList.d.ts +46 -46
  114. package/lib/generated/models/FungibleTokensMetadataList.js.map +1 -1
  115. package/lib/generated/models/GetRawTransactionResult.d.ts +27 -27
  116. package/lib/generated/models/GetRawTransactionResult.js.map +1 -1
  117. package/lib/generated/models/GetStxSupplyLegacyFormatResponse.d.ts +57 -57
  118. package/lib/generated/models/GetStxSupplyLegacyFormatResponse.js.map +1 -1
  119. package/lib/generated/models/GetStxSupplyResponse.d.ts +45 -45
  120. package/lib/generated/models/GetStxSupplyResponse.js.map +1 -1
  121. package/lib/generated/models/InboundStxTransfer.d.ts +72 -72
  122. package/lib/generated/models/InboundStxTransfer.js +1 -1
  123. package/lib/generated/models/InboundStxTransfer.js.map +1 -1
  124. package/lib/generated/models/InlineObject.d.ts +27 -27
  125. package/lib/generated/models/InlineObject.js.map +1 -1
  126. package/lib/generated/models/InlineResponse403.d.ts +33 -33
  127. package/lib/generated/models/InlineResponse403.js.map +1 -1
  128. package/lib/generated/models/MapEntryResponse.d.ts +33 -33
  129. package/lib/generated/models/MapEntryResponse.js.map +1 -1
  130. package/lib/generated/models/MempoolFeePriorities.d.ts +46 -46
  131. package/lib/generated/models/MempoolFeePriorities.js.map +1 -1
  132. package/lib/generated/models/MempoolFeePrioritiesAll.d.ts +45 -45
  133. package/lib/generated/models/MempoolFeePrioritiesAll.js.map +1 -1
  134. package/lib/generated/models/MempoolTransactionListResponse.d.ts +45 -45
  135. package/lib/generated/models/MempoolTransactionListResponse.js.map +1 -1
  136. package/lib/generated/models/MempoolTransactionStatsResponse.d.ts +46 -46
  137. package/lib/generated/models/MempoolTransactionStatsResponse.js.map +1 -1
  138. package/lib/generated/models/MempoolTransactionStatsResponseTxAges.d.ts +46 -46
  139. package/lib/generated/models/MempoolTransactionStatsResponseTxAges.js.map +1 -1
  140. package/lib/generated/models/MempoolTransactionStatsResponseTxByteSizes.d.ts +46 -46
  141. package/lib/generated/models/MempoolTransactionStatsResponseTxByteSizes.js.map +1 -1
  142. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAverages.d.ts +46 -46
  143. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAverages.js.map +1 -1
  144. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.d.ts +45 -45
  145. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.js.map +1 -1
  146. package/lib/generated/models/MempoolTransactionStatsResponseTxTypeCounts.d.ts +45 -45
  147. package/lib/generated/models/MempoolTransactionStatsResponseTxTypeCounts.js.map +1 -1
  148. package/lib/generated/models/Microblock.d.ts +105 -105
  149. package/lib/generated/models/Microblock.js.map +1 -1
  150. package/lib/generated/models/MicroblockListResponse.d.ts +46 -46
  151. package/lib/generated/models/MicroblockListResponse.js.map +1 -1
  152. package/lib/generated/models/NetworkBlockTimeResponse.d.ts +27 -27
  153. package/lib/generated/models/NetworkBlockTimeResponse.js.map +1 -1
  154. package/lib/generated/models/NetworkBlockTimesResponse.d.ts +34 -34
  155. package/lib/generated/models/NetworkBlockTimesResponse.js.map +1 -1
  156. package/lib/generated/models/NetworkIdentifier.d.ts +40 -40
  157. package/lib/generated/models/NetworkIdentifier.js.map +1 -1
  158. package/lib/generated/models/NftEvent.d.ts +76 -76
  159. package/lib/generated/models/NftEvent.js.map +1 -1
  160. package/lib/generated/models/NonFungibleTokenHistoryEventList.d.ts +45 -45
  161. package/lib/generated/models/NonFungibleTokenHistoryEventList.js.map +1 -1
  162. package/lib/generated/models/NonFungibleTokenHoldingsList.d.ts +45 -45
  163. package/lib/generated/models/NonFungibleTokenHoldingsList.js.map +1 -1
  164. package/lib/generated/models/NonFungibleTokenMetadata.d.ts +63 -63
  165. package/lib/generated/models/NonFungibleTokenMetadata.js.map +1 -1
  166. package/lib/generated/models/NonFungibleTokenMintList.d.ts +45 -45
  167. package/lib/generated/models/NonFungibleTokenMintList.js.map +1 -1
  168. package/lib/generated/models/NonFungibleTokensMetadataList.d.ts +46 -46
  169. package/lib/generated/models/NonFungibleTokensMetadataList.js.map +1 -1
  170. package/lib/generated/models/OtherTransactionIdentifier.d.ts +27 -27
  171. package/lib/generated/models/OtherTransactionIdentifier.js.map +1 -1
  172. package/lib/generated/models/PoolDelegation.d.ts +57 -57
  173. package/lib/generated/models/PoolDelegation.js.map +1 -1
  174. package/lib/generated/models/PoolDelegationsResponse.d.ts +46 -46
  175. package/lib/generated/models/PoolDelegationsResponse.js.map +1 -1
  176. package/lib/generated/models/PostCoreNodeTransactionsError.d.ts +45 -45
  177. package/lib/generated/models/PostCoreNodeTransactionsError.js.map +1 -1
  178. package/lib/generated/models/ReadOnlyFunctionArgs.d.ts +33 -33
  179. package/lib/generated/models/ReadOnlyFunctionArgs.js.map +1 -1
  180. package/lib/generated/models/ReadOnlyFunctionSuccessResponse.d.ts +39 -39
  181. package/lib/generated/models/ReadOnlyFunctionSuccessResponse.js.map +1 -1
  182. package/lib/generated/models/RosettaAccount.d.ts +40 -40
  183. package/lib/generated/models/RosettaAccount.js.map +1 -1
  184. package/lib/generated/models/RosettaAccountBalanceRequest.d.ts +40 -40
  185. package/lib/generated/models/RosettaAccountBalanceRequest.js.map +1 -1
  186. package/lib/generated/models/RosettaAccountBalanceResponse.d.ts +46 -46
  187. package/lib/generated/models/RosettaAccountBalanceResponse.js.map +1 -1
  188. package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.d.ts +27 -27
  189. package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.js.map +1 -1
  190. package/lib/generated/models/RosettaAccountBalanceResponseMetadata.d.ts +27 -27
  191. package/lib/generated/models/RosettaAccountBalanceResponseMetadata.js.map +1 -1
  192. package/lib/generated/models/RosettaAccountIdentifier.d.ts +40 -40
  193. package/lib/generated/models/RosettaAccountIdentifier.js.map +1 -1
  194. package/lib/generated/models/RosettaAmount.d.ts +40 -40
  195. package/lib/generated/models/RosettaAmount.js.map +1 -1
  196. package/lib/generated/models/RosettaBlock.d.ts +52 -52
  197. package/lib/generated/models/RosettaBlock.js.map +1 -1
  198. package/lib/generated/models/RosettaBlockMetadata.d.ts +39 -39
  199. package/lib/generated/models/RosettaBlockMetadata.js.map +1 -1
  200. package/lib/generated/models/RosettaBlockMetadata1.d.ts +33 -33
  201. package/lib/generated/models/RosettaBlockMetadata1.js.map +1 -1
  202. package/lib/generated/models/RosettaBlockRequest.d.ts +34 -34
  203. package/lib/generated/models/RosettaBlockRequest.js.map +1 -1
  204. package/lib/generated/models/RosettaBlockResponse.d.ts +34 -34
  205. package/lib/generated/models/RosettaBlockResponse.js.map +1 -1
  206. package/lib/generated/models/RosettaBlockTransactionRequest.d.ts +40 -40
  207. package/lib/generated/models/RosettaBlockTransactionRequest.js.map +1 -1
  208. package/lib/generated/models/RosettaBlockTransactionResponse.d.ts +28 -28
  209. package/lib/generated/models/RosettaBlockTransactionResponse.js.map +1 -1
  210. package/lib/generated/models/RosettaCoin.d.ts +34 -34
  211. package/lib/generated/models/RosettaCoin.js.map +1 -1
  212. package/lib/generated/models/RosettaCoinChange.d.ts +42 -42
  213. package/lib/generated/models/RosettaCoinChange.js +1 -1
  214. package/lib/generated/models/RosettaCoinChange.js.map +1 -1
  215. package/lib/generated/models/RosettaConstructionCombineRequest.d.ts +40 -40
  216. package/lib/generated/models/RosettaConstructionCombineRequest.js.map +1 -1
  217. package/lib/generated/models/RosettaConstructionCombineResponse.d.ts +27 -27
  218. package/lib/generated/models/RosettaConstructionCombineResponse.js.map +1 -1
  219. package/lib/generated/models/RosettaConstructionDeriveRequest.d.ts +40 -40
  220. package/lib/generated/models/RosettaConstructionDeriveRequest.js.map +1 -1
  221. package/lib/generated/models/RosettaConstructionDeriveResponse.d.ts +40 -40
  222. package/lib/generated/models/RosettaConstructionDeriveResponse.js.map +1 -1
  223. package/lib/generated/models/RosettaConstructionHashRequest.d.ts +34 -34
  224. package/lib/generated/models/RosettaConstructionHashRequest.js.map +1 -1
  225. package/lib/generated/models/RosettaConstructionHashResponse.d.ts +34 -34
  226. package/lib/generated/models/RosettaConstructionHashResponse.js.map +1 -1
  227. package/lib/generated/models/RosettaConstructionMetadataRequest.d.ts +40 -40
  228. package/lib/generated/models/RosettaConstructionMetadataRequest.js.map +1 -1
  229. package/lib/generated/models/RosettaConstructionMetadataResponse.d.ts +34 -34
  230. package/lib/generated/models/RosettaConstructionMetadataResponse.js.map +1 -1
  231. package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.d.ts +33 -33
  232. package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.js.map +1 -1
  233. package/lib/generated/models/RosettaConstructionParseRequest.d.ts +40 -40
  234. package/lib/generated/models/RosettaConstructionParseRequest.js.map +1 -1
  235. package/lib/generated/models/RosettaConstructionParseResponse.d.ts +46 -46
  236. package/lib/generated/models/RosettaConstructionParseResponse.js.map +1 -1
  237. package/lib/generated/models/RosettaConstructionPayloadResponse.d.ts +34 -34
  238. package/lib/generated/models/RosettaConstructionPayloadResponse.js.map +1 -1
  239. package/lib/generated/models/RosettaConstructionPayloadsRequest.d.ts +46 -46
  240. package/lib/generated/models/RosettaConstructionPayloadsRequest.js.map +1 -1
  241. package/lib/generated/models/RosettaConstructionPreprocessRequest.d.ts +52 -52
  242. package/lib/generated/models/RosettaConstructionPreprocessRequest.js.map +1 -1
  243. package/lib/generated/models/RosettaConstructionPreprocessResponse.d.ts +34 -34
  244. package/lib/generated/models/RosettaConstructionPreprocessResponse.js.map +1 -1
  245. package/lib/generated/models/RosettaConstructionSubmitRequest.d.ts +34 -34
  246. package/lib/generated/models/RosettaConstructionSubmitRequest.js.map +1 -1
  247. package/lib/generated/models/RosettaConstructionSubmitResponse.d.ts +34 -34
  248. package/lib/generated/models/RosettaConstructionSubmitResponse.js.map +1 -1
  249. package/lib/generated/models/RosettaCurrency.d.ts +39 -39
  250. package/lib/generated/models/RosettaCurrency.js.map +1 -1
  251. package/lib/generated/models/RosettaError.d.ts +46 -46
  252. package/lib/generated/models/RosettaError.js.map +1 -1
  253. package/lib/generated/models/RosettaErrorDetails.d.ts +33 -33
  254. package/lib/generated/models/RosettaErrorDetails.js.map +1 -1
  255. package/lib/generated/models/RosettaErrorNoDetails.d.ts +39 -39
  256. package/lib/generated/models/RosettaErrorNoDetails.js.map +1 -1
  257. package/lib/generated/models/RosettaGenesisBlockIdentifier.d.ts +33 -33
  258. package/lib/generated/models/RosettaGenesisBlockIdentifier.js.map +1 -1
  259. package/lib/generated/models/RosettaMaxFeeAmount.d.ts +40 -40
  260. package/lib/generated/models/RosettaMaxFeeAmount.js.map +1 -1
  261. package/lib/generated/models/RosettaMempoolRequest.d.ts +34 -34
  262. package/lib/generated/models/RosettaMempoolRequest.js.map +1 -1
  263. package/lib/generated/models/RosettaMempoolResponse.d.ts +34 -34
  264. package/lib/generated/models/RosettaMempoolResponse.js.map +1 -1
  265. package/lib/generated/models/RosettaMempoolTransactionRequest.d.ts +34 -34
  266. package/lib/generated/models/RosettaMempoolTransactionRequest.js.map +1 -1
  267. package/lib/generated/models/RosettaMempoolTransactionResponse.d.ts +34 -34
  268. package/lib/generated/models/RosettaMempoolTransactionResponse.js.map +1 -1
  269. package/lib/generated/models/RosettaNetworkListResponse.d.ts +28 -28
  270. package/lib/generated/models/RosettaNetworkListResponse.js.map +1 -1
  271. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.d.ts +34 -34
  272. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.js.map +1 -1
  273. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.d.ts +27 -27
  274. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.js.map +1 -1
  275. package/lib/generated/models/RosettaNetworkOptionsResponse.d.ts +34 -34
  276. package/lib/generated/models/RosettaNetworkOptionsResponse.js.map +1 -1
  277. package/lib/generated/models/RosettaNetworkOptionsResponseAllow.d.ts +46 -46
  278. package/lib/generated/models/RosettaNetworkOptionsResponseAllow.js.map +1 -1
  279. package/lib/generated/models/RosettaNetworkOptionsResponseVersion.d.ts +45 -45
  280. package/lib/generated/models/RosettaNetworkOptionsResponseVersion.js.map +1 -1
  281. package/lib/generated/models/RosettaNetworkStatusResponse.d.ts +58 -58
  282. package/lib/generated/models/RosettaNetworkStatusResponse.js.map +1 -1
  283. package/lib/generated/models/RosettaOldestBlockIdentifier.d.ts +33 -33
  284. package/lib/generated/models/RosettaOldestBlockIdentifier.js.map +1 -1
  285. package/lib/generated/models/RosettaOperation.d.ts +70 -70
  286. package/lib/generated/models/RosettaOperation.js.map +1 -1
  287. package/lib/generated/models/RosettaOperationIdentifier.d.ts +33 -33
  288. package/lib/generated/models/RosettaOperationIdentifier.js.map +1 -1
  289. package/lib/generated/models/RosettaOperationStatus.d.ts +33 -33
  290. package/lib/generated/models/RosettaOperationStatus.js.map +1 -1
  291. package/lib/generated/models/RosettaOptions.d.ts +141 -141
  292. package/lib/generated/models/RosettaOptions.js.map +1 -1
  293. package/lib/generated/models/RosettaOptionsRequest.d.ts +34 -34
  294. package/lib/generated/models/RosettaOptionsRequest.js.map +1 -1
  295. package/lib/generated/models/RosettaParentBlockIdentifier.d.ts +33 -33
  296. package/lib/generated/models/RosettaParentBlockIdentifier.js.map +1 -1
  297. package/lib/generated/models/RosettaPeers.d.ts +33 -33
  298. package/lib/generated/models/RosettaPeers.js.map +1 -1
  299. package/lib/generated/models/RosettaPublicKey.d.ts +41 -41
  300. package/lib/generated/models/RosettaPublicKey.js +1 -1
  301. package/lib/generated/models/RosettaPublicKey.js.map +1 -1
  302. package/lib/generated/models/RosettaRelatedOperation.d.ts +33 -33
  303. package/lib/generated/models/RosettaRelatedOperation.js.map +1 -1
  304. package/lib/generated/models/RosettaSignature.d.ts +57 -57
  305. package/lib/generated/models/RosettaSignature.js +1 -1
  306. package/lib/generated/models/RosettaSignature.js.map +1 -1
  307. package/lib/generated/models/RosettaStatusRequest.d.ts +34 -34
  308. package/lib/generated/models/RosettaStatusRequest.js.map +1 -1
  309. package/lib/generated/models/RosettaSubAccount.d.ts +33 -33
  310. package/lib/generated/models/RosettaSubAccount.js.map +1 -1
  311. package/lib/generated/models/RosettaSyncStatus.d.ts +45 -45
  312. package/lib/generated/models/RosettaSyncStatus.js.map +1 -1
  313. package/lib/generated/models/RosettaTransaction.d.ts +40 -40
  314. package/lib/generated/models/RosettaTransaction.js.map +1 -1
  315. package/lib/generated/models/RunFaucetResponse.d.ts +39 -39
  316. package/lib/generated/models/RunFaucetResponse.js.map +1 -1
  317. package/lib/generated/models/ServerStatusResponse.d.ts +52 -52
  318. package/lib/generated/models/ServerStatusResponse.js.map +1 -1
  319. package/lib/generated/models/SigningPayload.d.ts +57 -57
  320. package/lib/generated/models/SigningPayload.js +1 -1
  321. package/lib/generated/models/SigningPayload.js.map +1 -1
  322. package/lib/generated/models/SmartContract.d.ts +57 -57
  323. package/lib/generated/models/SmartContract.js.map +1 -1
  324. package/lib/generated/models/StxBalance.d.ts +81 -81
  325. package/lib/generated/models/StxBalance.js.map +1 -1
  326. package/lib/generated/models/TargetBlockTime.d.ts +27 -27
  327. package/lib/generated/models/TargetBlockTime.js.map +1 -1
  328. package/lib/generated/models/TransactionEventsResponse.d.ts +39 -39
  329. package/lib/generated/models/TransactionEventsResponse.js.map +1 -1
  330. package/lib/generated/models/TransactionFeeEstimateRequest.d.ts +33 -33
  331. package/lib/generated/models/TransactionFeeEstimateRequest.js.map +1 -1
  332. package/lib/generated/models/TransactionFeeEstimateResponse.d.ts +46 -46
  333. package/lib/generated/models/TransactionFeeEstimateResponse.js.map +1 -1
  334. package/lib/generated/models/TransactionFeeEstimateResponseEstimatedCost.d.ts +51 -51
  335. package/lib/generated/models/TransactionFeeEstimateResponseEstimatedCost.js.map +1 -1
  336. package/lib/generated/models/TransactionFeeEstimateResponseEstimations.d.ts +33 -33
  337. package/lib/generated/models/TransactionFeeEstimateResponseEstimations.js.map +1 -1
  338. package/lib/generated/models/TransactionIdentifier.d.ts +27 -27
  339. package/lib/generated/models/TransactionIdentifier.js.map +1 -1
  340. package/lib/generated/models/TransactionResults.d.ts +45 -45
  341. package/lib/generated/models/TransactionResults.js.map +1 -1
  342. package/lib/generated/models/UnanchoredTransactionListResponse.d.ts +33 -33
  343. package/lib/generated/models/UnanchoredTransactionListResponse.js.map +1 -1
  344. package/lib/generated/models/index.d.ts +151 -151
  345. package/lib/generated/runtime.d.ts +140 -140
  346. package/lib/generated/runtime.js +12 -3
  347. package/lib/generated/runtime.js.map +1 -1
  348. package/lib/index.d.ts +3 -3
  349. package/lib/index.umd.js +1637 -1352
  350. package/lib/index.umd.js.map +1 -1
  351. package/lib/socket-io/index.d.ts +56 -53
  352. package/lib/socket-io/index.js +64 -36
  353. package/lib/socket-io/index.js.map +1 -1
  354. package/lib/ws/index.d.ts +40 -40
  355. package/lib/ws/index.js +30 -29
  356. package/lib/ws/index.js.map +1 -1
  357. package/package.json +18 -15
  358. package/src/socket-io/index.ts +85 -53
  359. package/src/ws/index.ts +12 -7
@@ -1,103 +1,103 @@
1
- /**
2
- * Stacks Blockchain API
3
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
- *
5
- * The version of the OpenAPI document: STACKS_API_VERSION
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import { FeeRate, FeeRateRequest, TransactionFeeEstimateRequest, TransactionFeeEstimateResponse } from '../models';
14
- export interface FetchFeeRateRequest {
15
- feeRateRequest: FeeRateRequest;
16
- }
17
- export interface PostFeeTransactionRequest {
18
- transactionFeeEstimateRequest?: TransactionFeeEstimateRequest;
19
- }
20
- /**
21
- * FeesApi - interface
22
- *
23
- * @export
24
- * @interface FeesApiInterface
25
- */
26
- export interface FeesApiInterface {
27
- /**
28
- * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
29
- * @summary Fetch fee rate
30
- * @param {FeeRateRequest} feeRateRequest
31
- * @param {*} [options] Override http request option.
32
- * @throws {RequiredError}
33
- * @memberof FeesApiInterface
34
- */
35
- fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>>;
36
- /**
37
- * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
38
- * Fetch fee rate
39
- */
40
- fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate>;
41
- /**
42
- * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
43
- * @summary Get estimated fee
44
- * @param {*} [options] Override http request option.
45
- * @throws {RequiredError}
46
- * @memberof FeesApiInterface
47
- */
48
- getFeeTransferRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
49
- /**
50
- * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
51
- * Get estimated fee
52
- */
53
- getFeeTransfer(initOverrides?: RequestInit): Promise<object>;
54
- /**
55
- * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
56
- * @summary Get approximate fees for a given transaction
57
- * @param {TransactionFeeEstimateRequest} [transactionFeeEstimateRequest]
58
- * @param {*} [options] Override http request option.
59
- * @throws {RequiredError}
60
- * @memberof FeesApiInterface
61
- */
62
- postFeeTransactionRaw(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionFeeEstimateResponse>>;
63
- /**
64
- * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
65
- * Get approximate fees for a given transaction
66
- */
67
- postFeeTransaction(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<TransactionFeeEstimateResponse>;
68
- }
69
- /**
70
- *
71
- */
72
- export declare class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
73
- /**
74
- * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
75
- * Fetch fee rate
76
- */
77
- fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>>;
78
- /**
79
- * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
80
- * Fetch fee rate
81
- */
82
- fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate>;
83
- /**
84
- * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
85
- * Get estimated fee
86
- */
87
- getFeeTransferRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
88
- /**
89
- * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
90
- * Get estimated fee
91
- */
92
- getFeeTransfer(initOverrides?: RequestInit): Promise<object>;
93
- /**
94
- * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
95
- * Get approximate fees for a given transaction
96
- */
97
- postFeeTransactionRaw(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionFeeEstimateResponse>>;
98
- /**
99
- * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
100
- * Get approximate fees for a given transaction
101
- */
102
- postFeeTransaction(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<TransactionFeeEstimateResponse>;
103
- }
1
+ /**
2
+ * Stacks Blockchain API
3
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
+ *
5
+ * The version of the OpenAPI document: STACKS_API_VERSION
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { FeeRate, FeeRateRequest, TransactionFeeEstimateRequest, TransactionFeeEstimateResponse } from '../models';
14
+ export interface FetchFeeRateRequest {
15
+ feeRateRequest: FeeRateRequest;
16
+ }
17
+ export interface PostFeeTransactionRequest {
18
+ transactionFeeEstimateRequest?: TransactionFeeEstimateRequest;
19
+ }
20
+ /**
21
+ * FeesApi - interface
22
+ *
23
+ * @export
24
+ * @interface FeesApiInterface
25
+ */
26
+ export interface FeesApiInterface {
27
+ /**
28
+ * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
29
+ * @summary Fetch fee rate
30
+ * @param {FeeRateRequest} feeRateRequest
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ * @memberof FeesApiInterface
34
+ */
35
+ fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>>;
36
+ /**
37
+ * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
38
+ * Fetch fee rate
39
+ */
40
+ fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate>;
41
+ /**
42
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
43
+ * @summary Get estimated fee
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ * @memberof FeesApiInterface
47
+ */
48
+ getFeeTransferRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
49
+ /**
50
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
51
+ * Get estimated fee
52
+ */
53
+ getFeeTransfer(initOverrides?: RequestInit): Promise<object>;
54
+ /**
55
+ * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
56
+ * @summary Get approximate fees for a given transaction
57
+ * @param {TransactionFeeEstimateRequest} [transactionFeeEstimateRequest]
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ * @memberof FeesApiInterface
61
+ */
62
+ postFeeTransactionRaw(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionFeeEstimateResponse>>;
63
+ /**
64
+ * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
65
+ * Get approximate fees for a given transaction
66
+ */
67
+ postFeeTransaction(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<TransactionFeeEstimateResponse>;
68
+ }
69
+ /**
70
+ *
71
+ */
72
+ export declare class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
73
+ /**
74
+ * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
75
+ * Fetch fee rate
76
+ */
77
+ fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>>;
78
+ /**
79
+ * **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction). Retrieves estimated fee rate.
80
+ * Fetch fee rate
81
+ */
82
+ fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate>;
83
+ /**
84
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
85
+ * Get estimated fee
86
+ */
87
+ getFeeTransferRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
88
+ /**
89
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
90
+ * Get estimated fee
91
+ */
92
+ getFeeTransfer(initOverrides?: RequestInit): Promise<object>;
93
+ /**
94
+ * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
95
+ * Get approximate fees for a given transaction
96
+ */
97
+ postFeeTransactionRaw(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionFeeEstimateResponse>>;
98
+ /**
99
+ * Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts. * `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction. * `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a `reason` field which can be one of the following: * `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction. * `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet. * `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint. The 200 response contains the following data: * `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction. * `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node\'s estimated fee rate. * `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction. * `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields: * `fee_rate` - the estimated value for the current fee rates in the network * `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead. Note: If the final transaction\'s byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)
100
+ * Get approximate fees for a given transaction
101
+ */
102
+ postFeeTransaction(requestParameters: PostFeeTransactionRequest, initOverrides?: RequestInit): Promise<TransactionFeeEstimateResponse>;
103
+ }
@@ -1 +1 @@
1
- {"version":3,"file":"FeesApi.js","sourceRoot":"","sources":["../../../src/generated/apis/FeesApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAamB;AAkEnB;;GAEG;AACH,MAAa,OAAQ,SAAQ,OAAO,CAAC,OAAO;IAExC;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,iBAAsC,EAAE,aAA2B;QACrF,IAAI,iBAAiB,CAAC,cAAc,KAAK,IAAI,IAAI,iBAAiB,CAAC,cAAc,KAAK,SAAS,EAAE;YAC7F,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAC,sGAAsG,CAAC,CAAC;SAC5J;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,IAAA,6BAAoB,EAAC,iBAAiB,CAAC,cAAc,CAAC;SAC/D,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,wBAAe,EAAC,SAAS,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,iBAAsC,EAAE,aAA2B;QAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC9E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,aAA2B;QAC/C,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,aAA2B;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAC7D,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAC,iBAA4C,EAAE,aAA2B;QACjG,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,IAAA,4CAAmC,EAAC,iBAAiB,CAAC,6BAA6B,CAAC;SAC7F,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,+CAAsC,EAAC,SAAS,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,iBAA4C,EAAE,aAA2B;QAC9F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACpF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAhGD,0BAgGC"}
1
+ {"version":3,"file":"FeesApi.js","sourceRoot":"","sources":["../../../src/generated/apis/FeesApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAamB;AAkEnB;;GAEG;AACH,MAAa,OAAQ,SAAQ,OAAO,CAAC,OAAO;IAExC;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,iBAAsC,EAAE,aAA2B;QACrF,IAAI,iBAAiB,CAAC,cAAc,KAAK,IAAI,IAAI,iBAAiB,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAC9F,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAC,sGAAsG,CAAC,CAAC;QAC7J,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,IAAA,6BAAoB,EAAC,iBAAiB,CAAC,cAAc,CAAC;SAC/D,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,wBAAe,EAAC,SAAS,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,iBAAsC,EAAE,aAA2B;QAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC9E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,aAA2B;QAC/C,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,aAA2B;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAC7D,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAC,iBAA4C,EAAE,aAA2B;QACjG,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,IAAA,4CAAmC,EAAC,iBAAiB,CAAC,6BAA6B,CAAC;SAC7F,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,+CAAsC,EAAC,SAAS,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,iBAA4C,EAAE,aAA2B;QAC9F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACpF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAhGD,0BAgGC"}
@@ -1,82 +1,82 @@
1
- /**
2
- * Stacks Blockchain API
3
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
- *
5
- * The version of the OpenAPI document: STACKS_API_VERSION
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import { FungibleTokenMetadata, FungibleTokensMetadataList } from '../models';
14
- export interface GetContractFtMetadataRequest {
15
- contractId: string;
16
- }
17
- export interface GetFtMetadataListRequest {
18
- limit?: number;
19
- offset?: number;
20
- }
21
- /**
22
- * FungibleTokensApi - interface
23
- *
24
- * @export
25
- * @interface FungibleTokensApiInterface
26
- */
27
- export interface FungibleTokensApiInterface {
28
- /**
29
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
30
- * @summary Fungible tokens metadata for contract id
31
- * @param {string} contractId token\&#39;s contract id
32
- * @param {*} [options] Override http request option.
33
- * @throws {RequiredError}
34
- * @memberof FungibleTokensApiInterface
35
- */
36
- getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
37
- /**
38
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
39
- * Fungible tokens metadata for contract id
40
- */
41
- getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
42
- /**
43
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
44
- * @summary Fungible tokens metadata list
45
- * @param {number} [limit] max number of tokens to fetch.
46
- * @param {number} [offset] index of first tokens to fetch
47
- * @param {*} [options] Override http request option.
48
- * @throws {RequiredError}
49
- * @memberof FungibleTokensApiInterface
50
- */
51
- getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
52
- /**
53
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
54
- * Fungible tokens metadata list
55
- */
56
- getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
57
- }
58
- /**
59
- *
60
- */
61
- export declare class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokensApiInterface {
62
- /**
63
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
64
- * Fungible tokens metadata for contract id
65
- */
66
- getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
67
- /**
68
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
69
- * Fungible tokens metadata for contract id
70
- */
71
- getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
72
- /**
73
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
74
- * Fungible tokens metadata list
75
- */
76
- getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
77
- /**
78
- * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
79
- * Fungible tokens metadata list
80
- */
81
- getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
82
- }
1
+ /**
2
+ * Stacks Blockchain API
3
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
+ *
5
+ * The version of the OpenAPI document: STACKS_API_VERSION
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { FungibleTokenMetadata, FungibleTokensMetadataList } from '../models';
14
+ export interface GetContractFtMetadataRequest {
15
+ contractId: string;
16
+ }
17
+ export interface GetFtMetadataListRequest {
18
+ limit?: number;
19
+ offset?: number;
20
+ }
21
+ /**
22
+ * FungibleTokensApi - interface
23
+ *
24
+ * @export
25
+ * @interface FungibleTokensApiInterface
26
+ */
27
+ export interface FungibleTokensApiInterface {
28
+ /**
29
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
30
+ * @summary Fungible tokens metadata for contract id
31
+ * @param {string} contractId token\&#39;s contract id
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ * @memberof FungibleTokensApiInterface
35
+ */
36
+ getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
37
+ /**
38
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
39
+ * Fungible tokens metadata for contract id
40
+ */
41
+ getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
42
+ /**
43
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
44
+ * @summary Fungible tokens metadata list
45
+ * @param {number} [limit] max number of tokens to fetch.
46
+ * @param {number} [offset] index of first tokens to fetch
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ * @memberof FungibleTokensApiInterface
50
+ */
51
+ getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
52
+ /**
53
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
54
+ * Fungible tokens metadata list
55
+ */
56
+ getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
57
+ }
58
+ /**
59
+ *
60
+ */
61
+ export declare class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokensApiInterface {
62
+ /**
63
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
64
+ * Fungible tokens metadata for contract id
65
+ */
66
+ getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
67
+ /**
68
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
69
+ * Fungible tokens metadata for contract id
70
+ */
71
+ getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
72
+ /**
73
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
74
+ * Fungible tokens metadata list
75
+ */
76
+ getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
77
+ /**
78
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
79
+ * Fungible tokens metadata list
80
+ */
81
+ getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
82
+ }
@@ -1 +1 @@
1
- {"version":3,"file":"FungibleTokensApi.js","sourceRoot":"","sources":["../../../src/generated/apis/FungibleTokensApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAOmB;AAqDnB;;GAEG;AACH,MAAa,iBAAkB,SAAQ,OAAO,CAAC,OAAO;IAElD;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAAC,iBAA+C,EAAE,aAA2B;QACvG,IAAI,iBAAiB,CAAC,UAAU,KAAK,IAAI,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS,EAAE;YACrF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,YAAY,EAAC,2GAA2G,CAAC,CAAC;SAC7J;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,8CAA8C,CAAC,OAAO,CAAC,IAAI,YAAY,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC3I,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,sCAA6B,EAAC,SAAS,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAC,iBAA+C,EAAE,aAA2B;QACpG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACvF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA2C,EAAE,aAA2B;QAC/F,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,iCAAiC;YACvC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,2CAAkC,EAAC,SAAS,CAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAA2C,EAAE,aAA2B;QAC5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAtED,8CAsEC"}
1
+ {"version":3,"file":"FungibleTokensApi.js","sourceRoot":"","sources":["../../../src/generated/apis/FungibleTokensApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAOmB;AAqDnB;;GAEG;AACH,MAAa,iBAAkB,SAAQ,OAAO,CAAC,OAAO;IAElD;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAAC,iBAA+C,EAAE,aAA2B;QACvG,IAAI,iBAAiB,CAAC,UAAU,KAAK,IAAI,IAAI,iBAAiB,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACtF,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,YAAY,EAAC,2GAA2G,CAAC,CAAC;QAC9J,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,8CAA8C,CAAC,OAAO,CAAC,IAAI,YAAY,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC3I,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,sCAA6B,EAAC,SAAS,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAC,iBAA+C,EAAE,aAA2B;QACpG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACvF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA2C,EAAE,aAA2B;QAC/F,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACxC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;QACvD,CAAC;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACzC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;QACzD,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,iCAAiC;YACvC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,2CAAkC,EAAC,SAAS,CAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAA2C,EAAE,aAA2B;QAC5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAtED,8CAsEC"}