@shapeshiftoss/unchained-client 8.4.0 → 9.0.0-alpha.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.
@@ -131,313 +131,313 @@ export interface BitcoinAddress {
131
131
  */
132
132
  'pubkey': string;
133
133
  }
134
- /**
135
- * Contains info about a Bitcoin transaction
136
- * @export
137
- * @interface BitcoinTx
138
- */
139
- export interface BitcoinTx {
140
- /**
141
- *
142
- * @type {string}
143
- * @memberof BitcoinTx
144
- */
145
- 'txid': string;
146
- /**
147
- *
148
- * @type {string}
149
- * @memberof BitcoinTx
150
- */
151
- 'blockHash'?: string;
152
- /**
153
- *
154
- * @type {number}
155
- * @memberof BitcoinTx
156
- */
157
- 'blockHeight'?: number;
158
- /**
159
- *
160
- * @type {number}
161
- * @memberof BitcoinTx
162
- */
163
- 'timestamp'?: number;
164
- /**
165
- *
166
- * @type {Array<Vin>}
167
- * @memberof BitcoinTx
168
- */
169
- 'vin': Array<Vin>;
170
- /**
171
- *
172
- * @type {Array<Vout>}
173
- * @memberof BitcoinTx
174
- */
175
- 'vout': Array<Vout>;
176
- /**
177
- *
178
- * @type {number}
179
- * @memberof BitcoinTx
180
- */
181
- 'confirmations': number;
182
- /**
183
- *
184
- * @type {string}
185
- * @memberof BitcoinTx
186
- */
187
- 'value': string;
188
- /**
189
- *
190
- * @type {string}
191
- * @memberof BitcoinTx
192
- */
193
- 'fee': string;
194
- /**
195
- *
196
- * @type {string}
197
- * @memberof BitcoinTx
198
- */
199
- 'hex': string;
200
- }
201
- /**
202
- * Contains info about Bitcoin transaction history
203
- * @export
204
- * @interface BitcoinTxHistory
205
- */
206
- export interface BitcoinTxHistory {
207
- /**
208
- *
209
- * @type {string}
210
- * @memberof BitcoinTxHistory
211
- */
212
- 'cursor'?: string;
213
- /**
214
- *
215
- * @type {string}
216
- * @memberof BitcoinTxHistory
217
- */
218
- 'pubkey': string;
219
- /**
220
- *
221
- * @type {Array<BitcoinTx>}
222
- * @memberof BitcoinTxHistory
223
- */
224
- 'txs': Array<BitcoinTx>;
225
- }
226
134
  /**
227
135
  * Contains Bitcoin specific transaction info as returned from the node
228
136
  * @export
229
- * @interface BitcoinTxSpecific
137
+ * @interface BitcoinRawTx
230
138
  */
231
- export interface BitcoinTxSpecific {
139
+ export interface BitcoinRawTx {
232
140
  /**
233
141
  *
234
142
  * @type {string}
235
- * @memberof BitcoinTxSpecific
143
+ * @memberof BitcoinRawTx
236
144
  */
237
145
  'txid': string;
238
146
  /**
239
147
  *
240
148
  * @type {string}
241
- * @memberof BitcoinTxSpecific
149
+ * @memberof BitcoinRawTx
242
150
  */
243
151
  'hash': string;
244
152
  /**
245
153
  *
246
154
  * @type {number}
247
- * @memberof BitcoinTxSpecific
155
+ * @memberof BitcoinRawTx
248
156
  */
249
157
  'version': number;
250
158
  /**
251
159
  *
252
160
  * @type {number}
253
- * @memberof BitcoinTxSpecific
161
+ * @memberof BitcoinRawTx
254
162
  */
255
163
  'size': number;
256
164
  /**
257
165
  *
258
166
  * @type {number}
259
- * @memberof BitcoinTxSpecific
167
+ * @memberof BitcoinRawTx
260
168
  */
261
169
  'vsize': number;
262
170
  /**
263
171
  *
264
172
  * @type {number}
265
- * @memberof BitcoinTxSpecific
173
+ * @memberof BitcoinRawTx
266
174
  */
267
175
  'weight': number;
268
176
  /**
269
177
  *
270
178
  * @type {number}
271
- * @memberof BitcoinTxSpecific
179
+ * @memberof BitcoinRawTx
272
180
  */
273
181
  'locktime': number;
274
182
  /**
275
183
  *
276
- * @type {Array<BitcoinTxSpecificVin>}
277
- * @memberof BitcoinTxSpecific
184
+ * @type {Array<BitcoinRawTxVin>}
185
+ * @memberof BitcoinRawTx
278
186
  */
279
- 'vin': Array<BitcoinTxSpecificVin>;
187
+ 'vin': Array<BitcoinRawTxVin>;
280
188
  /**
281
189
  *
282
- * @type {Array<BitcoinTxSpecificVout>}
283
- * @memberof BitcoinTxSpecific
190
+ * @type {Array<BitcoinRawTxVout>}
191
+ * @memberof BitcoinRawTx
284
192
  */
285
- 'vout': Array<BitcoinTxSpecificVout>;
193
+ 'vout': Array<BitcoinRawTxVout>;
286
194
  /**
287
195
  *
288
196
  * @type {string}
289
- * @memberof BitcoinTxSpecific
197
+ * @memberof BitcoinRawTx
290
198
  */
291
199
  'hex': string;
292
200
  /**
293
201
  *
294
202
  * @type {string}
295
- * @memberof BitcoinTxSpecific
203
+ * @memberof BitcoinRawTx
296
204
  */
297
205
  'blockhash': string;
298
206
  /**
299
207
  *
300
208
  * @type {number}
301
- * @memberof BitcoinTxSpecific
209
+ * @memberof BitcoinRawTx
302
210
  */
303
211
  'confirmations': number;
304
212
  /**
305
213
  *
306
214
  * @type {number}
307
- * @memberof BitcoinTxSpecific
215
+ * @memberof BitcoinRawTx
308
216
  */
309
217
  'time': number;
310
218
  /**
311
219
  *
312
220
  * @type {number}
313
- * @memberof BitcoinTxSpecific
221
+ * @memberof BitcoinRawTx
314
222
  */
315
223
  'blocktime': number;
316
224
  }
317
225
  /**
318
226
  *
319
227
  * @export
320
- * @interface BitcoinTxSpecificScriptPubKey
228
+ * @interface BitcoinRawTxScriptPubKey
321
229
  */
322
- export interface BitcoinTxSpecificScriptPubKey {
230
+ export interface BitcoinRawTxScriptPubKey {
323
231
  /**
324
232
  *
325
233
  * @type {Array<string>}
326
- * @memberof BitcoinTxSpecificScriptPubKey
234
+ * @memberof BitcoinRawTxScriptPubKey
327
235
  */
328
236
  'addresses': Array<string>;
329
237
  /**
330
238
  *
331
239
  * @type {string}
332
- * @memberof BitcoinTxSpecificScriptPubKey
240
+ * @memberof BitcoinRawTxScriptPubKey
333
241
  */
334
242
  'type': string;
335
243
  /**
336
244
  *
337
245
  * @type {number}
338
- * @memberof BitcoinTxSpecificScriptPubKey
246
+ * @memberof BitcoinRawTxScriptPubKey
339
247
  */
340
248
  'reqSigs': number;
341
249
  /**
342
250
  *
343
251
  * @type {string}
344
- * @memberof BitcoinTxSpecificScriptPubKey
252
+ * @memberof BitcoinRawTxScriptPubKey
345
253
  */
346
254
  'hex': string;
347
255
  /**
348
256
  *
349
257
  * @type {string}
350
- * @memberof BitcoinTxSpecificScriptPubKey
258
+ * @memberof BitcoinRawTxScriptPubKey
351
259
  */
352
260
  'asm': string;
353
261
  }
354
262
  /**
355
263
  *
356
264
  * @export
357
- * @interface BitcoinTxSpecificScriptSig
265
+ * @interface BitcoinRawTxScriptSig
358
266
  */
359
- export interface BitcoinTxSpecificScriptSig {
267
+ export interface BitcoinRawTxScriptSig {
360
268
  /**
361
269
  *
362
270
  * @type {string}
363
- * @memberof BitcoinTxSpecificScriptSig
271
+ * @memberof BitcoinRawTxScriptSig
364
272
  */
365
273
  'hex': string;
366
274
  /**
367
275
  *
368
276
  * @type {string}
369
- * @memberof BitcoinTxSpecificScriptSig
277
+ * @memberof BitcoinRawTxScriptSig
370
278
  */
371
279
  'asm': string;
372
280
  }
373
281
  /**
374
282
  *
375
283
  * @export
376
- * @interface BitcoinTxSpecificVin
284
+ * @interface BitcoinRawTxVin
377
285
  */
378
- export interface BitcoinTxSpecificVin {
286
+ export interface BitcoinRawTxVin {
379
287
  /**
380
288
  *
381
289
  * @type {string}
382
- * @memberof BitcoinTxSpecificVin
290
+ * @memberof BitcoinRawTxVin
383
291
  */
384
292
  'txinwitness'?: string;
385
293
  /**
386
294
  *
387
- * @type {BitcoinTxSpecificScriptSig}
388
- * @memberof BitcoinTxSpecificVin
295
+ * @type {BitcoinRawTxScriptSig}
296
+ * @memberof BitcoinRawTxVin
389
297
  */
390
- 'scriptSig'?: BitcoinTxSpecificScriptSig;
298
+ 'scriptSig'?: BitcoinRawTxScriptSig;
391
299
  /**
392
300
  *
393
301
  * @type {string}
394
- * @memberof BitcoinTxSpecificVin
302
+ * @memberof BitcoinRawTxVin
395
303
  */
396
304
  'coinbase'?: string;
397
305
  /**
398
306
  *
399
307
  * @type {number}
400
- * @memberof BitcoinTxSpecificVin
308
+ * @memberof BitcoinRawTxVin
401
309
  */
402
310
  'sequence'?: number;
403
311
  /**
404
312
  *
405
313
  * @type {number}
406
- * @memberof BitcoinTxSpecificVin
314
+ * @memberof BitcoinRawTxVin
407
315
  */
408
316
  'vout'?: number;
409
317
  /**
410
318
  *
411
319
  * @type {string}
412
- * @memberof BitcoinTxSpecificVin
320
+ * @memberof BitcoinRawTxVin
413
321
  */
414
322
  'txid'?: string;
415
323
  }
416
324
  /**
417
325
  *
418
326
  * @export
419
- * @interface BitcoinTxSpecificVout
327
+ * @interface BitcoinRawTxVout
420
328
  */
421
- export interface BitcoinTxSpecificVout {
329
+ export interface BitcoinRawTxVout {
422
330
  /**
423
331
  *
424
- * @type {BitcoinTxSpecificScriptPubKey}
425
- * @memberof BitcoinTxSpecificVout
332
+ * @type {BitcoinRawTxScriptPubKey}
333
+ * @memberof BitcoinRawTxVout
426
334
  */
427
- 'scriptPubKey'?: BitcoinTxSpecificScriptPubKey;
335
+ 'scriptPubKey'?: BitcoinRawTxScriptPubKey;
428
336
  /**
429
337
  *
430
338
  * @type {number}
431
- * @memberof BitcoinTxSpecificVout
339
+ * @memberof BitcoinRawTxVout
432
340
  */
433
341
  'n'?: number;
434
342
  /**
435
343
  *
436
344
  * @type {string | number}
437
- * @memberof BitcoinTxSpecificVout
345
+ * @memberof BitcoinRawTxVout
438
346
  */
439
347
  'value'?: string | number;
440
348
  }
349
+ /**
350
+ * Contains info about a Bitcoin transaction
351
+ * @export
352
+ * @interface BitcoinTx
353
+ */
354
+ export interface BitcoinTx {
355
+ /**
356
+ *
357
+ * @type {string}
358
+ * @memberof BitcoinTx
359
+ */
360
+ 'txid': string;
361
+ /**
362
+ *
363
+ * @type {string}
364
+ * @memberof BitcoinTx
365
+ */
366
+ 'blockHash'?: string;
367
+ /**
368
+ *
369
+ * @type {number}
370
+ * @memberof BitcoinTx
371
+ */
372
+ 'blockHeight': number;
373
+ /**
374
+ *
375
+ * @type {number}
376
+ * @memberof BitcoinTx
377
+ */
378
+ 'timestamp': number;
379
+ /**
380
+ *
381
+ * @type {Array<Vin>}
382
+ * @memberof BitcoinTx
383
+ */
384
+ 'vin': Array<Vin>;
385
+ /**
386
+ *
387
+ * @type {Array<Vout>}
388
+ * @memberof BitcoinTx
389
+ */
390
+ 'vout': Array<Vout>;
391
+ /**
392
+ *
393
+ * @type {number}
394
+ * @memberof BitcoinTx
395
+ */
396
+ 'confirmations': number;
397
+ /**
398
+ *
399
+ * @type {string}
400
+ * @memberof BitcoinTx
401
+ */
402
+ 'value': string;
403
+ /**
404
+ *
405
+ * @type {string}
406
+ * @memberof BitcoinTx
407
+ */
408
+ 'fee': string;
409
+ /**
410
+ *
411
+ * @type {string}
412
+ * @memberof BitcoinTx
413
+ */
414
+ 'hex': string;
415
+ }
416
+ /**
417
+ * Contains info about Bitcoin transaction history
418
+ * @export
419
+ * @interface BitcoinTxHistory
420
+ */
421
+ export interface BitcoinTxHistory {
422
+ /**
423
+ *
424
+ * @type {string}
425
+ * @memberof BitcoinTxHistory
426
+ */
427
+ 'cursor'?: string;
428
+ /**
429
+ *
430
+ * @type {string}
431
+ * @memberof BitcoinTxHistory
432
+ */
433
+ 'pubkey': string;
434
+ /**
435
+ *
436
+ * @type {Array<BitcoinTx>}
437
+ * @memberof BitcoinTxHistory
438
+ */
439
+ 'txs': Array<BitcoinTx>;
440
+ }
441
441
  /**
442
442
  * Contains info about the running coinstack
443
443
  * @export
@@ -500,13 +500,13 @@ export interface Tx {
500
500
  * @type {number}
501
501
  * @memberof Tx
502
502
  */
503
- 'blockHeight'?: number;
503
+ 'blockHeight': number;
504
504
  /**
505
505
  *
506
506
  * @type {number}
507
507
  * @memberof Tx
508
508
  */
509
- 'timestamp'?: number;
509
+ 'timestamp': number;
510
510
  }
511
511
  /**
512
512
  * Contains info about an unspent transaction output
@@ -605,13 +605,13 @@ export interface Vin {
605
605
  * @type {string}
606
606
  * @memberof Vin
607
607
  */
608
- 'txid': string;
608
+ 'txid'?: string;
609
609
  /**
610
610
  *
611
611
  * @type {string}
612
612
  * @memberof Vin
613
613
  */
614
- 'vout': string;
614
+ 'vout'?: string;
615
615
  /**
616
616
  *
617
617
  * @type {number}
@@ -629,13 +629,19 @@ export interface Vin {
629
629
  * @type {VinScriptSig}
630
630
  * @memberof Vin
631
631
  */
632
- 'scriptSig': VinScriptSig;
632
+ 'scriptSig'?: VinScriptSig;
633
633
  /**
634
634
  *
635
635
  * @type {Array<string>}
636
636
  * @memberof Vin
637
637
  */
638
- 'addresses': Array<string>;
638
+ 'addresses'?: Array<string>;
639
+ /**
640
+ *
641
+ * @type {string}
642
+ * @memberof Vin
643
+ */
644
+ 'value'?: string;
639
645
  }
640
646
  /**
641
647
  *
@@ -649,12 +655,6 @@ export interface VinScriptSig {
649
655
  * @memberof VinScriptSig
650
656
  */
651
657
  'hex'?: string;
652
- /**
653
- *
654
- * @type {string}
655
- * @memberof VinScriptSig
656
- */
657
- 'asm'?: string;
658
658
  }
659
659
  /**
660
660
  * Contains info about a Bitcoin transaction output
@@ -664,53 +664,34 @@ export interface VinScriptSig {
664
664
  export interface Vout {
665
665
  /**
666
666
  *
667
- * @type {string | number}
667
+ * @type {string}
668
668
  * @memberof Vout
669
669
  */
670
- 'value': string | number;
670
+ 'value': string;
671
671
  /**
672
672
  *
673
673
  * @type {number}
674
674
  * @memberof Vout
675
675
  */
676
676
  'n': number;
677
- /**
678
- *
679
- * @type {VoutScriptPubKey}
680
- * @memberof Vout
681
- */
682
- 'scriptPubKey': VoutScriptPubKey;
683
- }
684
- /**
685
- *
686
- * @export
687
- * @interface VoutScriptPubKey
688
- */
689
- export interface VoutScriptPubKey {
690
- /**
691
- *
692
- * @type {Array<string>}
693
- * @memberof VoutScriptPubKey
694
- */
695
- 'addresses': Array<string>;
696
677
  /**
697
678
  *
698
679
  * @type {string}
699
- * @memberof VoutScriptPubKey
680
+ * @memberof Vout
700
681
  */
701
- 'type'?: string;
682
+ 'opReturn'?: string;
702
683
  /**
703
684
  *
704
- * @type {string}
705
- * @memberof VoutScriptPubKey
685
+ * @type {VinScriptSig}
686
+ * @memberof Vout
706
687
  */
707
- 'hex'?: string;
688
+ 'scriptPubKey': VinScriptSig;
708
689
  /**
709
690
  *
710
- * @type {string}
711
- * @memberof VoutScriptPubKey
691
+ * @type {Array<string>}
692
+ * @memberof Vout
712
693
  */
713
- 'asm'?: string;
694
+ 'addresses'?: Array<string>;
714
695
  }
715
696
  /**
716
697
  * V1Api - axios parameter creator
@@ -737,7 +718,14 @@ export declare const V1ApiAxiosParamCreator: (configuration?: Configuration | un
737
718
  */
738
719
  getNetworkFees: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
739
720
  /**
740
- * Get transaction specific data directly from the node
721
+ * Get raw transaction details directly from the node
722
+ * @param {string} txid transaction hash
723
+ * @param {*} [options] Override http request option.
724
+ * @throws {RequiredError}
725
+ */
726
+ getRawTransaction: (txid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
727
+ /**
728
+ * Get transaction details
741
729
  * @param {string} txid transaction hash
742
730
  * @param {*} [options] Override http request option.
743
731
  * @throws {RequiredError}
@@ -792,12 +780,19 @@ export declare const V1ApiFp: (configuration?: Configuration | undefined) => {
792
780
  */
793
781
  getNetworkFees(options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<BTCNetworkFees>>;
794
782
  /**
795
- * Get transaction specific data directly from the node
783
+ * Get raw transaction details directly from the node
796
784
  * @param {string} txid transaction hash
797
785
  * @param {*} [options] Override http request option.
798
786
  * @throws {RequiredError}
799
787
  */
800
- getTransaction(txid: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<BitcoinTxSpecific>>;
788
+ getRawTransaction(txid: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<BitcoinRawTx>>;
789
+ /**
790
+ * Get transaction details
791
+ * @param {string} txid transaction hash
792
+ * @param {*} [options] Override http request option.
793
+ * @throws {RequiredError}
794
+ */
795
+ getTransaction(txid: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<BitcoinTx>>;
801
796
  /**
802
797
  * Get transaction history by address or xpub
803
798
  * @param {string} pubkey account address or xpub
@@ -847,12 +842,19 @@ export declare const V1ApiFactory: (configuration?: Configuration | undefined, b
847
842
  */
848
843
  getNetworkFees(options?: any): AxiosPromise<BTCNetworkFees>;
849
844
  /**
850
- * Get transaction specific data directly from the node
845
+ * Get raw transaction details directly from the node
846
+ * @param {string} txid transaction hash
847
+ * @param {*} [options] Override http request option.
848
+ * @throws {RequiredError}
849
+ */
850
+ getRawTransaction(txid: string, options?: any): AxiosPromise<BitcoinRawTx>;
851
+ /**
852
+ * Get transaction details
851
853
  * @param {string} txid transaction hash
852
854
  * @param {*} [options] Override http request option.
853
855
  * @throws {RequiredError}
854
856
  */
855
- getTransaction(txid: string, options?: any): AxiosPromise<BitcoinTxSpecific>;
857
+ getTransaction(txid: string, options?: any): AxiosPromise<BitcoinTx>;
856
858
  /**
857
859
  * Get transaction history by address or xpub
858
860
  * @param {string} pubkey account address or xpub
@@ -890,6 +892,19 @@ export interface V1ApiGetAccountRequest {
890
892
  */
891
893
  readonly pubkey: string;
892
894
  }
895
+ /**
896
+ * Request parameters for getRawTransaction operation in V1Api.
897
+ * @export
898
+ * @interface V1ApiGetRawTransactionRequest
899
+ */
900
+ export interface V1ApiGetRawTransactionRequest {
901
+ /**
902
+ * transaction hash
903
+ * @type {string}
904
+ * @memberof V1ApiGetRawTransaction
905
+ */
906
+ readonly txid: string;
907
+ }
893
908
  /**
894
909
  * Request parameters for getTransaction operation in V1Api.
895
910
  * @export
@@ -984,13 +999,21 @@ export declare class V1Api extends BaseAPI {
984
999
  */
985
1000
  getNetworkFees(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BTCNetworkFees, any>>;
986
1001
  /**
987
- * Get transaction specific data directly from the node
1002
+ * Get raw transaction details directly from the node
1003
+ * @param {V1ApiGetRawTransactionRequest} requestParameters Request parameters.
1004
+ * @param {*} [options] Override http request option.
1005
+ * @throws {RequiredError}
1006
+ * @memberof V1Api
1007
+ */
1008
+ getRawTransaction(requestParameters: V1ApiGetRawTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BitcoinRawTx, any>>;
1009
+ /**
1010
+ * Get transaction details
988
1011
  * @param {V1ApiGetTransactionRequest} requestParameters Request parameters.
989
1012
  * @param {*} [options] Override http request option.
990
1013
  * @throws {RequiredError}
991
1014
  * @memberof V1Api
992
1015
  */
993
- getTransaction(requestParameters: V1ApiGetTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BitcoinTxSpecific, any>>;
1016
+ getTransaction(requestParameters: V1ApiGetTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BitcoinTx, any>>;
994
1017
  /**
995
1018
  * Get transaction history by address or xpub
996
1019
  * @param {V1ApiGetTxHistoryRequest} requestParameters Request parameters.