@stacks/blockchain-api-client 7.4.0-nakamoto.9 → 7.5.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (416) hide show
  1. package/README.md +16 -13
  2. package/lib/generated/apis/AccountsApi.d.ts +360 -325
  3. package/lib/generated/apis/AccountsApi.js +38 -0
  4. package/lib/generated/apis/AccountsApi.js.map +1 -1
  5. package/lib/generated/apis/BlocksApi.d.ts +163 -306
  6. package/lib/generated/apis/BlocksApi.js +10 -152
  7. package/lib/generated/apis/BlocksApi.js.map +1 -1
  8. package/lib/generated/apis/FaucetsApi.d.ts +84 -86
  9. package/lib/generated/apis/FaucetsApi.js +1 -3
  10. package/lib/generated/apis/FaucetsApi.js.map +1 -1
  11. package/lib/generated/apis/FeesApi.d.ts +103 -103
  12. package/lib/generated/apis/FeesApi.js.map +1 -1
  13. package/lib/generated/apis/FungibleTokensApi.d.ts +82 -0
  14. package/lib/generated/apis/FungibleTokensApi.js +80 -0
  15. package/lib/generated/apis/FungibleTokensApi.js.map +1 -0
  16. package/lib/generated/apis/InfoApi.d.ts +253 -253
  17. package/lib/generated/apis/InfoApi.js +1 -1
  18. package/lib/generated/apis/InfoApi.js.map +1 -1
  19. package/lib/generated/apis/MempoolApi.d.ts +49 -0
  20. package/lib/generated/apis/MempoolApi.js +48 -0
  21. package/lib/generated/apis/MempoolApi.js.map +1 -0
  22. package/lib/generated/apis/MicroblocksApi.d.ts +105 -105
  23. package/lib/generated/apis/MicroblocksApi.js.map +1 -1
  24. package/lib/generated/apis/NamesApi.d.ts +298 -298
  25. package/lib/generated/apis/NamesApi.js.map +1 -1
  26. package/lib/generated/apis/NonFungibleTokensApi.d.ts +191 -135
  27. package/lib/generated/apis/NonFungibleTokensApi.js +55 -0
  28. package/lib/generated/apis/NonFungibleTokensApi.js.map +1 -1
  29. package/lib/generated/apis/RosettaApi.d.ts +454 -454
  30. package/lib/generated/apis/RosettaApi.js.map +1 -1
  31. package/lib/generated/apis/SearchApi.d.ts +54 -54
  32. package/lib/generated/apis/SearchApi.js.map +1 -1
  33. package/lib/generated/apis/SmartContractsApi.d.ts +255 -255
  34. package/lib/generated/apis/SmartContractsApi.js.map +1 -1
  35. package/lib/generated/apis/StackingApi.d.ts +61 -61
  36. package/lib/generated/apis/StackingApi.js.map +1 -1
  37. package/lib/generated/apis/StackingRewardsApi.d.ts +173 -173
  38. package/lib/generated/apis/StackingRewardsApi.js.map +1 -1
  39. package/lib/generated/apis/TransactionsApi.d.ts +430 -431
  40. package/lib/generated/apis/TransactionsApi.js +2 -3
  41. package/lib/generated/apis/TransactionsApi.js.map +1 -1
  42. package/lib/generated/apis/index.d.ts +16 -14
  43. package/lib/generated/apis/index.js +2 -0
  44. package/lib/generated/apis/index.js.map +1 -1
  45. package/lib/generated/index.d.ts +3 -3
  46. package/lib/generated/models/AccountDataResponse.d.ts +57 -57
  47. package/lib/generated/models/AccountDataResponse.js.map +1 -1
  48. package/lib/generated/models/AddressAssetsListResponse.d.ts +45 -45
  49. package/lib/generated/models/AddressAssetsListResponse.js.map +1 -1
  50. package/lib/generated/models/AddressBalanceResponse.d.ts +50 -50
  51. package/lib/generated/models/AddressBalanceResponse.js.map +1 -1
  52. package/lib/generated/models/AddressNftListResponse.d.ts +46 -0
  53. package/lib/generated/models/{BurnBlockListResponse.js → AddressNftListResponse.js} +11 -11
  54. package/lib/generated/models/AddressNftListResponse.js.map +1 -0
  55. package/lib/generated/models/AddressNftListResponseValue.d.ts +33 -0
  56. package/lib/generated/models/{InlineObject1.js → AddressNftListResponseValue.js} +13 -12
  57. package/lib/generated/models/AddressNftListResponseValue.js.map +1 -0
  58. package/lib/generated/models/AddressNonces.d.ts +51 -51
  59. package/lib/generated/models/AddressNonces.js.map +1 -1
  60. package/lib/generated/models/AddressStxInboundListResponse.d.ts +46 -46
  61. package/lib/generated/models/AddressStxInboundListResponse.js.map +1 -1
  62. package/lib/generated/models/AddressTokenOfferingLocked.d.ts +40 -40
  63. package/lib/generated/models/AddressTokenOfferingLocked.js.map +1 -1
  64. package/lib/generated/models/AddressTransactionWithTransfers.d.ts +58 -58
  65. package/lib/generated/models/AddressTransactionWithTransfers.js.map +1 -1
  66. package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.d.ts +45 -45
  67. package/lib/generated/models/AddressTransactionWithTransfersFtTransfers.js.map +1 -1
  68. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.d.ts +46 -46
  69. package/lib/generated/models/AddressTransactionWithTransfersNftTransfers.js.map +1 -1
  70. package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.d.ts +39 -39
  71. package/lib/generated/models/AddressTransactionWithTransfersStxTransfers.js.map +1 -1
  72. package/lib/generated/models/AddressTransactionWithTransfersValue.d.ts +33 -33
  73. package/lib/generated/models/AddressTransactionWithTransfersValue.js.map +1 -1
  74. package/lib/generated/models/AddressTransactionsListResponse.d.ts +45 -45
  75. package/lib/generated/models/AddressTransactionsListResponse.js.map +1 -1
  76. package/lib/generated/models/AddressTransactionsWithTransfersListResponse.d.ts +46 -46
  77. package/lib/generated/models/AddressTransactionsWithTransfersListResponse.js.map +1 -1
  78. package/lib/generated/models/AddressUnlockSchedule.d.ts +33 -33
  79. package/lib/generated/models/AddressUnlockSchedule.js.map +1 -1
  80. package/lib/generated/models/Block.d.ts +149 -149
  81. package/lib/generated/models/Block.js.map +1 -1
  82. package/lib/generated/models/BlockListResponse.d.ts +46 -46
  83. package/lib/generated/models/BlockListResponse.js.map +1 -1
  84. package/lib/generated/models/BnsError.d.ts +27 -27
  85. package/lib/generated/models/BnsError.js.map +1 -1
  86. package/lib/generated/models/BnsGetAllNamespacesResponse.d.ts +27 -27
  87. package/lib/generated/models/BnsGetAllNamespacesResponse.js.map +1 -1
  88. package/lib/generated/models/BnsGetNameInfoResponse.d.ts +75 -75
  89. package/lib/generated/models/BnsGetNameInfoResponse.js.map +1 -1
  90. package/lib/generated/models/BnsGetNamePriceResponse.d.ts +33 -33
  91. package/lib/generated/models/BnsGetNamePriceResponse.js.map +1 -1
  92. package/lib/generated/models/BnsGetNamespacePriceResponse.d.ts +33 -33
  93. package/lib/generated/models/BnsGetNamespacePriceResponse.js.map +1 -1
  94. package/lib/generated/models/BnsNamesOwnByAddressResponse.d.ts +27 -27
  95. package/lib/generated/models/BnsNamesOwnByAddressResponse.js.map +1 -1
  96. package/lib/generated/models/BurnchainReward.d.ts +63 -63
  97. package/lib/generated/models/BurnchainReward.js.map +1 -1
  98. package/lib/generated/models/BurnchainRewardListResponse.d.ts +40 -40
  99. package/lib/generated/models/BurnchainRewardListResponse.js.map +1 -1
  100. package/lib/generated/models/BurnchainRewardSlotHolder.d.ts +51 -51
  101. package/lib/generated/models/BurnchainRewardSlotHolder.js.map +1 -1
  102. package/lib/generated/models/BurnchainRewardSlotHolderListResponse.d.ts +46 -46
  103. package/lib/generated/models/BurnchainRewardSlotHolderListResponse.js.map +1 -1
  104. package/lib/generated/models/BurnchainRewardsTotal.d.ts +33 -33
  105. package/lib/generated/models/BurnchainRewardsTotal.js.map +1 -1
  106. package/lib/generated/models/ChainTip.d.ts +57 -57
  107. package/lib/generated/models/ChainTip.js.map +1 -1
  108. package/lib/generated/models/ContractInterfaceResponse.d.ts +51 -51
  109. package/lib/generated/models/ContractInterfaceResponse.js.map +1 -1
  110. package/lib/generated/models/ContractListResponse.d.ts +40 -40
  111. package/lib/generated/models/ContractListResponse.js.map +1 -1
  112. package/lib/generated/models/ContractSourceResponse.d.ts +39 -39
  113. package/lib/generated/models/ContractSourceResponse.js.map +1 -1
  114. package/lib/generated/models/CoreNodeInfoResponse.d.ts +99 -99
  115. package/lib/generated/models/CoreNodeInfoResponse.js.map +1 -1
  116. package/lib/generated/models/CoreNodePoxResponse.d.ts +75 -75
  117. package/lib/generated/models/CoreNodePoxResponse.js.map +1 -1
  118. package/lib/generated/models/FeeRate.d.ts +27 -27
  119. package/lib/generated/models/FeeRate.js.map +1 -1
  120. package/lib/generated/models/FeeRateRequest.d.ts +27 -27
  121. package/lib/generated/models/FeeRateRequest.js.map +1 -1
  122. package/lib/generated/models/FungibleTokenMetadata.d.ts +75 -0
  123. package/lib/generated/models/FungibleTokenMetadata.js +58 -0
  124. package/lib/generated/models/FungibleTokenMetadata.js.map +1 -0
  125. package/lib/generated/models/FungibleTokensMetadataList.d.ts +46 -0
  126. package/lib/generated/models/{NakamotoBlockListResponse.js → FungibleTokensMetadataList.js} +11 -11
  127. package/lib/generated/models/FungibleTokensMetadataList.js.map +1 -0
  128. package/lib/generated/models/GetRawTransactionResult.d.ts +27 -27
  129. package/lib/generated/models/GetRawTransactionResult.js.map +1 -1
  130. package/lib/generated/models/GetStxSupplyLegacyFormatResponse.d.ts +57 -57
  131. package/lib/generated/models/GetStxSupplyLegacyFormatResponse.js.map +1 -1
  132. package/lib/generated/models/GetStxSupplyResponse.d.ts +45 -45
  133. package/lib/generated/models/GetStxSupplyResponse.js.map +1 -1
  134. package/lib/generated/models/InboundStxTransfer.d.ts +72 -72
  135. package/lib/generated/models/InboundStxTransfer.js +1 -1
  136. package/lib/generated/models/InboundStxTransfer.js.map +1 -1
  137. package/lib/generated/models/InlineObject.d.ts +27 -33
  138. package/lib/generated/models/InlineObject.js +0 -2
  139. package/lib/generated/models/InlineObject.js.map +1 -1
  140. package/lib/generated/models/InlineResponse403.d.ts +33 -33
  141. package/lib/generated/models/InlineResponse403.js.map +1 -1
  142. package/lib/generated/models/MapEntryResponse.d.ts +33 -33
  143. package/lib/generated/models/MapEntryResponse.js.map +1 -1
  144. package/lib/generated/models/MempoolFeePriorities.d.ts +46 -0
  145. package/lib/generated/models/MempoolFeePriorities.js +50 -0
  146. package/lib/generated/models/MempoolFeePriorities.js.map +1 -0
  147. package/lib/generated/models/MempoolFeePrioritiesAll.d.ts +45 -0
  148. package/lib/generated/models/MempoolFeePrioritiesAll.js +48 -0
  149. package/lib/generated/models/MempoolFeePrioritiesAll.js.map +1 -0
  150. package/lib/generated/models/MempoolTransactionListResponse.d.ts +45 -45
  151. package/lib/generated/models/MempoolTransactionListResponse.js.map +1 -1
  152. package/lib/generated/models/MempoolTransactionStatsResponse.d.ts +46 -46
  153. package/lib/generated/models/MempoolTransactionStatsResponse.js.map +1 -1
  154. package/lib/generated/models/MempoolTransactionStatsResponseTxAges.d.ts +46 -46
  155. package/lib/generated/models/MempoolTransactionStatsResponseTxAges.js.map +1 -1
  156. package/lib/generated/models/MempoolTransactionStatsResponseTxByteSizes.d.ts +46 -46
  157. package/lib/generated/models/MempoolTransactionStatsResponseTxByteSizes.js.map +1 -1
  158. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAverages.d.ts +46 -46
  159. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAverages.js.map +1 -1
  160. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.d.ts +45 -45
  161. package/lib/generated/models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.js.map +1 -1
  162. package/lib/generated/models/MempoolTransactionStatsResponseTxTypeCounts.d.ts +45 -45
  163. package/lib/generated/models/MempoolTransactionStatsResponseTxTypeCounts.js.map +1 -1
  164. package/lib/generated/models/Microblock.d.ts +105 -105
  165. package/lib/generated/models/Microblock.js.map +1 -1
  166. package/lib/generated/models/MicroblockListResponse.d.ts +46 -46
  167. package/lib/generated/models/MicroblockListResponse.js.map +1 -1
  168. package/lib/generated/models/NetworkBlockTimeResponse.d.ts +27 -27
  169. package/lib/generated/models/NetworkBlockTimeResponse.js.map +1 -1
  170. package/lib/generated/models/NetworkBlockTimesResponse.d.ts +34 -34
  171. package/lib/generated/models/NetworkBlockTimesResponse.js.map +1 -1
  172. package/lib/generated/models/NetworkIdentifier.d.ts +40 -40
  173. package/lib/generated/models/NetworkIdentifier.js.map +1 -1
  174. package/lib/generated/models/NftEvent.d.ts +76 -0
  175. package/lib/generated/models/NftEvent.js +60 -0
  176. package/lib/generated/models/NftEvent.js.map +1 -0
  177. package/lib/generated/models/NonFungibleTokenHistoryEventList.d.ts +45 -45
  178. package/lib/generated/models/NonFungibleTokenHistoryEventList.js.map +1 -1
  179. package/lib/generated/models/NonFungibleTokenHoldingsList.d.ts +45 -45
  180. package/lib/generated/models/NonFungibleTokenHoldingsList.js.map +1 -1
  181. package/lib/generated/models/NonFungibleTokenMetadata.d.ts +63 -0
  182. package/lib/generated/models/NonFungibleTokenMetadata.js +54 -0
  183. package/lib/generated/models/NonFungibleTokenMetadata.js.map +1 -0
  184. package/lib/generated/models/NonFungibleTokenMintList.d.ts +45 -45
  185. package/lib/generated/models/NonFungibleTokenMintList.js.map +1 -1
  186. package/lib/generated/models/NonFungibleTokensMetadataList.d.ts +46 -0
  187. package/lib/generated/models/NonFungibleTokensMetadataList.js +49 -0
  188. package/lib/generated/models/NonFungibleTokensMetadataList.js.map +1 -0
  189. package/lib/generated/models/OtherTransactionIdentifier.d.ts +27 -27
  190. package/lib/generated/models/OtherTransactionIdentifier.js.map +1 -1
  191. package/lib/generated/models/PoolDelegation.d.ts +57 -57
  192. package/lib/generated/models/PoolDelegation.js.map +1 -1
  193. package/lib/generated/models/PoolDelegationsResponse.d.ts +46 -46
  194. package/lib/generated/models/PoolDelegationsResponse.js.map +1 -1
  195. package/lib/generated/models/PostCoreNodeTransactionsError.d.ts +45 -45
  196. package/lib/generated/models/PostCoreNodeTransactionsError.js.map +1 -1
  197. package/lib/generated/models/ReadOnlyFunctionArgs.d.ts +33 -33
  198. package/lib/generated/models/ReadOnlyFunctionArgs.js.map +1 -1
  199. package/lib/generated/models/ReadOnlyFunctionSuccessResponse.d.ts +39 -39
  200. package/lib/generated/models/ReadOnlyFunctionSuccessResponse.js.map +1 -1
  201. package/lib/generated/models/RosettaAccount.d.ts +40 -40
  202. package/lib/generated/models/RosettaAccount.js.map +1 -1
  203. package/lib/generated/models/RosettaAccountBalanceRequest.d.ts +40 -40
  204. package/lib/generated/models/RosettaAccountBalanceRequest.js.map +1 -1
  205. package/lib/generated/models/RosettaAccountBalanceResponse.d.ts +46 -46
  206. package/lib/generated/models/RosettaAccountBalanceResponse.js.map +1 -1
  207. package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.d.ts +27 -27
  208. package/lib/generated/models/RosettaAccountBalanceResponseCoinIdentifier.js.map +1 -1
  209. package/lib/generated/models/RosettaAccountBalanceResponseMetadata.d.ts +27 -27
  210. package/lib/generated/models/RosettaAccountBalanceResponseMetadata.js.map +1 -1
  211. package/lib/generated/models/RosettaAccountIdentifier.d.ts +40 -40
  212. package/lib/generated/models/RosettaAccountIdentifier.js.map +1 -1
  213. package/lib/generated/models/RosettaAmount.d.ts +40 -40
  214. package/lib/generated/models/RosettaAmount.js.map +1 -1
  215. package/lib/generated/models/RosettaBlock.d.ts +52 -52
  216. package/lib/generated/models/RosettaBlock.js.map +1 -1
  217. package/lib/generated/models/RosettaBlockMetadata.d.ts +39 -39
  218. package/lib/generated/models/RosettaBlockMetadata.js.map +1 -1
  219. package/lib/generated/models/RosettaBlockMetadata1.d.ts +33 -33
  220. package/lib/generated/models/RosettaBlockMetadata1.js.map +1 -1
  221. package/lib/generated/models/RosettaBlockRequest.d.ts +34 -34
  222. package/lib/generated/models/RosettaBlockRequest.js.map +1 -1
  223. package/lib/generated/models/RosettaBlockResponse.d.ts +34 -34
  224. package/lib/generated/models/RosettaBlockResponse.js.map +1 -1
  225. package/lib/generated/models/RosettaBlockTransactionRequest.d.ts +40 -40
  226. package/lib/generated/models/RosettaBlockTransactionRequest.js.map +1 -1
  227. package/lib/generated/models/RosettaBlockTransactionResponse.d.ts +28 -28
  228. package/lib/generated/models/RosettaBlockTransactionResponse.js.map +1 -1
  229. package/lib/generated/models/RosettaCoin.d.ts +34 -34
  230. package/lib/generated/models/RosettaCoin.js.map +1 -1
  231. package/lib/generated/models/RosettaCoinChange.d.ts +42 -42
  232. package/lib/generated/models/RosettaCoinChange.js +1 -1
  233. package/lib/generated/models/RosettaCoinChange.js.map +1 -1
  234. package/lib/generated/models/RosettaConstructionCombineRequest.d.ts +40 -40
  235. package/lib/generated/models/RosettaConstructionCombineRequest.js.map +1 -1
  236. package/lib/generated/models/RosettaConstructionCombineResponse.d.ts +27 -27
  237. package/lib/generated/models/RosettaConstructionCombineResponse.js.map +1 -1
  238. package/lib/generated/models/RosettaConstructionDeriveRequest.d.ts +40 -40
  239. package/lib/generated/models/RosettaConstructionDeriveRequest.js.map +1 -1
  240. package/lib/generated/models/RosettaConstructionDeriveResponse.d.ts +40 -40
  241. package/lib/generated/models/RosettaConstructionDeriveResponse.js.map +1 -1
  242. package/lib/generated/models/RosettaConstructionHashRequest.d.ts +34 -34
  243. package/lib/generated/models/RosettaConstructionHashRequest.js.map +1 -1
  244. package/lib/generated/models/RosettaConstructionHashResponse.d.ts +34 -34
  245. package/lib/generated/models/RosettaConstructionHashResponse.js.map +1 -1
  246. package/lib/generated/models/RosettaConstructionMetadataRequest.d.ts +40 -40
  247. package/lib/generated/models/RosettaConstructionMetadataRequest.js.map +1 -1
  248. package/lib/generated/models/RosettaConstructionMetadataResponse.d.ts +34 -34
  249. package/lib/generated/models/RosettaConstructionMetadataResponse.js.map +1 -1
  250. package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.d.ts +33 -33
  251. package/lib/generated/models/RosettaConstructionMetadataResponseMetadata.js.map +1 -1
  252. package/lib/generated/models/RosettaConstructionParseRequest.d.ts +40 -40
  253. package/lib/generated/models/RosettaConstructionParseRequest.js.map +1 -1
  254. package/lib/generated/models/RosettaConstructionParseResponse.d.ts +46 -46
  255. package/lib/generated/models/RosettaConstructionParseResponse.js.map +1 -1
  256. package/lib/generated/models/RosettaConstructionPayloadResponse.d.ts +34 -34
  257. package/lib/generated/models/RosettaConstructionPayloadResponse.js.map +1 -1
  258. package/lib/generated/models/RosettaConstructionPayloadsRequest.d.ts +46 -46
  259. package/lib/generated/models/RosettaConstructionPayloadsRequest.js.map +1 -1
  260. package/lib/generated/models/RosettaConstructionPreprocessRequest.d.ts +52 -52
  261. package/lib/generated/models/RosettaConstructionPreprocessRequest.js.map +1 -1
  262. package/lib/generated/models/RosettaConstructionPreprocessResponse.d.ts +34 -34
  263. package/lib/generated/models/RosettaConstructionPreprocessResponse.js.map +1 -1
  264. package/lib/generated/models/RosettaConstructionSubmitRequest.d.ts +34 -34
  265. package/lib/generated/models/RosettaConstructionSubmitRequest.js.map +1 -1
  266. package/lib/generated/models/RosettaConstructionSubmitResponse.d.ts +34 -34
  267. package/lib/generated/models/RosettaConstructionSubmitResponse.js.map +1 -1
  268. package/lib/generated/models/RosettaCurrency.d.ts +39 -39
  269. package/lib/generated/models/RosettaCurrency.js.map +1 -1
  270. package/lib/generated/models/RosettaError.d.ts +46 -46
  271. package/lib/generated/models/RosettaError.js.map +1 -1
  272. package/lib/generated/models/RosettaErrorDetails.d.ts +33 -33
  273. package/lib/generated/models/RosettaErrorDetails.js.map +1 -1
  274. package/lib/generated/models/RosettaErrorNoDetails.d.ts +39 -39
  275. package/lib/generated/models/RosettaErrorNoDetails.js.map +1 -1
  276. package/lib/generated/models/RosettaGenesisBlockIdentifier.d.ts +33 -33
  277. package/lib/generated/models/RosettaGenesisBlockIdentifier.js.map +1 -1
  278. package/lib/generated/models/RosettaMaxFeeAmount.d.ts +40 -40
  279. package/lib/generated/models/RosettaMaxFeeAmount.js.map +1 -1
  280. package/lib/generated/models/RosettaMempoolRequest.d.ts +34 -34
  281. package/lib/generated/models/RosettaMempoolRequest.js.map +1 -1
  282. package/lib/generated/models/RosettaMempoolResponse.d.ts +34 -34
  283. package/lib/generated/models/RosettaMempoolResponse.js.map +1 -1
  284. package/lib/generated/models/RosettaMempoolTransactionRequest.d.ts +34 -34
  285. package/lib/generated/models/RosettaMempoolTransactionRequest.js.map +1 -1
  286. package/lib/generated/models/RosettaMempoolTransactionResponse.d.ts +34 -34
  287. package/lib/generated/models/RosettaMempoolTransactionResponse.js.map +1 -1
  288. package/lib/generated/models/RosettaNetworkListResponse.d.ts +28 -28
  289. package/lib/generated/models/RosettaNetworkListResponse.js.map +1 -1
  290. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.d.ts +34 -34
  291. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifier.js.map +1 -1
  292. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.d.ts +27 -27
  293. package/lib/generated/models/RosettaNetworkListResponseSubNetworkIdentifierMetadata.js.map +1 -1
  294. package/lib/generated/models/RosettaNetworkOptionsResponse.d.ts +34 -34
  295. package/lib/generated/models/RosettaNetworkOptionsResponse.js.map +1 -1
  296. package/lib/generated/models/RosettaNetworkOptionsResponseAllow.d.ts +46 -46
  297. package/lib/generated/models/RosettaNetworkOptionsResponseAllow.js.map +1 -1
  298. package/lib/generated/models/RosettaNetworkOptionsResponseVersion.d.ts +45 -45
  299. package/lib/generated/models/RosettaNetworkOptionsResponseVersion.js.map +1 -1
  300. package/lib/generated/models/RosettaNetworkStatusResponse.d.ts +58 -58
  301. package/lib/generated/models/RosettaNetworkStatusResponse.js.map +1 -1
  302. package/lib/generated/models/RosettaOldestBlockIdentifier.d.ts +33 -33
  303. package/lib/generated/models/RosettaOldestBlockIdentifier.js.map +1 -1
  304. package/lib/generated/models/RosettaOperation.d.ts +70 -70
  305. package/lib/generated/models/RosettaOperation.js.map +1 -1
  306. package/lib/generated/models/RosettaOperationIdentifier.d.ts +33 -33
  307. package/lib/generated/models/RosettaOperationIdentifier.js.map +1 -1
  308. package/lib/generated/models/RosettaOperationStatus.d.ts +33 -33
  309. package/lib/generated/models/RosettaOperationStatus.js.map +1 -1
  310. package/lib/generated/models/RosettaOptions.d.ts +141 -141
  311. package/lib/generated/models/RosettaOptions.js.map +1 -1
  312. package/lib/generated/models/RosettaOptionsRequest.d.ts +34 -34
  313. package/lib/generated/models/RosettaOptionsRequest.js.map +1 -1
  314. package/lib/generated/models/RosettaParentBlockIdentifier.d.ts +33 -33
  315. package/lib/generated/models/RosettaParentBlockIdentifier.js.map +1 -1
  316. package/lib/generated/models/RosettaPeers.d.ts +33 -33
  317. package/lib/generated/models/RosettaPeers.js.map +1 -1
  318. package/lib/generated/models/RosettaPublicKey.d.ts +41 -41
  319. package/lib/generated/models/RosettaPublicKey.js +1 -1
  320. package/lib/generated/models/RosettaPublicKey.js.map +1 -1
  321. package/lib/generated/models/RosettaRelatedOperation.d.ts +33 -33
  322. package/lib/generated/models/RosettaRelatedOperation.js.map +1 -1
  323. package/lib/generated/models/RosettaSignature.d.ts +57 -57
  324. package/lib/generated/models/RosettaSignature.js +1 -1
  325. package/lib/generated/models/RosettaSignature.js.map +1 -1
  326. package/lib/generated/models/RosettaStatusRequest.d.ts +34 -34
  327. package/lib/generated/models/RosettaStatusRequest.js.map +1 -1
  328. package/lib/generated/models/RosettaSubAccount.d.ts +33 -33
  329. package/lib/generated/models/RosettaSubAccount.js.map +1 -1
  330. package/lib/generated/models/RosettaSyncStatus.d.ts +45 -45
  331. package/lib/generated/models/RosettaSyncStatus.js.map +1 -1
  332. package/lib/generated/models/RosettaTransaction.d.ts +40 -40
  333. package/lib/generated/models/RosettaTransaction.js.map +1 -1
  334. package/lib/generated/models/RunFaucetResponse.d.ts +39 -39
  335. package/lib/generated/models/RunFaucetResponse.js.map +1 -1
  336. package/lib/generated/models/ServerStatusResponse.d.ts +52 -58
  337. package/lib/generated/models/ServerStatusResponse.js +0 -2
  338. package/lib/generated/models/ServerStatusResponse.js.map +1 -1
  339. package/lib/generated/models/SigningPayload.d.ts +57 -57
  340. package/lib/generated/models/SigningPayload.js +1 -1
  341. package/lib/generated/models/SigningPayload.js.map +1 -1
  342. package/lib/generated/models/SmartContract.d.ts +57 -57
  343. package/lib/generated/models/SmartContract.js.map +1 -1
  344. package/lib/generated/models/StxBalance.d.ts +81 -81
  345. package/lib/generated/models/StxBalance.js.map +1 -1
  346. package/lib/generated/models/TargetBlockTime.d.ts +27 -27
  347. package/lib/generated/models/TargetBlockTime.js.map +1 -1
  348. package/lib/generated/models/TransactionEventsResponse.d.ts +39 -39
  349. package/lib/generated/models/TransactionEventsResponse.js.map +1 -1
  350. package/lib/generated/models/TransactionFeeEstimateRequest.d.ts +33 -33
  351. package/lib/generated/models/TransactionFeeEstimateRequest.js.map +1 -1
  352. package/lib/generated/models/TransactionFeeEstimateResponse.d.ts +46 -46
  353. package/lib/generated/models/TransactionFeeEstimateResponse.js.map +1 -1
  354. package/lib/generated/models/TransactionFeeEstimateResponseEstimatedCost.d.ts +51 -51
  355. package/lib/generated/models/TransactionFeeEstimateResponseEstimatedCost.js.map +1 -1
  356. package/lib/generated/models/TransactionFeeEstimateResponseEstimations.d.ts +33 -33
  357. package/lib/generated/models/TransactionFeeEstimateResponseEstimations.js.map +1 -1
  358. package/lib/generated/models/TransactionIdentifier.d.ts +27 -27
  359. package/lib/generated/models/TransactionIdentifier.js.map +1 -1
  360. package/lib/generated/models/TransactionResults.d.ts +45 -45
  361. package/lib/generated/models/TransactionResults.js.map +1 -1
  362. package/lib/generated/models/UnanchoredTransactionListResponse.d.ts +33 -33
  363. package/lib/generated/models/UnanchoredTransactionListResponse.js.map +1 -1
  364. package/lib/generated/models/index.d.ts +151 -147
  365. package/lib/generated/models/index.js +9 -5
  366. package/lib/generated/models/index.js.map +1 -1
  367. package/lib/generated/runtime.d.ts +140 -140
  368. package/lib/generated/runtime.js +12 -3
  369. package/lib/generated/runtime.js.map +1 -1
  370. package/lib/index.d.ts +3 -3
  371. package/lib/index.umd.js +2400 -1866
  372. package/lib/index.umd.js.map +1 -1
  373. package/lib/socket-io/index.d.ts +56 -53
  374. package/lib/socket-io/index.js +64 -36
  375. package/lib/socket-io/index.js.map +1 -1
  376. package/lib/ws/index.d.ts +40 -40
  377. package/lib/ws/index.js +30 -29
  378. package/lib/ws/index.js.map +1 -1
  379. package/package.json +18 -15
  380. package/src/generated/.openapi-generator/FILES +11 -5
  381. package/src/generated/apis/AccountsApi.ts +79 -0
  382. package/src/generated/apis/BlocksApi.ts +20 -319
  383. package/src/generated/apis/FaucetsApi.ts +3 -11
  384. package/src/generated/apis/FungibleTokensApi.ts +150 -0
  385. package/src/generated/apis/MempoolApi.ts +80 -0
  386. package/src/generated/apis/NonFungibleTokensApi.ts +116 -0
  387. package/src/generated/apis/TransactionsApi.ts +2 -3
  388. package/src/generated/apis/index.ts +2 -0
  389. package/src/generated/models/{BurnBlockListResponse.ts → AddressNftListResponse.ts} +22 -22
  390. package/src/generated/models/{InlineObject1.ts → AddressNftListResponseValue.ts} +20 -12
  391. package/src/generated/models/FungibleTokenMetadata.ts +120 -0
  392. package/src/generated/models/{NakamotoBlockListResponse.ts → FungibleTokensMetadataList.ts} +22 -22
  393. package/src/generated/models/InlineObject.ts +1 -9
  394. package/src/generated/models/MempoolFeePriorities.ts +87 -0
  395. package/src/generated/models/MempoolFeePrioritiesAll.ts +80 -0
  396. package/src/generated/models/NftEvent.ts +127 -0
  397. package/src/generated/models/NonFungibleTokenMetadata.ts +104 -0
  398. package/src/generated/models/NonFungibleTokensMetadataList.ts +87 -0
  399. package/src/generated/models/ServerStatusResponse.ts +0 -8
  400. package/src/generated/models/index.ts +9 -5
  401. package/src/socket-io/index.ts +85 -53
  402. package/src/ws/index.ts +12 -7
  403. package/lib/generated/models/BurnBlock.d.ts +0 -51
  404. package/lib/generated/models/BurnBlock.js +0 -50
  405. package/lib/generated/models/BurnBlock.js.map +0 -1
  406. package/lib/generated/models/BurnBlockListResponse.d.ts +0 -46
  407. package/lib/generated/models/BurnBlockListResponse.js.map +0 -1
  408. package/lib/generated/models/InlineObject1.d.ts +0 -27
  409. package/lib/generated/models/InlineObject1.js.map +0 -1
  410. package/lib/generated/models/NakamotoBlock.d.ts +0 -123
  411. package/lib/generated/models/NakamotoBlock.js +0 -74
  412. package/lib/generated/models/NakamotoBlock.js.map +0 -1
  413. package/lib/generated/models/NakamotoBlockListResponse.d.ts +0 -46
  414. package/lib/generated/models/NakamotoBlockListResponse.js.map +0 -1
  415. package/src/generated/models/BurnBlock.ts +0 -88
  416. package/src/generated/models/NakamotoBlock.ts +0 -184
@@ -0,0 +1,87 @@
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=\"https://hirosystems.github.io/stacks-blockchain-api/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
+ import { exists, mapValues } from '../runtime';
16
+ import {
17
+ NonFungibleTokenMetadata,
18
+ NonFungibleTokenMetadataFromJSON,
19
+ NonFungibleTokenMetadataFromJSONTyped,
20
+ NonFungibleTokenMetadataToJSON,
21
+ } from './';
22
+
23
+ /**
24
+ * List of non fungible tokens metadata
25
+ * @export
26
+ * @interface NonFungibleTokensMetadataList
27
+ */
28
+ export interface NonFungibleTokensMetadataList {
29
+ /**
30
+ * The number of tokens metadata to return
31
+ * @type {number}
32
+ * @memberof NonFungibleTokensMetadataList
33
+ */
34
+ limit: number;
35
+ /**
36
+ * The number to tokens metadata to skip (starting at `0`)
37
+ * @type {number}
38
+ * @memberof NonFungibleTokensMetadataList
39
+ */
40
+ offset: number;
41
+ /**
42
+ * The number of tokens metadata available
43
+ * @type {number}
44
+ * @memberof NonFungibleTokensMetadataList
45
+ */
46
+ total: number;
47
+ /**
48
+ *
49
+ * @type {Array<NonFungibleTokenMetadata>}
50
+ * @memberof NonFungibleTokensMetadataList
51
+ */
52
+ results: Array<NonFungibleTokenMetadata>;
53
+ }
54
+
55
+ export function NonFungibleTokensMetadataListFromJSON(json: any): NonFungibleTokensMetadataList {
56
+ return NonFungibleTokensMetadataListFromJSONTyped(json, false);
57
+ }
58
+
59
+ export function NonFungibleTokensMetadataListFromJSONTyped(json: any, ignoreDiscriminator: boolean): NonFungibleTokensMetadataList {
60
+ if ((json === undefined) || (json === null)) {
61
+ return json;
62
+ }
63
+ return {
64
+
65
+ 'limit': json['limit'],
66
+ 'offset': json['offset'],
67
+ 'total': json['total'],
68
+ 'results': ((json['results'] as Array<any>).map(NonFungibleTokenMetadataFromJSON)),
69
+ };
70
+ }
71
+
72
+ export function NonFungibleTokensMetadataListToJSON(value?: NonFungibleTokensMetadataList | null): any {
73
+ if (value === undefined) {
74
+ return undefined;
75
+ }
76
+ if (value === null) {
77
+ return null;
78
+ }
79
+ return {
80
+
81
+ 'limit': value.limit,
82
+ 'offset': value.offset,
83
+ 'total': value.total,
84
+ 'results': ((value.results as Array<any>).map(NonFungibleTokenMetadataToJSON)),
85
+ };
86
+ }
87
+
@@ -50,12 +50,6 @@ export interface ServerStatusResponse {
50
50
  * @memberof ServerStatusResponse
51
51
  */
52
52
  pox_v2_unlock_height?: number | null;
53
- /**
54
- *
55
- * @type {number}
56
- * @memberof ServerStatusResponse
57
- */
58
- pox_v3_unlock_height?: number | null;
59
53
  /**
60
54
  *
61
55
  * @type {ChainTip}
@@ -78,7 +72,6 @@ export function ServerStatusResponseFromJSONTyped(json: any, ignoreDiscriminator
78
72
  'status': json['status'],
79
73
  'pox_v1_unlock_height': !exists(json, 'pox_v1_unlock_height') ? undefined : json['pox_v1_unlock_height'],
80
74
  'pox_v2_unlock_height': !exists(json, 'pox_v2_unlock_height') ? undefined : json['pox_v2_unlock_height'],
81
- 'pox_v3_unlock_height': !exists(json, 'pox_v3_unlock_height') ? undefined : json['pox_v3_unlock_height'],
82
75
  'chain_tip': !exists(json, 'chain_tip') ? undefined : ChainTipFromJSON(json['chain_tip']),
83
76
  };
84
77
  }
@@ -96,7 +89,6 @@ export function ServerStatusResponseToJSON(value?: ServerStatusResponse | null):
96
89
  'status': value.status,
97
90
  'pox_v1_unlock_height': value.pox_v1_unlock_height,
98
91
  'pox_v2_unlock_height': value.pox_v2_unlock_height,
99
- 'pox_v3_unlock_height': value.pox_v3_unlock_height,
100
92
  'chain_tip': ChainTipToJSON(value.chain_tip),
101
93
  };
102
94
  }
@@ -3,6 +3,8 @@
3
3
  export * from './AccountDataResponse';
4
4
  export * from './AddressAssetsListResponse';
5
5
  export * from './AddressBalanceResponse';
6
+ export * from './AddressNftListResponse';
7
+ export * from './AddressNftListResponseValue';
6
8
  export * from './AddressNonces';
7
9
  export * from './AddressStxInboundListResponse';
8
10
  export * from './AddressTokenOfferingLocked';
@@ -22,8 +24,6 @@ export * from './BnsGetNameInfoResponse';
22
24
  export * from './BnsGetNamePriceResponse';
23
25
  export * from './BnsGetNamespacePriceResponse';
24
26
  export * from './BnsNamesOwnByAddressResponse';
25
- export * from './BurnBlock';
26
- export * from './BurnBlockListResponse';
27
27
  export * from './BurnchainReward';
28
28
  export * from './BurnchainRewardListResponse';
29
29
  export * from './BurnchainRewardSlotHolder';
@@ -37,14 +37,17 @@ export * from './CoreNodeInfoResponse';
37
37
  export * from './CoreNodePoxResponse';
38
38
  export * from './FeeRate';
39
39
  export * from './FeeRateRequest';
40
+ export * from './FungibleTokenMetadata';
41
+ export * from './FungibleTokensMetadataList';
40
42
  export * from './GetRawTransactionResult';
41
43
  export * from './GetStxSupplyLegacyFormatResponse';
42
44
  export * from './GetStxSupplyResponse';
43
45
  export * from './InboundStxTransfer';
44
46
  export * from './InlineObject';
45
- export * from './InlineObject1';
46
47
  export * from './InlineResponse403';
47
48
  export * from './MapEntryResponse';
49
+ export * from './MempoolFeePriorities';
50
+ export * from './MempoolFeePrioritiesAll';
48
51
  export * from './MempoolTransactionListResponse';
49
52
  export * from './MempoolTransactionStatsResponse';
50
53
  export * from './MempoolTransactionStatsResponseTxAges';
@@ -54,14 +57,15 @@ export * from './MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer
54
57
  export * from './MempoolTransactionStatsResponseTxTypeCounts';
55
58
  export * from './Microblock';
56
59
  export * from './MicroblockListResponse';
57
- export * from './NakamotoBlock';
58
- export * from './NakamotoBlockListResponse';
59
60
  export * from './NetworkBlockTimeResponse';
60
61
  export * from './NetworkBlockTimesResponse';
61
62
  export * from './NetworkIdentifier';
63
+ export * from './NftEvent';
62
64
  export * from './NonFungibleTokenHistoryEventList';
63
65
  export * from './NonFungibleTokenHoldingsList';
66
+ export * from './NonFungibleTokenMetadata';
64
67
  export * from './NonFungibleTokenMintList';
68
+ export * from './NonFungibleTokensMetadataList';
65
69
  export * from './OtherTransactionIdentifier';
66
70
  export * from './PoolDelegation';
67
71
  export * from './PoolDelegationsResponse';
@@ -1,9 +1,16 @@
1
- import { io } from 'socket.io-client';
2
- import type { Socket } from 'socket.io-client';
1
+ import { io, Socket } from 'socket.io-client';
2
+ import type { ManagerOptions, SocketOptions } from 'socket.io-client';
3
3
  import {
4
4
  ClientToServerMessages,
5
5
  Topic,
6
6
  ServerToClientMessages,
7
+ MempoolTransaction,
8
+ Transaction,
9
+ Block,
10
+ Microblock,
11
+ AddressTransactionWithTransfers,
12
+ NftEvent,
13
+ AddressStxBalanceResponse,
7
14
  } from '@stacks/stacks-blockchain-api-types';
8
15
  import { BASE_PATH } from '../generated/runtime';
9
16
 
@@ -23,34 +30,46 @@ function getWsUrl(url: string): URL {
23
30
  return urlObj;
24
31
  }
25
32
 
26
- export interface StacksApiSocketConnectionOptions {
33
+ export type StacksApiSocketConnectionOptions = {
27
34
  url?: string;
28
35
  /** Initial topics to subscribe to. */
29
36
  subscriptions?: Topic[];
37
+ socketOpts?: Partial<ManagerOptions & SocketOptions>;
38
+ };
39
+
40
+ function createStacksApiSocket(opts?: StacksApiSocketConnectionOptions) {
41
+ const socketOpts = {
42
+ ...opts?.socketOpts,
43
+ query: {
44
+ ...opts?.socketOpts?.query,
45
+ // Subscriptions can be specified on init using this handshake query param.
46
+ subscriptions: Array.from(new Set(opts?.subscriptions)).join(','),
47
+ },
48
+ };
49
+ const socket: StacksApiSocket = io(getWsUrl(opts?.url ?? BASE_PATH).href, socketOpts);
50
+ return socket;
30
51
  }
31
52
 
32
53
  export class StacksApiSocketClient {
33
54
  readonly socket: StacksApiSocket;
34
55
 
35
- constructor(socket: StacksApiSocket) {
36
- this.socket = socket;
56
+ constructor(socket: StacksApiSocket);
57
+ constructor(opts?: StacksApiSocketConnectionOptions);
58
+ constructor(args?: StacksApiSocket | StacksApiSocketConnectionOptions) {
59
+ if (args instanceof Socket) {
60
+ this.socket = args;
61
+ } else {
62
+ this.socket = createStacksApiSocket(args);
63
+ }
37
64
  }
38
65
 
39
- public static connect({
40
- url = BASE_PATH,
41
- subscriptions = [],
42
- }: StacksApiSocketConnectionOptions = {}) {
43
- const socket: StacksApiSocket = io(getWsUrl(url).href, {
44
- query: {
45
- // Subscriptions can be specified on init using this handshake query param.
46
- subscriptions: Array.from(new Set(subscriptions)).join(','),
47
- },
48
- });
49
- return new StacksApiSocketClient(socket);
66
+ public static connect(opts?: StacksApiSocketConnectionOptions) {
67
+ return new StacksApiSocketClient(opts);
50
68
  }
51
69
 
52
- handleSubscription(topic: Topic, subscribe = false) {
53
- const subscriptions = new Set(this.socket.io.opts.query?.subscriptions.split(',') ?? []);
70
+ handleSubscription(topic: Topic, subscribe = false, listener?: (...args: any[]) => void) {
71
+ const subsQuery = this.socket.io.opts.query?.subscriptions as string | undefined;
72
+ const subscriptions = new Set(subsQuery?.split(',') ?? []);
54
73
  if (subscribe) {
55
74
  this.socket.emit('subscribe', topic, error => {
56
75
  if (error) console.error(`Error subscribing: ${error}`);
@@ -67,81 +86,106 @@ export class StacksApiSocketClient {
67
86
  this.socket.io.opts.query.subscriptions = Array.from(subscriptions).join(',');
68
87
  return {
69
88
  unsubscribe: () => {
89
+ if (listener) {
90
+ this.socket.off(topic, listener);
91
+ }
70
92
  this.handleSubscription(topic, false);
71
93
  },
72
94
  };
73
95
  }
74
96
 
75
- subscribeBlocks() {
76
- return this.handleSubscription('block', true);
97
+ subscribeBlocks(listener?: (tx: Block) => void) {
98
+ if (listener) this.socket.on('block', listener);
99
+ return this.handleSubscription('block', true, listener);
77
100
  }
78
101
 
79
102
  unsubscribeBlocks() {
80
103
  this.handleSubscription('block', false);
81
104
  }
82
105
 
83
- subscribeMicroblocks() {
84
- return this.handleSubscription('microblock', true);
106
+ subscribeMicroblocks(listener?: (tx: Microblock) => void) {
107
+ if (listener) this.socket.on('microblock', listener);
108
+ return this.handleSubscription('microblock', true, listener);
85
109
  }
86
110
 
87
111
  unsubscribeMicroblocks() {
88
112
  this.handleSubscription('microblock', false);
89
113
  }
90
114
 
91
- subscribeMempool() {
92
- return this.handleSubscription('mempool', true);
115
+ subscribeMempool(listener?: (tx: MempoolTransaction) => void) {
116
+ if (listener) this.socket.on('mempool', listener);
117
+ return this.handleSubscription('mempool', true, listener);
93
118
  }
94
119
 
95
120
  unsubscribeMempool() {
96
121
  this.handleSubscription('mempool', false);
97
122
  }
98
123
 
99
- subscribeAddressTransactions(address: string) {
100
- return this.handleSubscription(`address-transaction:${address}` as const, true);
124
+ subscribeAddressTransactions(
125
+ address: string,
126
+ listener?: (address: string, tx: AddressTransactionWithTransfers) => void
127
+ ) {
128
+ if (listener) this.socket.on(`address-transaction:${address}`, listener);
129
+ return this.handleSubscription(`address-transaction:${address}`, true, listener);
101
130
  }
102
131
 
103
132
  unsubscribeAddressTransactions(address: string) {
104
- this.handleSubscription(`address-transaction:${address}` as const, false);
133
+ this.handleSubscription(`address-transaction:${address}`, false);
105
134
  }
106
135
 
107
- subscribeAddressStxBalance(address: string) {
108
- return this.handleSubscription(`address-stx-balance:${address}` as const, true);
136
+ subscribeAddressStxBalance(
137
+ address: string,
138
+ listener?: (address: string, stxBalance: AddressStxBalanceResponse) => void
139
+ ) {
140
+ if (listener) this.socket.on(`address-stx-balance:${address}`, listener);
141
+ return this.handleSubscription(`address-stx-balance:${address}`, true, listener);
109
142
  }
110
143
 
111
144
  unsubscribeAddressStxBalance(address: string) {
112
- this.handleSubscription(`address-stx-balance:${address}` as const, false);
145
+ this.handleSubscription(`address-stx-balance:${address}`, false);
113
146
  }
114
147
 
115
- subscribeTransaction(txId: string) {
116
- return this.handleSubscription(`transaction:${txId}` as const, true);
148
+ subscribeTransaction(txId: string, listener?: (tx: MempoolTransaction | Transaction) => void) {
149
+ if (listener) this.socket.on(`transaction:${txId}`, listener);
150
+ return this.handleSubscription(`transaction:${txId}`, true, listener);
117
151
  }
118
152
 
119
153
  unsubscribeTransaction(txId: string) {
120
- this.handleSubscription(`transaction:${txId}` as const, false);
154
+ this.handleSubscription(`transaction:${txId}`, false);
121
155
  }
122
156
 
123
- subscribeNftEvent() {
124
- return this.handleSubscription('nft-event', true);
157
+ subscribeNftEvent(listener?: (event: NftEvent) => void) {
158
+ if (listener) this.socket.on('nft-event', listener);
159
+ return this.handleSubscription('nft-event', true, listener);
125
160
  }
126
161
 
127
162
  unsubscribeNftEvent() {
128
163
  this.handleSubscription('nft-event', false);
129
164
  }
130
165
 
131
- subscribeNftAssetEvent(assetIdentifier: string, value: string) {
132
- return this.handleSubscription(`nft-asset-event:${assetIdentifier}+${value}` as const, true);
166
+ subscribeNftAssetEvent(
167
+ assetIdentifier: string,
168
+ value: string,
169
+ listener?: (assetIdentifier: string, value: string, event: NftEvent) => void
170
+ ) {
171
+ if (listener) this.socket.on(`nft-asset-event:${assetIdentifier}+${value}`, listener);
172
+ return this.handleSubscription(`nft-asset-event:${assetIdentifier}+${value}`, true, listener);
133
173
  }
134
174
 
135
175
  unsubscribeNftAssetEvent(assetIdentifier: string, value: string) {
136
- this.handleSubscription(`nft-asset-event:${assetIdentifier}+${value}` as const, false);
176
+ this.handleSubscription(`nft-asset-event:${assetIdentifier}+${value}`, false);
137
177
  }
138
178
 
139
- subscribeNftCollectionEvent(assetIdentifier: string) {
140
- return this.handleSubscription(`nft-collection-event:${assetIdentifier}` as const, true);
179
+ subscribeNftCollectionEvent(
180
+ assetIdentifier: string,
181
+ listener?: (assetIdentifier: string, event: NftEvent) => void
182
+ ) {
183
+ if (listener) this.socket.on(`nft-collection-event:${assetIdentifier}`, listener);
184
+ return this.handleSubscription(`nft-collection-event:${assetIdentifier}`, true, listener);
141
185
  }
142
186
 
143
187
  unsubscribeNftCollectionEvent(assetIdentifier: string) {
144
- this.handleSubscription(`nft-collection-event:${assetIdentifier}` as const, false);
188
+ this.handleSubscription(`nft-collection-event:${assetIdentifier}`, false);
145
189
  }
146
190
 
147
191
  logEvents() {
@@ -151,18 +195,6 @@ export class StacksApiSocketClient {
151
195
  this.socket.on('block', block => console.log('block', block));
152
196
  this.socket.on('microblock', microblock => console.log('microblock', microblock));
153
197
  this.socket.on('mempool', tx => console.log('mempool', tx));
154
- this.socket.on('address-transaction', (address, data) =>
155
- console.log('address-transaction', address, data)
156
- );
157
- this.socket.on('address-stx-balance', (address, data) =>
158
- console.log('address-stx-balance', address, data)
159
- );
160
198
  this.socket.on('nft-event', event => console.log('nft-event', event));
161
- this.socket.on('nft-asset-event', (assetIdentifier, value, event) =>
162
- console.log('nft-asset-event', assetIdentifier, value, event)
163
- );
164
- this.socket.on('nft-collection-event', (assetIdentifier, event) =>
165
- console.log('nft-collection-event', assetIdentifier, event)
166
- );
167
199
  }
168
200
  }
package/src/ws/index.ts CHANGED
@@ -74,7 +74,7 @@ export class StacksApiWebSocketClient {
74
74
  constructor(webSocket: IWebSocket) {
75
75
  this.webSocket = webSocket;
76
76
  (webSocket as WebSocket).addEventListener('message', event => {
77
- const parsed = JsonRpcLite.parse(event.data);
77
+ const parsed = JsonRpcLite.parse(event.data as string);
78
78
  const rpcObjects = Array.isArray(parsed) ? parsed : [parsed];
79
79
  rpcObjects.forEach(obj => {
80
80
  if (obj.type === JsonRpcLite.RpcStatusType.notification) {
@@ -100,11 +100,10 @@ export class StacksApiWebSocketClient {
100
100
  const method = data.method as RpcSubscriptionType;
101
101
  switch (method) {
102
102
  case 'tx_update':
103
- this.eventEmitter.emit('txUpdate', data.params as (Transaction | MempoolTransaction));
103
+ this.eventEmitter.emit('txUpdate', data.params as Transaction | MempoolTransaction);
104
104
  break;
105
105
  case 'address_tx_update':
106
- this.eventEmitter.emit('addressTxUpdate',
107
- data.params as RpcAddressTxNotificationParams);
106
+ this.eventEmitter.emit('addressTxUpdate', data.params as RpcAddressTxNotificationParams);
108
107
  break;
109
108
  case 'address_balance_update':
110
109
  this.eventEmitter.emit(
@@ -134,7 +133,7 @@ export class StacksApiWebSocketClient {
134
133
  }
135
134
 
136
135
  private rpcCall<TResult = void>(method: string, params: any): Promise<TResult> {
137
- const rpcReq = JsonRpcLite.request(++this.idCursor, method, params);
136
+ const rpcReq = JsonRpcLite.request(++this.idCursor, method, params as JsonRpcLite.RpcParams);
138
137
  return new Promise<TResult>((resolve, reject) => {
139
138
  this.pendingRequests.set(rpcReq.id, { resolve, reject });
140
139
  this.webSocket.send(rpcReq.serialize());
@@ -276,9 +275,15 @@ export class StacksApiWebSocketClient {
276
275
  asset_identifier: assetIdentifier,
277
276
  value,
278
277
  };
279
- const subscribed = await this.rpcCall<{ asset_identifier: string, value: string }>('subscribe', params);
278
+ const subscribed = await this.rpcCall<{ asset_identifier: string; value: string }>(
279
+ 'subscribe',
280
+ params
281
+ );
280
282
  const listener = (event: NftEvent) => {
281
- if (event.asset_identifier === subscribed.asset_identifier && event.value.hex === subscribed.value) {
283
+ if (
284
+ event.asset_identifier === subscribed.asset_identifier &&
285
+ event.value.hex === subscribed.value
286
+ ) {
282
287
  update(event);
283
288
  }
284
289
  };
@@ -1,51 +0,0 @@
1
- /**
2
- * Stacks Blockchain API
3
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
- *
5
- * The version of the OpenAPI document: STACKS_API_VERSION
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * A burn block
14
- * @export
15
- * @interface BurnBlock
16
- */
17
- export interface BurnBlock {
18
- /**
19
- * Unix timestamp (in seconds) indicating when this block was mined.
20
- * @type {number}
21
- * @memberof BurnBlock
22
- */
23
- burn_block_time: number;
24
- /**
25
- * An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
26
- * @type {string}
27
- * @memberof BurnBlock
28
- */
29
- burn_block_time_iso: string;
30
- /**
31
- * Hash of the anchor chain block
32
- * @type {string}
33
- * @memberof BurnBlock
34
- */
35
- burn_block_hash: string;
36
- /**
37
- * Height of the anchor chain block
38
- * @type {number}
39
- * @memberof BurnBlock
40
- */
41
- burn_block_height: number;
42
- /**
43
- * Hashes of the Stacks blocks included in the burn block
44
- * @type {Array<string>}
45
- * @memberof BurnBlock
46
- */
47
- stacks_blocks: Array<string>;
48
- }
49
- export declare function BurnBlockFromJSON(json: any): BurnBlock;
50
- export declare function BurnBlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): BurnBlock;
51
- export declare function BurnBlockToJSON(value?: BurnBlock | null): any;
@@ -1,50 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Stacks Blockchain API
6
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
7
- *
8
- * The version of the OpenAPI document: STACKS_API_VERSION
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.BurnBlockToJSON = exports.BurnBlockFromJSONTyped = exports.BurnBlockFromJSON = void 0;
17
- function BurnBlockFromJSON(json) {
18
- return BurnBlockFromJSONTyped(json, false);
19
- }
20
- exports.BurnBlockFromJSON = BurnBlockFromJSON;
21
- function BurnBlockFromJSONTyped(json, ignoreDiscriminator) {
22
- if ((json === undefined) || (json === null)) {
23
- return json;
24
- }
25
- return {
26
- 'burn_block_time': json['burn_block_time'],
27
- 'burn_block_time_iso': json['burn_block_time_iso'],
28
- 'burn_block_hash': json['burn_block_hash'],
29
- 'burn_block_height': json['burn_block_height'],
30
- 'stacks_blocks': json['stacks_blocks'],
31
- };
32
- }
33
- exports.BurnBlockFromJSONTyped = BurnBlockFromJSONTyped;
34
- function BurnBlockToJSON(value) {
35
- if (value === undefined) {
36
- return undefined;
37
- }
38
- if (value === null) {
39
- return null;
40
- }
41
- return {
42
- 'burn_block_time': value.burn_block_time,
43
- 'burn_block_time_iso': value.burn_block_time_iso,
44
- 'burn_block_hash': value.burn_block_hash,
45
- 'burn_block_height': value.burn_block_height,
46
- 'stacks_blocks': value.stacks_blocks,
47
- };
48
- }
49
- exports.BurnBlockToJSON = BurnBlockToJSON;
50
- //# sourceMappingURL=BurnBlock.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"BurnBlock.js","sourceRoot":"","sources":["../../../src/generated/models/BurnBlock.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAyCH,SAAgB,iBAAiB,CAAC,IAAS;IACvC,OAAO,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC;AAFD,8CAEC;AAED,SAAgB,sBAAsB,CAAC,IAAS,EAAE,mBAA4B;IAC1E,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;QACzC,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC;QAC1C,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,CAAC;QAClD,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC;QAC1C,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC;QAC9C,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;KACzC,CAAC;AACN,CAAC;AAZD,wDAYC;AAED,SAAgB,eAAe,CAAC,KAAwB;IACpD,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,OAAO,SAAS,CAAC;KACpB;IACD,IAAI,KAAK,KAAK,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,iBAAiB,EAAE,KAAK,CAAC,eAAe;QACxC,qBAAqB,EAAE,KAAK,CAAC,mBAAmB;QAChD,iBAAiB,EAAE,KAAK,CAAC,eAAe;QACxC,mBAAmB,EAAE,KAAK,CAAC,iBAAiB;QAC5C,eAAe,EAAE,KAAK,CAAC,aAAa;KACvC,CAAC;AACN,CAAC;AAfD,0CAeC"}
@@ -1,46 +0,0 @@
1
- /**
2
- * Stacks Blockchain API
3
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
- *
5
- * The version of the OpenAPI document: STACKS_API_VERSION
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { BurnBlock } from './';
13
- /**
14
- * GET request that returns burn blocks
15
- * @export
16
- * @interface BurnBlockListResponse
17
- */
18
- export interface BurnBlockListResponse {
19
- /**
20
- * The number of burn blocks to return
21
- * @type {number}
22
- * @memberof BurnBlockListResponse
23
- */
24
- limit: number;
25
- /**
26
- * The number to burn blocks to skip (starting at `0`)
27
- * @type {number}
28
- * @memberof BurnBlockListResponse
29
- */
30
- offset: number;
31
- /**
32
- * The number of burn blocks available (regardless of filter parameters)
33
- * @type {number}
34
- * @memberof BurnBlockListResponse
35
- */
36
- total: number;
37
- /**
38
- *
39
- * @type {Array<BurnBlock>}
40
- * @memberof BurnBlockListResponse
41
- */
42
- results: Array<BurnBlock>;
43
- }
44
- export declare function BurnBlockListResponseFromJSON(json: any): BurnBlockListResponse;
45
- export declare function BurnBlockListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BurnBlockListResponse;
46
- export declare function BurnBlockListResponseToJSON(value?: BurnBlockListResponse | null): any;
@@ -1 +0,0 @@
1
- {"version":3,"file":"BurnBlockListResponse.js","sourceRoot":"","sources":["../../../src/generated/models/BurnBlockListResponse.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,yBAKY;AAkCZ,SAAgB,6BAA6B,CAAC,IAAS;IACnD,OAAO,kCAAkC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAFD,sEAEC;AAED,SAAgB,kCAAkC,CAAC,IAAS,EAAE,mBAA4B;IACtF,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;QACzC,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QACtB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QACxB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QACtB,SAAS,EAAE,CAAE,IAAI,CAAC,SAAS,CAAgB,CAAC,GAAG,CAAC,oBAAiB,CAAC,CAAC;KACtE,CAAC;AACN,CAAC;AAXD,gFAWC;AAED,SAAgB,2BAA2B,CAAC,KAAoC;IAC5E,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,OAAO,SAAS,CAAC;KACpB;IACD,IAAI,KAAK,KAAK,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,OAAO,EAAE,KAAK,CAAC,KAAK;QACpB,QAAQ,EAAE,KAAK,CAAC,MAAM;QACtB,OAAO,EAAE,KAAK,CAAC,KAAK;QACpB,SAAS,EAAE,CAAE,KAAK,CAAC,OAAsB,CAAC,GAAG,CAAC,kBAAe,CAAC,CAAC;KAClE,CAAC;AACN,CAAC;AAdD,kEAcC"}
@@ -1,27 +0,0 @@
1
- /**
2
- * Stacks Blockchain API
3
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>. <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a>
4
- *
5
- * The version of the OpenAPI document: STACKS_API_VERSION
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface InlineObject1
16
- */
17
- export interface InlineObject1 {
18
- /**
19
- * BTC testnet address
20
- * @type {string}
21
- * @memberof InlineObject1
22
- */
23
- address?: string;
24
- }
25
- export declare function InlineObject1FromJSON(json: any): InlineObject1;
26
- export declare function InlineObject1FromJSONTyped(json: any, ignoreDiscriminator: boolean): InlineObject1;
27
- export declare function InlineObject1ToJSON(value?: InlineObject1 | null): any;
@@ -1 +0,0 @@
1
- {"version":3,"file":"InlineObject1.js","sourceRoot":"","sources":["../../../src/generated/models/InlineObject1.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAEH,wCAA+C;AAe/C,SAAgB,qBAAqB,CAAC,IAAS;IAC3C,OAAO,0BAA0B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACnD,CAAC;AAFD,sDAEC;AAED,SAAgB,0BAA0B,CAAC,IAAS,EAAE,mBAA4B;IAC9E,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;QACzC,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,SAAS,EAAE,CAAC,IAAA,gBAAM,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;KACpE,CAAC;AACN,CAAC;AARD,gEAQC;AAED,SAAgB,mBAAmB,CAAC,KAA4B;IAC5D,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,OAAO,SAAS,CAAC;KACpB;IACD,IAAI,KAAK,KAAK,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC;KACf;IACD,OAAO;QAEH,SAAS,EAAE,KAAK,CAAC,OAAO;KAC3B,CAAC;AACN,CAAC;AAXD,kDAWC"}