@stacks/blockchain-api-client 0.71.1 → 1.0.3

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
  *
@@ -49,11 +49,13 @@ export interface GetAccountAssetsRequest {
49
49
  limit?: number;
50
50
  offset?: number;
51
51
  unanchored?: boolean;
52
+ untilBlock?: string;
52
53
  }
53
54
 
54
55
  export interface GetAccountBalanceRequest {
55
56
  principal: string;
56
57
  unanchored?: boolean;
58
+ untilBlock?: string;
57
59
  }
58
60
 
59
61
  export interface GetAccountInboundRequest {
@@ -62,6 +64,7 @@ export interface GetAccountInboundRequest {
62
64
  offset?: number;
63
65
  height?: number;
64
66
  unanchored?: boolean;
67
+ untilBlock?: string;
65
68
  }
66
69
 
67
70
  export interface GetAccountInfoRequest {
@@ -75,6 +78,7 @@ export interface GetAccountNftRequest {
75
78
  limit?: number;
76
79
  offset?: number;
77
80
  unanchored?: boolean;
81
+ untilBlock?: string;
78
82
  }
79
83
 
80
84
  export interface GetAccountNoncesRequest {
@@ -84,6 +88,7 @@ export interface GetAccountNoncesRequest {
84
88
  export interface GetAccountStxBalanceRequest {
85
89
  principal: string;
86
90
  unanchored?: boolean;
91
+ untilBlock?: string;
87
92
  }
88
93
 
89
94
  export interface GetAccountTransactionsRequest {
@@ -92,6 +97,7 @@ export interface GetAccountTransactionsRequest {
92
97
  offset?: number;
93
98
  height?: number;
94
99
  unanchored?: boolean;
100
+ untilBlock?: string;
95
101
  }
96
102
 
97
103
  export interface GetAccountTransactionsWithTransfersRequest {
@@ -100,6 +106,7 @@ export interface GetAccountTransactionsWithTransfersRequest {
100
106
  offset?: number;
101
107
  height?: number;
102
108
  unanchored?: boolean;
109
+ untilBlock?: string;
103
110
  }
104
111
 
105
112
  export interface GetSingleTransactionWithTransfersRequest {
@@ -115,12 +122,13 @@ export interface GetSingleTransactionWithTransfersRequest {
115
122
  */
116
123
  export interface AccountsApiInterface {
117
124
  /**
118
- *
125
+ * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
119
126
  * @summary Get account assets
120
127
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
121
128
  * @param {number} [limit] max number of account assets to fetch
122
129
  * @param {number} [offset] index of first account assets to fetch
123
130
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
131
+ * @param {string} [untilBlock] returned data representing the state at that point in time, rather than the current block.
124
132
  * @param {*} [options] Override http request option.
125
133
  * @throws {RequiredError}
126
134
  * @memberof AccountsApiInterface
@@ -128,15 +136,17 @@ export interface AccountsApiInterface {
128
136
  getAccountAssetsRaw(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressAssetsListResponse>>;
129
137
 
130
138
  /**
139
+ * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
131
140
  * Get account assets
132
141
  */
133
142
  getAccountAssets(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<AddressAssetsListResponse>;
134
143
 
135
144
  /**
136
- *
145
+ * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
137
146
  * @summary Get account balances
138
147
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
139
148
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
149
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
140
150
  * @param {*} [options] Override http request option.
141
151
  * @throws {RequiredError}
142
152
  * @memberof AccountsApiInterface
@@ -144,18 +154,20 @@ export interface AccountsApiInterface {
144
154
  getAccountBalanceRaw(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressBalanceResponse>>;
145
155
 
146
156
  /**
157
+ * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
147
158
  * Get account balances
148
159
  */
149
160
  getAccountBalance(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<AddressBalanceResponse>;
150
161
 
151
162
  /**
152
- * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
163
+ * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
153
164
  * @summary Get inbound STX transfers
154
165
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
155
166
  * @param {number} [limit] number of items to return
156
167
  * @param {number} [offset] number of items to skip
157
168
  * @param {number} [height] Filter for transfers only at this given block height
158
169
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
170
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
159
171
  * @param {*} [options] Override http request option.
160
172
  * @throws {RequiredError}
161
173
  * @memberof AccountsApiInterface
@@ -163,13 +175,13 @@ export interface AccountsApiInterface {
163
175
  getAccountInboundRaw(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressStxInboundListResponse>>;
164
176
 
165
177
  /**
166
- * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
178
+ * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
167
179
  * Get inbound STX transfers
168
180
  */
169
181
  getAccountInbound(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<AddressStxInboundListResponse>;
170
182
 
171
183
  /**
172
- * Get the account data for the provided principal Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
184
+ * Retrieves the account data for a given Account or a Contract Identifier Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
173
185
  * @summary Get account info
174
186
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
175
187
  * @param {number} [proof] Returns object without the proof field if set to 0
@@ -181,18 +193,19 @@ export interface AccountsApiInterface {
181
193
  getAccountInfoRaw(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AccountDataResponse>>;
182
194
 
183
195
  /**
184
- * Get the account data for the provided principal Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
196
+ * Retrieves the account data for a given Account or a Contract Identifier Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
185
197
  * Get account info
186
198
  */
187
199
  getAccountInfo(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<AccountDataResponse>;
188
200
 
189
201
  /**
190
- * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
202
+ * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
191
203
  * @summary Get nft events
192
204
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
193
205
  * @param {number} [limit] number of items to return
194
206
  * @param {number} [offset] number of items to skip
195
207
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
208
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
196
209
  * @param {*} [options] Override http request option.
197
210
  * @throws {RequiredError}
198
211
  * @memberof AccountsApiInterface
@@ -200,14 +213,14 @@ export interface AccountsApiInterface {
200
213
  getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>>;
201
214
 
202
215
  /**
203
- * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
216
+ * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
204
217
  * Get nft events
205
218
  */
206
219
  getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse>;
207
220
 
208
221
  /**
209
- *
210
- * @summary Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
222
+ * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
223
+ * @summary Get the latest nonce used by an account
211
224
  * @param {string} principal Stacks address (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0&#x60;)
212
225
  * @param {*} [options] Override http request option.
213
226
  * @throws {RequiredError}
@@ -216,15 +229,17 @@ export interface AccountsApiInterface {
216
229
  getAccountNoncesRaw(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNonces>>;
217
230
 
218
231
  /**
219
- * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
232
+ * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
233
+ * Get the latest nonce used by an account
220
234
  */
221
235
  getAccountNonces(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<AddressNonces>;
222
236
 
223
237
  /**
224
- *
238
+ * Retrieves STX token balance for a given Address or Contract Identifier.
225
239
  * @summary Get account STX balance
226
240
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
227
241
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
242
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
228
243
  * @param {*} [options] Override http request option.
229
244
  * @throws {RequiredError}
230
245
  * @memberof AccountsApiInterface
@@ -232,18 +247,20 @@ export interface AccountsApiInterface {
232
247
  getAccountStxBalanceRaw(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
233
248
 
234
249
  /**
250
+ * Retrieves STX token balance for a given Address or Contract Identifier.
235
251
  * Get account STX balance
236
252
  */
237
253
  getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object>;
238
254
 
239
255
  /**
240
- *
256
+ * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
241
257
  * @summary Get account transactions
242
258
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
243
259
  * @param {number} [limit] max number of account transactions to fetch
244
260
  * @param {number} [offset] index of first account transaction to fetch
245
261
  * @param {number} [height] Filter for transactions only at this given block height
246
262
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
263
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
247
264
  * @param {*} [options] Override http request option.
248
265
  * @throws {RequiredError}
249
266
  * @memberof AccountsApiInterface
@@ -251,18 +268,20 @@ export interface AccountsApiInterface {
251
268
  getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>>;
252
269
 
253
270
  /**
271
+ * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
254
272
  * Get account transactions
255
273
  */
256
274
  getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse>;
257
275
 
258
276
  /**
259
- *
277
+ * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
260
278
  * @summary Get account transactions including STX transfers for each transaction.
261
279
  * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
262
280
  * @param {number} [limit] max number of account transactions to fetch
263
281
  * @param {number} [offset] index of first account transaction to fetch
264
282
  * @param {number} [height] Filter for transactions only at this given block height
265
283
  * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
284
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
266
285
  * @param {*} [options] Override http request option.
267
286
  * @throws {RequiredError}
268
287
  * @memberof AccountsApiInterface
@@ -270,12 +289,13 @@ export interface AccountsApiInterface {
270
289
  getAccountTransactionsWithTransfersRaw(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsWithTransfersListResponse>>;
271
290
 
272
291
  /**
292
+ * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
273
293
  * Get account transactions including STX transfers for each transaction.
274
294
  */
275
295
  getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
276
296
 
277
297
  /**
278
- *
298
+ * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
279
299
  * @summary Get account transaction information for specific transaction
280
300
  * @param {string} principal Stacks address or a contract identifier
281
301
  * @param {string} txId Transaction id
@@ -286,6 +306,7 @@ export interface AccountsApiInterface {
286
306
  getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
287
307
 
288
308
  /**
309
+ * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
289
310
  * Get account transaction information for specific transaction
290
311
  */
291
312
  getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -298,6 +319,7 @@ export interface AccountsApiInterface {
298
319
  export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
299
320
 
300
321
  /**
322
+ * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
301
323
  * Get account assets
302
324
  */
303
325
  async getAccountAssetsRaw(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressAssetsListResponse>> {
@@ -319,6 +341,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
319
341
  queryParameters['unanchored'] = requestParameters.unanchored;
320
342
  }
321
343
 
344
+ if (requestParameters.untilBlock !== undefined) {
345
+ queryParameters['until_block'] = requestParameters.untilBlock;
346
+ }
347
+
322
348
  const headerParameters: runtime.HTTPHeaders = {};
323
349
 
324
350
  const response = await this.request({
@@ -332,6 +358,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
332
358
  }
333
359
 
334
360
  /**
361
+ * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
335
362
  * Get account assets
336
363
  */
337
364
  async getAccountAssets(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<AddressAssetsListResponse> {
@@ -340,6 +367,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
340
367
  }
341
368
 
342
369
  /**
370
+ * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
343
371
  * Get account balances
344
372
  */
345
373
  async getAccountBalanceRaw(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressBalanceResponse>> {
@@ -353,6 +381,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
353
381
  queryParameters['unanchored'] = requestParameters.unanchored;
354
382
  }
355
383
 
384
+ if (requestParameters.untilBlock !== undefined) {
385
+ queryParameters['until_block'] = requestParameters.untilBlock;
386
+ }
387
+
356
388
  const headerParameters: runtime.HTTPHeaders = {};
357
389
 
358
390
  const response = await this.request({
@@ -366,6 +398,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
366
398
  }
367
399
 
368
400
  /**
401
+ * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
369
402
  * Get account balances
370
403
  */
371
404
  async getAccountBalance(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<AddressBalanceResponse> {
@@ -374,7 +407,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
374
407
  }
375
408
 
376
409
  /**
377
- * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
410
+ * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
378
411
  * Get inbound STX transfers
379
412
  */
380
413
  async getAccountInboundRaw(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressStxInboundListResponse>> {
@@ -400,6 +433,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
400
433
  queryParameters['unanchored'] = requestParameters.unanchored;
401
434
  }
402
435
 
436
+ if (requestParameters.untilBlock !== undefined) {
437
+ queryParameters['until_block'] = requestParameters.untilBlock;
438
+ }
439
+
403
440
  const headerParameters: runtime.HTTPHeaders = {};
404
441
 
405
442
  const response = await this.request({
@@ -413,7 +450,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
413
450
  }
414
451
 
415
452
  /**
416
- * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
453
+ * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
417
454
  * Get inbound STX transfers
418
455
  */
419
456
  async getAccountInbound(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<AddressStxInboundListResponse> {
@@ -422,7 +459,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
422
459
  }
423
460
 
424
461
  /**
425
- * Get the account data for the provided principal Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
462
+ * Retrieves the account data for a given Account or a Contract Identifier Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
426
463
  * Get account info
427
464
  */
428
465
  async getAccountInfoRaw(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AccountDataResponse>> {
@@ -453,7 +490,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
453
490
  }
454
491
 
455
492
  /**
456
- * Get the account data for the provided principal Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
493
+ * Retrieves the account data for a given Account or a Contract Identifier Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
457
494
  * Get account info
458
495
  */
459
496
  async getAccountInfo(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<AccountDataResponse> {
@@ -462,7 +499,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
462
499
  }
463
500
 
464
501
  /**
465
- * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
502
+ * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
466
503
  * Get nft events
467
504
  */
468
505
  async getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>> {
@@ -484,6 +521,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
484
521
  queryParameters['unanchored'] = requestParameters.unanchored;
485
522
  }
486
523
 
524
+ if (requestParameters.untilBlock !== undefined) {
525
+ queryParameters['until_block'] = requestParameters.untilBlock;
526
+ }
527
+
487
528
  const headerParameters: runtime.HTTPHeaders = {};
488
529
 
489
530
  const response = await this.request({
@@ -497,7 +538,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
497
538
  }
498
539
 
499
540
  /**
500
- * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
541
+ * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
501
542
  * Get nft events
502
543
  */
503
544
  async getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse> {
@@ -506,7 +547,8 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
506
547
  }
507
548
 
508
549
  /**
509
- * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
550
+ * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
551
+ * Get the latest nonce used by an account
510
552
  */
511
553
  async getAccountNoncesRaw(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNonces>> {
512
554
  if (requestParameters.principal === null || requestParameters.principal === undefined) {
@@ -528,7 +570,8 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
528
570
  }
529
571
 
530
572
  /**
531
- * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
573
+ * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
574
+ * Get the latest nonce used by an account
532
575
  */
533
576
  async getAccountNonces(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<AddressNonces> {
534
577
  const response = await this.getAccountNoncesRaw(requestParameters, initOverrides);
@@ -536,6 +579,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
536
579
  }
537
580
 
538
581
  /**
582
+ * Retrieves STX token balance for a given Address or Contract Identifier.
539
583
  * Get account STX balance
540
584
  */
541
585
  async getAccountStxBalanceRaw(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
@@ -549,6 +593,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
549
593
  queryParameters['unanchored'] = requestParameters.unanchored;
550
594
  }
551
595
 
596
+ if (requestParameters.untilBlock !== undefined) {
597
+ queryParameters['until_block'] = requestParameters.untilBlock;
598
+ }
599
+
552
600
  const headerParameters: runtime.HTTPHeaders = {};
553
601
 
554
602
  const response = await this.request({
@@ -562,6 +610,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
562
610
  }
563
611
 
564
612
  /**
613
+ * Retrieves STX token balance for a given Address or Contract Identifier.
565
614
  * Get account STX balance
566
615
  */
567
616
  async getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object> {
@@ -570,6 +619,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
570
619
  }
571
620
 
572
621
  /**
622
+ * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
573
623
  * Get account transactions
574
624
  */
575
625
  async getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>> {
@@ -595,6 +645,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
595
645
  queryParameters['unanchored'] = requestParameters.unanchored;
596
646
  }
597
647
 
648
+ if (requestParameters.untilBlock !== undefined) {
649
+ queryParameters['until_block'] = requestParameters.untilBlock;
650
+ }
651
+
598
652
  const headerParameters: runtime.HTTPHeaders = {};
599
653
 
600
654
  const response = await this.request({
@@ -608,6 +662,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
608
662
  }
609
663
 
610
664
  /**
665
+ * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
611
666
  * Get account transactions
612
667
  */
613
668
  async getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse> {
@@ -616,6 +671,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
616
671
  }
617
672
 
618
673
  /**
674
+ * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
619
675
  * Get account transactions including STX transfers for each transaction.
620
676
  */
621
677
  async getAccountTransactionsWithTransfersRaw(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsWithTransfersListResponse>> {
@@ -641,6 +697,10 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
641
697
  queryParameters['unanchored'] = requestParameters.unanchored;
642
698
  }
643
699
 
700
+ if (requestParameters.untilBlock !== undefined) {
701
+ queryParameters['until_block'] = requestParameters.untilBlock;
702
+ }
703
+
644
704
  const headerParameters: runtime.HTTPHeaders = {};
645
705
 
646
706
  const response = await this.request({
@@ -654,6 +714,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
654
714
  }
655
715
 
656
716
  /**
717
+ * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
657
718
  * Get account transactions including STX transfers for each transaction.
658
719
  */
659
720
  async getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse> {
@@ -662,6 +723,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
662
723
  }
663
724
 
664
725
  /**
726
+ * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
665
727
  * Get account transaction information for specific transaction
666
728
  */
667
729
  async getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>> {
@@ -688,6 +750,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
688
750
  }
689
751
 
690
752
  /**
753
+ * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
691
754
  * Get account transaction information for specific transaction
692
755
  */
693
756
  async getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers> {