@bopen-io/wallet-toolbox 2.15.0-bopen.2 → 2.15.1
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 +183 -0
- package/README.md +127 -25
- package/docs/client.md +312 -154
- package/docs/monitor.md +2 -2
- package/docs/no-send-expiry.md +7 -2
- package/docs/services.md +143 -60
- package/docs/wallet.md +208 -117
- package/out/src/CWIStyleWalletManager.d.ts +36 -5
- package/out/src/CWIStyleWalletManager.d.ts.map +1 -1
- package/out/src/CWIStyleWalletManager.js +356 -60
- package/out/src/CWIStyleWalletManager.js.map +1 -1
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +8 -3
- package/out/src/Wallet.js.map +1 -1
- package/out/src/WalletAuthenticationManager.d.ts +3 -0
- package/out/src/WalletAuthenticationManager.d.ts.map +1 -1
- package/out/src/WalletAuthenticationManager.js +86 -3
- package/out/src/WalletAuthenticationManager.js.map +1 -1
- package/out/src/WalletPermissionsManager.d.ts +63 -9
- package/out/src/WalletPermissionsManager.d.ts.map +1 -1
- package/out/src/WalletPermissionsManager.js +213 -49
- package/out/src/WalletPermissionsManager.js.map +1 -1
- package/out/src/monitor/Monitor.js +1 -1
- package/out/src/monitor/Monitor.js.map +1 -1
- package/out/src/monitor/monitorValidation.d.ts +2 -1
- package/out/src/monitor/monitorValidation.d.ts.map +1 -1
- package/out/src/monitor/monitorValidation.js +2 -2
- package/out/src/monitor/monitorValidation.js.map +1 -1
- package/out/src/monitor/tasks/TaskNewHeader.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskNewHeader.js +1 -1
- package/out/src/monitor/tasks/TaskNewHeader.js.map +1 -1
- package/out/src/monitor/tasks/TaskReviewUtxos.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskReviewUtxos.js +2 -1
- package/out/src/monitor/tasks/TaskReviewUtxos.js.map +1 -1
- package/out/src/sdk/WERR_errors.d.ts +4 -0
- package/out/src/sdk/WERR_errors.d.ts.map +1 -1
- package/out/src/sdk/WERR_errors.js +4 -0
- package/out/src/sdk/WERR_errors.js.map +1 -1
- package/out/src/sdk/WalletErrorFromJson.d.ts.map +1 -1
- package/out/src/sdk/WalletErrorFromJson.js +23 -2
- package/out/src/sdk/WalletErrorFromJson.js.map +1 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts +11 -0
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- package/out/src/sdk/types.d.ts +12 -1
- package/out/src/sdk/types.d.ts.map +1 -1
- package/out/src/sdk/types.js +19 -2
- package/out/src/sdk/types.js.map +1 -1
- package/out/src/services/Services.d.ts.map +1 -1
- package/out/src/services/Services.js +5 -3
- package/out/src/services/Services.js.map +1 -1
- package/out/src/services/chaintracker/BHServiceClient.js +2 -2
- package/out/src/services/chaintracker/BHServiceClient.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Chaintracks.js +2 -2
- package/out/src/services/chaintracker/chaintracks/Chaintracks.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/ChaintracksServiceClient.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/ChaintracksServiceClient.js +3 -1
- package/out/src/services/chaintracker/chaintracks/ChaintracksServiceClient.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.js +3 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/BulkIngestorBase.js +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/BulkIngestorBase.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/LiveIngestorBase.js +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/LiveIngestorBase.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/LiveIngestorChaintracksSSE.js +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/LiveIngestorChaintracksSSE.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/BulkStorageBase.js +2 -2
- package/out/src/services/chaintracker/chaintracks/Storage/BulkStorageBase.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageBase.js +6 -6
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageBase.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageIdb.js +2 -2
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageIdb.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageKnex.js +2 -2
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageKnex.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.d.ts +1 -0
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.js +11 -3
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/BulkFileDataManager.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/BulkFileDataManager.js +13 -9
- package/out/src/services/chaintracker/chaintracks/util/BulkFileDataManager.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/BulkFilesReader.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/BulkFilesReader.js +2 -2
- package/out/src/services/chaintracker/chaintracks/util/BulkFilesReader.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/InlineBulkFileDataValidator.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/InlineBulkFileDataValidator.js +2 -2
- package/out/src/services/chaintracker/chaintracks/util/InlineBulkFileDataValidator.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.d.ts +23 -5
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js +58 -16
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.d.ts +6 -3
- package/out/src/services/createDefaultWalletServicesOptions.d.ts.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.js +18 -6
- package/out/src/services/createDefaultWalletServicesOptions.js.map +1 -1
- package/out/src/services/networkConfig.d.ts +7 -0
- package/out/src/services/networkConfig.d.ts.map +1 -1
- package/out/src/services/networkConfig.js +25 -2
- package/out/src/services/networkConfig.js.map +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.d.ts +8 -2
- package/out/src/services/providers/SdkWhatsOnChain.d.ts.map +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.js +17 -6
- package/out/src/services/providers/SdkWhatsOnChain.js.map +1 -1
- package/out/src/services/validateMerklePathResult.d.ts +4 -3
- package/out/src/services/validateMerklePathResult.d.ts.map +1 -1
- package/out/src/services/validateMerklePathResult.js +6 -6
- package/out/src/services/validateMerklePathResult.js.map +1 -1
- package/out/src/signer/actionBatch/ActionBatchWorkspace.d.ts.map +1 -1
- package/out/src/signer/actionBatch/ActionBatchWorkspace.js +3 -2
- package/out/src/signer/actionBatch/ActionBatchWorkspace.js.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.d.ts.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.js +7 -3
- package/out/src/signer/methods/buildSignableTransaction.js.map +1 -1
- package/out/src/signer/methods/createAction.d.ts +32 -1
- package/out/src/signer/methods/createAction.d.ts.map +1 -1
- package/out/src/signer/methods/createAction.js +56 -1
- package/out/src/signer/methods/createAction.js.map +1 -1
- package/out/src/signer/methods/internalizeAction.js +1 -1
- package/out/src/signer/methods/internalizeAction.js.map +1 -1
- package/out/src/signer/methods/signAction.js +8 -1
- package/out/src/signer/methods/signAction.js.map +1 -1
- package/out/src/storage/StorageIdb.js +4 -4
- package/out/src/storage/StorageIdb.js.map +1 -1
- package/out/src/storage/StorageKnex.d.ts +6 -2
- package/out/src/storage/StorageKnex.d.ts.map +1 -1
- package/out/src/storage/StorageKnex.js +114 -0
- package/out/src/storage/StorageKnex.js.map +1 -1
- package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
- package/out/src/storage/WalletStorageManager.js +5 -0
- package/out/src/storage/WalletStorageManager.js.map +1 -1
- package/out/src/storage/methods/ListOutputsSpecOp.d.ts.map +1 -1
- package/out/src/storage/methods/ListOutputsSpecOp.js +84 -0
- package/out/src/storage/methods/ListOutputsSpecOp.js.map +1 -1
- package/out/src/storage/methods/attemptToPostReqsToNetwork.d.ts.map +1 -1
- package/out/src/storage/methods/attemptToPostReqsToNetwork.js +7 -3
- package/out/src/storage/methods/attemptToPostReqsToNetwork.js.map +1 -1
- package/out/src/storage/methods/createAction.d.ts +5 -0
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +13 -6
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/generateChange.d.ts +6 -0
- package/out/src/storage/methods/generateChange.d.ts.map +1 -1
- package/out/src/storage/methods/generateChange.js +10 -3
- package/out/src/storage/methods/generateChange.js.map +1 -1
- package/out/src/storage/methods/internalizeAction.d.ts +8 -1
- package/out/src/storage/methods/internalizeAction.d.ts.map +1 -1
- package/out/src/storage/methods/internalizeAction.js +106 -42
- package/out/src/storage/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/methods/listOutputsKnex.js +1 -1
- package/out/src/storage/methods/listOutputsKnex.js.map +1 -1
- package/out/src/storage/methods/noSendExpiry.d.ts.map +1 -1
- package/out/src/storage/methods/noSendExpiry.js +14 -4
- package/out/src/storage/methods/noSendExpiry.js.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.js +15 -5
- package/out/src/storage/remoting/StorageClientBase.js.map +1 -1
- package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageServer.js +12 -1
- package/out/src/storage/remoting/StorageServer.js.map +1 -1
- package/out/src/storage/remoting/syncChunkBinary.d.ts +10 -0
- package/out/src/storage/remoting/syncChunkBinary.d.ts.map +1 -1
- package/out/src/storage/remoting/syncChunkBinary.js +15 -11
- package/out/src/storage/remoting/syncChunkBinary.js.map +1 -1
- package/out/src/storage/schema/KnexMigrations.d.ts +1 -0
- package/out/src/storage/schema/KnexMigrations.d.ts.map +1 -1
- package/out/src/storage/schema/KnexMigrations.js +26 -4
- package/out/src/storage/schema/KnexMigrations.js.map +1 -1
- package/out/src/storage/sync/liveSyncGuards.d.ts +11 -0
- package/out/src/storage/sync/liveSyncGuards.d.ts.map +1 -0
- package/out/src/storage/sync/liveSyncGuards.js +22 -0
- package/out/src/storage/sync/liveSyncGuards.js.map +1 -0
- package/out/src/utility/actionOutputAuthorizations.d.ts +10 -0
- package/out/src/utility/actionOutputAuthorizations.d.ts.map +1 -0
- package/out/src/utility/actionOutputAuthorizations.js +25 -0
- package/out/src/utility/actionOutputAuthorizations.js.map +1 -0
- package/out/src/utility/index.all.d.ts +1 -0
- package/out/src/utility/index.all.d.ts.map +1 -1
- package/out/src/utility/index.all.js +1 -0
- package/out/src/utility/index.all.js.map +1 -1
- package/out/src/utility/index.client.d.ts +1 -0
- package/out/src/utility/index.client.d.ts.map +1 -1
- package/out/src/utility/index.client.js +1 -0
- package/out/src/utility/index.client.js.map +1 -1
- package/out/src/utility/numericTotalOutputs.d.ts +7 -0
- package/out/src/utility/numericTotalOutputs.d.ts.map +1 -0
- package/out/src/utility/numericTotalOutputs.js +15 -0
- package/out/src/utility/numericTotalOutputs.js.map +1 -0
- 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 +43 -46
package/docs/client.md
CHANGED
|
@@ -6573,6 +6573,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6573
6573
|
A permissions module handles request/response transformation for a specific P-protocol or P-basket scheme under BRC-98/99.
|
|
6574
6574
|
Modules are registered in the config mapped by their scheme ID.
|
|
6575
6575
|
|
|
6576
|
+
Modules that handled a `createAction` returning a signable transaction also receive that action's
|
|
6577
|
+
`signAction` through `onRequest` and `onResponse`, with method `signAction` and the `action` being
|
|
6578
|
+
signed. A module may add `spends`
|
|
6579
|
+
for inputs it supplied.
|
|
6580
|
+
|
|
6576
6581
|
```ts
|
|
6577
6582
|
export interface PermissionsModule {
|
|
6578
6583
|
handleRequest?: (req: PermissionsModuleRequest, next: PermissionsModuleNext) => Promise<unknown>;
|
|
@@ -6582,11 +6587,12 @@ export interface PermissionsModule {
|
|
|
6582
6587
|
onResponse: (res: any, context: {
|
|
6583
6588
|
method: string;
|
|
6584
6589
|
originator: string;
|
|
6590
|
+
action?: PermissionsModuleAction;
|
|
6585
6591
|
}) => Promise<any>;
|
|
6586
6592
|
}
|
|
6587
6593
|
```
|
|
6588
6594
|
|
|
6589
|
-
See also: [PermissionsModuleNext](./client.md#type-permissionsmodulenext), [PermissionsModuleRequest](./client.md#interface-permissionsmodulerequest)
|
|
6595
|
+
See also: [PermissionsModuleAction](./client.md#interface-permissionsmoduleaction), [PermissionsModuleNext](./client.md#type-permissionsmodulenext), [PermissionsModuleRequest](./client.md#interface-permissionsmodulerequest)
|
|
6590
6596
|
|
|
6591
6597
|
###### Property handleRequest
|
|
6592
6598
|
|
|
@@ -6623,8 +6629,50 @@ Transforms the response from the underlying wallet before returning to caller.
|
|
|
6623
6629
|
onResponse: (res: any, context: {
|
|
6624
6630
|
method: string;
|
|
6625
6631
|
originator: string;
|
|
6632
|
+
action?: PermissionsModuleAction;
|
|
6626
6633
|
}) => Promise<any>
|
|
6627
6634
|
```
|
|
6635
|
+
See also: [PermissionsModuleAction](./client.md#interface-permissionsmoduleaction)
|
|
6636
|
+
|
|
6637
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6638
|
+
|
|
6639
|
+
---
|
|
6640
|
+
##### Interface: PermissionsModuleAction
|
|
6641
|
+
|
|
6642
|
+
The action a `signAction` hook call signs.
|
|
6643
|
+
|
|
6644
|
+
```ts
|
|
6645
|
+
export interface PermissionsModuleAction {
|
|
6646
|
+
reference: string;
|
|
6647
|
+
transaction: Transaction;
|
|
6648
|
+
noSend: boolean;
|
|
6649
|
+
createArgs?: CreateActionArgs;
|
|
6650
|
+
}
|
|
6651
|
+
```
|
|
6652
|
+
|
|
6653
|
+
###### Property createArgs
|
|
6654
|
+
|
|
6655
|
+
The `createAction` arguments as the permission modules returned them, before metadata encryption.
|
|
6656
|
+
|
|
6657
|
+
```ts
|
|
6658
|
+
createArgs?: CreateActionArgs
|
|
6659
|
+
```
|
|
6660
|
+
|
|
6661
|
+
###### Property noSend
|
|
6662
|
+
|
|
6663
|
+
True when the signed transaction is not broadcast.
|
|
6664
|
+
|
|
6665
|
+
```ts
|
|
6666
|
+
noSend: boolean
|
|
6667
|
+
```
|
|
6668
|
+
|
|
6669
|
+
###### Property transaction
|
|
6670
|
+
|
|
6671
|
+
The signable transaction as `createAction` returned it.
|
|
6672
|
+
|
|
6673
|
+
```ts
|
|
6674
|
+
transaction: Transaction
|
|
6675
|
+
```
|
|
6628
6676
|
|
|
6629
6677
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6630
6678
|
|
|
@@ -6638,9 +6686,21 @@ export interface PermissionsModuleRequest {
|
|
|
6638
6686
|
method: string;
|
|
6639
6687
|
args: object;
|
|
6640
6688
|
originator: string;
|
|
6689
|
+
action?: PermissionsModuleAction;
|
|
6641
6690
|
}
|
|
6642
6691
|
```
|
|
6643
6692
|
|
|
6693
|
+
See also: [PermissionsModuleAction](./client.md#interface-permissionsmoduleaction)
|
|
6694
|
+
|
|
6695
|
+
###### Property action
|
|
6696
|
+
|
|
6697
|
+
Set only for `signAction` hook calls.
|
|
6698
|
+
|
|
6699
|
+
```ts
|
|
6700
|
+
action?: PermissionsModuleAction
|
|
6701
|
+
```
|
|
6702
|
+
See also: [PermissionsModuleAction](./client.md#interface-permissionsmoduleaction)
|
|
6703
|
+
|
|
6644
6704
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6645
6705
|
|
|
6646
6706
|
---
|
|
@@ -7080,6 +7140,18 @@ nextCheckpoint?: SyncCheckpoint
|
|
|
7080
7140
|
```
|
|
7081
7141
|
See also: [SyncCheckpoint](./client.md#interface-synccheckpoint)
|
|
7082
7142
|
|
|
7143
|
+
###### Property error
|
|
7144
|
+
|
|
7145
|
+
Optional non-throwing failure from a custom writer. First-party
|
|
7146
|
+
`StorageProvider` implementations throw instead of setting this field.
|
|
7147
|
+
`WalletStorageManager.syncToWriter` and `syncFromReader` throw `error`
|
|
7148
|
+
immediately and do not request another chunk.
|
|
7149
|
+
|
|
7150
|
+
```ts
|
|
7151
|
+
error?: WalletError
|
|
7152
|
+
```
|
|
7153
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
7154
|
+
|
|
7083
7155
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7084
7156
|
|
|
7085
7157
|
---
|
|
@@ -14030,6 +14102,13 @@ export class ChaintracksStorageNoDb extends ChaintracksStorageBase {
|
|
|
14030
14102
|
tipHeaderId: 0,
|
|
14031
14103
|
hashToHeaderId: new Map<string, number>()
|
|
14032
14104
|
};
|
|
14105
|
+
static readonly regtestData: ChaintracksNoDbData = {
|
|
14106
|
+
chain: "regtest",
|
|
14107
|
+
liveHeaders: new Map<number, LiveBlockHeader>(),
|
|
14108
|
+
maxHeaderId: 0,
|
|
14109
|
+
tipHeaderId: 0,
|
|
14110
|
+
hashToHeaderId: new Map<string, number>()
|
|
14111
|
+
};
|
|
14033
14112
|
constructor(options: ChaintracksStorageNoDbOptions)
|
|
14034
14113
|
override async destroy(): Promise<void>
|
|
14035
14114
|
async getData(): Promise<ChaintracksNoDbData>
|
|
@@ -16072,7 +16151,8 @@ export default class SdkWhatsOnChain implements ChainTracker {
|
|
|
16072
16151
|
protected readonly URL: string;
|
|
16073
16152
|
protected readonly httpClient: HttpClient;
|
|
16074
16153
|
protected readonly requestTimeoutMsecs: number;
|
|
16075
|
-
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" = "main", config: LocalWhatsOnChainConfig = {})
|
|
16154
|
+
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" | "regtest" = "main", config: LocalWhatsOnChainConfig = {})
|
|
16155
|
+
get isAvailable(): boolean
|
|
16076
16156
|
protected async request<T, Data = unknown>(url: string, options: HttpClientRequestOptions<Data>): Promise<HttpClientResponse<T>>
|
|
16077
16157
|
async isValidRootForHeight(root: string, height: number): Promise<boolean>
|
|
16078
16158
|
async currentHeight(): Promise<number>
|
|
@@ -16083,9 +16163,10 @@ export default class SdkWhatsOnChain implements ChainTracker {
|
|
|
16083
16163
|
###### Constructor
|
|
16084
16164
|
|
|
16085
16165
|
Constructs an instance of the WhatsOnChain ChainTracker.
|
|
16166
|
+
`tstn` and `regtest` have no WhatsOnChain service, so every request made for them is refused.
|
|
16086
16167
|
|
|
16087
16168
|
```ts
|
|
16088
|
-
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" = "main", config: LocalWhatsOnChainConfig = {})
|
|
16169
|
+
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" | "regtest" = "main", config: LocalWhatsOnChainConfig = {})
|
|
16089
16170
|
```
|
|
16090
16171
|
|
|
16091
16172
|
Argument Details
|
|
@@ -19459,6 +19540,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
19459
19540
|
|
|
19460
19541
|
Configured network chain is invalid or does not match across services.
|
|
19461
19542
|
|
|
19543
|
+
Live `WalletStorageManager.syncToWriter` and `syncFromReader` throw this
|
|
19544
|
+
before any sync chunk moves when the reader and writer `TableSettings.chain`
|
|
19545
|
+
values differ.
|
|
19546
|
+
|
|
19462
19547
|
```ts
|
|
19463
19548
|
export class WERR_NETWORK_CHAIN extends WalletError {
|
|
19464
19549
|
constructor(message?: string)
|
|
@@ -21209,140 +21294,140 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
21209
21294
|
|
|
21210
21295
|
| | | |
|
|
21211
21296
|
| --- | --- | --- |
|
|
21212
|
-
| [WalletErrorFromJson](#function-walleterrorfromjson) | [
|
|
21213
|
-
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [
|
|
21214
|
-
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [
|
|
21215
|
-
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [
|
|
21216
|
-
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [
|
|
21217
|
-
| [abortActionBatch](#function-abortactionbatch) | [
|
|
21218
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [
|
|
21219
|
-
| [actionBatchBlobDigest](#function-actionbatchblobdigest) | [
|
|
21220
|
-
| [actionBatchBootstrap](#function-actionbatchbootstrap) | [
|
|
21221
|
-
| [actionBatchManifestDigest](#function-actionbatchmanifestdigest) | [
|
|
21222
|
-
| [actionBatchPackLength](#function-actionbatchpacklength) | [
|
|
21223
|
-
| [activateNoSendExpiry](#function-activatenosendexpiry) | [
|
|
21224
|
-
| [addPlannerOutputs](#function-addplanneroutputs) | [
|
|
21225
|
-
| [addWork](#function-addwork) | [
|
|
21226
|
-
| [additionalFundingTarget](#function-additionalfundingtarget) | [
|
|
21227
|
-
| [applyBrc153ReferenceLabel](#function-applybrc153referencelabel) | [
|
|
21228
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [
|
|
21229
|
-
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [
|
|
21230
|
-
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [
|
|
21231
|
-
| [armNoSendExpiry](#function-armnosendexpiry) | [
|
|
21232
|
-
| [arraysEqual](#function-arraysequal) | [
|
|
21233
|
-
| [asArray](#function-asarray) | [
|
|
21234
|
-
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [
|
|
21235
|
-
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [
|
|
21236
|
-
| [asBsvSdkScript](#function-asbsvsdkscript) | [
|
|
21237
|
-
| [asBsvSdkTx](#function-asbsvsdktx) | [
|
|
21238
|
-
| [asString](#function-asstring) | [
|
|
21239
|
-
| [asUint8Array](#function-asuint8array) | [
|
|
21240
|
-
| [assertAbortResult](#function-assertabortresult) | [
|
|
21241
|
-
| [assertCanonicalShamirShare](#function-assertcanonicalshamirshare) | [
|
|
21242
|
-
| [assertInternalizeAccepted](#function-assertinternalizeaccepted) | [
|
|
21243
|
-
| [assertStorageMutationSucceeded](#function-assertstoragemutationsucceeded) | [
|
|
21244
|
-
| [assertSyncProofReplacementAuthorized](#function-assertsyncproofreplacementauthorized) | [
|
|
21245
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [
|
|
21246
|
-
| [authenticateMerklePathResult](#function-authenticatemerklepathresult) | [
|
|
21247
|
-
| [availableManagedChange](#function-availablemanagedchange) | [
|
|
21248
|
-
| [beefForTxids](#function-beeffortxids) | [
|
|
21249
|
-
| [beginActionBatch](#function-beginactionbatch) | [
|
|
21250
|
-
| [binaryJsonReplacer](#function-binaryjsonreplacer) | [
|
|
21251
|
-
| [binaryJsonReviver](#function-binaryjsonreviver) | [
|
|
21252
|
-
| [blockHash](#function-blockhash) | [
|
|
21253
|
-
| [brc177NoSendExpiryStateRank](#function-brc177nosendexpirystaterank) | [
|
|
21254
|
-
| [buildBeefForOutpoints](#function-buildbeefforoutpoints) | [
|
|
21255
|
-
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [
|
|
21256
|
-
| [buildSignableTransaction](#function-buildsignabletransaction) | [
|
|
21257
|
-
| [canonicalizeAtomicBeef](#function-canonicalizeatomicbeef) | [
|
|
21258
|
-
| [canonicalizeSyncProofIdentifiers](#function-canonicalizesyncproofidentifiers) | [
|
|
21259
|
-
| [classifyArcadeRejection](#function-classifyarcaderejection) | [
|
|
21260
|
-
| [classifyBroadcastInputSpendEvidence](#function-classifybroadcastinputspendevidence) | [
|
|
21261
|
-
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [
|
|
21262
|
-
| [classifyOutputUtxo](#function-classifyoutpututxo) | [
|
|
21263
|
-
| [classifyReqStatus](#function-classifyreqstatus) | [
|
|
21264
|
-
| [cleanupExpiredActionBatches](#function-cleanupexpiredactionbatches) | [
|
|
21265
|
-
| [commitActionBatch](#function-commitactionbatch) | [
|
|
21266
|
-
| [commitActionBatchByDigest](#function-commitactionbatchbydigest) | [
|
|
21267
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
21268
|
-
| [compressActionBatchPack](#function-compressactionbatchpack) | [
|
|
21269
|
-
| [compressActionBatchPackItems](#function-compressactionbatchpackitems) | [
|
|
21270
|
-
| [computeMerklePath](#function-computemerklepath) | [
|
|
21271
|
-
| [computeMerkleRoot](#function-computemerkleroot) | [
|
|
21272
|
-
| [containsControlCharacter](#function-containscontrolcharacter) | [
|
|
21273
|
-
| [convertBitsToTarget](#function-convertbitstotarget) | [
|
|
21274
|
-
| [convertBitsToWork](#function-convertbitstowork) | [
|
|
21275
|
-
| [convertBufferToUint32](#function-convertbuffertouint32) | [
|
|
21276
|
-
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [
|
|
21277
|
-
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [
|
|
21278
|
-
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [
|
|
21279
|
-
| [copyMonitorTags](#function-copymonitortags) | [
|
|
21280
|
-
| [copyRawTransactionBytes](#function-copyrawtransactionbytes) | [
|
|
21281
|
-
| [copyValidatedBlockHeader](#function-copyvalidatedblockheader) | [
|
|
21282
|
-
| [copyValidatedMonitorHeader](#function-copyvalidatedmonitorheader) | [
|
|
21283
|
-
| [createAction](#function-createaction) | [
|
|
21284
|
-
| [
|
|
21285
|
-
| [
|
|
21286
|
-
| [
|
|
21287
|
-
| [
|
|
21288
|
-
| [
|
|
21289
|
-
| [
|
|
21290
|
-
| [
|
|
21291
|
-
| [
|
|
21292
|
-
| [
|
|
21293
|
-
| [
|
|
21294
|
-
| [
|
|
21295
|
-
| [
|
|
21296
|
-
| [
|
|
21297
|
-
| [
|
|
21298
|
-
| [
|
|
21299
|
-
| [
|
|
21300
|
-
| [
|
|
21301
|
-
| [
|
|
21302
|
-
| [
|
|
21303
|
-
| [
|
|
21304
|
-
| [
|
|
21305
|
-
| [
|
|
21306
|
-
| [
|
|
21307
|
-
| [
|
|
21308
|
-
| [
|
|
21309
|
-
| [
|
|
21310
|
-
| [
|
|
21311
|
-
| [
|
|
21312
|
-
| [
|
|
21313
|
-
| [
|
|
21314
|
-
| [
|
|
21315
|
-
| [
|
|
21316
|
-
| [
|
|
21317
|
-
| [
|
|
21318
|
-
| [
|
|
21319
|
-
| [
|
|
21320
|
-
| [
|
|
21321
|
-
| [
|
|
21322
|
-
| [
|
|
21323
|
-
| [
|
|
21324
|
-
| [
|
|
21325
|
-
| [
|
|
21326
|
-
| [
|
|
21327
|
-
| [
|
|
21328
|
-
| [
|
|
21329
|
-
| [
|
|
21330
|
-
| [
|
|
21331
|
-
| [
|
|
21332
|
-
| [
|
|
21333
|
-
| [
|
|
21334
|
-
| [
|
|
21335
|
-
| [
|
|
21336
|
-
| [
|
|
21337
|
-
| [
|
|
21338
|
-
| [
|
|
21339
|
-
| [
|
|
21340
|
-
| [
|
|
21341
|
-
| [
|
|
21342
|
-
| [
|
|
21343
|
-
| [
|
|
21344
|
-
| [
|
|
21345
|
-
| [
|
|
21297
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [isBaseBlockHeader](#function-isbaseblockheader) | [setResultBeef](#function-setresultbeef) |
|
|
21298
|
+
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [isBlockHeader](#function-isblockheader) | [sha256Hash](#function-sha256hash) |
|
|
21299
|
+
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [isBrc153ReferenceLabel](#function-isbrc153referencelabel) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
21300
|
+
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isCanonicalShamirShare](#function-iscanonicalshamirshare) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
21301
|
+
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [signAction](#function-signaction) |
|
|
21302
|
+
| [abortActionBatch](#function-abortactionbatch) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [signAndComplete](#function-signandcomplete) |
|
|
21303
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [isLegacyManagedChangeBasketDefault](#function-islegacymanagedchangebasketdefault) | [snapshotMerklePathResult](#function-snapshotmerklepathresult) |
|
|
21304
|
+
| [actionBatchBlobDigest](#function-actionbatchblobdigest) | [isListActionsSpecOp](#function-islistactionsspecop) | [snapshotPostBeefRequest](#function-snapshotpostbeefrequest) |
|
|
21305
|
+
| [actionBatchBootstrap](#function-actionbatchbootstrap) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [stageTransactionOutputs](#function-stagetransactionoutputs) |
|
|
21306
|
+
| [actionBatchManifestDigest](#function-actionbatchmanifestdigest) | [isLive](#function-islive) | [stampLog](#function-stamplog) |
|
|
21307
|
+
| [actionBatchPackLength](#function-actionbatchpacklength) | [isLiveBlockHeader](#function-isliveblockheader) | [stampLogFormat](#function-stamplogformat) |
|
|
21308
|
+
| [activateNoSendExpiry](#function-activatenosendexpiry) | [isManagedChangeOutput](#function-ismanagedchangeoutput) | [startChaintracks](#function-startchaintracks) |
|
|
21309
|
+
| [addPlannerOutputs](#function-addplanneroutputs) | [isMoreWork](#function-ismorework) | [stnArcadeUrl](#function-stnarcadeurl) |
|
|
21310
|
+
| [addWork](#function-addwork) | [isValidFiatRate](#function-isvalidfiatrate) | [stnChaintracksUrl](#function-stnchaintracksurl) |
|
|
21311
|
+
| [additionalFundingTarget](#function-additionalfundingtarget) | [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [stringifyJsonRpc](#function-stringifyjsonrpc) |
|
|
21312
|
+
| [applyBrc153ReferenceLabel](#function-applybrc153referencelabel) | [legacyBinaryJsonReplacer](#function-legacybinaryjsonreplacer) | [subWork](#function-subwork) |
|
|
21313
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [listActionsIdb](#function-listactionsidb) | [supportedActionBatchPackEncodings](#function-supportedactionbatchpackencodings) |
|
|
21314
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [listCertificates](#function-listcertificates) | [swapByteOrder](#function-swapbyteorder) |
|
|
21315
|
+
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [listOutputsIdb](#function-listoutputsidb) | [syncChunkBinary](#function-syncchunkbinary) |
|
|
21316
|
+
| [armNoSendExpiry](#function-armnosendexpiry) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [syncProofUpdatedAt](#function-syncproofupdatedat) |
|
|
21317
|
+
| [arraysEqual](#function-arraysequal) | [logCreateActionArgs](#function-logcreateactionargs) | [syncTransferDigest](#function-synctransferdigest) |
|
|
21318
|
+
| [asArray](#function-asarray) | [logWalletError](#function-logwalleterror) | [tableAuthSessionToPeerSession](#function-tableauthsessiontopeersession) |
|
|
21319
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [lookupPreparedBeefs](#function-lookuppreparedbeefs) | [targetForStorage](#function-targetforstorage) |
|
|
21320
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [makeAtomicBeef](#function-makeatomicbeef) | [throwDummyReviewActions](#function-throwdummyreviewactions) |
|
|
21321
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [makeBrc114ActionTimeLabel](#function-makebrc114actiontimelabel) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
21322
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [makeBrc153ReferenceLabel](#function-makebrc153referencelabel) | [toDefaultChaintracksArguments](#function-todefaultchaintracksarguments) |
|
|
21323
|
+
| [asString](#function-asstring) | [makeChangeLock](#function-makechangelock) | [toLookupNetworkPreset](#function-tolookupnetworkpreset) |
|
|
21324
|
+
| [asUint8Array](#function-asuint8array) | [makeMerklePathNote](#function-makemerklepathnote) | [toWalletNetwork](#function-towalletnetwork) |
|
|
21325
|
+
| [assertAbortResult](#function-assertabortresult) | [makeNoSendExpiryFundingArgs](#function-makenosendexpiryfundingargs) | [transactionInputSize](#function-transactioninputsize) |
|
|
21326
|
+
| [assertCanonicalShamirShare](#function-assertcanonicalshamirshare) | [makePostBeefServiceError](#function-makepostbeefserviceerror) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
21327
|
+
| [assertInternalizeAccepted](#function-assertinternalizeaccepted) | [manifestPhysicalDigests](#function-manifestphysicaldigests) | [transactionSize](#function-transactionsize) |
|
|
21328
|
+
| [assertStorageMutationSucceeded](#function-assertstoragemutationsucceeded) | [mapWithConcurrency](#function-mapwithconcurrency) | [tstnArcadeUrl](#function-tstnarcadeurl) |
|
|
21329
|
+
| [assertSyncProofReplacementAuthorized](#function-assertsyncproofreplacementauthorized) | [markConfirmedStaleReqInputs](#function-markconfirmedstalereqinputs) | [tstnChaintracksUrl](#function-tstnchaintracksurl) |
|
|
21330
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [markStaleInputsAsSpent](#function-markstaleinputsasspent) | [unregisterArgon2idBackend](#function-unregisterargon2idbackend) |
|
|
21331
|
+
| [authenticateMerklePathResult](#function-authenticatemerklepathresult) | [markSyncProofInsertOnly](#function-marksyncproofinsertonly) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
21332
|
+
| [availableManagedChange](#function-availablemanagedchange) | [markSyncProofReconciled](#function-marksyncproofreconciled) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
21333
|
+
| [beefForTxids](#function-beeffortxids) | [markUserInputsSpent](#function-markuserinputsspent) | [updateReqsFromAggregateResults](#function-updatereqsfromaggregateresults) |
|
|
21334
|
+
| [beginActionBatch](#function-beginactionbatch) | [matchesCertificateFieldPartial](#function-matchescertificatefieldpartial) | [upgradeActionBatchStoresV2](#function-upgradeactionbatchstoresv2) |
|
|
21335
|
+
| [binaryJsonReplacer](#function-binaryjsonreplacer) | [matchesCertificatePartial](#function-matchescertificatepartial) | [upgradeAllStoresV1](#function-upgradeallstoresv1) |
|
|
21336
|
+
| [binaryJsonReviver](#function-binaryjsonreviver) | [matchesCommissionPartial](#function-matchescommissionpartial) | [upgradeCertificateFields](#function-upgradecertificatefields) |
|
|
21337
|
+
| [blockHash](#function-blockhash) | [matchesMonitorEventPartial](#function-matchesmonitoreventpartial) | [upgradeCertificates](#function-upgradecertificates) |
|
|
21338
|
+
| [brc177NoSendExpiryStateRank](#function-brc177nosendexpirystaterank) | [matchesOutputBasketPartial](#function-matchesoutputbasketpartial) | [upgradeCommissions](#function-upgradecommissions) |
|
|
21339
|
+
| [buildBeefForOutpoints](#function-buildbeefforoutpoints) | [matchesOutputPartial](#function-matchesoutputpartial) | [upgradeLegacyManagedChangeBasketDefault](#function-upgradelegacymanagedchangebasketdefault) |
|
|
21340
|
+
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [matchesOutputTagMapPartial](#function-matchesoutputtagmappartial) | [upgradeMonitorEvents](#function-upgrademonitorevents) |
|
|
21341
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [matchesOutputTagPartial](#function-matchesoutputtagpartial) | [upgradeOutputBaskets](#function-upgradeoutputbaskets) |
|
|
21342
|
+
| [canonicalizeAtomicBeef](#function-canonicalizeatomicbeef) | [matchesProvenTxPartial](#function-matchesproventxpartial) | [upgradeOutputTags](#function-upgradeoutputtags) |
|
|
21343
|
+
| [canonicalizeSyncProofIdentifiers](#function-canonicalizesyncproofidentifiers) | [matchesProvenTxReqPartial](#function-matchesproventxreqpartial) | [upgradeOutputTagsMap](#function-upgradeoutputtagsmap) |
|
|
21344
|
+
| [classifyArcadeRejection](#function-classifyarcaderejection) | [matchesSyncStatePartial](#function-matchessyncstatepartial) | [upgradeOutputs](#function-upgradeoutputs) |
|
|
21345
|
+
| [classifyBroadcastInputSpendEvidence](#function-classifybroadcastinputspendevidence) | [matchesTransactionPartial](#function-matchestransactionpartial) | [upgradeProvenTxReqs](#function-upgradeproventxreqs) |
|
|
21346
|
+
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [matchesTxLabelMapPartial](#function-matchestxlabelmappartial) | [upgradeProvenTxs](#function-upgradeproventxs) |
|
|
21347
|
+
| [classifyOutputUtxo](#function-classifyoutpututxo) | [matchesTxLabelPartial](#function-matchestxlabelpartial) | [upgradeSyncStates](#function-upgradesyncstates) |
|
|
21348
|
+
| [classifyReqStatus](#function-classifyreqstatus) | [maxDate](#function-maxdate) | [upgradeTransactions](#function-upgradetransactions) |
|
|
21349
|
+
| [cleanupExpiredActionBatches](#function-cleanupexpiredactionbatches) | [mergeInputBeefs](#function-mergeinputbeefs) | [upgradeTxLabels](#function-upgradetxlabels) |
|
|
21350
|
+
| [commitActionBatch](#function-commitactionbatch) | [mergeInputsIntoBeef](#function-mergeinputsintobeef) | [upgradeTxLabelsMap](#function-upgradetxlabelsmap) |
|
|
21351
|
+
| [commitActionBatchByDigest](#function-commitactionbatchbydigest) | [mergePlannerBeef](#function-mergeplannerbeef) | [upgradeUsers](#function-upgradeusers) |
|
|
21352
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [normalizeArcProviderConfig](#function-normalizearcproviderconfig) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
21353
|
+
| [compressActionBatchPack](#function-compressactionbatchpack) | [normalizeBulkFileDataValidationRequest](#function-normalizebulkfiledatavalidationrequest) | [validateActionBatchInlinePayload](#function-validateactionbatchinlinepayload) |
|
|
21354
|
+
| [compressActionBatchPackItems](#function-compressactionbatchpackitems) | [normalizeBulkHeaderFileInfo](#function-normalizebulkheaderfileinfo) | [validateActionBatchSendWith](#function-validateactionbatchsendwith) |
|
|
21355
|
+
| [computeMerklePath](#function-computemerklepath) | [normalizeBulkHeaderFileSequence](#function-normalizebulkheaderfilesequence) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
21356
|
+
| [computeMerkleRoot](#function-computemerkleroot) | [normalizeBulkHeaderFilesInfo](#function-normalizebulkheaderfilesinfo) | [validateArcadeTxData](#function-validatearcadetxdata) |
|
|
21357
|
+
| [containsControlCharacter](#function-containscontrolcharacter) | [normalizeFiatCurrencies](#function-normalizefiatcurrencies) | [validateArgon2idResult](#function-validateargon2idresult) |
|
|
21358
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [normalizeFiatCurrency](#function-normalizefiatcurrency) | [validateBaseBlockHeaderFormat](#function-validatebaseblockheaderformat) |
|
|
21359
|
+
| [convertBitsToWork](#function-convertbitstowork) | [normalizeFiatExchangeRates](#function-normalizefiatexchangerates) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
21360
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [normalizeFiatRate](#function-normalizefiatrate) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
21361
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [normalizeFiatRateTimestamps](#function-normalizefiatratetimestamps) | [validateCompactManifest](#function-validatecompactmanifest) |
|
|
21362
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [normalizeFiatTimestamp](#function-normalizefiattimestamp) | [validateDate](#function-validatedate) |
|
|
21363
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [normalizeMonitorIdentityKey](#function-normalizemonitoridentitykey) | [validateEntities](#function-validateentities) |
|
|
21364
|
+
| [copyMonitorTags](#function-copymonitortags) | [normalizePostRawHex](#function-normalizepostrawhex) | [validateEntity](#function-validateentity) |
|
|
21365
|
+
| [copyRawTransactionBytes](#function-copyrawtransactionbytes) | [normalizePostTxids](#function-normalizeposttxids) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
21366
|
+
| [copyValidatedBlockHeader](#function-copyvalidatedblockheader) | [normalizeTxid](#function-normalizetxid) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
21367
|
+
| [copyValidatedMonitorHeader](#function-copyvalidatedmonitorheader) | [normalizeWalletOutpoint](#function-normalizewalletoutpoint) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
21368
|
+
| [createAction](#function-createaction) | [notifyTransactionsOfProof](#function-notifytransactionsofproof) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
21369
|
+
| [createAndStartDefaultChaintracks](#function-createandstartdefaultchaintracks) | [offsetPrivKey](#function-offsetprivkey) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
21370
|
+
| [createCoinbaseTransaction](#function-createcoinbasetransaction) | [offsetPubKey](#function-offsetpubkey) | [validateHeaderProofOfWork](#function-validateheaderproofofwork) |
|
|
21371
|
+
| [createDefaultBulkFileDataManager](#function-createdefaultbulkfiledatamanager) | [optionalArraysEqual](#function-optionalarraysequal) | [validateJsonRpcResponse](#function-validatejsonrpcresponse) |
|
|
21372
|
+
| [createDefaultChaintracksClient](#function-createdefaultchaintracksclient) | [optionalMonitorInteger](#function-optionalmonitorinteger) | [validateManagedChangePolicy](#function-validatemanagedchangepolicy) |
|
|
21373
|
+
| [createDefaultChaintracksStorageOptions](#function-createdefaultchaintracksstorageoptions) | [parseBrc114ActionTimeLabels](#function-parsebrc114actiontimelabels) | [validateManifestActions](#function-validatemanifestactions) |
|
|
21374
|
+
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [parseBrc153ReferenceLabel](#function-parsebrc153referencelabel) | [validateMerklePathResult](#function-validatemerklepathresult) |
|
|
21375
|
+
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [parseBrc177NoSendExpiryLabels](#function-parsebrc177nosendexpirylabels) | [validateMonitorOptions](#function-validatemonitoroptions) |
|
|
21376
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [parseFileLink](#function-parsefilelink) | [validateNoSendExpiryRequest](#function-validatenosendexpiryrequest) |
|
|
21377
|
+
| [createIdbChaintracks](#function-createidbchaintracks) | [parseJsonRpc](#function-parsejsonrpc) | [validatePostBeefResult](#function-validatepostbeefresult) |
|
|
21378
|
+
| [createNoDbChaintracks](#function-createnodbchaintracks) | [parseOutpoint](#function-parseoutpoint) | [validatePostBeefResultOrServiceError](#function-validatepostbeefresultorserviceerror) |
|
|
21379
|
+
| [createNoSendExpiryAction](#function-createnosendexpiryaction) | [parseResults$](#function-parseresults$) | [validatePostTxResult](#function-validateposttxresult) |
|
|
21380
|
+
| [createStopHandler](#function-createstophandler) | [parseTxAndAssertId](#function-parsetxandassertid) | [validatePostTxResultOrServiceError](#function-validateposttxresultorserviceerror) |
|
|
21381
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validatePreparedBeefPolicy](#function-validatepreparedbeefpolicy) |
|
|
21382
|
+
| [createSyncMap](#function-createsyncmap) | [partitionActionLabels](#function-partitionactionlabels) | [validateRawTxResult](#function-validaterawtxresult) |
|
|
21383
|
+
| [dateMatches](#function-datematches) | [planAction](#function-planaction) | [validateRequiredInputs](#function-validaterequiredinputs) |
|
|
21384
|
+
| [decodeActionBatchPack](#function-decodeactionbatchpack) | [plannerInputLockingScript](#function-plannerinputlockingscript) | [validateRequiredOutputs](#function-validaterequiredoutputs) |
|
|
21385
|
+
| [decodeBinaryJsonValue](#function-decodebinaryjsonvalue) | [plannerOutputLockingScript](#function-planneroutputlockingscript) | [validateScriptHash](#function-validatescripthash) |
|
|
21386
|
+
| [decodeSyncTransfer](#function-decodesynctransfer) | [populateUtxoDetails](#function-populateutxodetails) | [validateScriptHashHistoryResult](#function-validatescripthashhistoryresult) |
|
|
21387
|
+
| [decompressActionBatchPack](#function-decompressactionbatchpack) | [prepareActionBatchCommit](#function-prepareactionbatchcommit) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
21388
|
+
| [defaultManagedChangePolicy](#function-defaultmanagedchangepolicy) | [prepareNoSendExpiry](#function-preparenosendexpiry) | [validateStatusForTxidsResult](#function-validatestatusfortxidsresult) |
|
|
21389
|
+
| [defaultPreparedBeefPolicy](#function-defaultpreparedbeefpolicy) | [processAction](#function-processaction) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
21390
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [processNoSendExpiryLifecycle](#function-processnosendexpirylifecycle) | [validateSyncCheckpoint](#function-validatesynccheckpoint) |
|
|
21391
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [proofOfWorkLimitBits](#function-proofofworklimitbits) | [validateSyncChunkEntities](#function-validatesyncchunkentities) |
|
|
21392
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [proveCertificate](#function-provecertificate) | [validateSyncProof](#function-validatesyncproof) |
|
|
21393
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [pruneBeefForTxids](#function-prunebeeffortxids) | [validateSyncTransferCapabilities](#function-validatesynctransfercapabilities) |
|
|
21394
|
+
| [doubleSha256BE](#function-doublesha256be) | [publicArcadeUrl](#function-publicarcadeurl) | [validateSyncTransferManifest](#function-validatesynctransfermanifest) |
|
|
21395
|
+
| [doubleSha256LE](#function-doublesha256le) | [purgeDataIdb](#function-purgedataidb) | [validateTrustSettings](#function-validatetrustsettings) |
|
|
21396
|
+
| [encodeActionBatchPack](#function-encodeactionbatchpack) | [putActionBatchBlob](#function-putactionbatchblob) | [validateUtxoStatusResult](#function-validateutxostatusresult) |
|
|
21397
|
+
| [encodeSyncTransfer](#function-encodesynctransfer) | [putActionBatchPack](#function-putactionbatchpack) | [validateWABCompleteAuthResponse](#function-validatewabcompleteauthresponse) |
|
|
21398
|
+
| [extendActionBatch](#function-extendactionbatch) | [quarantineReqInputs](#function-quarantinereqinputs) | [validateWABFaucetResponse](#function-validatewabfaucetresponse) |
|
|
21399
|
+
| [filterCertificatesByAttributes](#function-filtercertificatesbyattributes) | [quarantineReqInputsFromFailedParents](#function-quarantinereqinputsfromfailedparents) | [validateWABLinkedMethodsResponse](#function-validatewablinkedmethodsresponse) |
|
|
21400
|
+
| [filterCertificatesByIdentityKey](#function-filtercertificatesbyidentitykey) | [randomBytes](#function-randombytes) | [validateWABOperationResponse](#function-validatewaboperationresponse) |
|
|
21401
|
+
| [fundWalletFromP2PKHOutpoints](#function-fundwalletfromp2pkhoutpoints) | [randomBytesBase64](#function-randombytesbase64) | [validateWABRegistrationResponse](#function-validatewabregistrationresponse) |
|
|
21402
|
+
| [fundingRunwayExtension](#function-fundingrunwayextension) | [randomBytesHex](#function-randombyteshex) | [validateWABRetrieveShareResponse](#function-validatewabretrieveshareresponse) |
|
|
21403
|
+
| [generateChangeSdk](#function-generatechangesdk) | [randomizeOutputVouts](#function-randomizeoutputvouts) | [validateWABServerInfo](#function-validatewabserverinfo) |
|
|
21404
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [rawTransactionBytes](#function-rawtransactionbytes) | [validateWABStartAuthResponse](#function-validatewabstartauthresponse) |
|
|
21405
|
+
| [genesisBuffer](#function-genesisbuffer) | [readUInt32BE](#function-readuint32be) | [validateWABStoreShareResponse](#function-validatewabstoreshareresponse) |
|
|
21406
|
+
| [genesisHeader](#function-genesisheader) | [readUInt32LE](#function-readuint32le) | [validateWABUpdateShareResponse](#function-validatewabupdateshareresponse) |
|
|
21407
|
+
| [getActionBatchCapabilities](#function-getactionbatchcapabilities) | [readyArgon2idBackend](#function-readyargon2idbackend) | [validateWalletSettings](#function-validatewalletsettings) |
|
|
21408
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [receiveSyncTransfer](#function-receivesynctransfer) | [validateWocChainInfo](#function-validatewocchaininfo) |
|
|
21409
|
+
| [getBeefForTransactions](#function-getbeeffortransactions) | [redeemServiceCharges](#function-redeemservicecharges) | [varUintSize](#function-varuintsize) |
|
|
21410
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [registerArgon2idBackend](#function-registerargon2idbackend) | [verifyActionBatchManifestDigest](#function-verifyactionbatchmanifestdigest) |
|
|
21411
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [regtestArcadeUrl](#function-regtestarcadeurl) | [verifyHexString](#function-verifyhexstring) |
|
|
21412
|
+
| [getIdentityKey](#function-getidentitykey) | [regtestChaintracksUrl](#function-regtestchaintracksurl) | [verifyId](#function-verifyid) |
|
|
21413
|
+
| [getListOutputsSpecOp](#function-getlistoutputsspecop) | [renewActionBatch](#function-renewactionbatch) | [verifyInteger](#function-verifyinteger) |
|
|
21414
|
+
| [getProofs](#function-getproofs) | [repeatableRandom](#function-repeatablerandom) | [verifyNumber](#function-verifynumber) |
|
|
21415
|
+
| [getResultBeef](#function-getresultbeef) | [requireConclusiveUtxo](#function-requireconclusiveutxo) | [verifyOne](#function-verifyone) |
|
|
21416
|
+
| [getSyncChunk](#function-getsyncchunk) | [requireMonitorInteger](#function-requiremonitorinteger) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
21417
|
+
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [resolveAutoSigned](#function-resolveautosigned) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
21418
|
+
| [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [resolveDefaultChaintracksArguments](#function-resolvedefaultchaintracksarguments) | [verifyP2PKHOwnership](#function-verifyp2pkhownership) |
|
|
21419
|
+
| [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [restoreInputsToSpendable](#function-restoreinputstospendable) | [verifyRequestedOutputsUnchanged](#function-verifyrequestedoutputsunchanged) |
|
|
21420
|
+
| [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [resumeActionBatch](#function-resumeactionbatch) | [verifyTruthy](#function-verifytruthy) |
|
|
21421
|
+
| [handleUtxoConnReset](#function-handleutxoconnreset) | [reviewStatusIdb](#function-reviewstatusidb) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
21422
|
+
| [hasBrc177NoSendExpiryLabel](#function-hasbrc177nosendexpirylabel) | [reviewUtxoOutputs](#function-reviewutxooutputs) | [verifyUnlockScriptsBatch](#function-verifyunlockscriptsbatch) |
|
|
21423
|
+
| [importSingleOutpoint](#function-importsingleoutpoint) | [safeDiagnostic](#function-safediagnostic) | [verifyUnrequestedOutputsAreChangeOrCommission](#function-verifyunrequestedoutputsarechangeorcommission) |
|
|
21424
|
+
| [inputSourceTxid](#function-inputsourcetxid) | [sameSyncProof](#function-samesyncproof) | [wait](#function-wait) |
|
|
21425
|
+
| [internalizeAction](#function-internalizeaction) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
|
|
21426
|
+
| [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [selectCanonicalChange](#function-selectcanonicalchange) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
21427
|
+
| [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [selectNoSendExpiryFundingAnchor](#function-selectnosendexpiryfundinganchor) | [writeUInt32BE](#function-writeuint32be) |
|
|
21428
|
+
| [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [writeUInt32LE](#function-writeuint32le) |
|
|
21429
|
+
| [isArcServiceErrorStatus](#function-isarcserviceerrorstatus) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | |
|
|
21430
|
+
| [isAutoSpendableChangeOutput](#function-isautospendablechangeoutput) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | |
|
|
21346
21431
|
|
|
21347
21432
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21348
21433
|
|
|
@@ -21913,10 +21998,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
21913
21998
|
##### Function: authenticateMerklePathResult
|
|
21914
21999
|
|
|
21915
22000
|
```ts
|
|
21916
|
-
export async function authenticateMerklePathResult(requestedTxid: unknown, result: GetMerklePathResult, validator: MerkleRootValidator, requireProofOfWork = false, requireHeaderFormat = true): Promise<ValidatedMerklePathResult>
|
|
22001
|
+
export async function authenticateMerklePathResult(requestedTxid: unknown, result: GetMerklePathResult, validator: MerkleRootValidator, requireProofOfWork = false, requireHeaderFormat = true, chain?: Chain): Promise<ValidatedMerklePathResult>
|
|
21917
22002
|
```
|
|
21918
22003
|
|
|
21919
|
-
See also: [GetMerklePathResult](./client.md#interface-getmerklepathresult), [MerkleRootValidator](./services.md#interface-merklerootvalidator), [ValidatedMerklePathResult](./services.md#interface-validatedmerklepathresult)
|
|
22004
|
+
See also: [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [MerkleRootValidator](./services.md#interface-merklerootvalidator), [ValidatedMerklePathResult](./services.md#interface-validatedmerklepathresult)
|
|
21920
22005
|
|
|
21921
22006
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21922
22007
|
|
|
@@ -22302,9 +22387,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
22302
22387
|
Computes "chainWork" value for 4 byte Bitcoin block header "bits" value.
|
|
22303
22388
|
|
|
22304
22389
|
```ts
|
|
22305
|
-
export function convertBitsToWork(bits: number | number[]): string
|
|
22390
|
+
export function convertBitsToWork(bits: number | number[], chain?: Chain): string
|
|
22306
22391
|
```
|
|
22307
22392
|
|
|
22393
|
+
See also: [Chain](./client.md#type-chain)
|
|
22394
|
+
|
|
22308
22395
|
Returns
|
|
22309
22396
|
|
|
22310
22397
|
32 byte Buffer with "chainWork" value
|
|
@@ -22313,6 +22400,9 @@ Argument Details
|
|
|
22313
22400
|
|
|
22314
22401
|
+ **bits**
|
|
22315
22402
|
+ number or converted from Buffer using `readUint32LE`
|
|
22403
|
+
+ **chain**
|
|
22404
|
+
+ Optional chain the header belongs to. Selects its proof-of-work limit
|
|
22405
|
+
(see `proofOfWorkLimitBits`); omitted means the mainnet limit.
|
|
22316
22406
|
|
|
22317
22407
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22318
22408
|
|
|
@@ -22424,10 +22514,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
22424
22514
|
##### Function: copyValidatedBlockHeader
|
|
22425
22515
|
|
|
22426
22516
|
```ts
|
|
22427
|
-
export function copyValidatedBlockHeader(value: unknown, requireProofOfWork = false, requireHeaderFormat = true): BlockHeader
|
|
22517
|
+
export function copyValidatedBlockHeader(value: unknown, requireProofOfWork = false, requireHeaderFormat = true, chain?: Chain): BlockHeader
|
|
22428
22518
|
```
|
|
22429
22519
|
|
|
22430
|
-
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
22520
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain)
|
|
22431
22521
|
|
|
22432
22522
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22433
22523
|
|
|
@@ -22435,10 +22525,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
22435
22525
|
##### Function: copyValidatedMonitorHeader
|
|
22436
22526
|
|
|
22437
22527
|
```ts
|
|
22438
|
-
export function copyValidatedMonitorHeader(value: unknown, name = "header", requireProofOfWork = true): BlockHeader
|
|
22528
|
+
export function copyValidatedMonitorHeader(value: unknown, name = "header", requireProofOfWork = true, chain?: Chain): BlockHeader
|
|
22439
22529
|
```
|
|
22440
22530
|
|
|
22441
|
-
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
22531
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain)
|
|
22442
22532
|
|
|
22443
22533
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22444
22534
|
|
|
@@ -23048,6 +23138,17 @@ export function genesisHeader(chain: Chain): BlockHeader {
|
|
|
23048
23138
|
height: 0,
|
|
23049
23139
|
hash: "000000005d221c0e023cb56b5682cf094f32cd959958b40bc931e5797cae706c"
|
|
23050
23140
|
};
|
|
23141
|
+
case "regtest":
|
|
23142
|
+
return {
|
|
23143
|
+
version: 1,
|
|
23144
|
+
previousHash: "0000000000000000000000000000000000000000000000000000000000000000",
|
|
23145
|
+
merkleRoot: "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
|
|
23146
|
+
time: 1296688602,
|
|
23147
|
+
bits: 545259519,
|
|
23148
|
+
nonce: 2,
|
|
23149
|
+
height: 0,
|
|
23150
|
+
hash: "0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206"
|
|
23151
|
+
};
|
|
23051
23152
|
case "mock":
|
|
23052
23153
|
throw new Error("genesisHeader does not support 'mock' chain. Mock chain generates its own genesis block.");
|
|
23053
23154
|
}
|
|
@@ -24679,6 +24780,23 @@ See also: [NoSendExpiryLifecycleResult](./storage.md#interface-nosendexpirylifec
|
|
|
24679
24780
|
|
|
24680
24781
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
24681
24782
|
|
|
24783
|
+
---
|
|
24784
|
+
##### Function: proofOfWorkLimitBits
|
|
24785
|
+
|
|
24786
|
+
The compact encoding of the highest proof-of-work target `chain` admits.
|
|
24787
|
+
|
|
24788
|
+
Only `'regtest'` raises the limit. Every other chain — and an omitted chain,
|
|
24789
|
+
which is how every caller that predates this parameter asks — keeps the mainnet
|
|
24790
|
+
limit, so no existing validation is relaxed.
|
|
24791
|
+
|
|
24792
|
+
```ts
|
|
24793
|
+
export function proofOfWorkLimitBits(chain?: Chain): number
|
|
24794
|
+
```
|
|
24795
|
+
|
|
24796
|
+
See also: [Chain](./client.md#type-chain)
|
|
24797
|
+
|
|
24798
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
24799
|
+
|
|
24682
24800
|
---
|
|
24683
24801
|
##### Function: proveCertificate
|
|
24684
24802
|
|
|
@@ -24914,6 +25032,29 @@ See also: [AsyncArgon2idBackend](./client.md#interface-asyncargon2idbackend)
|
|
|
24914
25032
|
|
|
24915
25033
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
24916
25034
|
|
|
25035
|
+
---
|
|
25036
|
+
##### Function: regtestArcadeUrl
|
|
25037
|
+
|
|
25038
|
+
Arcade broadcaster / ARC endpoint for regtest, or `undefined` when `REGTEST_ARCADE_URL` is unset.
|
|
25039
|
+
|
|
25040
|
+
```ts
|
|
25041
|
+
export function regtestArcadeUrl(): string | undefined
|
|
25042
|
+
```
|
|
25043
|
+
|
|
25044
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
25045
|
+
|
|
25046
|
+
---
|
|
25047
|
+
##### Function: regtestChaintracksUrl
|
|
25048
|
+
|
|
25049
|
+
ChainTracks service URL for regtest. Falls back to `${REGTEST_ARCADE_URL}/chaintracks/v1` when
|
|
25050
|
+
`REGTEST_CHAINTRACKS_URL` is unset (mirrors the tstn layout). Throws when neither is configured.
|
|
25051
|
+
|
|
25052
|
+
```ts
|
|
25053
|
+
export function regtestChaintracksUrl(): string
|
|
25054
|
+
```
|
|
25055
|
+
|
|
25056
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
25057
|
+
|
|
24917
25058
|
---
|
|
24918
25059
|
##### Function: renewActionBatch
|
|
24919
25060
|
|
|
@@ -25989,12 +26130,14 @@ Validate headers contained in an array of bytes. The headers must be consecutive
|
|
|
25989
26130
|
where the hash of each header equals the previousHash of the following header.
|
|
25990
26131
|
|
|
25991
26132
|
```ts
|
|
25992
|
-
export function validateBufferOfHeaders(buffer: Uint8Array, previousHash: string, offset = 0, count = -1, previousChainWork?: string): {
|
|
26133
|
+
export function validateBufferOfHeaders(buffer: Uint8Array, previousHash: string, offset = 0, count = -1, previousChainWork?: string, chain?: Chain): {
|
|
25993
26134
|
lastHeaderHash: string;
|
|
25994
26135
|
lastChainWork: string | undefined;
|
|
25995
26136
|
}
|
|
25996
26137
|
```
|
|
25997
26138
|
|
|
26139
|
+
See also: [Chain](./client.md#type-chain)
|
|
26140
|
+
|
|
25998
26141
|
Returns
|
|
25999
26142
|
|
|
26000
26143
|
Header hash of last header validated or previousHash if there where none.
|
|
@@ -26009,6 +26152,11 @@ Argument Details
|
|
|
26009
26152
|
+ Optional starting offset within `buffer`.
|
|
26010
26153
|
+ **count**
|
|
26011
26154
|
+ Optional number of headers to validate. Validates to end of buffer if missing.
|
|
26155
|
+
+ **previousChainWork**
|
|
26156
|
+
+ Optional chain work through `previousHash`; when present, the result carries it forward.
|
|
26157
|
+
+ **chain**
|
|
26158
|
+
+ Optional chain the headers belong to. Selects its proof-of-work limit
|
|
26159
|
+
(see `proofOfWorkLimitBits`); omitted means the mainnet limit.
|
|
26012
26160
|
|
|
26013
26161
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
26014
26162
|
|
|
@@ -26144,17 +26292,24 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
26144
26292
|
Ensures that a header has a valid proof-of-work target and hash.
|
|
26145
26293
|
|
|
26146
26294
|
```ts
|
|
26147
|
-
export function validateHeaderDifficulty(hash: number[] | Uint8Array, bits: number)
|
|
26295
|
+
export function validateHeaderDifficulty(hash: number[] | Uint8Array, bits: number, chain?: Chain)
|
|
26148
26296
|
```
|
|
26149
26297
|
|
|
26298
|
+
See also: [Chain](./client.md#type-chain)
|
|
26299
|
+
|
|
26150
26300
|
Returns
|
|
26151
26301
|
|
|
26152
26302
|
true if the header is valid
|
|
26153
26303
|
|
|
26154
26304
|
Argument Details
|
|
26155
26305
|
|
|
26156
|
-
+ **
|
|
26157
|
-
+ The header
|
|
26306
|
+
+ **hash**
|
|
26307
|
+
+ The header hash, big-endian.
|
|
26308
|
+
+ **bits**
|
|
26309
|
+
+ The header's compact target.
|
|
26310
|
+
+ **chain**
|
|
26311
|
+
+ Optional chain the header belongs to. Selects its proof-of-work limit
|
|
26312
|
+
(see `proofOfWorkLimitBits`); omitted means the mainnet limit.
|
|
26158
26313
|
|
|
26159
26314
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
26160
26315
|
|
|
@@ -26176,13 +26331,13 @@ Ensures that a structured header's computed hash satisfies its declared
|
|
|
26176
26331
|
proof-of-work target.
|
|
26177
26332
|
|
|
26178
26333
|
```ts
|
|
26179
|
-
export function validateHeaderProofOfWork(header: BlockHeader): true {
|
|
26180
|
-
validateConsensusProofOfWork(header.hash, header.bits);
|
|
26334
|
+
export function validateHeaderProofOfWork(header: BlockHeader, chain?: Chain): true {
|
|
26335
|
+
validateConsensusProofOfWork(header.hash, header.bits, chain);
|
|
26181
26336
|
return true;
|
|
26182
26337
|
}
|
|
26183
26338
|
```
|
|
26184
26339
|
|
|
26185
|
-
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
26340
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain)
|
|
26186
26341
|
|
|
26187
26342
|
Returns
|
|
26188
26343
|
|
|
@@ -26192,6 +26347,9 @@ Argument Details
|
|
|
26192
26347
|
|
|
26193
26348
|
+ **header**
|
|
26194
26349
|
+ Header whose format and hash have already been checked.
|
|
26350
|
+
+ **chain**
|
|
26351
|
+
+ Optional chain the header belongs to. Selects its proof-of-work limit
|
|
26352
|
+
(see `proofOfWorkLimitBits`); omitted means the mainnet limit.
|
|
26195
26353
|
|
|
26196
26354
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
26197
26355
|
|
|
@@ -26238,10 +26396,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
26238
26396
|
##### Function: validateMerklePathResult
|
|
26239
26397
|
|
|
26240
26398
|
```ts
|
|
26241
|
-
export function validateMerklePathResult(requestedTxid: unknown, result: GetMerklePathResult, requireProofOfWork = false, requireHeaderFormat = true): ValidatedMerklePathResult
|
|
26399
|
+
export function validateMerklePathResult(requestedTxid: unknown, result: GetMerklePathResult, requireProofOfWork = false, requireHeaderFormat = true, chain?: Chain): ValidatedMerklePathResult
|
|
26242
26400
|
```
|
|
26243
26401
|
|
|
26244
|
-
See also: [GetMerklePathResult](./client.md#interface-getmerklepathresult), [ValidatedMerklePathResult](./services.md#interface-validatedmerklepathresult)
|
|
26402
|
+
See also: [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [ValidatedMerklePathResult](./services.md#interface-validatedmerklepathresult)
|
|
26245
26403
|
|
|
26246
26404
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
26247
26405
|
|
|
@@ -27170,7 +27328,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
27170
27328
|
##### Type: Chain
|
|
27171
27329
|
|
|
27172
27330
|
```ts
|
|
27173
|
-
export type Chain = "main" | "test" | "stn" | "ttn" | "tstn" | "mock"
|
|
27331
|
+
export type Chain = "main" | "test" | "stn" | "ttn" | "tstn" | "regtest" | "mock"
|
|
27174
27332
|
```
|
|
27175
27333
|
|
|
27176
27334
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|