@stacks/blockchain-api-client 7.0.0-stacks-2.1.1 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -238,7 +238,7 @@ export interface AccountsApiInterface {
238
238
  */
239
239
  getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
240
240
  /**
241
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
241
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
242
242
  * @summary Get account transaction information for specific transaction
243
243
  * @param {string} principal Stacks address or a contract identifier
244
244
  * @param {string} txId Transaction id
@@ -248,7 +248,7 @@ export interface AccountsApiInterface {
248
248
  */
249
249
  getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
250
250
  /**
251
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
251
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
252
252
  * Get account transaction information for specific transaction
253
253
  */
254
254
  getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -348,12 +348,12 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
348
348
  */
349
349
  getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
350
350
  /**
351
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
351
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
352
352
  * Get account transaction information for specific transaction
353
353
  */
354
354
  getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
355
355
  /**
356
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
356
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
357
357
  * Get account transaction information for specific transaction
358
358
  */
359
359
  getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -348,7 +348,7 @@ class AccountsApi extends runtime.BaseAPI {
348
348
  return await response.value();
349
349
  }
350
350
  /**
351
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
351
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
352
352
  * Get account transaction information for specific transaction
353
353
  */
354
354
  async getSingleTransactionWithTransfersRaw(requestParameters, initOverrides) {
@@ -369,7 +369,7 @@ class AccountsApi extends runtime.BaseAPI {
369
369
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.AddressTransactionWithTransfersFromJSON)(jsonValue));
370
370
  }
371
371
  /**
372
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
372
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
373
373
  * Get account transaction information for specific transaction
374
374
  */
375
375
  async getSingleTransactionWithTransfers(requestParameters, initOverrides) {
@@ -94,7 +94,7 @@ export interface InfoApiInterface {
94
94
  */
95
95
  getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse>;
96
96
  /**
97
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
97
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
98
98
  * @summary Get total and unlocked STX supply
99
99
  * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
100
100
  * @param {*} [options] Override http request option.
@@ -103,7 +103,7 @@ export interface InfoApiInterface {
103
103
  */
104
104
  getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>>;
105
105
  /**
106
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
106
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
107
107
  * Get total and unlocked STX supply
108
108
  */
109
109
  getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>;
@@ -121,7 +121,7 @@ export interface InfoApiInterface {
121
121
  */
122
122
  getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>;
123
123
  /**
124
- * Retrieves the total supply for STX tokens as plain text.
124
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
125
125
  * @summary Get total STX supply in plain text format
126
126
  * @param {*} [options] Override http request option.
127
127
  * @throws {RequiredError}
@@ -129,12 +129,12 @@ export interface InfoApiInterface {
129
129
  */
130
130
  getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
131
131
  /**
132
- * Retrieves the total supply for STX tokens as plain text.
132
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
133
133
  * Get total STX supply in plain text format
134
134
  */
135
135
  getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string>;
136
136
  /**
137
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
137
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
138
138
  * @summary Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
139
139
  * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
140
140
  * @param {*} [options] Override http request option.
@@ -143,7 +143,7 @@ export interface InfoApiInterface {
143
143
  */
144
144
  getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>>;
145
145
  /**
146
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
146
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
147
147
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
148
148
  */
149
149
  getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>;
@@ -203,12 +203,12 @@ export declare class InfoApi extends runtime.BaseAPI implements InfoApiInterface
203
203
  */
204
204
  getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse>;
205
205
  /**
206
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
206
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
207
207
  * Get total and unlocked STX supply
208
208
  */
209
209
  getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>>;
210
210
  /**
211
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
211
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
212
212
  * Get total and unlocked STX supply
213
213
  */
214
214
  getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>;
@@ -223,22 +223,22 @@ export declare class InfoApi extends runtime.BaseAPI implements InfoApiInterface
223
223
  */
224
224
  getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>;
225
225
  /**
226
- * Retrieves the total supply for STX tokens as plain text.
226
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
227
227
  * Get total STX supply in plain text format
228
228
  */
229
229
  getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
230
230
  /**
231
- * Retrieves the total supply for STX tokens as plain text.
231
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
232
232
  * Get total STX supply in plain text format
233
233
  */
234
234
  getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string>;
235
235
  /**
236
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
236
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
237
237
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
238
238
  */
239
239
  getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>>;
240
240
  /**
241
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
241
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
242
242
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
243
243
  */
244
244
  getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>;
@@ -139,7 +139,7 @@ class InfoApi extends runtime.BaseAPI {
139
139
  return await response.value();
140
140
  }
141
141
  /**
142
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
142
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
143
143
  * Get total and unlocked STX supply
144
144
  */
145
145
  async getStxSupplyRaw(requestParameters, initOverrides) {
@@ -157,7 +157,7 @@ class InfoApi extends runtime.BaseAPI {
157
157
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetStxSupplyResponseFromJSON)(jsonValue));
158
158
  }
159
159
  /**
160
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
160
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
161
161
  * Get total and unlocked STX supply
162
162
  */
163
163
  async getStxSupply(requestParameters, initOverrides) {
@@ -188,7 +188,7 @@ class InfoApi extends runtime.BaseAPI {
188
188
  return await response.value();
189
189
  }
190
190
  /**
191
- * Retrieves the total supply for STX tokens as plain text.
191
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
192
192
  * Get total STX supply in plain text format
193
193
  */
194
194
  async getStxSupplyTotalSupplyPlainRaw(initOverrides) {
@@ -203,7 +203,7 @@ class InfoApi extends runtime.BaseAPI {
203
203
  return new runtime.TextApiResponse(response);
204
204
  }
205
205
  /**
206
- * Retrieves the total supply for STX tokens as plain text.
206
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
207
207
  * Get total STX supply in plain text format
208
208
  */
209
209
  async getStxSupplyTotalSupplyPlain(initOverrides) {
@@ -211,7 +211,7 @@ class InfoApi extends runtime.BaseAPI {
211
211
  return await response.value();
212
212
  }
213
213
  /**
214
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
214
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
215
215
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
216
216
  */
217
217
  async getTotalStxSupplyLegacyFormatRaw(requestParameters, initOverrides) {
@@ -229,7 +229,7 @@ class InfoApi extends runtime.BaseAPI {
229
229
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetStxSupplyLegacyFormatResponseFromJSON)(jsonValue));
230
230
  }
231
231
  /**
232
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
232
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
233
233
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
234
234
  */
235
235
  async getTotalStxSupplyLegacyFormat(requestParameters, initOverrides) {
@@ -50,7 +50,7 @@ export interface GetNftMintsRequest {
50
50
  export interface NonFungibleTokensApiInterface {
51
51
  /**
52
52
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
53
- * @summary Non fungible tokens metadata for contract id
53
+ * @summary Non fungible tokens metadata for contract ID
54
54
  * @param {string} contractId token\&#39;s contract id
55
55
  * @param {*} [options] Override http request option.
56
56
  * @throws {RequiredError}
@@ -59,7 +59,7 @@ export interface NonFungibleTokensApiInterface {
59
59
  getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
60
60
  /**
61
61
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
62
- * Non fungible tokens metadata for contract id
62
+ * Non fungible tokens metadata for contract ID
63
63
  */
64
64
  getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
65
65
  /**
@@ -140,12 +140,12 @@ export interface NonFungibleTokensApiInterface {
140
140
  export declare class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungibleTokensApiInterface {
141
141
  /**
142
142
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
143
- * Non fungible tokens metadata for contract id
143
+ * Non fungible tokens metadata for contract ID
144
144
  */
145
145
  getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
146
146
  /**
147
147
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
148
- * Non fungible tokens metadata for contract id
148
+ * Non fungible tokens metadata for contract ID
149
149
  */
150
150
  getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
151
151
  /**
@@ -22,7 +22,7 @@ const models_1 = require("../models");
22
22
  class NonFungibleTokensApi extends runtime.BaseAPI {
23
23
  /**
24
24
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
25
- * Non fungible tokens metadata for contract id
25
+ * Non fungible tokens metadata for contract ID
26
26
  */
27
27
  async getContractNftMetadataRaw(requestParameters, initOverrides) {
28
28
  if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
@@ -40,7 +40,7 @@ class NonFungibleTokensApi extends runtime.BaseAPI {
40
40
  }
41
41
  /**
42
42
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
43
- * Non fungible tokens metadata for contract id
43
+ * Non fungible tokens metadata for contract ID
44
44
  */
45
45
  async getContractNftMetadata(requestParameters, initOverrides) {
46
46
  const response = await this.getContractNftMetadataRaw(requestParameters, initOverrides);
@@ -106,7 +106,7 @@ export interface RosettaApiInterface {
106
106
  */
107
107
  rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
108
108
  /**
109
- * Take unsigned transaction and signature, combine both and return signed transaction
109
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
110
110
  * @summary Create Network Transaction from Signatures
111
111
  * @param {RosettaConstructionCombineRequest} rosettaConstructionCombineRequest
112
112
  * @param {*} [options] Override http request option.
@@ -115,7 +115,7 @@ export interface RosettaApiInterface {
115
115
  */
116
116
  rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>>;
117
117
  /**
118
- * Take unsigned transaction and signature, combine both and return signed transaction
118
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
119
119
  * Create Network Transaction from Signatures
120
120
  */
121
121
  rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
@@ -176,7 +176,7 @@ export interface RosettaApiInterface {
176
176
  */
177
177
  rosettaConstructionParse(requestParameters: RosettaConstructionParseOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionParseResponse>;
178
178
  /**
179
- * Generate and unsigned transaction from operations and metadata
179
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
180
180
  * @summary Generate an Unsigned Transaction and Signing Payloads
181
181
  * @param {RosettaConstructionPayloadsRequest} rosettaConstructionPayloadsRequest
182
182
  * @param {*} [options] Override http request option.
@@ -185,7 +185,7 @@ export interface RosettaApiInterface {
185
185
  */
186
186
  rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>>;
187
187
  /**
188
- * Generate and unsigned transaction from operations and metadata
188
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
189
189
  * Generate an Unsigned Transaction and Signing Payloads
190
190
  */
191
191
  rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse>;
@@ -204,7 +204,7 @@ export interface RosettaApiInterface {
204
204
  */
205
205
  rosettaConstructionPreprocess(requestParameters: RosettaConstructionPreprocessOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPreprocessResponse>;
206
206
  /**
207
- * Submit a pre-signed transaction to the node.
207
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
208
208
  * @summary Submit a Signed Transaction
209
209
  * @param {RosettaConstructionSubmitRequest} rosettaConstructionSubmitRequest
210
210
  * @param {*} [options] Override http request option.
@@ -213,12 +213,12 @@ export interface RosettaApiInterface {
213
213
  */
214
214
  rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>>;
215
215
  /**
216
- * Submit a pre-signed transaction to the node.
216
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
217
217
  * Submit a Signed Transaction
218
218
  */
219
219
  rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
220
220
  /**
221
- * Retrieves a list of transcations currently in the mempool for a given network.
221
+ * Retrieves a list of transactions currently in the mempool for a given network.
222
222
  * @summary Get All Mempool Transactions
223
223
  * @param {RosettaMempoolRequest} rosettaMempoolRequest
224
224
  * @param {*} [options] Override http request option.
@@ -227,7 +227,7 @@ export interface RosettaApiInterface {
227
227
  */
228
228
  rosettaMempoolRaw(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolResponse>>;
229
229
  /**
230
- * Retrieves a list of transcations currently in the mempool for a given network.
230
+ * Retrieves a list of transactions currently in the mempool for a given network.
231
231
  * Get All Mempool Transactions
232
232
  */
233
233
  rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse>;
@@ -322,12 +322,12 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
322
322
  */
323
323
  rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
324
324
  /**
325
- * Take unsigned transaction and signature, combine both and return signed transaction
325
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
326
326
  * Create Network Transaction from Signatures
327
327
  */
328
328
  rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>>;
329
329
  /**
330
- * Take unsigned transaction and signature, combine both and return signed transaction
330
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
331
331
  * Create Network Transaction from Signatures
332
332
  */
333
333
  rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
@@ -372,12 +372,12 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
372
372
  */
373
373
  rosettaConstructionParse(requestParameters: RosettaConstructionParseOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionParseResponse>;
374
374
  /**
375
- * Generate and unsigned transaction from operations and metadata
375
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
376
376
  * Generate an Unsigned Transaction and Signing Payloads
377
377
  */
378
378
  rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>>;
379
379
  /**
380
- * Generate and unsigned transaction from operations and metadata
380
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
381
381
  * Generate an Unsigned Transaction and Signing Payloads
382
382
  */
383
383
  rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse>;
@@ -392,22 +392,22 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
392
392
  */
393
393
  rosettaConstructionPreprocess(requestParameters: RosettaConstructionPreprocessOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPreprocessResponse>;
394
394
  /**
395
- * Submit a pre-signed transaction to the node.
395
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
396
396
  * Submit a Signed Transaction
397
397
  */
398
398
  rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>>;
399
399
  /**
400
- * Submit a pre-signed transaction to the node.
400
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
401
401
  * Submit a Signed Transaction
402
402
  */
403
403
  rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
404
404
  /**
405
- * Retrieves a list of transcations currently in the mempool for a given network.
405
+ * Retrieves a list of transactions currently in the mempool for a given network.
406
406
  * Get All Mempool Transactions
407
407
  */
408
408
  rosettaMempoolRaw(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolResponse>>;
409
409
  /**
410
- * Retrieves a list of transcations currently in the mempool for a given network.
410
+ * Retrieves a list of transactions currently in the mempool for a given network.
411
411
  * Get All Mempool Transactions
412
412
  */
413
413
  rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse>;
@@ -105,7 +105,7 @@ class RosettaApi extends runtime.BaseAPI {
105
105
  return await response.value();
106
106
  }
107
107
  /**
108
- * Take unsigned transaction and signature, combine both and return signed transaction
108
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
109
109
  * Create Network Transaction from Signatures
110
110
  */
111
111
  async rosettaConstructionCombineRaw(requestParameters, initOverrides) {
@@ -125,7 +125,7 @@ class RosettaApi extends runtime.BaseAPI {
125
125
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.RosettaConstructionCombineResponseFromJSON)(jsonValue));
126
126
  }
127
127
  /**
128
- * Take unsigned transaction and signature, combine both and return signed transaction
128
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
129
129
  * Create Network Transaction from Signatures
130
130
  */
131
131
  async rosettaConstructionCombine(requestParameters, initOverrides) {
@@ -245,7 +245,7 @@ class RosettaApi extends runtime.BaseAPI {
245
245
  return await response.value();
246
246
  }
247
247
  /**
248
- * Generate and unsigned transaction from operations and metadata
248
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
249
249
  * Generate an Unsigned Transaction and Signing Payloads
250
250
  */
251
251
  async rosettaConstructionPayloadsRaw(requestParameters, initOverrides) {
@@ -265,7 +265,7 @@ class RosettaApi extends runtime.BaseAPI {
265
265
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.RosettaConstructionPayloadResponseFromJSON)(jsonValue));
266
266
  }
267
267
  /**
268
- * Generate and unsigned transaction from operations and metadata
268
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
269
269
  * Generate an Unsigned Transaction and Signing Payloads
270
270
  */
271
271
  async rosettaConstructionPayloads(requestParameters, initOverrides) {
@@ -301,7 +301,7 @@ class RosettaApi extends runtime.BaseAPI {
301
301
  return await response.value();
302
302
  }
303
303
  /**
304
- * Submit a pre-signed transaction to the node.
304
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
305
305
  * Submit a Signed Transaction
306
306
  */
307
307
  async rosettaConstructionSubmitRaw(requestParameters, initOverrides) {
@@ -321,7 +321,7 @@ class RosettaApi extends runtime.BaseAPI {
321
321
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.RosettaConstructionSubmitResponseFromJSON)(jsonValue));
322
322
  }
323
323
  /**
324
- * Submit a pre-signed transaction to the node.
324
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
325
325
  * Submit a Signed Transaction
326
326
  */
327
327
  async rosettaConstructionSubmit(requestParameters, initOverrides) {
@@ -329,7 +329,7 @@ class RosettaApi extends runtime.BaseAPI {
329
329
  return await response.value();
330
330
  }
331
331
  /**
332
- * Retrieves a list of transcations currently in the mempool for a given network.
332
+ * Retrieves a list of transactions currently in the mempool for a given network.
333
333
  * Get All Mempool Transactions
334
334
  */
335
335
  async rosettaMempoolRaw(requestParameters, initOverrides) {
@@ -349,7 +349,7 @@ class RosettaApi extends runtime.BaseAPI {
349
349
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.RosettaMempoolResponseFromJSON)(jsonValue));
350
350
  }
351
351
  /**
352
- * Retrieves a list of transcations currently in the mempool for a given network.
352
+ * Retrieves a list of transactions currently in the mempool for a given network.
353
353
  * Get All Mempool Transactions
354
354
  */
355
355
  async rosettaMempool(requestParameters, initOverrides) {
package/lib/index.umd.js CHANGED
@@ -6950,7 +6950,7 @@
6950
6950
  }
6951
6951
  }
6952
6952
  /**
6953
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
6953
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
6954
6954
  * Get account transaction information for specific transaction
6955
6955
  */
6956
6956
  ;
@@ -6984,7 +6984,7 @@
6984
6984
  }
6985
6985
  }
6986
6986
  /**
6987
- * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
6987
+ * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
6988
6988
  * Get account transaction information for specific transaction
6989
6989
  */
6990
6990
  ;
@@ -7881,7 +7881,7 @@
7881
7881
  }
7882
7882
  }
7883
7883
  /**
7884
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
7884
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
7885
7885
  * Get total and unlocked STX supply
7886
7886
  */
7887
7887
  ;
@@ -7912,7 +7912,7 @@
7912
7912
  }
7913
7913
  }
7914
7914
  /**
7915
- * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
7915
+ * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** this uses the estimated future total supply for the year 2050.
7916
7916
  * Get total and unlocked STX supply
7917
7917
  */
7918
7918
  ;
@@ -7970,7 +7970,7 @@
7970
7970
  }
7971
7971
  }
7972
7972
  /**
7973
- * Retrieves the total supply for STX tokens as plain text.
7973
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
7974
7974
  * Get total STX supply in plain text format
7975
7975
  */
7976
7976
  ;
@@ -7994,7 +7994,7 @@
7994
7994
  }
7995
7995
  }
7996
7996
  /**
7997
- * Retrieves the total supply for STX tokens as plain text.
7997
+ * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050.
7998
7998
  * Get total STX supply in plain text format
7999
7999
  */
8000
8000
  ;
@@ -8011,7 +8011,7 @@
8011
8011
  }
8012
8012
  }
8013
8013
  /**
8014
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
8014
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
8015
8015
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
8016
8016
  */
8017
8017
  ;
@@ -8042,7 +8042,7 @@
8042
8042
  }
8043
8043
  }
8044
8044
  /**
8045
- * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
8045
+ * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050.
8046
8046
  * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
8047
8047
  */
8048
8048
  ;
@@ -8730,7 +8730,7 @@
8730
8730
 
8731
8731
  /**
8732
8732
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
8733
- * Non fungible tokens metadata for contract id
8733
+ * Non fungible tokens metadata for contract ID
8734
8734
  */
8735
8735
  _proto.getContractNftMetadataRaw = function getContractNftMetadataRaw(requestParameters, initOverrides) {
8736
8736
  try {
@@ -8758,7 +8758,7 @@
8758
8758
  }
8759
8759
  /**
8760
8760
  * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
8761
- * Non fungible tokens metadata for contract id
8761
+ * Non fungible tokens metadata for contract ID
8762
8762
  */
8763
8763
  ;
8764
8764
 
@@ -9204,7 +9204,7 @@
9204
9204
  }
9205
9205
  }
9206
9206
  /**
9207
- * Take unsigned transaction and signature, combine both and return signed transaction
9207
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
9208
9208
  * Create Network Transaction from Signatures
9209
9209
  */
9210
9210
  ;
@@ -9236,7 +9236,7 @@
9236
9236
  }
9237
9237
  }
9238
9238
  /**
9239
- * Take unsigned transaction and signature, combine both and return signed transaction
9239
+ * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
9240
9240
  * Create Network Transaction from Signatures
9241
9241
  */
9242
9242
  ;
@@ -9449,7 +9449,7 @@
9449
9449
  }
9450
9450
  }
9451
9451
  /**
9452
- * Generate and unsigned transaction from operations and metadata
9452
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
9453
9453
  * Generate an Unsigned Transaction and Signing Payloads
9454
9454
  */
9455
9455
  ;
@@ -9481,7 +9481,7 @@
9481
9481
  }
9482
9482
  }
9483
9483
  /**
9484
- * Generate and unsigned transaction from operations and metadata
9484
+ * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
9485
9485
  * Generate an Unsigned Transaction and Signing Payloads
9486
9486
  */
9487
9487
  ;
@@ -9547,7 +9547,7 @@
9547
9547
  }
9548
9548
  }
9549
9549
  /**
9550
- * Submit a pre-signed transaction to the node.
9550
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
9551
9551
  * Submit a Signed Transaction
9552
9552
  */
9553
9553
  ;
@@ -9579,7 +9579,7 @@
9579
9579
  }
9580
9580
  }
9581
9581
  /**
9582
- * Submit a pre-signed transaction to the node.
9582
+ * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
9583
9583
  * Submit a Signed Transaction
9584
9584
  */
9585
9585
  ;
@@ -9596,7 +9596,7 @@
9596
9596
  }
9597
9597
  }
9598
9598
  /**
9599
- * Retrieves a list of transcations currently in the mempool for a given network.
9599
+ * Retrieves a list of transactions currently in the mempool for a given network.
9600
9600
  * Get All Mempool Transactions
9601
9601
  */
9602
9602
  ;
@@ -9628,7 +9628,7 @@
9628
9628
  }
9629
9629
  }
9630
9630
  /**
9631
- * Retrieves a list of transcations currently in the mempool for a given network.
9631
+ * Retrieves a list of transactions currently in the mempool for a given network.
9632
9632
  * Get All Mempool Transactions
9633
9633
  */
9634
9634
  ;