@stacks/blockchain-api-client 4.1.2 → 5.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "4.1.2",
3
+ "version": "5.0.0-beta.3",
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",
@@ -229,7 +229,7 @@ export interface RosettaApiInterface {
229
229
  rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
230
230
 
231
231
  /**
232
- * Take unsigned transaction and signature, combine both and return signed transaction
232
+ * 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.
233
233
  * @summary Create Network Transaction from Signatures
234
234
  * @param {RosettaConstructionCombineRequest} rosettaConstructionCombineRequest
235
235
  * @param {*} [options] Override http request option.
@@ -239,7 +239,7 @@ export interface RosettaApiInterface {
239
239
  rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>>;
240
240
 
241
241
  /**
242
- * Take unsigned transaction and signature, combine both and return signed transaction
242
+ * 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.
243
243
  * Create Network Transaction from Signatures
244
244
  */
245
245
  rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
@@ -309,7 +309,7 @@ export interface RosettaApiInterface {
309
309
  rosettaConstructionParse(requestParameters: RosettaConstructionParseOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionParseResponse>;
310
310
 
311
311
  /**
312
- * Generate and unsigned transaction from operations and metadata
312
+ * 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.
313
313
  * @summary Generate an Unsigned Transaction and Signing Payloads
314
314
  * @param {RosettaConstructionPayloadsRequest} rosettaConstructionPayloadsRequest
315
315
  * @param {*} [options] Override http request option.
@@ -319,7 +319,7 @@ export interface RosettaApiInterface {
319
319
  rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>>;
320
320
 
321
321
  /**
322
- * Generate and unsigned transaction from operations and metadata
322
+ * 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.
323
323
  * Generate an Unsigned Transaction and Signing Payloads
324
324
  */
325
325
  rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse>;
@@ -341,7 +341,7 @@ export interface RosettaApiInterface {
341
341
  rosettaConstructionPreprocess(requestParameters: RosettaConstructionPreprocessOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPreprocessResponse>;
342
342
 
343
343
  /**
344
- * Submit a pre-signed transaction to the node.
344
+ * 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.
345
345
  * @summary Submit a Signed Transaction
346
346
  * @param {RosettaConstructionSubmitRequest} rosettaConstructionSubmitRequest
347
347
  * @param {*} [options] Override http request option.
@@ -351,7 +351,7 @@ export interface RosettaApiInterface {
351
351
  rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>>;
352
352
 
353
353
  /**
354
- * Submit a pre-signed transaction to the node.
354
+ * 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.
355
355
  * Submit a Signed Transaction
356
356
  */
357
357
  rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
@@ -548,7 +548,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
548
548
  }
549
549
 
550
550
  /**
551
- * Take unsigned transaction and signature, combine both and return signed transaction
551
+ * 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.
552
552
  * Create Network Transaction from Signatures
553
553
  */
554
554
  async rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>> {
@@ -574,7 +574,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
574
574
  }
575
575
 
576
576
  /**
577
- * Take unsigned transaction and signature, combine both and return signed transaction
577
+ * 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.
578
578
  * Create Network Transaction from Signatures
579
579
  */
580
580
  async rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse> {
@@ -723,7 +723,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
723
723
  }
724
724
 
725
725
  /**
726
- * Generate and unsigned transaction from operations and metadata
726
+ * 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.
727
727
  * Generate an Unsigned Transaction and Signing Payloads
728
728
  */
729
729
  async rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>> {
@@ -749,7 +749,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
749
749
  }
750
750
 
751
751
  /**
752
- * Generate and unsigned transaction from operations and metadata
752
+ * 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.
753
753
  * Generate an Unsigned Transaction and Signing Payloads
754
754
  */
755
755
  async rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse> {
@@ -793,7 +793,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
793
793
  }
794
794
 
795
795
  /**
796
- * Submit a pre-signed transaction to the node.
796
+ * 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.
797
797
  * Submit a Signed Transaction
798
798
  */
799
799
  async rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>> {
@@ -819,7 +819,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
819
819
  }
820
820
 
821
821
  /**
822
- * Submit a pre-signed transaction to the node.
822
+ * 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.
823
823
  * Submit a Signed Transaction
824
824
  */
825
825
  async rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse> {