@bsv/wallet-toolbox 1.1.12 → 1.1.14
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/.github/workflows/push.yaml +2 -2
- package/README.md +3 -22
- package/docs/README.md +16 -10
- package/docs/client.md +490 -382
- package/docs/open-rpc/index.html +46 -0
- package/docs/services.md +236 -211
- package/docs/setup.md +51 -34
- package/docs/storage.md +30 -5
- package/docs/wallet.md +490 -382
- package/out/src/SetupClient.d.ts +9 -0
- package/out/src/SetupClient.d.ts.map +1 -1
- package/out/src/SetupClient.js +34 -18
- package/out/src/SetupClient.js.map +1 -1
- package/out/src/Wallet.d.ts +6 -0
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +57 -0
- package/out/src/Wallet.js.map +1 -1
- package/out/src/sdk/WalletServices.interfaces.d.ts +18 -13
- package/out/src/sdk/WalletServices.interfaces.d.ts.map +1 -1
- package/out/src/services/Services.d.ts +4 -11
- package/out/src/services/Services.d.ts.map +1 -1
- package/out/src/services/Services.js +19 -37
- package/out/src/services/Services.js.map +1 -1
- package/out/src/services/__tests/ARC.test.d.ts +2 -0
- package/out/src/services/__tests/ARC.test.d.ts.map +1 -0
- package/out/src/services/__tests/ARC.test.js +98 -0
- package/out/src/services/__tests/ARC.test.js.map +1 -0
- package/out/src/services/__tests/arcServices.test.d.ts +2 -0
- package/out/src/services/__tests/arcServices.test.d.ts.map +1 -0
- package/out/src/services/__tests/arcServices.test.js +7 -0
- package/out/src/services/__tests/arcServices.test.js.map +1 -0
- package/out/src/services/__tests/postBeef.test.js +45 -7
- package/out/src/services/__tests/postBeef.test.js.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.d.ts +1 -0
- package/out/src/services/createDefaultWalletServicesOptions.d.ts.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.js +16 -4
- package/out/src/services/createDefaultWalletServicesOptions.js.map +1 -1
- package/out/src/services/providers/ARC.d.ts +91 -0
- package/out/src/services/providers/ARC.d.ts.map +1 -0
- package/out/src/services/providers/ARC.js +192 -0
- package/out/src/services/providers/ARC.js.map +1 -0
- package/out/src/services/providers/SdkWhatsOnChain.d.ts +21 -0
- package/out/src/services/providers/SdkWhatsOnChain.d.ts.map +1 -0
- package/out/src/services/providers/SdkWhatsOnChain.js +67 -0
- package/out/src/services/providers/SdkWhatsOnChain.js.map +1 -0
- package/out/src/services/providers/WhatsOnChain.d.ts +35 -0
- package/out/src/services/providers/WhatsOnChain.d.ts.map +1 -0
- package/out/src/services/providers/WhatsOnChain.js +266 -0
- package/out/src/services/providers/WhatsOnChain.js.map +1 -0
- package/out/src/services/providers/__tests/WhatsOnChain.test.d.ts +2 -0
- package/out/src/services/providers/__tests/WhatsOnChain.test.d.ts.map +1 -0
- package/out/src/services/providers/__tests/WhatsOnChain.test.js +176 -0
- package/out/src/services/providers/__tests/WhatsOnChain.test.js.map +1 -0
- package/out/src/signer/methods/createAction.js +3 -3
- package/out/src/signer/methods/createAction.js.map +1 -1
- package/out/src/signer/methods/signAction.js +1 -1
- package/out/src/signer/methods/signAction.js.map +1 -1
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +9 -2
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/generateChange.d.ts +12 -1
- package/out/src/storage/methods/generateChange.d.ts.map +1 -1
- package/out/src/storage/methods/generateChange.js +24 -1
- package/out/src/storage/methods/generateChange.js.map +1 -1
- package/out/src/storage/methods/processAction.d.ts.map +1 -1
- package/out/src/storage/methods/processAction.js +1 -1
- package/out/src/storage/methods/processAction.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/ProvenTxTests.test.js +0 -1
- package/out/src/storage/schema/entities/__tests/ProvenTxTests.test.js.map +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.js +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.js.map +1 -1
- package/out/src/utility/{ScriptTemplateSABPPP.d.ts → ScriptTemplateBRC29.d.ts} +6 -6
- package/out/src/utility/ScriptTemplateBRC29.d.ts.map +1 -0
- package/out/src/utility/{ScriptTemplateSABPPP.js → ScriptTemplateBRC29.js} +4 -4
- package/out/src/utility/ScriptTemplateBRC29.js.map +1 -0
- package/out/src/utility/index.all.d.ts +1 -1
- package/out/src/utility/index.all.d.ts.map +1 -1
- package/out/src/utility/index.all.js +1 -1
- package/out/src/utility/index.all.js.map +1 -1
- package/out/src/utility/index.client.d.ts +1 -1
- package/out/src/utility/index.client.d.ts.map +1 -1
- package/out/src/utility/index.client.js +1 -1
- package/out/src/utility/index.client.js.map +1 -1
- package/out/src/utility/utilityHelpers.js +1 -1
- package/out/src/utility/utilityHelpers.js.map +1 -1
- package/out/test/Wallet/StorageClient/storageClient.man.test.js +22 -3
- package/out/test/Wallet/StorageClient/storageClient.man.test.js.map +1 -1
- package/out/test/Wallet/live/walletLive.man.test.js +2 -2
- package/out/test/Wallet/live/walletLive.man.test.js.map +1 -1
- package/out/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.js +40 -0
- package/out/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.js.map +1 -1
- package/out/test/services/Services.test.js +0 -31
- package/out/test/services/Services.test.js.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.d.ts +26 -18
- package/out/test/utils/TestUtilsWalletStorage.d.ts.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.js +135 -27
- package/out/test/utils/TestUtilsWalletStorage.js.map +1 -1
- package/out/test/wallet/list/listActions2.test.js +36 -2
- package/out/test/wallet/list/listActions2.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +5 -7
- package/src/SetupClient.ts +41 -21
- package/src/Wallet.ts +66 -2
- package/src/sdk/WalletServices.interfaces.ts +19 -14
- package/src/services/Services.ts +23 -62
- package/src/services/__tests/ARC.test.ts +110 -0
- package/src/services/__tests/arcServices.test.ts +8 -0
- package/src/services/__tests/postBeef.test.ts +47 -9
- package/src/services/createDefaultWalletServicesOptions.ts +19 -6
- package/src/services/providers/ARC.ts +289 -0
- package/src/services/providers/SdkWhatsOnChain.ts +96 -0
- package/src/services/providers/WhatsOnChain.ts +369 -0
- package/src/services/providers/__tests/WhatsOnChain.test.ts +227 -0
- package/src/signer/methods/createAction.ts +4 -4
- package/src/signer/methods/signAction.ts +2 -2
- package/src/storage/methods/createAction.ts +26 -4
- package/src/storage/methods/generateChange.ts +42 -2
- package/src/storage/methods/processAction.ts +2 -1
- package/src/storage/schema/entities/__tests/ProvenTxTests.test.ts +0 -1
- package/src/storage/sync/StorageMySQLDojoReader.ts +1 -1
- package/src/utility/{ScriptTemplateSABPPP.ts → ScriptTemplateBRC29.ts} +6 -8
- package/src/utility/index.all.ts +1 -1
- package/src/utility/index.client.ts +1 -1
- package/src/utility/utilityHelpers.ts +1 -1
- package/test/Wallet/StorageClient/storageClient.man.test.ts +30 -4
- package/test/Wallet/live/walletLive.man.test.ts +3 -3
- package/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.ts +54 -0
- package/test/services/Services.test.ts +0 -30
- package/test/utils/TestUtilsWalletStorage.ts +175 -45
- package/test/wallet/list/listActions2.test.ts +4 -7
- package/out/src/services/__tests/postBeefToArcTaal.test.d.ts +0 -2
- package/out/src/services/__tests/postBeefToArcTaal.test.d.ts.map +0 -1
- package/out/src/services/__tests/postBeefToArcTaal.test.js +0 -479
- package/out/src/services/__tests/postBeefToArcTaal.test.js.map +0 -1
- package/out/src/services/__tests/postTxs.test.d.ts +0 -2
- package/out/src/services/__tests/postTxs.test.d.ts.map +0 -1
- package/out/src/services/__tests/postTxs.test.js +0 -28
- package/out/src/services/__tests/postTxs.test.js.map +0 -1
- package/out/src/services/providers/arcServices.d.ts +0 -62
- package/out/src/services/providers/arcServices.d.ts.map +0 -1
- package/out/src/services/providers/arcServices.js +0 -375
- package/out/src/services/providers/arcServices.js.map +0 -1
- package/out/src/services/providers/whatsonchain.d.ts +0 -17
- package/out/src/services/providers/whatsonchain.d.ts.map +0 -1
- package/out/src/services/providers/whatsonchain.js +0 -130
- package/out/src/services/providers/whatsonchain.js.map +0 -1
- package/out/src/utility/ScriptTemplateSABPPP.d.ts.map +0 -1
- package/out/src/utility/ScriptTemplateSABPPP.js.map +0 -1
- package/out/test/examples/README.man.test.d.ts +0 -2
- package/out/test/examples/README.man.test.d.ts.map +0 -1
- package/out/test/examples/README.man.test.js +0 -47
- package/out/test/examples/README.man.test.js.map +0 -1
- package/src/services/__tests/postBeefToArcTaal.test.ts +0 -487
- package/src/services/__tests/postTxs.test.ts +0 -28
- package/src/services/providers/arcServices.ts +0 -578
- package/src/services/providers/whatsonchain.ts +0 -170
- package/test/examples/README.man.test.ts +0 -53
package/docs/wallet.md
CHANGED
|
@@ -13,109 +13,132 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
13
13
|
|
|
14
14
|
| | | |
|
|
15
15
|
| --- | --- | --- |
|
|
16
|
-
| [
|
|
17
|
-
| [
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
20
|
-
| [
|
|
21
|
-
| [
|
|
22
|
-
| [
|
|
23
|
-
| [
|
|
24
|
-
| [
|
|
25
|
-
| [
|
|
26
|
-
| [
|
|
27
|
-
| [
|
|
28
|
-
| [
|
|
29
|
-
| [
|
|
30
|
-
| [
|
|
31
|
-
| [
|
|
32
|
-
| [
|
|
33
|
-
| [
|
|
34
|
-
| [
|
|
35
|
-
| [
|
|
36
|
-
| [
|
|
37
|
-
| [
|
|
38
|
-
| [
|
|
39
|
-
| [
|
|
40
|
-
| [
|
|
41
|
-
| [
|
|
42
|
-
| [
|
|
43
|
-
| [
|
|
44
|
-
| [
|
|
45
|
-
| [
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
48
|
-
| [
|
|
49
|
-
| [
|
|
50
|
-
| [
|
|
51
|
-
| [
|
|
52
|
-
| [
|
|
53
|
-
| [
|
|
54
|
-
| [
|
|
55
|
-
| [
|
|
56
|
-
| [
|
|
57
|
-
| [
|
|
58
|
-
| [
|
|
59
|
-
| [
|
|
60
|
-
| [
|
|
61
|
-
| [
|
|
62
|
-
| [
|
|
63
|
-
| [
|
|
64
|
-
| [
|
|
65
|
-
| [
|
|
66
|
-
| [
|
|
16
|
+
| [ArcConfig](#interface-arcconfig) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableProvenTx](#interface-tableproventx) |
|
|
17
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
18
|
+
| [AuthId](#interface-authid) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
19
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TableSettings](#interface-tablesettings) |
|
|
20
|
+
| [BlockHeader](#interface-blockheader) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TableSyncState](#interface-tablesyncstate) |
|
|
21
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [PostTxsResult](#interface-posttxsresult) | [TableTransaction](#interface-tabletransaction) |
|
|
22
|
+
| [CertOpsWallet](#interface-certopswallet) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TableTxLabel](#interface-tabletxlabel) |
|
|
23
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProvenOrRawTx](#interface-provenorrawtx) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
24
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [TableUser](#interface-tableuser) |
|
|
25
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
26
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [TrxToken](#interface-trxtoken) |
|
|
27
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
28
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [PurgeParams](#interface-purgeparams) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
29
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [PurgeResults](#interface-purgeresults) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
30
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
31
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidAbortActionArgs](#interface-validabortactionargs) |
|
|
32
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
|
|
33
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [SetupEnv](#interface-setupenv) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
|
|
34
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [SetupWallet](#interface-setupwallet) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
|
|
35
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [SetupWalletArgs](#interface-setupwalletargs) | [ValidBasketInsertion](#interface-validbasketinsertion) |
|
|
36
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [SetupWalletClient](#interface-setupwalletclient) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
|
|
37
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [SetupWalletClientArgs](#interface-setupwalletclientargs) | [ValidCreateActionInput](#interface-validcreateactioninput) |
|
|
38
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
|
|
39
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
|
|
40
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
|
|
41
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageFeeModel](#interface-storagefeemodel) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
|
|
42
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
|
|
43
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageIdentity](#interface-storageidentity) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
|
|
44
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [ValidListActionsArgs](#interface-validlistactionsargs) |
|
|
45
|
+
| [FindUsersArgs](#interface-findusersargs) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
|
|
46
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
|
|
47
|
+
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageProvenOrReq](#interface-storageprovenorreq) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
|
|
48
|
+
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageProviderOptions](#interface-storageprovideroptions) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
|
|
49
|
+
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageReaderOptions](#interface-storagereaderoptions) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
|
|
50
|
+
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
|
|
51
|
+
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageSyncReader](#interface-storagesyncreader) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
|
|
52
|
+
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) | [ValidSignActionArgs](#interface-validsignactionargs) |
|
|
53
|
+
| [GetMerklePathResult](#interface-getmerklepathresult) | [StorageSyncReaderWriter](#interface-storagesyncreaderwriter) | [ValidSignActionOptions](#interface-validsignactionoptions) |
|
|
54
|
+
| [GetRawTxResult](#interface-getrawtxresult) | [SyncChunk](#interface-syncchunk) | [ValidWalletPayment](#interface-validwalletpayment) |
|
|
55
|
+
| [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [SyncError](#interface-syncerror) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
|
|
56
|
+
| [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [SyncMap](#interface-syncmap) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
57
|
+
| [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableCertificate](#interface-tablecertificate) | [WalletArgs](#interface-walletargs) |
|
|
58
|
+
| [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableCertificateField](#interface-tablecertificatefield) | [WalletServices](#interface-walletservices) |
|
|
59
|
+
| [KeyPair](#interface-keypair) | [TableCertificateX](#interface-tablecertificatex) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
60
|
+
| [KeyPairAddress](#interface-keypairaddress) | [TableCommission](#interface-tablecommission) | [WalletSigner](#interface-walletsigner) |
|
|
61
|
+
| [MonitorOptions](#interface-monitoroptions) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletStorage](#interface-walletstorage) |
|
|
62
|
+
| [OutPoint](#interface-outpoint) | [TableOutput](#interface-tableoutput) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
63
|
+
| [Paged](#interface-paged) | [TableOutputBasket](#interface-tableoutputbasket) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
64
|
+
| [PendingSignAction](#interface-pendingsignaction) | [TableOutputTag](#interface-tableoutputtag) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
65
|
+
| [PendingStorageInput](#interface-pendingstorageinput) | [TableOutputTagMap](#interface-tableoutputtagmap) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
66
|
+
| [PostBeefResult](#interface-postbeefresult) | [TableOutputX](#interface-tableoutputx) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
67
67
|
|
|
68
68
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
69
69
|
|
|
70
70
|
---
|
|
71
71
|
|
|
72
|
-
##### Interface:
|
|
72
|
+
##### Interface: ArcConfig
|
|
73
|
+
|
|
74
|
+
Configuration options for the ARC broadcaster.
|
|
73
75
|
|
|
74
76
|
```ts
|
|
75
|
-
export interface
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
merklePath: string;
|
|
83
|
-
timestamp: string;
|
|
84
|
-
txid: string;
|
|
85
|
-
txStatus: string;
|
|
77
|
+
export interface ArcConfig {
|
|
78
|
+
apiKey?: string;
|
|
79
|
+
httpClient?: HttpClient;
|
|
80
|
+
deploymentId?: string;
|
|
81
|
+
callbackUrl?: string;
|
|
82
|
+
callbackToken?: string;
|
|
83
|
+
headers?: Record<string, string>;
|
|
86
84
|
}
|
|
87
85
|
```
|
|
88
86
|
|
|
89
|
-
|
|
87
|
+
###### Property apiKey
|
|
90
88
|
|
|
91
|
-
|
|
92
|
-
##### Interface: ArcMinerPostBeefDataApi
|
|
89
|
+
Authentication token for the ARC API
|
|
93
90
|
|
|
94
91
|
```ts
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
92
|
+
apiKey?: string
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
###### Property callbackToken
|
|
96
|
+
|
|
97
|
+
default access token for notification callback endpoint. It will be used as a Authorization header for the http callback
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
callbackToken?: string
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
###### Property callbackUrl
|
|
104
|
+
|
|
105
|
+
notification callback endpoint for proofs and double spend notification
|
|
106
|
+
|
|
107
|
+
```ts
|
|
108
|
+
callbackUrl?: string
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
###### Property deploymentId
|
|
112
|
+
|
|
113
|
+
Deployment id used annotating api calls in XDeployment-ID header - this value will be randomly generated if not set
|
|
114
|
+
|
|
115
|
+
```ts
|
|
116
|
+
deploymentId?: string
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
###### Property headers
|
|
120
|
+
|
|
121
|
+
additional headers to be attached to all tx submissions.
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
headers?: Record<string, string>
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
###### Property httpClient
|
|
128
|
+
|
|
129
|
+
The HTTP client used to make requests to the ARC API.
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
httpClient?: HttpClient
|
|
110
133
|
```
|
|
111
134
|
|
|
112
135
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
113
136
|
|
|
114
137
|
---
|
|
115
|
-
##### Interface:
|
|
138
|
+
##### Interface: ArcMinerGetTxData
|
|
116
139
|
|
|
117
140
|
```ts
|
|
118
|
-
export interface
|
|
141
|
+
export interface ArcMinerGetTxData {
|
|
119
142
|
status: number;
|
|
120
143
|
title: string;
|
|
121
144
|
blockHash: string;
|
|
@@ -131,19 +154,6 @@ export interface ArcMinerPostTxsData {
|
|
|
131
154
|
|
|
132
155
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
133
156
|
|
|
134
|
-
---
|
|
135
|
-
##### Interface: ArcServiceConfig
|
|
136
|
-
|
|
137
|
-
```ts
|
|
138
|
-
export interface ArcServiceConfig {
|
|
139
|
-
name: string;
|
|
140
|
-
url: string;
|
|
141
|
-
arcConfig: ArcConfig;
|
|
142
|
-
}
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
146
|
-
|
|
147
157
|
---
|
|
148
158
|
##### Interface: AuthId
|
|
149
159
|
|
|
@@ -756,6 +766,10 @@ export interface GenerateChangeSdkResult {
|
|
|
756
766
|
size: number;
|
|
757
767
|
fee: number;
|
|
758
768
|
satsPerKb: number;
|
|
769
|
+
maxPossibleSatoshisAdjustment?: {
|
|
770
|
+
fixedOutputIndex: number;
|
|
771
|
+
satoshis: number;
|
|
772
|
+
};
|
|
759
773
|
}
|
|
760
774
|
```
|
|
761
775
|
|
|
@@ -1241,13 +1255,17 @@ export interface PostTxResultForTxid {
|
|
|
1241
1255
|
txid: string;
|
|
1242
1256
|
status: "success" | "error";
|
|
1243
1257
|
alreadyKnown?: boolean;
|
|
1258
|
+
doubleSpend?: boolean;
|
|
1244
1259
|
blockHash?: string;
|
|
1245
1260
|
blockHeight?: number;
|
|
1246
1261
|
merklePath?: MerklePath;
|
|
1247
|
-
|
|
1262
|
+
competingTxs?: string[];
|
|
1263
|
+
data?: object | string | PostTxResultForTxidError;
|
|
1248
1264
|
}
|
|
1249
1265
|
```
|
|
1250
1266
|
|
|
1267
|
+
See also: [PostTxResultForTxidError](./client.md#interface-posttxresultfortxiderror)
|
|
1268
|
+
|
|
1251
1269
|
###### Property alreadyKnown
|
|
1252
1270
|
|
|
1253
1271
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1258,6 +1276,15 @@ Potentially stop posting to additional transaction processors.
|
|
|
1258
1276
|
alreadyKnown?: boolean
|
|
1259
1277
|
```
|
|
1260
1278
|
|
|
1279
|
+
###### Property doubleSpend
|
|
1280
|
+
|
|
1281
|
+
service indicated this broadcast double spends at least one input
|
|
1282
|
+
`competingTxs` may be an array of txids that were first seen spends of at least one input.
|
|
1283
|
+
|
|
1284
|
+
```ts
|
|
1285
|
+
doubleSpend?: boolean
|
|
1286
|
+
```
|
|
1287
|
+
|
|
1261
1288
|
###### Property status
|
|
1262
1289
|
|
|
1263
1290
|
'success' - The transaction was accepted for processing
|
|
@@ -1268,6 +1295,19 @@ status: "success" | "error"
|
|
|
1268
1295
|
|
|
1269
1296
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1270
1297
|
|
|
1298
|
+
---
|
|
1299
|
+
##### Interface: PostTxResultForTxidError
|
|
1300
|
+
|
|
1301
|
+
```ts
|
|
1302
|
+
export interface PostTxResultForTxidError {
|
|
1303
|
+
status?: string;
|
|
1304
|
+
detail?: string;
|
|
1305
|
+
more?: object;
|
|
1306
|
+
}
|
|
1307
|
+
```
|
|
1308
|
+
|
|
1309
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1310
|
+
|
|
1271
1311
|
---
|
|
1272
1312
|
##### Interface: PostTxsResult
|
|
1273
1313
|
|
|
@@ -1559,10 +1599,10 @@ toStorageIdentityKey: string
|
|
|
1559
1599
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1560
1600
|
|
|
1561
1601
|
---
|
|
1562
|
-
##### Interface:
|
|
1602
|
+
##### Interface: ScriptTemplateParamsBRC29
|
|
1563
1603
|
|
|
1564
1604
|
```ts
|
|
1565
|
-
export interface
|
|
1605
|
+
export interface ScriptTemplateParamsBRC29 {
|
|
1566
1606
|
derivationPrefix?: string;
|
|
1567
1607
|
derivationSuffix?: string;
|
|
1568
1608
|
keyDeriver: KeyDeriverApi;
|
|
@@ -1597,6 +1637,7 @@ export interface SetupEnv {
|
|
|
1597
1637
|
chain: sdk.Chain;
|
|
1598
1638
|
identityKey: string;
|
|
1599
1639
|
identityKey2: string;
|
|
1640
|
+
filePath: string | undefined;
|
|
1600
1641
|
taalApiKey: string;
|
|
1601
1642
|
devKeys: Record<string, string>;
|
|
1602
1643
|
mySQLConnection: string;
|
|
@@ -1622,6 +1663,14 @@ A map of public keys (identity keys, hex strings) to private keys (hex strings).
|
|
|
1622
1663
|
devKeys: Record<string, string>
|
|
1623
1664
|
```
|
|
1624
1665
|
|
|
1666
|
+
###### Property filePath
|
|
1667
|
+
|
|
1668
|
+
Filepath to sqlite file to be used for identityKey wallet.
|
|
1669
|
+
|
|
1670
|
+
```ts
|
|
1671
|
+
filePath: string | undefined
|
|
1672
|
+
```
|
|
1673
|
+
|
|
1625
1674
|
###### Property identityKey
|
|
1626
1675
|
|
|
1627
1676
|
The user's primary identity key (public key).
|
|
@@ -3553,6 +3602,17 @@ export interface ValidWalletSignerArgs {
|
|
|
3553
3602
|
|
|
3554
3603
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3555
3604
|
|
|
3605
|
+
---
|
|
3606
|
+
##### Interface: ValidateGenerateChangeSdkParamsResult
|
|
3607
|
+
|
|
3608
|
+
```ts
|
|
3609
|
+
export interface ValidateGenerateChangeSdkParamsResult {
|
|
3610
|
+
hasMaxPossibleOutput?: number;
|
|
3611
|
+
}
|
|
3612
|
+
```
|
|
3613
|
+
|
|
3614
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3615
|
+
|
|
3556
3616
|
---
|
|
3557
3617
|
##### Interface: WalletArgs
|
|
3558
3618
|
|
|
@@ -3586,7 +3646,6 @@ export interface WalletServices {
|
|
|
3586
3646
|
getFiatExchangeRate(currency: "USD" | "GBP" | "EUR", base?: "USD" | "GBP" | "EUR"): Promise<number>;
|
|
3587
3647
|
getRawTx(txid: string, useNext?: boolean): Promise<GetRawTxResult>;
|
|
3588
3648
|
getMerklePath(txid: string, useNext?: boolean): Promise<GetMerklePathResult>;
|
|
3589
|
-
postTxs(beef: Beef, txids: string[]): Promise<PostTxsResult[]>;
|
|
3590
3649
|
postBeef(beef: Beef, txids: string[]): Promise<PostBeefResult[]>;
|
|
3591
3650
|
getUtxoStatus(output: string, outputFormat?: GetUtxoStatusOutputFormat, useNext?: boolean): Promise<GetUtxoStatusResult>;
|
|
3592
3651
|
hashToHeader(hash: string): Promise<sdk.BlockHeader>;
|
|
@@ -3594,7 +3653,7 @@ export interface WalletServices {
|
|
|
3594
3653
|
}
|
|
3595
3654
|
```
|
|
3596
3655
|
|
|
3597
|
-
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
3656
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
3598
3657
|
|
|
3599
3658
|
###### Property chain
|
|
3600
3659
|
|
|
@@ -3787,10 +3846,12 @@ export interface WalletServicesOptions {
|
|
|
3787
3846
|
exchangeratesapiKey?: string;
|
|
3788
3847
|
chaintracksFiatExchangeRatesUrl?: string;
|
|
3789
3848
|
chaintracks?: ChaintracksServiceClient;
|
|
3849
|
+
arcUrl: string;
|
|
3850
|
+
arcConfig: ArcConfig;
|
|
3790
3851
|
}
|
|
3791
3852
|
```
|
|
3792
3853
|
|
|
3793
|
-
See also: [BsvExchangeRate](./client.md#interface-bsvexchangerate), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates)
|
|
3854
|
+
See also: [ArcConfig](./services.md#interface-arcconfig), [BsvExchangeRate](./client.md#interface-bsvexchangerate), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates)
|
|
3794
3855
|
|
|
3795
3856
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3796
3857
|
|
|
@@ -3980,22 +4041,23 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3980
4041
|
|
|
3981
4042
|
| | | |
|
|
3982
4043
|
| --- | --- | --- |
|
|
3983
|
-
| [
|
|
3984
|
-
| [
|
|
3985
|
-
| [
|
|
3986
|
-
| [
|
|
3987
|
-
| [
|
|
3988
|
-
| [
|
|
3989
|
-
| [
|
|
3990
|
-
| [
|
|
3991
|
-
| [
|
|
3992
|
-
| [
|
|
3993
|
-
| [
|
|
3994
|
-
| [
|
|
3995
|
-
| [
|
|
3996
|
-
| [
|
|
3997
|
-
| [
|
|
3998
|
-
| [
|
|
4044
|
+
| [ARC](#class-arc) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
|
|
4045
|
+
| [CertOps](#class-certops) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
|
|
4046
|
+
| [EntityBase](#class-entitybase) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_INTERNAL](#class-werr_internal) |
|
|
4047
|
+
| [EntityCertificate](#class-entitycertificate) | [ServiceCollection](#class-servicecollection) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
|
|
4048
|
+
| [EntityCertificateField](#class-entitycertificatefield) | [Services](#class-services) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
4049
|
+
| [EntityCommission](#class-entitycommission) | [SetupClient](#class-setupclient) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
4050
|
+
| [EntityOutput](#class-entityoutput) | [StorageClient](#class-storageclient) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
4051
|
+
| [EntityOutputBasket](#class-entityoutputbasket) | [StorageProvider](#class-storageprovider) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
4052
|
+
| [EntityOutputTag](#class-entityoutputtag) | [StorageReader](#class-storagereader) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
4053
|
+
| [EntityOutputTagMap](#class-entityoutputtagmap) | [StorageReaderWriter](#class-storagereaderwriter) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
4054
|
+
| [EntityProvenTx](#class-entityproventx) | [StorageSyncReader](#class-storagesyncreader) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
4055
|
+
| [EntityProvenTxReq](#class-entityproventxreq) | [TaskCheckForProofs](#class-taskcheckforproofs) | [Wallet](#class-wallet) |
|
|
4056
|
+
| [EntitySyncState](#class-entitysyncstate) | [TaskClock](#class-taskclock) | [WalletError](#class-walleterror) |
|
|
4057
|
+
| [EntityTransaction](#class-entitytransaction) | [TaskFailAbandoned](#class-taskfailabandoned) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
4058
|
+
| [EntityTxLabel](#class-entitytxlabel) | [TaskNewHeader](#class-tasknewheader) | [WalletSigner](#class-walletsigner) |
|
|
4059
|
+
| [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskPurge](#class-taskpurge) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
4060
|
+
| [EntityUser](#class-entityuser) | [TaskReviewStatus](#class-taskreviewstatus) | [WhatsOnChain](#class-whatsonchain) |
|
|
3999
4061
|
| [MergeEntity](#class-mergeentity) | [TaskSendWaiting](#class-tasksendwaiting) | |
|
|
4000
4062
|
| [Monitor](#class-monitor) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) | |
|
|
4001
4063
|
|
|
@@ -4003,6 +4065,99 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4003
4065
|
|
|
4004
4066
|
---
|
|
4005
4067
|
|
|
4068
|
+
##### Class: ARC
|
|
4069
|
+
|
|
4070
|
+
Represents an ARC transaction broadcaster.
|
|
4071
|
+
|
|
4072
|
+
```ts
|
|
4073
|
+
export default class ARC {
|
|
4074
|
+
readonly URL: string;
|
|
4075
|
+
readonly apiKey: string | undefined;
|
|
4076
|
+
readonly deploymentId: string;
|
|
4077
|
+
readonly callbackUrl: string | undefined;
|
|
4078
|
+
readonly callbackToken: string | undefined;
|
|
4079
|
+
readonly headers: Record<string, string> | undefined;
|
|
4080
|
+
constructor(URL: string, config?: ArcConfig);
|
|
4081
|
+
constructor(URL: string, apiKey?: string);
|
|
4082
|
+
constructor(URL: string, config?: string | ArcConfig)
|
|
4083
|
+
async postRawTx(rawTx: HexString, txids?: string[]): Promise<sdk.PostTxResultForTxid>
|
|
4084
|
+
async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
|
|
4085
|
+
async getTxData(txid: string): Promise<ArcMinerGetTxData>
|
|
4086
|
+
}
|
|
4087
|
+
```
|
|
4088
|
+
|
|
4089
|
+
See also: [ArcConfig](./services.md#interface-arcconfig), [ArcMinerGetTxData](./services.md#interface-arcminergettxdata), [PostBeefResult](./client.md#interface-postbeefresult), [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
|
|
4090
|
+
|
|
4091
|
+
###### Constructor
|
|
4092
|
+
|
|
4093
|
+
Constructs an instance of the ARC broadcaster.
|
|
4094
|
+
|
|
4095
|
+
```ts
|
|
4096
|
+
constructor(URL: string, config?: ArcConfig)
|
|
4097
|
+
```
|
|
4098
|
+
See also: [ArcConfig](./services.md#interface-arcconfig)
|
|
4099
|
+
|
|
4100
|
+
Argument Details
|
|
4101
|
+
|
|
4102
|
+
+ **URL**
|
|
4103
|
+
+ The URL endpoint for the ARC API.
|
|
4104
|
+
+ **config**
|
|
4105
|
+
+ Configuration options for the ARC broadcaster.
|
|
4106
|
+
|
|
4107
|
+
###### Constructor
|
|
4108
|
+
|
|
4109
|
+
Constructs an instance of the ARC broadcaster.
|
|
4110
|
+
|
|
4111
|
+
```ts
|
|
4112
|
+
constructor(URL: string, apiKey?: string)
|
|
4113
|
+
```
|
|
4114
|
+
|
|
4115
|
+
Argument Details
|
|
4116
|
+
|
|
4117
|
+
+ **URL**
|
|
4118
|
+
+ The URL endpoint for the ARC API.
|
|
4119
|
+
+ **apiKey**
|
|
4120
|
+
+ The API key used for authorization with the ARC API.
|
|
4121
|
+
|
|
4122
|
+
###### Method getTxData
|
|
4123
|
+
|
|
4124
|
+
This seems to only work for recently submitted txids...but that's all we need to complete postBeef!
|
|
4125
|
+
|
|
4126
|
+
```ts
|
|
4127
|
+
async getTxData(txid: string): Promise<ArcMinerGetTxData>
|
|
4128
|
+
```
|
|
4129
|
+
See also: [ArcMinerGetTxData](./services.md#interface-arcminergettxdata)
|
|
4130
|
+
|
|
4131
|
+
###### Method postBeef
|
|
4132
|
+
|
|
4133
|
+
ARC does not natively support a postBeef end-point aware of multiple txids of interest in the Beef.
|
|
4134
|
+
|
|
4135
|
+
It does process multiple new transactions, however, which allows results for all txids of interest
|
|
4136
|
+
to be collected by the `/v1/tx/${txid}` endpoint.
|
|
4137
|
+
|
|
4138
|
+
```ts
|
|
4139
|
+
async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
|
|
4140
|
+
```
|
|
4141
|
+
See also: [PostBeefResult](./client.md#interface-postbeefresult)
|
|
4142
|
+
|
|
4143
|
+
###### Method postRawTx
|
|
4144
|
+
|
|
4145
|
+
The ARC '/v1/tx' endpoint, as of 2025-02-17 supports all of the following hex string formats:
|
|
4146
|
+
1. Single serialized raw transaction.
|
|
4147
|
+
2. Single EF serialized raw transaction (untested).
|
|
4148
|
+
3. V1 serialized Beef (results returned reflect only the last transaction in the beef)
|
|
4149
|
+
|
|
4150
|
+
The ARC '/v1/tx' endpoint, as of 2025-02-17 DOES NOT support the following hex string formats:
|
|
4151
|
+
1. V2 serialized Beef
|
|
4152
|
+
|
|
4153
|
+
```ts
|
|
4154
|
+
async postRawTx(rawTx: HexString, txids?: string[]): Promise<sdk.PostTxResultForTxid>
|
|
4155
|
+
```
|
|
4156
|
+
See also: [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
|
|
4157
|
+
|
|
4158
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4159
|
+
|
|
4160
|
+
---
|
|
4006
4161
|
##### Class: CertOps
|
|
4007
4162
|
|
|
4008
4163
|
```ts
|
|
@@ -5233,15 +5388,15 @@ destroyKey(): void
|
|
|
5233
5388
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5234
5389
|
|
|
5235
5390
|
---
|
|
5236
|
-
##### Class:
|
|
5391
|
+
##### Class: ScriptTemplateBRC29
|
|
5237
5392
|
|
|
5238
5393
|
Simple Authenticated BSV P2PKH Payment Protocol
|
|
5239
5394
|
https://brc.dev/29
|
|
5240
5395
|
|
|
5241
5396
|
```ts
|
|
5242
|
-
export class
|
|
5397
|
+
export class ScriptTemplateBRC29 implements ScriptTemplate {
|
|
5243
5398
|
p2pkh: P2PKH;
|
|
5244
|
-
constructor(public params:
|
|
5399
|
+
constructor(public params: ScriptTemplateParamsBRC29)
|
|
5245
5400
|
getKeyID()
|
|
5246
5401
|
getKeyDeriver(privKey: PrivateKey | HexString): KeyDeriverApi
|
|
5247
5402
|
lock(lockerPrivKey: string, unlockerPubKey: string): LockingScript
|
|
@@ -5250,7 +5405,7 @@ export class ScriptTemplateSABPPP implements ScriptTemplate {
|
|
|
5250
5405
|
}
|
|
5251
5406
|
```
|
|
5252
5407
|
|
|
5253
|
-
See also: [
|
|
5408
|
+
See also: [ScriptTemplateParamsBRC29](./client.md#interface-scripttemplateparamsbrc29), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock)
|
|
5254
5409
|
|
|
5255
5410
|
###### Property unlockLength
|
|
5256
5411
|
|
|
@@ -5262,6 +5417,41 @@ unlockLength = 108
|
|
|
5262
5417
|
|
|
5263
5418
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5264
5419
|
|
|
5420
|
+
---
|
|
5421
|
+
##### Class: SdkWhatsOnChain
|
|
5422
|
+
|
|
5423
|
+
Represents a chain tracker based on What's On Chain .
|
|
5424
|
+
|
|
5425
|
+
```ts
|
|
5426
|
+
export default class SdkWhatsOnChain implements ChainTracker {
|
|
5427
|
+
readonly network: string;
|
|
5428
|
+
readonly apiKey: string;
|
|
5429
|
+
protected readonly URL: string;
|
|
5430
|
+
protected readonly httpClient: HttpClient;
|
|
5431
|
+
constructor(network: "main" | "test" | "stn" = "main", config: WhatsOnChainConfig = {})
|
|
5432
|
+
async isValidRootForHeight(root: string, height: number): Promise<boolean>
|
|
5433
|
+
async currentHeight(): Promise<number>
|
|
5434
|
+
protected getHttpHeaders(): Record<string, string>
|
|
5435
|
+
}
|
|
5436
|
+
```
|
|
5437
|
+
|
|
5438
|
+
###### Constructor
|
|
5439
|
+
|
|
5440
|
+
Constructs an instance of the WhatsOnChain ChainTracker.
|
|
5441
|
+
|
|
5442
|
+
```ts
|
|
5443
|
+
constructor(network: "main" | "test" | "stn" = "main", config: WhatsOnChainConfig = {})
|
|
5444
|
+
```
|
|
5445
|
+
|
|
5446
|
+
Argument Details
|
|
5447
|
+
|
|
5448
|
+
+ **network**
|
|
5449
|
+
+ The BSV network to use when calling the WhatsOnChain API.
|
|
5450
|
+
+ **config**
|
|
5451
|
+
+ Configuration options for the WhatsOnChain ChainTracker.
|
|
5452
|
+
|
|
5453
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5454
|
+
|
|
5265
5455
|
---
|
|
5266
5456
|
##### Class: ServiceCollection
|
|
5267
5457
|
|
|
@@ -5301,9 +5491,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5301
5491
|
export class Services implements sdk.WalletServices {
|
|
5302
5492
|
static createDefaultOptions(chain: sdk.Chain): sdk.WalletServicesOptions
|
|
5303
5493
|
options: sdk.WalletServicesOptions;
|
|
5494
|
+
whatsonchain: WhatsOnChain;
|
|
5495
|
+
arc: ARC;
|
|
5304
5496
|
getMerklePathServices: ServiceCollection<sdk.GetMerklePathService>;
|
|
5305
5497
|
getRawTxServices: ServiceCollection<sdk.GetRawTxService>;
|
|
5306
|
-
postTxsServices: ServiceCollection<sdk.PostTxsService>;
|
|
5307
5498
|
postBeefServices: ServiceCollection<sdk.PostBeefService>;
|
|
5308
5499
|
getUtxoStatusServices: ServiceCollection<sdk.GetUtxoStatusService>;
|
|
5309
5500
|
updateFiatExchangeRateServices: ServiceCollection<sdk.UpdateFiatExchangeRateService>;
|
|
@@ -5314,11 +5505,9 @@ export class Services implements sdk.WalletServices {
|
|
|
5314
5505
|
async getFiatExchangeRate(currency: "USD" | "GBP" | "EUR", base?: "USD" | "GBP" | "EUR"): Promise<number>
|
|
5315
5506
|
get getProofsCount()
|
|
5316
5507
|
get getRawTxsCount()
|
|
5317
|
-
get postTxsServicesCount()
|
|
5318
5508
|
get postBeefServicesCount()
|
|
5319
5509
|
get getUtxoStatsCount()
|
|
5320
5510
|
async getUtxoStatus(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat, useNext?: boolean): Promise<sdk.GetUtxoStatusResult>
|
|
5321
|
-
async postTxs(beef: Beef, txids: string[]): Promise<sdk.PostTxsResult[]>
|
|
5322
5511
|
async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult[]>
|
|
5323
5512
|
async getRawTx(txid: string, useNext?: boolean): Promise<sdk.GetRawTxResult>
|
|
5324
5513
|
async invokeChaintracksWithRetry<R>(method: () => Promise<R>): Promise<R>
|
|
@@ -5332,18 +5521,7 @@ export class Services implements sdk.WalletServices {
|
|
|
5332
5521
|
}
|
|
5333
5522
|
```
|
|
5334
5523
|
|
|
5335
|
-
See also: [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), [
|
|
5336
|
-
|
|
5337
|
-
###### Method postTxs
|
|
5338
|
-
|
|
5339
|
-
The beef must contain at least each rawTx for each txid.
|
|
5340
|
-
Some services may require input transactions as well.
|
|
5341
|
-
These will be fetched if missing, greatly extending the service response time.
|
|
5342
|
-
|
|
5343
|
-
```ts
|
|
5344
|
-
async postTxs(beef: Beef, txids: string[]): Promise<sdk.PostTxsResult[]>
|
|
5345
|
-
```
|
|
5346
|
-
See also: [PostTxsResult](./client.md#interface-posttxsresult)
|
|
5524
|
+
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)
|
|
5347
5525
|
|
|
5348
5526
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5349
5527
|
|
|
@@ -5370,21 +5548,21 @@ export abstract class SetupClient {
|
|
|
5370
5548
|
const mainPrivKey2 = PrivateKey.fromRandom();
|
|
5371
5549
|
const mainIdentityKey2 = mainPrivKey2.toPublicKey().toString();
|
|
5372
5550
|
const log = `
|
|
5373
|
-
|
|
5374
|
-
|
|
5375
|
-
|
|
5376
|
-
|
|
5377
|
-
|
|
5378
|
-
|
|
5379
|
-
|
|
5380
|
-
|
|
5381
|
-
|
|
5382
|
-
|
|
5383
|
-
|
|
5384
|
-
|
|
5385
|
-
}
|
|
5386
|
-
|
|
5387
|
-
|
|
5551
|
+
# .env file template for working with wallet-toolbox Setup functions.
|
|
5552
|
+
MY_TEST_IDENTITY = '${testIdentityKey1}'
|
|
5553
|
+
MY_TEST_IDENTITY2 = '${testIdentityKey2}'
|
|
5554
|
+
MY_MAIN_IDENTITY = '${mainIdentityKey1}'
|
|
5555
|
+
MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
|
|
5556
|
+
MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
|
|
5557
|
+
TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
|
|
5558
|
+
MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
|
|
5559
|
+
DEV_KEYS = '{
|
|
5560
|
+
"${testIdentityKey1}": "${testPrivKey1.toString()}",
|
|
5561
|
+
"${testIdentityKey2}": "${testPrivKey2.toString()}"
|
|
5562
|
+
"${mainIdentityKey1}": "${mainPrivKey1.toString()}",
|
|
5563
|
+
"${mainIdentityKey2}": "${mainPrivKey2.toString()}"
|
|
5564
|
+
}'
|
|
5565
|
+
`;
|
|
5388
5566
|
console.log(log);
|
|
5389
5567
|
return log;
|
|
5390
5568
|
}
|
|
@@ -5395,6 +5573,9 @@ export abstract class SetupClient {
|
|
|
5395
5573
|
const identityKey2 = chain === "main"
|
|
5396
5574
|
? process.env.MY_MAIN_IDENTITY2
|
|
5397
5575
|
: process.env.MY_TEST_IDENTITY2;
|
|
5576
|
+
const filePath = chain === "main"
|
|
5577
|
+
? process.env.MY_MAIN_FILEPATH
|
|
5578
|
+
: process.env.MY_TEST_FILEPATH;
|
|
5398
5579
|
const DEV_KEYS = process.env.DEV_KEYS || "{}";
|
|
5399
5580
|
const mySQLConnection = process.env.MYSQL_CONNECTION || "{}";
|
|
5400
5581
|
const taalApiKey = verifyTruthy(chain === "main"
|
|
@@ -5406,6 +5587,7 @@ export abstract class SetupClient {
|
|
|
5406
5587
|
chain,
|
|
5407
5588
|
identityKey,
|
|
5408
5589
|
identityKey2,
|
|
5590
|
+
filePath,
|
|
5409
5591
|
taalApiKey,
|
|
5410
5592
|
devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
|
|
5411
5593
|
mySQLConnection
|
|
@@ -5453,9 +5635,8 @@ export abstract class SetupClient {
|
|
|
5453
5635
|
}
|
|
5454
5636
|
static async createWalletClient(args: SetupWalletClientArgs): Promise<SetupWalletClient> {
|
|
5455
5637
|
const wo = await SetupClient.createWallet(args);
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
const endpointUrl = args.endpointUrl || "https://staging-dojo.babbage.systems";
|
|
5638
|
+
const endpointUrl = args.endpointUrl ||
|
|
5639
|
+
`https://${args.env.chain !== "main" ? "staging-" : ""}storage.babbage.systems`;
|
|
5459
5640
|
const client = new StorageClient(wo.wallet, endpointUrl);
|
|
5460
5641
|
await wo.storage.addWalletStorageProvider(client);
|
|
5461
5642
|
await wo.storage.makeAvailable();
|
|
@@ -5536,7 +5717,7 @@ export abstract class SetupClient {
|
|
|
5536
5717
|
}
|
|
5537
5718
|
```
|
|
5538
5719
|
|
|
5539
|
-
See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [StorageClient](./storage.md#class-storageclient), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [
|
|
5720
|
+
See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [Setup](./setup.md#class-setup), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [StorageClient](./storage.md#class-storageclient), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [verifyTruthy](./client.md#function-verifytruthy)
|
|
5540
5721
|
|
|
5541
5722
|
###### Method createWallet
|
|
5542
5723
|
|
|
@@ -5605,6 +5786,9 @@ static getEnv(chain: sdk.Chain): SetupEnv {
|
|
|
5605
5786
|
const identityKey2 = chain === "main"
|
|
5606
5787
|
? process.env.MY_MAIN_IDENTITY2
|
|
5607
5788
|
: process.env.MY_TEST_IDENTITY2;
|
|
5789
|
+
const filePath = chain === "main"
|
|
5790
|
+
? process.env.MY_MAIN_FILEPATH
|
|
5791
|
+
: process.env.MY_TEST_FILEPATH;
|
|
5608
5792
|
const DEV_KEYS = process.env.DEV_KEYS || "{}";
|
|
5609
5793
|
const mySQLConnection = process.env.MYSQL_CONNECTION || "{}";
|
|
5610
5794
|
const taalApiKey = verifyTruthy(chain === "main"
|
|
@@ -5616,6 +5800,7 @@ static getEnv(chain: sdk.Chain): SetupEnv {
|
|
|
5616
5800
|
chain,
|
|
5617
5801
|
identityKey,
|
|
5618
5802
|
identityKey2,
|
|
5803
|
+
filePath,
|
|
5619
5804
|
taalApiKey,
|
|
5620
5805
|
devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
|
|
5621
5806
|
mySQLConnection
|
|
@@ -5653,25 +5838,26 @@ static makeEnv(): string {
|
|
|
5653
5838
|
const mainPrivKey2 = PrivateKey.fromRandom();
|
|
5654
5839
|
const mainIdentityKey2 = mainPrivKey2.toPublicKey().toString();
|
|
5655
5840
|
const log = `
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
}
|
|
5669
|
-
|
|
5670
|
-
|
|
5841
|
+
# .env file template for working with wallet-toolbox Setup functions.
|
|
5842
|
+
MY_TEST_IDENTITY = '${testIdentityKey1}'
|
|
5843
|
+
MY_TEST_IDENTITY2 = '${testIdentityKey2}'
|
|
5844
|
+
MY_MAIN_IDENTITY = '${mainIdentityKey1}'
|
|
5845
|
+
MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
|
|
5846
|
+
MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
|
|
5847
|
+
TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
|
|
5848
|
+
MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
|
|
5849
|
+
DEV_KEYS = '{
|
|
5850
|
+
"${testIdentityKey1}": "${testPrivKey1.toString()}",
|
|
5851
|
+
"${testIdentityKey2}": "${testPrivKey2.toString()}"
|
|
5852
|
+
"${mainIdentityKey1}": "${mainPrivKey1.toString()}",
|
|
5853
|
+
"${mainIdentityKey2}": "${mainPrivKey2.toString()}"
|
|
5854
|
+
}'
|
|
5855
|
+
`;
|
|
5671
5856
|
console.log(log);
|
|
5672
5857
|
return log;
|
|
5673
5858
|
}
|
|
5674
5859
|
```
|
|
5860
|
+
See also: [Setup](./setup.md#class-setup)
|
|
5675
5861
|
|
|
5676
5862
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5677
5863
|
|
|
@@ -7149,6 +7335,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
7149
7335
|
async getHeaderForHeight(args: GetHeaderArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetHeaderResult>
|
|
7150
7336
|
async getNetwork(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetNetworkResult>
|
|
7151
7337
|
async getVersion(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetVersionResult>
|
|
7338
|
+
async sweepTo(toWallet: Wallet): Promise<void>
|
|
7152
7339
|
}
|
|
7153
7340
|
```
|
|
7154
7341
|
|
|
@@ -7192,6 +7379,20 @@ Argument Details
|
|
|
7192
7379
|
+ **newKnownTxids**
|
|
7193
7380
|
+ Optional. Additional new txids known to be valid by the caller to be merged.
|
|
7194
7381
|
|
|
7382
|
+
###### Method sweepTo
|
|
7383
|
+
|
|
7384
|
+
Transfer all possible satoshis held by this wallet to `toWallet`.
|
|
7385
|
+
|
|
7386
|
+
```ts
|
|
7387
|
+
async sweepTo(toWallet: Wallet): Promise<void>
|
|
7388
|
+
```
|
|
7389
|
+
See also: [Wallet](./client.md#class-wallet)
|
|
7390
|
+
|
|
7391
|
+
Argument Details
|
|
7392
|
+
|
|
7393
|
+
+ **toWallet**
|
|
7394
|
+
+ wallet which will receive this wallet's satoshis.
|
|
7395
|
+
|
|
7195
7396
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7196
7397
|
|
|
7197
7398
|
---
|
|
@@ -7477,49 +7678,100 @@ Argument Details
|
|
|
7477
7678
|
|
|
7478
7679
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7479
7680
|
|
|
7681
|
+
---
|
|
7682
|
+
##### Class: WhatsOnChain
|
|
7683
|
+
|
|
7684
|
+
```ts
|
|
7685
|
+
export class WhatsOnChain extends SdkWhatsOnChain {
|
|
7686
|
+
constructor(chain: sdk.Chain = "main", config: WhatsOnChainConfig = {})
|
|
7687
|
+
async getTxPropagation(txid: string): Promise<number>
|
|
7688
|
+
async getRawTx(txid: string): Promise<string | undefined>
|
|
7689
|
+
async getRawTxResult(txid: string): Promise<sdk.GetRawTxResult>
|
|
7690
|
+
async postRawTx(rawTx: HexString): Promise<string>
|
|
7691
|
+
async getMerklePath(txid: string, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
7692
|
+
async updateBsvExchangeRate(rate?: sdk.BsvExchangeRate, updateMsecs?: number): Promise<sdk.BsvExchangeRate>
|
|
7693
|
+
async getUtxoStatus(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat): Promise<sdk.GetUtxoStatusResult>
|
|
7694
|
+
}
|
|
7695
|
+
```
|
|
7696
|
+
|
|
7697
|
+
See also: [BsvExchangeRate](./client.md#interface-bsvexchangerate), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [SdkWhatsOnChain](./services.md#class-sdkwhatsonchain), [WalletServices](./client.md#interface-walletservices)
|
|
7698
|
+
|
|
7699
|
+
###### Method getRawTx
|
|
7700
|
+
|
|
7701
|
+
May return undefined for unmined transactions that are in the mempool.
|
|
7702
|
+
|
|
7703
|
+
```ts
|
|
7704
|
+
async getRawTx(txid: string): Promise<string | undefined>
|
|
7705
|
+
```
|
|
7706
|
+
|
|
7707
|
+
Returns
|
|
7708
|
+
|
|
7709
|
+
raw transaction as hex string or undefined if txid not found in mined block.
|
|
7710
|
+
|
|
7711
|
+
###### Method getTxPropagation
|
|
7712
|
+
|
|
7713
|
+
2025-02-16 throwing internal server error 500.
|
|
7714
|
+
|
|
7715
|
+
```ts
|
|
7716
|
+
async getTxPropagation(txid: string): Promise<number>
|
|
7717
|
+
```
|
|
7718
|
+
|
|
7719
|
+
###### Method postRawTx
|
|
7720
|
+
|
|
7721
|
+
```ts
|
|
7722
|
+
async postRawTx(rawTx: HexString): Promise<string>
|
|
7723
|
+
```
|
|
7724
|
+
|
|
7725
|
+
Returns
|
|
7726
|
+
|
|
7727
|
+
txid returned by transaction processor of transaction broadcast
|
|
7728
|
+
|
|
7729
|
+
Argument Details
|
|
7730
|
+
|
|
7731
|
+
+ **rawTx**
|
|
7732
|
+
+ raw transaction to broadcast as hex string
|
|
7733
|
+
|
|
7734
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7735
|
+
|
|
7480
7736
|
---
|
|
7481
7737
|
#### Functions
|
|
7482
7738
|
|
|
7483
7739
|
| | | |
|
|
7484
7740
|
| --- | --- | --- |
|
|
7485
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [
|
|
7486
|
-
| [
|
|
7487
|
-
| [
|
|
7488
|
-
| [
|
|
7489
|
-
| [
|
|
7490
|
-
| [
|
|
7491
|
-
| [
|
|
7492
|
-
| [
|
|
7493
|
-
| [
|
|
7494
|
-
| [
|
|
7495
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
7496
|
-
| [
|
|
7497
|
-
| [
|
|
7498
|
-
| [createAction](#function-createaction) | [
|
|
7499
|
-
| [
|
|
7500
|
-
| [
|
|
7501
|
-
| [
|
|
7502
|
-
| [
|
|
7503
|
-
| [
|
|
7504
|
-
| [
|
|
7505
|
-
| [
|
|
7506
|
-
| [
|
|
7507
|
-
| [
|
|
7508
|
-
| [
|
|
7509
|
-
| [
|
|
7510
|
-
| [
|
|
7511
|
-
| [
|
|
7512
|
-
| [
|
|
7513
|
-
| [
|
|
7514
|
-
| [
|
|
7515
|
-
| [
|
|
7516
|
-
| [
|
|
7517
|
-
| [
|
|
7518
|
-
| [
|
|
7519
|
-
| [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateBasketInsertion](#function-validatebasketinsertion) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
7520
|
-
| [makeAtomicBeef](#function-makeatomicbeef) | [validateCreateActionArgs](#function-validatecreateactionargs) | [verifyTruthy](#function-verifytruthy) |
|
|
7521
|
-
| [makeAtomicBeef](#function-makeatomicbeef) | [validateCreateActionInput](#function-validatecreateactioninput) | [wait](#function-wait) |
|
|
7522
|
-
| [makeErrorResult](#function-makeerrorresult) | [validateCreateActionOptions](#function-validatecreateactionoptions) | |
|
|
7741
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [offsetPubKey](#function-offsetpubkey) | [validateInteger](#function-validateinteger) |
|
|
7742
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
|
|
7743
|
+
| [arraysEqual](#function-arraysequal) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
|
|
7744
|
+
| [asArray](#function-asarray) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListActionsArgs](#function-validatelistactionsargs) |
|
|
7745
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [processAction](#function-processaction) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
|
|
7746
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
|
|
7747
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [proveCertificate](#function-provecertificate) | [validateOptionalInteger](#function-validateoptionalinteger) |
|
|
7748
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [randomBytes](#function-randombytes) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
|
|
7749
|
+
| [asString](#function-asstring) | [randomBytesBase64](#function-randombytesbase64) | [validateOriginator](#function-validateoriginator) |
|
|
7750
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [randomBytesHex](#function-randombyteshex) | [validateOutpointString](#function-validateoutpointstring) |
|
|
7751
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [sha256Hash](#function-sha256hash) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
|
|
7752
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [signAction](#function-signaction) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
|
|
7753
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [stampLog](#function-stamplog) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
|
|
7754
|
+
| [createAction](#function-createaction) | [stampLogFormat](#function-stamplogformat) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
|
|
7755
|
+
| [createAction](#function-createaction) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [validateSatoshis](#function-validatesatoshis) |
|
|
7756
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [toWalletNetwork](#function-towalletnetwork) | [validateScriptHash](#function-validatescripthash) |
|
|
7757
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [transactionInputSize](#function-transactioninputsize) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
7758
|
+
| [createSyncMap](#function-createsyncmap) | [transactionOutputSize](#function-transactionoutputsize) | [validateSignActionArgs](#function-validatesignactionargs) |
|
|
7759
|
+
| [doubleSha256BE](#function-doublesha256be) | [transactionSize](#function-transactionsize) | [validateSignActionOptions](#function-validatesignactionoptions) |
|
|
7760
|
+
| [doubleSha256HashLE](#function-doublesha256hashle) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
7761
|
+
| [generateChangeSdk](#function-generatechangesdk) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [validateStringLength](#function-validatestringlength) |
|
|
7762
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [validateAbortActionArgs](#function-validateabortactionargs) | [validateWalletPayment](#function-validatewalletpayment) |
|
|
7763
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [varUintSize](#function-varuintsize) |
|
|
7764
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | [verifyHexString](#function-verifyhexstring) |
|
|
7765
|
+
| [getIdentityKey](#function-getidentitykey) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) | [verifyId](#function-verifyid) |
|
|
7766
|
+
| [getSyncChunk](#function-getsyncchunk) | [validateBasketInsertion](#function-validatebasketinsertion) | [verifyInteger](#function-verifyinteger) |
|
|
7767
|
+
| [internalizeAction](#function-internalizeaction) | [validateCreateActionArgs](#function-validatecreateactionargs) | [verifyNumber](#function-verifynumber) |
|
|
7768
|
+
| [internalizeAction](#function-internalizeaction) | [validateCreateActionInput](#function-validatecreateactioninput) | [verifyOne](#function-verifyone) |
|
|
7769
|
+
| [isHexString](#function-ishexstring) | [validateCreateActionOptions](#function-validatecreateactionoptions) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
7770
|
+
| [listCertificates](#function-listcertificates) | [validateCreateActionOutput](#function-validatecreateactionoutput) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
7771
|
+
| [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) | [verifyTruthy](#function-verifytruthy) |
|
|
7772
|
+
| [makeAtomicBeef](#function-makeatomicbeef) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) | [wait](#function-wait) |
|
|
7773
|
+
| [makeAtomicBeef](#function-makeatomicbeef) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) | |
|
|
7774
|
+
| [maxDate](#function-maxdate) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) | |
|
|
7523
7775
|
|
|
7524
7776
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7525
7777
|
|
|
@@ -7535,6 +7787,17 @@ See also: [AuthId](./client.md#interface-authid), [ValidAcquireDirectCertificate
|
|
|
7535
7787
|
|
|
7536
7788
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7537
7789
|
|
|
7790
|
+
---
|
|
7791
|
+
##### Function: arcDefaultUrl
|
|
7792
|
+
|
|
7793
|
+
```ts
|
|
7794
|
+
export function arcDefaultUrl(chain: sdk.Chain): string
|
|
7795
|
+
```
|
|
7796
|
+
|
|
7797
|
+
See also: [Chain](./client.md#type-chain)
|
|
7798
|
+
|
|
7799
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7800
|
+
|
|
7538
7801
|
---
|
|
7539
7802
|
##### Function: arraysEqual
|
|
7540
7803
|
|
|
@@ -7883,45 +8146,6 @@ See also: [CertOpsWallet](./client.md#interface-certopswallet)
|
|
|
7883
8146
|
|
|
7884
8147
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7885
8148
|
|
|
7886
|
-
---
|
|
7887
|
-
##### Function: getMerklePathFromTaalARC
|
|
7888
|
-
|
|
7889
|
-
```ts
|
|
7890
|
-
export async function getMerklePathFromTaalARC(txid: string, config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
7891
|
-
```
|
|
7892
|
-
|
|
7893
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
7894
|
-
|
|
7895
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7896
|
-
|
|
7897
|
-
---
|
|
7898
|
-
##### Function: getMerklePathFromWhatsOnChainTsc
|
|
7899
|
-
|
|
7900
|
-
WhatOnChain.com has their own "hash/pos/R/L" proof format and a more TSC compliant proof format.
|
|
7901
|
-
|
|
7902
|
-
The "/proof/tsc" endpoint is much closer to the TSC specification. It provides "index" directly and each node is just the provided hash value.
|
|
7903
|
-
The "targetType" is unspecified and thus defaults to block header hash, requiring a Chaintracks lookup to get the merkleRoot...
|
|
7904
|
-
Duplicate hash values are provided in full instead of being replaced by "*".
|
|
7905
|
-
|
|
7906
|
-
```ts
|
|
7907
|
-
export async function getMerklePathFromWhatsOnChainTsc(txid: string, chain: sdk.Chain, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
7908
|
-
```
|
|
7909
|
-
|
|
7910
|
-
See also: [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
7911
|
-
|
|
7912
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7913
|
-
|
|
7914
|
-
---
|
|
7915
|
-
##### Function: getRawTxFromWhatsOnChain
|
|
7916
|
-
|
|
7917
|
-
```ts
|
|
7918
|
-
export async function getRawTxFromWhatsOnChain(txid: string, chain: sdk.Chain): Promise<sdk.GetRawTxResult>
|
|
7919
|
-
```
|
|
7920
|
-
|
|
7921
|
-
See also: [Chain](./client.md#type-chain), [GetRawTxResult](./client.md#interface-getrawtxresult)
|
|
7922
|
-
|
|
7923
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7924
|
-
|
|
7925
8149
|
---
|
|
7926
8150
|
##### Function: getSyncChunk
|
|
7927
8151
|
|
|
@@ -7935,28 +8159,6 @@ See also: [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [S
|
|
|
7935
8159
|
|
|
7936
8160
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7937
8161
|
|
|
7938
|
-
---
|
|
7939
|
-
##### Function: getTaalArcServiceConfig
|
|
7940
|
-
|
|
7941
|
-
```ts
|
|
7942
|
-
export function getTaalArcServiceConfig(chain: sdk.Chain, apiKey: string): ArcServiceConfig
|
|
7943
|
-
```
|
|
7944
|
-
|
|
7945
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [Chain](./client.md#type-chain)
|
|
7946
|
-
|
|
7947
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7948
|
-
|
|
7949
|
-
---
|
|
7950
|
-
##### Function: getUtxoStatusFromWhatsOnChain
|
|
7951
|
-
|
|
7952
|
-
```ts
|
|
7953
|
-
export async function getUtxoStatusFromWhatsOnChain(output: string, chain: sdk.Chain, outputFormat?: sdk.GetUtxoStatusOutputFormat): Promise<sdk.GetUtxoStatusResult>
|
|
7954
|
-
```
|
|
7955
|
-
|
|
7956
|
-
See also: [Chain](./client.md#type-chain), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
7957
|
-
|
|
7958
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7959
|
-
|
|
7960
8162
|
---
|
|
7961
8163
|
##### Function: internalizeAction
|
|
7962
8164
|
|
|
@@ -8079,61 +8281,6 @@ export function makeAtomicBeef(tx: BsvTransaction, beef: number[] | Beef): numbe
|
|
|
8079
8281
|
|
|
8080
8282
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8081
8283
|
|
|
8082
|
-
---
|
|
8083
|
-
##### Function: makeErrorResult
|
|
8084
|
-
|
|
8085
|
-
```ts
|
|
8086
|
-
export function makeErrorResult(error: sdk.WalletError, miner: ArcServiceConfig, beef: number[], txids: string[], dd?: ArcMinerPostBeefDataApi): sdk.PostBeefResult
|
|
8087
|
-
```
|
|
8088
|
-
|
|
8089
|
-
See also: [ArcMinerPostBeefDataApi](./services.md#interface-arcminerpostbeefdataapi), [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult), [WalletError](./client.md#class-walleterror)
|
|
8090
|
-
|
|
8091
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8092
|
-
|
|
8093
|
-
---
|
|
8094
|
-
##### Function: makeGetMerklePathFromTaalARC
|
|
8095
|
-
|
|
8096
|
-
```ts
|
|
8097
|
-
export function makeGetMerklePathFromTaalARC(config: ArcServiceConfig): sdk.GetMerklePathService
|
|
8098
|
-
```
|
|
8099
|
-
|
|
8100
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [GetMerklePathService](./client.md#type-getmerklepathservice)
|
|
8101
|
-
|
|
8102
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8103
|
-
|
|
8104
|
-
---
|
|
8105
|
-
##### Function: makePostBeefResult
|
|
8106
|
-
|
|
8107
|
-
```ts
|
|
8108
|
-
export function makePostBeefResult(dd: ArcMinerPostBeefDataApi, miner: ArcServiceConfig, beef: number[], txids: string[]): sdk.PostBeefResult
|
|
8109
|
-
```
|
|
8110
|
-
|
|
8111
|
-
See also: [ArcMinerPostBeefDataApi](./services.md#interface-arcminerpostbeefdataapi), [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
8112
|
-
|
|
8113
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8114
|
-
|
|
8115
|
-
---
|
|
8116
|
-
##### Function: makePostBeefToTaalARC
|
|
8117
|
-
|
|
8118
|
-
```ts
|
|
8119
|
-
export function makePostBeefToTaalARC(config: ArcServiceConfig): sdk.PostBeefService
|
|
8120
|
-
```
|
|
8121
|
-
|
|
8122
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefService](./client.md#type-postbeefservice)
|
|
8123
|
-
|
|
8124
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8125
|
-
|
|
8126
|
-
---
|
|
8127
|
-
##### Function: makePostTxsToTaalARC
|
|
8128
|
-
|
|
8129
|
-
```ts
|
|
8130
|
-
export function makePostTxsToTaalARC(config: ArcServiceConfig): sdk.PostTxsService
|
|
8131
|
-
```
|
|
8132
|
-
|
|
8133
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostTxsService](./client.md#type-posttxsservice)
|
|
8134
|
-
|
|
8135
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8136
|
-
|
|
8137
8284
|
---
|
|
8138
8285
|
##### Function: maxDate
|
|
8139
8286
|
|
|
@@ -8187,44 +8334,6 @@ export function parseWalletOutpoint(outpoint: string): {
|
|
|
8187
8334
|
|
|
8188
8335
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8189
8336
|
|
|
8190
|
-
---
|
|
8191
|
-
##### Function: postBeefToArcMiner
|
|
8192
|
-
|
|
8193
|
-
```ts
|
|
8194
|
-
export async function postBeefToArcMiner(beef: Beef | number[], txids: string[], config: ArcServiceConfig): Promise<sdk.PostBeefResult>
|
|
8195
|
-
```
|
|
8196
|
-
|
|
8197
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
8198
|
-
|
|
8199
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8200
|
-
|
|
8201
|
-
---
|
|
8202
|
-
##### Function: postBeefToTaalArcMiner
|
|
8203
|
-
|
|
8204
|
-
```ts
|
|
8205
|
-
export async function postBeefToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostBeefResult>
|
|
8206
|
-
```
|
|
8207
|
-
|
|
8208
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult), [WalletServices](./client.md#interface-walletservices)
|
|
8209
|
-
|
|
8210
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8211
|
-
|
|
8212
|
-
---
|
|
8213
|
-
##### Function: postTxsToTaalArcMiner
|
|
8214
|
-
|
|
8215
|
-
```ts
|
|
8216
|
-
export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostTxsResult>
|
|
8217
|
-
```
|
|
8218
|
-
|
|
8219
|
-
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostTxsResult](./client.md#interface-posttxsresult), [WalletServices](./client.md#interface-walletservices)
|
|
8220
|
-
|
|
8221
|
-
Argument Details
|
|
8222
|
-
|
|
8223
|
-
+ **txs**
|
|
8224
|
-
+ All transactions must have source transactions. Will just source locking scripts and satoshis do?? toHexEF() is used.
|
|
8225
|
-
|
|
8226
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8227
|
-
|
|
8228
8337
|
---
|
|
8229
8338
|
##### Function: processAction
|
|
8230
8339
|
|
|
@@ -8473,17 +8582,6 @@ Argument Details
|
|
|
8473
8582
|
|
|
8474
8583
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8475
8584
|
|
|
8476
|
-
---
|
|
8477
|
-
##### Function: updateBsvExchangeRate
|
|
8478
|
-
|
|
8479
|
-
```ts
|
|
8480
|
-
export async function updateBsvExchangeRate(rate?: sdk.BsvExchangeRate, updateMsecs?: number): Promise<sdk.BsvExchangeRate>
|
|
8481
|
-
```
|
|
8482
|
-
|
|
8483
|
-
See also: [BsvExchangeRate](./client.md#interface-bsvexchangerate)
|
|
8484
|
-
|
|
8485
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8486
|
-
|
|
8487
8585
|
---
|
|
8488
8586
|
##### Function: updateChaintracksFiatExchangeRates
|
|
8489
8587
|
|
|
@@ -8641,10 +8739,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
8641
8739
|
##### Function: validateGenerateChangeSdkParams
|
|
8642
8740
|
|
|
8643
8741
|
```ts
|
|
8644
|
-
export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams)
|
|
8742
|
+
export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams): ValidateGenerateChangeSdkParamsResult
|
|
8645
8743
|
```
|
|
8646
8744
|
|
|
8647
|
-
See also: [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams)
|
|
8745
|
+
See also: [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams), [ValidateGenerateChangeSdkParamsResult](./storage.md#interface-validategeneratechangesdkparamsresult)
|
|
8648
8746
|
|
|
8649
8747
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8650
8748
|
|
|
@@ -9138,10 +9236,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
9138
9236
|
##### Type: GetMerklePathService
|
|
9139
9237
|
|
|
9140
9238
|
```ts
|
|
9141
|
-
export type GetMerklePathService = (txid: string,
|
|
9239
|
+
export type GetMerklePathService = (txid: string, services: WalletServices) => Promise<GetMerklePathResult>
|
|
9142
9240
|
```
|
|
9143
9241
|
|
|
9144
|
-
See also: [
|
|
9242
|
+
See also: [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
9145
9243
|
|
|
9146
9244
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9147
9245
|
|
|
@@ -9169,10 +9267,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
9169
9267
|
##### Type: GetUtxoStatusService
|
|
9170
9268
|
|
|
9171
9269
|
```ts
|
|
9172
|
-
export type GetUtxoStatusService = (output: string,
|
|
9270
|
+
export type GetUtxoStatusService = (output: string, outputFormat?: GetUtxoStatusOutputFormat) => Promise<GetUtxoStatusResult>
|
|
9173
9271
|
```
|
|
9174
9272
|
|
|
9175
|
-
See also: [
|
|
9273
|
+
See also: [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
9176
9274
|
|
|
9177
9275
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9178
9276
|
|
|
@@ -9191,10 +9289,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
9191
9289
|
##### Type: PostBeefService
|
|
9192
9290
|
|
|
9193
9291
|
```ts
|
|
9194
|
-
export type PostBeefService = (beef: Beef, txids: string[]
|
|
9292
|
+
export type PostBeefService = (beef: Beef, txids: string[]) => Promise<PostBeefResult>
|
|
9195
9293
|
```
|
|
9196
9294
|
|
|
9197
|
-
See also: [PostBeefResult](./client.md#interface-postbeefresult)
|
|
9295
|
+
See also: [PostBeefResult](./client.md#interface-postbeefresult)
|
|
9198
9296
|
|
|
9199
9297
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9200
9298
|
|
|
@@ -9322,6 +9420,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
9322
9420
|
| [ProvenTxReqNonTerminalStatus](#variable-proventxreqnonterminalstatus) |
|
|
9323
9421
|
| [ProvenTxReqTerminalStatus](#variable-proventxreqterminalstatus) |
|
|
9324
9422
|
| [brc29ProtocolID](#variable-brc29protocolid) |
|
|
9423
|
+
| [maxPossibleSatoshis](#variable-maxpossiblesatoshis) |
|
|
9325
9424
|
| [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) |
|
|
9326
9425
|
| [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
|
|
9327
9426
|
|
|
@@ -9373,6 +9472,15 @@ brc29ProtocolID: WalletProtocol = [2, "3241645161d8"]
|
|
|
9373
9472
|
|
|
9374
9473
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9375
9474
|
|
|
9475
|
+
---
|
|
9476
|
+
##### Variable: maxPossibleSatoshis
|
|
9477
|
+
|
|
9478
|
+
```ts
|
|
9479
|
+
maxPossibleSatoshis = 2099999999999999
|
|
9480
|
+
```
|
|
9481
|
+
|
|
9482
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9483
|
+
|
|
9376
9484
|
---
|
|
9377
9485
|
##### Variable: outputColumnsWithoutLockingScript
|
|
9378
9486
|
|