@bsv/wallet-toolbox 2.4.1 → 2.4.2
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/CHANGELOG.md +33 -0
- package/README.md +41 -0
- package/docs/client.md +417 -173
- package/docs/services.md +51 -26
- package/docs/storage.md +367 -76
- package/docs/wallet.md +384 -140
- package/out/src/Wallet.d.ts +1 -1
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +8 -7
- package/out/src/Wallet.js.map +1 -1
- package/out/src/WalletPermissionsManager.d.ts +18 -0
- package/out/src/WalletPermissionsManager.d.ts.map +1 -1
- package/out/src/WalletPermissionsManager.js +56 -9
- package/out/src/WalletPermissionsManager.js.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.js +11 -7
- package/out/src/monitor/tasks/TaskArcSSE.js.map +1 -1
- package/out/src/monitor/tasks/TaskCheckForProofs.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskCheckForProofs.js +10 -10
- package/out/src/monitor/tasks/TaskCheckForProofs.js.map +1 -1
- package/out/src/monitor/tasks/TaskReviewStatus.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskReviewStatus.js +7 -2
- package/out/src/monitor/tasks/TaskReviewStatus.js.map +1 -1
- package/out/src/monitor/tasks/TaskUnFail.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskUnFail.js +2 -57
- package/out/src/monitor/tasks/TaskUnFail.js.map +1 -1
- package/out/src/sdk/WalletServices.interfaces.d.ts +1 -0
- package/out/src/sdk/WalletServices.interfaces.d.ts.map +1 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts +10 -4
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- package/out/src/sdk/types.d.ts +1 -1
- package/out/src/sdk/types.d.ts.map +1 -1
- package/out/src/services/Services.d.ts.map +1 -1
- package/out/src/services/Services.js +39 -19
- package/out/src/services/Services.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.js +4 -0
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.js +2 -0
- package/out/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.js +2 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js +1 -0
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.d.ts.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.js +17 -3
- package/out/src/services/createDefaultWalletServicesOptions.js.map +1 -1
- package/out/src/services/networkConfig.d.ts +29 -0
- package/out/src/services/networkConfig.d.ts.map +1 -0
- package/out/src/services/networkConfig.js +54 -0
- package/out/src/services/networkConfig.js.map +1 -0
- package/out/src/services/providers/Arcade.d.ts.map +1 -1
- package/out/src/services/providers/Arcade.js +6 -2
- package/out/src/services/providers/Arcade.js.map +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.d.ts +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.d.ts.map +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.js +12 -4
- package/out/src/services/providers/SdkWhatsOnChain.js.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.d.ts.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.js +3 -1
- package/out/src/signer/methods/buildSignableTransaction.js.map +1 -1
- package/out/src/signer/methods/completeSignedTransaction.d.ts.map +1 -1
- package/out/src/signer/methods/completeSignedTransaction.js +5 -3
- package/out/src/signer/methods/completeSignedTransaction.js.map +1 -1
- package/out/src/signer/methods/createAction.d.ts.map +1 -1
- package/out/src/signer/methods/createAction.js +12 -5
- package/out/src/signer/methods/createAction.js.map +1 -1
- package/out/src/signer/methods/resultBeef.d.ts +4 -0
- package/out/src/signer/methods/resultBeef.d.ts.map +1 -0
- package/out/src/signer/methods/resultBeef.js +12 -0
- package/out/src/signer/methods/resultBeef.js.map +1 -0
- package/out/src/signer/methods/signAction.d.ts.map +1 -1
- package/out/src/signer/methods/signAction.js +6 -1
- package/out/src/signer/methods/signAction.js.map +1 -1
- package/out/src/storage/StorageProvider.d.ts +17 -0
- package/out/src/storage/StorageProvider.d.ts.map +1 -1
- package/out/src/storage/StorageProvider.js +206 -13
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/src/storage/index.all.d.ts +1 -0
- package/out/src/storage/index.all.d.ts.map +1 -1
- package/out/src/storage/index.all.js +1 -0
- package/out/src/storage/index.all.js.map +1 -1
- package/out/src/storage/methods/createAction.js +17 -4
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/getBeefForTransaction.d.ts.map +1 -1
- package/out/src/storage/methods/getBeefForTransaction.js +47 -24
- package/out/src/storage/methods/getBeefForTransaction.js.map +1 -1
- package/out/src/storage/methods/internalizeAction.js +3 -3
- package/out/src/storage/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/methods/processAction.d.ts.map +1 -1
- package/out/src/storage/methods/processAction.js +5 -4
- package/out/src/storage/methods/processAction.js.map +1 -1
- package/out/src/storage/remoting/BinaryJson.d.ts +10 -0
- package/out/src/storage/remoting/BinaryJson.d.ts.map +1 -0
- package/out/src/storage/remoting/BinaryJson.js +172 -0
- package/out/src/storage/remoting/BinaryJson.js.map +1 -0
- package/out/src/storage/remoting/KnexSessionManager.d.ts +37 -0
- package/out/src/storage/remoting/KnexSessionManager.d.ts.map +1 -0
- package/out/src/storage/remoting/KnexSessionManager.js +198 -0
- package/out/src/storage/remoting/KnexSessionManager.js.map +1 -0
- package/out/src/storage/remoting/StorageClient.d.ts +2 -2
- package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClient.js +14 -5
- package/out/src/storage/remoting/StorageClient.js.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.d.ts +11 -1
- package/out/src/storage/remoting/StorageClientBase.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.js +4 -1
- package/out/src/storage/remoting/StorageClientBase.js.map +1 -1
- package/out/src/storage/remoting/StorageMobile.d.ts +2 -2
- package/out/src/storage/remoting/StorageMobile.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageMobile.js +14 -5
- package/out/src/storage/remoting/StorageMobile.js.map +1 -1
- package/out/src/storage/remoting/StorageServer.d.ts +10 -0
- package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageServer.js +48 -21
- package/out/src/storage/remoting/StorageServer.js.map +1 -1
- package/out/src/storage/schema/KnexMigrations.d.ts +2 -0
- package/out/src/storage/schema/KnexMigrations.d.ts.map +1 -1
- package/out/src/storage/schema/KnexMigrations.js +34 -1
- package/out/src/storage/schema/KnexMigrations.js.map +1 -1
- package/out/src/storage/schema/tables/TableAuthSession.d.ts +20 -0
- package/out/src/storage/schema/tables/TableAuthSession.d.ts.map +1 -0
- package/out/src/storage/schema/tables/TableAuthSession.js +15 -0
- package/out/src/storage/schema/tables/TableAuthSession.js.map +1 -0
- package/out/src/storage/schema/tables/index.d.ts +1 -0
- package/out/src/storage/schema/tables/index.d.ts.map +1 -1
- package/out/src/storage/schema/tables/index.js +1 -0
- package/out/src/storage/schema/tables/index.js.map +1 -1
- package/out/src/storage/storageProviderHelpers.d.ts +5 -4
- package/out/src/storage/storageProviderHelpers.d.ts.map +1 -1
- package/out/src/storage/storageProviderHelpers.js +7 -6
- package/out/src/storage/storageProviderHelpers.js.map +1 -1
- package/out/src/utility/utilityHelpers.d.ts.map +1 -1
- package/out/src/utility/utilityHelpers.js +2 -0
- package/out/src/utility/utilityHelpers.js.map +1 -1
- package/package.json +5 -4
package/docs/services.md
CHANGED
|
@@ -4732,7 +4732,7 @@ export default class SdkWhatsOnChain implements ChainTracker {
|
|
|
4732
4732
|
readonly apiKey: string;
|
|
4733
4733
|
protected readonly URL: string;
|
|
4734
4734
|
protected readonly httpClient: HttpClient;
|
|
4735
|
-
constructor(network: "main" | "test" | "stn" | "ttn" = "main", config: WhatsOnChainConfig = {})
|
|
4735
|
+
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" = "main", config: WhatsOnChainConfig = {})
|
|
4736
4736
|
async isValidRootForHeight(root: string, height: number): Promise<boolean>
|
|
4737
4737
|
async currentHeight(): Promise<number>
|
|
4738
4738
|
protected getHttpHeaders(): Record<string, string>
|
|
@@ -4744,7 +4744,7 @@ export default class SdkWhatsOnChain implements ChainTracker {
|
|
|
4744
4744
|
Constructs an instance of the WhatsOnChain ChainTracker.
|
|
4745
4745
|
|
|
4746
4746
|
```ts
|
|
4747
|
-
constructor(network: "main" | "test" | "stn" | "ttn" = "main", config: WhatsOnChainConfig = {})
|
|
4747
|
+
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" = "main", config: WhatsOnChainConfig = {})
|
|
4748
4748
|
```
|
|
4749
4749
|
|
|
4750
4750
|
Argument Details
|
|
@@ -5135,30 +5135,31 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5135
5135
|
|
|
5136
5136
|
| | | |
|
|
5137
5137
|
| --- | --- | --- |
|
|
5138
|
-
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [
|
|
5139
|
-
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [
|
|
5140
|
-
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [
|
|
5141
|
-
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [
|
|
5142
|
-
| [addWork](#function-addwork) | [
|
|
5143
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [
|
|
5144
|
-
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [
|
|
5145
|
-
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [
|
|
5146
|
-
| [blockHash](#function-blockhash) | [
|
|
5147
|
-
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [
|
|
5148
|
-
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [
|
|
5149
|
-
| [convertBitsToTarget](#function-convertbitstotarget) | [
|
|
5150
|
-
| [convertBitsToWork](#function-convertbitstowork) | [
|
|
5151
|
-
| [convertBufferToUint32](#function-convertbuffertouint32) | [
|
|
5152
|
-
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [
|
|
5153
|
-
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [
|
|
5154
|
-
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [
|
|
5155
|
-
| [createDefaultKnexChaintracksOptions](#function-createdefaultknexchaintracksoptions) | [
|
|
5156
|
-
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [
|
|
5157
|
-
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [
|
|
5158
|
-
| [createIdbChaintracks](#function-createidbchaintracks) | [
|
|
5159
|
-
| [createKnexChaintracks](#function-createknexchaintracks) | [
|
|
5160
|
-
| [createNoDbChaintracks](#function-createnodbchaintracks) | [
|
|
5161
|
-
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [
|
|
5138
|
+
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [deserializeBlockHeader](#function-deserializeblockheader) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) |
|
|
5139
|
+
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [deserializeBlockHeaders](#function-deserializeblockheaders) | [serializeBaseBlockHeader](#function-serializebaseblockheader) |
|
|
5140
|
+
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [genesisBuffer](#function-genesisbuffer) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) |
|
|
5141
|
+
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [genesisHeader](#function-genesisheader) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
5142
|
+
| [addWork](#function-addwork) | [getBeefForTxid](#function-getbeeffortxid) | [subWork](#function-subwork) |
|
|
5143
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [getExchangeRatesIo](#function-getexchangeratesio) | [swapByteOrder](#function-swapbyteorder) |
|
|
5144
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
5145
|
+
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [tstnArcadeUrl](#function-tstnarcadeurl) |
|
|
5146
|
+
| [blockHash](#function-blockhash) | [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [tstnChaintracksUrl](#function-tstnchaintracksurl) |
|
|
5147
|
+
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
5148
|
+
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [handleUtxoConnReset](#function-handleutxoconnreset) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
5149
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
5150
|
+
| [convertBitsToWork](#function-convertbitstowork) | [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
5151
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
5152
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [isArcServiceErrorStatus](#function-isarcserviceerrorstatus) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
5153
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [isBaseBlockHeader](#function-isbaseblockheader) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
5154
|
+
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [isBlockHeader](#function-isblockheader) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
5155
|
+
| [createDefaultKnexChaintracksOptions](#function-createdefaultknexchaintracksoptions) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
5156
|
+
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [isLive](#function-islive) | [validateScriptHash](#function-validatescripthash) |
|
|
5157
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [isLiveBlockHeader](#function-isliveblockheader) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
|
|
5158
|
+
| [createIdbChaintracks](#function-createidbchaintracks) | [isMoreWork](#function-ismorework) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
5159
|
+
| [createKnexChaintracks](#function-createknexchaintracks) | [makeMerklePathNote](#function-makemerklepathnote) | [writeUInt32BE](#function-writeuint32be) |
|
|
5160
|
+
| [createNoDbChaintracks](#function-createnodbchaintracks) | [populateUtxoDetails](#function-populateutxodetails) | [writeUInt32LE](#function-writeuint32le) |
|
|
5161
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [readUInt32BE](#function-readuint32be) | |
|
|
5162
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [readUInt32LE](#function-readuint32le) | |
|
|
5162
5163
|
|
|
5163
5164
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5164
5165
|
|
|
@@ -5663,6 +5664,7 @@ export function genesisHeader(chain: Chain): BlockHeader {
|
|
|
5663
5664
|
};
|
|
5664
5665
|
case "test":
|
|
5665
5666
|
case "ttn":
|
|
5667
|
+
case "tstn":
|
|
5666
5668
|
return {
|
|
5667
5669
|
version: 1,
|
|
5668
5670
|
previousHash: "0000000000000000000000000000000000000000000000000000000000000000",
|
|
@@ -6131,6 +6133,29 @@ Returns
|
|
|
6131
6133
|
|
|
6132
6134
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6133
6135
|
|
|
6136
|
+
---
|
|
6137
|
+
##### Function: tstnArcadeUrl
|
|
6138
|
+
|
|
6139
|
+
Arcade broadcaster / ARC endpoint for tstn, or `undefined` when `TSTN_ARCADE_URL` is unset.
|
|
6140
|
+
|
|
6141
|
+
```ts
|
|
6142
|
+
export function tstnArcadeUrl(): string | undefined
|
|
6143
|
+
```
|
|
6144
|
+
|
|
6145
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6146
|
+
|
|
6147
|
+
---
|
|
6148
|
+
##### Function: tstnChaintracksUrl
|
|
6149
|
+
|
|
6150
|
+
ChainTracks service URL for tstn. Falls back to `${TSTN_ARCADE_URL}/chaintracks/v1` when
|
|
6151
|
+
`TSTN_CHAINTRACKS_URL` is unset (mirrors the ttn layout). Throws when neither is configured.
|
|
6152
|
+
|
|
6153
|
+
```ts
|
|
6154
|
+
export function tstnChaintracksUrl(): string
|
|
6155
|
+
```
|
|
6156
|
+
|
|
6157
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6158
|
+
|
|
6134
6159
|
---
|
|
6135
6160
|
##### Function: updateChaintracksFiatExchangeRates
|
|
6136
6161
|
|