@bsv/wallet-toolbox 2.4.0 → 2.4.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 +9 -0
- package/README.md +4 -0
- package/docs/client.md +160 -79
- package/docs/managed-change-policy.md +79 -0
- package/docs/services.md +10 -0
- package/docs/storage.md +86 -29
- package/docs/wallet.md +140 -74
- package/out/src/Wallet.d.ts +4 -0
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +6 -1
- package/out/src/Wallet.js.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.js +39 -15
- package/out/src/monitor/tasks/TaskArcSSE.js.map +1 -1
- package/out/src/sdk/types.d.ts +9 -0
- package/out/src/sdk/types.d.ts.map +1 -1
- package/out/src/sdk/types.js +16 -2
- package/out/src/sdk/types.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/ChaintracksServiceClient.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/ChaintracksServiceClient.js +8 -0
- package/out/src/services/chaintracker/chaintracks/ChaintracksServiceClient.js.map +1 -1
- package/out/src/services/providers/Arcade.d.ts +1 -0
- package/out/src/services/providers/Arcade.d.ts.map +1 -1
- package/out/src/services/providers/Arcade.js +40 -13
- package/out/src/services/providers/Arcade.js.map +1 -1
- package/out/src/signer/methods/internalizeAction.d.ts +6 -4
- package/out/src/signer/methods/internalizeAction.d.ts.map +1 -1
- package/out/src/signer/methods/internalizeAction.js +12 -7
- package/out/src/signer/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/StorageIdb.d.ts +2 -1
- package/out/src/storage/StorageIdb.d.ts.map +1 -1
- package/out/src/storage/StorageIdb.js +12 -5
- package/out/src/storage/StorageIdb.js.map +1 -1
- package/out/src/storage/StorageKnex.d.ts +2 -1
- package/out/src/storage/StorageKnex.d.ts.map +1 -1
- package/out/src/storage/StorageKnex.js +27 -2
- package/out/src/storage/StorageKnex.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/index.client.d.ts +1 -0
- package/out/src/storage/index.client.d.ts.map +1 -1
- package/out/src/storage/index.client.js +1 -0
- package/out/src/storage/index.client.js.map +1 -1
- package/out/src/storage/methods/ListOutputsSpecOp.d.ts +2 -0
- package/out/src/storage/methods/ListOutputsSpecOp.d.ts.map +1 -1
- package/out/src/storage/methods/ListOutputsSpecOp.js +13 -1
- package/out/src/storage/methods/ListOutputsSpecOp.js.map +1 -1
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +6 -6
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/internalizeAction.d.ts +6 -4
- package/out/src/storage/methods/internalizeAction.d.ts.map +1 -1
- package/out/src/storage/methods/internalizeAction.js +23 -12
- package/out/src/storage/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/methods/listOutputsIdb.d.ts.map +1 -1
- package/out/src/storage/methods/listOutputsIdb.js +21 -3
- package/out/src/storage/methods/listOutputsIdb.js.map +1 -1
- package/out/src/storage/methods/listOutputsKnex.d.ts.map +1 -1
- package/out/src/storage/methods/listOutputsKnex.js +14 -0
- package/out/src/storage/methods/listOutputsKnex.js.map +1 -1
- package/out/src/storage/methods/managedChange.d.ts +26 -0
- package/out/src/storage/methods/managedChange.d.ts.map +1 -0
- package/out/src/storage/methods/managedChange.js +43 -0
- package/out/src/storage/methods/managedChange.js.map +1 -0
- package/package.json +3 -3
package/docs/storage.md
CHANGED
|
@@ -462,6 +462,7 @@ export interface ListOutputsSpecOp {
|
|
|
462
462
|
includeOutputScripts?: boolean;
|
|
463
463
|
includeSpent?: boolean;
|
|
464
464
|
totalOutputsIsSumOfSatoshis?: boolean;
|
|
465
|
+
managedChangeOnly?: boolean;
|
|
465
466
|
resultFromTags?: (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[]) => Promise<ListOutputsResult>;
|
|
466
467
|
resultFromOutputs?: (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[], outputs: TableOutput[]) => Promise<ListOutputsResult>;
|
|
467
468
|
filterOutputs?: (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[], outputs: TableOutput[]) => Promise<TableOutput[]>;
|
|
@@ -472,6 +473,14 @@ export interface ListOutputsSpecOp {
|
|
|
472
473
|
|
|
473
474
|
See also: [AuthId](./client.md#interface-authid), [StorageProvider](./storage.md#class-storageprovider), [TableOutput](./storage.md#interface-tableoutput)
|
|
474
475
|
|
|
476
|
+
###### Property managedChangeOnly
|
|
477
|
+
|
|
478
|
+
Restrict the operation to wallet-managed, BRC-29-signable change.
|
|
479
|
+
|
|
480
|
+
```ts
|
|
481
|
+
managedChangeOnly?: boolean
|
|
482
|
+
```
|
|
483
|
+
|
|
475
484
|
###### Property tagsParamsCount
|
|
476
485
|
|
|
477
486
|
How many positional tags to intercept.
|
|
@@ -3669,7 +3678,8 @@ Proceeds in three stages:
|
|
|
3669
3678
|
3. Find an output that comes as close to funding as possible (targetSatoshis).
|
|
3670
3679
|
4. Return undefined if no output is found.
|
|
3671
3680
|
|
|
3672
|
-
Outputs must belong to userId and basketId and
|
|
3681
|
+
Outputs must belong to userId and basketId and satisfy the wallet-managed
|
|
3682
|
+
BRC-29 change policy.
|
|
3673
3683
|
Their corresponding transaction must have status of 'completed', 'unproven', or 'sending' (if excludeSending is false).
|
|
3674
3684
|
|
|
3675
3685
|
```ts
|
|
@@ -4089,7 +4099,8 @@ See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
|
4089
4099
|
|
|
4090
4100
|
###### Method countChangeInputs
|
|
4091
4101
|
|
|
4092
|
-
Counts
|
|
4102
|
+
Counts wallet-managed BRC-29 change outputs for userId in basketId that
|
|
4103
|
+
are currently eligible for automatic allocation
|
|
4093
4104
|
AND whose transaction status is one of:
|
|
4094
4105
|
- completed
|
|
4095
4106
|
- unproven
|
|
@@ -4902,26 +4913,28 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4902
4913
|
|
|
4903
4914
|
| | | |
|
|
4904
4915
|
| --- | --- | --- |
|
|
4905
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [
|
|
4906
|
-
| [classifyReqStatus](#function-classifyreqstatus) | [
|
|
4907
|
-
| [createAction](#function-createaction) | [
|
|
4908
|
-
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [
|
|
4909
|
-
| [createSyncMap](#function-createsyncmap) | [
|
|
4910
|
-
| [dateMatches](#function-datematches) | [
|
|
4911
|
-
| [decryptBRC39](#function-decryptbrc39) | [
|
|
4912
|
-
| [determineDBType](#function-determinedbtype) | [
|
|
4913
|
-
| [encryptBRC39](#function-encryptbrc39) | [
|
|
4914
|
-
| [exportBRC38](#function-exportbrc38) | [
|
|
4915
|
-
| [exportBRC38Json](#function-exportbrc38json) | [
|
|
4916
|
-
| [exportBRC39](#function-exportbrc39) | [
|
|
4917
|
-
| [generateChangeSdk](#function-generatechangesdk) | [
|
|
4918
|
-
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [
|
|
4919
|
-
| [getBeefForTransaction](#function-getbeeffortransaction) | [
|
|
4920
|
-
| [getListOutputsSpecOp](#function-getlistoutputsspecop) | [
|
|
4921
|
-
| [getSyncChunk](#function-getsyncchunk) | [
|
|
4922
|
-
| [importBRC38](#function-importbrc38) | [
|
|
4923
|
-
| [importBRC39](#function-importbrc39) | [
|
|
4924
|
-
| [internalizeAction](#function-internalizeaction) | [
|
|
4916
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [markUserInputsSpent](#function-markuserinputsspent) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) |
|
|
4917
|
+
| [classifyReqStatus](#function-classifyreqstatus) | [matchesCertificateFieldPartial](#function-matchescertificatefieldpartial) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
4918
|
+
| [createAction](#function-createaction) | [matchesCertificatePartial](#function-matchescertificatepartial) | [transactionInputSize](#function-transactioninputsize) |
|
|
4919
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [matchesCommissionPartial](#function-matchescommissionpartial) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
4920
|
+
| [createSyncMap](#function-createsyncmap) | [matchesMonitorEventPartial](#function-matchesmonitoreventpartial) | [transactionSize](#function-transactionsize) |
|
|
4921
|
+
| [dateMatches](#function-datematches) | [matchesOutputBasketPartial](#function-matchesoutputbasketpartial) | [updateReqsFromAggregateResults](#function-updatereqsfromaggregateresults) |
|
|
4922
|
+
| [decryptBRC39](#function-decryptbrc39) | [matchesOutputPartial](#function-matchesoutputpartial) | [upgradeAllStoresV1](#function-upgradeallstoresv1) |
|
|
4923
|
+
| [determineDBType](#function-determinedbtype) | [matchesOutputTagMapPartial](#function-matchesoutputtagmappartial) | [upgradeCertificateFields](#function-upgradecertificatefields) |
|
|
4924
|
+
| [encryptBRC39](#function-encryptbrc39) | [matchesOutputTagPartial](#function-matchesoutputtagpartial) | [upgradeCertificates](#function-upgradecertificates) |
|
|
4925
|
+
| [exportBRC38](#function-exportbrc38) | [matchesProvenTxPartial](#function-matchesproventxpartial) | [upgradeCommissions](#function-upgradecommissions) |
|
|
4926
|
+
| [exportBRC38Json](#function-exportbrc38json) | [matchesProvenTxReqPartial](#function-matchesproventxreqpartial) | [upgradeMonitorEvents](#function-upgrademonitorevents) |
|
|
4927
|
+
| [exportBRC39](#function-exportbrc39) | [matchesSyncStatePartial](#function-matchessyncstatepartial) | [upgradeOutputBaskets](#function-upgradeoutputbaskets) |
|
|
4928
|
+
| [generateChangeSdk](#function-generatechangesdk) | [matchesTransactionPartial](#function-matchestransactionpartial) | [upgradeOutputTags](#function-upgradeoutputtags) |
|
|
4929
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [matchesTxLabelMapPartial](#function-matchestxlabelmappartial) | [upgradeOutputTagsMap](#function-upgradeoutputtagsmap) |
|
|
4930
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [matchesTxLabelPartial](#function-matchestxlabelpartial) | [upgradeOutputs](#function-upgradeoutputs) |
|
|
4931
|
+
| [getListOutputsSpecOp](#function-getlistoutputsspecop) | [mergeInputBeefs](#function-mergeinputbeefs) | [upgradeProvenTxReqs](#function-upgradeproventxreqs) |
|
|
4932
|
+
| [getSyncChunk](#function-getsyncchunk) | [mergeInputsIntoBeef](#function-mergeinputsintobeef) | [upgradeProvenTxs](#function-upgradeproventxs) |
|
|
4933
|
+
| [importBRC38](#function-importbrc38) | [notifyTransactionsOfProof](#function-notifytransactionsofproof) | [upgradeSyncStates](#function-upgradesyncstates) |
|
|
4934
|
+
| [importBRC39](#function-importbrc39) | [offsetPrivKey](#function-offsetprivkey) | [upgradeTransactions](#function-upgradetransactions) |
|
|
4935
|
+
| [internalizeAction](#function-internalizeaction) | [offsetPubKey](#function-offsetpubkey) | [upgradeTxLabels](#function-upgradetxlabels) |
|
|
4936
|
+
| [isAutoSpendableChangeOutput](#function-isautospendablechangeoutput) | [parseBRC38Json](#function-parsebrc38json) | [upgradeTxLabelsMap](#function-upgradetxlabelsmap) |
|
|
4937
|
+
| [isManagedChangeOutput](#function-ismanagedchangeoutput) | [partitionActionLabels](#function-partitionactionlabels) | [upgradeUsers](#function-upgradeusers) |
|
|
4925
4938
|
| [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [processAction](#function-processaction) | [validateDate](#function-validatedate) |
|
|
4926
4939
|
| [listActions](#function-listactions) | [purgeData](#function-purgedata) | [validateEntities](#function-validateentities) |
|
|
4927
4940
|
| [listActionsIdb](#function-listactionsidb) | [purgeDataIdb](#function-purgedataidb) | [validateEntity](#function-validateentity) |
|
|
@@ -4930,8 +4943,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4930
4943
|
| [listOutputsIdb](#function-listoutputsidb) | [restoreInputsToSpendable](#function-restoreinputstospendable) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
4931
4944
|
| [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [reviewStatus](#function-reviewstatus) | [validateSyncChunkEntities](#function-validatesyncchunkentities) |
|
|
4932
4945
|
| [markStaleInputsAsSpent](#function-markstaleinputsasspent) | [reviewStatusIdb](#function-reviewstatusidb) | [varUintSize](#function-varuintsize) |
|
|
4933
|
-
| [markUserInputsSpent](#function-markuserinputsspent) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | |
|
|
4934
|
-
| [matchesCertificateFieldPartial](#function-matchescertificatefieldpartial) | [shareReqsWithWorld](#function-sharereqswithworld) | |
|
|
4935
4946
|
|
|
4936
4947
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4937
4948
|
|
|
@@ -5225,12 +5236,14 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
5225
5236
|
|
|
5226
5237
|
"basket insertion" Merge Rules:
|
|
5227
5238
|
1. The "default" basket may not be specified as the insertion basket.
|
|
5228
|
-
2.
|
|
5229
|
-
3.
|
|
5239
|
+
2. Managed change may not be reclassified as a basket insertion.
|
|
5240
|
+
3. Basket insertions do not affect wallet balance and are typed "custom".
|
|
5230
5241
|
|
|
5231
5242
|
"wallet payment" Merge Rules:
|
|
5232
|
-
1.
|
|
5233
|
-
2.
|
|
5243
|
+
1. Targeting an existing managed output is idempotent.
|
|
5244
|
+
2. Targeting an existing custom output converts it to managed BRC-29
|
|
5245
|
+
change and increases wallet balance. This includes verified recovery of
|
|
5246
|
+
a legacy custom row that was incorrectly placed in the default basket.
|
|
5234
5247
|
|
|
5235
5248
|
```ts
|
|
5236
5249
|
export async function internalizeAction(storage: StorageProvider, auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>
|
|
@@ -5240,6 +5253,35 @@ See also: [AuthId](./client.md#interface-authid), [StorageInternalizeActionResul
|
|
|
5240
5253
|
|
|
5241
5254
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5242
5255
|
|
|
5256
|
+
---
|
|
5257
|
+
##### Function: isAutoSpendableChangeOutput
|
|
5258
|
+
|
|
5259
|
+
True when managed change is currently eligible for automatic allocation.
|
|
5260
|
+
|
|
5261
|
+
```ts
|
|
5262
|
+
export function isAutoSpendableChangeOutput(output: TableOutput | undefined): output is TableOutput
|
|
5263
|
+
```
|
|
5264
|
+
|
|
5265
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
5266
|
+
|
|
5267
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5268
|
+
|
|
5269
|
+
---
|
|
5270
|
+
##### Function: isManagedChangeOutput
|
|
5271
|
+
|
|
5272
|
+
True when an output has all metadata required to use the wallet-managed
|
|
5273
|
+
BRC-29 signing path. `senderIdentityKey` is optional: wallet-created change
|
|
5274
|
+
uses the client's change public key when it is absent, while received
|
|
5275
|
+
BRC-29 payments record the sender's identity key.
|
|
5276
|
+
|
|
5277
|
+
```ts
|
|
5278
|
+
export function isManagedChangeOutput(output: TableOutput | undefined): output is TableOutput
|
|
5279
|
+
```
|
|
5280
|
+
|
|
5281
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
5282
|
+
|
|
5283
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5284
|
+
|
|
5243
5285
|
---
|
|
5244
5286
|
##### Function: keyOffsetToHashedSecret
|
|
5245
5287
|
|
|
@@ -6218,6 +6260,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6218
6260
|
| |
|
|
6219
6261
|
| --- |
|
|
6220
6262
|
| [getLabelToSpecOp](#variable-getlabeltospecop) |
|
|
6263
|
+
| [managedChangeOutputFields](#variable-managedchangeoutputfields) |
|
|
6221
6264
|
| [maxChangeOutputsPerTransaction](#variable-maxchangeoutputspertransaction) |
|
|
6222
6265
|
| [maxPossibleSatoshis](#variable-maxpossiblesatoshis) |
|
|
6223
6266
|
| [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) |
|
|
@@ -6292,6 +6335,20 @@ See also: [AuthId](./client.md#interface-authid), [ListActionsSpecOp](./storage.
|
|
|
6292
6335
|
|
|
6293
6336
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6294
6337
|
|
|
6338
|
+
---
|
|
6339
|
+
##### Variable: managedChangeOutputFields
|
|
6340
|
+
|
|
6341
|
+
```ts
|
|
6342
|
+
managedChangeOutputFields = {
|
|
6343
|
+
type: "P2PKH",
|
|
6344
|
+
change: true,
|
|
6345
|
+
providedBy: "storage",
|
|
6346
|
+
purpose: "change"
|
|
6347
|
+
} as const
|
|
6348
|
+
```
|
|
6349
|
+
|
|
6350
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6351
|
+
|
|
6295
6352
|
---
|
|
6296
6353
|
##### Variable: maxChangeOutputsPerTransaction
|
|
6297
6354
|
|
|
@@ -6369,4 +6426,4 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6369
6426
|
|
|
6370
6427
|
---
|
|
6371
6428
|
|
|
6372
|
-
<!--#endregion ts2md-api-merged-here-->
|
|
6429
|
+
<!--#endregion ts2md-api-merged-here-->
|
package/docs/wallet.md
CHANGED
|
@@ -10989,6 +10989,10 @@ sum of output satoshis
|
|
|
10989
10989
|
Uses `listOutputs` to iterate over chunks of up to 1000 outputs to
|
|
10990
10990
|
compute the sum of output satoshis.
|
|
10991
10991
|
|
|
10992
|
+
For `default`, only wallet-managed BRC-29 change is included. Raw
|
|
10993
|
+
administrative `listOutputs({ basket: 'default' })` remains available to
|
|
10994
|
+
discover legacy incompatible rows for recovery.
|
|
10995
|
+
|
|
10992
10996
|
```ts
|
|
10993
10997
|
async balanceAndUtxos(basket: string = "default"): Promise<WalletBalance>
|
|
10994
10998
|
```
|
|
@@ -11755,58 +11759,58 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
11755
11759
|
|
|
11756
11760
|
| | | |
|
|
11757
11761
|
| --- | --- | --- |
|
|
11758
|
-
| [WalletErrorFromJson](#function-walleterrorfromjson) | [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [
|
|
11759
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [
|
|
11760
|
-
| [addWork](#function-addwork) | [handleUtxoConnReset](#function-handleutxoconnreset) | [
|
|
11761
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [internalizeAction](#function-internalizeaction) | [
|
|
11762
|
-
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [internalizeAction](#function-internalizeaction) | [
|
|
11763
|
-
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [
|
|
11764
|
-
| [arraysEqual](#function-arraysequal) | [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [
|
|
11765
|
-
| [asArray](#function-asarray) | [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [
|
|
11766
|
-
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [isArcServiceErrorStatus](#function-isarcserviceerrorstatus) | [
|
|
11767
|
-
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [
|
|
11768
|
-
| [asBsvSdkScript](#function-asbsvsdkscript) | [
|
|
11769
|
-
| [asBsvSdkTx](#function-asbsvsdktx) | [
|
|
11770
|
-
| [asString](#function-asstring) | [
|
|
11771
|
-
| [asUint8Array](#function-asuint8array) | [
|
|
11772
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [
|
|
11773
|
-
| [blockHash](#function-blockhash) | [
|
|
11774
|
-
| [buildSignableTransaction](#function-buildsignabletransaction) | [
|
|
11775
|
-
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [
|
|
11776
|
-
| [classifyReqStatus](#function-classifyreqstatus) | [
|
|
11777
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
11778
|
-
| [computeMerklePath](#function-computemerklepath) | [
|
|
11779
|
-
| [computeMerkleRoot](#function-computemerkleroot) | [
|
|
11780
|
-
| [convertBitsToTarget](#function-convertbitstotarget) | [
|
|
11781
|
-
| [convertBitsToWork](#function-convertbitstowork) | [
|
|
11782
|
-
| [convertBufferToUint32](#function-convertbuffertouint32) | [
|
|
11783
|
-
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [
|
|
11784
|
-
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [
|
|
11785
|
-
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [
|
|
11786
|
-
| [createAction](#function-createaction) | [
|
|
11787
|
-
| [createAction](#function-createaction) | [
|
|
11788
|
-
| [createCoinbaseTransaction](#function-createcoinbasetransaction) | [
|
|
11789
|
-
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [
|
|
11790
|
-
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [
|
|
11791
|
-
| [createSyncMap](#function-createsyncmap) | [
|
|
11792
|
-
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [
|
|
11793
|
-
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [
|
|
11794
|
-
| [deserializeBlockHeader](#function-deserializeblockheader) | [
|
|
11795
|
-
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [
|
|
11796
|
-
| [doubleSha256BE](#function-doublesha256be) | [
|
|
11797
|
-
| [doubleSha256LE](#function-doublesha256le) | [
|
|
11798
|
-
| [generateChangeSdk](#function-generatechangesdk) | [
|
|
11799
|
-
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [
|
|
11800
|
-
| [genesisBuffer](#function-genesisbuffer) | [
|
|
11801
|
-
| [genesisHeader](#function-genesisheader) | [
|
|
11802
|
-
| [getBeefForTransaction](#function-getbeeffortransaction) | [
|
|
11803
|
-
| [getBeefForTxid](#function-getbeeffortxid) | [
|
|
11804
|
-
| [getExchangeRatesIo](#function-getexchangeratesio) | [
|
|
11805
|
-
| [getIdentityKey](#function-getidentitykey) | [
|
|
11806
|
-
| [getProofs](#function-getproofs) | [
|
|
11807
|
-
| [getSyncChunk](#function-getsyncchunk) | [
|
|
11808
|
-
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [
|
|
11809
|
-
| [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [
|
|
11762
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) |
|
|
11763
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) |
|
|
11764
|
+
| [addWork](#function-addwork) | [handleUtxoConnReset](#function-handleutxoconnreset) | [sha256Hash](#function-sha256hash) |
|
|
11765
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [internalizeAction](#function-internalizeaction) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
11766
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [internalizeAction](#function-internalizeaction) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
11767
|
+
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [signAction](#function-signaction) |
|
|
11768
|
+
| [arraysEqual](#function-arraysequal) | [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [stampLog](#function-stamplog) |
|
|
11769
|
+
| [asArray](#function-asarray) | [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [stampLogFormat](#function-stamplogformat) |
|
|
11770
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [isArcServiceErrorStatus](#function-isarcserviceerrorstatus) | [subWork](#function-subwork) |
|
|
11771
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [isAutoSpendableChangeOutput](#function-isautospendablechangeoutput) | [swapByteOrder](#function-swapbyteorder) |
|
|
11772
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [isBaseBlockHeader](#function-isbaseblockheader) | [throwDummyReviewActions](#function-throwdummyreviewactions) |
|
|
11773
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [isBlockHeader](#function-isblockheader) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
11774
|
+
| [asString](#function-asstring) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [toLookupNetworkPreset](#function-tolookupnetworkpreset) |
|
|
11775
|
+
| [asUint8Array](#function-asuint8array) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [toWalletNetwork](#function-towalletnetwork) |
|
|
11776
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [isListActionsSpecOp](#function-islistactionsspecop) | [transactionInputSize](#function-transactioninputsize) |
|
|
11777
|
+
| [blockHash](#function-blockhash) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
11778
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [isLive](#function-islive) | [transactionSize](#function-transactionsize) |
|
|
11779
|
+
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [isLiveBlockHeader](#function-isliveblockheader) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
11780
|
+
| [classifyReqStatus](#function-classifyreqstatus) | [isManagedChangeOutput](#function-ismanagedchangeoutput) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
11781
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [isMoreWork](#function-ismorework) | [updateReqsFromAggregateResults](#function-updatereqsfromaggregateresults) |
|
|
11782
|
+
| [computeMerklePath](#function-computemerklepath) | [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
11783
|
+
| [computeMerkleRoot](#function-computemerkleroot) | [listCertificates](#function-listcertificates) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
11784
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
11785
|
+
| [convertBitsToWork](#function-convertbitstowork) | [logCreateActionArgs](#function-logcreateactionargs) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
11786
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [logWalletError](#function-logwalleterror) | [validateDate](#function-validatedate) |
|
|
11787
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [makeAtomicBeef](#function-makeatomicbeef) | [validateEntities](#function-validateentities) |
|
|
11788
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [makeChangeLock](#function-makechangelock) | [validateEntity](#function-validateentity) |
|
|
11789
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [makeMerklePathNote](#function-makemerklepathnote) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
11790
|
+
| [createAction](#function-createaction) | [markStaleInputsAsSpent](#function-markstaleinputsasspent) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
11791
|
+
| [createAction](#function-createaction) | [markUserInputsSpent](#function-markuserinputsspent) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
11792
|
+
| [createCoinbaseTransaction](#function-createcoinbasetransaction) | [maxDate](#function-maxdate) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
11793
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [mergeInputBeefs](#function-mergeinputbeefs) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
11794
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [mergeInputsIntoBeef](#function-mergeinputsintobeef) | [validateScriptHash](#function-validatescripthash) |
|
|
11795
|
+
| [createSyncMap](#function-createsyncmap) | [notifyTransactionsOfProof](#function-notifytransactionsofproof) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
11796
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [offsetPrivKey](#function-offsetprivkey) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
11797
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [offsetPubKey](#function-offsetpubkey) | [validateSyncChunkEntities](#function-validatesyncchunkentities) |
|
|
11798
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [optionalArraysEqual](#function-optionalarraysequal) | [varUintSize](#function-varuintsize) |
|
|
11799
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [parseResults$](#function-parseresults$) | [verifyHexString](#function-verifyhexstring) |
|
|
11800
|
+
| [doubleSha256BE](#function-doublesha256be) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [verifyId](#function-verifyid) |
|
|
11801
|
+
| [doubleSha256LE](#function-doublesha256le) | [populateUtxoDetails](#function-populateutxodetails) | [verifyInteger](#function-verifyinteger) |
|
|
11802
|
+
| [generateChangeSdk](#function-generatechangesdk) | [processAction](#function-processaction) | [verifyNumber](#function-verifynumber) |
|
|
11803
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [processAction](#function-processaction) | [verifyOne](#function-verifyone) |
|
|
11804
|
+
| [genesisBuffer](#function-genesisbuffer) | [proveCertificate](#function-provecertificate) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
11805
|
+
| [genesisHeader](#function-genesisheader) | [randomBytes](#function-randombytes) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
11806
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [randomBytesBase64](#function-randombytesbase64) | [verifyRequestedOutputsUnchanged](#function-verifyrequestedoutputsunchanged) |
|
|
11807
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [randomBytesHex](#function-randombyteshex) | [verifyTruthy](#function-verifytruthy) |
|
|
11808
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [readUInt32BE](#function-readuint32be) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
11809
|
+
| [getIdentityKey](#function-getidentitykey) | [readUInt32LE](#function-readuint32le) | [verifyUnrequestedOutputsAreChangeOrCommission](#function-verifyunrequestedoutputsarechangeorcommission) |
|
|
11810
|
+
| [getProofs](#function-getproofs) | [redeemServiceCharges](#function-redeemservicecharges) | [wait](#function-wait) |
|
|
11811
|
+
| [getSyncChunk](#function-getsyncchunk) | [restoreInputsToSpendable](#function-restoreinputstospendable) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
11812
|
+
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [writeUInt32BE](#function-writeuint32be) |
|
|
11813
|
+
| [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [writeUInt32LE](#function-writeuint32le) |
|
|
11810
11814
|
|
|
11811
11815
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11812
11816
|
|
|
@@ -12790,12 +12794,14 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
12790
12794
|
|
|
12791
12795
|
"basket insertion" Merge Rules:
|
|
12792
12796
|
1. The "default" basket may not be specified as the insertion basket.
|
|
12793
|
-
2.
|
|
12794
|
-
3.
|
|
12797
|
+
2. Managed change may not be reclassified as a basket insertion.
|
|
12798
|
+
3. Basket insertions do not affect wallet balance and are typed "custom".
|
|
12795
12799
|
|
|
12796
12800
|
"wallet payment" Merge Rules:
|
|
12797
|
-
1.
|
|
12798
|
-
2.
|
|
12801
|
+
1. Targeting an existing managed output is idempotent.
|
|
12802
|
+
2. Targeting a custom output converts it to managed BRC-29 change after
|
|
12803
|
+
the locking script is verified. This is the only supported in-place
|
|
12804
|
+
recovery path for a misclassified BRC-29 payment.
|
|
12799
12805
|
|
|
12800
12806
|
```ts
|
|
12801
12807
|
export async function internalizeAction(wallet: Wallet, auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>
|
|
@@ -12838,12 +12844,14 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
12838
12844
|
|
|
12839
12845
|
"basket insertion" Merge Rules:
|
|
12840
12846
|
1. The "default" basket may not be specified as the insertion basket.
|
|
12841
|
-
2.
|
|
12842
|
-
3.
|
|
12847
|
+
2. Managed change may not be reclassified as a basket insertion.
|
|
12848
|
+
3. Basket insertions do not affect wallet balance and are typed "custom".
|
|
12843
12849
|
|
|
12844
12850
|
"wallet payment" Merge Rules:
|
|
12845
|
-
1.
|
|
12846
|
-
2.
|
|
12851
|
+
1. Targeting an existing managed output is idempotent.
|
|
12852
|
+
2. Targeting an existing custom output converts it to managed BRC-29
|
|
12853
|
+
change and increases wallet balance. This includes verified recovery of
|
|
12854
|
+
a legacy custom row that was incorrectly placed in the default basket.
|
|
12847
12855
|
|
|
12848
12856
|
```ts
|
|
12849
12857
|
export async function internalizeAction(storage: StorageProvider, auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>
|
|
@@ -12889,6 +12897,19 @@ export function isArcServiceErrorStatus(status: number | undefined, detail?: str
|
|
|
12889
12897
|
|
|
12890
12898
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12891
12899
|
|
|
12900
|
+
---
|
|
12901
|
+
##### Function: isAutoSpendableChangeOutput
|
|
12902
|
+
|
|
12903
|
+
True when managed change is currently eligible for automatic allocation.
|
|
12904
|
+
|
|
12905
|
+
```ts
|
|
12906
|
+
export function isAutoSpendableChangeOutput(output: TableOutput | undefined): output is TableOutput
|
|
12907
|
+
```
|
|
12908
|
+
|
|
12909
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
12910
|
+
|
|
12911
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12912
|
+
|
|
12892
12913
|
---
|
|
12893
12914
|
##### Function: isBaseBlockHeader
|
|
12894
12915
|
|
|
@@ -13050,6 +13071,22 @@ See also: [AnyBlockHeader](./services.md#type-anyblockheader), [LiveBlockHeader]
|
|
|
13050
13071
|
|
|
13051
13072
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13052
13073
|
|
|
13074
|
+
---
|
|
13075
|
+
##### Function: isManagedChangeOutput
|
|
13076
|
+
|
|
13077
|
+
True when an output has all metadata required to use the wallet-managed
|
|
13078
|
+
BRC-29 signing path. `senderIdentityKey` is optional: wallet-created change
|
|
13079
|
+
uses the client's change public key when it is absent, while received
|
|
13080
|
+
BRC-29 payments record the sender's identity key.
|
|
13081
|
+
|
|
13082
|
+
```ts
|
|
13083
|
+
export function isManagedChangeOutput(output: TableOutput | undefined): output is TableOutput
|
|
13084
|
+
```
|
|
13085
|
+
|
|
13086
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
13087
|
+
|
|
13088
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13089
|
+
|
|
13053
13090
|
---
|
|
13054
13091
|
##### Function: isMoreWork
|
|
13055
13092
|
|
|
@@ -14829,25 +14866,31 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14829
14866
|
---
|
|
14830
14867
|
#### Variables
|
|
14831
14868
|
|
|
14832
|
-
| | |
|
|
14833
|
-
| --- | --- |
|
|
14834
|
-
| [
|
|
14835
|
-
| [
|
|
14836
|
-
| [
|
|
14837
|
-
| [
|
|
14838
|
-
| [
|
|
14839
|
-
| [
|
|
14840
|
-
| [
|
|
14841
|
-
| [
|
|
14842
|
-
| [
|
|
14843
|
-
| [maxChangeOutputsPerTransaction](#variable-maxchangeoutputspertransaction) | [transformVerifiableCertificatesWithTrust](#variable-transformverifiablecertificateswithtrust) |
|
|
14844
|
-
| [maxPossibleSatoshis](#variable-maxpossiblesatoshis) | [validBulkHeaderFiles](#variable-validbulkheaderfiles) |
|
|
14845
|
-
| [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) | |
|
|
14869
|
+
| | | |
|
|
14870
|
+
| --- | --- | --- |
|
|
14871
|
+
| [ARCADE_POST_BEEF_CONCURRENCY](#variable-arcade_post_beef_concurrency) | [logger](#variable-logger) | [specOpNoSendActions](#variable-specopnosendactions) |
|
|
14872
|
+
| [DEFAULT_SETTINGS](#variable-default_settings) | [managedChangeOutputFields](#variable-managedchangeoutputfields) | [specOpSetWalletChangeParams](#variable-specopsetwalletchangeparams) |
|
|
14873
|
+
| [MAX_STORAGE_COMMISSION_SATOSHIS](#variable-max_storage_commission_satoshis) | [maxChangeOutputsPerTransaction](#variable-maxchangeoutputspertransaction) | [specOpThrowReviewActions](#variable-specopthrowreviewactions) |
|
|
14874
|
+
| [ProvenTxReqNonTerminalStatus](#variable-proventxreqnonterminalstatus) | [maxPossibleSatoshis](#variable-maxpossiblesatoshis) | [specOpWalletBalance](#variable-specopwalletbalance) |
|
|
14875
|
+
| [ProvenTxReqTerminalStatus](#variable-proventxreqterminalstatus) | [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) | [specOpWalletManagedUtxos](#variable-specopwalletmanagedutxos) |
|
|
14876
|
+
| [TESTNET_DEFAULT_SETTINGS](#variable-testnet_default_settings) | [parseResults](#variable-parseresults) | [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
|
|
14877
|
+
| [aggregateActionResults](#variable-aggregateactionresults) | [queryOverlay](#variable-queryoverlay) | [transformVerifiableCertificatesWithTrust](#variable-transformverifiablecertificateswithtrust) |
|
|
14878
|
+
| [brc29ProtocolID](#variable-brc29protocolid) | [specOpFailedActions](#variable-specopfailedactions) | [validBulkHeaderFiles](#variable-validbulkheaderfiles) |
|
|
14879
|
+
| [dirtyHashes](#variable-dirtyhashes) | [specOpInvalidChange](#variable-specopinvalidchange) | |
|
|
14846
14880
|
|
|
14847
14881
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14848
14882
|
|
|
14849
14883
|
---
|
|
14850
14884
|
|
|
14885
|
+
##### Variable: ARCADE_POST_BEEF_CONCURRENCY
|
|
14886
|
+
|
|
14887
|
+
```ts
|
|
14888
|
+
ARCADE_POST_BEEF_CONCURRENCY = 4
|
|
14889
|
+
```
|
|
14890
|
+
|
|
14891
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14892
|
+
|
|
14893
|
+
---
|
|
14851
14894
|
##### Variable: DEFAULT_SETTINGS
|
|
14852
14895
|
|
|
14853
14896
|
```ts
|
|
@@ -15026,6 +15069,20 @@ logger = (message: string, ...optionalParams: any[]): void => {
|
|
|
15026
15069
|
|
|
15027
15070
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15028
15071
|
|
|
15072
|
+
---
|
|
15073
|
+
##### Variable: managedChangeOutputFields
|
|
15074
|
+
|
|
15075
|
+
```ts
|
|
15076
|
+
managedChangeOutputFields = {
|
|
15077
|
+
type: "P2PKH",
|
|
15078
|
+
change: true,
|
|
15079
|
+
providedBy: "storage",
|
|
15080
|
+
purpose: "change"
|
|
15081
|
+
} as const
|
|
15082
|
+
```
|
|
15083
|
+
|
|
15084
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15085
|
+
|
|
15029
15086
|
---
|
|
15030
15087
|
##### Variable: maxChangeOutputsPerTransaction
|
|
15031
15088
|
|
|
@@ -15171,6 +15228,15 @@ specOpWalletBalance = "893b7646de0e1c9f741bd6e9169b76a8847ae34adef7bef1e6a285371
|
|
|
15171
15228
|
|
|
15172
15229
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15173
15230
|
|
|
15231
|
+
---
|
|
15232
|
+
##### Variable: specOpWalletManagedUtxos
|
|
15233
|
+
|
|
15234
|
+
```ts
|
|
15235
|
+
specOpWalletManagedUtxos = "284570a6213a74ba861c38b1cf790e1e400d9cf9324454b76ea98860b6031c1a"
|
|
15236
|
+
```
|
|
15237
|
+
|
|
15238
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15239
|
+
|
|
15174
15240
|
---
|
|
15175
15241
|
##### Variable: transactionColumnsWithoutRawTx
|
|
15176
15242
|
|
package/out/src/Wallet.d.ts
CHANGED
|
@@ -181,6 +181,10 @@ export declare class Wallet implements WalletInterface, ProtoWallet {
|
|
|
181
181
|
* Uses `listOutputs` to iterate over chunks of up to 1000 outputs to
|
|
182
182
|
* compute the sum of output satoshis.
|
|
183
183
|
*
|
|
184
|
+
* For `default`, only wallet-managed BRC-29 change is included. Raw
|
|
185
|
+
* administrative `listOutputs({ basket: 'default' })` remains available to
|
|
186
|
+
* discover legacy incompatible rows for recovery.
|
|
187
|
+
*
|
|
184
188
|
* @param {string} basket - Optional. Defaults to 'default', the wallet change basket.
|
|
185
189
|
* @returns {WalletBalance} total sum of output satoshis and utxo details (satoshis and outpoints)
|
|
186
190
|
*/
|
package/out/src/Wallet.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Wallet.d.ts","sourceRoot":"","sources":["../../src/Wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,mBAAmB,EACnB,IAAI,EACJ,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EACb,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,uCAAuC,EACvC,WAAW,EACX,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACT,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,EACpB,sBAAsB,EACtB,gCAAgC,EAChC,kCAAkC,EAClC,4BAA4B,EAC5B,8BAA8B,EAC9B,cAAc,EACd,gBAAgB,EAChB,WAAW,IAAI,cAAc,EAC7B,SAAS,EAET,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EAMf,cAAc,EACd,UAAU,EACV,IAAI,EACJ,aAAa,EACb,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EACjB,MAAM,UAAU,CAAA;AAMjB,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAG/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,EACL,KAAK,EACL,OAAO,
|
|
1
|
+
{"version":3,"file":"Wallet.d.ts","sourceRoot":"","sources":["../../src/Wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,mBAAmB,EACnB,IAAI,EACJ,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EACb,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,uCAAuC,EACvC,WAAW,EACX,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACT,yBAAyB,EACzB,2BAA2B,EAC3B,oBAAoB,EACpB,sBAAsB,EACtB,gCAAgC,EAChC,kCAAkC,EAClC,4BAA4B,EAC5B,8BAA8B,EAC9B,cAAc,EACd,gBAAgB,EAChB,WAAW,IAAI,cAAc,EAC7B,SAAS,EAET,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EAMf,cAAc,EACd,UAAU,EACV,IAAI,EACJ,aAAa,EACb,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EACjB,MAAM,UAAU,CAAA;AAMjB,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAG/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,EACL,KAAK,EACL,OAAO,EAQP,eAAe,EACf,aAAa,EACd,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,EAAU,yBAAyB,EAAkC,MAAM,gCAAgC,CAAA;AAKlH;;GAEG;AACH;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,kFAAkF;IAClF,iBAAiB,EAAE,CAAC,WAAW,EAAE,SAAS,KAAK,OAAO,CAAC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC,CAAA;IACxF,wGAAwG;IACxG,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;CAC/F;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,SAAS,CAAA;IACtB,0FAA0F;IAC1F,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kFAAkF;IAClF,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,2GAA2G;IAC3G,aAAa,CAAC,EAAE;QACd,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAiCD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,aAAa,CAAA;IACzB,OAAO,EAAE,oBAAoB,CAAA;IAC7B,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAMD,qBAAa,MAAO,YAAW,eAAe,EAAE,WAAW;IACzD,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,aAAa,CAAA;IACzB,OAAO,EAAE,oBAAoB,CAAA;IAC7B,eAAe,EAAE,qBAAqB,CAAA;IACtC,cAAc,EAAE,cAAc,CAAA;IAE9B,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,aAAa,CAAA;IAE7B,WAAW,EAAE,MAAM,CAAA;IAEnB;;;;;;;;;OASG;IACH,IAAI,EAAE,SAAS,CAAA;IACf;;;;OAIG;IACH,4BAA4B,EAAE,OAAO,CAAO;IAC5C;;OAEG;IACH,cAAc,EAAE,OAAO,CAAQ;IAC/B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAQ;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,WAAW,CAAA;IAClB,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAE7B,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAErD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAY;gBAG/B,YAAY,EAAE,UAAU,GAAG,YAAY,EACvC,QAAQ,CAAC,EAAE,cAAc,EACzB,OAAO,CAAC,EAAE,OAAO,EACjB,oBAAoB,CAAC,EAAE,oBAAoB,EAC3C,UAAU,CAAC,EAAE,gBAAgB;IAkDzB,OAAO,IAAK,OAAO,CAAC,IAAI,CAAC;IAK/B,sBAAsB,IAAK,OAAO;IAQ5B,cAAc,IAAK,OAAO,CAAC,SAAS,CAAC;IAIrC,YAAY,CAChB,IAAI,EAAE,gBAAgB,EACtB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,kBAAkB,CAAC;IAUxB,4BAA4B,CAChC,IAAI,EAAE,gCAAgC,EACtC,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,kCAAkC,CAAC;IAUxC,wBAAwB,CAC5B,IAAI,EAAE,4BAA4B,EAClC,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,8BAA8B,CAAC;IAUpC,OAAO,CAAE,IAAI,EAAE,iBAAiB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAUrH,OAAO,CAAE,IAAI,EAAE,iBAAiB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAUrH,UAAU,CAAE,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAUlH,UAAU,CAAE,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAUlH,eAAe,CACnB,IAAI,EAAE,mBAAmB,EACzB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,qBAAqB,CAAC;IAU3B,eAAe,CACnB,IAAI,EAAE,mBAAmB,EACzB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,qBAAqB,CAAC;IAUjC,WAAW,IAAK,cAAc;IAK9B;;;;OAIG;IACH,aAAa,CAAE,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IASlD,kBAAkB,IAAK,eAAe;IAQtC,OAAO,CAAC,mBAAmB;IAcrB,WAAW,CACf,IAAI,EAAE,eAAe,EACrB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,iBAAiB,CAAC;IAe7B,IAAI,YAAY,IAAK,MAAM,CAE1B;IAEK,WAAW,CACf,IAAI,EAAE,eAAe,EACrB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,iBAAiB,CAAC;IAcvB,gBAAgB,CACpB,IAAI,EAAE,oBAAoB,EAC1B,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,sBAAsB,CAAC;IAW5B,kBAAkB,CACtB,IAAI,EAAE,sBAAsB,EAC5B,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,wBAAwB,CAAC;IAgK9B,qBAAqB,CACzB,IAAI,EAAE,yBAAyB,EAC/B,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,2BAA2B,CAAC;IAOjC,gBAAgB,CACpB,IAAI,EAAE,oBAAoB,EAC1B,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,sBAAsB,CAAC;IAOlC,qEAAqE;IACrE,OAAO,CAAC,mBAAmB,CAAC,CAG3B;IAED,yEAAyE;IACzE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgE;IAExF,qBAAqB,CACzB,IAAI,EAAE,yBAAyB,GAAG;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,EAC5D,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,0BAA0B,CAAC;IAuDhC,oBAAoB,CACxB,IAAI,EAAE,wBAAwB,GAAG;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,EAC3D,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,0BAA0B,CAAC;IA+DtC,sBAAsB,CAAE,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAgBhE,gCAAgC,CAAE,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU;IAOtF,0BAA0B,CAAE,IAAI,EAAE,IAAI,GAAG,IAAI;IAM7C,aAAa,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,qBAAqB,GAAG,SAAS;IAM5E,cAAc,CAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAIrE,SAAS,CAAE,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAMxD,cAAc,CAAE,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAU5D,YAAY,CAChB,IAAI,EAAE,gBAAgB,EACtB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,kBAAkB,CAAC;IAyCxB,UAAU,CACd,IAAI,EAAE,cAAc,EACpB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,gBAAgB,CAAC;IAgBtB,iBAAiB,CACrB,IAAI,EAAE,qBAAqB,EAC3B,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,uBAAuB,CAAC;IAa7B,WAAW,CACf,IAAI,EAAE,eAAe,EACrB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,iBAAiB,CAAC;IAQvB,gBAAgB,CACpB,IAAI,EAAE,oBAAoB,EAC1B,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,sBAAsB,CAAC;IAO5B,eAAe,CAAE,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQ9G,qBAAqB,CACzB,IAAI,EAAE,EAAE,EACR,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,mBAAmB,CAAC;IAKzB,SAAS,CAAE,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,eAAe,CAAC;IAMpG,kBAAkB,CACtB,IAAI,EAAE,aAAa,EACnB,UAAU,CAAC,EAAE,uCAAuC,GACnD,OAAO,CAAC,eAAe,CAAC;IAMrB,UAAU,CAAE,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKtG,UAAU,CAAE,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK5G;;;;OAIG;IACG,OAAO,CAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuD/C;;;;;;;;;;OAUG;IACG,eAAe,CAAE,MAAM,GAAE,MAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAoB1E;;;;;OAKG;IACG,OAAO,CAAE,IAAI,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IASvD;;;;;;;;;;OAUG;IACG,sBAAsB,CAC1B,GAAG,UAAQ,EACX,OAAO,UAAQ,EACf,YAAY,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GACtC,OAAO,CAAC,iBAAiB,CAAC;IAY7B;;;;;;OAMG;IACG,qBAAqB,CAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5E;;;;;OAKG;IACG,iBAAiB,CAAE,IAAI,EAAE,eAAe,EAAE,KAAK,UAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ1F;;;;;OAKG;IACG,iBAAiB,CAAE,IAAI,EAAE,eAAe,EAAE,MAAM,UAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAO5F;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAA;IACX,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,yBAAyB,CAAA;IAC9B,IAAI,EAAE,UAAU,CAAC,qBAAqB,CAAA;IACtC,EAAE,EAAE,cAAc,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,mBAAmB,EAAE,CAAA;CAC3B;AA6BD;;GAEG;AACH,wBAAgB,uBAAuB,SA4BtC"}
|
package/out/src/Wallet.js
CHANGED
|
@@ -738,15 +738,20 @@ class Wallet {
|
|
|
738
738
|
* Uses `listOutputs` to iterate over chunks of up to 1000 outputs to
|
|
739
739
|
* compute the sum of output satoshis.
|
|
740
740
|
*
|
|
741
|
+
* For `default`, only wallet-managed BRC-29 change is included. Raw
|
|
742
|
+
* administrative `listOutputs({ basket: 'default' })` remains available to
|
|
743
|
+
* discover legacy incompatible rows for recovery.
|
|
744
|
+
*
|
|
741
745
|
* @param {string} basket - Optional. Defaults to 'default', the wallet change basket.
|
|
742
746
|
* @returns {WalletBalance} total sum of output satoshis and utxo details (satoshis and outpoints)
|
|
743
747
|
*/
|
|
744
748
|
async balanceAndUtxos(basket = 'default') {
|
|
745
749
|
const r = { total: 0, utxos: [] };
|
|
750
|
+
const listBasket = basket === 'default' ? types_1.specOpWalletManagedUtxos : basket;
|
|
746
751
|
let offset = 0;
|
|
747
752
|
for (;;) {
|
|
748
753
|
const change = await this.listOutputs({
|
|
749
|
-
basket,
|
|
754
|
+
basket: listBasket,
|
|
750
755
|
limit: 1000,
|
|
751
756
|
offset
|
|
752
757
|
});
|