@bsv/wallet-toolbox 1.1.55 → 1.1.57

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 (48) hide show
  1. package/docs/client.md +204 -87
  2. package/docs/services.md +92 -2
  3. package/docs/wallet.md +204 -87
  4. package/out/src/sdk/types.d.ts +28 -0
  5. package/out/src/sdk/types.d.ts.map +1 -1
  6. package/out/src/sdk/types.js +36 -1
  7. package/out/src/sdk/types.js.map +1 -1
  8. package/out/src/services/Services.d.ts +3 -1
  9. package/out/src/services/Services.d.ts.map +1 -1
  10. package/out/src/services/Services.js +8 -8
  11. package/out/src/services/Services.js.map +1 -1
  12. package/out/src/services/__tests/ARC.test.js +3 -6
  13. package/out/src/services/__tests/ARC.test.js.map +1 -1
  14. package/out/src/services/__tests/bitrails.test.d.ts +2 -0
  15. package/out/src/services/__tests/bitrails.test.d.ts.map +1 -0
  16. package/out/src/services/__tests/bitrails.test.js +48 -0
  17. package/out/src/services/__tests/bitrails.test.js.map +1 -0
  18. package/out/src/services/providers/ARC.d.ts +1 -1
  19. package/out/src/services/providers/ARC.d.ts.map +1 -1
  20. package/out/src/services/providers/ARC.js +2 -1
  21. package/out/src/services/providers/ARC.js.map +1 -1
  22. package/out/src/services/providers/Bitails.d.ts +48 -0
  23. package/out/src/services/providers/Bitails.d.ts.map +1 -0
  24. package/out/src/services/providers/Bitails.js +253 -0
  25. package/out/src/services/providers/Bitails.js.map +1 -0
  26. package/out/src/services/providers/WhatsOnChain.d.ts.map +1 -1
  27. package/out/src/services/providers/WhatsOnChain.js +2 -5
  28. package/out/src/services/providers/WhatsOnChain.js.map +1 -1
  29. package/out/src/storage/methods/listOutputs.d.ts.map +1 -1
  30. package/out/src/storage/methods/listOutputs.js +33 -7
  31. package/out/src/storage/methods/listOutputs.js.map +1 -1
  32. package/out/test/Wallet/local/localWallet.man.test.d.ts.map +1 -1
  33. package/out/test/Wallet/local/localWallet.man.test.js +42 -6
  34. package/out/test/Wallet/local/localWallet.man.test.js.map +1 -1
  35. package/out/test/Wallet/specOps/specOps.man.test.js +29 -4
  36. package/out/test/Wallet/specOps/specOps.man.test.js.map +1 -1
  37. package/out/tsconfig.all.tsbuildinfo +1 -1
  38. package/package.json +3 -3
  39. package/src/sdk/types.ts +40 -0
  40. package/src/services/Services.ts +9 -4
  41. package/src/services/__tests/ARC.test.ts +1 -1
  42. package/src/services/__tests/bitrails.test.ts +62 -0
  43. package/src/services/providers/ARC.ts +1 -1
  44. package/src/services/providers/Bitails.ts +313 -0
  45. package/src/services/providers/WhatsOnChain.ts +2 -5
  46. package/src/storage/methods/listOutputs.ts +79 -6
  47. package/test/Wallet/local/localWallet.man.test.ts +52 -6
  48. package/test/Wallet/specOps/specOps.man.test.ts +45 -5
package/docs/client.md CHANGED
@@ -14,55 +14,56 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
14
14
 
15
15
  | | | |
16
16
  | --- | --- | --- |
17
- | [ArcConfig](#interface-arcconfig) | [PostBeefResult](#interface-postbeefresult) | [TableSyncState](#interface-tablesyncstate) |
18
- | [ArcMinerGetTxData](#interface-arcminergettxdata) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableTransaction](#interface-tabletransaction) |
19
- | [AuthId](#interface-authid) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableTxLabel](#interface-tabletxlabel) |
20
- | [BaseBlockHeader](#interface-baseblockheader) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableTxLabelMap](#interface-tabletxlabelmap) |
21
- | [BlockHeader](#interface-blockheader) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TableUser](#interface-tableuser) |
22
- | [BsvExchangeRate](#interface-bsvexchangerate) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TaskPurgeParams](#interface-taskpurgeparams) |
23
- | [CertOpsWallet](#interface-certopswallet) | [PostTxsResult](#interface-posttxsresult) | [TrxToken](#interface-trxtoken) |
24
- | [CommitNewTxResults](#interface-commitnewtxresults) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
25
- | [EntitySyncMap](#interface-entitysyncmap) | [ProvenOrRawTx](#interface-provenorrawtx) | [TxScriptOffsets](#interface-txscriptoffsets) |
26
- | [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
27
- | [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
28
- | [FiatExchangeRates](#interface-fiatexchangerates) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [ValidAbortActionArgs](#interface-validabortactionargs) |
29
- | [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
30
- | [FindCertificatesArgs](#interface-findcertificatesargs) | [PurgeParams](#interface-purgeparams) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
31
- | [FindCommissionsArgs](#interface-findcommissionsargs) | [PurgeResults](#interface-purgeresults) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
32
- | [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidBasketInsertion](#interface-validbasketinsertion) |
33
- | [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
34
- | [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidCreateActionInput](#interface-validcreateactioninput) |
35
- | [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
36
- | [FindOutputTagsArgs](#interface-findoutputtagsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
37
- | [FindOutputsArgs](#interface-findoutputsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
38
- | [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [StorageFeeModel](#interface-storagefeemodel) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
39
- | [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
40
- | [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageIdentity](#interface-storageidentity) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
41
- | [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [ValidListActionsArgs](#interface-validlistactionsargs) |
42
- | [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
43
- | [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
44
- | [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageProvenOrReq](#interface-storageprovenorreq) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
45
- | [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageProviderOptions](#interface-storageprovideroptions) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
46
- | [FindUsersArgs](#interface-findusersargs) | [StorageReaderOptions](#interface-storagereaderoptions) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
47
- | [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
48
- | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
49
- | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [SyncChunk](#interface-syncchunk) | [ValidSignActionArgs](#interface-validsignactionargs) |
50
- | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [SyncError](#interface-syncerror) | [ValidSignActionOptions](#interface-validsignactionoptions) |
51
- | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [SyncMap](#interface-syncmap) | [ValidWalletPayment](#interface-validwalletpayment) |
52
- | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [TableCertificate](#interface-tablecertificate) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
53
- | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [TableCertificateField](#interface-tablecertificatefield) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
54
- | [GetMerklePathResult](#interface-getmerklepathresult) | [TableCertificateX](#interface-tablecertificatex) | [WalletArgs](#interface-walletargs) |
55
- | [GetRawTxResult](#interface-getrawtxresult) | [TableCommission](#interface-tablecommission) | [WalletBalance](#interface-walletbalance) |
56
- | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletServices](#interface-walletservices) |
57
- | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [TableOutput](#interface-tableoutput) | [WalletServicesOptions](#interface-walletservicesoptions) |
58
- | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableOutputBasket](#interface-tableoutputbasket) | [WalletSigner](#interface-walletsigner) |
59
- | [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableOutputTag](#interface-tableoutputtag) | [WalletStorage](#interface-walletstorage) |
60
- | [KeyPair](#interface-keypair) | [TableOutputTagMap](#interface-tableoutputtagmap) | [WalletStorageProvider](#interface-walletstorageprovider) |
61
- | [MonitorOptions](#interface-monitoroptions) | [TableOutputX](#interface-tableoutputx) | [WalletStorageReader](#interface-walletstoragereader) |
62
- | [OutPoint](#interface-outpoint) | [TableProvenTx](#interface-tableproventx) | [WalletStorageSync](#interface-walletstoragesync) |
63
- | [Paged](#interface-paged) | [TableProvenTxReq](#interface-tableproventxreq) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
64
- | [PendingSignAction](#interface-pendingsignaction) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) | [WalletStorageWriter](#interface-walletstoragewriter) |
65
- | [PendingStorageInput](#interface-pendingstorageinput) | [TableSettings](#interface-tablesettings) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
17
+ | [ArcConfig](#interface-arcconfig) | [PendingStorageInput](#interface-pendingstorageinput) | [TableSyncState](#interface-tablesyncstate) |
18
+ | [ArcMinerGetTxData](#interface-arcminergettxdata) | [PostBeefResult](#interface-postbeefresult) | [TableTransaction](#interface-tabletransaction) |
19
+ | [AuthId](#interface-authid) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableTxLabel](#interface-tabletxlabel) |
20
+ | [BaseBlockHeader](#interface-baseblockheader) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableTxLabelMap](#interface-tabletxlabelmap) |
21
+ | [BitailsConfig](#interface-bitailsconfig) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableUser](#interface-tableuser) |
22
+ | [BitailsMerkleProof](#interface-bitailsmerkleproof) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TaskPurgeParams](#interface-taskpurgeparams) |
23
+ | [BlockHeader](#interface-blockheader) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TrxToken](#interface-trxtoken) |
24
+ | [BsvExchangeRate](#interface-bsvexchangerate) | [PostTxsResult](#interface-posttxsresult) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
25
+ | [CertOpsWallet](#interface-certopswallet) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TxScriptOffsets](#interface-txscriptoffsets) |
26
+ | [CommitNewTxResults](#interface-commitnewtxresults) | [ProvenOrRawTx](#interface-provenorrawtx) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
27
+ | [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
28
+ | [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [ValidAbortActionArgs](#interface-validabortactionargs) |
29
+ | [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
30
+ | [FiatExchangeRates](#interface-fiatexchangerates) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
31
+ | [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [PurgeParams](#interface-purgeparams) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
32
+ | [FindCertificatesArgs](#interface-findcertificatesargs) | [PurgeResults](#interface-purgeresults) | [ValidBasketInsertion](#interface-validbasketinsertion) |
33
+ | [FindCommissionsArgs](#interface-findcommissionsargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
34
+ | [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidCreateActionInput](#interface-validcreateactioninput) |
35
+ | [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
36
+ | [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
37
+ | [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
38
+ | [FindOutputTagsArgs](#interface-findoutputtagsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
39
+ | [FindOutputsArgs](#interface-findoutputsargs) | [StorageFeeModel](#interface-storagefeemodel) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
40
+ | [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
41
+ | [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StorageIdentity](#interface-storageidentity) | [ValidListActionsArgs](#interface-validlistactionsargs) |
42
+ | [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
43
+ | [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
44
+ | [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
45
+ | [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageProvenOrReq](#interface-storageprovenorreq) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
46
+ | [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageProviderOptions](#interface-storageprovideroptions) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
47
+ | [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageReaderOptions](#interface-storagereaderoptions) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
48
+ | [FindUsersArgs](#interface-findusersargs) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
49
+ | [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) | [ValidSignActionArgs](#interface-validsignactionargs) |
50
+ | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [SyncChunk](#interface-syncchunk) | [ValidSignActionOptions](#interface-validsignactionoptions) |
51
+ | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [SyncError](#interface-syncerror) | [ValidWalletPayment](#interface-validwalletpayment) |
52
+ | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [SyncMap](#interface-syncmap) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
53
+ | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [TableCertificate](#interface-tablecertificate) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
54
+ | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [TableCertificateField](#interface-tablecertificatefield) | [WalletArgs](#interface-walletargs) |
55
+ | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [TableCertificateX](#interface-tablecertificatex) | [WalletBalance](#interface-walletbalance) |
56
+ | [GetMerklePathResult](#interface-getmerklepathresult) | [TableCommission](#interface-tablecommission) | [WalletServices](#interface-walletservices) |
57
+ | [GetRawTxResult](#interface-getrawtxresult) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletServicesOptions](#interface-walletservicesoptions) |
58
+ | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [TableOutput](#interface-tableoutput) | [WalletSigner](#interface-walletsigner) |
59
+ | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [TableOutputBasket](#interface-tableoutputbasket) | [WalletStorage](#interface-walletstorage) |
60
+ | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableOutputTag](#interface-tableoutputtag) | [WalletStorageProvider](#interface-walletstorageprovider) |
61
+ | [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableOutputTagMap](#interface-tableoutputtagmap) | [WalletStorageReader](#interface-walletstoragereader) |
62
+ | [KeyPair](#interface-keypair) | [TableOutputX](#interface-tableoutputx) | [WalletStorageSync](#interface-walletstoragesync) |
63
+ | [MonitorOptions](#interface-monitoroptions) | [TableProvenTx](#interface-tableproventx) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
64
+ | [OutPoint](#interface-outpoint) | [TableProvenTxReq](#interface-tableproventxreq) | [WalletStorageWriter](#interface-walletstoragewriter) |
65
+ | [Paged](#interface-paged) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
66
+ | [PendingSignAction](#interface-pendingsignaction) | [TableSettings](#interface-tablesettings) | |
66
67
 
67
68
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
68
69
 
@@ -235,6 +236,48 @@ version: number
235
236
 
236
237
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
237
238
 
239
+ ---
240
+ ##### Interface: BitailsConfig
241
+
242
+ ```ts
243
+ export interface BitailsConfig {
244
+ apiKey?: string;
245
+ httpClient?: HttpClient;
246
+ }
247
+ ```
248
+
249
+ ###### Property apiKey
250
+
251
+ Authentication token for BitTails API
252
+
253
+ ```ts
254
+ apiKey?: string
255
+ ```
256
+
257
+ ###### Property httpClient
258
+
259
+ The HTTP client used to make requests to the API.
260
+
261
+ ```ts
262
+ httpClient?: HttpClient
263
+ ```
264
+
265
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
266
+
267
+ ---
268
+ ##### Interface: BitailsMerkleProof
269
+
270
+ ```ts
271
+ export interface BitailsMerkleProof {
272
+ index: number;
273
+ txOrId: string;
274
+ target: string;
275
+ nodes: string[];
276
+ }
277
+ ```
278
+
279
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
280
+
238
281
  ---
239
282
  ##### Interface: BlockHeader
240
283
 
@@ -3648,7 +3691,8 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
3648
3691
 
3649
3692
  | | | |
3650
3693
  | --- | --- | --- |
3651
- | [ARC](#class-arc) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
3694
+ | [ARC](#class-arc) | [Monitor](#class-monitor) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
3695
+ | [Bitails](#class-bitails) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
3652
3696
  | [CertOps](#class-certops) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
3653
3697
  | [EntityBase](#class-entitybase) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_INTERNAL](#class-werr_internal) |
3654
3698
  | [EntityCertificate](#class-entitycertificate) | [ServiceCollection](#class-servicecollection) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
@@ -3666,7 +3710,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
3666
3710
  | [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskReviewStatus](#class-taskreviewstatus) | [WalletStorageManager](#class-walletstoragemanager) |
3667
3711
  | [EntityUser](#class-entityuser) | [TaskSendWaiting](#class-tasksendwaiting) | [WhatsOnChain](#class-whatsonchain) |
3668
3712
  | [MergeEntity](#class-mergeentity) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) | |
3669
- | [Monitor](#class-monitor) | [WERR_BAD_REQUEST](#class-werr_bad_request) | |
3670
3713
 
3671
3714
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3672
3715
 
@@ -3677,7 +3720,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
3677
3720
  Represents an ARC transaction broadcaster.
3678
3721
 
3679
3722
  ```ts
3680
- export default class ARC {
3723
+ export class ARC {
3681
3724
  readonly URL: string;
3682
3725
  readonly apiKey: string | undefined;
3683
3726
  readonly deploymentId: string;
@@ -3764,6 +3807,50 @@ See also: [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
3764
3807
 
3765
3808
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3766
3809
 
3810
+ ---
3811
+ ##### Class: Bitails
3812
+
3813
+ ```ts
3814
+ export class Bitails {
3815
+ readonly chain: sdk.Chain;
3816
+ readonly apiKey: string;
3817
+ readonly URL: string;
3818
+ readonly httpClient: HttpClient;
3819
+ constructor(chain: sdk.Chain = "main", config: BitailsConfig = {})
3820
+ getHttpHeaders(): Record<string, string>
3821
+ async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
3822
+ async postRaws(raws: HexString[]): Promise<sdk.PostBeefResult>
3823
+ async getMerklePath(txid: string, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
3824
+ }
3825
+ ```
3826
+
3827
+ See also: [BitailsConfig](./services.md#interface-bitailsconfig), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [PostBeefResult](./client.md#interface-postbeefresult), [WalletServices](./client.md#interface-walletservices)
3828
+
3829
+ ###### Method postBeef
3830
+
3831
+ Bitails does not natively support a postBeef end-point aware of multiple txids of interest in the Beef.
3832
+
3833
+ Send rawTx in `txids` order from beef.
3834
+
3835
+ ```ts
3836
+ async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
3837
+ ```
3838
+ See also: [PostBeefResult](./client.md#interface-postbeefresult)
3839
+
3840
+ ###### Method postRaws
3841
+
3842
+ ```ts
3843
+ async postRaws(raws: HexString[]): Promise<sdk.PostBeefResult>
3844
+ ```
3845
+ See also: [PostBeefResult](./client.md#interface-postbeefresult)
3846
+
3847
+ Argument Details
3848
+
3849
+ + **raws**
3850
+ + Array of raw transactions to broadcast as hex strings
3851
+
3852
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3853
+
3767
3854
  ---
3768
3855
  ##### Class: CertOps
3769
3856
 
@@ -5116,6 +5203,7 @@ export class Services implements sdk.WalletServices {
5116
5203
  options: sdk.WalletServicesOptions;
5117
5204
  whatsonchain: WhatsOnChain;
5118
5205
  arc: ARC;
5206
+ bitails: Bitails;
5119
5207
  getMerklePathServices: ServiceCollection<sdk.GetMerklePathService>;
5120
5208
  getRawTxServices: ServiceCollection<sdk.GetRawTxService>;
5121
5209
  postBeefServices: ServiceCollection<sdk.PostBeefService>;
@@ -5144,7 +5232,7 @@ export class Services implements sdk.WalletServices {
5144
5232
  }
5145
5233
  ```
5146
5234
 
5147
- See also: [ARC](./services.md#class-arc), [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [ServiceCollection](./services.md#class-servicecollection), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain)
5235
+ See also: [ARC](./services.md#class-arc), [Bitails](./services.md#class-bitails), [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [ServiceCollection](./services.md#class-servicecollection), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain)
5148
5236
 
5149
5237
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5150
5238
 
@@ -7231,40 +7319,41 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
7231
7319
 
7232
7320
  | | | |
7233
7321
  | --- | --- | --- |
7234
- | [acquireDirectCertificate](#function-acquiredirectcertificate) | [makeChangeLock](#function-makechangelock) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
7235
- | [arcDefaultUrl](#function-arcdefaulturl) | [maxDate](#function-maxdate) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
7236
- | [arraysEqual](#function-arraysequal) | [offsetPubKey](#function-offsetpubkey) | [validateInteger](#function-validateinteger) |
7237
- | [asArray](#function-asarray) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
7238
- | [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
7239
- | [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListActionsArgs](#function-validatelistactionsargs) |
7240
- | [asBsvSdkScript](#function-asbsvsdkscript) | [processAction](#function-processaction) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
7241
- | [asBsvSdkTx](#function-asbsvsdktx) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
7242
- | [asString](#function-asstring) | [proveCertificate](#function-provecertificate) | [validateOptionalInteger](#function-validateoptionalinteger) |
7243
- | [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [randomBytes](#function-randombytes) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
7244
- | [buildSignableTransaction](#function-buildsignabletransaction) | [randomBytesBase64](#function-randombytesbase64) | [validateOriginator](#function-validateoriginator) |
7245
- | [completeSignedTransaction](#function-completesignedtransaction) | [randomBytesHex](#function-randombyteshex) | [validateOutpointString](#function-validateoutpointstring) |
7246
- | [completeSignedTransaction](#function-completesignedtransaction) | [sha256Hash](#function-sha256hash) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
7247
- | [convertProofToMerklePath](#function-convertprooftomerklepath) | [signAction](#function-signaction) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
7248
- | [createAction](#function-createaction) | [stampLog](#function-stamplog) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
7249
- | [createAction](#function-createaction) | [stampLogFormat](#function-stamplogformat) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
7250
- | [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [validateSatoshis](#function-validatesatoshis) |
7251
- | [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [toWalletNetwork](#function-towalletnetwork) | [validateScriptHash](#function-validatescripthash) |
7252
- | [createSyncMap](#function-createsyncmap) | [transactionInputSize](#function-transactioninputsize) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
7253
- | [doubleSha256BE](#function-doublesha256be) | [transactionOutputSize](#function-transactionoutputsize) | [validateSignActionArgs](#function-validatesignactionargs) |
7254
- | [doubleSha256HashLE](#function-doublesha256hashle) | [transactionSize](#function-transactionsize) | [validateSignActionOptions](#function-validatesignactionoptions) |
7255
- | [generateChangeSdk](#function-generatechangesdk) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
7256
- | [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [validateStringLength](#function-validatestringlength) |
7257
- | [getBeefForTransaction](#function-getbeeffortransaction) | [validateAbortActionArgs](#function-validateabortactionargs) | [validateWalletPayment](#function-validatewalletpayment) |
7258
- | [getExchangeRatesIo](#function-getexchangeratesio) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [varUintSize](#function-varuintsize) |
7259
- | [getIdentityKey](#function-getidentitykey) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | [verifyHexString](#function-verifyhexstring) |
7260
- | [getSyncChunk](#function-getsyncchunk) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) | [verifyId](#function-verifyid) |
7261
- | [internalizeAction](#function-internalizeaction) | [validateBasketInsertion](#function-validatebasketinsertion) | [verifyInteger](#function-verifyinteger) |
7262
- | [internalizeAction](#function-internalizeaction) | [validateCreateActionArgs](#function-validatecreateactionargs) | [verifyNumber](#function-verifynumber) |
7263
- | [isHexString](#function-ishexstring) | [validateCreateActionInput](#function-validatecreateactioninput) | [verifyOne](#function-verifyone) |
7264
- | [listCertificates](#function-listcertificates) | [validateCreateActionOptions](#function-validatecreateactionoptions) | [verifyOneOrNone](#function-verifyoneornone) |
7265
- | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateCreateActionOutput](#function-validatecreateactionoutput) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
7266
- | [makeAtomicBeef](#function-makeatomicbeef) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) | [verifyTruthy](#function-verifytruthy) |
7267
- | [makeAtomicBeef](#function-makeatomicbeef) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) | [wait](#function-wait) |
7322
+ | [acquireDirectCertificate](#function-acquiredirectcertificate) | [makeChangeLock](#function-makechangelock) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
7323
+ | [arcDefaultUrl](#function-arcdefaulturl) | [maxDate](#function-maxdate) | [validateInteger](#function-validateinteger) |
7324
+ | [arraysEqual](#function-arraysequal) | [offsetPubKey](#function-offsetpubkey) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
7325
+ | [asArray](#function-asarray) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
7326
+ | [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateListActionsArgs](#function-validatelistactionsargs) |
7327
+ | [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
7328
+ | [asBsvSdkScript](#function-asbsvsdkscript) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
7329
+ | [asBsvSdkTx](#function-asbsvsdktx) | [processAction](#function-processaction) | [validateOptionalInteger](#function-validateoptionalinteger) |
7330
+ | [asString](#function-asstring) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
7331
+ | [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [randomBytes](#function-randombytes) | [validateOriginator](#function-validateoriginator) |
7332
+ | [buildSignableTransaction](#function-buildsignabletransaction) | [randomBytesBase64](#function-randombytesbase64) | [validateOutpointString](#function-validateoutpointstring) |
7333
+ | [completeSignedTransaction](#function-completesignedtransaction) | [randomBytesHex](#function-randombyteshex) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
7334
+ | [completeSignedTransaction](#function-completesignedtransaction) | [sha256Hash](#function-sha256hash) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
7335
+ | [convertProofToMerklePath](#function-convertprooftomerklepath) | [signAction](#function-signaction) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
7336
+ | [createAction](#function-createaction) | [stampLog](#function-stamplog) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
7337
+ | [createAction](#function-createaction) | [stampLogFormat](#function-stamplogformat) | [validateSatoshis](#function-validatesatoshis) |
7338
+ | [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [validateScriptHash](#function-validatescripthash) |
7339
+ | [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [toWalletNetwork](#function-towalletnetwork) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
7340
+ | [createSyncMap](#function-createsyncmap) | [transactionInputSize](#function-transactioninputsize) | [validateSignActionArgs](#function-validatesignactionargs) |
7341
+ | [doubleSha256BE](#function-doublesha256be) | [transactionOutputSize](#function-transactionoutputsize) | [validateSignActionOptions](#function-validatesignactionoptions) |
7342
+ | [doubleSha256HashLE](#function-doublesha256hashle) | [transactionSize](#function-transactionsize) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
7343
+ | [generateChangeSdk](#function-generatechangesdk) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [validateStringLength](#function-validatestringlength) |
7344
+ | [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [validateWalletPayment](#function-validatewalletpayment) |
7345
+ | [getBeefForTransaction](#function-getbeeffortransaction) | [validateAbortActionArgs](#function-validateabortactionargs) | [varUintSize](#function-varuintsize) |
7346
+ | [getExchangeRatesIo](#function-getexchangeratesio) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [verifyHexString](#function-verifyhexstring) |
7347
+ | [getIdentityKey](#function-getidentitykey) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | [verifyId](#function-verifyid) |
7348
+ | [getSyncChunk](#function-getsyncchunk) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) | [verifyInteger](#function-verifyinteger) |
7349
+ | [internalizeAction](#function-internalizeaction) | [validateBasketInsertion](#function-validatebasketinsertion) | [verifyNumber](#function-verifynumber) |
7350
+ | [internalizeAction](#function-internalizeaction) | [validateCreateActionArgs](#function-validatecreateactionargs) | [verifyOne](#function-verifyone) |
7351
+ | [isHexString](#function-ishexstring) | [validateCreateActionInput](#function-validatecreateactioninput) | [verifyOneOrNone](#function-verifyoneornone) |
7352
+ | [isSpecOp](#function-isspecop) | [validateCreateActionOptions](#function-validatecreateactionoptions) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
7353
+ | [listCertificates](#function-listcertificates) | [validateCreateActionOutput](#function-validatecreateactionoutput) | [verifyTruthy](#function-verifytruthy) |
7354
+ | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) | [wait](#function-wait) |
7355
+ | [makeAtomicBeef](#function-makeatomicbeef) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) | |
7356
+ | [makeAtomicBeef](#function-makeatomicbeef) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) | |
7268
7357
 
7269
7358
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7270
7359
 
@@ -7749,6 +7838,24 @@ export function isHexString(s: string): boolean
7749
7838
 
7750
7839
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7751
7840
 
7841
+ ---
7842
+ ##### Function: isSpecOp
7843
+
7844
+ ```ts
7845
+ export function isSpecOp(basket: string): boolean
7846
+ ```
7847
+
7848
+ Returns
7849
+
7850
+ true iff the `basket` name is a reserved `listOutputs` special operation identifier.
7851
+
7852
+ Argument Details
7853
+
7854
+ + **basket**
7855
+ + Output basket name value.
7856
+
7857
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7858
+
7752
7859
  ---
7753
7860
  ##### Function: listCertificates
7754
7861
 
@@ -8968,6 +9075,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
8968
9075
  | [maxPossibleSatoshis](#variable-maxpossiblesatoshis) |
8969
9076
  | [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) |
8970
9077
  | [specOpInvalidChange](#variable-specopinvalidchange) |
9078
+ | [specOpSetWalletChangeParams](#variable-specopsetwalletchangeparams) |
8971
9079
  | [specOpWalletBalance](#variable-specopwalletbalance) |
8972
9080
  | [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
8973
9081
 
@@ -9071,6 +9179,15 @@ specOpInvalidChange = "5a76fd430a311f8bc0553859061710a4475c19fed46e2ff95969aa918
9071
9179
 
9072
9180
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
9073
9181
 
9182
+ ---
9183
+ ##### Variable: specOpSetWalletChangeParams
9184
+
9185
+ ```ts
9186
+ specOpSetWalletChangeParams = "a4979d28ced8581e9c1c92f1001cc7cb3aabf8ea32e10888ad898f0a509a3929"
9187
+ ```
9188
+
9189
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
9190
+
9074
9191
  ---
9075
9192
  ##### Variable: specOpWalletBalance
9076
9193
 
package/docs/services.md CHANGED
@@ -25,6 +25,8 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
25
25
  | --- |
26
26
  | [ArcConfig](#interface-arcconfig) |
27
27
  | [ArcMinerGetTxData](#interface-arcminergettxdata) |
28
+ | [BitailsConfig](#interface-bitailsconfig) |
29
+ | [BitailsMerkleProof](#interface-bitailsmerkleproof) |
28
30
  | [ExchangeRatesIoApi](#interface-exchangeratesioapi) |
29
31
 
30
32
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
@@ -116,6 +118,48 @@ export interface ArcMinerGetTxData {
116
118
 
117
119
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
118
120
 
121
+ ---
122
+ ##### Interface: BitailsConfig
123
+
124
+ ```ts
125
+ export interface BitailsConfig {
126
+ apiKey?: string;
127
+ httpClient?: HttpClient;
128
+ }
129
+ ```
130
+
131
+ ###### Property apiKey
132
+
133
+ Authentication token for BitTails API
134
+
135
+ ```ts
136
+ apiKey?: string
137
+ ```
138
+
139
+ ###### Property httpClient
140
+
141
+ The HTTP client used to make requests to the API.
142
+
143
+ ```ts
144
+ httpClient?: HttpClient
145
+ ```
146
+
147
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
148
+
149
+ ---
150
+ ##### Interface: BitailsMerkleProof
151
+
152
+ ```ts
153
+ export interface BitailsMerkleProof {
154
+ index: number;
155
+ txOrId: string;
156
+ target: string;
157
+ nodes: string[];
158
+ }
159
+ ```
160
+
161
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
162
+
119
163
  ---
120
164
  ##### Interface: ExchangeRatesIoApi
121
165
 
@@ -137,6 +181,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
137
181
  | |
138
182
  | --- |
139
183
  | [ARC](#class-arc) |
184
+ | [Bitails](#class-bitails) |
140
185
  | [SdkWhatsOnChain](#class-sdkwhatsonchain) |
141
186
  | [ServiceCollection](#class-servicecollection) |
142
187
  | [Services](#class-services) |
@@ -151,7 +196,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
151
196
  Represents an ARC transaction broadcaster.
152
197
 
153
198
  ```ts
154
- export default class ARC {
199
+ export class ARC {
155
200
  readonly URL: string;
156
201
  readonly apiKey: string | undefined;
157
202
  readonly deploymentId: string;
@@ -238,6 +283,50 @@ See also: [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
238
283
 
239
284
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
240
285
 
286
+ ---
287
+ ##### Class: Bitails
288
+
289
+ ```ts
290
+ export class Bitails {
291
+ readonly chain: sdk.Chain;
292
+ readonly apiKey: string;
293
+ readonly URL: string;
294
+ readonly httpClient: HttpClient;
295
+ constructor(chain: sdk.Chain = "main", config: BitailsConfig = {})
296
+ getHttpHeaders(): Record<string, string>
297
+ async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
298
+ async postRaws(raws: HexString[]): Promise<sdk.PostBeefResult>
299
+ async getMerklePath(txid: string, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
300
+ }
301
+ ```
302
+
303
+ See also: [BitailsConfig](./services.md#interface-bitailsconfig), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [PostBeefResult](./client.md#interface-postbeefresult), [WalletServices](./client.md#interface-walletservices)
304
+
305
+ ###### Method postBeef
306
+
307
+ Bitails does not natively support a postBeef end-point aware of multiple txids of interest in the Beef.
308
+
309
+ Send rawTx in `txids` order from beef.
310
+
311
+ ```ts
312
+ async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
313
+ ```
314
+ See also: [PostBeefResult](./client.md#interface-postbeefresult)
315
+
316
+ ###### Method postRaws
317
+
318
+ ```ts
319
+ async postRaws(raws: HexString[]): Promise<sdk.PostBeefResult>
320
+ ```
321
+ See also: [PostBeefResult](./client.md#interface-postbeefresult)
322
+
323
+ Argument Details
324
+
325
+ + **raws**
326
+ + Array of raw transactions to broadcast as hex strings
327
+
328
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
329
+
241
330
  ---
242
331
  ##### Class: SdkWhatsOnChain
243
332
 
@@ -314,6 +403,7 @@ export class Services implements sdk.WalletServices {
314
403
  options: sdk.WalletServicesOptions;
315
404
  whatsonchain: WhatsOnChain;
316
405
  arc: ARC;
406
+ bitails: Bitails;
317
407
  getMerklePathServices: ServiceCollection<sdk.GetMerklePathService>;
318
408
  getRawTxServices: ServiceCollection<sdk.GetRawTxService>;
319
409
  postBeefServices: ServiceCollection<sdk.PostBeefService>;
@@ -342,7 +432,7 @@ export class Services implements sdk.WalletServices {
342
432
  }
343
433
  ```
344
434
 
345
- See also: [ARC](./services.md#class-arc), [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [ServiceCollection](./services.md#class-servicecollection), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain)
435
+ See also: [ARC](./services.md#class-arc), [Bitails](./services.md#class-bitails), [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [ServiceCollection](./services.md#class-servicecollection), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain)
346
436
 
347
437
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
348
438