@bsv/wallet-toolbox 1.1.7 → 1.1.9
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/docs/client.md +3872 -1555
- package/docs/monitor.md +29 -27
- package/docs/services.md +22 -22
- package/docs/setup.md +23 -23
- package/docs/storage.md +2747 -438
- package/docs/wallet.md +3872 -1555
- package/out/src/monitor/tasks/TaskCheckForProofs.d.ts +4 -4
- package/out/src/monitor/tasks/TaskCheckForProofs.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskCheckForProofs.js +2 -2
- package/out/src/monitor/tasks/TaskCheckForProofs.js.map +1 -1
- package/out/src/monitor/tasks/TaskSendWaiting.d.ts +2 -2
- package/out/src/monitor/tasks/TaskSendWaiting.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskSendWaiting.js +2 -2
- package/out/src/monitor/tasks/TaskSendWaiting.js.map +1 -1
- package/out/src/sdk/StorageSyncReader.d.ts +30 -30
- package/out/src/sdk/StorageSyncReader.d.ts.map +1 -1
- package/out/src/sdk/StorageSyncReaderWriter.d.ts +60 -60
- package/out/src/sdk/StorageSyncReaderWriter.d.ts.map +1 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts +36 -36
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- package/out/src/signer/methods/acquireDirectCertificate.d.ts.map +1 -1
- package/out/src/signer/methods/acquireDirectCertificate.js.map +1 -1
- package/out/src/storage/StorageKnex.d.ts +61 -61
- package/out/src/storage/StorageKnex.d.ts.map +1 -1
- package/out/src/storage/StorageKnex.js +13 -4
- package/out/src/storage/StorageKnex.js.map +1 -1
- package/out/src/storage/StorageProvider.d.ts +16 -15
- package/out/src/storage/StorageProvider.d.ts.map +1 -1
- package/out/src/storage/StorageProvider.js +8 -8
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/src/storage/StorageReader.d.ts +21 -21
- package/out/src/storage/StorageReader.d.ts.map +1 -1
- package/out/src/storage/StorageReader.js.map +1 -1
- package/out/src/storage/StorageReaderWriter.d.ts +60 -60
- package/out/src/storage/StorageReaderWriter.d.ts.map +1 -1
- package/out/src/storage/StorageReaderWriter.js.map +1 -1
- package/out/src/storage/StorageSyncReader.d.ts +17 -17
- package/out/src/storage/StorageSyncReader.d.ts.map +1 -1
- package/out/src/storage/StorageSyncReader.js.map +1 -1
- package/out/src/storage/WalletStorageManager.d.ts +9 -9
- package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
- package/out/src/storage/WalletStorageManager.js +2 -2
- package/out/src/storage/WalletStorageManager.js.map +1 -1
- package/out/src/storage/index.all.d.ts +2 -2
- package/out/src/storage/index.all.d.ts.map +1 -1
- package/out/src/storage/index.all.js +3 -3
- package/out/src/storage/index.all.js.map +1 -1
- package/out/src/storage/index.client.d.ts +2 -2
- package/out/src/storage/index.client.d.ts.map +1 -1
- package/out/src/storage/index.client.js +2 -25
- package/out/src/storage/index.client.js.map +1 -1
- package/out/src/storage/methods/attemptToPostReqsToNetwork.d.ts +3 -3
- package/out/src/storage/methods/attemptToPostReqsToNetwork.d.ts.map +1 -1
- package/out/src/storage/methods/attemptToPostReqsToNetwork.js.map +1 -1
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +1 -1
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/getBeefForTransaction.js +2 -2
- package/out/src/storage/methods/getBeefForTransaction.js.map +1 -1
- package/out/src/storage/methods/getSyncChunk.d.ts.map +1 -1
- package/out/src/storage/methods/getSyncChunk.js.map +1 -1
- package/out/src/storage/methods/internalizeAction.d.ts.map +1 -1
- package/out/src/storage/methods/internalizeAction.js +1 -1
- package/out/src/storage/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/methods/listActions.js.map +1 -1
- package/out/src/storage/methods/listCertificates.d.ts.map +1 -1
- package/out/src/storage/methods/listCertificates.js.map +1 -1
- package/out/src/storage/methods/listOutputs.js.map +1 -1
- package/out/src/storage/methods/processAction.d.ts +4 -4
- package/out/src/storage/methods/processAction.d.ts.map +1 -1
- package/out/src/storage/methods/processAction.js +2 -2
- package/out/src/storage/methods/processAction.js.map +1 -1
- package/out/src/storage/methods/purgeData.d.ts.map +1 -1
- package/out/src/storage/methods/purgeData.js.map +1 -1
- package/out/src/storage/methods/reviewStatus.js.map +1 -1
- package/out/src/storage/remoting/StorageClient.d.ts +230 -15
- package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClient.js +222 -7
- package/out/src/storage/remoting/StorageClient.js.map +1 -1
- package/out/src/storage/schema/entities/Certificate.d.ts +9 -9
- package/out/src/storage/schema/entities/Certificate.d.ts.map +1 -1
- package/out/src/storage/schema/entities/Certificate.js +5 -5
- package/out/src/storage/schema/entities/Certificate.js.map +1 -1
- package/out/src/storage/schema/entities/CertificateField.d.ts +9 -9
- package/out/src/storage/schema/entities/CertificateField.d.ts.map +1 -1
- package/out/src/storage/schema/entities/CertificateField.js +5 -5
- package/out/src/storage/schema/entities/CertificateField.js.map +1 -1
- package/out/src/storage/schema/entities/Commission.d.ts +9 -9
- package/out/src/storage/schema/entities/Commission.d.ts.map +1 -1
- package/out/src/storage/schema/entities/Commission.js +5 -5
- package/out/src/storage/schema/entities/Commission.js.map +1 -1
- package/out/src/storage/schema/entities/EntityBase.d.ts +1 -1
- package/out/src/storage/schema/entities/MergeEntity.d.ts +6 -7
- package/out/src/storage/schema/entities/MergeEntity.d.ts.map +1 -1
- package/out/src/storage/schema/entities/MergeEntity.js.map +1 -1
- package/out/src/storage/schema/entities/Output.d.ts +9 -9
- package/out/src/storage/schema/entities/Output.d.ts.map +1 -1
- package/out/src/storage/schema/entities/Output.js +5 -5
- package/out/src/storage/schema/entities/Output.js.map +1 -1
- package/out/src/storage/schema/entities/OutputBasket.d.ts +9 -9
- package/out/src/storage/schema/entities/OutputBasket.d.ts.map +1 -1
- package/out/src/storage/schema/entities/OutputBasket.js +5 -5
- package/out/src/storage/schema/entities/OutputBasket.js.map +1 -1
- package/out/src/storage/schema/entities/OutputTag.d.ts +9 -9
- package/out/src/storage/schema/entities/OutputTag.d.ts.map +1 -1
- package/out/src/storage/schema/entities/OutputTag.js +5 -5
- package/out/src/storage/schema/entities/OutputTag.js.map +1 -1
- package/out/src/storage/schema/entities/OutputTagMap.d.ts +9 -9
- package/out/src/storage/schema/entities/OutputTagMap.d.ts.map +1 -1
- package/out/src/storage/schema/entities/OutputTagMap.js +5 -5
- package/out/src/storage/schema/entities/OutputTagMap.js.map +1 -1
- package/out/src/storage/schema/entities/ProvenTx.d.ts +11 -11
- package/out/src/storage/schema/entities/ProvenTx.d.ts.map +1 -1
- package/out/src/storage/schema/entities/ProvenTx.js +11 -11
- package/out/src/storage/schema/entities/ProvenTx.js.map +1 -1
- package/out/src/storage/schema/entities/ProvenTxReq.d.ts +19 -19
- package/out/src/storage/schema/entities/ProvenTxReq.d.ts.map +1 -1
- package/out/src/storage/schema/entities/ProvenTxReq.js +13 -13
- package/out/src/storage/schema/entities/ProvenTxReq.js.map +1 -1
- package/out/src/storage/schema/entities/SyncState.d.ts +11 -11
- package/out/src/storage/schema/entities/SyncState.d.ts.map +1 -1
- package/out/src/storage/schema/entities/SyncState.js +27 -27
- package/out/src/storage/schema/entities/SyncState.js.map +1 -1
- package/out/src/storage/schema/entities/Transaction.d.ts +11 -11
- package/out/src/storage/schema/entities/Transaction.d.ts.map +1 -1
- package/out/src/storage/schema/entities/Transaction.js +6 -6
- package/out/src/storage/schema/entities/Transaction.js.map +1 -1
- package/out/src/storage/schema/entities/TxLabel.d.ts +9 -9
- package/out/src/storage/schema/entities/TxLabel.d.ts.map +1 -1
- package/out/src/storage/schema/entities/TxLabel.js +5 -5
- package/out/src/storage/schema/entities/TxLabel.js.map +1 -1
- package/out/src/storage/schema/entities/TxLabelMap.d.ts +9 -9
- package/out/src/storage/schema/entities/TxLabelMap.d.ts.map +1 -1
- package/out/src/storage/schema/entities/TxLabelMap.js +5 -5
- package/out/src/storage/schema/entities/TxLabelMap.js.map +1 -1
- package/out/src/storage/schema/entities/User.d.ts +9 -9
- package/out/src/storage/schema/entities/User.d.ts.map +1 -1
- package/out/src/storage/schema/entities/User.js +5 -5
- package/out/src/storage/schema/entities/User.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/CertificateFieldTests.test.js +20 -307
- package/out/src/storage/schema/entities/__tests/CertificateFieldTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/CertificateTests.test.js +17 -158
- package/out/src/storage/schema/entities/__tests/CertificateTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/CommissionTests.test.js +23 -309
- package/out/src/storage/schema/entities/__tests/CommissionTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/OutputBasketTests.test.js +19 -306
- package/out/src/storage/schema/entities/__tests/OutputBasketTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/OutputTagMapTests.test.js +19 -306
- package/out/src/storage/schema/entities/__tests/OutputTagMapTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/OutputTagTests.test.js +23 -237
- package/out/src/storage/schema/entities/__tests/OutputTagTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/OutputTests.test.js +20 -233
- package/out/src/storage/schema/entities/__tests/OutputTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/ProvenTxReqTests.test.js +27 -98
- package/out/src/storage/schema/entities/__tests/ProvenTxReqTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/ProvenTxTests.test.js +25 -241
- package/out/src/storage/schema/entities/__tests/ProvenTxTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/SyncStateTests.test.js +38 -112
- package/out/src/storage/schema/entities/__tests/SyncStateTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/TransactionTests.test.js +39 -323
- package/out/src/storage/schema/entities/__tests/TransactionTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/TxLabelMapTests.test.js +31 -169
- package/out/src/storage/schema/entities/__tests/TxLabelMapTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/TxLabelTests.test.js +16 -159
- package/out/src/storage/schema/entities/__tests/TxLabelTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/usersTests.test.js +21 -168
- package/out/src/storage/schema/entities/__tests/usersTests.test.js.map +1 -1
- package/out/src/storage/schema/tables/Certificate.d.ts +4 -4
- package/out/src/storage/schema/tables/Certificate.d.ts.map +1 -1
- package/out/src/storage/schema/tables/CertificateField.d.ts +1 -1
- package/out/src/storage/schema/tables/CertificateField.d.ts.map +1 -1
- package/out/src/storage/schema/tables/Commission.d.ts +1 -1
- package/out/src/storage/schema/tables/Commission.d.ts.map +1 -1
- package/out/src/storage/schema/tables/MonitorEvent.d.ts +1 -1
- package/out/src/storage/schema/tables/MonitorEvent.d.ts.map +1 -1
- package/out/src/storage/schema/tables/Output.d.ts +5 -5
- package/out/src/storage/schema/tables/Output.d.ts.map +1 -1
- package/out/src/storage/schema/tables/OutputBasket.d.ts +1 -1
- package/out/src/storage/schema/tables/OutputBasket.d.ts.map +1 -1
- package/out/src/storage/schema/tables/OutputTag.d.ts +1 -1
- package/out/src/storage/schema/tables/OutputTag.d.ts.map +1 -1
- package/out/src/storage/schema/tables/OutputTagMap.d.ts +1 -1
- package/out/src/storage/schema/tables/OutputTagMap.d.ts.map +1 -1
- package/out/src/storage/schema/tables/ProvenTx.d.ts +1 -1
- package/out/src/storage/schema/tables/ProvenTx.d.ts.map +1 -1
- package/out/src/storage/schema/tables/ProvenTxReq.d.ts +2 -2
- package/out/src/storage/schema/tables/ProvenTxReq.d.ts.map +1 -1
- package/out/src/storage/schema/tables/SyncState.d.ts +1 -1
- package/out/src/storage/schema/tables/SyncState.d.ts.map +1 -1
- package/out/src/storage/schema/tables/{Settings.d.ts → TableSettings.d.ts} +2 -2
- package/out/src/storage/schema/tables/TableSettings.d.ts.map +1 -0
- package/out/src/storage/schema/tables/{Settings.js → TableSettings.js} +1 -1
- package/out/src/storage/schema/tables/TableSettings.js.map +1 -0
- package/out/src/storage/schema/tables/Transaction.d.ts +1 -1
- package/out/src/storage/schema/tables/Transaction.d.ts.map +1 -1
- package/out/src/storage/schema/tables/TxLabel.d.ts +1 -1
- package/out/src/storage/schema/tables/TxLabel.d.ts.map +1 -1
- package/out/src/storage/schema/tables/TxLabelMap.d.ts +1 -1
- package/out/src/storage/schema/tables/TxLabelMap.d.ts.map +1 -1
- package/out/src/storage/schema/tables/User.d.ts +1 -1
- package/out/src/storage/schema/tables/User.d.ts.map +1 -1
- package/out/src/storage/schema/tables/index.d.ts +1 -1
- package/out/src/storage/schema/tables/index.d.ts.map +1 -1
- package/out/src/storage/schema/tables/index.js +1 -1
- package/out/src/storage/schema/tables/index.js.map +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.d.ts +17 -17
- package/out/src/storage/sync/StorageMySQLDojoReader.d.ts.map +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.js +2 -2
- package/out/src/storage/sync/StorageMySQLDojoReader.js.map +1 -1
- package/out/test/Wallet/certificate/listCertificates.test.js.map +1 -1
- package/out/test/Wallet/live/walletLive.man.test.js +1 -1
- package/out/test/Wallet/live/walletLive.man.test.js.map +1 -1
- package/out/test/monitor/Monitor.test.js +7 -7
- package/out/test/monitor/Monitor.test.js.map +1 -1
- package/out/test/storage/StorageMySQLDojoReader.man.test.js +1 -1
- package/out/test/storage/StorageMySQLDojoReader.man.test.js.map +1 -1
- package/out/test/storage/insert.test.js.map +1 -1
- package/out/test/storage/update.test.js.map +1 -1
- package/out/test/storage/update2.test.js.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.d.ts +56 -56
- package/out/test/utils/TestUtilsWalletStorage.d.ts.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.js +11 -4
- package/out/test/utils/TestUtilsWalletStorage.js.map +1 -1
- package/out/test/wallet/action/createActionToGenerateBeefs.man.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/monitor/tasks/TaskCheckForProofs.ts +11 -10
- package/src/monitor/tasks/TaskSendWaiting.ts +5 -5
- package/src/sdk/StorageSyncReader.ts +48 -30
- package/src/sdk/StorageSyncReaderWriter.ts +77 -63
- package/src/sdk/WalletStorage.interfaces.ts +55 -36
- package/src/signer/methods/acquireDirectCertificate.ts +2 -2
- package/src/storage/StorageKnex.ts +137 -106
- package/src/storage/StorageProvider.ts +43 -30
- package/src/storage/StorageReader.ts +37 -21
- package/src/storage/StorageReaderWriter.ts +78 -65
- package/src/storage/StorageSyncReader.ts +35 -17
- package/src/storage/WalletStorageManager.ts +18 -12
- package/src/storage/index.all.ts +2 -2
- package/src/storage/index.client.ts +2 -2
- package/src/storage/methods/attemptToPostReqsToNetwork.ts +3 -3
- package/src/storage/methods/createAction.ts +29 -26
- package/src/storage/methods/getBeefForTransaction.ts +3 -3
- package/src/storage/methods/getSyncChunk.ts +28 -13
- package/src/storage/methods/internalizeAction.ts +19 -17
- package/src/storage/methods/listActions.ts +5 -5
- package/src/storage/methods/listCertificates.ts +2 -2
- package/src/storage/methods/listOutputs.ts +5 -5
- package/src/storage/methods/processAction.ts +21 -17
- package/src/storage/methods/purgeData.ts +17 -11
- package/src/storage/methods/reviewStatus.ts +4 -4
- package/src/storage/remoting/StorageClient.ts +250 -26
- package/src/storage/schema/entities/Certificate.ts +16 -17
- package/src/storage/schema/entities/CertificateField.ts +17 -18
- package/src/storage/schema/entities/Commission.ts +16 -20
- package/src/storage/schema/entities/EntityBase.ts +1 -1
- package/src/storage/schema/entities/MergeEntity.ts +7 -7
- package/src/storage/schema/entities/Output.ts +16 -20
- package/src/storage/schema/entities/OutputBasket.ts +16 -17
- package/src/storage/schema/entities/OutputTag.ts +16 -20
- package/src/storage/schema/entities/OutputTagMap.ts +17 -18
- package/src/storage/schema/entities/ProvenTx.ts +24 -28
- package/src/storage/schema/entities/ProvenTxReq.ts +42 -45
- package/src/storage/schema/entities/SyncState.ts +61 -38
- package/src/storage/schema/entities/Transaction.ts +23 -23
- package/src/storage/schema/entities/TxLabel.ts +16 -17
- package/src/storage/schema/entities/TxLabelMap.ts +16 -20
- package/src/storage/schema/entities/User.ts +15 -19
- package/src/storage/schema/entities/__tests/CertificateFieldTests.test.ts +39 -318
- package/src/storage/schema/entities/__tests/CertificateTests.test.ts +29 -169
- package/src/storage/schema/entities/__tests/CommissionTests.test.ts +47 -325
- package/src/storage/schema/entities/__tests/OutputBasketTests.test.ts +35 -316
- package/src/storage/schema/entities/__tests/OutputTagMapTests.test.ts +38 -318
- package/src/storage/schema/entities/__tests/OutputTagTests.test.ts +36 -249
- package/src/storage/schema/entities/__tests/OutputTests.test.ts +30 -244
- package/src/storage/schema/entities/__tests/ProvenTxReqTests.test.ts +35 -101
- package/src/storage/schema/entities/__tests/ProvenTxTests.test.ts +27 -243
- package/src/storage/schema/entities/__tests/SyncStateTests.test.ts +54 -122
- package/src/storage/schema/entities/__tests/TransactionTests.test.ts +53 -333
- package/src/storage/schema/entities/__tests/TxLabelMapTests.test.ts +44 -177
- package/src/storage/schema/entities/__tests/TxLabelTests.test.ts +19 -163
- package/src/storage/schema/entities/__tests/usersTests.test.ts +31 -179
- package/src/storage/schema/tables/Certificate.ts +4 -4
- package/src/storage/schema/tables/CertificateField.ts +1 -1
- package/src/storage/schema/tables/Commission.ts +1 -1
- package/src/storage/schema/tables/MonitorEvent.ts +1 -1
- package/src/storage/schema/tables/Output.ts +5 -5
- package/src/storage/schema/tables/OutputBasket.ts +1 -1
- package/src/storage/schema/tables/OutputTag.ts +1 -1
- package/src/storage/schema/tables/OutputTagMap.ts +1 -1
- package/src/storage/schema/tables/ProvenTx.ts +1 -1
- package/src/storage/schema/tables/ProvenTxReq.ts +2 -2
- package/src/storage/schema/tables/SyncState.ts +1 -1
- package/src/storage/schema/tables/{Settings.ts → TableSettings.ts} +3 -1
- package/src/storage/schema/tables/Transaction.ts +1 -1
- package/src/storage/schema/tables/TxLabel.ts +1 -1
- package/src/storage/schema/tables/TxLabelMap.ts +1 -1
- package/src/storage/schema/tables/User.ts +1 -1
- package/src/storage/schema/tables/index.ts +1 -1
- package/src/storage/sync/StorageMySQLDojoReader.ts +68 -50
- package/test/Wallet/certificate/listCertificates.test.ts +12 -8
- package/test/Wallet/live/walletLive.man.test.ts +6 -6
- package/test/monitor/Monitor.test.ts +8 -8
- package/test/storage/StorageMySQLDojoReader.man.test.ts +1 -1
- package/test/storage/insert.test.ts +2 -2
- package/test/storage/update.test.ts +30 -30
- package/test/storage/update2.test.ts +23 -24
- package/test/utils/TestUtilsWalletStorage.ts +103 -82
- package/test/wallet/action/createActionToGenerateBeefs.man.test.ts +1 -2
- package/ts2md.json +1 -1
- package/out/src/storage/index.db.d.ts +0 -1
- package/out/src/storage/index.db.d.ts.map +0 -1
- package/out/src/storage/index.db.js +0 -2
- package/out/src/storage/index.db.js.map +0 -1
- package/out/src/storage/schema/tables/Settings.d.ts.map +0 -1
- package/out/src/storage/schema/tables/Settings.js.map +0 -1
- package/src/storage/index.db.ts +0 -0
package/docs/monitor.md
CHANGED
|
@@ -47,7 +47,7 @@ export interface MonitorDaemonSetup {
|
|
|
47
47
|
}
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [StorageKnexOptions](#interface-storageknexoptions), [StorageProvider](#class-storageprovider), [WalletServicesOptions](#interface-walletservicesoptions), [WalletStorageManager](#class-walletstoragemanager)
|
|
50
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [Services](./services.md#class-services), [StorageKnexOptions](./storage.md#interface-storageknexoptions), [StorageProvider](./storage.md#class-storageprovider), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
51
51
|
|
|
52
52
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
53
53
|
|
|
@@ -68,7 +68,7 @@ export interface MonitorOptions {
|
|
|
68
68
|
}
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
See also: [Chain](#type-chain), [MonitorStorage](#type-monitorstorage), [Services](#class-services)
|
|
71
|
+
See also: [Chain](./client.md#type-chain), [MonitorStorage](./monitor.md#type-monitorstorage), [Services](./services.md#class-services)
|
|
72
72
|
|
|
73
73
|
###### Property msecsWaitPerMerkleProofServiceReq
|
|
74
74
|
|
|
@@ -112,7 +112,7 @@ export interface TaskPurgeParams extends sdk.PurgeParams {
|
|
|
112
112
|
}
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
See also: [PurgeParams](#interface-purgeparams)
|
|
115
|
+
See also: [PurgeParams](./client.md#interface-purgeparams)
|
|
116
116
|
|
|
117
117
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
118
118
|
|
|
@@ -186,7 +186,7 @@ export class Monitor {
|
|
|
186
186
|
}
|
|
187
187
|
```
|
|
188
188
|
|
|
189
|
-
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [MonitorOptions](#interface-monitoroptions), [MonitorStorage](#type-monitorstorage), [Services](#class-services), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
189
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [MonitorOptions](./monitor.md#interface-monitoroptions), [MonitorStorage](./monitor.md#type-monitorstorage), [Services](./services.md#class-services), [TaskPurgeParams](./monitor.md#interface-taskpurgeparams), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
190
190
|
|
|
191
191
|
###### Property _otherTasks
|
|
192
192
|
|
|
@@ -195,7 +195,7 @@ _otherTasks can be run by runTask but not by scheduler.
|
|
|
195
195
|
```ts
|
|
196
196
|
_otherTasks: WalletMonitorTask[] = []
|
|
197
197
|
```
|
|
198
|
-
See also: [WalletMonitorTask](#class-walletmonitortask)
|
|
198
|
+
See also: [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
199
199
|
|
|
200
200
|
###### Property _tasks
|
|
201
201
|
|
|
@@ -204,7 +204,7 @@ _tasks are typically run by the scheduler but may also be run by runTask.
|
|
|
204
204
|
```ts
|
|
205
205
|
_tasks: WalletMonitorTask[] = []
|
|
206
206
|
```
|
|
207
|
-
See also: [WalletMonitorTask](#class-walletmonitortask)
|
|
207
|
+
See also: [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
208
208
|
|
|
209
209
|
###### Method addDefaultTasks
|
|
210
210
|
|
|
@@ -233,7 +233,7 @@ Kicks processing 'unconfirmed' and 'unmined' request processing.
|
|
|
233
233
|
```ts
|
|
234
234
|
processNewBlockHeader(header: BlockHeader): void
|
|
235
235
|
```
|
|
236
|
-
See also: [BlockHeader](#interface-blockheader)
|
|
236
|
+
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
237
237
|
|
|
238
238
|
###### Method processReorg
|
|
239
239
|
|
|
@@ -249,7 +249,7 @@ Coinbase transactions always become invalid.
|
|
|
249
249
|
```ts
|
|
250
250
|
processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader): void
|
|
251
251
|
```
|
|
252
|
-
See also: [BlockHeader](#interface-blockheader)
|
|
252
|
+
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
253
253
|
|
|
254
254
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
255
255
|
|
|
@@ -271,7 +271,7 @@ export class MonitorDaemon {
|
|
|
271
271
|
}
|
|
272
272
|
```
|
|
273
273
|
|
|
274
|
-
See also: [MonitorDaemonSetup](#interface-monitordaemonsetup)
|
|
274
|
+
See also: [MonitorDaemonSetup](./monitor.md#interface-monitordaemonsetup)
|
|
275
275
|
|
|
276
276
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
277
277
|
|
|
@@ -298,15 +298,15 @@ export class TaskCheckForProofs extends WalletMonitorTask {
|
|
|
298
298
|
run: boolean;
|
|
299
299
|
}
|
|
300
300
|
async runTask(): Promise<string>
|
|
301
|
-
async getProofs(reqs:
|
|
302
|
-
proven:
|
|
303
|
-
invalid:
|
|
301
|
+
async getProofs(reqs: TableProvenTxReq[], indent = 0, countsAsAttempt = false, ignoreStatus = false): Promise<{
|
|
302
|
+
proven: TableProvenTxReq[];
|
|
303
|
+
invalid: TableProvenTxReq[];
|
|
304
304
|
log: string;
|
|
305
305
|
}>
|
|
306
306
|
}
|
|
307
307
|
```
|
|
308
308
|
|
|
309
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
309
|
+
See also: [Monitor](./monitor.md#class-monitor), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
310
310
|
|
|
311
311
|
###### Property checkNow
|
|
312
312
|
|
|
@@ -331,12 +331,13 @@ depending on chaintracks succeeding on proof verification.
|
|
|
331
331
|
Increments attempts if proofs where requested.
|
|
332
332
|
|
|
333
333
|
```ts
|
|
334
|
-
async getProofs(reqs:
|
|
335
|
-
proven:
|
|
336
|
-
invalid:
|
|
334
|
+
async getProofs(reqs: TableProvenTxReq[], indent = 0, countsAsAttempt = false, ignoreStatus = false): Promise<{
|
|
335
|
+
proven: TableProvenTxReq[];
|
|
336
|
+
invalid: TableProvenTxReq[];
|
|
337
337
|
log: string;
|
|
338
338
|
}>
|
|
339
339
|
```
|
|
340
|
+
See also: [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
340
341
|
|
|
341
342
|
Returns
|
|
342
343
|
|
|
@@ -370,7 +371,7 @@ export class TaskClock extends WalletMonitorTask {
|
|
|
370
371
|
}
|
|
371
372
|
```
|
|
372
373
|
|
|
373
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
374
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
374
375
|
|
|
375
376
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
376
377
|
|
|
@@ -395,7 +396,7 @@ export class TaskFailAbandoned extends WalletMonitorTask {
|
|
|
395
396
|
}
|
|
396
397
|
```
|
|
397
398
|
|
|
398
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
399
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
399
400
|
|
|
400
401
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
401
402
|
|
|
@@ -415,7 +416,7 @@ export class TaskNewHeader extends WalletMonitorTask {
|
|
|
415
416
|
}
|
|
416
417
|
```
|
|
417
418
|
|
|
418
|
-
See also: [BlockHeader](#interface-blockheader), [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
419
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
419
420
|
|
|
420
421
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
421
422
|
|
|
@@ -434,7 +435,7 @@ export class TaskPurge extends WalletMonitorTask {
|
|
|
434
435
|
}
|
|
435
436
|
```
|
|
436
437
|
|
|
437
|
-
See also: [Monitor](#class-monitor), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
438
|
+
See also: [Monitor](./monitor.md#class-monitor), [TaskPurgeParams](./monitor.md#interface-taskpurgeparams), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
438
439
|
|
|
439
440
|
###### Property checkNow
|
|
440
441
|
|
|
@@ -469,7 +470,7 @@ export class TaskReviewStatus extends WalletMonitorTask {
|
|
|
469
470
|
}
|
|
470
471
|
```
|
|
471
472
|
|
|
472
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
473
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
473
474
|
|
|
474
475
|
###### Property checkNow
|
|
475
476
|
|
|
@@ -492,11 +493,11 @@ export class TaskSendWaiting extends WalletMonitorTask {
|
|
|
492
493
|
run: boolean;
|
|
493
494
|
}
|
|
494
495
|
async runTask(): Promise<string>
|
|
495
|
-
async processUnsent(reqApis:
|
|
496
|
+
async processUnsent(reqApis: TableProvenTxReq[], indent = 0): Promise<string>
|
|
496
497
|
}
|
|
497
498
|
```
|
|
498
499
|
|
|
499
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
500
|
+
See also: [Monitor](./monitor.md#class-monitor), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
500
501
|
|
|
501
502
|
###### Method processUnsent
|
|
502
503
|
|
|
@@ -515,8 +516,9 @@ Add mapi responses to database table if received.
|
|
|
515
516
|
Increments attempts if sending was attempted.
|
|
516
517
|
|
|
517
518
|
```ts
|
|
518
|
-
async processUnsent(reqApis:
|
|
519
|
+
async processUnsent(reqApis: TableProvenTxReq[], indent = 0): Promise<string>
|
|
519
520
|
```
|
|
521
|
+
See also: [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
520
522
|
|
|
521
523
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
522
524
|
|
|
@@ -534,7 +536,7 @@ export class TaskSyncWhenIdle extends WalletMonitorTask {
|
|
|
534
536
|
}
|
|
535
537
|
```
|
|
536
538
|
|
|
537
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
539
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
538
540
|
|
|
539
541
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
540
542
|
|
|
@@ -568,7 +570,7 @@ export abstract class WalletMonitorTask {
|
|
|
568
570
|
}
|
|
569
571
|
```
|
|
570
572
|
|
|
571
|
-
See also: [Monitor](#class-monitor), [MonitorStorage](#type-monitorstorage)
|
|
573
|
+
See also: [Monitor](./monitor.md#class-monitor), [MonitorStorage](./monitor.md#type-monitorstorage)
|
|
572
574
|
|
|
573
575
|
###### Property lastRunMsecsSinceEpoch
|
|
574
576
|
|
|
@@ -611,7 +613,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
611
613
|
export type MonitorStorage = WalletStorageManager
|
|
612
614
|
```
|
|
613
615
|
|
|
614
|
-
See also: [WalletStorageManager](#class-walletstoragemanager)
|
|
616
|
+
See also: [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
615
617
|
|
|
616
618
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
617
619
|
|
package/docs/services.md
CHANGED
|
@@ -204,7 +204,7 @@ export class Services implements sdk.WalletServices {
|
|
|
204
204
|
}
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [FiatExchangeRates](#interface-fiatexchangerates), [GetMerklePathResult](#interface-getmerklepathresult), [GetMerklePathService](#type-getmerklepathservice), [GetRawTxResult](#interface-getrawtxresult), [GetRawTxService](#type-getrawtxservice), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult), [GetUtxoStatusService](#type-getutxostatusservice), [PostBeefResult](#interface-postbeefresult), [PostBeefService](#type-postbeefservice), [PostTxsResult](#interface-posttxsresult), [PostTxsService](#type-posttxsservice), [ServiceCollection](#class-servicecollection), [UpdateFiatExchangeRateService](#type-updatefiatexchangerateservice), [WalletServices](#interface-walletservices), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
207
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [PostTxsResult](./client.md#interface-posttxsresult), [PostTxsService](./client.md#type-posttxsservice), [ServiceCollection](./services.md#class-servicecollection), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
208
208
|
|
|
209
209
|
###### Method postTxs
|
|
210
210
|
|
|
@@ -215,7 +215,7 @@ These will be fetched if missing, greatly extending the service response time.
|
|
|
215
215
|
```ts
|
|
216
216
|
async postTxs(beef: Beef, txids: string[]): Promise<sdk.PostTxsResult[]>
|
|
217
217
|
```
|
|
218
|
-
See also: [PostTxsResult](#interface-posttxsresult)
|
|
218
|
+
See also: [PostTxsResult](./client.md#interface-posttxsresult)
|
|
219
219
|
|
|
220
220
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
221
221
|
|
|
@@ -245,7 +245,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
245
245
|
export function createDefaultWalletServicesOptions(chain: sdk.Chain): sdk.WalletServicesOptions
|
|
246
246
|
```
|
|
247
247
|
|
|
248
|
-
See also: [Chain](#type-chain), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
248
|
+
See also: [Chain](./client.md#type-chain), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
249
249
|
|
|
250
250
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
251
251
|
|
|
@@ -256,7 +256,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
256
256
|
export async function getExchangeRatesIo(key: string): Promise<ExchangeRatesIoApi>
|
|
257
257
|
```
|
|
258
258
|
|
|
259
|
-
See also: [ExchangeRatesIoApi](#interface-exchangeratesioapi)
|
|
259
|
+
See also: [ExchangeRatesIoApi](./services.md#interface-exchangeratesioapi)
|
|
260
260
|
|
|
261
261
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
262
262
|
|
|
@@ -267,7 +267,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
267
267
|
export async function getMerklePathFromTaalARC(txid: string, config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
268
268
|
```
|
|
269
269
|
|
|
270
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathResult](#interface-getmerklepathresult), [WalletServices](#interface-walletservices)
|
|
270
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
271
271
|
|
|
272
272
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
273
273
|
|
|
@@ -284,7 +284,7 @@ Duplicate hash values are provided in full instead of being replaced by "*".
|
|
|
284
284
|
export async function getMerklePathFromWhatsOnChainTsc(txid: string, chain: sdk.Chain, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
285
285
|
```
|
|
286
286
|
|
|
287
|
-
See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathresult), [WalletServices](#interface-walletservices)
|
|
287
|
+
See also: [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
288
288
|
|
|
289
289
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
290
290
|
|
|
@@ -295,7 +295,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
295
295
|
export async function getRawTxFromWhatsOnChain(txid: string, chain: sdk.Chain): Promise<sdk.GetRawTxResult>
|
|
296
296
|
```
|
|
297
297
|
|
|
298
|
-
See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
|
|
298
|
+
See also: [Chain](./client.md#type-chain), [GetRawTxResult](./client.md#interface-getrawtxresult)
|
|
299
299
|
|
|
300
300
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
301
301
|
|
|
@@ -306,7 +306,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
306
306
|
export function getTaalArcServiceConfig(chain: sdk.Chain, apiKey: string): ArcServiceConfig
|
|
307
307
|
```
|
|
308
308
|
|
|
309
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [Chain](#type-chain)
|
|
309
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [Chain](./client.md#type-chain)
|
|
310
310
|
|
|
311
311
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
312
312
|
|
|
@@ -317,7 +317,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
317
317
|
export async function getUtxoStatusFromWhatsOnChain(output: string, chain: sdk.Chain, outputFormat?: sdk.GetUtxoStatusOutputFormat): Promise<sdk.GetUtxoStatusResult>
|
|
318
318
|
```
|
|
319
319
|
|
|
320
|
-
See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult)
|
|
320
|
+
See also: [Chain](./client.md#type-chain), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
321
321
|
|
|
322
322
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
323
323
|
|
|
@@ -328,7 +328,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
328
328
|
export function makeErrorResult(error: sdk.WalletError, miner: ArcServiceConfig, beef: number[], txids: string[], dd?: ArcMinerPostBeefDataApi): sdk.PostBeefResult
|
|
329
329
|
```
|
|
330
330
|
|
|
331
|
-
See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult), [WalletError](#class-walleterror)
|
|
331
|
+
See also: [ArcMinerPostBeefDataApi](./services.md#interface-arcminerpostbeefdataapi), [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult), [WalletError](./client.md#class-walleterror)
|
|
332
332
|
|
|
333
333
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
334
334
|
|
|
@@ -339,7 +339,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
339
339
|
export function makeGetMerklePathFromTaalARC(config: ArcServiceConfig): sdk.GetMerklePathService
|
|
340
340
|
```
|
|
341
341
|
|
|
342
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathService](#type-getmerklepathservice)
|
|
342
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [GetMerklePathService](./client.md#type-getmerklepathservice)
|
|
343
343
|
|
|
344
344
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
345
345
|
|
|
@@ -350,7 +350,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
350
350
|
export function makePostBeefResult(dd: ArcMinerPostBeefDataApi, miner: ArcServiceConfig, beef: number[], txids: string[]): sdk.PostBeefResult
|
|
351
351
|
```
|
|
352
352
|
|
|
353
|
-
See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult)
|
|
353
|
+
See also: [ArcMinerPostBeefDataApi](./services.md#interface-arcminerpostbeefdataapi), [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
354
354
|
|
|
355
355
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
356
356
|
|
|
@@ -361,7 +361,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
361
361
|
export function makePostBeefToTaalARC(config: ArcServiceConfig): sdk.PostBeefService
|
|
362
362
|
```
|
|
363
363
|
|
|
364
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefService](#type-postbeefservice)
|
|
364
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefService](./client.md#type-postbeefservice)
|
|
365
365
|
|
|
366
366
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
367
367
|
|
|
@@ -372,7 +372,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
372
372
|
export function makePostTxsToTaalARC(config: ArcServiceConfig): sdk.PostTxsService
|
|
373
373
|
```
|
|
374
374
|
|
|
375
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsService](#type-posttxsservice)
|
|
375
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostTxsService](./client.md#type-posttxsservice)
|
|
376
376
|
|
|
377
377
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
378
378
|
|
|
@@ -383,7 +383,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
383
383
|
export async function postBeefToArcMiner(beef: Beef | number[], txids: string[], config: ArcServiceConfig): Promise<sdk.PostBeefResult>
|
|
384
384
|
```
|
|
385
385
|
|
|
386
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult)
|
|
386
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
387
387
|
|
|
388
388
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
389
389
|
|
|
@@ -394,7 +394,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
394
394
|
export async function postBeefToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostBeefResult>
|
|
395
395
|
```
|
|
396
396
|
|
|
397
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult), [WalletServices](#interface-walletservices)
|
|
397
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult), [WalletServices](./client.md#interface-walletservices)
|
|
398
398
|
|
|
399
399
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
400
400
|
|
|
@@ -405,7 +405,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
405
405
|
export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostTxsResult>
|
|
406
406
|
```
|
|
407
407
|
|
|
408
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface-walletservices)
|
|
408
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostTxsResult](./client.md#interface-posttxsresult), [WalletServices](./client.md#interface-walletservices)
|
|
409
409
|
|
|
410
410
|
Argument Details
|
|
411
411
|
|
|
@@ -436,7 +436,7 @@ export function toBinaryBaseBlockHeader(header: sdk.BaseBlockHeader): number[] {
|
|
|
436
436
|
}
|
|
437
437
|
```
|
|
438
438
|
|
|
439
|
-
See also: [BaseBlockHeader](#interface-baseblockheader), [asArray](#function-asarray)
|
|
439
|
+
See also: [BaseBlockHeader](./client.md#interface-baseblockheader), [asArray](./client.md#function-asarray)
|
|
440
440
|
|
|
441
441
|
Returns
|
|
442
442
|
|
|
@@ -451,7 +451,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
451
451
|
export async function updateBsvExchangeRate(rate?: sdk.BsvExchangeRate, updateMsecs?: number): Promise<sdk.BsvExchangeRate>
|
|
452
452
|
```
|
|
453
453
|
|
|
454
|
-
See also: [BsvExchangeRate](#interface-bsvexchangerate)
|
|
454
|
+
See also: [BsvExchangeRate](./client.md#interface-bsvexchangerate)
|
|
455
455
|
|
|
456
456
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
457
457
|
|
|
@@ -462,7 +462,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
462
462
|
export async function updateChaintracksFiatExchangeRates(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
|
|
463
463
|
```
|
|
464
464
|
|
|
465
|
-
See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
465
|
+
See also: [FiatExchangeRates](./client.md#interface-fiatexchangerates), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
466
466
|
|
|
467
467
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
468
468
|
|
|
@@ -473,7 +473,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
473
473
|
export async function updateExchangeratesapi(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
|
|
474
474
|
```
|
|
475
475
|
|
|
476
|
-
See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
476
|
+
See also: [FiatExchangeRates](./client.md#interface-fiatexchangerates), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
477
477
|
|
|
478
478
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
479
479
|
|
|
@@ -484,7 +484,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
484
484
|
export function validateScriptHash(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat): string
|
|
485
485
|
```
|
|
486
486
|
|
|
487
|
-
See also: [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat)
|
|
487
|
+
See also: [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat)
|
|
488
488
|
|
|
489
489
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
490
490
|
|
package/docs/setup.md
CHANGED
|
@@ -50,7 +50,7 @@ export interface SetupEnv {
|
|
|
50
50
|
}
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
See also: [Chain](#type-chain)
|
|
53
|
+
See also: [Chain](./client.md#type-chain)
|
|
54
54
|
|
|
55
55
|
###### Property chain
|
|
56
56
|
|
|
@@ -59,7 +59,7 @@ The chan being accessed: 'main' for mainnet, 'test' for 'testnet'.
|
|
|
59
59
|
```ts
|
|
60
60
|
chain: sdk.Chain
|
|
61
61
|
```
|
|
62
|
-
See also: [Chain](#type-chain)
|
|
62
|
+
See also: [Chain](./client.md#type-chain)
|
|
63
63
|
|
|
64
64
|
###### Property devKeys
|
|
65
65
|
|
|
@@ -126,7 +126,7 @@ export interface SetupWallet {
|
|
|
126
126
|
}
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
129
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [Services](./services.md#class-services), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
130
130
|
|
|
131
131
|
###### Property chain
|
|
132
132
|
|
|
@@ -135,7 +135,7 @@ The chain ('main' or 'test') which the wallet accesses.
|
|
|
135
135
|
```ts
|
|
136
136
|
chain: sdk.Chain
|
|
137
137
|
```
|
|
138
|
-
See also: [Chain](#type-chain)
|
|
138
|
+
See also: [Chain](./client.md#type-chain)
|
|
139
139
|
|
|
140
140
|
###### Property identityKey
|
|
141
141
|
|
|
@@ -161,7 +161,7 @@ that speed up wallet operations and maintain data integrity.
|
|
|
161
161
|
```ts
|
|
162
162
|
monitor: Monitor
|
|
163
163
|
```
|
|
164
|
-
See also: [Monitor](#class-monitor)
|
|
164
|
+
See also: [Monitor](./monitor.md#class-monitor)
|
|
165
165
|
|
|
166
166
|
###### Property rootKey
|
|
167
167
|
|
|
@@ -179,7 +179,7 @@ on the public network.
|
|
|
179
179
|
```ts
|
|
180
180
|
services: Services
|
|
181
181
|
```
|
|
182
|
-
See also: [Services](#class-services)
|
|
182
|
+
See also: [Services](./services.md#class-services)
|
|
183
183
|
|
|
184
184
|
###### Property storage
|
|
185
185
|
|
|
@@ -189,7 +189,7 @@ accessed by the wallet.
|
|
|
189
189
|
```ts
|
|
190
190
|
storage: WalletStorageManager
|
|
191
191
|
```
|
|
192
|
-
See also: [WalletStorageManager](#class-walletstoragemanager)
|
|
192
|
+
See also: [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
193
193
|
|
|
194
194
|
###### Property wallet
|
|
195
195
|
|
|
@@ -203,7 +203,7 @@ components after construction may disrupt the normal operation of the wallet.
|
|
|
203
203
|
```ts
|
|
204
204
|
wallet: Wallet
|
|
205
205
|
```
|
|
206
|
-
See also: [Wallet](#class-wallet)
|
|
206
|
+
See also: [Wallet](./client.md#class-wallet)
|
|
207
207
|
|
|
208
208
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
209
209
|
|
|
@@ -230,7 +230,7 @@ export interface SetupWalletArgs {
|
|
|
230
230
|
}
|
|
231
231
|
```
|
|
232
232
|
|
|
233
|
-
See also: [SetupEnv](#interface-setupenv), [WalletStorageProvider](#interface-walletstorageprovider)
|
|
233
|
+
See also: [SetupEnv](./setup.md#interface-setupenv), [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
234
234
|
|
|
235
235
|
###### Property active
|
|
236
236
|
|
|
@@ -239,7 +239,7 @@ Optional. Active wallet storage. Can be added later.
|
|
|
239
239
|
```ts
|
|
240
240
|
active?: sdk.WalletStorageProvider
|
|
241
241
|
```
|
|
242
|
-
See also: [WalletStorageProvider](#interface-walletstorageprovider)
|
|
242
|
+
See also: [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
243
243
|
|
|
244
244
|
###### Property backups
|
|
245
245
|
|
|
@@ -248,7 +248,7 @@ Optional. One or more storage providers managed as backup destinations. Can be a
|
|
|
248
248
|
```ts
|
|
249
249
|
backups?: sdk.WalletStorageProvider[]
|
|
250
250
|
```
|
|
251
|
-
See also: [WalletStorageProvider](#interface-walletstorageprovider)
|
|
251
|
+
See also: [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
252
252
|
|
|
253
253
|
###### Property env
|
|
254
254
|
|
|
@@ -257,7 +257,7 @@ Configuration "secrets" typically obtained by `Setup.makeEnv` and `Setup.getEnv`
|
|
|
257
257
|
```ts
|
|
258
258
|
env: SetupEnv
|
|
259
259
|
```
|
|
260
|
-
See also: [SetupEnv](#interface-setupenv)
|
|
260
|
+
See also: [SetupEnv](./setup.md#interface-setupenv)
|
|
261
261
|
|
|
262
262
|
###### Property privKeyHex
|
|
263
263
|
|
|
@@ -290,7 +290,7 @@ export interface SetupWalletClient extends SetupWallet {
|
|
|
290
290
|
}
|
|
291
291
|
```
|
|
292
292
|
|
|
293
|
-
See also: [SetupWallet](#interface-setupwallet)
|
|
293
|
+
See also: [SetupWallet](./setup.md#interface-setupwallet)
|
|
294
294
|
|
|
295
295
|
###### Property endpointUrl
|
|
296
296
|
|
|
@@ -316,7 +316,7 @@ export interface SetupWalletClientArgs extends SetupWalletArgs {
|
|
|
316
316
|
}
|
|
317
317
|
```
|
|
318
318
|
|
|
319
|
-
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
319
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
320
320
|
|
|
321
321
|
###### Property endpointUrl
|
|
322
322
|
|
|
@@ -348,7 +348,7 @@ export interface SetupWalletKnex extends SetupWallet {
|
|
|
348
348
|
}
|
|
349
349
|
```
|
|
350
350
|
|
|
351
|
-
See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [SetupWallet](#interface-setupwallet), [StorageKnex](#class-storageknex), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
351
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [Services](./services.md#class-services), [SetupWallet](./setup.md#interface-setupwallet), [StorageKnex](./storage.md#class-storageknex), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
352
352
|
|
|
353
353
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
354
354
|
|
|
@@ -362,7 +362,7 @@ export interface SetupWalletKnexArgs extends SetupWalletArgs {
|
|
|
362
362
|
}
|
|
363
363
|
```
|
|
364
364
|
|
|
365
|
-
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
365
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
366
366
|
|
|
367
367
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
368
368
|
|
|
@@ -375,7 +375,7 @@ export interface SetupWalletMySQLArgs extends SetupWalletArgs {
|
|
|
375
375
|
}
|
|
376
376
|
```
|
|
377
377
|
|
|
378
|
-
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
378
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
379
379
|
|
|
380
380
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
381
381
|
|
|
@@ -389,7 +389,7 @@ export interface SetupWalletSQLiteArgs extends SetupWalletArgs {
|
|
|
389
389
|
}
|
|
390
390
|
```
|
|
391
391
|
|
|
392
|
-
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
392
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
393
393
|
|
|
394
394
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
395
395
|
|
|
@@ -476,7 +476,7 @@ export abstract class Setup extends SetupClient {
|
|
|
476
476
|
}
|
|
477
477
|
```
|
|
478
478
|
|
|
479
|
-
See also: [SetupClient](#class-setupclient), [SetupWalletKnex](#interface-setupwalletknex), [SetupWalletKnexArgs](#interface-setupwalletknexargs), [SetupWalletMySQLArgs](#interface-setupwalletmysqlargs), [SetupWalletSQLiteArgs](#interface-setupwalletsqliteargs), [StorageKnex](#class-storageknex)
|
|
479
|
+
See also: [SetupClient](./setup.md#class-setupclient), [SetupWalletKnex](./setup.md#interface-setupwalletknex), [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs), [SetupWalletMySQLArgs](./setup.md#interface-setupwalletmysqlargs), [SetupWalletSQLiteArgs](./setup.md#interface-setupwalletsqliteargs), [StorageKnex](./storage.md#class-storageknex)
|
|
480
480
|
|
|
481
481
|
###### Method createWalletKnex
|
|
482
482
|
|
|
@@ -505,7 +505,7 @@ static async createWalletKnex(args: SetupWalletKnexArgs): Promise<SetupWalletKne
|
|
|
505
505
|
return r;
|
|
506
506
|
}
|
|
507
507
|
```
|
|
508
|
-
See also: [Setup](#class-setup), [SetupWalletKnex](#interface-setupwalletknex), [SetupWalletKnexArgs](#interface-setupwalletknexargs), [StorageKnex](#class-storageknex)
|
|
508
|
+
See also: [Setup](./setup.md#class-setup), [SetupWalletKnex](./setup.md#interface-setupwalletknex), [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs), [StorageKnex](./storage.md#class-storageknex)
|
|
509
509
|
|
|
510
510
|
Argument Details
|
|
511
511
|
|
|
@@ -627,7 +627,7 @@ export abstract class SetupClient {
|
|
|
627
627
|
}
|
|
628
628
|
```
|
|
629
629
|
|
|
630
|
-
See also: [Chain](#type-chain), [KeyPairAddress](#type-keypairaddress), [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [ScriptTemplateUnlock](#interface-scripttemplateunlock), [Services](#class-services), [SetupEnv](#interface-setupenv), [SetupWallet](#interface-setupwallet), [SetupWalletArgs](#interface-setupwalletargs), [SetupWalletClient](#interface-setupwalletclient), [SetupWalletClientArgs](#interface-setupwalletclientargs), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
630
|
+
See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#type-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
631
631
|
|
|
632
632
|
###### Method createWallet
|
|
633
633
|
|
|
@@ -678,7 +678,7 @@ static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
|
678
678
|
return r;
|
|
679
679
|
}
|
|
680
680
|
```
|
|
681
|
-
See also: [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [Services](#class-services), [SetupWallet](#interface-setupwallet), [SetupWalletArgs](#interface-setupwalletargs), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
681
|
+
See also: [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [Services](./services.md#class-services), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
682
682
|
|
|
683
683
|
###### Method getEnv
|
|
684
684
|
|
|
@@ -691,7 +691,7 @@ Access private keys through the `devKeys` object: `devKeys[identityKey]`
|
|
|
691
691
|
```ts
|
|
692
692
|
static getEnv(chain: sdk.Chain): SetupEnv
|
|
693
693
|
```
|
|
694
|
-
See also: [Chain](#type-chain), [SetupEnv](#interface-setupenv)
|
|
694
|
+
See also: [Chain](./client.md#type-chain), [SetupEnv](./setup.md#interface-setupenv)
|
|
695
695
|
|
|
696
696
|
Returns
|
|
697
697
|
|