@stacks/blockchain-api-client 0.71.2 → 1.0.0

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 (469) hide show
  1. package/README.md +362 -15
  2. package/lib/generated/apis/AccountsApi.d.ts +60 -25
  3. package/lib/generated/apis/AccountsApi.js +45 -10
  4. package/lib/generated/apis/AccountsApi.js.map +1 -1
  5. package/lib/generated/apis/BlocksApi.d.ts +38 -38
  6. package/lib/generated/apis/BlocksApi.js +20 -20
  7. package/lib/generated/apis/FaucetsApi.d.ts +10 -10
  8. package/lib/generated/apis/FaucetsApi.js +6 -6
  9. package/lib/generated/apis/FeesApi.d.ts +34 -6
  10. package/lib/generated/apis/FeesApi.js +33 -4
  11. package/lib/generated/apis/FeesApi.js.map +1 -1
  12. package/lib/generated/apis/FungibleTokensApi.d.ts +82 -0
  13. package/lib/generated/apis/FungibleTokensApi.js +80 -0
  14. package/lib/generated/apis/FungibleTokensApi.js.map +1 -0
  15. package/lib/generated/apis/InfoApi.d.ts +42 -24
  16. package/lib/generated/apis/InfoApi.js +22 -10
  17. package/lib/generated/apis/InfoApi.js.map +1 -1
  18. package/lib/generated/apis/MicroblocksApi.d.ts +14 -11
  19. package/lib/generated/apis/MicroblocksApi.js +8 -6
  20. package/lib/generated/apis/MicroblocksApi.js.map +1 -1
  21. package/lib/generated/apis/{BNSApi.d.ts → NamesApi.d.ts} +66 -63
  22. package/lib/generated/apis/{BNSApi.js → NamesApi.js} +30 -28
  23. package/lib/generated/apis/NamesApi.js.map +1 -0
  24. package/lib/generated/apis/NonFungibleTokensApi.d.ts +82 -0
  25. package/lib/generated/apis/NonFungibleTokensApi.js +80 -0
  26. package/lib/generated/apis/NonFungibleTokensApi.js.map +1 -0
  27. package/lib/generated/apis/RosettaApi.d.ts +42 -42
  28. package/lib/generated/apis/RosettaApi.js +22 -22
  29. package/lib/generated/apis/SearchApi.d.ts +4 -2
  30. package/lib/generated/apis/SearchApi.js +5 -2
  31. package/lib/generated/apis/SearchApi.js.map +1 -1
  32. package/lib/generated/apis/SmartContractsApi.d.ts +54 -23
  33. package/lib/generated/apis/SmartContractsApi.js +47 -12
  34. package/lib/generated/apis/SmartContractsApi.js.map +1 -1
  35. package/lib/generated/apis/{BurnchainApi.d.ts → StackingRewardsApi.d.ts} +31 -31
  36. package/lib/generated/apis/{BurnchainApi.js → StackingRewardsApi.js} +16 -16
  37. package/lib/generated/apis/StackingRewardsApi.js.map +1 -0
  38. package/lib/generated/apis/TransactionsApi.d.ts +87 -46
  39. package/lib/generated/apis/TransactionsApi.js +62 -24
  40. package/lib/generated/apis/TransactionsApi.js.map +1 -1
  41. package/lib/generated/apis/index.d.ts +4 -4
  42. package/lib/generated/apis/index.js +4 -4
  43. package/lib/generated/apis/index.js.map +1 -1
  44. package/lib/generated/models/AccountDataResponse.d.ts +2 -2
  45. package/lib/generated/models/AccountDataResponse.js +2 -2
  46. package/lib/generated/models/AddressAssetsListResponse.d.ts +2 -2
  47. package/lib/generated/models/AddressAssetsListResponse.js +2 -2
  48. package/lib/generated/models/AddressBalanceResponse.d.ts +2 -2
  49. package/lib/generated/models/AddressBalanceResponse.js +2 -2
  50. package/lib/generated/models/AddressBalanceResponseStx.d.ts +2 -2
  51. package/lib/generated/models/AddressBalanceResponseStx.js +2 -2
  52. package/lib/generated/models/AddressNftListResponse.d.ts +2 -2
  53. package/lib/generated/models/AddressNftListResponse.js +2 -2
  54. package/lib/generated/models/AddressNftListResponseValue.d.ts +2 -2
  55. package/lib/generated/models/AddressNftListResponseValue.js +2 -2
  56. package/lib/generated/models/AddressNonces.d.ts +2 -2
  57. package/lib/generated/models/AddressNonces.js +2 -2
  58. package/lib/generated/models/AddressStxInboundListResponse.d.ts +2 -2
  59. package/lib/generated/models/AddressStxInboundListResponse.js +2 -2
  60. package/lib/generated/models/AddressTokenOfferingLocked.d.ts +2 -2
  61. package/lib/generated/models/AddressTokenOfferingLocked.js +2 -2
  62. package/lib/generated/models/AddressTransactionWithTransfers.d.ts +2 -2
  63. package/lib/generated/models/AddressTransactionWithTransfers.js +2 -2
  64. package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.d.ts +2 -2
  65. package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.js +2 -2
  66. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.d.ts +6 -5
  67. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.js +5 -4
  68. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.js.map +1 -1
  69. package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.d.ts +2 -2
  70. package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.js +2 -2
  71. package/lib/generated/models/AddressTransactionWithTransfersValue.d.ts +33 -0
  72. package/lib/generated/models/AddressTransactionWithTransfersValue.js +44 -0
  73. package/lib/generated/models/AddressTransactionWithTransfersValue.js.map +1 -0
  74. package/lib/generated/models/AddressTransactionsListResponse.d.ts +2 -2
  75. package/lib/generated/models/AddressTransactionsListResponse.js +2 -2
  76. package/lib/generated/models/AddressTransactionsWithTransfersListResponse.d.ts +2 -2
  77. package/lib/generated/models/AddressTransactionsWithTransfersListResponse.js +2 -2
  78. package/lib/generated/models/AddressUnlockSchedule.d.ts +2 -2
  79. package/lib/generated/models/AddressUnlockSchedule.js +2 -2
  80. package/lib/generated/models/Block.d.ts +2 -2
  81. package/lib/generated/models/Block.js +2 -2
  82. package/lib/generated/models/BlockListResponse.d.ts +2 -2
  83. package/lib/generated/models/BlockListResponse.js +2 -2
  84. package/lib/generated/models/BnsError.d.ts +2 -2
  85. package/lib/generated/models/BnsError.js +2 -2
  86. package/lib/generated/models/BnsGetAllNamespacesResponse.d.ts +2 -2
  87. package/lib/generated/models/BnsGetAllNamespacesResponse.js +2 -2
  88. package/lib/generated/models/BnsGetNameInfoResponse.d.ts +2 -2
  89. package/lib/generated/models/BnsGetNameInfoResponse.js +2 -2
  90. package/lib/generated/models/BnsGetNamePriceResponse.d.ts +2 -2
  91. package/lib/generated/models/BnsGetNamePriceResponse.js +2 -2
  92. package/lib/generated/models/BnsGetNamespacePriceResponse.d.ts +2 -2
  93. package/lib/generated/models/BnsGetNamespacePriceResponse.js +2 -2
  94. package/lib/generated/models/BnsNamesOwnByAddressResponse.d.ts +2 -2
  95. package/lib/generated/models/BnsNamesOwnByAddressResponse.js +2 -2
  96. package/lib/generated/models/BurnchainReward.d.ts +2 -2
  97. package/lib/generated/models/BurnchainReward.js +2 -2
  98. package/lib/generated/models/BurnchainRewardListResponse.d.ts +2 -2
  99. package/lib/generated/models/BurnchainRewardListResponse.js +2 -2
  100. package/lib/generated/models/BurnchainRewardSlotHolder.d.ts +2 -2
  101. package/lib/generated/models/BurnchainRewardSlotHolder.js +2 -2
  102. package/lib/generated/models/BurnchainRewardSlotHolderListResponse.d.ts +2 -2
  103. package/lib/generated/models/BurnchainRewardSlotHolderListResponse.js +2 -2
  104. package/lib/generated/models/BurnchainRewardsTotal.d.ts +2 -2
  105. package/lib/generated/models/BurnchainRewardsTotal.js +2 -2
  106. package/lib/generated/models/ContractInterfaceResponse.d.ts +2 -2
  107. package/lib/generated/models/ContractInterfaceResponse.js +2 -2
  108. package/lib/generated/models/ContractListResponse.d.ts +40 -0
  109. package/lib/generated/models/ContractListResponse.js +47 -0
  110. package/lib/generated/models/ContractListResponse.js.map +1 -0
  111. package/lib/generated/models/ContractSourceResponse.d.ts +2 -2
  112. package/lib/generated/models/ContractSourceResponse.js +2 -2
  113. package/lib/generated/models/CoreNodeInfoResponse.d.ts +2 -2
  114. package/lib/generated/models/CoreNodeInfoResponse.js +2 -2
  115. package/lib/generated/models/CoreNodePoxResponse.d.ts +2 -2
  116. package/lib/generated/models/CoreNodePoxResponse.js +2 -2
  117. package/lib/generated/models/FeeRate.d.ts +2 -2
  118. package/lib/generated/models/FeeRate.js +2 -2
  119. package/lib/generated/models/FeeRateRequest.d.ts +2 -2
  120. package/lib/generated/models/FeeRateRequest.js +2 -2
  121. package/lib/generated/models/FungibleTokenMetadata.d.ts +2 -2
  122. package/lib/generated/models/FungibleTokenMetadata.js +2 -2
  123. package/lib/generated/models/FungibleTokensMetadataList.d.ts +2 -2
  124. package/lib/generated/models/FungibleTokensMetadataList.js +2 -2
  125. package/lib/generated/models/GetRawTransactionResult.d.ts +2 -2
  126. package/lib/generated/models/GetRawTransactionResult.js +2 -2
  127. package/lib/generated/models/GetStxSupplyLegacyFormatResponse.d.ts +2 -2
  128. package/lib/generated/models/GetStxSupplyLegacyFormatResponse.js +2 -2
  129. package/lib/generated/models/GetStxSupplyResponse.d.ts +2 -2
  130. package/lib/generated/models/GetStxSupplyResponse.js +2 -2
  131. package/lib/generated/models/InboundStxTransfer.d.ts +2 -2
  132. package/lib/generated/models/InboundStxTransfer.js +2 -2
  133. package/lib/generated/models/InlineResponse200.d.ts +2 -2
  134. package/lib/generated/models/InlineResponse200.js +2 -2
  135. package/lib/generated/models/MapEntryResponse.d.ts +2 -2
  136. package/lib/generated/models/MapEntryResponse.js +2 -2
  137. package/lib/generated/models/MempoolTransactionListResponse.d.ts +2 -2
  138. package/lib/generated/models/MempoolTransactionListResponse.js +2 -2
  139. package/lib/generated/models/Microblock.d.ts +2 -2
  140. package/lib/generated/models/Microblock.js +2 -2
  141. package/lib/generated/models/MicroblockListResponse.d.ts +2 -2
  142. package/lib/generated/models/MicroblockListResponse.js +2 -2
  143. package/lib/generated/models/NetworkBlockTimeResponse.d.ts +2 -2
  144. package/lib/generated/models/NetworkBlockTimeResponse.js +2 -2
  145. package/lib/generated/models/NetworkBlockTimesResponse.d.ts +2 -2
  146. package/lib/generated/models/NetworkBlockTimesResponse.js +2 -2
  147. package/lib/generated/models/NetworkBlockTimesResponseMainnet.d.ts +2 -2
  148. package/lib/generated/models/NetworkBlockTimesResponseMainnet.js +2 -2
  149. package/lib/generated/models/NetworkIdentifier.d.ts +2 -2
  150. package/lib/generated/models/NetworkIdentifier.js +2 -2
  151. package/lib/generated/models/NftEvent.d.ts +2 -2
  152. package/lib/generated/models/NftEvent.js +2 -2
  153. package/lib/generated/models/NonFungibleTokenMetadata.d.ts +2 -2
  154. package/lib/generated/models/NonFungibleTokenMetadata.js +2 -2
  155. package/lib/generated/models/NonFungibleTokensMetadataList.d.ts +2 -2
  156. package/lib/generated/models/NonFungibleTokensMetadataList.js +2 -2
  157. package/lib/generated/models/OtherTransactionIdentifier.d.ts +2 -2
  158. package/lib/generated/models/OtherTransactionIdentifier.js +2 -2
  159. package/lib/generated/models/PostCoreNodeTransactionsError.d.ts +2 -2
  160. package/lib/generated/models/PostCoreNodeTransactionsError.js +2 -2
  161. package/lib/generated/models/ReadOnlyFunctionArgs.d.ts +2 -2
  162. package/lib/generated/models/ReadOnlyFunctionArgs.js +2 -2
  163. package/lib/generated/models/ReadOnlyFunctionSuccessResponse.d.ts +2 -2
  164. package/lib/generated/models/ReadOnlyFunctionSuccessResponse.js +2 -2
  165. package/lib/generated/models/RosettaAccount.d.ts +2 -2
  166. package/lib/generated/models/RosettaAccount.js +2 -2
  167. package/lib/generated/models/RosettaAccountBalanceRequest.d.ts +2 -2
  168. package/lib/generated/models/RosettaAccountBalanceRequest.js +2 -2
  169. package/lib/generated/models/RosettaAccountBalanceResponse.d.ts +2 -2
  170. package/lib/generated/models/RosettaAccountBalanceResponse.js +2 -2
  171. package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.d.ts +2 -2
  172. package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.js +2 -2
  173. package/lib/generated/models/RosettaAccountBalanceResponseMetadata.d.ts +2 -2
  174. package/lib/generated/models/RosettaAccountBalanceResponseMetadata.js +2 -2
  175. package/lib/generated/models/RosettaAccountIdentifier.d.ts +2 -2
  176. package/lib/generated/models/RosettaAccountIdentifier.js +2 -2
  177. package/lib/generated/models/RosettaAmount.d.ts +2 -2
  178. package/lib/generated/models/RosettaAmount.js +2 -2
  179. package/lib/generated/models/RosettaBlock.d.ts +2 -2
  180. package/lib/generated/models/RosettaBlock.js +2 -2
  181. package/lib/generated/models/RosettaBlockMetadata.d.ts +2 -2
  182. package/lib/generated/models/RosettaBlockMetadata.js +2 -2
  183. package/lib/generated/models/RosettaBlockMetadata1.d.ts +2 -2
  184. package/lib/generated/models/RosettaBlockMetadata1.js +2 -2
  185. package/lib/generated/models/RosettaBlockRequest.d.ts +2 -2
  186. package/lib/generated/models/RosettaBlockRequest.js +2 -2
  187. package/lib/generated/models/RosettaBlockResponse.d.ts +2 -2
  188. package/lib/generated/models/RosettaBlockResponse.js +2 -2
  189. package/lib/generated/models/RosettaBlockTransactionRequest.d.ts +2 -2
  190. package/lib/generated/models/RosettaBlockTransactionRequest.js +2 -2
  191. package/lib/generated/models/RosettaBlockTransactionResponse.d.ts +2 -2
  192. package/lib/generated/models/RosettaBlockTransactionResponse.js +2 -2
  193. package/lib/generated/models/RosettaCoin.d.ts +2 -2
  194. package/lib/generated/models/RosettaCoin.js +2 -2
  195. package/lib/generated/models/RosettaCoinChange.d.ts +2 -2
  196. package/lib/generated/models/RosettaCoinChange.js +2 -2
  197. package/lib/generated/models/RosettaConstructionCombineRequest.d.ts +2 -2
  198. package/lib/generated/models/RosettaConstructionCombineRequest.js +2 -2
  199. package/lib/generated/models/RosettaConstructionCombineResponse.d.ts +2 -2
  200. package/lib/generated/models/RosettaConstructionCombineResponse.js +2 -2
  201. package/lib/generated/models/RosettaConstructionDeriveRequest.d.ts +2 -2
  202. package/lib/generated/models/RosettaConstructionDeriveRequest.js +2 -2
  203. package/lib/generated/models/RosettaConstructionDeriveResponse.d.ts +2 -2
  204. package/lib/generated/models/RosettaConstructionDeriveResponse.js +2 -2
  205. package/lib/generated/models/RosettaConstructionHashRequest.d.ts +2 -2
  206. package/lib/generated/models/RosettaConstructionHashRequest.js +2 -2
  207. package/lib/generated/models/RosettaConstructionHashResponse.d.ts +2 -2
  208. package/lib/generated/models/RosettaConstructionHashResponse.js +2 -2
  209. package/lib/generated/models/RosettaConstructionMetadataRequest.d.ts +2 -2
  210. package/lib/generated/models/RosettaConstructionMetadataRequest.js +2 -2
  211. package/lib/generated/models/RosettaConstructionMetadataResponse.d.ts +2 -2
  212. package/lib/generated/models/RosettaConstructionMetadataResponse.js +2 -2
  213. package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.d.ts +2 -2
  214. package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.js +2 -2
  215. package/lib/generated/models/RosettaConstructionParseRequest.d.ts +2 -2
  216. package/lib/generated/models/RosettaConstructionParseRequest.js +2 -2
  217. package/lib/generated/models/RosettaConstructionParseResponse.d.ts +2 -2
  218. package/lib/generated/models/RosettaConstructionParseResponse.js +2 -2
  219. package/lib/generated/models/RosettaConstructionPayloadResponse.d.ts +2 -2
  220. package/lib/generated/models/RosettaConstructionPayloadResponse.js +2 -2
  221. package/lib/generated/models/RosettaConstructionPayloadsRequest.d.ts +2 -2
  222. package/lib/generated/models/RosettaConstructionPayloadsRequest.js +2 -2
  223. package/lib/generated/models/RosettaConstructionPreprocessRequest.d.ts +2 -2
  224. package/lib/generated/models/RosettaConstructionPreprocessRequest.js +2 -2
  225. package/lib/generated/models/RosettaConstructionPreprocessResponse.d.ts +2 -2
  226. package/lib/generated/models/RosettaConstructionPreprocessResponse.js +2 -2
  227. package/lib/generated/models/RosettaConstructionSubmitRequest.d.ts +2 -2
  228. package/lib/generated/models/RosettaConstructionSubmitRequest.js +2 -2
  229. package/lib/generated/models/RosettaConstructionSubmitResponse.d.ts +2 -2
  230. package/lib/generated/models/RosettaConstructionSubmitResponse.js +2 -2
  231. package/lib/generated/models/RosettaCurrency.d.ts +2 -2
  232. package/lib/generated/models/RosettaCurrency.js +2 -2
  233. package/lib/generated/models/RosettaError.d.ts +2 -2
  234. package/lib/generated/models/RosettaError.js +2 -2
  235. package/lib/generated/models/RosettaErrorDetails.d.ts +2 -2
  236. package/lib/generated/models/RosettaErrorDetails.js +2 -2
  237. package/lib/generated/models/RosettaErrorNoDetails.d.ts +2 -2
  238. package/lib/generated/models/RosettaErrorNoDetails.js +2 -2
  239. package/lib/generated/models/RosettaMaxFeeAmount.d.ts +2 -2
  240. package/lib/generated/models/RosettaMaxFeeAmount.js +2 -2
  241. package/lib/generated/models/RosettaMempoolRequest.d.ts +2 -2
  242. package/lib/generated/models/RosettaMempoolRequest.js +2 -2
  243. package/lib/generated/models/RosettaMempoolResponse.d.ts +2 -2
  244. package/lib/generated/models/RosettaMempoolResponse.js +2 -2
  245. package/lib/generated/models/RosettaMempoolTransactionRequest.d.ts +2 -2
  246. package/lib/generated/models/RosettaMempoolTransactionRequest.js +2 -2
  247. package/lib/generated/models/RosettaMempoolTransactionResponse.d.ts +2 -2
  248. package/lib/generated/models/RosettaMempoolTransactionResponse.js +2 -2
  249. package/lib/generated/models/RosettaNetworkListResponse.d.ts +2 -2
  250. package/lib/generated/models/RosettaNetworkListResponse.js +2 -2
  251. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.d.ts +2 -2
  252. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.js +2 -2
  253. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.d.ts +2 -2
  254. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.js +2 -2
  255. package/lib/generated/models/RosettaNetworkOptionsResponse.d.ts +2 -2
  256. package/lib/generated/models/RosettaNetworkOptionsResponse.js +2 -2
  257. package/lib/generated/models/RosettaNetworkOptionsResponseAllow.d.ts +2 -2
  258. package/lib/generated/models/RosettaNetworkOptionsResponseAllow.js +2 -2
  259. package/lib/generated/models/RosettaNetworkOptionsResponseVersion.d.ts +2 -2
  260. package/lib/generated/models/RosettaNetworkOptionsResponseVersion.js +2 -2
  261. package/lib/generated/models/RosettaOperation.d.ts +2 -2
  262. package/lib/generated/models/RosettaOperation.js +2 -2
  263. package/lib/generated/models/RosettaOperationIdentifier.d.ts +2 -2
  264. package/lib/generated/models/RosettaOperationIdentifier.js +2 -2
  265. package/lib/generated/models/RosettaOperationStatus.d.ts +2 -2
  266. package/lib/generated/models/RosettaOperationStatus.js +2 -2
  267. package/lib/generated/models/RosettaOptions.d.ts +2 -2
  268. package/lib/generated/models/RosettaOptions.js +2 -2
  269. package/lib/generated/models/RosettaOptionsRequest.d.ts +2 -2
  270. package/lib/generated/models/RosettaOptionsRequest.js +2 -2
  271. package/lib/generated/models/RosettaParentBlockIdentifier.d.ts +2 -2
  272. package/lib/generated/models/RosettaParentBlockIdentifier.js +2 -2
  273. package/lib/generated/models/RosettaPublicKey.d.ts +2 -2
  274. package/lib/generated/models/RosettaPublicKey.js +2 -2
  275. package/lib/generated/models/RosettaRelatedOperation.d.ts +2 -2
  276. package/lib/generated/models/RosettaRelatedOperation.js +2 -2
  277. package/lib/generated/models/RosettaSignature.d.ts +2 -2
  278. package/lib/generated/models/RosettaSignature.js +2 -2
  279. package/lib/generated/models/RosettaStatusRequest.d.ts +2 -2
  280. package/lib/generated/models/RosettaStatusRequest.js +2 -2
  281. package/lib/generated/models/RosettaSubAccount.d.ts +2 -2
  282. package/lib/generated/models/RosettaSubAccount.js +2 -2
  283. package/lib/generated/models/RosettaTransaction.d.ts +2 -2
  284. package/lib/generated/models/RosettaTransaction.js +2 -2
  285. package/lib/generated/models/RunFaucetResponse.d.ts +2 -2
  286. package/lib/generated/models/RunFaucetResponse.js +2 -2
  287. package/lib/generated/models/ServerStatusResponse.d.ts +2 -2
  288. package/lib/generated/models/ServerStatusResponse.js +2 -2
  289. package/lib/generated/models/SigningPayload.d.ts +2 -2
  290. package/lib/generated/models/SigningPayload.js +2 -2
  291. package/lib/generated/models/SmartContract.d.ts +51 -0
  292. package/lib/generated/models/SmartContract.js +50 -0
  293. package/lib/generated/models/SmartContract.js.map +1 -0
  294. package/lib/generated/models/TransactionIdentifier.d.ts +2 -2
  295. package/lib/generated/models/TransactionIdentifier.js +2 -2
  296. package/lib/generated/models/TransactionResults.d.ts +2 -2
  297. package/lib/generated/models/TransactionResults.js +2 -2
  298. package/lib/generated/models/UnanchoredTransactionListResponse.d.ts +2 -2
  299. package/lib/generated/models/UnanchoredTransactionListResponse.js +2 -2
  300. package/lib/generated/models/index.d.ts +3 -0
  301. package/lib/generated/models/index.js +3 -0
  302. package/lib/generated/models/index.js.map +1 -1
  303. package/lib/generated/runtime.d.ts +2 -2
  304. package/lib/generated/runtime.js +2 -2
  305. package/lib/index.umd.js +1393 -976
  306. package/lib/index.umd.js.map +1 -1
  307. package/lib/socket-io/index.d.ts +4 -0
  308. package/lib/socket-io/index.js +6 -1
  309. package/lib/socket-io/index.js.map +1 -1
  310. package/lib/ws/index.d.ts +7 -1
  311. package/lib/ws/index.js +51 -0
  312. package/lib/ws/index.js.map +1 -1
  313. package/package.json +5 -5
  314. package/src/generated/.openapi-generator/FILES +7 -4
  315. package/src/generated/apis/AccountsApi.ts +88 -25
  316. package/src/generated/apis/BlocksApi.ts +38 -38
  317. package/src/generated/apis/FaucetsApi.ts +10 -10
  318. package/src/generated/apis/FeesApi.ts +69 -6
  319. package/src/generated/apis/FungibleTokensApi.ts +150 -0
  320. package/src/generated/apis/InfoApi.ts +42 -24
  321. package/src/generated/apis/MicroblocksApi.ts +14 -11
  322. package/src/generated/apis/{BNSApi.ts → NamesApi.ts} +66 -63
  323. package/src/generated/apis/NonFungibleTokensApi.ts +150 -0
  324. package/src/generated/apis/RosettaApi.ts +42 -42
  325. package/src/generated/apis/SearchApi.ts +8 -2
  326. package/src/generated/apis/SmartContractsApi.ts +93 -22
  327. package/src/generated/apis/{BurnchainApi.ts → StackingRewardsApi.ts} +31 -31
  328. package/src/generated/apis/TransactionsApi.ts +120 -46
  329. package/src/generated/apis/index.ts +4 -4
  330. package/src/generated/models/AccountDataResponse.ts +2 -2
  331. package/src/generated/models/AddressAssetsListResponse.ts +2 -2
  332. package/src/generated/models/AddressBalanceResponse.ts +2 -2
  333. package/src/generated/models/AddressBalanceResponseStx.ts +2 -2
  334. package/src/generated/models/AddressNftListResponse.ts +2 -2
  335. package/src/generated/models/AddressNftListResponseValue.ts +2 -2
  336. package/src/generated/models/AddressNonces.ts +2 -2
  337. package/src/generated/models/AddressStxInboundListResponse.ts +2 -2
  338. package/src/generated/models/AddressTokenOfferingLocked.ts +2 -2
  339. package/src/generated/models/AddressTransactionWithTransfers.ts +2 -2
  340. package/src/generated/models/AddressTransactionWithTransfersFtTransfers.ts +2 -2
  341. package/src/generated/models/AddressTransactionWithTransfersNftTransfers.ts +14 -7
  342. package/src/generated/models/AddressTransactionWithTransfersStxTransfers.ts +2 -2
  343. package/src/generated/models/AddressTransactionWithTransfersValue.ts +64 -0
  344. package/src/generated/models/AddressTransactionsListResponse.ts +2 -2
  345. package/src/generated/models/AddressTransactionsWithTransfersListResponse.ts +2 -2
  346. package/src/generated/models/AddressUnlockSchedule.ts +2 -2
  347. package/src/generated/models/Block.ts +2 -2
  348. package/src/generated/models/BlockListResponse.ts +2 -2
  349. package/src/generated/models/BnsError.ts +2 -2
  350. package/src/generated/models/BnsGetAllNamespacesResponse.ts +2 -2
  351. package/src/generated/models/BnsGetNameInfoResponse.ts +2 -2
  352. package/src/generated/models/BnsGetNamePriceResponse.ts +2 -2
  353. package/src/generated/models/BnsGetNamespacePriceResponse.ts +2 -2
  354. package/src/generated/models/BnsNamesOwnByAddressResponse.ts +2 -2
  355. package/src/generated/models/BurnchainReward.ts +2 -2
  356. package/src/generated/models/BurnchainRewardListResponse.ts +2 -2
  357. package/src/generated/models/BurnchainRewardSlotHolder.ts +2 -2
  358. package/src/generated/models/BurnchainRewardSlotHolderListResponse.ts +2 -2
  359. package/src/generated/models/BurnchainRewardsTotal.ts +2 -2
  360. package/src/generated/models/ContractInterfaceResponse.ts +2 -2
  361. package/src/generated/models/ContractListResponse.ts +79 -0
  362. package/src/generated/models/ContractSourceResponse.ts +2 -2
  363. package/src/generated/models/CoreNodeInfoResponse.ts +2 -2
  364. package/src/generated/models/CoreNodePoxResponse.ts +2 -2
  365. package/src/generated/models/FeeRate.ts +2 -2
  366. package/src/generated/models/FeeRateRequest.ts +2 -2
  367. package/src/generated/models/FungibleTokenMetadata.ts +2 -2
  368. package/src/generated/models/FungibleTokensMetadataList.ts +2 -2
  369. package/src/generated/models/GetRawTransactionResult.ts +2 -2
  370. package/src/generated/models/GetStxSupplyLegacyFormatResponse.ts +2 -2
  371. package/src/generated/models/GetStxSupplyResponse.ts +2 -2
  372. package/src/generated/models/InboundStxTransfer.ts +2 -2
  373. package/src/generated/models/InlineResponse200.ts +2 -2
  374. package/src/generated/models/MapEntryResponse.ts +2 -2
  375. package/src/generated/models/MempoolTransactionListResponse.ts +2 -2
  376. package/src/generated/models/Microblock.ts +2 -2
  377. package/src/generated/models/MicroblockListResponse.ts +2 -2
  378. package/src/generated/models/NetworkBlockTimeResponse.ts +2 -2
  379. package/src/generated/models/NetworkBlockTimesResponse.ts +2 -2
  380. package/src/generated/models/NetworkBlockTimesResponseMainnet.ts +2 -2
  381. package/src/generated/models/NetworkIdentifier.ts +2 -2
  382. package/src/generated/models/NftEvent.ts +2 -2
  383. package/src/generated/models/NonFungibleTokenMetadata.ts +2 -2
  384. package/src/generated/models/NonFungibleTokensMetadataList.ts +2 -2
  385. package/src/generated/models/OtherTransactionIdentifier.ts +2 -2
  386. package/src/generated/models/PostCoreNodeTransactionsError.ts +2 -2
  387. package/src/generated/models/ReadOnlyFunctionArgs.ts +2 -2
  388. package/src/generated/models/ReadOnlyFunctionSuccessResponse.ts +2 -2
  389. package/src/generated/models/RosettaAccount.ts +2 -2
  390. package/src/generated/models/RosettaAccountBalanceRequest.ts +2 -2
  391. package/src/generated/models/RosettaAccountBalanceResponse.ts +2 -2
  392. package/src/generated/models/RosettaAccountBalanceResponseCoinIdentifier.ts +2 -2
  393. package/src/generated/models/RosettaAccountBalanceResponseMetadata.ts +2 -2
  394. package/src/generated/models/RosettaAccountIdentifier.ts +2 -2
  395. package/src/generated/models/RosettaAmount.ts +2 -2
  396. package/src/generated/models/RosettaBlock.ts +2 -2
  397. package/src/generated/models/RosettaBlockMetadata.ts +2 -2
  398. package/src/generated/models/RosettaBlockMetadata1.ts +2 -2
  399. package/src/generated/models/RosettaBlockRequest.ts +2 -2
  400. package/src/generated/models/RosettaBlockResponse.ts +2 -2
  401. package/src/generated/models/RosettaBlockTransactionRequest.ts +2 -2
  402. package/src/generated/models/RosettaBlockTransactionResponse.ts +2 -2
  403. package/src/generated/models/RosettaCoin.ts +2 -2
  404. package/src/generated/models/RosettaCoinChange.ts +2 -2
  405. package/src/generated/models/RosettaConstructionCombineRequest.ts +2 -2
  406. package/src/generated/models/RosettaConstructionCombineResponse.ts +2 -2
  407. package/src/generated/models/RosettaConstructionDeriveRequest.ts +2 -2
  408. package/src/generated/models/RosettaConstructionDeriveResponse.ts +2 -2
  409. package/src/generated/models/RosettaConstructionHashRequest.ts +2 -2
  410. package/src/generated/models/RosettaConstructionHashResponse.ts +2 -2
  411. package/src/generated/models/RosettaConstructionMetadataRequest.ts +2 -2
  412. package/src/generated/models/RosettaConstructionMetadataResponse.ts +2 -2
  413. package/src/generated/models/RosettaConstructionMetadataResponseMetadata.ts +2 -2
  414. package/src/generated/models/RosettaConstructionParseRequest.ts +2 -2
  415. package/src/generated/models/RosettaConstructionParseResponse.ts +2 -2
  416. package/src/generated/models/RosettaConstructionPayloadResponse.ts +2 -2
  417. package/src/generated/models/RosettaConstructionPayloadsRequest.ts +2 -2
  418. package/src/generated/models/RosettaConstructionPreprocessRequest.ts +2 -2
  419. package/src/generated/models/RosettaConstructionPreprocessResponse.ts +2 -2
  420. package/src/generated/models/RosettaConstructionSubmitRequest.ts +2 -2
  421. package/src/generated/models/RosettaConstructionSubmitResponse.ts +2 -2
  422. package/src/generated/models/RosettaCurrency.ts +2 -2
  423. package/src/generated/models/RosettaError.ts +2 -2
  424. package/src/generated/models/RosettaErrorDetails.ts +2 -2
  425. package/src/generated/models/RosettaErrorNoDetails.ts +2 -2
  426. package/src/generated/models/RosettaMaxFeeAmount.ts +2 -2
  427. package/src/generated/models/RosettaMempoolRequest.ts +2 -2
  428. package/src/generated/models/RosettaMempoolResponse.ts +2 -2
  429. package/src/generated/models/RosettaMempoolTransactionRequest.ts +2 -2
  430. package/src/generated/models/RosettaMempoolTransactionResponse.ts +2 -2
  431. package/src/generated/models/RosettaNetworkListResponse.ts +2 -2
  432. package/src/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.ts +2 -2
  433. package/src/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.ts +2 -2
  434. package/src/generated/models/RosettaNetworkOptionsResponse.ts +2 -2
  435. package/src/generated/models/RosettaNetworkOptionsResponseAllow.ts +2 -2
  436. package/src/generated/models/RosettaNetworkOptionsResponseVersion.ts +2 -2
  437. package/src/generated/models/RosettaOperation.ts +2 -2
  438. package/src/generated/models/RosettaOperationIdentifier.ts +2 -2
  439. package/src/generated/models/RosettaOperationStatus.ts +2 -2
  440. package/src/generated/models/RosettaOptions.ts +2 -2
  441. package/src/generated/models/RosettaOptionsRequest.ts +2 -2
  442. package/src/generated/models/RosettaParentBlockIdentifier.ts +2 -2
  443. package/src/generated/models/RosettaPublicKey.ts +2 -2
  444. package/src/generated/models/RosettaRelatedOperation.ts +2 -2
  445. package/src/generated/models/RosettaSignature.ts +2 -2
  446. package/src/generated/models/RosettaStatusRequest.ts +2 -2
  447. package/src/generated/models/RosettaSubAccount.ts +2 -2
  448. package/src/generated/models/RosettaTransaction.ts +2 -2
  449. package/src/generated/models/RunFaucetResponse.ts +2 -2
  450. package/src/generated/models/ServerStatusResponse.ts +2 -2
  451. package/src/generated/models/SigningPayload.ts +2 -2
  452. package/src/generated/models/SmartContract.ts +88 -0
  453. package/src/generated/models/TransactionIdentifier.ts +2 -2
  454. package/src/generated/models/TransactionResults.ts +2 -2
  455. package/src/generated/models/UnanchoredTransactionListResponse.ts +2 -2
  456. package/src/generated/models/index.ts +3 -0
  457. package/src/generated/runtime.ts +2 -2
  458. package/src/socket-io/index.ts +8 -1
  459. package/src/ws/index.ts +63 -0
  460. package/lib/generated/apis/BNSApi.js.map +0 -1
  461. package/lib/generated/apis/BurnchainApi.js.map +0 -1
  462. package/lib/generated/apis/FeeRateApi.d.ts +0 -53
  463. package/lib/generated/apis/FeeRateApi.js +0 -53
  464. package/lib/generated/apis/FeeRateApi.js.map +0 -1
  465. package/lib/generated/apis/TokensApi.d.ts +0 -138
  466. package/lib/generated/apis/TokensApi.js +0 -135
  467. package/lib/generated/apis/TokensApi.js.map +0 -1
  468. package/src/generated/apis/FeeRateApi.ts +0 -95
  469. package/src/generated/apis/TokensApi.ts +0 -266
@@ -1,8 +1,8 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Stacks 2.0 Blockchain API
5
- * This is the documentation for the Stacks 2.0 Blockchain API. It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API. <a href=\"collection.json\" download=\"collection.json\">Download Postman collection</a>
4
+ * Stacks Blockchain API
5
+ * 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
6
6
  *
7
7
  * The version of the OpenAPI document: STACKS_API_VERSION
8
8
  *
@@ -52,8 +52,8 @@ export interface GetBlockListRequest {
52
52
  */
53
53
  export interface BlocksApiInterface {
54
54
  /**
55
- * Get a specific block by burnchain block hash
56
- * @summary Get block
55
+ * Retrieves block details of a specific block for a given burnchain block hash
56
+ * @summary Get block by burnchain block hash
57
57
  * @param {string} burnBlockHash Hash of the burnchain block
58
58
  * @param {*} [options] Override http request option.
59
59
  * @throws {RequiredError}
@@ -62,14 +62,14 @@ export interface BlocksApiInterface {
62
62
  getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
63
63
 
64
64
  /**
65
- * Get a specific block by burnchain block hash
66
- * Get block
65
+ * Retrieves block details of a specific block for a given burnchain block hash
66
+ * Get block by burnchain block hash
67
67
  */
68
68
  getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block>;
69
69
 
70
70
  /**
71
- * Get a specific block by burn chain height
72
- * @summary Get block
71
+ * Retrieves block details of a specific block for a given burn chain height
72
+ * @summary Get block by burnchain height
73
73
  * @param {number} burnBlockHeight Height of the burn chain block
74
74
  * @param {*} [options] Override http request option.
75
75
  * @throws {RequiredError}
@@ -78,14 +78,14 @@ export interface BlocksApiInterface {
78
78
  getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
79
79
 
80
80
  /**
81
- * Get a specific block by burn chain height
82
- * Get block
81
+ * Retrieves block details of a specific block for a given burn chain height
82
+ * Get block by burnchain height
83
83
  */
84
84
  getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block>;
85
85
 
86
86
  /**
87
- * Get a specific block by hash
88
- * @summary Get block
87
+ * Retrieves block details of a specific block for a given chain height
88
+ * @summary Get block by hash
89
89
  * @param {string} hash Hash of the block
90
90
  * @param {*} [options] Override http request option.
91
91
  * @throws {RequiredError}
@@ -94,14 +94,14 @@ export interface BlocksApiInterface {
94
94
  getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
95
95
 
96
96
  /**
97
- * Get a specific block by hash
98
- * Get block
97
+ * Retrieves block details of a specific block for a given chain height
98
+ * Get block by hash
99
99
  */
100
100
  getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block>;
101
101
 
102
102
  /**
103
- * Get a specific block by height
104
- * @summary Get block
103
+ * Retrieves block details of a specific block at a given block height
104
+ * @summary Get block by height
105
105
  * @param {number} height Height of the block
106
106
  * @param {*} [options] Override http request option.
107
107
  * @throws {RequiredError}
@@ -110,13 +110,13 @@ export interface BlocksApiInterface {
110
110
  getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
111
111
 
112
112
  /**
113
- * Get a specific block by height
114
- * Get block
113
+ * Retrieves block details of a specific block at a given block height
114
+ * Get block by height
115
115
  */
116
116
  getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block>;
117
117
 
118
118
  /**
119
- * Get all recently mined blocks
119
+ * Retrieves a list of recently mined blocks
120
120
  * @summary Get recent blocks
121
121
  * @param {number} [limit] max number of blocks to fetch
122
122
  * @param {number} [offset] index of first block to fetch
@@ -127,7 +127,7 @@ export interface BlocksApiInterface {
127
127
  getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BlockListResponse>>;
128
128
 
129
129
  /**
130
- * Get all recently mined blocks
130
+ * Retrieves a list of recently mined blocks
131
131
  * Get recent blocks
132
132
  */
133
133
  getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse>;
@@ -140,8 +140,8 @@ export interface BlocksApiInterface {
140
140
  export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
141
141
 
142
142
  /**
143
- * Get a specific block by burnchain block hash
144
- * Get block
143
+ * Retrieves block details of a specific block for a given burnchain block hash
144
+ * Get block by burnchain block hash
145
145
  */
146
146
  async getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
147
147
  if (requestParameters.burnBlockHash === null || requestParameters.burnBlockHash === undefined) {
@@ -163,8 +163,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
163
163
  }
164
164
 
165
165
  /**
166
- * Get a specific block by burnchain block hash
167
- * Get block
166
+ * Retrieves block details of a specific block for a given burnchain block hash
167
+ * Get block by burnchain block hash
168
168
  */
169
169
  async getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block> {
170
170
  const response = await this.getBlockByBurnBlockHashRaw(requestParameters, initOverrides);
@@ -172,8 +172,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
172
172
  }
173
173
 
174
174
  /**
175
- * Get a specific block by burn chain height
176
- * Get block
175
+ * Retrieves block details of a specific block for a given burn chain height
176
+ * Get block by burnchain height
177
177
  */
178
178
  async getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
179
179
  if (requestParameters.burnBlockHeight === null || requestParameters.burnBlockHeight === undefined) {
@@ -195,8 +195,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
195
195
  }
196
196
 
197
197
  /**
198
- * Get a specific block by burn chain height
199
- * Get block
198
+ * Retrieves block details of a specific block for a given burn chain height
199
+ * Get block by burnchain height
200
200
  */
201
201
  async getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block> {
202
202
  const response = await this.getBlockByBurnBlockHeightRaw(requestParameters, initOverrides);
@@ -204,8 +204,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
204
204
  }
205
205
 
206
206
  /**
207
- * Get a specific block by hash
208
- * Get block
207
+ * Retrieves block details of a specific block for a given chain height
208
+ * Get block by hash
209
209
  */
210
210
  async getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
211
211
  if (requestParameters.hash === null || requestParameters.hash === undefined) {
@@ -227,8 +227,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
227
227
  }
228
228
 
229
229
  /**
230
- * Get a specific block by hash
231
- * Get block
230
+ * Retrieves block details of a specific block for a given chain height
231
+ * Get block by hash
232
232
  */
233
233
  async getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block> {
234
234
  const response = await this.getBlockByHashRaw(requestParameters, initOverrides);
@@ -236,8 +236,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
236
236
  }
237
237
 
238
238
  /**
239
- * Get a specific block by height
240
- * Get block
239
+ * Retrieves block details of a specific block at a given block height
240
+ * Get block by height
241
241
  */
242
242
  async getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
243
243
  if (requestParameters.height === null || requestParameters.height === undefined) {
@@ -259,8 +259,8 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
259
259
  }
260
260
 
261
261
  /**
262
- * Get a specific block by height
263
- * Get block
262
+ * Retrieves block details of a specific block at a given block height
263
+ * Get block by height
264
264
  */
265
265
  async getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block> {
266
266
  const response = await this.getBlockByHeightRaw(requestParameters, initOverrides);
@@ -268,7 +268,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
268
268
  }
269
269
 
270
270
  /**
271
- * Get all recently mined blocks
271
+ * Retrieves a list of recently mined blocks
272
272
  * Get recent blocks
273
273
  */
274
274
  async getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BlockListResponse>> {
@@ -295,7 +295,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
295
295
  }
296
296
 
297
297
  /**
298
- * Get all recently mined blocks
298
+ * Retrieves a list of recently mined blocks
299
299
  * Get recent blocks
300
300
  */
301
301
  async getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse> {
@@ -1,8 +1,8 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Stacks 2.0 Blockchain API
5
- * This is the documentation for the Stacks 2.0 Blockchain API. It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API. <a href=\"collection.json\" download=\"collection.json\">Download Postman collection</a>
4
+ * Stacks Blockchain API
5
+ * 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
6
6
  *
7
7
  * The version of the OpenAPI document: STACKS_API_VERSION
8
8
  *
@@ -37,7 +37,7 @@ export interface RunFaucetStxRequest {
37
37
  */
38
38
  export interface FaucetsApiInterface {
39
39
  /**
40
- * Get BTC tokens for the testnet
40
+ * Retrieves BTC tokens into your TestNet BTC address.
41
41
  * @summary Get BTC tokens
42
42
  * @param {string} address BTC address
43
43
  * @param {*} [options] Override http request option.
@@ -47,13 +47,13 @@ export interface FaucetsApiInterface {
47
47
  runFaucetBtcRaw(requestParameters: RunFaucetBtcRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RunFaucetResponse>>;
48
48
 
49
49
  /**
50
- * Get BTC tokens for the testnet
50
+ * Retrieves BTC tokens into your TestNet BTC address.
51
51
  * Get BTC tokens
52
52
  */
53
53
  runFaucetBtc(requestParameters: RunFaucetBtcRequest, initOverrides?: RequestInit): Promise<RunFaucetResponse>;
54
54
 
55
55
  /**
56
- * Get STX tokens for the testnet
56
+ * Retrieves STX tokens into you TestNet STX address.
57
57
  * @summary Get STX tokens
58
58
  * @param {string} address STX address
59
59
  * @param {boolean} [stacking] Request the amount of STX needed for stacking
@@ -64,7 +64,7 @@ export interface FaucetsApiInterface {
64
64
  runFaucetStxRaw(requestParameters: RunFaucetStxRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RunFaucetResponse>>;
65
65
 
66
66
  /**
67
- * Get STX tokens for the testnet
67
+ * Retrieves STX tokens into you TestNet STX address.
68
68
  * Get STX tokens
69
69
  */
70
70
  runFaucetStx(requestParameters: RunFaucetStxRequest, initOverrides?: RequestInit): Promise<RunFaucetResponse>;
@@ -77,7 +77,7 @@ export interface FaucetsApiInterface {
77
77
  export class FaucetsApi extends runtime.BaseAPI implements FaucetsApiInterface {
78
78
 
79
79
  /**
80
- * Get BTC tokens for the testnet
80
+ * Retrieves BTC tokens into your TestNet BTC address.
81
81
  * Get BTC tokens
82
82
  */
83
83
  async runFaucetBtcRaw(requestParameters: RunFaucetBtcRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RunFaucetResponse>> {
@@ -104,7 +104,7 @@ export class FaucetsApi extends runtime.BaseAPI implements FaucetsApiInterface {
104
104
  }
105
105
 
106
106
  /**
107
- * Get BTC tokens for the testnet
107
+ * Retrieves BTC tokens into your TestNet BTC address.
108
108
  * Get BTC tokens
109
109
  */
110
110
  async runFaucetBtc(requestParameters: RunFaucetBtcRequest, initOverrides?: RequestInit): Promise<RunFaucetResponse> {
@@ -113,7 +113,7 @@ export class FaucetsApi extends runtime.BaseAPI implements FaucetsApiInterface {
113
113
  }
114
114
 
115
115
  /**
116
- * Get STX tokens for the testnet
116
+ * Retrieves STX tokens into you TestNet STX address.
117
117
  * Get STX tokens
118
118
  */
119
119
  async runFaucetStxRaw(requestParameters: RunFaucetStxRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RunFaucetResponse>> {
@@ -144,7 +144,7 @@ export class FaucetsApi extends runtime.BaseAPI implements FaucetsApiInterface {
144
144
  }
145
145
 
146
146
  /**
147
- * Get STX tokens for the testnet
147
+ * Retrieves STX tokens into you TestNet STX address.
148
148
  * Get STX tokens
149
149
  */
150
150
  async runFaucetStx(requestParameters: RunFaucetStxRequest, initOverrides?: RequestInit): Promise<RunFaucetResponse> {
@@ -1,8 +1,8 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Stacks 2.0 Blockchain API
5
- * This is the documentation for the Stacks 2.0 Blockchain API. It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API. <a href=\"collection.json\" download=\"collection.json\">Download Postman collection</a>
4
+ * Stacks Blockchain API
5
+ * 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
6
6
  *
7
7
  * The version of the OpenAPI document: STACKS_API_VERSION
8
8
  *
@@ -14,6 +14,18 @@
14
14
 
15
15
 
16
16
  import * as runtime from '../runtime';
17
+ import {
18
+ FeeRate,
19
+ FeeRateFromJSON,
20
+ FeeRateToJSON,
21
+ FeeRateRequest,
22
+ FeeRateRequestFromJSON,
23
+ FeeRateRequestToJSON,
24
+ } from '../models';
25
+
26
+ export interface FetchFeeRateRequest {
27
+ feeRateRequest: FeeRateRequest;
28
+ }
17
29
 
18
30
  /**
19
31
  * FeesApi - interface
@@ -23,7 +35,23 @@ import * as runtime from '../runtime';
23
35
  */
24
36
  export interface FeesApiInterface {
25
37
  /**
26
- * Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
38
+ * Retrieves estimated fee rate.
39
+ * @summary fetch fee rate
40
+ * @param {FeeRateRequest} feeRateRequest
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ * @memberof FeesApiInterface
44
+ */
45
+ fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>>;
46
+
47
+ /**
48
+ * Retrieves estimated fee rate.
49
+ * fetch fee rate
50
+ */
51
+ fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate>;
52
+
53
+ /**
54
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
27
55
  * @summary Get estimated fee
28
56
  * @param {*} [options] Override http request option.
29
57
  * @throws {RequiredError}
@@ -32,7 +60,7 @@ export interface FeesApiInterface {
32
60
  getFeeTransferRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
33
61
 
34
62
  /**
35
- * Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
63
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
36
64
  * Get estimated fee
37
65
  */
38
66
  getFeeTransfer(initOverrides?: RequestInit): Promise<object>;
@@ -45,7 +73,42 @@ export interface FeesApiInterface {
45
73
  export class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
46
74
 
47
75
  /**
48
- * Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
76
+ * Retrieves estimated fee rate.
77
+ * fetch fee rate
78
+ */
79
+ async fetchFeeRateRaw(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FeeRate>> {
80
+ if (requestParameters.feeRateRequest === null || requestParameters.feeRateRequest === undefined) {
81
+ throw new runtime.RequiredError('feeRateRequest','Required parameter requestParameters.feeRateRequest was null or undefined when calling fetchFeeRate.');
82
+ }
83
+
84
+ const queryParameters: any = {};
85
+
86
+ const headerParameters: runtime.HTTPHeaders = {};
87
+
88
+ headerParameters['Content-Type'] = 'application/json';
89
+
90
+ const response = await this.request({
91
+ path: `/extended/v1/fee_rate`,
92
+ method: 'POST',
93
+ headers: headerParameters,
94
+ query: queryParameters,
95
+ body: FeeRateRequestToJSON(requestParameters.feeRateRequest),
96
+ }, initOverrides);
97
+
98
+ return new runtime.JSONApiResponse(response, (jsonValue) => FeeRateFromJSON(jsonValue));
99
+ }
100
+
101
+ /**
102
+ * Retrieves estimated fee rate.
103
+ * fetch fee rate
104
+ */
105
+ async fetchFeeRate(requestParameters: FetchFeeRateRequest, initOverrides?: RequestInit): Promise<FeeRate> {
106
+ const response = await this.fetchFeeRateRaw(requestParameters, initOverrides);
107
+ return await response.value();
108
+ }
109
+
110
+ /**
111
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
49
112
  * Get estimated fee
50
113
  */
51
114
  async getFeeTransferRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
@@ -64,7 +127,7 @@ export class FeesApi extends runtime.BaseAPI implements FeesApiInterface {
64
127
  }
65
128
 
66
129
  /**
67
- * Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
130
+ * Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
68
131
  * Get estimated fee
69
132
  */
70
133
  async getFeeTransfer(initOverrides?: RequestInit): Promise<object> {
@@ -0,0 +1,150 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Stacks Blockchain API
5
+ * 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=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
6
+ *
7
+ * The version of the OpenAPI document: STACKS_API_VERSION
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import {
18
+ FungibleTokenMetadata,
19
+ FungibleTokenMetadataFromJSON,
20
+ FungibleTokenMetadataToJSON,
21
+ FungibleTokensMetadataList,
22
+ FungibleTokensMetadataListFromJSON,
23
+ FungibleTokensMetadataListToJSON,
24
+ } from '../models';
25
+
26
+ export interface GetContractFtMetadataRequest {
27
+ contractId: string;
28
+ }
29
+
30
+ export interface GetFtMetadataListRequest {
31
+ limit?: number;
32
+ offset?: number;
33
+ }
34
+
35
+ /**
36
+ * FungibleTokensApi - interface
37
+ *
38
+ * @export
39
+ * @interface FungibleTokensApiInterface
40
+ */
41
+ export interface FungibleTokensApiInterface {
42
+ /**
43
+ * Retrieves the metadata for fungible tokens for a given contract id
44
+ * @summary Fungible tokens metadata for contract id
45
+ * @param {string} contractId token\&#39;s contract id
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ * @memberof FungibleTokensApiInterface
49
+ */
50
+ getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
51
+
52
+ /**
53
+ * Retrieves the metadata for fungible tokens for a given contract id
54
+ * Fungible tokens metadata for contract id
55
+ */
56
+ getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
57
+
58
+ /**
59
+ * 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).
60
+ * @summary Fungible tokens metadata list
61
+ * @param {number} [limit] max number of tokens to fetch
62
+ * @param {number} [offset] index of first tokens to fetch
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ * @memberof FungibleTokensApiInterface
66
+ */
67
+ getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
68
+
69
+ /**
70
+ * 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).
71
+ * Fungible tokens metadata list
72
+ */
73
+ getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
74
+
75
+ }
76
+
77
+ /**
78
+ *
79
+ */
80
+ export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokensApiInterface {
81
+
82
+ /**
83
+ * Retrieves the metadata for fungible tokens for a given contract id
84
+ * Fungible tokens metadata for contract id
85
+ */
86
+ async getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>> {
87
+ if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
88
+ throw new runtime.RequiredError('contractId','Required parameter requestParameters.contractId was null or undefined when calling getContractFtMetadata.');
89
+ }
90
+
91
+ const queryParameters: any = {};
92
+
93
+ const headerParameters: runtime.HTTPHeaders = {};
94
+
95
+ const response = await this.request({
96
+ path: `/extended/v1/tokens/{contractId}/ft/metadata`.replace(`{${"contractId"}}`, encodeURIComponent(String(requestParameters.contractId))),
97
+ method: 'GET',
98
+ headers: headerParameters,
99
+ query: queryParameters,
100
+ }, initOverrides);
101
+
102
+ return new runtime.JSONApiResponse(response, (jsonValue) => FungibleTokenMetadataFromJSON(jsonValue));
103
+ }
104
+
105
+ /**
106
+ * Retrieves the metadata for fungible tokens for a given contract id
107
+ * Fungible tokens metadata for contract id
108
+ */
109
+ async getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata> {
110
+ const response = await this.getContractFtMetadataRaw(requestParameters, initOverrides);
111
+ return await response.value();
112
+ }
113
+
114
+ /**
115
+ * 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).
116
+ * Fungible tokens metadata list
117
+ */
118
+ async getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>> {
119
+ const queryParameters: any = {};
120
+
121
+ if (requestParameters.limit !== undefined) {
122
+ queryParameters['limit'] = requestParameters.limit;
123
+ }
124
+
125
+ if (requestParameters.offset !== undefined) {
126
+ queryParameters['offset'] = requestParameters.offset;
127
+ }
128
+
129
+ const headerParameters: runtime.HTTPHeaders = {};
130
+
131
+ const response = await this.request({
132
+ path: `/extended/v1/tokens/ft/metadata`,
133
+ method: 'GET',
134
+ headers: headerParameters,
135
+ query: queryParameters,
136
+ }, initOverrides);
137
+
138
+ return new runtime.JSONApiResponse(response, (jsonValue) => FungibleTokensMetadataListFromJSON(jsonValue));
139
+ }
140
+
141
+ /**
142
+ * 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).
143
+ * Fungible tokens metadata list
144
+ */
145
+ async getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList> {
146
+ const response = await this.getFtMetadataListRaw(requestParameters, initOverrides);
147
+ return await response.value();
148
+ }
149
+
150
+ }