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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/lib/generated/apis/AccountsApi.d.ts +36 -1
  2. package/lib/generated/apis/AccountsApi.js +38 -0
  3. package/lib/generated/apis/AccountsApi.js.map +1 -1
  4. package/lib/generated/apis/BlocksApi.d.ts +21 -164
  5. package/lib/generated/apis/BlocksApi.js +10 -152
  6. package/lib/generated/apis/BlocksApi.js.map +1 -1
  7. package/lib/generated/apis/FaucetsApi.d.ts +3 -5
  8. package/lib/generated/apis/FaucetsApi.js +1 -3
  9. package/lib/generated/apis/FaucetsApi.js.map +1 -1
  10. package/lib/generated/apis/FungibleTokensApi.d.ts +82 -0
  11. package/lib/generated/apis/FungibleTokensApi.js +80 -0
  12. package/lib/generated/apis/FungibleTokensApi.js.map +1 -0
  13. package/lib/generated/apis/MempoolApi.d.ts +49 -0
  14. package/lib/generated/apis/MempoolApi.js +48 -0
  15. package/lib/generated/apis/MempoolApi.js.map +1 -0
  16. package/lib/generated/apis/NonFungibleTokensApi.d.ts +57 -1
  17. package/lib/generated/apis/NonFungibleTokensApi.js +55 -0
  18. package/lib/generated/apis/NonFungibleTokensApi.js.map +1 -1
  19. package/lib/generated/apis/TransactionsApi.d.ts +2 -3
  20. package/lib/generated/apis/TransactionsApi.js +0 -1
  21. package/lib/generated/apis/TransactionsApi.js.map +1 -1
  22. package/lib/generated/apis/index.d.ts +2 -0
  23. package/lib/generated/apis/index.js +2 -0
  24. package/lib/generated/apis/index.js.map +1 -1
  25. package/lib/generated/models/AddressNftListResponse.d.ts +46 -0
  26. package/lib/generated/models/{BurnBlockListResponse.js → AddressNftListResponse.js} +11 -11
  27. package/lib/generated/models/AddressNftListResponse.js.map +1 -0
  28. package/lib/generated/models/AddressNftListResponseValue.d.ts +33 -0
  29. package/lib/generated/models/{InlineObject1.js → AddressNftListResponseValue.js} +13 -12
  30. package/lib/generated/models/AddressNftListResponseValue.js.map +1 -0
  31. package/lib/generated/models/FungibleTokenMetadata.d.ts +75 -0
  32. package/lib/generated/models/FungibleTokenMetadata.js +58 -0
  33. package/lib/generated/models/FungibleTokenMetadata.js.map +1 -0
  34. package/lib/generated/models/FungibleTokensMetadataList.d.ts +46 -0
  35. package/lib/generated/models/{NakamotoBlockListResponse.js → FungibleTokensMetadataList.js} +11 -11
  36. package/lib/generated/models/FungibleTokensMetadataList.js.map +1 -0
  37. package/lib/generated/models/InlineObject.d.ts +1 -7
  38. package/lib/generated/models/InlineObject.js +0 -2
  39. package/lib/generated/models/InlineObject.js.map +1 -1
  40. package/lib/generated/models/MempoolFeePriorities.d.ts +46 -0
  41. package/lib/generated/models/MempoolFeePriorities.js +50 -0
  42. package/lib/generated/models/MempoolFeePriorities.js.map +1 -0
  43. package/lib/generated/models/MempoolFeePrioritiesAll.d.ts +45 -0
  44. package/lib/generated/models/MempoolFeePrioritiesAll.js +48 -0
  45. package/lib/generated/models/MempoolFeePrioritiesAll.js.map +1 -0
  46. package/lib/generated/models/NftEvent.d.ts +76 -0
  47. package/lib/generated/models/NftEvent.js +60 -0
  48. package/lib/generated/models/NftEvent.js.map +1 -0
  49. package/lib/generated/models/NonFungibleTokenMetadata.d.ts +63 -0
  50. package/lib/generated/models/NonFungibleTokenMetadata.js +54 -0
  51. package/lib/generated/models/NonFungibleTokenMetadata.js.map +1 -0
  52. package/lib/generated/models/NonFungibleTokensMetadataList.d.ts +46 -0
  53. package/lib/generated/models/NonFungibleTokensMetadataList.js +49 -0
  54. package/lib/generated/models/NonFungibleTokensMetadataList.js.map +1 -0
  55. package/lib/generated/models/ServerStatusResponse.d.ts +0 -6
  56. package/lib/generated/models/ServerStatusResponse.js +0 -2
  57. package/lib/generated/models/ServerStatusResponse.js.map +1 -1
  58. package/lib/generated/models/index.d.ts +9 -5
  59. package/lib/generated/models/index.js +9 -5
  60. package/lib/generated/models/index.js.map +1 -1
  61. package/lib/index.umd.js +835 -586
  62. package/lib/index.umd.js.map +1 -1
  63. package/package.json +1 -1
  64. package/src/generated/.openapi-generator/FILES +11 -5
  65. package/src/generated/apis/AccountsApi.ts +79 -0
  66. package/src/generated/apis/BlocksApi.ts +20 -319
  67. package/src/generated/apis/FaucetsApi.ts +3 -11
  68. package/src/generated/apis/FungibleTokensApi.ts +150 -0
  69. package/src/generated/apis/MempoolApi.ts +80 -0
  70. package/src/generated/apis/NonFungibleTokensApi.ts +116 -0
  71. package/src/generated/apis/TransactionsApi.ts +2 -3
  72. package/src/generated/apis/index.ts +2 -0
  73. package/src/generated/models/{BurnBlockListResponse.ts → AddressNftListResponse.ts} +22 -22
  74. package/src/generated/models/{InlineObject1.ts → AddressNftListResponseValue.ts} +20 -12
  75. package/src/generated/models/FungibleTokenMetadata.ts +120 -0
  76. package/src/generated/models/{NakamotoBlockListResponse.ts → FungibleTokensMetadataList.ts} +22 -22
  77. package/src/generated/models/InlineObject.ts +1 -9
  78. package/src/generated/models/MempoolFeePriorities.ts +87 -0
  79. package/src/generated/models/MempoolFeePrioritiesAll.ts +80 -0
  80. package/src/generated/models/NftEvent.ts +127 -0
  81. package/src/generated/models/NonFungibleTokenMetadata.ts +104 -0
  82. package/src/generated/models/NonFungibleTokensMetadataList.ts +87 -0
  83. package/src/generated/models/ServerStatusResponse.ts +0 -8
  84. package/src/generated/models/index.ts +9 -5
  85. package/lib/generated/models/BurnBlock.d.ts +0 -51
  86. package/lib/generated/models/BurnBlock.js +0 -50
  87. package/lib/generated/models/BurnBlock.js.map +0 -1
  88. package/lib/generated/models/BurnBlockListResponse.d.ts +0 -46
  89. package/lib/generated/models/BurnBlockListResponse.js.map +0 -1
  90. package/lib/generated/models/InlineObject1.d.ts +0 -27
  91. package/lib/generated/models/InlineObject1.js.map +0 -1
  92. package/lib/generated/models/NakamotoBlock.d.ts +0 -123
  93. package/lib/generated/models/NakamotoBlock.js +0 -74
  94. package/lib/generated/models/NakamotoBlock.js.map +0 -1
  95. package/lib/generated/models/NakamotoBlockListResponse.d.ts +0 -46
  96. package/lib/generated/models/NakamotoBlockListResponse.js.map +0 -1
  97. package/src/generated/models/BurnBlock.ts +0 -88
  98. package/src/generated/models/NakamotoBlock.ts +0 -184
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "7.4.0-nakamoto.9",
3
+ "version": "7.4.0",
4
4
  "access": "public",
5
5
  "description": "Client for the Stacks Blockchain API",
6
6
  "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",
@@ -3,7 +3,9 @@ apis/AccountsApi.ts
3
3
  apis/BlocksApi.ts
4
4
  apis/FaucetsApi.ts
5
5
  apis/FeesApi.ts
6
+ apis/FungibleTokensApi.ts
6
7
  apis/InfoApi.ts
8
+ apis/MempoolApi.ts
7
9
  apis/MicroblocksApi.ts
8
10
  apis/NamesApi.ts
9
11
  apis/NonFungibleTokensApi.ts
@@ -18,6 +20,8 @@ index.ts
18
20
  models/AccountDataResponse.ts
19
21
  models/AddressAssetsListResponse.ts
20
22
  models/AddressBalanceResponse.ts
23
+ models/AddressNftListResponse.ts
24
+ models/AddressNftListResponseValue.ts
21
25
  models/AddressNonces.ts
22
26
  models/AddressStxInboundListResponse.ts
23
27
  models/AddressTokenOfferingLocked.ts
@@ -37,8 +41,6 @@ models/BnsGetNameInfoResponse.ts
37
41
  models/BnsGetNamePriceResponse.ts
38
42
  models/BnsGetNamespacePriceResponse.ts
39
43
  models/BnsNamesOwnByAddressResponse.ts
40
- models/BurnBlock.ts
41
- models/BurnBlockListResponse.ts
42
44
  models/BurnchainReward.ts
43
45
  models/BurnchainRewardListResponse.ts
44
46
  models/BurnchainRewardSlotHolder.ts
@@ -52,14 +54,17 @@ models/CoreNodeInfoResponse.ts
52
54
  models/CoreNodePoxResponse.ts
53
55
  models/FeeRate.ts
54
56
  models/FeeRateRequest.ts
57
+ models/FungibleTokenMetadata.ts
58
+ models/FungibleTokensMetadataList.ts
55
59
  models/GetRawTransactionResult.ts
56
60
  models/GetStxSupplyLegacyFormatResponse.ts
57
61
  models/GetStxSupplyResponse.ts
58
62
  models/InboundStxTransfer.ts
59
63
  models/InlineObject.ts
60
- models/InlineObject1.ts
61
64
  models/InlineResponse403.ts
62
65
  models/MapEntryResponse.ts
66
+ models/MempoolFeePriorities.ts
67
+ models/MempoolFeePrioritiesAll.ts
63
68
  models/MempoolTransactionListResponse.ts
64
69
  models/MempoolTransactionStatsResponse.ts
65
70
  models/MempoolTransactionStatsResponseTxAges.ts
@@ -69,14 +74,15 @@ models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.ts
69
74
  models/MempoolTransactionStatsResponseTxTypeCounts.ts
70
75
  models/Microblock.ts
71
76
  models/MicroblockListResponse.ts
72
- models/NakamotoBlock.ts
73
- models/NakamotoBlockListResponse.ts
74
77
  models/NetworkBlockTimeResponse.ts
75
78
  models/NetworkBlockTimesResponse.ts
76
79
  models/NetworkIdentifier.ts
80
+ models/NftEvent.ts
77
81
  models/NonFungibleTokenHistoryEventList.ts
78
82
  models/NonFungibleTokenHoldingsList.ts
83
+ models/NonFungibleTokenMetadata.ts
79
84
  models/NonFungibleTokenMintList.ts
85
+ models/NonFungibleTokensMetadataList.ts
80
86
  models/OtherTransactionIdentifier.ts
81
87
  models/PoolDelegation.ts
82
88
  models/PoolDelegationsResponse.ts
@@ -24,6 +24,9 @@ import {
24
24
  AddressBalanceResponse,
25
25
  AddressBalanceResponseFromJSON,
26
26
  AddressBalanceResponseToJSON,
27
+ AddressNftListResponse,
28
+ AddressNftListResponseFromJSON,
29
+ AddressNftListResponseToJSON,
27
30
  AddressNonces,
28
31
  AddressNoncesFromJSON,
29
32
  AddressNoncesToJSON,
@@ -70,6 +73,14 @@ export interface GetAccountInfoRequest {
70
73
  tip?: string;
71
74
  }
72
75
 
76
+ export interface GetAccountNftRequest {
77
+ principal: string;
78
+ limit?: number;
79
+ offset?: number;
80
+ unanchored?: boolean;
81
+ untilBlock?: string;
82
+ }
83
+
73
84
  export interface GetAccountNoncesRequest {
74
85
  principal: string;
75
86
  blockHeight?: number;
@@ -189,6 +200,26 @@ export interface AccountsApiInterface {
189
200
  */
190
201
  getAccountInfo(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<AccountDataResponse>;
191
202
 
203
+ /**
204
+ * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings). Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft.
205
+ * @summary Get nft events
206
+ * @param {string} principal Stacks address or a Contract identifier
207
+ * @param {number} [limit] number of items to return
208
+ * @param {number} [offset] number of items to skip
209
+ * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
210
+ * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
211
+ * @param {*} [options] Override http request option.
212
+ * @throws {RequiredError}
213
+ * @memberof AccountsApiInterface
214
+ */
215
+ getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>>;
216
+
217
+ /**
218
+ * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings). Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft.
219
+ * Get nft events
220
+ */
221
+ getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse>;
222
+
192
223
  /**
193
224
  * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
194
225
  * @summary Get the latest nonce used by an account
@@ -471,6 +502,54 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
471
502
  return await response.value();
472
503
  }
473
504
 
505
+ /**
506
+ * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings). Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft.
507
+ * Get nft events
508
+ */
509
+ async getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>> {
510
+ if (requestParameters.principal === null || requestParameters.principal === undefined) {
511
+ throw new runtime.RequiredError('principal','Required parameter requestParameters.principal was null or undefined when calling getAccountNft.');
512
+ }
513
+
514
+ const queryParameters: any = {};
515
+
516
+ if (requestParameters.limit !== undefined) {
517
+ queryParameters['limit'] = requestParameters.limit;
518
+ }
519
+
520
+ if (requestParameters.offset !== undefined) {
521
+ queryParameters['offset'] = requestParameters.offset;
522
+ }
523
+
524
+ if (requestParameters.unanchored !== undefined) {
525
+ queryParameters['unanchored'] = requestParameters.unanchored;
526
+ }
527
+
528
+ if (requestParameters.untilBlock !== undefined) {
529
+ queryParameters['until_block'] = requestParameters.untilBlock;
530
+ }
531
+
532
+ const headerParameters: runtime.HTTPHeaders = {};
533
+
534
+ const response = await this.request({
535
+ path: `/extended/v1/address/{principal}/nft_events`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
536
+ method: 'GET',
537
+ headers: headerParameters,
538
+ query: queryParameters,
539
+ }, initOverrides);
540
+
541
+ return new runtime.JSONApiResponse(response, (jsonValue) => AddressNftListResponseFromJSON(jsonValue));
542
+ }
543
+
544
+ /**
545
+ * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings). Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft.
546
+ * Get nft events
547
+ */
548
+ async getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse> {
549
+ const response = await this.getAccountNftRaw(requestParameters, initOverrides);
550
+ return await response.value();
551
+ }
552
+
474
553
  /**
475
554
  * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
476
555
  * Get the latest nonce used by an account
@@ -21,27 +21,8 @@ import {
21
21
  BlockListResponse,
22
22
  BlockListResponseFromJSON,
23
23
  BlockListResponseToJSON,
24
- BurnBlock,
25
- BurnBlockFromJSON,
26
- BurnBlockToJSON,
27
- BurnBlockListResponse,
28
- BurnBlockListResponseFromJSON,
29
- BurnBlockListResponseToJSON,
30
- NakamotoBlock,
31
- NakamotoBlockFromJSON,
32
- NakamotoBlockToJSON,
33
- NakamotoBlockListResponse,
34
- NakamotoBlockListResponseFromJSON,
35
- NakamotoBlockListResponseToJSON,
36
- TransactionResults,
37
- TransactionResultsFromJSON,
38
- TransactionResultsToJSON,
39
24
  } from '../models';
40
25
 
41
- export interface GetBlockRequest {
42
- heightOrHash: number | string;
43
- }
44
-
45
26
  export interface GetBlockByBurnBlockHashRequest {
46
27
  burnBlockHash: string;
47
28
  }
@@ -63,26 +44,6 @@ export interface GetBlockListRequest {
63
44
  offset?: number;
64
45
  }
65
46
 
66
- export interface GetBlockTransactionsRequest {
67
- heightOrHash: number | string;
68
- }
69
-
70
- export interface GetBlocksRequest {
71
- limit?: number;
72
- offset?: number;
73
- burnBlockHash?: string;
74
- burnBlockHeight?: number;
75
- }
76
-
77
- export interface GetBurnBlockRequest {
78
- heightOrHash: number | string;
79
- }
80
-
81
- export interface GetBurnBlocksRequest {
82
- limit?: number;
83
- offset?: number;
84
- }
85
-
86
47
  /**
87
48
  * BlocksApi - interface
88
49
  *
@@ -91,23 +52,7 @@ export interface GetBurnBlocksRequest {
91
52
  */
92
53
  export interface BlocksApiInterface {
93
54
  /**
94
- * Retrieves a single block
95
- * @summary Get block
96
- * @param {number | string} heightOrHash filter by block height, hash, index block hash or the constant &#x60;latest&#x60; to filter for the most recent block
97
- * @param {*} [options] Override http request option.
98
- * @throws {RequiredError}
99
- * @memberof BlocksApiInterface
100
- */
101
- getBlockRaw(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlock>>;
102
-
103
- /**
104
- * Retrieves a single block
105
- * Get block
106
- */
107
- getBlock(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<NakamotoBlock>;
108
-
109
- /**
110
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burnchain block hash
55
+ * Retrieves block details of a specific block for a given burnchain block hash
111
56
  * @summary Get block by burnchain block hash
112
57
  * @param {string} burnBlockHash Hash of the burnchain block
113
58
  * @param {*} [options] Override http request option.
@@ -117,13 +62,13 @@ export interface BlocksApiInterface {
117
62
  getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
118
63
 
119
64
  /**
120
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burnchain block hash
65
+ * Retrieves block details of a specific block for a given burnchain block hash
121
66
  * Get block by burnchain block hash
122
67
  */
123
68
  getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block>;
124
69
 
125
70
  /**
126
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burn chain height
71
+ * Retrieves block details of a specific block for a given burn chain height
127
72
  * @summary Get block by burnchain height
128
73
  * @param {number} burnBlockHeight Height of the burn chain block
129
74
  * @param {*} [options] Override http request option.
@@ -133,13 +78,13 @@ export interface BlocksApiInterface {
133
78
  getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
134
79
 
135
80
  /**
136
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burn chain height
81
+ * Retrieves block details of a specific block for a given burn chain height
137
82
  * Get block by burnchain height
138
83
  */
139
84
  getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block>;
140
85
 
141
86
  /**
142
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
87
+ * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
143
88
  * @summary Get block by hash
144
89
  * @param {string} hash Hash of the block
145
90
  * @param {*} [options] Override http request option.
@@ -149,13 +94,13 @@ export interface BlocksApiInterface {
149
94
  getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
150
95
 
151
96
  /**
152
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
97
+ * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
153
98
  * Get block by hash
154
99
  */
155
100
  getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block>;
156
101
 
157
102
  /**
158
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block at a given block height
103
+ * Retrieves block details of a specific block at a given block height
159
104
  * @summary Get block by height
160
105
  * @param {number} height Height of the block
161
106
  * @param {*} [options] Override http request option.
@@ -165,13 +110,13 @@ export interface BlocksApiInterface {
165
110
  getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
166
111
 
167
112
  /**
168
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block at a given block height
113
+ * Retrieves block details of a specific block at a given block height
169
114
  * Get block by height
170
115
  */
171
116
  getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block>;
172
117
 
173
118
  /**
174
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
119
+ * Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
175
120
  * @summary Get recent blocks
176
121
  * @param {number} [limit] max number of blocks to fetch
177
122
  * @param {number} [offset] index of first block to fetch
@@ -182,79 +127,11 @@ export interface BlocksApiInterface {
182
127
  getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BlockListResponse>>;
183
128
 
184
129
  /**
185
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
130
+ * Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
186
131
  * Get recent blocks
187
132
  */
188
133
  getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse>;
189
134
 
190
- /**
191
- * Retrieves transactions confirmed in a single block
192
- * @summary Get block transactions
193
- * @param {number | string} heightOrHash filter by block height, hash, index block hash or the constant &#x60;latest&#x60; to filter for the most recent block
194
- * @param {*} [options] Override http request option.
195
- * @throws {RequiredError}
196
- * @memberof BlocksApiInterface
197
- */
198
- getBlockTransactionsRaw(requestParameters: GetBlockTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>>;
199
-
200
- /**
201
- * Retrieves transactions confirmed in a single block
202
- * Get block transactions
203
- */
204
- getBlockTransactions(requestParameters: GetBlockTransactionsRequest, initOverrides?: RequestInit): Promise<TransactionResults>;
205
-
206
- /**
207
- * Retrieves a list of recently mined blocks
208
- * @summary Get blocks
209
- * @param {number} [limit] max number of blocks to fetch
210
- * @param {number} [offset] index of first burn block to fetch
211
- * @param {string} [burnBlockHash] filter blocks by burn block hash
212
- * @param {number} [burnBlockHeight] filter blocks by burn block height
213
- * @param {*} [options] Override http request option.
214
- * @throws {RequiredError}
215
- * @memberof BlocksApiInterface
216
- */
217
- getBlocksRaw(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlockListResponse>>;
218
-
219
- /**
220
- * Retrieves a list of recently mined blocks
221
- * Get blocks
222
- */
223
- getBlocks(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<NakamotoBlockListResponse>;
224
-
225
- /**
226
- * Retrieves a single burn block
227
- * @summary Get burn block
228
- * @param {number | string} heightOrHash filter by burn block height, hash, or the constant &#x60;latest&#x60; to filter for the most recent burn block
229
- * @param {*} [options] Override http request option.
230
- * @throws {RequiredError}
231
- * @memberof BlocksApiInterface
232
- */
233
- getBurnBlockRaw(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlock>>;
234
-
235
- /**
236
- * Retrieves a single burn block
237
- * Get burn block
238
- */
239
- getBurnBlock(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<BurnBlock>;
240
-
241
- /**
242
- * Retrieves a list of recent burn blocks
243
- * @summary Get burn blocks
244
- * @param {number} [limit] max number of burn blocks to fetch
245
- * @param {number} [offset] index of first burn block to fetch
246
- * @param {*} [options] Override http request option.
247
- * @throws {RequiredError}
248
- * @memberof BlocksApiInterface
249
- */
250
- getBurnBlocksRaw(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>>;
251
-
252
- /**
253
- * Retrieves a list of recent burn blocks
254
- * Get burn blocks
255
- */
256
- getBurnBlocks(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse>;
257
-
258
135
  }
259
136
 
260
137
  /**
@@ -263,39 +140,7 @@ export interface BlocksApiInterface {
263
140
  export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
264
141
 
265
142
  /**
266
- * Retrieves a single block
267
- * Get block
268
- */
269
- async getBlockRaw(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlock>> {
270
- if (requestParameters.heightOrHash === null || requestParameters.heightOrHash === undefined) {
271
- throw new runtime.RequiredError('heightOrHash','Required parameter requestParameters.heightOrHash was null or undefined when calling getBlock.');
272
- }
273
-
274
- const queryParameters: any = {};
275
-
276
- const headerParameters: runtime.HTTPHeaders = {};
277
-
278
- const response = await this.request({
279
- path: `/extended/v2/blocks/{height_or_hash}`.replace(`{${"height_or_hash"}}`, encodeURIComponent(String(requestParameters.heightOrHash))),
280
- method: 'GET',
281
- headers: headerParameters,
282
- query: queryParameters,
283
- }, initOverrides);
284
-
285
- return new runtime.JSONApiResponse(response, (jsonValue) => NakamotoBlockFromJSON(jsonValue));
286
- }
287
-
288
- /**
289
- * Retrieves a single block
290
- * Get block
291
- */
292
- async getBlock(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<NakamotoBlock> {
293
- const response = await this.getBlockRaw(requestParameters, initOverrides);
294
- return await response.value();
295
- }
296
-
297
- /**
298
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burnchain block hash
143
+ * Retrieves block details of a specific block for a given burnchain block hash
299
144
  * Get block by burnchain block hash
300
145
  */
301
146
  async getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -318,7 +163,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
318
163
  }
319
164
 
320
165
  /**
321
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burnchain block hash
166
+ * Retrieves block details of a specific block for a given burnchain block hash
322
167
  * Get block by burnchain block hash
323
168
  */
324
169
  async getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -327,7 +172,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
327
172
  }
328
173
 
329
174
  /**
330
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burn chain height
175
+ * Retrieves block details of a specific block for a given burn chain height
331
176
  * Get block by burnchain height
332
177
  */
333
178
  async getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -350,7 +195,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
350
195
  }
351
196
 
352
197
  /**
353
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves block details of a specific block for a given burn chain height
198
+ * Retrieves block details of a specific block for a given burn chain height
354
199
  * Get block by burnchain height
355
200
  */
356
201
  async getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -359,7 +204,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
359
204
  }
360
205
 
361
206
  /**
362
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
207
+ * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
363
208
  * Get block by hash
364
209
  */
365
210
  async getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -382,7 +227,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
382
227
  }
383
228
 
384
229
  /**
385
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
230
+ * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
386
231
  * Get block by hash
387
232
  */
388
233
  async getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -391,7 +236,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
391
236
  }
392
237
 
393
238
  /**
394
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block at a given block height
239
+ * Retrieves block details of a specific block at a given block height
395
240
  * Get block by height
396
241
  */
397
242
  async getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -414,7 +259,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
414
259
  }
415
260
 
416
261
  /**
417
- * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block). Retrieves block details of a specific block at a given block height
262
+ * Retrieves block details of a specific block at a given block height
418
263
  * Get block by height
419
264
  */
420
265
  async getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -423,7 +268,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
423
268
  }
424
269
 
425
270
  /**
426
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
271
+ * Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
427
272
  * Get recent blocks
428
273
  */
429
274
  async getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BlockListResponse>> {
@@ -450,7 +295,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
450
295
  }
451
296
 
452
297
  /**
453
- * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks). Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
298
+ * Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
454
299
  * Get recent blocks
455
300
  */
456
301
  async getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse> {
@@ -458,148 +303,4 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
458
303
  return await response.value();
459
304
  }
460
305
 
461
- /**
462
- * Retrieves transactions confirmed in a single block
463
- * Get block transactions
464
- */
465
- async getBlockTransactionsRaw(requestParameters: GetBlockTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TransactionResults>> {
466
- if (requestParameters.heightOrHash === null || requestParameters.heightOrHash === undefined) {
467
- throw new runtime.RequiredError('heightOrHash','Required parameter requestParameters.heightOrHash was null or undefined when calling getBlockTransactions.');
468
- }
469
-
470
- const queryParameters: any = {};
471
-
472
- const headerParameters: runtime.HTTPHeaders = {};
473
-
474
- const response = await this.request({
475
- path: `/extended/v2/blocks/{height_or_hash}/transactions`.replace(`{${"height_or_hash"}}`, encodeURIComponent(String(requestParameters.heightOrHash))),
476
- method: 'GET',
477
- headers: headerParameters,
478
- query: queryParameters,
479
- }, initOverrides);
480
-
481
- return new runtime.JSONApiResponse(response, (jsonValue) => TransactionResultsFromJSON(jsonValue));
482
- }
483
-
484
- /**
485
- * Retrieves transactions confirmed in a single block
486
- * Get block transactions
487
- */
488
- async getBlockTransactions(requestParameters: GetBlockTransactionsRequest, initOverrides?: RequestInit): Promise<TransactionResults> {
489
- const response = await this.getBlockTransactionsRaw(requestParameters, initOverrides);
490
- return await response.value();
491
- }
492
-
493
- /**
494
- * Retrieves a list of recently mined blocks
495
- * Get blocks
496
- */
497
- async getBlocksRaw(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlockListResponse>> {
498
- const queryParameters: any = {};
499
-
500
- if (requestParameters.limit !== undefined) {
501
- queryParameters['limit'] = requestParameters.limit;
502
- }
503
-
504
- if (requestParameters.offset !== undefined) {
505
- queryParameters['offset'] = requestParameters.offset;
506
- }
507
-
508
- if (requestParameters.burnBlockHash !== undefined) {
509
- queryParameters['burn_block_hash'] = requestParameters.burnBlockHash;
510
- }
511
-
512
- if (requestParameters.burnBlockHeight !== undefined) {
513
- queryParameters['burn_block_height'] = requestParameters.burnBlockHeight;
514
- }
515
-
516
- const headerParameters: runtime.HTTPHeaders = {};
517
-
518
- const response = await this.request({
519
- path: `/extended/v2/blocks`,
520
- method: 'GET',
521
- headers: headerParameters,
522
- query: queryParameters,
523
- }, initOverrides);
524
-
525
- return new runtime.JSONApiResponse(response, (jsonValue) => NakamotoBlockListResponseFromJSON(jsonValue));
526
- }
527
-
528
- /**
529
- * Retrieves a list of recently mined blocks
530
- * Get blocks
531
- */
532
- async getBlocks(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<NakamotoBlockListResponse> {
533
- const response = await this.getBlocksRaw(requestParameters, initOverrides);
534
- return await response.value();
535
- }
536
-
537
- /**
538
- * Retrieves a single burn block
539
- * Get burn block
540
- */
541
- async getBurnBlockRaw(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlock>> {
542
- if (requestParameters.heightOrHash === null || requestParameters.heightOrHash === undefined) {
543
- throw new runtime.RequiredError('heightOrHash','Required parameter requestParameters.heightOrHash was null or undefined when calling getBurnBlock.');
544
- }
545
-
546
- const queryParameters: any = {};
547
-
548
- const headerParameters: runtime.HTTPHeaders = {};
549
-
550
- const response = await this.request({
551
- path: `/extended/v2/burn-blocks/{height_or_hash}`.replace(`{${"height_or_hash"}}`, encodeURIComponent(String(requestParameters.heightOrHash))),
552
- method: 'GET',
553
- headers: headerParameters,
554
- query: queryParameters,
555
- }, initOverrides);
556
-
557
- return new runtime.JSONApiResponse(response, (jsonValue) => BurnBlockFromJSON(jsonValue));
558
- }
559
-
560
- /**
561
- * Retrieves a single burn block
562
- * Get burn block
563
- */
564
- async getBurnBlock(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<BurnBlock> {
565
- const response = await this.getBurnBlockRaw(requestParameters, initOverrides);
566
- return await response.value();
567
- }
568
-
569
- /**
570
- * Retrieves a list of recent burn blocks
571
- * Get burn blocks
572
- */
573
- async getBurnBlocksRaw(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>> {
574
- const queryParameters: any = {};
575
-
576
- if (requestParameters.limit !== undefined) {
577
- queryParameters['limit'] = requestParameters.limit;
578
- }
579
-
580
- if (requestParameters.offset !== undefined) {
581
- queryParameters['offset'] = requestParameters.offset;
582
- }
583
-
584
- const headerParameters: runtime.HTTPHeaders = {};
585
-
586
- const response = await this.request({
587
- path: `/extended/v2/burn-blocks`,
588
- method: 'GET',
589
- headers: headerParameters,
590
- query: queryParameters,
591
- }, initOverrides);
592
-
593
- return new runtime.JSONApiResponse(response, (jsonValue) => BurnBlockListResponseFromJSON(jsonValue));
594
- }
595
-
596
- /**
597
- * Retrieves a list of recent burn blocks
598
- * Get burn blocks
599
- */
600
- async getBurnBlocks(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse> {
601
- const response = await this.getBurnBlocksRaw(requestParameters, initOverrides);
602
- return await response.value();
603
- }
604
-
605
306
  }