@bsv/wallet-toolbox 1.1.6 → 1.1.8
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 +499 -900
- package/docs/monitor.md +29 -69
- package/docs/services.md +22 -40
- package/docs/setup.md +23 -65
- package/docs/storage.md +2163 -489
- package/docs/wallet.md +499 -900
- 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 +2 -2
- 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 +4 -2
- package/out/src/storage/methods/purgeData.js.map +1 -1
- package/out/src/storage/methods/reviewStatus.js +1 -1
- package/out/src/storage/methods/reviewStatus.js.map +1 -1
- package/out/src/storage/remoting/StorageClient.d.ts +11 -11
- package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
- 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.d.ts.map +1 -1
- package/out/test/Wallet/live/walletLive.man.test.js +35 -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 +47 -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 +124 -104
- package/src/storage/StorageProvider.ts +43 -30
- package/src/storage/StorageReader.ts +36 -21
- package/src/storage/StorageReaderWriter.ts +78 -65
- package/src/storage/StorageSyncReader.ts +34 -17
- package/src/storage/WalletStorageManager.ts +17 -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 +20 -12
- package/src/storage/methods/reviewStatus.ts +5 -5
- package/src/storage/remoting/StorageClient.ts +28 -18
- 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 +67 -50
- package/test/Wallet/certificate/listCertificates.test.ts +12 -8
- package/test/Wallet/live/walletLive.man.test.ts +46 -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 +12 -6
- 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/client.md
CHANGED
|
@@ -168,10 +168,6 @@ export interface BaseBlockHeader {
|
|
|
168
168
|
}
|
|
169
169
|
```
|
|
170
170
|
|
|
171
|
-
<details>
|
|
172
|
-
|
|
173
|
-
<summary>Interface BaseBlockHeader Details</summary>
|
|
174
|
-
|
|
175
171
|
###### Property bits
|
|
176
172
|
|
|
177
173
|
Block header bits value. Serialized length is 4 bytes.
|
|
@@ -220,8 +216,6 @@ Block header version value. Serialized length is 4 bytes.
|
|
|
220
216
|
version: number
|
|
221
217
|
```
|
|
222
218
|
|
|
223
|
-
</details>
|
|
224
|
-
|
|
225
219
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
226
220
|
|
|
227
221
|
---
|
|
@@ -236,11 +230,7 @@ export interface BlockHeader extends BaseBlockHeader {
|
|
|
236
230
|
}
|
|
237
231
|
```
|
|
238
232
|
|
|
239
|
-
See also: [BaseBlockHeader](#interface-baseblockheader)
|
|
240
|
-
|
|
241
|
-
<details>
|
|
242
|
-
|
|
243
|
-
<summary>Interface BlockHeader Details</summary>
|
|
233
|
+
See also: [BaseBlockHeader](./client.md#interface-baseblockheader)
|
|
244
234
|
|
|
245
235
|
###### Property hash
|
|
246
236
|
|
|
@@ -258,8 +248,6 @@ Height of the header, starting from zero.
|
|
|
258
248
|
height: number
|
|
259
249
|
```
|
|
260
250
|
|
|
261
|
-
</details>
|
|
262
|
-
|
|
263
251
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
264
252
|
|
|
265
253
|
---
|
|
@@ -293,11 +281,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
293
281
|
|
|
294
282
|
```ts
|
|
295
283
|
export interface CommitNewTxResults {
|
|
296
|
-
req:
|
|
284
|
+
req: EntityProvenTxReq;
|
|
297
285
|
log?: string;
|
|
298
286
|
}
|
|
299
287
|
```
|
|
300
288
|
|
|
289
|
+
See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq)
|
|
290
|
+
|
|
301
291
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
302
292
|
|
|
303
293
|
---
|
|
@@ -345,11 +335,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
345
335
|
|
|
346
336
|
```ts
|
|
347
337
|
export interface FindCertificateFieldsArgs extends sdk.FindSincePagedArgs {
|
|
348
|
-
partial: Partial<
|
|
338
|
+
partial: Partial<TableCertificateField>;
|
|
349
339
|
}
|
|
350
340
|
```
|
|
351
341
|
|
|
352
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
342
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableCertificateField](./storage.md#interface-tablecertificatefield)
|
|
353
343
|
|
|
354
344
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
355
345
|
|
|
@@ -358,14 +348,14 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
358
348
|
|
|
359
349
|
```ts
|
|
360
350
|
export interface FindCertificatesArgs extends FindSincePagedArgs {
|
|
361
|
-
partial: Partial<
|
|
351
|
+
partial: Partial<TableCertificate>;
|
|
362
352
|
certifiers?: string[];
|
|
363
353
|
types?: string[];
|
|
364
354
|
includeFields?: boolean;
|
|
365
355
|
}
|
|
366
356
|
```
|
|
367
357
|
|
|
368
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
358
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableCertificate](./storage.md#interface-tablecertificate)
|
|
369
359
|
|
|
370
360
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
371
361
|
|
|
@@ -374,11 +364,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
374
364
|
|
|
375
365
|
```ts
|
|
376
366
|
export interface FindCommissionsArgs extends sdk.FindSincePagedArgs {
|
|
377
|
-
partial: Partial<
|
|
367
|
+
partial: Partial<TableCommission>;
|
|
378
368
|
}
|
|
379
369
|
```
|
|
380
370
|
|
|
381
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
371
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableCommission](./storage.md#interface-tablecommission)
|
|
382
372
|
|
|
383
373
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
384
374
|
|
|
@@ -391,7 +381,7 @@ export interface FindForUserSincePagedArgs extends FindSincePagedArgs {
|
|
|
391
381
|
}
|
|
392
382
|
```
|
|
393
383
|
|
|
394
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
384
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs)
|
|
395
385
|
|
|
396
386
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
397
387
|
|
|
@@ -400,11 +390,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
400
390
|
|
|
401
391
|
```ts
|
|
402
392
|
export interface FindMonitorEventsArgs extends sdk.FindSincePagedArgs {
|
|
403
|
-
partial: Partial<
|
|
393
|
+
partial: Partial<TableMonitorEvent>;
|
|
404
394
|
}
|
|
405
395
|
```
|
|
406
396
|
|
|
407
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
397
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableMonitorEvent](./storage.md#interface-tablemonitorevent)
|
|
408
398
|
|
|
409
399
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
410
400
|
|
|
@@ -413,11 +403,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
413
403
|
|
|
414
404
|
```ts
|
|
415
405
|
export interface FindOutputBasketsArgs extends FindSincePagedArgs {
|
|
416
|
-
partial: Partial<
|
|
406
|
+
partial: Partial<TableOutputBasket>;
|
|
417
407
|
}
|
|
418
408
|
```
|
|
419
409
|
|
|
420
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
410
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableOutputBasket](./storage.md#interface-tableoutputbasket)
|
|
421
411
|
|
|
422
412
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
423
413
|
|
|
@@ -426,12 +416,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
426
416
|
|
|
427
417
|
```ts
|
|
428
418
|
export interface FindOutputTagMapsArgs extends sdk.FindSincePagedArgs {
|
|
429
|
-
partial: Partial<
|
|
419
|
+
partial: Partial<TableOutputTagMap>;
|
|
430
420
|
tagIds?: number[];
|
|
431
421
|
}
|
|
432
422
|
```
|
|
433
423
|
|
|
434
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
424
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap)
|
|
435
425
|
|
|
436
426
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
437
427
|
|
|
@@ -440,11 +430,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
440
430
|
|
|
441
431
|
```ts
|
|
442
432
|
export interface FindOutputTagsArgs extends sdk.FindSincePagedArgs {
|
|
443
|
-
partial: Partial<
|
|
433
|
+
partial: Partial<TableOutputTag>;
|
|
444
434
|
}
|
|
445
435
|
```
|
|
446
436
|
|
|
447
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
437
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableOutputTag](./storage.md#interface-tableoutputtag)
|
|
448
438
|
|
|
449
439
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
450
440
|
|
|
@@ -453,13 +443,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
453
443
|
|
|
454
444
|
```ts
|
|
455
445
|
export interface FindOutputsArgs extends FindSincePagedArgs {
|
|
456
|
-
partial: Partial<
|
|
446
|
+
partial: Partial<TableOutput>;
|
|
457
447
|
noScript?: boolean;
|
|
458
448
|
txStatus?: sdk.TransactionStatus[];
|
|
459
449
|
}
|
|
460
450
|
```
|
|
461
451
|
|
|
462
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs), [TransactionStatus](#type-transactionstatus)
|
|
452
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableOutput](./storage.md#interface-tableoutput), [TransactionStatus](./client.md#type-transactionstatus)
|
|
463
453
|
|
|
464
454
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
465
455
|
|
|
@@ -472,7 +462,7 @@ export interface FindPartialSincePagedArgs<T extends object> extends FindSincePa
|
|
|
472
462
|
}
|
|
473
463
|
```
|
|
474
464
|
|
|
475
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
465
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs)
|
|
476
466
|
|
|
477
467
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
478
468
|
|
|
@@ -481,13 +471,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
481
471
|
|
|
482
472
|
```ts
|
|
483
473
|
export interface FindProvenTxReqsArgs extends sdk.FindSincePagedArgs {
|
|
484
|
-
partial: Partial<
|
|
474
|
+
partial: Partial<TableProvenTxReq>;
|
|
485
475
|
status?: sdk.ProvenTxReqStatus[];
|
|
486
476
|
txids?: string[];
|
|
487
477
|
}
|
|
488
478
|
```
|
|
489
479
|
|
|
490
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs), [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
480
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [ProvenTxReqStatus](./client.md#type-proventxreqstatus), [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
491
481
|
|
|
492
482
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
493
483
|
|
|
@@ -496,11 +486,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
496
486
|
|
|
497
487
|
```ts
|
|
498
488
|
export interface FindProvenTxsArgs extends sdk.FindSincePagedArgs {
|
|
499
|
-
partial: Partial<
|
|
489
|
+
partial: Partial<TableProvenTx>;
|
|
500
490
|
}
|
|
501
491
|
```
|
|
502
492
|
|
|
503
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
493
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableProvenTx](./storage.md#interface-tableproventx)
|
|
504
494
|
|
|
505
495
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
506
496
|
|
|
@@ -515,7 +505,7 @@ export interface FindSincePagedArgs {
|
|
|
515
505
|
}
|
|
516
506
|
```
|
|
517
507
|
|
|
518
|
-
See also: [Paged](#interface-paged), [TrxToken](#interface-trxtoken)
|
|
508
|
+
See also: [Paged](./client.md#interface-paged), [TrxToken](./client.md#interface-trxtoken)
|
|
519
509
|
|
|
520
510
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
521
511
|
|
|
@@ -524,11 +514,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
524
514
|
|
|
525
515
|
```ts
|
|
526
516
|
export interface FindSyncStatesArgs extends sdk.FindSincePagedArgs {
|
|
527
|
-
partial: Partial<
|
|
517
|
+
partial: Partial<TableSyncState>;
|
|
528
518
|
}
|
|
529
519
|
```
|
|
530
520
|
|
|
531
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
521
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableSyncState](./storage.md#interface-tablesyncstate)
|
|
532
522
|
|
|
533
523
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
534
524
|
|
|
@@ -537,13 +527,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
537
527
|
|
|
538
528
|
```ts
|
|
539
529
|
export interface FindTransactionsArgs extends sdk.FindSincePagedArgs {
|
|
540
|
-
partial: Partial<
|
|
530
|
+
partial: Partial<TableTransaction>;
|
|
541
531
|
status?: sdk.TransactionStatus[];
|
|
542
532
|
noRawTx?: boolean;
|
|
543
533
|
}
|
|
544
534
|
```
|
|
545
535
|
|
|
546
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs), [TransactionStatus](#type-transactionstatus)
|
|
536
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableTransaction](./storage.md#interface-tabletransaction), [TransactionStatus](./client.md#type-transactionstatus)
|
|
547
537
|
|
|
548
538
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
549
539
|
|
|
@@ -552,12 +542,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
552
542
|
|
|
553
543
|
```ts
|
|
554
544
|
export interface FindTxLabelMapsArgs extends sdk.FindSincePagedArgs {
|
|
555
|
-
partial: Partial<
|
|
545
|
+
partial: Partial<TableTxLabelMap>;
|
|
556
546
|
labelIds?: number[];
|
|
557
547
|
}
|
|
558
548
|
```
|
|
559
549
|
|
|
560
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
550
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap)
|
|
561
551
|
|
|
562
552
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
563
553
|
|
|
@@ -566,11 +556,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
566
556
|
|
|
567
557
|
```ts
|
|
568
558
|
export interface FindTxLabelsArgs extends sdk.FindSincePagedArgs {
|
|
569
|
-
partial: Partial<
|
|
559
|
+
partial: Partial<TableTxLabel>;
|
|
570
560
|
}
|
|
571
561
|
```
|
|
572
562
|
|
|
573
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
563
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableTxLabel](./storage.md#interface-tabletxlabel)
|
|
574
564
|
|
|
575
565
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
576
566
|
|
|
@@ -579,11 +569,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
579
569
|
|
|
580
570
|
```ts
|
|
581
571
|
export interface FindUsersArgs extends sdk.FindSincePagedArgs {
|
|
582
|
-
partial: Partial<
|
|
572
|
+
partial: Partial<TableUser>;
|
|
583
573
|
}
|
|
584
574
|
```
|
|
585
575
|
|
|
586
|
-
See also: [FindSincePagedArgs](#interface-findsincepagedargs)
|
|
576
|
+
See also: [FindSincePagedArgs](./client.md#interface-findsincepagedargs), [TableUser](./storage.md#interface-tableuser)
|
|
587
577
|
|
|
588
578
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
589
579
|
|
|
@@ -654,11 +644,7 @@ export interface GenerateChangeSdkParams {
|
|
|
654
644
|
}
|
|
655
645
|
```
|
|
656
646
|
|
|
657
|
-
See also: [GenerateChangeSdkInput](#interface-generatechangesdkinput), [GenerateChangeSdkOutput](#interface-generatechangesdkoutput), [StorageFeeModel](#interface-storagefeemodel)
|
|
658
|
-
|
|
659
|
-
<details>
|
|
660
|
-
|
|
661
|
-
<summary>Interface GenerateChangeSdkParams Details</summary>
|
|
647
|
+
See also: [GenerateChangeSdkInput](./storage.md#interface-generatechangesdkinput), [GenerateChangeSdkOutput](./storage.md#interface-generatechangesdkoutput), [StorageFeeModel](./client.md#interface-storagefeemodel)
|
|
662
648
|
|
|
663
649
|
###### Property changeFirstSatoshis
|
|
664
650
|
|
|
@@ -707,8 +693,6 @@ If undefined, only a single change output will be added if excess fees must be r
|
|
|
707
693
|
targetNetCount?: number
|
|
708
694
|
```
|
|
709
695
|
|
|
710
|
-
</details>
|
|
711
|
-
|
|
712
696
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
713
697
|
|
|
714
698
|
---
|
|
@@ -724,7 +708,7 @@ export interface GenerateChangeSdkResult {
|
|
|
724
708
|
}
|
|
725
709
|
```
|
|
726
710
|
|
|
727
|
-
See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput), [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput)
|
|
711
|
+
See also: [GenerateChangeSdkChangeInput](./storage.md#interface-generatechangesdkchangeinput), [GenerateChangeSdkChangeOutput](./storage.md#interface-generatechangesdkchangeoutput)
|
|
728
712
|
|
|
729
713
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
730
714
|
|
|
@@ -737,7 +721,7 @@ export interface GenerateChangeSdkStorageChange extends GenerateChangeSdkChangeI
|
|
|
737
721
|
}
|
|
738
722
|
```
|
|
739
723
|
|
|
740
|
-
See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput)
|
|
724
|
+
See also: [GenerateChangeSdkChangeInput](./storage.md#interface-generatechangesdkchangeinput)
|
|
741
725
|
|
|
742
726
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
743
727
|
|
|
@@ -755,11 +739,7 @@ export interface GetMerklePathResult {
|
|
|
755
739
|
}
|
|
756
740
|
```
|
|
757
741
|
|
|
758
|
-
See also: [BlockHeader](#interface-blockheader), [WalletError](#class-walleterror)
|
|
759
|
-
|
|
760
|
-
<details>
|
|
761
|
-
|
|
762
|
-
<summary>Interface GetMerklePathResult Details</summary>
|
|
742
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [WalletError](./client.md#class-walleterror)
|
|
763
743
|
|
|
764
744
|
###### Property error
|
|
765
745
|
|
|
@@ -768,7 +748,7 @@ The first exception error that occurred during processing, if any.
|
|
|
768
748
|
```ts
|
|
769
749
|
error?: sdk.WalletError
|
|
770
750
|
```
|
|
771
|
-
See also: [WalletError](#class-walleterror)
|
|
751
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
772
752
|
|
|
773
753
|
###### Property merklePath
|
|
774
754
|
|
|
@@ -787,8 +767,6 @@ The name of the service returning the proof, or undefined if no proof
|
|
|
787
767
|
name?: string
|
|
788
768
|
```
|
|
789
769
|
|
|
790
|
-
</details>
|
|
791
|
-
|
|
792
770
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
793
771
|
|
|
794
772
|
---
|
|
@@ -805,11 +783,7 @@ export interface GetRawTxResult {
|
|
|
805
783
|
}
|
|
806
784
|
```
|
|
807
785
|
|
|
808
|
-
See also: [WalletError](#class-walleterror)
|
|
809
|
-
|
|
810
|
-
<details>
|
|
811
|
-
|
|
812
|
-
<summary>Interface GetRawTxResult Details</summary>
|
|
786
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
813
787
|
|
|
814
788
|
###### Property error
|
|
815
789
|
|
|
@@ -818,7 +792,7 @@ The first exception error that occurred during processing, if any.
|
|
|
818
792
|
```ts
|
|
819
793
|
error?: sdk.WalletError
|
|
820
794
|
```
|
|
821
|
-
See also: [WalletError](#class-walleterror)
|
|
795
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
822
796
|
|
|
823
797
|
###### Property name
|
|
824
798
|
|
|
@@ -845,8 +819,6 @@ Transaction hash or rawTx (and of initial request)
|
|
|
845
819
|
txid: string
|
|
846
820
|
```
|
|
847
821
|
|
|
848
|
-
</details>
|
|
849
|
-
|
|
850
822
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
851
823
|
|
|
852
824
|
---
|
|
@@ -855,13 +827,15 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
855
827
|
```ts
|
|
856
828
|
export interface GetReqsAndBeefDetail {
|
|
857
829
|
txid: string;
|
|
858
|
-
req?:
|
|
859
|
-
proven?:
|
|
830
|
+
req?: TableProvenTxReq;
|
|
831
|
+
proven?: TableProvenTx;
|
|
860
832
|
status: "readyToSend" | "alreadySent" | "error" | "unknown";
|
|
861
833
|
error?: string;
|
|
862
834
|
}
|
|
863
835
|
```
|
|
864
836
|
|
|
837
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
838
|
+
|
|
865
839
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
866
840
|
|
|
867
841
|
---
|
|
@@ -874,7 +848,7 @@ export interface GetReqsAndBeefResult {
|
|
|
874
848
|
}
|
|
875
849
|
```
|
|
876
850
|
|
|
877
|
-
See also: [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail)
|
|
851
|
+
See also: [GetReqsAndBeefDetail](./storage.md#interface-getreqsandbeefdetail)
|
|
878
852
|
|
|
879
853
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
880
854
|
|
|
@@ -890,10 +864,6 @@ export interface GetUtxoStatusDetails {
|
|
|
890
864
|
}
|
|
891
865
|
```
|
|
892
866
|
|
|
893
|
-
<details>
|
|
894
|
-
|
|
895
|
-
<summary>Interface GetUtxoStatusDetails Details</summary>
|
|
896
|
-
|
|
897
867
|
###### Property height
|
|
898
868
|
|
|
899
869
|
if isUtxo, the block height containing the matching unspent transaction output
|
|
@@ -934,8 +904,6 @@ typically there will be only one, but future orphans can result in multiple valu
|
|
|
934
904
|
txid?: string
|
|
935
905
|
```
|
|
936
906
|
|
|
937
|
-
</details>
|
|
938
|
-
|
|
939
907
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
940
908
|
|
|
941
909
|
---
|
|
@@ -951,11 +919,7 @@ export interface GetUtxoStatusResult {
|
|
|
951
919
|
}
|
|
952
920
|
```
|
|
953
921
|
|
|
954
|
-
See also: [GetUtxoStatusDetails](#interface-getutxostatusdetails), [WalletError](#class-walleterror)
|
|
955
|
-
|
|
956
|
-
<details>
|
|
957
|
-
|
|
958
|
-
<summary>Interface GetUtxoStatusResult Details</summary>
|
|
922
|
+
See also: [GetUtxoStatusDetails](./client.md#interface-getutxostatusdetails), [WalletError](./client.md#class-walleterror)
|
|
959
923
|
|
|
960
924
|
###### Property details
|
|
961
925
|
|
|
@@ -967,7 +931,7 @@ there could be more than one block in which it is a valid utxo.
|
|
|
967
931
|
```ts
|
|
968
932
|
details: GetUtxoStatusDetails[]
|
|
969
933
|
```
|
|
970
|
-
See also: [GetUtxoStatusDetails](#interface-getutxostatusdetails)
|
|
934
|
+
See also: [GetUtxoStatusDetails](./client.md#interface-getutxostatusdetails)
|
|
971
935
|
|
|
972
936
|
###### Property error
|
|
973
937
|
|
|
@@ -976,7 +940,7 @@ When status is 'error', provides code and description
|
|
|
976
940
|
```ts
|
|
977
941
|
error?: sdk.WalletError
|
|
978
942
|
```
|
|
979
|
-
See also: [WalletError](#class-walleterror)
|
|
943
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
980
944
|
|
|
981
945
|
###### Property isUtxo
|
|
982
946
|
|
|
@@ -1003,8 +967,6 @@ name: string
|
|
|
1003
967
|
status: "success" | "error"
|
|
1004
968
|
```
|
|
1005
969
|
|
|
1006
|
-
</details>
|
|
1007
|
-
|
|
1008
970
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1009
971
|
|
|
1010
972
|
---
|
|
@@ -1036,11 +998,7 @@ export interface MonitorOptions {
|
|
|
1036
998
|
}
|
|
1037
999
|
```
|
|
1038
1000
|
|
|
1039
|
-
See also: [Chain](#type-chain), [MonitorStorage](#type-monitorstorage), [Services](#class-services)
|
|
1040
|
-
|
|
1041
|
-
<details>
|
|
1042
|
-
|
|
1043
|
-
<summary>Interface MonitorOptions Details</summary>
|
|
1001
|
+
See also: [Chain](./client.md#type-chain), [MonitorStorage](./monitor.md#type-monitorstorage), [Services](./services.md#class-services)
|
|
1044
1002
|
|
|
1045
1003
|
###### Property msecsWaitPerMerkleProofServiceReq
|
|
1046
1004
|
|
|
@@ -1050,8 +1008,6 @@ How many msecs to wait after each getMerkleProof service request.
|
|
|
1050
1008
|
msecsWaitPerMerkleProofServiceReq: number
|
|
1051
1009
|
```
|
|
1052
1010
|
|
|
1053
|
-
</details>
|
|
1054
|
-
|
|
1055
1011
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1056
1012
|
|
|
1057
1013
|
---
|
|
@@ -1066,10 +1022,6 @@ export interface OutPoint {
|
|
|
1066
1022
|
}
|
|
1067
1023
|
```
|
|
1068
1024
|
|
|
1069
|
-
<details>
|
|
1070
|
-
|
|
1071
|
-
<summary>Interface OutPoint Details</summary>
|
|
1072
|
-
|
|
1073
1025
|
###### Property txid
|
|
1074
1026
|
|
|
1075
1027
|
Transaction double sha256 hash as big endian hex string
|
|
@@ -1086,8 +1038,6 @@ zero based output index within the transaction
|
|
|
1086
1038
|
vout: number
|
|
1087
1039
|
```
|
|
1088
1040
|
|
|
1089
|
-
</details>
|
|
1090
|
-
|
|
1091
1041
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1092
1042
|
|
|
1093
1043
|
---
|
|
@@ -1116,7 +1066,7 @@ export interface PendingSignAction {
|
|
|
1116
1066
|
}
|
|
1117
1067
|
```
|
|
1118
1068
|
|
|
1119
|
-
See also: [PendingStorageInput](#interface-pendingstorageinput), [StorageCreateActionResult](#interface-storagecreateactionresult), [ValidCreateActionArgs](#interface-validcreateactionargs)
|
|
1069
|
+
See also: [PendingStorageInput](./client.md#interface-pendingstorageinput), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs)
|
|
1120
1070
|
|
|
1121
1071
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1122
1072
|
|
|
@@ -1144,7 +1094,7 @@ export interface PostBeefResult extends PostTxsResult {
|
|
|
1144
1094
|
}
|
|
1145
1095
|
```
|
|
1146
1096
|
|
|
1147
|
-
See also: [PostTxsResult](#interface-posttxsresult)
|
|
1097
|
+
See also: [PostTxsResult](./client.md#interface-posttxsresult)
|
|
1148
1098
|
|
|
1149
1099
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1150
1100
|
|
|
@@ -1162,10 +1112,6 @@ export interface PostBeefResultForTxidApi {
|
|
|
1162
1112
|
}
|
|
1163
1113
|
```
|
|
1164
1114
|
|
|
1165
|
-
<details>
|
|
1166
|
-
|
|
1167
|
-
<summary>Interface PostBeefResultForTxidApi Details</summary>
|
|
1168
|
-
|
|
1169
1115
|
###### Property alreadyKnown
|
|
1170
1116
|
|
|
1171
1117
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1184,8 +1130,6 @@ alreadyKnown?: boolean
|
|
|
1184
1130
|
status: "success" | "error"
|
|
1185
1131
|
```
|
|
1186
1132
|
|
|
1187
|
-
</details>
|
|
1188
|
-
|
|
1189
1133
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1190
1134
|
|
|
1191
1135
|
---
|
|
@@ -1194,7 +1138,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
1194
1138
|
```ts
|
|
1195
1139
|
export interface PostReqsToNetworkDetails {
|
|
1196
1140
|
txid: string;
|
|
1197
|
-
req:
|
|
1141
|
+
req: EntityProvenTxReq;
|
|
1198
1142
|
status: PostReqsToNetworkDetailsStatus;
|
|
1199
1143
|
pbrft: sdk.PostTxResultForTxid;
|
|
1200
1144
|
data?: string;
|
|
@@ -1202,7 +1146,7 @@ export interface PostReqsToNetworkDetails {
|
|
|
1202
1146
|
}
|
|
1203
1147
|
```
|
|
1204
1148
|
|
|
1205
|
-
See also: [PostReqsToNetworkDetailsStatus](#type-postreqstonetworkdetailsstatus), [PostTxResultForTxid](#interface-posttxresultfortxid)
|
|
1149
|
+
See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq), [PostReqsToNetworkDetailsStatus](./storage.md#type-postreqstonetworkdetailsstatus), [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
|
|
1206
1150
|
|
|
1207
1151
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1208
1152
|
|
|
@@ -1219,7 +1163,7 @@ export interface PostReqsToNetworkResult {
|
|
|
1219
1163
|
}
|
|
1220
1164
|
```
|
|
1221
1165
|
|
|
1222
|
-
See also: [PostBeefResult](#interface-postbeefresult), [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails)
|
|
1166
|
+
See also: [PostBeefResult](./client.md#interface-postbeefresult), [PostReqsToNetworkDetails](./storage.md#interface-postreqstonetworkdetails)
|
|
1223
1167
|
|
|
1224
1168
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1225
1169
|
|
|
@@ -1238,10 +1182,6 @@ export interface PostTxResultForTxid {
|
|
|
1238
1182
|
}
|
|
1239
1183
|
```
|
|
1240
1184
|
|
|
1241
|
-
<details>
|
|
1242
|
-
|
|
1243
|
-
<summary>Interface PostTxResultForTxid Details</summary>
|
|
1244
|
-
|
|
1245
1185
|
###### Property alreadyKnown
|
|
1246
1186
|
|
|
1247
1187
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1260,8 +1200,6 @@ alreadyKnown?: boolean
|
|
|
1260
1200
|
status: "success" | "error"
|
|
1261
1201
|
```
|
|
1262
1202
|
|
|
1263
|
-
</details>
|
|
1264
|
-
|
|
1265
1203
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1266
1204
|
|
|
1267
1205
|
---
|
|
@@ -1279,11 +1217,7 @@ export interface PostTxsResult {
|
|
|
1279
1217
|
}
|
|
1280
1218
|
```
|
|
1281
1219
|
|
|
1282
|
-
See also: [PostTxResultForTxid](#interface-posttxresultfortxid), [WalletError](#class-walleterror)
|
|
1283
|
-
|
|
1284
|
-
<details>
|
|
1285
|
-
|
|
1286
|
-
<summary>Interface PostTxsResult Details</summary>
|
|
1220
|
+
See also: [PostTxResultForTxid](./client.md#interface-posttxresultfortxid), [WalletError](./client.md#class-walleterror)
|
|
1287
1221
|
|
|
1288
1222
|
###### Property data
|
|
1289
1223
|
|
|
@@ -1310,8 +1244,6 @@ name: string
|
|
|
1310
1244
|
status: "success" | "error"
|
|
1311
1245
|
```
|
|
1312
1246
|
|
|
1313
|
-
</details>
|
|
1314
|
-
|
|
1315
1247
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1316
1248
|
|
|
1317
1249
|
---
|
|
@@ -1327,7 +1259,7 @@ export interface ProcessSyncChunkResult {
|
|
|
1327
1259
|
}
|
|
1328
1260
|
```
|
|
1329
1261
|
|
|
1330
|
-
See also: [WalletError](#class-walleterror)
|
|
1262
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
1331
1263
|
|
|
1332
1264
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1333
1265
|
|
|
@@ -1336,12 +1268,14 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
1336
1268
|
|
|
1337
1269
|
```ts
|
|
1338
1270
|
export interface ProvenOrRawTx {
|
|
1339
|
-
proven?:
|
|
1271
|
+
proven?: TableProvenTx;
|
|
1340
1272
|
rawTx?: number[];
|
|
1341
1273
|
inputBEEF?: number[];
|
|
1342
1274
|
}
|
|
1343
1275
|
```
|
|
1344
1276
|
|
|
1277
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
1278
|
+
|
|
1345
1279
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1346
1280
|
|
|
1347
1281
|
---
|
|
@@ -1358,10 +1292,6 @@ export interface PurgeParams {
|
|
|
1358
1292
|
}
|
|
1359
1293
|
```
|
|
1360
1294
|
|
|
1361
|
-
<details>
|
|
1362
|
-
|
|
1363
|
-
<summary>Interface PurgeParams Details</summary>
|
|
1364
|
-
|
|
1365
1295
|
###### Property purgeCompletedAge
|
|
1366
1296
|
|
|
1367
1297
|
Minimum age in msecs for transient completed transaction data purge.
|
|
@@ -1389,8 +1319,6 @@ Default is 14 days.
|
|
|
1389
1319
|
purgeSpentAge?: number
|
|
1390
1320
|
```
|
|
1391
1321
|
|
|
1392
|
-
</details>
|
|
1393
|
-
|
|
1394
1322
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1395
1323
|
|
|
1396
1324
|
---
|
|
@@ -1423,10 +1351,6 @@ export interface RequestSyncChunkArgs {
|
|
|
1423
1351
|
}
|
|
1424
1352
|
```
|
|
1425
1353
|
|
|
1426
|
-
<details>
|
|
1427
|
-
|
|
1428
|
-
<summary>Interface RequestSyncChunkArgs Details</summary>
|
|
1429
|
-
|
|
1430
1354
|
###### Property fromStorageIdentityKey
|
|
1431
1355
|
|
|
1432
1356
|
The storageIdentityKey of the storage supplying the update SyncChunk data.
|
|
@@ -1505,8 +1429,6 @@ The storageIdentityKey of the storage consuming the update SyncChunk data.
|
|
|
1505
1429
|
toStorageIdentityKey: string
|
|
1506
1430
|
```
|
|
1507
1431
|
|
|
1508
|
-
</details>
|
|
1509
|
-
|
|
1510
1432
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1511
1433
|
|
|
1512
1434
|
---
|
|
@@ -1554,11 +1476,7 @@ export interface SetupEnv {
|
|
|
1554
1476
|
}
|
|
1555
1477
|
```
|
|
1556
1478
|
|
|
1557
|
-
See also: [Chain](#type-chain)
|
|
1558
|
-
|
|
1559
|
-
<details>
|
|
1560
|
-
|
|
1561
|
-
<summary>Interface SetupEnv Details</summary>
|
|
1479
|
+
See also: [Chain](./client.md#type-chain)
|
|
1562
1480
|
|
|
1563
1481
|
###### Property chain
|
|
1564
1482
|
|
|
@@ -1567,7 +1485,7 @@ The chan being accessed: 'main' for mainnet, 'test' for 'testnet'.
|
|
|
1567
1485
|
```ts
|
|
1568
1486
|
chain: sdk.Chain
|
|
1569
1487
|
```
|
|
1570
|
-
See also: [Chain](#type-chain)
|
|
1488
|
+
See also: [Chain](./client.md#type-chain)
|
|
1571
1489
|
|
|
1572
1490
|
###### Property devKeys
|
|
1573
1491
|
|
|
@@ -1610,8 +1528,6 @@ A vaild TAAL API key for use by `Services`
|
|
|
1610
1528
|
taalApiKey: string
|
|
1611
1529
|
```
|
|
1612
1530
|
|
|
1613
|
-
</details>
|
|
1614
|
-
|
|
1615
1531
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1616
1532
|
|
|
1617
1533
|
---
|
|
@@ -1636,11 +1552,7 @@ export interface SetupWallet {
|
|
|
1636
1552
|
}
|
|
1637
1553
|
```
|
|
1638
1554
|
|
|
1639
|
-
See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
1640
|
-
|
|
1641
|
-
<details>
|
|
1642
|
-
|
|
1643
|
-
<summary>Interface SetupWallet Details</summary>
|
|
1555
|
+
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)
|
|
1644
1556
|
|
|
1645
1557
|
###### Property chain
|
|
1646
1558
|
|
|
@@ -1649,7 +1561,7 @@ The chain ('main' or 'test') which the wallet accesses.
|
|
|
1649
1561
|
```ts
|
|
1650
1562
|
chain: sdk.Chain
|
|
1651
1563
|
```
|
|
1652
|
-
See also: [Chain](#type-chain)
|
|
1564
|
+
See also: [Chain](./client.md#type-chain)
|
|
1653
1565
|
|
|
1654
1566
|
###### Property identityKey
|
|
1655
1567
|
|
|
@@ -1675,7 +1587,7 @@ that speed up wallet operations and maintain data integrity.
|
|
|
1675
1587
|
```ts
|
|
1676
1588
|
monitor: Monitor
|
|
1677
1589
|
```
|
|
1678
|
-
See also: [Monitor](#class-monitor)
|
|
1590
|
+
See also: [Monitor](./monitor.md#class-monitor)
|
|
1679
1591
|
|
|
1680
1592
|
###### Property rootKey
|
|
1681
1593
|
|
|
@@ -1693,7 +1605,7 @@ on the public network.
|
|
|
1693
1605
|
```ts
|
|
1694
1606
|
services: Services
|
|
1695
1607
|
```
|
|
1696
|
-
See also: [Services](#class-services)
|
|
1608
|
+
See also: [Services](./services.md#class-services)
|
|
1697
1609
|
|
|
1698
1610
|
###### Property storage
|
|
1699
1611
|
|
|
@@ -1703,7 +1615,7 @@ accessed by the wallet.
|
|
|
1703
1615
|
```ts
|
|
1704
1616
|
storage: WalletStorageManager
|
|
1705
1617
|
```
|
|
1706
|
-
See also: [WalletStorageManager](#class-walletstoragemanager)
|
|
1618
|
+
See also: [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
1707
1619
|
|
|
1708
1620
|
###### Property wallet
|
|
1709
1621
|
|
|
@@ -1717,9 +1629,7 @@ components after construction may disrupt the normal operation of the wallet.
|
|
|
1717
1629
|
```ts
|
|
1718
1630
|
wallet: Wallet
|
|
1719
1631
|
```
|
|
1720
|
-
See also: [Wallet](#class-wallet)
|
|
1721
|
-
|
|
1722
|
-
</details>
|
|
1632
|
+
See also: [Wallet](./client.md#class-wallet)
|
|
1723
1633
|
|
|
1724
1634
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1725
1635
|
|
|
@@ -1746,11 +1656,7 @@ export interface SetupWalletArgs {
|
|
|
1746
1656
|
}
|
|
1747
1657
|
```
|
|
1748
1658
|
|
|
1749
|
-
See also: [SetupEnv](#interface-setupenv), [WalletStorageProvider](#interface-walletstorageprovider)
|
|
1750
|
-
|
|
1751
|
-
<details>
|
|
1752
|
-
|
|
1753
|
-
<summary>Interface SetupWalletArgs Details</summary>
|
|
1659
|
+
See also: [SetupEnv](./setup.md#interface-setupenv), [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
1754
1660
|
|
|
1755
1661
|
###### Property active
|
|
1756
1662
|
|
|
@@ -1759,7 +1665,7 @@ Optional. Active wallet storage. Can be added later.
|
|
|
1759
1665
|
```ts
|
|
1760
1666
|
active?: sdk.WalletStorageProvider
|
|
1761
1667
|
```
|
|
1762
|
-
See also: [WalletStorageProvider](#interface-walletstorageprovider)
|
|
1668
|
+
See also: [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
1763
1669
|
|
|
1764
1670
|
###### Property backups
|
|
1765
1671
|
|
|
@@ -1768,7 +1674,7 @@ Optional. One or more storage providers managed as backup destinations. Can be a
|
|
|
1768
1674
|
```ts
|
|
1769
1675
|
backups?: sdk.WalletStorageProvider[]
|
|
1770
1676
|
```
|
|
1771
|
-
See also: [WalletStorageProvider](#interface-walletstorageprovider)
|
|
1677
|
+
See also: [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
1772
1678
|
|
|
1773
1679
|
###### Property env
|
|
1774
1680
|
|
|
@@ -1777,7 +1683,7 @@ Configuration "secrets" typically obtained by `Setup.makeEnv` and `Setup.getEnv`
|
|
|
1777
1683
|
```ts
|
|
1778
1684
|
env: SetupEnv
|
|
1779
1685
|
```
|
|
1780
|
-
See also: [SetupEnv](#interface-setupenv)
|
|
1686
|
+
See also: [SetupEnv](./setup.md#interface-setupenv)
|
|
1781
1687
|
|
|
1782
1688
|
###### Property privKeyHex
|
|
1783
1689
|
|
|
@@ -1797,8 +1703,6 @@ Defaults to `env.devKeys[env.identityKey]
|
|
|
1797
1703
|
rootKeyHex?: string
|
|
1798
1704
|
```
|
|
1799
1705
|
|
|
1800
|
-
</details>
|
|
1801
|
-
|
|
1802
1706
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1803
1707
|
|
|
1804
1708
|
---
|
|
@@ -1812,11 +1716,7 @@ export interface SetupWalletClient extends SetupWallet {
|
|
|
1812
1716
|
}
|
|
1813
1717
|
```
|
|
1814
1718
|
|
|
1815
|
-
See also: [SetupWallet](#interface-setupwallet)
|
|
1816
|
-
|
|
1817
|
-
<details>
|
|
1818
|
-
|
|
1819
|
-
<summary>Interface SetupWalletClient Details</summary>
|
|
1719
|
+
See also: [SetupWallet](./setup.md#interface-setupwallet)
|
|
1820
1720
|
|
|
1821
1721
|
###### Property endpointUrl
|
|
1822
1722
|
|
|
@@ -1828,8 +1728,6 @@ the active storage provider of the wallet.
|
|
|
1828
1728
|
endpointUrl: string
|
|
1829
1729
|
```
|
|
1830
1730
|
|
|
1831
|
-
</details>
|
|
1832
|
-
|
|
1833
1731
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1834
1732
|
|
|
1835
1733
|
---
|
|
@@ -1844,11 +1742,7 @@ export interface SetupWalletClientArgs extends SetupWalletArgs {
|
|
|
1844
1742
|
}
|
|
1845
1743
|
```
|
|
1846
1744
|
|
|
1847
|
-
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
1848
|
-
|
|
1849
|
-
<details>
|
|
1850
|
-
|
|
1851
|
-
<summary>Interface SetupWalletClientArgs Details</summary>
|
|
1745
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
1852
1746
|
|
|
1853
1747
|
###### Property endpointUrl
|
|
1854
1748
|
|
|
@@ -1860,8 +1754,6 @@ the active storage provider of the newly created wallet.
|
|
|
1860
1754
|
endpointUrl?: string
|
|
1861
1755
|
```
|
|
1862
1756
|
|
|
1863
|
-
</details>
|
|
1864
|
-
|
|
1865
1757
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1866
1758
|
|
|
1867
1759
|
---
|
|
@@ -1880,7 +1772,7 @@ export interface StorageCreateActionResult {
|
|
|
1880
1772
|
}
|
|
1881
1773
|
```
|
|
1882
1774
|
|
|
1883
|
-
See also: [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput), [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput)
|
|
1775
|
+
See also: [StorageCreateTransactionSdkInput](./client.md#interface-storagecreatetransactionsdkinput), [StorageCreateTransactionSdkOutput](./client.md#interface-storagecreatetransactionsdkoutput)
|
|
1884
1776
|
|
|
1885
1777
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1886
1778
|
|
|
@@ -1904,7 +1796,7 @@ export interface StorageCreateTransactionSdkInput {
|
|
|
1904
1796
|
}
|
|
1905
1797
|
```
|
|
1906
1798
|
|
|
1907
|
-
See also: [StorageProvidedBy](#type-storageprovidedby)
|
|
1799
|
+
See also: [StorageProvidedBy](./client.md#type-storageprovidedby)
|
|
1908
1800
|
|
|
1909
1801
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1910
1802
|
|
|
@@ -1920,7 +1812,7 @@ export interface StorageCreateTransactionSdkOutput extends sdk.ValidCreateAction
|
|
|
1920
1812
|
}
|
|
1921
1813
|
```
|
|
1922
1814
|
|
|
1923
|
-
See also: [StorageProvidedBy](#type-storageprovidedby), [ValidCreateActionOutput](#interface-validcreateactionoutput)
|
|
1815
|
+
See also: [StorageProvidedBy](./client.md#type-storageprovidedby), [ValidCreateActionOutput](./client.md#interface-validcreateactionoutput)
|
|
1924
1816
|
|
|
1925
1817
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1926
1818
|
|
|
@@ -1936,10 +1828,6 @@ export interface StorageFeeModel {
|
|
|
1936
1828
|
}
|
|
1937
1829
|
```
|
|
1938
1830
|
|
|
1939
|
-
<details>
|
|
1940
|
-
|
|
1941
|
-
<summary>Interface StorageFeeModel Details</summary>
|
|
1942
|
-
|
|
1943
1831
|
###### Property model
|
|
1944
1832
|
|
|
1945
1833
|
Available models. Currently only "sat/kb" is supported.
|
|
@@ -1959,8 +1847,6 @@ If undefined, the default value is used.
|
|
|
1959
1847
|
value?: number
|
|
1960
1848
|
```
|
|
1961
1849
|
|
|
1962
|
-
</details>
|
|
1963
|
-
|
|
1964
1850
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1965
1851
|
|
|
1966
1852
|
---
|
|
@@ -1978,10 +1864,6 @@ export interface StorageGetBeefOptions {
|
|
|
1978
1864
|
}
|
|
1979
1865
|
```
|
|
1980
1866
|
|
|
1981
|
-
<details>
|
|
1982
|
-
|
|
1983
|
-
<summary>Interface StorageGetBeefOptions Details</summary>
|
|
1984
|
-
|
|
1985
1867
|
###### Property ignoreNewProven
|
|
1986
1868
|
|
|
1987
1869
|
optional. Default is false. If true, raw transactions with proofs missing from `storage` and obtained from `getServices` are not inserted to `storage`.
|
|
@@ -2038,8 +1920,6 @@ if 'known', txids known to local storage as valid are included as txidOnly
|
|
|
2038
1920
|
trustSelf?: "known"
|
|
2039
1921
|
```
|
|
2040
1922
|
|
|
2041
|
-
</details>
|
|
2042
|
-
|
|
2043
1923
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2044
1924
|
|
|
2045
1925
|
---
|
|
@@ -2052,10 +1932,6 @@ export interface StorageIdentity {
|
|
|
2052
1932
|
}
|
|
2053
1933
|
```
|
|
2054
1934
|
|
|
2055
|
-
<details>
|
|
2056
|
-
|
|
2057
|
-
<summary>Interface StorageIdentity Details</summary>
|
|
2058
|
-
|
|
2059
1935
|
###### Property storageIdentityKey
|
|
2060
1936
|
|
|
2061
1937
|
The identity key (public key) assigned to this storage
|
|
@@ -2072,8 +1948,6 @@ The human readable name assigned to this storage.
|
|
|
2072
1948
|
storageName: string
|
|
2073
1949
|
```
|
|
2074
1950
|
|
|
2075
|
-
</details>
|
|
2076
|
-
|
|
2077
1951
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2078
1952
|
|
|
2079
1953
|
---
|
|
@@ -2087,10 +1961,6 @@ export interface StorageInternalizeActionResult extends InternalizeActionResult
|
|
|
2087
1961
|
}
|
|
2088
1962
|
```
|
|
2089
1963
|
|
|
2090
|
-
<details>
|
|
2091
|
-
|
|
2092
|
-
<summary>Interface StorageInternalizeActionResult Details</summary>
|
|
2093
|
-
|
|
2094
1964
|
###### Property isMerge
|
|
2095
1965
|
|
|
2096
1966
|
true if internalizing outputs on an existing storage transaction
|
|
@@ -2115,8 +1985,6 @@ txid of transaction being internalized
|
|
|
2115
1985
|
txid: string
|
|
2116
1986
|
```
|
|
2117
1987
|
|
|
2118
|
-
</details>
|
|
2119
|
-
|
|
2120
1988
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2121
1989
|
|
|
2122
1990
|
---
|
|
@@ -2155,11 +2023,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
2155
2023
|
|
|
2156
2024
|
```ts
|
|
2157
2025
|
export interface StorageProvenOrReq {
|
|
2158
|
-
proven?:
|
|
2159
|
-
req?:
|
|
2026
|
+
proven?: TableProvenTx;
|
|
2027
|
+
req?: TableProvenTxReq;
|
|
2160
2028
|
}
|
|
2161
2029
|
```
|
|
2162
2030
|
|
|
2031
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
2032
|
+
|
|
2163
2033
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2164
2034
|
|
|
2165
2035
|
---
|
|
@@ -2174,11 +2044,7 @@ export interface StorageProviderOptions extends StorageReaderWriterOptions {
|
|
|
2174
2044
|
}
|
|
2175
2045
|
```
|
|
2176
2046
|
|
|
2177
|
-
See also: [Chain](#type-chain), [StorageFeeModel](#interface-storagefeemodel), [StorageReaderWriterOptions](#interface-storagereaderwriteroptions)
|
|
2178
|
-
|
|
2179
|
-
<details>
|
|
2180
|
-
|
|
2181
|
-
<summary>Interface StorageProviderOptions Details</summary>
|
|
2047
|
+
See also: [Chain](./client.md#type-chain), [StorageFeeModel](./client.md#interface-storagefeemodel), [StorageReaderWriterOptions](./storage.md#interface-storagereaderwriteroptions)
|
|
2182
2048
|
|
|
2183
2049
|
###### Property commissionPubKeyHex
|
|
2184
2050
|
|
|
@@ -2199,8 +2065,6 @@ A value of zero disables commission fees.
|
|
|
2199
2065
|
commissionSatoshis: number
|
|
2200
2066
|
```
|
|
2201
2067
|
|
|
2202
|
-
</details>
|
|
2203
|
-
|
|
2204
2068
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2205
2069
|
|
|
2206
2070
|
---
|
|
@@ -2212,7 +2076,7 @@ export interface StorageReaderOptions {
|
|
|
2212
2076
|
}
|
|
2213
2077
|
```
|
|
2214
2078
|
|
|
2215
|
-
See also: [Chain](#type-chain)
|
|
2079
|
+
See also: [Chain](./client.md#type-chain)
|
|
2216
2080
|
|
|
2217
2081
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2218
2082
|
|
|
@@ -2224,7 +2088,7 @@ export interface StorageReaderWriterOptions extends StorageReaderOptions {
|
|
|
2224
2088
|
}
|
|
2225
2089
|
```
|
|
2226
2090
|
|
|
2227
|
-
See also: [StorageReaderOptions](#interface-storagereaderoptions)
|
|
2091
|
+
See also: [StorageReaderOptions](./storage.md#interface-storagereaderoptions)
|
|
2228
2092
|
|
|
2229
2093
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2230
2094
|
|
|
@@ -2236,28 +2100,28 @@ This is the minimal interface required for a WalletStorageProvider to export dat
|
|
|
2236
2100
|
```ts
|
|
2237
2101
|
export interface StorageSyncReader {
|
|
2238
2102
|
isAvailable(): boolean;
|
|
2239
|
-
makeAvailable(): Promise<
|
|
2103
|
+
makeAvailable(): Promise<TableSettings>;
|
|
2240
2104
|
destroy(): Promise<void>;
|
|
2241
|
-
getSettings():
|
|
2242
|
-
findUserByIdentityKey(key: string): Promise<
|
|
2243
|
-
findSyncStates(args: sdk.FindSyncStatesArgs): Promise<
|
|
2244
|
-
findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<
|
|
2245
|
-
findCertificates(args: sdk.FindCertificatesArgs): Promise<
|
|
2246
|
-
findCommissions(args: sdk.FindCommissionsArgs): Promise<
|
|
2247
|
-
findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<
|
|
2248
|
-
findOutputs(args: sdk.FindOutputsArgs): Promise<
|
|
2249
|
-
findOutputTags(args: sdk.FindOutputTagsArgs): Promise<
|
|
2250
|
-
findTransactions(args: sdk.FindTransactionsArgs): Promise<
|
|
2251
|
-
findTxLabels(args: sdk.FindTxLabelsArgs): Promise<
|
|
2252
|
-
getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
2253
|
-
getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
2254
|
-
getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
2255
|
-
getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
2105
|
+
getSettings(): TableSettings;
|
|
2106
|
+
findUserByIdentityKey(key: string): Promise<TableUser | undefined>;
|
|
2107
|
+
findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>;
|
|
2108
|
+
findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<TableCertificateField[]>;
|
|
2109
|
+
findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>;
|
|
2110
|
+
findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>;
|
|
2111
|
+
findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
2112
|
+
findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
2113
|
+
findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>;
|
|
2114
|
+
findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>;
|
|
2115
|
+
findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>;
|
|
2116
|
+
getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTx[]>;
|
|
2117
|
+
getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTxReq[]>;
|
|
2118
|
+
getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableTxLabelMap[]>;
|
|
2119
|
+
getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableOutputTagMap[]>;
|
|
2256
2120
|
getSyncChunk(args: RequestSyncChunkArgs): Promise<SyncChunk>;
|
|
2257
2121
|
}
|
|
2258
2122
|
```
|
|
2259
2123
|
|
|
2260
|
-
See also: [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs), [FindCertificatesArgs](#interface-findcertificatesargs), [FindCommissionsArgs](#interface-findcommissionsargs), [FindForUserSincePagedArgs](#interface-findforusersincepagedargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputTagsArgs](#interface-findoutputtagsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindSyncStatesArgs](#interface-findsyncstatesargs), [FindTransactionsArgs](#interface-findtransactionsargs), [FindTxLabelsArgs](#interface-findtxlabelsargs), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [SyncChunk](#interface-syncchunk), [getSyncChunk](#function-getsyncchunk)
|
|
2124
|
+
See also: [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
2261
2125
|
|
|
2262
2126
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2263
2127
|
|
|
@@ -2270,7 +2134,7 @@ export interface StorageSyncReaderOptions {
|
|
|
2270
2134
|
}
|
|
2271
2135
|
```
|
|
2272
2136
|
|
|
2273
|
-
See also: [Chain](#type-chain)
|
|
2137
|
+
See also: [Chain](./client.md#type-chain)
|
|
2274
2138
|
|
|
2275
2139
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2276
2140
|
|
|
@@ -2284,89 +2148,89 @@ export interface StorageSyncReaderWriter extends sdk.StorageSyncReader {
|
|
|
2284
2148
|
getProvenOrRawTx(txid: string, trx?: sdk.TrxToken): Promise<sdk.ProvenOrRawTx>;
|
|
2285
2149
|
purgeData(params: sdk.PurgeParams, trx?: sdk.TrxToken): Promise<sdk.PurgeResults>;
|
|
2286
2150
|
transaction<T>(scope: (trx: sdk.TrxToken) => Promise<T>, trx?: sdk.TrxToken): Promise<T>;
|
|
2287
|
-
findOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<
|
|
2288
|
-
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<
|
|
2289
|
-
findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<
|
|
2290
|
-
findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<
|
|
2151
|
+
findOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<TableOutputTagMap[]>;
|
|
2152
|
+
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
|
|
2153
|
+
findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<TableProvenTx[]>;
|
|
2154
|
+
findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<TableTxLabelMap[]>;
|
|
2291
2155
|
countOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<number>;
|
|
2292
2156
|
countProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<number>;
|
|
2293
2157
|
countProvenTxs(args: sdk.FindProvenTxsArgs): Promise<number>;
|
|
2294
2158
|
countTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<number>;
|
|
2295
|
-
insertProvenTx(tx:
|
|
2296
|
-
insertProvenTxReq(tx:
|
|
2297
|
-
insertUser(user:
|
|
2298
|
-
insertCertificate(certificate:
|
|
2299
|
-
insertCertificateField(certificateField:
|
|
2300
|
-
insertOutputBasket(basket:
|
|
2301
|
-
insertTransaction(tx:
|
|
2302
|
-
insertCommission(commission:
|
|
2303
|
-
insertOutput(output:
|
|
2304
|
-
insertOutputTag(tag:
|
|
2305
|
-
insertOutputTagMap(tagMap:
|
|
2306
|
-
insertTxLabel(label:
|
|
2307
|
-
insertTxLabelMap(labelMap:
|
|
2308
|
-
insertSyncState(syncState:
|
|
2309
|
-
updateCertificateField(certificateId: number, fieldName: string, update: Partial<
|
|
2310
|
-
updateCertificate(id: number, update: Partial<
|
|
2311
|
-
updateCommission(id: number, update: Partial<
|
|
2312
|
-
updateOutputBasket(id: number, update: Partial<
|
|
2313
|
-
updateOutput(id: number, update: Partial<
|
|
2314
|
-
updateOutputTagMap(outputId: number, tagId: number, update: Partial<
|
|
2315
|
-
updateOutputTag(id: number, update: Partial<
|
|
2316
|
-
updateProvenTxReq(id: number | number[], update: Partial<
|
|
2317
|
-
updateProvenTxReqDynamics(id: number, update: Partial<
|
|
2159
|
+
insertProvenTx(tx: TableProvenTx, trx?: sdk.TrxToken): Promise<number>;
|
|
2160
|
+
insertProvenTxReq(tx: TableProvenTxReq, trx?: sdk.TrxToken): Promise<number>;
|
|
2161
|
+
insertUser(user: TableUser, trx?: sdk.TrxToken): Promise<number>;
|
|
2162
|
+
insertCertificate(certificate: TableCertificate, trx?: sdk.TrxToken): Promise<number>;
|
|
2163
|
+
insertCertificateField(certificateField: TableCertificateField, trx?: sdk.TrxToken): Promise<void>;
|
|
2164
|
+
insertOutputBasket(basket: TableOutputBasket, trx?: sdk.TrxToken): Promise<number>;
|
|
2165
|
+
insertTransaction(tx: TableTransaction, trx?: sdk.TrxToken): Promise<number>;
|
|
2166
|
+
insertCommission(commission: TableCommission, trx?: sdk.TrxToken): Promise<number>;
|
|
2167
|
+
insertOutput(output: TableOutput, trx?: sdk.TrxToken): Promise<number>;
|
|
2168
|
+
insertOutputTag(tag: TableOutputTag, trx?: sdk.TrxToken): Promise<number>;
|
|
2169
|
+
insertOutputTagMap(tagMap: TableOutputTagMap, trx?: sdk.TrxToken): Promise<void>;
|
|
2170
|
+
insertTxLabel(label: TableTxLabel, trx?: sdk.TrxToken): Promise<number>;
|
|
2171
|
+
insertTxLabelMap(labelMap: TableTxLabelMap, trx?: sdk.TrxToken): Promise<void>;
|
|
2172
|
+
insertSyncState(syncState: TableSyncState, trx?: sdk.TrxToken): Promise<number>;
|
|
2173
|
+
updateCertificateField(certificateId: number, fieldName: string, update: Partial<TableCertificateField>, trx?: sdk.TrxToken): Promise<number>;
|
|
2174
|
+
updateCertificate(id: number, update: Partial<TableCertificate>, trx?: sdk.TrxToken): Promise<number>;
|
|
2175
|
+
updateCommission(id: number, update: Partial<TableCommission>, trx?: sdk.TrxToken): Promise<number>;
|
|
2176
|
+
updateOutputBasket(id: number, update: Partial<TableOutputBasket>, trx?: sdk.TrxToken): Promise<number>;
|
|
2177
|
+
updateOutput(id: number, update: Partial<TableOutput>, trx?: sdk.TrxToken): Promise<number>;
|
|
2178
|
+
updateOutputTagMap(outputId: number, tagId: number, update: Partial<TableOutputTagMap>, trx?: sdk.TrxToken): Promise<number>;
|
|
2179
|
+
updateOutputTag(id: number, update: Partial<TableOutputTag>, trx?: sdk.TrxToken): Promise<number>;
|
|
2180
|
+
updateProvenTxReq(id: number | number[], update: Partial<TableProvenTxReq>, trx?: sdk.TrxToken): Promise<number>;
|
|
2181
|
+
updateProvenTxReqDynamics(id: number, update: Partial<TableProvenTxReqDynamics>, trx?: sdk.TrxToken): Promise<number>;
|
|
2318
2182
|
updateProvenTxReqWithNewProvenTx(args: sdk.UpdateProvenTxReqWithNewProvenTxArgs): Promise<sdk.UpdateProvenTxReqWithNewProvenTxResult>;
|
|
2319
|
-
updateProvenTx(id: number, update: Partial<
|
|
2320
|
-
updateSyncState(id: number, update: Partial<
|
|
2321
|
-
updateTransaction(id: number | number[], update: Partial<
|
|
2183
|
+
updateProvenTx(id: number, update: Partial<TableProvenTx>, trx?: sdk.TrxToken): Promise<number>;
|
|
2184
|
+
updateSyncState(id: number, update: Partial<TableSyncState>, trx?: sdk.TrxToken): Promise<number>;
|
|
2185
|
+
updateTransaction(id: number | number[], update: Partial<TableTransaction>, trx?: sdk.TrxToken): Promise<number>;
|
|
2322
2186
|
updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: number, userId?: number, reference?: string, trx?: sdk.TrxToken): Promise<void>;
|
|
2323
2187
|
updateTransactionsStatus(transactionIds: number[], status: sdk.TransactionStatus): Promise<void>;
|
|
2324
|
-
updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<
|
|
2325
|
-
updateTxLabel(id: number, update: Partial<
|
|
2326
|
-
updateUser(id: number, update: Partial<
|
|
2327
|
-
findCertificateById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2328
|
-
findCommissionById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2329
|
-
findOutputById(id: number, trx?: sdk.TrxToken, noScript?: boolean): Promise<
|
|
2330
|
-
findOutputBasketById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2331
|
-
findProvenTxById(id: number, trx?: sdk.TrxToken | undefined): Promise<
|
|
2332
|
-
findProvenTxReqById(id: number, trx?: sdk.TrxToken | undefined): Promise<
|
|
2333
|
-
findSyncStateById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2334
|
-
findTransactionById(id: number, trx?: sdk.TrxToken, noRawTx?: boolean): Promise<
|
|
2335
|
-
findTxLabelById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2336
|
-
findOutputTagById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2337
|
-
findUserById(id: number, trx?: sdk.TrxToken): Promise<
|
|
2188
|
+
updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<TableTxLabelMap>, trx?: sdk.TrxToken): Promise<number>;
|
|
2189
|
+
updateTxLabel(id: number, update: Partial<TableTxLabel>, trx?: sdk.TrxToken): Promise<number>;
|
|
2190
|
+
updateUser(id: number, update: Partial<TableUser>, trx?: sdk.TrxToken): Promise<number>;
|
|
2191
|
+
findCertificateById(id: number, trx?: sdk.TrxToken): Promise<TableCertificate | undefined>;
|
|
2192
|
+
findCommissionById(id: number, trx?: sdk.TrxToken): Promise<TableCommission | undefined>;
|
|
2193
|
+
findOutputById(id: number, trx?: sdk.TrxToken, noScript?: boolean): Promise<TableOutput | undefined>;
|
|
2194
|
+
findOutputBasketById(id: number, trx?: sdk.TrxToken): Promise<TableOutputBasket | undefined>;
|
|
2195
|
+
findProvenTxById(id: number, trx?: sdk.TrxToken | undefined): Promise<TableProvenTx | undefined>;
|
|
2196
|
+
findProvenTxReqById(id: number, trx?: sdk.TrxToken | undefined): Promise<TableProvenTxReq | undefined>;
|
|
2197
|
+
findSyncStateById(id: number, trx?: sdk.TrxToken): Promise<TableSyncState | undefined>;
|
|
2198
|
+
findTransactionById(id: number, trx?: sdk.TrxToken, noRawTx?: boolean): Promise<TableTransaction | undefined>;
|
|
2199
|
+
findTxLabelById(id: number, trx?: sdk.TrxToken): Promise<TableTxLabel | undefined>;
|
|
2200
|
+
findOutputTagById(id: number, trx?: sdk.TrxToken): Promise<TableOutputTag | undefined>;
|
|
2201
|
+
findUserById(id: number, trx?: sdk.TrxToken): Promise<TableUser | undefined>;
|
|
2338
2202
|
findOrInsertUser(identityKey: string, trx?: sdk.TrxToken): Promise<{
|
|
2339
|
-
user:
|
|
2203
|
+
user: TableUser;
|
|
2340
2204
|
isNew: boolean;
|
|
2341
2205
|
}>;
|
|
2342
|
-
findOrInsertTransaction(newTx:
|
|
2343
|
-
tx:
|
|
2206
|
+
findOrInsertTransaction(newTx: TableTransaction, trx?: sdk.TrxToken): Promise<{
|
|
2207
|
+
tx: TableTransaction;
|
|
2344
2208
|
isNew: boolean;
|
|
2345
2209
|
}>;
|
|
2346
|
-
findOrInsertOutputBasket(userId: number, name: string, trx?: sdk.TrxToken): Promise<
|
|
2347
|
-
findOrInsertTxLabel(userId: number, label: string, trx?: sdk.TrxToken): Promise<
|
|
2348
|
-
findOrInsertTxLabelMap(transactionId: number, txLabelId: number, trx?: sdk.TrxToken): Promise<
|
|
2349
|
-
findOrInsertOutputTag(userId: number, tag: string, trx?: sdk.TrxToken): Promise<
|
|
2350
|
-
findOrInsertOutputTagMap(outputId: number, outputTagId: number, trx?: sdk.TrxToken): Promise<
|
|
2210
|
+
findOrInsertOutputBasket(userId: number, name: string, trx?: sdk.TrxToken): Promise<TableOutputBasket>;
|
|
2211
|
+
findOrInsertTxLabel(userId: number, label: string, trx?: sdk.TrxToken): Promise<TableTxLabel>;
|
|
2212
|
+
findOrInsertTxLabelMap(transactionId: number, txLabelId: number, trx?: sdk.TrxToken): Promise<TableTxLabelMap>;
|
|
2213
|
+
findOrInsertOutputTag(userId: number, tag: string, trx?: sdk.TrxToken): Promise<TableOutputTag>;
|
|
2214
|
+
findOrInsertOutputTagMap(outputId: number, outputTagId: number, trx?: sdk.TrxToken): Promise<TableOutputTagMap>;
|
|
2351
2215
|
findOrInsertSyncStateAuth(auth: sdk.AuthId, storageIdentityKey: string, storageName: string): Promise<{
|
|
2352
|
-
syncState:
|
|
2216
|
+
syncState: TableSyncState;
|
|
2353
2217
|
isNew: boolean;
|
|
2354
2218
|
}>;
|
|
2355
|
-
findOrInsertProvenTxReq(newReq:
|
|
2356
|
-
req:
|
|
2219
|
+
findOrInsertProvenTxReq(newReq: TableProvenTxReq, trx?: sdk.TrxToken): Promise<{
|
|
2220
|
+
req: TableProvenTxReq;
|
|
2357
2221
|
isNew: boolean;
|
|
2358
2222
|
}>;
|
|
2359
|
-
findOrInsertProvenTx(newProven:
|
|
2360
|
-
proven:
|
|
2223
|
+
findOrInsertProvenTx(newProven: TableProvenTx, trx?: sdk.TrxToken): Promise<{
|
|
2224
|
+
proven: TableProvenTx;
|
|
2361
2225
|
isNew: boolean;
|
|
2362
2226
|
}>;
|
|
2363
|
-
findUsers(args: sdk.FindUsersArgs): Promise<
|
|
2364
|
-
tagOutput(partial: Partial<
|
|
2227
|
+
findUsers(args: sdk.FindUsersArgs): Promise<TableUser[]>;
|
|
2228
|
+
tagOutput(partial: Partial<TableOutput>, tag: string, trx?: sdk.TrxToken): Promise<void>;
|
|
2365
2229
|
processSyncChunk(args: sdk.RequestSyncChunkArgs, chunk: sdk.SyncChunk): Promise<sdk.ProcessSyncChunkResult>;
|
|
2366
2230
|
}
|
|
2367
2231
|
```
|
|
2368
2232
|
|
|
2369
|
-
See also: [AuthId](#interface-authid), [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [FindProvenTxsArgs](#interface-findproventxsargs), [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs), [FindUsersArgs](#interface-findusersargs), [ProcessSyncChunkResult](#interface-processsyncchunkresult), [ProvenOrRawTx](#interface-provenorrawtx), [PurgeParams](#interface-purgeparams), [PurgeResults](#interface-purgeresults), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageSyncReader](#class-storagesyncreader), [SyncChunk](#interface-syncchunk), [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult)
|
|
2233
|
+
See also: [AuthId](./client.md#interface-authid), [FindOutputTagMapsArgs](./client.md#interface-findoutputtagmapsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [FindProvenTxsArgs](./client.md#interface-findproventxsargs), [FindTxLabelMapsArgs](./client.md#interface-findtxlabelmapsargs), [FindUsersArgs](./client.md#interface-findusersargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageSyncReader](./storage.md#class-storagesyncreader), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [purgeData](./storage.md#function-purgedata)
|
|
2370
2234
|
|
|
2371
2235
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2372
2236
|
|
|
@@ -2384,22 +2248,24 @@ export interface SyncChunk {
|
|
|
2384
2248
|
fromStorageIdentityKey: string;
|
|
2385
2249
|
toStorageIdentityKey: string;
|
|
2386
2250
|
userIdentityKey: string;
|
|
2387
|
-
user?:
|
|
2388
|
-
provenTxs?:
|
|
2389
|
-
provenTxReqs?:
|
|
2390
|
-
outputBaskets?:
|
|
2391
|
-
txLabels?:
|
|
2392
|
-
outputTags?:
|
|
2393
|
-
transactions?:
|
|
2394
|
-
txLabelMaps?:
|
|
2395
|
-
commissions?:
|
|
2396
|
-
outputs?:
|
|
2397
|
-
outputTagMaps?:
|
|
2398
|
-
certificates?:
|
|
2399
|
-
certificateFields?:
|
|
2251
|
+
user?: TableUser;
|
|
2252
|
+
provenTxs?: TableProvenTx[];
|
|
2253
|
+
provenTxReqs?: TableProvenTxReq[];
|
|
2254
|
+
outputBaskets?: TableOutputBasket[];
|
|
2255
|
+
txLabels?: TableTxLabel[];
|
|
2256
|
+
outputTags?: TableOutputTag[];
|
|
2257
|
+
transactions?: TableTransaction[];
|
|
2258
|
+
txLabelMaps?: TableTxLabelMap[];
|
|
2259
|
+
commissions?: TableCommission[];
|
|
2260
|
+
outputs?: TableOutput[];
|
|
2261
|
+
outputTagMaps?: TableOutputTagMap[];
|
|
2262
|
+
certificates?: TableCertificate[];
|
|
2263
|
+
certificateFields?: TableCertificateField[];
|
|
2400
2264
|
}
|
|
2401
2265
|
```
|
|
2402
2266
|
|
|
2267
|
+
See also: [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser)
|
|
2268
|
+
|
|
2403
2269
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2404
2270
|
|
|
2405
2271
|
---
|
|
@@ -2434,7 +2300,7 @@ export interface TaskPurgeParams extends sdk.PurgeParams {
|
|
|
2434
2300
|
}
|
|
2435
2301
|
```
|
|
2436
2302
|
|
|
2437
|
-
See also: [PurgeParams](#interface-purgeparams)
|
|
2303
|
+
See also: [PurgeParams](./client.md#interface-purgeparams)
|
|
2438
2304
|
|
|
2439
2305
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2440
2306
|
|
|
@@ -2501,7 +2367,7 @@ export interface UpdateProvenTxReqWithNewProvenTxArgs {
|
|
|
2501
2367
|
}
|
|
2502
2368
|
```
|
|
2503
2369
|
|
|
2504
|
-
See also: [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
2370
|
+
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus)
|
|
2505
2371
|
|
|
2506
2372
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2507
2373
|
|
|
@@ -2517,7 +2383,7 @@ export interface UpdateProvenTxReqWithNewProvenTxResult {
|
|
|
2517
2383
|
}
|
|
2518
2384
|
```
|
|
2519
2385
|
|
|
2520
|
-
See also: [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
2386
|
+
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus)
|
|
2521
2387
|
|
|
2522
2388
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2523
2389
|
|
|
@@ -2530,7 +2396,7 @@ export interface ValidAbortActionArgs extends ValidWalletSignerArgs {
|
|
|
2530
2396
|
}
|
|
2531
2397
|
```
|
|
2532
2398
|
|
|
2533
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2399
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2534
2400
|
|
|
2535
2401
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2536
2402
|
|
|
@@ -2554,7 +2420,7 @@ export interface ValidAcquireCertificateArgs extends ValidWalletSignerArgs {
|
|
|
2554
2420
|
}
|
|
2555
2421
|
```
|
|
2556
2422
|
|
|
2557
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2423
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2558
2424
|
|
|
2559
2425
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2560
2426
|
|
|
@@ -2577,11 +2443,7 @@ export interface ValidAcquireDirectCertificateArgs extends ValidWalletSignerArgs
|
|
|
2577
2443
|
}
|
|
2578
2444
|
```
|
|
2579
2445
|
|
|
2580
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2581
|
-
|
|
2582
|
-
<details>
|
|
2583
|
-
|
|
2584
|
-
<summary>Interface ValidAcquireDirectCertificateArgs Details</summary>
|
|
2446
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2585
2447
|
|
|
2586
2448
|
###### Property subject
|
|
2587
2449
|
|
|
@@ -2592,8 +2454,6 @@ match expectations of keyringForSubject
|
|
|
2592
2454
|
subject: PubKeyHex
|
|
2593
2455
|
```
|
|
2594
2456
|
|
|
2595
|
-
</details>
|
|
2596
|
-
|
|
2597
2457
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2598
2458
|
|
|
2599
2459
|
---
|
|
@@ -2611,11 +2471,7 @@ export interface ValidAcquireIssuanceCertificateArgs extends ValidWalletSignerAr
|
|
|
2611
2471
|
}
|
|
2612
2472
|
```
|
|
2613
2473
|
|
|
2614
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2615
|
-
|
|
2616
|
-
<details>
|
|
2617
|
-
|
|
2618
|
-
<summary>Interface ValidAcquireIssuanceCertificateArgs Details</summary>
|
|
2474
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2619
2475
|
|
|
2620
2476
|
###### Property subject
|
|
2621
2477
|
|
|
@@ -2626,8 +2482,6 @@ match expectations of keyringForSubject
|
|
|
2626
2482
|
subject: PubKeyHex
|
|
2627
2483
|
```
|
|
2628
2484
|
|
|
2629
|
-
</details>
|
|
2630
|
-
|
|
2631
2485
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2632
2486
|
|
|
2633
2487
|
---
|
|
@@ -2661,7 +2515,7 @@ export interface ValidCreateActionArgs extends ValidProcessActionArgs {
|
|
|
2661
2515
|
}
|
|
2662
2516
|
```
|
|
2663
2517
|
|
|
2664
|
-
See also: [ValidCreateActionInput](#interface-validcreateactioninput), [ValidCreateActionOptions](#interface-validcreateactionoptions), [ValidCreateActionOutput](#interface-validcreateactionoutput), [ValidProcessActionArgs](#interface-validprocessactionargs)
|
|
2518
|
+
See also: [ValidCreateActionInput](./client.md#interface-validcreateactioninput), [ValidCreateActionOptions](./client.md#interface-validcreateactionoptions), [ValidCreateActionOutput](./client.md#interface-validcreateactionoutput), [ValidProcessActionArgs](./client.md#interface-validprocessactionargs)
|
|
2665
2519
|
|
|
2666
2520
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2667
2521
|
|
|
@@ -2678,7 +2532,7 @@ export interface ValidCreateActionInput {
|
|
|
2678
2532
|
}
|
|
2679
2533
|
```
|
|
2680
2534
|
|
|
2681
|
-
See also: [OutPoint](#interface-outpoint)
|
|
2535
|
+
See also: [OutPoint](./client.md#interface-outpoint)
|
|
2682
2536
|
|
|
2683
2537
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2684
2538
|
|
|
@@ -2695,7 +2549,7 @@ export interface ValidCreateActionOptions extends ValidProcessActionOptions {
|
|
|
2695
2549
|
}
|
|
2696
2550
|
```
|
|
2697
2551
|
|
|
2698
|
-
See also: [OutPoint](#interface-outpoint), [ValidProcessActionOptions](#interface-validprocessactionoptions)
|
|
2552
|
+
See also: [OutPoint](./client.md#interface-outpoint), [ValidProcessActionOptions](./client.md#interface-validprocessactionoptions)
|
|
2699
2553
|
|
|
2700
2554
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2701
2555
|
|
|
@@ -2727,7 +2581,7 @@ export interface ValidDiscoverByAttributesArgs extends ValidWalletSignerArgs {
|
|
|
2727
2581
|
}
|
|
2728
2582
|
```
|
|
2729
2583
|
|
|
2730
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2584
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2731
2585
|
|
|
2732
2586
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2733
2587
|
|
|
@@ -2743,7 +2597,7 @@ export interface ValidDiscoverByIdentityKeyArgs extends ValidWalletSignerArgs {
|
|
|
2743
2597
|
}
|
|
2744
2598
|
```
|
|
2745
2599
|
|
|
2746
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2600
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2747
2601
|
|
|
2748
2602
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2749
2603
|
|
|
@@ -2760,7 +2614,7 @@ export interface ValidInternalizeActionArgs extends ValidWalletSignerArgs {
|
|
|
2760
2614
|
}
|
|
2761
2615
|
```
|
|
2762
2616
|
|
|
2763
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2617
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2764
2618
|
|
|
2765
2619
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2766
2620
|
|
|
@@ -2776,7 +2630,7 @@ export interface ValidInternalizeOutput {
|
|
|
2776
2630
|
}
|
|
2777
2631
|
```
|
|
2778
2632
|
|
|
2779
|
-
See also: [ValidBasketInsertion](#interface-validbasketinsertion), [ValidWalletPayment](#interface-validwalletpayment)
|
|
2633
|
+
See also: [ValidBasketInsertion](./client.md#interface-validbasketinsertion), [ValidWalletPayment](./client.md#interface-validwalletpayment)
|
|
2780
2634
|
|
|
2781
2635
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2782
2636
|
|
|
@@ -2799,7 +2653,7 @@ export interface ValidListActionsArgs extends ValidWalletSignerArgs {
|
|
|
2799
2653
|
}
|
|
2800
2654
|
```
|
|
2801
2655
|
|
|
2802
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2656
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2803
2657
|
|
|
2804
2658
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2805
2659
|
|
|
@@ -2825,7 +2679,7 @@ export interface ValidListCertificatesArgs extends ValidWalletSignerArgs {
|
|
|
2825
2679
|
}
|
|
2826
2680
|
```
|
|
2827
2681
|
|
|
2828
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2682
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2829
2683
|
|
|
2830
2684
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2831
2685
|
|
|
@@ -2849,7 +2703,7 @@ export interface ValidListOutputsArgs extends ValidWalletSignerArgs {
|
|
|
2849
2703
|
}
|
|
2850
2704
|
```
|
|
2851
2705
|
|
|
2852
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2706
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2853
2707
|
|
|
2854
2708
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2855
2709
|
|
|
@@ -2866,7 +2720,7 @@ export interface ValidProcessActionArgs extends ValidWalletSignerArgs {
|
|
|
2866
2720
|
}
|
|
2867
2721
|
```
|
|
2868
2722
|
|
|
2869
|
-
See also: [ValidProcessActionOptions](#interface-validprocessactionoptions), [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2723
|
+
See also: [ValidProcessActionOptions](./client.md#interface-validprocessactionoptions), [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2870
2724
|
|
|
2871
2725
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2872
2726
|
|
|
@@ -2902,7 +2756,7 @@ export interface ValidProveCertificateArgs extends ValidWalletSignerArgs {
|
|
|
2902
2756
|
}
|
|
2903
2757
|
```
|
|
2904
2758
|
|
|
2905
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2759
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2906
2760
|
|
|
2907
2761
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2908
2762
|
|
|
@@ -2917,7 +2771,7 @@ export interface ValidRelinquishCertificateArgs extends ValidWalletSignerArgs {
|
|
|
2917
2771
|
}
|
|
2918
2772
|
```
|
|
2919
2773
|
|
|
2920
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2774
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2921
2775
|
|
|
2922
2776
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2923
2777
|
|
|
@@ -2931,7 +2785,7 @@ export interface ValidRelinquishOutputArgs extends ValidWalletSignerArgs {
|
|
|
2931
2785
|
}
|
|
2932
2786
|
```
|
|
2933
2787
|
|
|
2934
|
-
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2788
|
+
See also: [ValidWalletSignerArgs](./client.md#interface-validwalletsignerargs)
|
|
2935
2789
|
|
|
2936
2790
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2937
2791
|
|
|
@@ -2946,7 +2800,7 @@ export interface ValidSignActionArgs extends ValidProcessActionArgs {
|
|
|
2946
2800
|
}
|
|
2947
2801
|
```
|
|
2948
2802
|
|
|
2949
|
-
See also: [ValidProcessActionArgs](#interface-validprocessactionargs), [ValidSignActionOptions](#interface-validsignactionoptions)
|
|
2803
|
+
See also: [ValidProcessActionArgs](./client.md#interface-validprocessactionargs), [ValidSignActionOptions](./client.md#interface-validsignactionoptions)
|
|
2950
2804
|
|
|
2951
2805
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2952
2806
|
|
|
@@ -2962,7 +2816,7 @@ export interface ValidSignActionOptions extends ValidProcessActionOptions {
|
|
|
2962
2816
|
}
|
|
2963
2817
|
```
|
|
2964
2818
|
|
|
2965
|
-
See also: [ValidProcessActionOptions](#interface-validprocessactionoptions)
|
|
2819
|
+
See also: [ValidProcessActionOptions](./client.md#interface-validprocessactionoptions)
|
|
2966
2820
|
|
|
2967
2821
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2968
2822
|
|
|
@@ -3003,7 +2857,7 @@ export interface WalletArgs {
|
|
|
3003
2857
|
}
|
|
3004
2858
|
```
|
|
3005
2859
|
|
|
3006
|
-
See also: [Chain](#type-chain), [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [WalletServices](#interface-walletservices), [WalletStorageManager](#class-walletstoragemanager)
|
|
2860
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [WalletServices](./client.md#interface-walletservices), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
3007
2861
|
|
|
3008
2862
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3009
2863
|
|
|
@@ -3030,11 +2884,7 @@ export interface WalletServices {
|
|
|
3030
2884
|
}
|
|
3031
2885
|
```
|
|
3032
2886
|
|
|
3033
|
-
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathresult), [GetRawTxResult](#interface-getrawtxresult), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult), [PostBeefResult](#interface-postbeefresult), [PostTxsResult](#interface-posttxsresult)
|
|
3034
|
-
|
|
3035
|
-
<details>
|
|
3036
|
-
|
|
3037
|
-
<summary>Interface WalletServices Details</summary>
|
|
2887
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [PostBeefResult](./client.md#interface-postbeefresult), [PostTxsResult](./client.md#interface-posttxsresult)
|
|
3038
2888
|
|
|
3039
2889
|
###### Property chain
|
|
3040
2890
|
|
|
@@ -3043,7 +2893,7 @@ The chain being serviced.
|
|
|
3043
2893
|
```ts
|
|
3044
2894
|
chain: sdk.Chain
|
|
3045
2895
|
```
|
|
3046
|
-
See also: [Chain](#type-chain)
|
|
2896
|
+
See also: [Chain](./client.md#type-chain)
|
|
3047
2897
|
|
|
3048
2898
|
###### Method getBsvExchangeRate
|
|
3049
2899
|
|
|
@@ -3114,7 +2964,7 @@ Increments to next configured service and tries again until all services have be
|
|
|
3114
2964
|
```ts
|
|
3115
2965
|
getMerklePath(txid: string, useNext?: boolean): Promise<GetMerklePathResult>
|
|
3116
2966
|
```
|
|
3117
|
-
See also: [GetMerklePathResult](#interface-getmerklepathresult)
|
|
2967
|
+
See also: [GetMerklePathResult](./client.md#interface-getmerklepathresult)
|
|
3118
2968
|
|
|
3119
2969
|
Argument Details
|
|
3120
2970
|
|
|
@@ -3144,7 +2994,7 @@ Increments to next configured service and tries again until all services have be
|
|
|
3144
2994
|
```ts
|
|
3145
2995
|
getRawTx(txid: string, useNext?: boolean): Promise<GetRawTxResult>
|
|
3146
2996
|
```
|
|
3147
|
-
See also: [GetRawTxResult](#interface-getrawtxresult)
|
|
2997
|
+
See also: [GetRawTxResult](./client.md#interface-getrawtxresult)
|
|
3148
2998
|
|
|
3149
2999
|
Argument Details
|
|
3150
3000
|
|
|
@@ -3162,7 +3012,7 @@ Cycles through configured transaction processing services attempting to get a va
|
|
|
3162
3012
|
```ts
|
|
3163
3013
|
getUtxoStatus(output: string, outputFormat?: GetUtxoStatusOutputFormat, useNext?: boolean): Promise<GetUtxoStatusResult>
|
|
3164
3014
|
```
|
|
3165
|
-
See also: [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult)
|
|
3015
|
+
See also: [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
3166
3016
|
|
|
3167
3017
|
Argument Details
|
|
3168
3018
|
|
|
@@ -3184,7 +3034,7 @@ undefined if length of `output` is 32 then 'hashBE`, otherwise 'script'.
|
|
|
3184
3034
|
```ts
|
|
3185
3035
|
hashToHeader(hash: string): Promise<sdk.BlockHeader>
|
|
3186
3036
|
```
|
|
3187
|
-
See also: [BlockHeader](#interface-blockheader)
|
|
3037
|
+
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
3188
3038
|
|
|
3189
3039
|
Returns
|
|
3190
3040
|
|
|
@@ -3210,8 +3060,6 @@ Argument Details
|
|
|
3210
3060
|
+ **txOrLockTime**
|
|
3211
3061
|
+ either a bitcoin locktime value or hex, binary, un-encoded Transaction
|
|
3212
3062
|
|
|
3213
|
-
</details>
|
|
3214
|
-
|
|
3215
3063
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3216
3064
|
|
|
3217
3065
|
---
|
|
@@ -3232,7 +3080,7 @@ export interface WalletServicesOptions {
|
|
|
3232
3080
|
}
|
|
3233
3081
|
```
|
|
3234
3082
|
|
|
3235
|
-
See also: [BsvExchangeRate](#interface-bsvexchangerate), [Chain](#type-chain), [FiatExchangeRates](#interface-fiatexchangerates)
|
|
3083
|
+
See also: [BsvExchangeRate](./client.md#interface-bsvexchangerate), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates)
|
|
3236
3084
|
|
|
3237
3085
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3238
3086
|
|
|
@@ -3247,7 +3095,7 @@ export interface WalletSigner {
|
|
|
3247
3095
|
}
|
|
3248
3096
|
```
|
|
3249
3097
|
|
|
3250
|
-
See also: [Chain](#type-chain)
|
|
3098
|
+
See also: [Chain](./client.md#type-chain)
|
|
3251
3099
|
|
|
3252
3100
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3253
3101
|
|
|
@@ -3264,39 +3112,35 @@ and it is left to the providers: physical access or remote channel authenticatio
|
|
|
3264
3112
|
export interface WalletStorage {
|
|
3265
3113
|
isStorageProvider(): boolean;
|
|
3266
3114
|
isAvailable(): boolean;
|
|
3267
|
-
makeAvailable(): Promise<
|
|
3115
|
+
makeAvailable(): Promise<TableSettings>;
|
|
3268
3116
|
migrate(storageName: string, storageIdentityKey: string): Promise<string>;
|
|
3269
3117
|
destroy(): Promise<void>;
|
|
3270
3118
|
setServices(v: sdk.WalletServices): void;
|
|
3271
3119
|
getServices(): sdk.WalletServices;
|
|
3272
|
-
getSettings():
|
|
3120
|
+
getSettings(): TableSettings;
|
|
3273
3121
|
getAuth(): Promise<sdk.AuthId>;
|
|
3274
3122
|
findOrInsertUser(identityKey: string): Promise<{
|
|
3275
|
-
user:
|
|
3123
|
+
user: TableUser;
|
|
3276
3124
|
isNew: boolean;
|
|
3277
3125
|
}>;
|
|
3278
3126
|
abortAction(args: AbortActionArgs): Promise<AbortActionResult>;
|
|
3279
3127
|
createAction(args: sdk.ValidCreateActionArgs): Promise<sdk.StorageCreateActionResult>;
|
|
3280
3128
|
processAction(args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>;
|
|
3281
3129
|
internalizeAction(args: InternalizeActionArgs): Promise<InternalizeActionResult>;
|
|
3282
|
-
findCertificates(args: sdk.FindCertificatesArgs): Promise<
|
|
3283
|
-
findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<
|
|
3284
|
-
findOutputs(args: sdk.FindOutputsArgs): Promise<
|
|
3285
|
-
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<
|
|
3130
|
+
findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>;
|
|
3131
|
+
findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
3132
|
+
findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
3133
|
+
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
|
|
3286
3134
|
listActions(args: ListActionsArgs): Promise<ListActionsResult>;
|
|
3287
3135
|
listCertificates(args: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>;
|
|
3288
3136
|
listOutputs(args: ListOutputsArgs): Promise<ListOutputsResult>;
|
|
3289
|
-
insertCertificate(certificate:
|
|
3137
|
+
insertCertificate(certificate: TableCertificateX): Promise<number>;
|
|
3290
3138
|
relinquishCertificate(args: RelinquishCertificateArgs): Promise<number>;
|
|
3291
3139
|
relinquishOutput(args: RelinquishOutputArgs): Promise<number>;
|
|
3292
3140
|
}
|
|
3293
3141
|
```
|
|
3294
3142
|
|
|
3295
|
-
See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [WalletServices](#interface-walletservices), [createAction](#function-createaction), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
3296
|
-
|
|
3297
|
-
<details>
|
|
3298
|
-
|
|
3299
|
-
<summary>Interface WalletStorage Details</summary>
|
|
3143
|
+
See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [WalletServices](./client.md#interface-walletservices), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
|
|
3300
3144
|
|
|
3301
3145
|
###### Method isStorageProvider
|
|
3302
3146
|
|
|
@@ -3308,8 +3152,6 @@ Returns
|
|
|
3308
3152
|
|
|
3309
3153
|
false
|
|
3310
3154
|
|
|
3311
|
-
</details>
|
|
3312
|
-
|
|
3313
3155
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3314
3156
|
|
|
3315
3157
|
---
|
|
@@ -3325,11 +3167,7 @@ export interface WalletStorageProvider extends WalletStorageSync {
|
|
|
3325
3167
|
}
|
|
3326
3168
|
```
|
|
3327
3169
|
|
|
3328
|
-
See also: [WalletServices](#interface-walletservices), [WalletStorageSync](#interface-walletstoragesync)
|
|
3329
|
-
|
|
3330
|
-
<details>
|
|
3331
|
-
|
|
3332
|
-
<summary>Interface WalletStorageProvider Details</summary>
|
|
3170
|
+
See also: [WalletServices](./client.md#interface-walletservices), [WalletStorageSync](./client.md#interface-walletstoragesync)
|
|
3333
3171
|
|
|
3334
3172
|
###### Method isStorageProvider
|
|
3335
3173
|
|
|
@@ -3341,8 +3179,6 @@ Returns
|
|
|
3341
3179
|
|
|
3342
3180
|
true if this object's interface can be extended to the full `StorageProvider` interface
|
|
3343
3181
|
|
|
3344
|
-
</details>
|
|
3345
|
-
|
|
3346
3182
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3347
3183
|
|
|
3348
3184
|
---
|
|
@@ -3352,18 +3188,18 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3352
3188
|
export interface WalletStorageReader {
|
|
3353
3189
|
isAvailable(): boolean;
|
|
3354
3190
|
getServices(): sdk.WalletServices;
|
|
3355
|
-
getSettings():
|
|
3356
|
-
findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<
|
|
3357
|
-
findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<
|
|
3358
|
-
findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<
|
|
3359
|
-
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<
|
|
3191
|
+
getSettings(): TableSettings;
|
|
3192
|
+
findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>;
|
|
3193
|
+
findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
3194
|
+
findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
3195
|
+
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
|
|
3360
3196
|
listActions(auth: sdk.AuthId, vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>;
|
|
3361
3197
|
listCertificates(auth: sdk.AuthId, vargs: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>;
|
|
3362
3198
|
listOutputs(auth: sdk.AuthId, vargs: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>;
|
|
3363
3199
|
}
|
|
3364
3200
|
```
|
|
3365
3201
|
|
|
3366
|
-
See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [ValidListActionsArgs](#interface-validlistactionsargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [ValidListOutputsArgs](#interface-validlistoutputsargs), [WalletServices](#interface-walletservices), [listCertificates](#function-listcertificates)
|
|
3202
|
+
See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [TableCertificate](./storage.md#interface-tablecertificate), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs)
|
|
3367
3203
|
|
|
3368
3204
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3369
3205
|
|
|
@@ -3373,7 +3209,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3373
3209
|
```ts
|
|
3374
3210
|
export interface WalletStorageSync extends WalletStorageWriter {
|
|
3375
3211
|
findOrInsertSyncStateAuth(auth: sdk.AuthId, storageIdentityKey: string, storageName: string): Promise<{
|
|
3376
|
-
syncState:
|
|
3212
|
+
syncState: TableSyncState;
|
|
3377
3213
|
isNew: boolean;
|
|
3378
3214
|
}>;
|
|
3379
3215
|
setActive(auth: sdk.AuthId, newActiveStorageIdentityKey: string): Promise<number>;
|
|
@@ -3382,7 +3218,7 @@ export interface WalletStorageSync extends WalletStorageWriter {
|
|
|
3382
3218
|
}
|
|
3383
3219
|
```
|
|
3384
3220
|
|
|
3385
|
-
See also: [AuthId](#interface-authid), [ProcessSyncChunkResult](#interface-processsyncchunkresult), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [SyncChunk](#interface-syncchunk), [WalletStorageWriter](#interface-walletstoragewriter), [getSyncChunk](#function-getsyncchunk)
|
|
3221
|
+
See also: [AuthId](./client.md#interface-authid), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [SyncChunk](./client.md#interface-syncchunk), [TableSyncState](./storage.md#interface-tablesyncstate), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
3386
3222
|
|
|
3387
3223
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3388
3224
|
|
|
@@ -3391,24 +3227,24 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3391
3227
|
|
|
3392
3228
|
```ts
|
|
3393
3229
|
export interface WalletStorageWriter extends WalletStorageReader {
|
|
3394
|
-
makeAvailable(): Promise<
|
|
3230
|
+
makeAvailable(): Promise<TableSettings>;
|
|
3395
3231
|
migrate(storageName: string, storageIdentityKey: string): Promise<string>;
|
|
3396
3232
|
destroy(): Promise<void>;
|
|
3397
3233
|
findOrInsertUser(identityKey: string): Promise<{
|
|
3398
|
-
user:
|
|
3234
|
+
user: TableUser;
|
|
3399
3235
|
isNew: boolean;
|
|
3400
3236
|
}>;
|
|
3401
3237
|
abortAction(auth: sdk.AuthId, args: AbortActionArgs): Promise<AbortActionResult>;
|
|
3402
3238
|
createAction(auth: sdk.AuthId, args: sdk.ValidCreateActionArgs): Promise<sdk.StorageCreateActionResult>;
|
|
3403
3239
|
processAction(auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>;
|
|
3404
3240
|
internalizeAction(auth: sdk.AuthId, args: InternalizeActionArgs): Promise<InternalizeActionResult>;
|
|
3405
|
-
insertCertificateAuth(auth: sdk.AuthId, certificate:
|
|
3241
|
+
insertCertificateAuth(auth: sdk.AuthId, certificate: TableCertificateX): Promise<number>;
|
|
3406
3242
|
relinquishCertificate(auth: sdk.AuthId, args: RelinquishCertificateArgs): Promise<number>;
|
|
3407
3243
|
relinquishOutput(auth: sdk.AuthId, args: RelinquishOutputArgs): Promise<number>;
|
|
3408
3244
|
}
|
|
3409
3245
|
```
|
|
3410
3246
|
|
|
3411
|
-
See also: [AuthId](#interface-authid), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [ValidCreateActionArgs](#interface-validcreateactionargs), [WalletStorageReader](#interface-walletstoragereader), [createAction](#function-createaction), [internalizeAction](#function-internalizeaction), [processAction](#function-processaction)
|
|
3247
|
+
See also: [AuthId](./client.md#interface-authid), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [WalletStorageReader](./client.md#interface-walletstoragereader), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [processAction](./storage.md#function-processaction)
|
|
3412
3248
|
|
|
3413
3249
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3414
3250
|
|
|
@@ -3425,7 +3261,7 @@ export interface XValidCreateActionOutput extends sdk.ValidCreateActionOutput {
|
|
|
3425
3261
|
}
|
|
3426
3262
|
```
|
|
3427
3263
|
|
|
3428
|
-
See also: [StorageProvidedBy](#type-storageprovidedby), [ValidCreateActionOutput](#interface-validcreateactionoutput)
|
|
3264
|
+
See also: [StorageProvidedBy](./client.md#type-storageprovidedby), [ValidCreateActionOutput](./client.md#interface-validcreateactionoutput)
|
|
3429
3265
|
|
|
3430
3266
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3431
3267
|
|
|
@@ -3495,11 +3331,7 @@ export class CertOps extends BsvCertificate {
|
|
|
3495
3331
|
}
|
|
3496
3332
|
```
|
|
3497
3333
|
|
|
3498
|
-
See also: [CertOpsWallet](#interface-certopswallet)
|
|
3499
|
-
|
|
3500
|
-
<details>
|
|
3501
|
-
|
|
3502
|
-
<summary>Class CertOps Details</summary>
|
|
3334
|
+
See also: [CertOpsWallet](./client.md#interface-certopswallet)
|
|
3503
3335
|
|
|
3504
3336
|
###### Method createKeyringForVerifier
|
|
3505
3337
|
|
|
@@ -3538,8 +3370,6 @@ update the signature using the certifier's private key.
|
|
|
3538
3370
|
async encryptAndSignNewCertificate(): Promise<void>
|
|
3539
3371
|
```
|
|
3540
3372
|
|
|
3541
|
-
</details>
|
|
3542
|
-
|
|
3543
3373
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3544
3374
|
|
|
3545
3375
|
---
|
|
@@ -3592,11 +3422,7 @@ export class Monitor {
|
|
|
3592
3422
|
}
|
|
3593
3423
|
```
|
|
3594
3424
|
|
|
3595
|
-
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [MonitorOptions](#interface-monitoroptions), [MonitorStorage](#type-monitorstorage), [Services](#class-services), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
3596
|
-
|
|
3597
|
-
<details>
|
|
3598
|
-
|
|
3599
|
-
<summary>Class Monitor Details</summary>
|
|
3425
|
+
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)
|
|
3600
3426
|
|
|
3601
3427
|
###### Property _otherTasks
|
|
3602
3428
|
|
|
@@ -3605,7 +3431,7 @@ _otherTasks can be run by runTask but not by scheduler.
|
|
|
3605
3431
|
```ts
|
|
3606
3432
|
_otherTasks: WalletMonitorTask[] = []
|
|
3607
3433
|
```
|
|
3608
|
-
See also: [WalletMonitorTask](#class-walletmonitortask)
|
|
3434
|
+
See also: [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
3609
3435
|
|
|
3610
3436
|
###### Property _tasks
|
|
3611
3437
|
|
|
@@ -3614,7 +3440,7 @@ _tasks are typically run by the scheduler but may also be run by runTask.
|
|
|
3614
3440
|
```ts
|
|
3615
3441
|
_tasks: WalletMonitorTask[] = []
|
|
3616
3442
|
```
|
|
3617
|
-
See also: [WalletMonitorTask](#class-walletmonitortask)
|
|
3443
|
+
See also: [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
3618
3444
|
|
|
3619
3445
|
###### Method addDefaultTasks
|
|
3620
3446
|
|
|
@@ -3643,7 +3469,7 @@ Kicks processing 'unconfirmed' and 'unmined' request processing.
|
|
|
3643
3469
|
```ts
|
|
3644
3470
|
processNewBlockHeader(header: BlockHeader): void
|
|
3645
3471
|
```
|
|
3646
|
-
See also: [BlockHeader](#interface-blockheader)
|
|
3472
|
+
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
3647
3473
|
|
|
3648
3474
|
###### Method processReorg
|
|
3649
3475
|
|
|
@@ -3659,9 +3485,7 @@ Coinbase transactions always become invalid.
|
|
|
3659
3485
|
```ts
|
|
3660
3486
|
processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader): void
|
|
3661
3487
|
```
|
|
3662
|
-
See also: [BlockHeader](#interface-blockheader)
|
|
3663
|
-
|
|
3664
|
-
</details>
|
|
3488
|
+
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
3665
3489
|
|
|
3666
3490
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3667
3491
|
|
|
@@ -3697,10 +3521,6 @@ export class PrivilegedKeyManager implements ProtoWallet {
|
|
|
3697
3521
|
}
|
|
3698
3522
|
```
|
|
3699
3523
|
|
|
3700
|
-
<details>
|
|
3701
|
-
|
|
3702
|
-
<summary>Class PrivilegedKeyManager Details</summary>
|
|
3703
|
-
|
|
3704
3524
|
###### Constructor
|
|
3705
3525
|
|
|
3706
3526
|
```ts
|
|
@@ -3724,8 +3544,6 @@ properties to further confuse an attacker.
|
|
|
3724
3544
|
destroyKey(): void
|
|
3725
3545
|
```
|
|
3726
3546
|
|
|
3727
|
-
</details>
|
|
3728
|
-
|
|
3729
3547
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3730
3548
|
|
|
3731
3549
|
---
|
|
@@ -3749,11 +3567,7 @@ export class ScriptTemplateSABPPP implements ScriptTemplate {
|
|
|
3749
3567
|
}
|
|
3750
3568
|
```
|
|
3751
3569
|
|
|
3752
|
-
See also: [ScriptTemplateParamsSABPPP](#interface-scripttemplateparamssabppp)
|
|
3753
|
-
|
|
3754
|
-
<details>
|
|
3755
|
-
|
|
3756
|
-
<summary>Class ScriptTemplateSABPPP Details</summary>
|
|
3570
|
+
See also: [ScriptTemplateParamsSABPPP](./client.md#interface-scripttemplateparamssabppp)
|
|
3757
3571
|
|
|
3758
3572
|
###### Property unlockLength
|
|
3759
3573
|
|
|
@@ -3763,8 +3577,6 @@ P2PKH unlock estimateLength is a constant
|
|
|
3763
3577
|
unlockLength = 108
|
|
3764
3578
|
```
|
|
3765
3579
|
|
|
3766
|
-
</details>
|
|
3767
|
-
|
|
3768
3580
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3769
3581
|
|
|
3770
3582
|
---
|
|
@@ -3837,11 +3649,7 @@ export class Services implements sdk.WalletServices {
|
|
|
3837
3649
|
}
|
|
3838
3650
|
```
|
|
3839
3651
|
|
|
3840
|
-
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)
|
|
3841
|
-
|
|
3842
|
-
<details>
|
|
3843
|
-
|
|
3844
|
-
<summary>Class Services Details</summary>
|
|
3652
|
+
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)
|
|
3845
3653
|
|
|
3846
3654
|
###### Method postTxs
|
|
3847
3655
|
|
|
@@ -3852,9 +3660,7 @@ These will be fetched if missing, greatly extending the service response time.
|
|
|
3852
3660
|
```ts
|
|
3853
3661
|
async postTxs(beef: Beef, txids: string[]): Promise<sdk.PostTxsResult[]>
|
|
3854
3662
|
```
|
|
3855
|
-
See also: [PostTxsResult](#interface-posttxsresult)
|
|
3856
|
-
|
|
3857
|
-
</details>
|
|
3663
|
+
See also: [PostTxsResult](./client.md#interface-posttxsresult)
|
|
3858
3664
|
|
|
3859
3665
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3860
3666
|
|
|
@@ -3965,11 +3771,7 @@ export abstract class SetupClient {
|
|
|
3965
3771
|
}
|
|
3966
3772
|
```
|
|
3967
3773
|
|
|
3968
|
-
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)
|
|
3969
|
-
|
|
3970
|
-
<details>
|
|
3971
|
-
|
|
3972
|
-
<summary>Class SetupClient Details</summary>
|
|
3774
|
+
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)
|
|
3973
3775
|
|
|
3974
3776
|
###### Method createWallet
|
|
3975
3777
|
|
|
@@ -4020,7 +3822,7 @@ static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
|
4020
3822
|
return r;
|
|
4021
3823
|
}
|
|
4022
3824
|
```
|
|
4023
|
-
See also: [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [Services](#class-services), [SetupWallet](#interface-setupwallet), [SetupWalletArgs](#interface-setupwalletargs), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
3825
|
+
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)
|
|
4024
3826
|
|
|
4025
3827
|
###### Method getEnv
|
|
4026
3828
|
|
|
@@ -4033,7 +3835,7 @@ Access private keys through the `devKeys` object: `devKeys[identityKey]`
|
|
|
4033
3835
|
```ts
|
|
4034
3836
|
static getEnv(chain: sdk.Chain): SetupEnv
|
|
4035
3837
|
```
|
|
4036
|
-
See also: [Chain](#type-chain), [SetupEnv](#interface-setupenv)
|
|
3838
|
+
See also: [Chain](./client.md#type-chain), [SetupEnv](./setup.md#interface-setupenv)
|
|
4037
3839
|
|
|
4038
3840
|
Returns
|
|
4039
3841
|
|
|
@@ -4057,8 +3859,6 @@ Private keys should never be included directly in your source code.
|
|
|
4057
3859
|
static makeEnv(): string
|
|
4058
3860
|
```
|
|
4059
3861
|
|
|
4060
|
-
</details>
|
|
4061
|
-
|
|
4062
3862
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4063
3863
|
|
|
4064
3864
|
---
|
|
@@ -4066,12 +3866,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4066
3866
|
|
|
4067
3867
|
```ts
|
|
4068
3868
|
export class StorageClient implements sdk.WalletStorageProvider {
|
|
4069
|
-
public settings?:
|
|
3869
|
+
public settings?: TableSettings;
|
|
4070
3870
|
constructor(wallet: WalletInterface, endpointUrl: string)
|
|
4071
3871
|
isStorageProvider(): boolean
|
|
4072
3872
|
isAvailable(): boolean
|
|
4073
|
-
getSettings():
|
|
4074
|
-
async makeAvailable(): Promise<
|
|
3873
|
+
getSettings(): TableSettings
|
|
3874
|
+
async makeAvailable(): Promise<TableSettings>
|
|
4075
3875
|
async destroy(): Promise<void>
|
|
4076
3876
|
async migrate(storageName: string, storageIdentityKey: string): Promise<string>
|
|
4077
3877
|
getServices(): sdk.WalletServices
|
|
@@ -4081,21 +3881,21 @@ export class StorageClient implements sdk.WalletStorageProvider {
|
|
|
4081
3881
|
async processAction(auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
|
|
4082
3882
|
async abortAction(auth: sdk.AuthId, args: AbortActionArgs): Promise<AbortActionResult>
|
|
4083
3883
|
async findOrInsertUser(identityKey): Promise<{
|
|
4084
|
-
user:
|
|
3884
|
+
user: TableUser;
|
|
4085
3885
|
isNew: boolean;
|
|
4086
3886
|
}>
|
|
4087
3887
|
async findOrInsertSyncStateAuth(auth: sdk.AuthId, storageIdentityKey: string, storageName: string): Promise<{
|
|
4088
|
-
syncState:
|
|
3888
|
+
syncState: TableSyncState;
|
|
4089
3889
|
isNew: boolean;
|
|
4090
3890
|
}>
|
|
4091
|
-
async insertCertificateAuth(auth: sdk.AuthId, certificate:
|
|
3891
|
+
async insertCertificateAuth(auth: sdk.AuthId, certificate: TableCertificateX): Promise<number>
|
|
4092
3892
|
async listActions(auth: sdk.AuthId, vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>
|
|
4093
3893
|
async listOutputs(auth: sdk.AuthId, vargs: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>
|
|
4094
3894
|
async listCertificates(auth: sdk.AuthId, vargs: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>
|
|
4095
|
-
async findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<
|
|
4096
|
-
async findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<
|
|
4097
|
-
async findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<
|
|
4098
|
-
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<
|
|
3895
|
+
async findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>
|
|
3896
|
+
async findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
3897
|
+
async findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
3898
|
+
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
|
|
4099
3899
|
async relinquishCertificate(auth: sdk.AuthId, args: RelinquishCertificateArgs): Promise<number>
|
|
4100
3900
|
async relinquishOutput(auth: sdk.AuthId, args: RelinquishOutputArgs): Promise<number>
|
|
4101
3901
|
async processSyncChunk(args: sdk.RequestSyncChunkArgs, chunk: sdk.SyncChunk): Promise<sdk.ProcessSyncChunkResult>
|
|
@@ -4105,7 +3905,7 @@ export class StorageClient implements sdk.WalletStorageProvider {
|
|
|
4105
3905
|
}
|
|
4106
3906
|
```
|
|
4107
3907
|
|
|
4108
|
-
See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [ProcessSyncChunkResult](#interface-processsyncchunkresult), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [SyncChunk](#interface-syncchunk), [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListActionsArgs](#interface-validlistactionsargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [ValidListOutputsArgs](#interface-validlistoutputsargs), [WalletServices](#interface-walletservices), [WalletStorageProvider](#interface-walletstorageprovider), [createAction](#function-createaction), [getSyncChunk](#function-getsyncchunk), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
3908
|
+
See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableUser](./storage.md#interface-tableuser), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [createAction](./storage.md#function-createaction), [getSyncChunk](./storage.md#function-getsyncchunk), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
|
|
4109
3909
|
|
|
4110
3910
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4111
3911
|
|
|
@@ -4130,53 +3930,49 @@ export abstract class StorageProvider extends StorageReaderWriter implements sdk
|
|
|
4130
3930
|
log: string;
|
|
4131
3931
|
}>;
|
|
4132
3932
|
abstract purgeData(params: sdk.PurgeParams, trx?: sdk.TrxToken): Promise<sdk.PurgeResults>;
|
|
4133
|
-
abstract allocateChangeInput(userId: number, basketId: number, targetSatoshis: number, exactSatoshis: number | undefined, excludeSending: boolean, transactionId: number): Promise<
|
|
3933
|
+
abstract allocateChangeInput(userId: number, basketId: number, targetSatoshis: number, exactSatoshis: number | undefined, excludeSending: boolean, transactionId: number): Promise<TableOutput | undefined>;
|
|
4134
3934
|
abstract getProvenOrRawTx(txid: string, trx?: sdk.TrxToken): Promise<sdk.ProvenOrRawTx>;
|
|
4135
3935
|
abstract getRawTxOfKnownValidTransaction(txid?: string, offset?: number, length?: number, trx?: sdk.TrxToken): Promise<number[] | undefined>;
|
|
4136
|
-
abstract getLabelsForTransactionId(transactionId?: number, trx?: sdk.TrxToken): Promise<
|
|
4137
|
-
abstract getTagsForOutputId(outputId: number, trx?: sdk.TrxToken): Promise<
|
|
3936
|
+
abstract getLabelsForTransactionId(transactionId?: number, trx?: sdk.TrxToken): Promise<TableTxLabel[]>;
|
|
3937
|
+
abstract getTagsForOutputId(outputId: number, trx?: sdk.TrxToken): Promise<TableOutputTag[]>;
|
|
4138
3938
|
abstract listActions(auth: sdk.AuthId, args: sdk.ValidListActionsArgs): Promise<ListActionsResult>;
|
|
4139
3939
|
abstract listOutputs(auth: sdk.AuthId, args: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>;
|
|
4140
3940
|
abstract countChangeInputs(userId: number, basketId: number, excludeSending: boolean): Promise<number>;
|
|
4141
|
-
abstract findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<
|
|
4142
|
-
abstract findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<
|
|
4143
|
-
abstract findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<
|
|
4144
|
-
abstract insertCertificateAuth(auth: sdk.AuthId, certificate:
|
|
3941
|
+
abstract findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>;
|
|
3942
|
+
abstract findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
3943
|
+
abstract findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
3944
|
+
abstract insertCertificateAuth(auth: sdk.AuthId, certificate: TableCertificateX): Promise<number>;
|
|
4145
3945
|
override isStorageProvider(): boolean
|
|
4146
3946
|
setServices(v: sdk.WalletServices)
|
|
4147
3947
|
getServices(): sdk.WalletServices
|
|
4148
|
-
async abortAction(auth: sdk.AuthId, args: Partial<
|
|
3948
|
+
async abortAction(auth: sdk.AuthId, args: Partial<TableTransaction>): Promise<AbortActionResult>
|
|
4149
3949
|
async internalizeAction(auth: sdk.AuthId, args: InternalizeActionArgs): Promise<InternalizeActionResult>
|
|
4150
3950
|
async getReqsAndBeefToShareWithWorld(txids: string[], knownTxids: string[], trx?: sdk.TrxToken): Promise<GetReqsAndBeefResult>
|
|
4151
|
-
async mergeReqToBeefToShareExternally(req:
|
|
4152
|
-
async getProvenOrReq(txid: string, newReq?:
|
|
3951
|
+
async mergeReqToBeefToShareExternally(req: TableProvenTxReq, mergeToBeef: Beef, knownTxids: string[], trx?: sdk.TrxToken): Promise<void>
|
|
3952
|
+
async getProvenOrReq(txid: string, newReq?: TableProvenTxReq, trx?: sdk.TrxToken): Promise<sdk.StorageProvenOrReq>
|
|
4153
3953
|
async updateTransactionsStatus(transactionIds: number[], status: sdk.TransactionStatus): Promise<void>
|
|
4154
3954
|
async updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: number, userId?: number, reference?: string, trx?: sdk.TrxToken): Promise<void>
|
|
4155
3955
|
async createAction(auth: sdk.AuthId, args: sdk.ValidCreateActionArgs): Promise<sdk.StorageCreateActionResult>
|
|
4156
3956
|
async processAction(auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
|
|
4157
|
-
async attemptToPostReqsToNetwork(reqs:
|
|
3957
|
+
async attemptToPostReqsToNetwork(reqs: EntityProvenTxReq[], trx?: sdk.TrxToken): Promise<PostReqsToNetworkResult>
|
|
4158
3958
|
async listCertificates(auth: sdk.AuthId, args: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>
|
|
4159
3959
|
async verifyKnownValidTransaction(txid: string, trx?: sdk.TrxToken): Promise<boolean>
|
|
4160
3960
|
async getValidBeefForKnownTxid(txid: string, mergeToBeef?: Beef, trustSelf?: TrustSelf, knownTxids?: string[], trx?: sdk.TrxToken): Promise<Beef>
|
|
4161
3961
|
async getValidBeefForTxid(txid: string, mergeToBeef?: Beef, trustSelf?: TrustSelf, knownTxids?: string[], trx?: sdk.TrxToken): Promise<Beef | undefined>
|
|
4162
3962
|
async getBeefForTransaction(txid: string, options: sdk.StorageGetBeefOptions): Promise<Beef>
|
|
4163
|
-
async findMonitorEventById(id: number, trx?: sdk.TrxToken): Promise<
|
|
3963
|
+
async findMonitorEventById(id: number, trx?: sdk.TrxToken): Promise<TableMonitorEvent | undefined>
|
|
4164
3964
|
async relinquishCertificate(auth: sdk.AuthId, args: RelinquishCertificateArgs): Promise<number>
|
|
4165
3965
|
async relinquishOutput(auth: sdk.AuthId, args: RelinquishOutputArgs): Promise<number>
|
|
4166
3966
|
async processSyncChunk(args: sdk.RequestSyncChunkArgs, chunk: sdk.SyncChunk): Promise<sdk.ProcessSyncChunkResult>
|
|
4167
3967
|
async updateProvenTxReqWithNewProvenTx(args: sdk.UpdateProvenTxReqWithNewProvenTxArgs): Promise<sdk.UpdateProvenTxReqWithNewProvenTxResult>
|
|
4168
3968
|
async confirmSpendableOutputs(): Promise<{
|
|
4169
|
-
invalidSpendableOutputs:
|
|
3969
|
+
invalidSpendableOutputs: TableOutput[];
|
|
4170
3970
|
}>
|
|
4171
|
-
async updateProvenTxReqDynamics(id: number, update: Partial<
|
|
3971
|
+
async updateProvenTxReqDynamics(id: number, update: Partial<TableProvenTxReqDynamics>, trx?: sdk.TrxToken): Promise<number>
|
|
4172
3972
|
}
|
|
4173
3973
|
```
|
|
4174
3974
|
|
|
4175
|
-
See also: [AuthId](#interface-authid), [Chain](#type-chain), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [GetReqsAndBeefResult](#interface-getreqsandbeefresult), [PostReqsToNetworkResult](#interface-postreqstonetworkresult), [ProcessSyncChunkResult](#interface-processsyncchunkresult), [ProvenOrRawTx](#interface-provenorrawtx), [PurgeParams](#interface-purgeparams), [PurgeResults](#interface-purgeresults), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageFeeModel](#interface-storagefeemodel), [StorageGetBeefOptions](#interface-storagegetbeefoptions), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [StorageProvenOrReq](#interface-storageprovenorreq), [StorageProviderOptions](#interface-storageprovideroptions), [StorageReaderWriter](#class-storagereaderwriter), [SyncChunk](#interface-syncchunk), [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListActionsArgs](#interface-validlistactionsargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [ValidListOutputsArgs](#interface-validlistoutputsargs), [WalletServices](#interface-walletservices), [WalletStorageProvider](#interface-walletstorageprovider), [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork), [createAction](#function-createaction), [getBeefForTransaction](#function-getbeeffortransaction), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
4176
|
-
|
|
4177
|
-
<details>
|
|
4178
|
-
|
|
4179
|
-
<summary>Class StorageProvider Details</summary>
|
|
3975
|
+
See also: [AuthId](./client.md#interface-authid), [Chain](./client.md#type-chain), [EntityProvenTxReq](./storage.md#class-entityproventxreq), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [PostReqsToNetworkResult](./storage.md#interface-postreqstonetworkresult), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageFeeModel](./client.md#interface-storagefeemodel), [StorageGetBeefOptions](./client.md#interface-storagegetbeefoptions), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvenOrReq](./client.md#interface-storageprovenorreq), [StorageProviderOptions](./storage.md#interface-storageprovideroptions), [StorageReaderWriter](./storage.md#class-storagereaderwriter), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [attemptToPostReqsToNetwork](./storage.md#function-attempttopostreqstonetwork), [createAction](./storage.md#function-createaction), [getBeefForTransaction](./storage.md#function-getbeeffortransaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction), [purgeData](./storage.md#function-purgedata), [reviewStatus](./storage.md#function-reviewstatus)
|
|
4180
3976
|
|
|
4181
3977
|
###### Method confirmSpendableOutputs
|
|
4182
3978
|
|
|
@@ -4186,9 +3982,10 @@ still in the mempool of at least one service provider.
|
|
|
4186
3982
|
|
|
4187
3983
|
```ts
|
|
4188
3984
|
async confirmSpendableOutputs(): Promise<{
|
|
4189
|
-
invalidSpendableOutputs:
|
|
3985
|
+
invalidSpendableOutputs: TableOutput[];
|
|
4190
3986
|
}>
|
|
4191
3987
|
```
|
|
3988
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
4192
3989
|
|
|
4193
3990
|
Returns
|
|
4194
3991
|
|
|
@@ -4205,9 +4002,9 @@ This is safe "findOrInsert" operation using retry if unique index constraint
|
|
|
4205
4002
|
is violated by a race condition insert.
|
|
4206
4003
|
|
|
4207
4004
|
```ts
|
|
4208
|
-
async getProvenOrReq(txid: string, newReq?:
|
|
4005
|
+
async getProvenOrReq(txid: string, newReq?: TableProvenTxReq, trx?: sdk.TrxToken): Promise<sdk.StorageProvenOrReq>
|
|
4209
4006
|
```
|
|
4210
|
-
See also: [StorageProvenOrReq](#interface-storageprovenorreq), [TrxToken](#interface-trxtoken)
|
|
4007
|
+
See also: [StorageProvenOrReq](./client.md#interface-storageprovenorreq), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TrxToken](./client.md#interface-trxtoken)
|
|
4211
4008
|
|
|
4212
4009
|
###### Method getReqsAndBeefToShareWithWorld
|
|
4213
4010
|
|
|
@@ -4218,7 +4015,7 @@ For the txids with reqs and status still ready to send construct a single merged
|
|
|
4218
4015
|
```ts
|
|
4219
4016
|
async getReqsAndBeefToShareWithWorld(txids: string[], knownTxids: string[], trx?: sdk.TrxToken): Promise<GetReqsAndBeefResult>
|
|
4220
4017
|
```
|
|
4221
|
-
See also: [GetReqsAndBeefResult](#interface-getreqsandbeefresult), [TrxToken](#interface-trxtoken)
|
|
4018
|
+
See also: [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [TrxToken](./client.md#interface-trxtoken)
|
|
4222
4019
|
|
|
4223
4020
|
###### Method updateProvenTxReqWithNewProvenTx
|
|
4224
4021
|
|
|
@@ -4237,7 +4034,7 @@ Alterations of "typically" to handle:
|
|
|
4237
4034
|
```ts
|
|
4238
4035
|
async updateProvenTxReqWithNewProvenTx(args: sdk.UpdateProvenTxReqWithNewProvenTxArgs): Promise<sdk.UpdateProvenTxReqWithNewProvenTxResult>
|
|
4239
4036
|
```
|
|
4240
|
-
See also: [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult)
|
|
4037
|
+
See also: [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult)
|
|
4241
4038
|
|
|
4242
4039
|
###### Method updateTransactionStatus
|
|
4243
4040
|
|
|
@@ -4248,9 +4045,7 @@ For 'status' of 'failed', attempts to make outputs previously allocated as input
|
|
|
4248
4045
|
```ts
|
|
4249
4046
|
async updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: number, userId?: number, reference?: string, trx?: sdk.TrxToken): Promise<void>
|
|
4250
4047
|
```
|
|
4251
|
-
See also: [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken)
|
|
4252
|
-
|
|
4253
|
-
</details>
|
|
4048
|
+
See also: [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken)
|
|
4254
4049
|
|
|
4255
4050
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4256
4051
|
|
|
@@ -4271,28 +4066,28 @@ As such there are no user specific authenticated access checks implied in the im
|
|
|
4271
4066
|
```ts
|
|
4272
4067
|
export abstract class StorageReader implements sdk.StorageSyncReader {
|
|
4273
4068
|
chain: sdk.Chain;
|
|
4274
|
-
_settings?:
|
|
4069
|
+
_settings?: TableSettings;
|
|
4275
4070
|
whenLastAccess?: Date;
|
|
4276
4071
|
get dbtype(): DBType | undefined
|
|
4277
4072
|
constructor(options: StorageReaderOptions)
|
|
4278
4073
|
isAvailable(): boolean
|
|
4279
|
-
async makeAvailable(): Promise<
|
|
4280
|
-
getSettings():
|
|
4074
|
+
async makeAvailable(): Promise<TableSettings>
|
|
4075
|
+
getSettings(): TableSettings
|
|
4281
4076
|
isStorageProvider(): boolean
|
|
4282
4077
|
abstract destroy(): Promise<void>;
|
|
4283
4078
|
abstract transaction<T>(scope: (trx: sdk.TrxToken) => Promise<T>, trx?: sdk.TrxToken): Promise<T>;
|
|
4284
|
-
abstract readSettings(trx?: sdk.TrxToken): Promise<
|
|
4285
|
-
abstract findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<
|
|
4286
|
-
abstract findCertificates(args: sdk.FindCertificatesArgs): Promise<
|
|
4287
|
-
abstract findCommissions(args: sdk.FindCommissionsArgs): Promise<
|
|
4288
|
-
abstract findMonitorEvents(args: sdk.FindMonitorEventsArgs): Promise<
|
|
4289
|
-
abstract findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<
|
|
4290
|
-
abstract findOutputs(args: sdk.FindOutputsArgs): Promise<
|
|
4291
|
-
abstract findOutputTags(args: sdk.FindOutputTagsArgs): Promise<
|
|
4292
|
-
abstract findSyncStates(args: sdk.FindSyncStatesArgs): Promise<
|
|
4293
|
-
abstract findTransactions(args: sdk.FindTransactionsArgs): Promise<
|
|
4294
|
-
abstract findTxLabels(args: sdk.FindTxLabelsArgs): Promise<
|
|
4295
|
-
abstract findUsers(args: sdk.FindUsersArgs): Promise<
|
|
4079
|
+
abstract readSettings(trx?: sdk.TrxToken): Promise<TableSettings>;
|
|
4080
|
+
abstract findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<TableCertificateField[]>;
|
|
4081
|
+
abstract findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>;
|
|
4082
|
+
abstract findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>;
|
|
4083
|
+
abstract findMonitorEvents(args: sdk.FindMonitorEventsArgs): Promise<TableMonitorEvent[]>;
|
|
4084
|
+
abstract findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
4085
|
+
abstract findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
4086
|
+
abstract findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>;
|
|
4087
|
+
abstract findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>;
|
|
4088
|
+
abstract findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>;
|
|
4089
|
+
abstract findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>;
|
|
4090
|
+
abstract findUsers(args: sdk.FindUsersArgs): Promise<TableUser[]>;
|
|
4296
4091
|
abstract countCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<number>;
|
|
4297
4092
|
abstract countCertificates(args: sdk.FindCertificatesArgs): Promise<number>;
|
|
4298
4093
|
abstract countCommissions(args: sdk.FindCommissionsArgs): Promise<number>;
|
|
@@ -4304,11 +4099,11 @@ export abstract class StorageReader implements sdk.StorageSyncReader {
|
|
|
4304
4099
|
abstract countTransactions(args: sdk.FindTransactionsArgs): Promise<number>;
|
|
4305
4100
|
abstract countTxLabels(args: sdk.FindTxLabelsArgs): Promise<number>;
|
|
4306
4101
|
abstract countUsers(args: sdk.FindUsersArgs): Promise<number>;
|
|
4307
|
-
abstract getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4308
|
-
abstract getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4309
|
-
abstract getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4310
|
-
abstract getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4311
|
-
async findUserByIdentityKey(key: string): Promise<
|
|
4102
|
+
abstract getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTx[]>;
|
|
4103
|
+
abstract getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTxReq[]>;
|
|
4104
|
+
abstract getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableTxLabelMap[]>;
|
|
4105
|
+
abstract getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableOutputTagMap[]>;
|
|
4106
|
+
async findUserByIdentityKey(key: string): Promise<TableUser | undefined>
|
|
4312
4107
|
async getSyncChunk(args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk>
|
|
4313
4108
|
validateEntityDate(date: Date | string | number): Date | string
|
|
4314
4109
|
validateOptionalEntityDate(date: Date | string | number | null | undefined, useNowAsDefault?: boolean): Date | string | undefined
|
|
@@ -4318,11 +4113,7 @@ export abstract class StorageReader implements sdk.StorageSyncReader {
|
|
|
4318
4113
|
}
|
|
4319
4114
|
```
|
|
4320
4115
|
|
|
4321
|
-
See also: [Chain](#type-chain), [DBType](#type-dbtype), [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs), [FindCertificatesArgs](#interface-findcertificatesargs), [FindCommissionsArgs](#interface-findcommissionsargs), [FindForUserSincePagedArgs](#interface-findforusersincepagedargs), [FindMonitorEventsArgs](#interface-findmonitoreventsargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputTagsArgs](#interface-findoutputtagsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindSyncStatesArgs](#interface-findsyncstatesargs), [FindTransactionsArgs](#interface-findtransactionsargs), [FindTxLabelsArgs](#interface-findtxlabelsargs), [FindUsersArgs](#interface-findusersargs), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReaderOptions](#interface-storagereaderoptions), [StorageSyncReader](#class-storagesyncreader), [SyncChunk](#interface-syncchunk), [TrxToken](#interface-trxtoken), [getSyncChunk](#function-getsyncchunk)
|
|
4322
|
-
|
|
4323
|
-
<details>
|
|
4324
|
-
|
|
4325
|
-
<summary>Class StorageReader Details</summary>
|
|
4116
|
+
See also: [Chain](./client.md#type-chain), [DBType](./storage.md#type-dbtype), [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindMonitorEventsArgs](./client.md#interface-findmonitoreventsargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [FindUsersArgs](./client.md#interface-findusersargs), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReaderOptions](./storage.md#interface-storagereaderoptions), [StorageSyncReader](./storage.md#class-storagesyncreader), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TrxToken](./client.md#interface-trxtoken), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
4326
4117
|
|
|
4327
4118
|
###### Method validateEntityDate
|
|
4328
4119
|
|
|
@@ -4343,8 +4134,6 @@ Argument Details
|
|
|
4343
4134
|
+ **useNowAsDefault**
|
|
4344
4135
|
+ if true and date is null or undefiend, set to current time.
|
|
4345
4136
|
|
|
4346
|
-
</details>
|
|
4347
|
-
|
|
4348
4137
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4349
4138
|
|
|
4350
4139
|
---
|
|
@@ -4355,87 +4144,87 @@ export abstract class StorageReaderWriter extends StorageReader {
|
|
|
4355
4144
|
constructor(options: StorageReaderWriterOptions)
|
|
4356
4145
|
abstract dropAllData(): Promise<void>;
|
|
4357
4146
|
abstract migrate(storageName: string, storageIdentityKey: string): Promise<string>;
|
|
4358
|
-
abstract findOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<
|
|
4359
|
-
abstract findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<
|
|
4360
|
-
abstract findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<
|
|
4361
|
-
abstract findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<
|
|
4147
|
+
abstract findOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<TableOutputTagMap[]>;
|
|
4148
|
+
abstract findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
|
|
4149
|
+
abstract findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<TableProvenTx[]>;
|
|
4150
|
+
abstract findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<TableTxLabelMap[]>;
|
|
4362
4151
|
abstract countOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<number>;
|
|
4363
4152
|
abstract countProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<number>;
|
|
4364
4153
|
abstract countProvenTxs(args: sdk.FindProvenTxsArgs): Promise<number>;
|
|
4365
4154
|
abstract countTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<number>;
|
|
4366
|
-
abstract insertCertificate(certificate:
|
|
4367
|
-
abstract insertCertificateField(certificateField:
|
|
4368
|
-
abstract insertCommission(commission:
|
|
4369
|
-
abstract insertMonitorEvent(event:
|
|
4370
|
-
abstract insertOutput(output:
|
|
4371
|
-
abstract insertOutputBasket(basket:
|
|
4372
|
-
abstract insertOutputTag(tag:
|
|
4373
|
-
abstract insertOutputTagMap(tagMap:
|
|
4374
|
-
abstract insertProvenTx(tx:
|
|
4375
|
-
abstract insertProvenTxReq(tx:
|
|
4376
|
-
abstract insertSyncState(syncState:
|
|
4377
|
-
abstract insertTransaction(tx:
|
|
4378
|
-
abstract insertTxLabel(label:
|
|
4379
|
-
abstract insertTxLabelMap(labelMap:
|
|
4380
|
-
abstract insertUser(user:
|
|
4381
|
-
abstract updateCertificate(id: number, update: Partial<
|
|
4382
|
-
abstract updateCertificateField(certificateId: number, fieldName: string, update: Partial<
|
|
4383
|
-
abstract updateCommission(id: number, update: Partial<
|
|
4384
|
-
abstract updateMonitorEvent(id: number, update: Partial<
|
|
4385
|
-
abstract updateOutput(id: number, update: Partial<
|
|
4386
|
-
abstract updateOutputBasket(id: number, update: Partial<
|
|
4387
|
-
abstract updateOutputTag(id: number, update: Partial<
|
|
4388
|
-
abstract updateOutputTagMap(outputId: number, tagId: number, update: Partial<
|
|
4389
|
-
abstract updateProvenTx(id: number, update: Partial<
|
|
4390
|
-
abstract updateProvenTxReq(id: number | number[], update: Partial<
|
|
4391
|
-
abstract updateSyncState(id: number, update: Partial<
|
|
4392
|
-
abstract updateTransaction(id: number | number[], update: Partial<
|
|
4393
|
-
abstract updateTxLabel(id: number, update: Partial<
|
|
4394
|
-
abstract updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<
|
|
4395
|
-
abstract updateUser(id: number, update: Partial<
|
|
4155
|
+
abstract insertCertificate(certificate: TableCertificate, trx?: sdk.TrxToken): Promise<number>;
|
|
4156
|
+
abstract insertCertificateField(certificateField: TableCertificateField, trx?: sdk.TrxToken): Promise<void>;
|
|
4157
|
+
abstract insertCommission(commission: TableCommission, trx?: sdk.TrxToken): Promise<number>;
|
|
4158
|
+
abstract insertMonitorEvent(event: TableMonitorEvent, trx?: sdk.TrxToken): Promise<number>;
|
|
4159
|
+
abstract insertOutput(output: TableOutput, trx?: sdk.TrxToken): Promise<number>;
|
|
4160
|
+
abstract insertOutputBasket(basket: TableOutputBasket, trx?: sdk.TrxToken): Promise<number>;
|
|
4161
|
+
abstract insertOutputTag(tag: TableOutputTag, trx?: sdk.TrxToken): Promise<number>;
|
|
4162
|
+
abstract insertOutputTagMap(tagMap: TableOutputTagMap, trx?: sdk.TrxToken): Promise<void>;
|
|
4163
|
+
abstract insertProvenTx(tx: TableProvenTx, trx?: sdk.TrxToken): Promise<number>;
|
|
4164
|
+
abstract insertProvenTxReq(tx: TableProvenTxReq, trx?: sdk.TrxToken): Promise<number>;
|
|
4165
|
+
abstract insertSyncState(syncState: TableSyncState, trx?: sdk.TrxToken): Promise<number>;
|
|
4166
|
+
abstract insertTransaction(tx: TableTransaction, trx?: sdk.TrxToken): Promise<number>;
|
|
4167
|
+
abstract insertTxLabel(label: TableTxLabel, trx?: sdk.TrxToken): Promise<number>;
|
|
4168
|
+
abstract insertTxLabelMap(labelMap: TableTxLabelMap, trx?: sdk.TrxToken): Promise<void>;
|
|
4169
|
+
abstract insertUser(user: TableUser, trx?: sdk.TrxToken): Promise<number>;
|
|
4170
|
+
abstract updateCertificate(id: number, update: Partial<TableCertificate>, trx?: sdk.TrxToken): Promise<number>;
|
|
4171
|
+
abstract updateCertificateField(certificateId: number, fieldName: string, update: Partial<TableCertificateField>, trx?: sdk.TrxToken): Promise<number>;
|
|
4172
|
+
abstract updateCommission(id: number, update: Partial<TableCommission>, trx?: sdk.TrxToken): Promise<number>;
|
|
4173
|
+
abstract updateMonitorEvent(id: number, update: Partial<TableMonitorEvent>, trx?: sdk.TrxToken): Promise<number>;
|
|
4174
|
+
abstract updateOutput(id: number, update: Partial<TableOutput>, trx?: sdk.TrxToken): Promise<number>;
|
|
4175
|
+
abstract updateOutputBasket(id: number, update: Partial<TableOutputBasket>, trx?: sdk.TrxToken): Promise<number>;
|
|
4176
|
+
abstract updateOutputTag(id: number, update: Partial<TableOutputTag>, trx?: sdk.TrxToken): Promise<number>;
|
|
4177
|
+
abstract updateOutputTagMap(outputId: number, tagId: number, update: Partial<TableOutputTagMap>, trx?: sdk.TrxToken): Promise<number>;
|
|
4178
|
+
abstract updateProvenTx(id: number, update: Partial<TableProvenTx>, trx?: sdk.TrxToken): Promise<number>;
|
|
4179
|
+
abstract updateProvenTxReq(id: number | number[], update: Partial<TableProvenTxReq>, trx?: sdk.TrxToken): Promise<number>;
|
|
4180
|
+
abstract updateSyncState(id: number, update: Partial<TableSyncState>, trx?: sdk.TrxToken): Promise<number>;
|
|
4181
|
+
abstract updateTransaction(id: number | number[], update: Partial<TableTransaction>, trx?: sdk.TrxToken): Promise<number>;
|
|
4182
|
+
abstract updateTxLabel(id: number, update: Partial<TableTxLabel>, trx?: sdk.TrxToken): Promise<number>;
|
|
4183
|
+
abstract updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<TableTxLabelMap>, trx?: sdk.TrxToken): Promise<number>;
|
|
4184
|
+
abstract updateUser(id: number, update: Partial<TableUser>, trx?: sdk.TrxToken): Promise<number>;
|
|
4396
4185
|
async setActive(auth: sdk.AuthId, newActiveStorageIdentityKey: string): Promise<number>
|
|
4397
|
-
async findCertificateById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4398
|
-
async findCommissionById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4399
|
-
async findOutputById(id: number, trx?: sdk.TrxToken, noScript?: boolean): Promise<
|
|
4400
|
-
async findOutputBasketById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4401
|
-
async findProvenTxById(id: number, trx?: sdk.TrxToken | undefined): Promise<
|
|
4402
|
-
async findProvenTxReqById(id: number, trx?: sdk.TrxToken | undefined): Promise<
|
|
4403
|
-
async findSyncStateById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4404
|
-
async findTransactionById(id: number, trx?: sdk.TrxToken, noRawTx?: boolean): Promise<
|
|
4405
|
-
async findTxLabelById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4406
|
-
async findOutputTagById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4407
|
-
async findUserById(id: number, trx?: sdk.TrxToken): Promise<
|
|
4186
|
+
async findCertificateById(id: number, trx?: sdk.TrxToken): Promise<TableCertificate | undefined>
|
|
4187
|
+
async findCommissionById(id: number, trx?: sdk.TrxToken): Promise<TableCommission | undefined>
|
|
4188
|
+
async findOutputById(id: number, trx?: sdk.TrxToken, noScript?: boolean): Promise<TableOutput | undefined>
|
|
4189
|
+
async findOutputBasketById(id: number, trx?: sdk.TrxToken): Promise<TableOutputBasket | undefined>
|
|
4190
|
+
async findProvenTxById(id: number, trx?: sdk.TrxToken | undefined): Promise<TableProvenTx | undefined>
|
|
4191
|
+
async findProvenTxReqById(id: number, trx?: sdk.TrxToken | undefined): Promise<TableProvenTxReq | undefined>
|
|
4192
|
+
async findSyncStateById(id: number, trx?: sdk.TrxToken): Promise<TableSyncState | undefined>
|
|
4193
|
+
async findTransactionById(id: number, trx?: sdk.TrxToken, noRawTx?: boolean): Promise<TableTransaction | undefined>
|
|
4194
|
+
async findTxLabelById(id: number, trx?: sdk.TrxToken): Promise<TableTxLabel | undefined>
|
|
4195
|
+
async findOutputTagById(id: number, trx?: sdk.TrxToken): Promise<TableOutputTag | undefined>
|
|
4196
|
+
async findUserById(id: number, trx?: sdk.TrxToken): Promise<TableUser | undefined>
|
|
4408
4197
|
async findOrInsertUser(identityKey: string, trx?: sdk.TrxToken): Promise<{
|
|
4409
|
-
user:
|
|
4198
|
+
user: TableUser;
|
|
4410
4199
|
isNew: boolean;
|
|
4411
4200
|
}>
|
|
4412
|
-
async findOrInsertTransaction(newTx:
|
|
4413
|
-
tx:
|
|
4201
|
+
async findOrInsertTransaction(newTx: TableTransaction, trx?: sdk.TrxToken): Promise<{
|
|
4202
|
+
tx: TableTransaction;
|
|
4414
4203
|
isNew: boolean;
|
|
4415
4204
|
}>
|
|
4416
|
-
async findOrInsertOutputBasket(userId: number, name: string, trx?: sdk.TrxToken): Promise<
|
|
4417
|
-
async findOrInsertTxLabel(userId: number, label: string, trx?: sdk.TrxToken): Promise<
|
|
4418
|
-
async findOrInsertTxLabelMap(transactionId: number, txLabelId: number, trx?: sdk.TrxToken): Promise<
|
|
4419
|
-
async findOrInsertOutputTag(userId: number, tag: string, trx?: sdk.TrxToken): Promise<
|
|
4420
|
-
async findOrInsertOutputTagMap(outputId: number, outputTagId: number, trx?: sdk.TrxToken): Promise<
|
|
4205
|
+
async findOrInsertOutputBasket(userId: number, name: string, trx?: sdk.TrxToken): Promise<TableOutputBasket>
|
|
4206
|
+
async findOrInsertTxLabel(userId: number, label: string, trx?: sdk.TrxToken): Promise<TableTxLabel>
|
|
4207
|
+
async findOrInsertTxLabelMap(transactionId: number, txLabelId: number, trx?: sdk.TrxToken): Promise<TableTxLabelMap>
|
|
4208
|
+
async findOrInsertOutputTag(userId: number, tag: string, trx?: sdk.TrxToken): Promise<TableOutputTag>
|
|
4209
|
+
async findOrInsertOutputTagMap(outputId: number, outputTagId: number, trx?: sdk.TrxToken): Promise<TableOutputTagMap>
|
|
4421
4210
|
async findOrInsertSyncStateAuth(auth: sdk.AuthId, storageIdentityKey: string, storageName: string): Promise<{
|
|
4422
|
-
syncState:
|
|
4211
|
+
syncState: TableSyncState;
|
|
4423
4212
|
isNew: boolean;
|
|
4424
4213
|
}>
|
|
4425
|
-
async findOrInsertProvenTxReq(newReq:
|
|
4426
|
-
req:
|
|
4214
|
+
async findOrInsertProvenTxReq(newReq: TableProvenTxReq, trx?: sdk.TrxToken): Promise<{
|
|
4215
|
+
req: TableProvenTxReq;
|
|
4427
4216
|
isNew: boolean;
|
|
4428
4217
|
}>
|
|
4429
|
-
async findOrInsertProvenTx(newProven:
|
|
4430
|
-
proven:
|
|
4218
|
+
async findOrInsertProvenTx(newProven: TableProvenTx, trx?: sdk.TrxToken): Promise<{
|
|
4219
|
+
proven: TableProvenTx;
|
|
4431
4220
|
isNew: boolean;
|
|
4432
4221
|
}>
|
|
4433
4222
|
abstract processSyncChunk(args: sdk.RequestSyncChunkArgs, chunk: sdk.SyncChunk): Promise<sdk.ProcessSyncChunkResult>;
|
|
4434
|
-
async tagOutput(partial: Partial<
|
|
4223
|
+
async tagOutput(partial: Partial<TableOutput>, tag: string, trx?: sdk.TrxToken): Promise<void>
|
|
4435
4224
|
}
|
|
4436
4225
|
```
|
|
4437
4226
|
|
|
4438
|
-
See also: [AuthId](#interface-authid), [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [FindProvenTxsArgs](#interface-findproventxsargs), [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs), [ProcessSyncChunkResult](#interface-processsyncchunkresult), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReader](#class-storagereader), [StorageReaderWriterOptions](#interface-storagereaderwriteroptions), [SyncChunk](#interface-syncchunk), [TrxToken](#interface-trxtoken)
|
|
4227
|
+
See also: [AuthId](./client.md#interface-authid), [FindOutputTagMapsArgs](./client.md#interface-findoutputtagmapsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [FindProvenTxsArgs](./client.md#interface-findproventxsargs), [FindTxLabelMapsArgs](./client.md#interface-findtxlabelmapsargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReader](./storage.md#class-storagereader), [StorageReaderWriterOptions](./storage.md#interface-storagereaderwriteroptions), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TrxToken](./client.md#interface-trxtoken)
|
|
4439
4228
|
|
|
4440
4229
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4441
4230
|
|
|
@@ -4451,28 +4240,28 @@ and the `StorageBaseReader` to be protected.
|
|
|
4451
4240
|
export class StorageSyncReader implements sdk.StorageSyncReader {
|
|
4452
4241
|
constructor(public auth: sdk.AuthId, public storage: StorageReader)
|
|
4453
4242
|
isAvailable(): boolean
|
|
4454
|
-
async makeAvailable(): Promise<
|
|
4243
|
+
async makeAvailable(): Promise<TableSettings>
|
|
4455
4244
|
destroy(): Promise<void>
|
|
4456
|
-
getSettings():
|
|
4245
|
+
getSettings(): TableSettings
|
|
4457
4246
|
async getSyncChunk(args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk>
|
|
4458
|
-
async findUserByIdentityKey(key: string): Promise<
|
|
4459
|
-
async findSyncStates(args: sdk.FindSyncStatesArgs): Promise<
|
|
4460
|
-
async findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<
|
|
4461
|
-
async findCertificates(args: sdk.FindCertificatesArgs): Promise<
|
|
4462
|
-
async findCommissions(args: sdk.FindCommissionsArgs): Promise<
|
|
4463
|
-
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<
|
|
4464
|
-
async findOutputs(args: sdk.FindOutputsArgs): Promise<
|
|
4465
|
-
async findOutputTags(args: sdk.FindOutputTagsArgs): Promise<
|
|
4466
|
-
async findTransactions(args: sdk.FindTransactionsArgs): Promise<
|
|
4467
|
-
async findTxLabels(args: sdk.FindTxLabelsArgs): Promise<
|
|
4468
|
-
async getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4469
|
-
async getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4470
|
-
async getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4471
|
-
async getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<
|
|
4247
|
+
async findUserByIdentityKey(key: string): Promise<TableUser | undefined>
|
|
4248
|
+
async findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>
|
|
4249
|
+
async findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<TableCertificateField[]>
|
|
4250
|
+
async findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>
|
|
4251
|
+
async findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>
|
|
4252
|
+
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
4253
|
+
async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
4254
|
+
async findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>
|
|
4255
|
+
async findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>
|
|
4256
|
+
async findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>
|
|
4257
|
+
async getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTx[]>
|
|
4258
|
+
async getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTxReq[]>
|
|
4259
|
+
async getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableTxLabelMap[]>
|
|
4260
|
+
async getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableOutputTagMap[]>
|
|
4472
4261
|
}
|
|
4473
4262
|
```
|
|
4474
4263
|
|
|
4475
|
-
See also: [AuthId](#interface-authid), [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs), [FindCertificatesArgs](#interface-findcertificatesargs), [FindCommissionsArgs](#interface-findcommissionsargs), [FindForUserSincePagedArgs](#interface-findforusersincepagedargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputTagsArgs](#interface-findoutputtagsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindSyncStatesArgs](#interface-findsyncstatesargs), [FindTransactionsArgs](#interface-findtransactionsargs), [FindTxLabelsArgs](#interface-findtxlabelsargs), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReader](#class-storagereader), [SyncChunk](#interface-syncchunk), [getSyncChunk](#function-getsyncchunk)
|
|
4264
|
+
See also: [AuthId](./client.md#interface-authid), [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReader](./storage.md#class-storagereader), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
4476
4265
|
|
|
4477
4266
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4478
4267
|
|
|
@@ -4499,19 +4288,15 @@ export class TaskCheckForProofs extends WalletMonitorTask {
|
|
|
4499
4288
|
run: boolean;
|
|
4500
4289
|
}
|
|
4501
4290
|
async runTask(): Promise<string>
|
|
4502
|
-
async getProofs(reqs:
|
|
4503
|
-
proven:
|
|
4504
|
-
invalid:
|
|
4291
|
+
async getProofs(reqs: TableProvenTxReq[], indent = 0, countsAsAttempt = false, ignoreStatus = false): Promise<{
|
|
4292
|
+
proven: TableProvenTxReq[];
|
|
4293
|
+
invalid: TableProvenTxReq[];
|
|
4505
4294
|
log: string;
|
|
4506
4295
|
}>
|
|
4507
4296
|
}
|
|
4508
4297
|
```
|
|
4509
4298
|
|
|
4510
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4511
|
-
|
|
4512
|
-
<details>
|
|
4513
|
-
|
|
4514
|
-
<summary>Class TaskCheckForProofs Details</summary>
|
|
4299
|
+
See also: [Monitor](./monitor.md#class-monitor), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4515
4300
|
|
|
4516
4301
|
###### Property checkNow
|
|
4517
4302
|
|
|
@@ -4536,12 +4321,13 @@ depending on chaintracks succeeding on proof verification.
|
|
|
4536
4321
|
Increments attempts if proofs where requested.
|
|
4537
4322
|
|
|
4538
4323
|
```ts
|
|
4539
|
-
async getProofs(reqs:
|
|
4540
|
-
proven:
|
|
4541
|
-
invalid:
|
|
4324
|
+
async getProofs(reqs: TableProvenTxReq[], indent = 0, countsAsAttempt = false, ignoreStatus = false): Promise<{
|
|
4325
|
+
proven: TableProvenTxReq[];
|
|
4326
|
+
invalid: TableProvenTxReq[];
|
|
4542
4327
|
log: string;
|
|
4543
4328
|
}>
|
|
4544
4329
|
```
|
|
4330
|
+
See also: [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
4545
4331
|
|
|
4546
4332
|
Returns
|
|
4547
4333
|
|
|
@@ -4557,8 +4343,6 @@ trigger(nowMsecsSinceEpoch: number): {
|
|
|
4557
4343
|
}
|
|
4558
4344
|
```
|
|
4559
4345
|
|
|
4560
|
-
</details>
|
|
4561
|
-
|
|
4562
4346
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4563
4347
|
|
|
4564
4348
|
---
|
|
@@ -4577,7 +4361,7 @@ export class TaskClock extends WalletMonitorTask {
|
|
|
4577
4361
|
}
|
|
4578
4362
|
```
|
|
4579
4363
|
|
|
4580
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4364
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4581
4365
|
|
|
4582
4366
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4583
4367
|
|
|
@@ -4602,7 +4386,7 @@ export class TaskFailAbandoned extends WalletMonitorTask {
|
|
|
4602
4386
|
}
|
|
4603
4387
|
```
|
|
4604
4388
|
|
|
4605
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4389
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4606
4390
|
|
|
4607
4391
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4608
4392
|
|
|
@@ -4622,7 +4406,7 @@ export class TaskNewHeader extends WalletMonitorTask {
|
|
|
4622
4406
|
}
|
|
4623
4407
|
```
|
|
4624
4408
|
|
|
4625
|
-
See also: [BlockHeader](#interface-blockheader), [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4409
|
+
See also: [BlockHeader](./client.md#interface-blockheader), [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4626
4410
|
|
|
4627
4411
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4628
4412
|
|
|
@@ -4641,11 +4425,7 @@ export class TaskPurge extends WalletMonitorTask {
|
|
|
4641
4425
|
}
|
|
4642
4426
|
```
|
|
4643
4427
|
|
|
4644
|
-
See also: [Monitor](#class-monitor), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
4645
|
-
|
|
4646
|
-
<details>
|
|
4647
|
-
|
|
4648
|
-
<summary>Class TaskPurge Details</summary>
|
|
4428
|
+
See also: [Monitor](./monitor.md#class-monitor), [TaskPurgeParams](./monitor.md#interface-taskpurgeparams), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4649
4429
|
|
|
4650
4430
|
###### Property checkNow
|
|
4651
4431
|
|
|
@@ -4655,8 +4435,6 @@ Set to true to trigger running this task
|
|
|
4655
4435
|
static checkNow = false
|
|
4656
4436
|
```
|
|
4657
4437
|
|
|
4658
|
-
</details>
|
|
4659
|
-
|
|
4660
4438
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4661
4439
|
|
|
4662
4440
|
---
|
|
@@ -4682,11 +4460,7 @@ export class TaskReviewStatus extends WalletMonitorTask {
|
|
|
4682
4460
|
}
|
|
4683
4461
|
```
|
|
4684
4462
|
|
|
4685
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4686
|
-
|
|
4687
|
-
<details>
|
|
4688
|
-
|
|
4689
|
-
<summary>Class TaskReviewStatus Details</summary>
|
|
4463
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4690
4464
|
|
|
4691
4465
|
###### Property checkNow
|
|
4692
4466
|
|
|
@@ -4696,8 +4470,6 @@ Set to true to trigger running this task
|
|
|
4696
4470
|
static checkNow = false
|
|
4697
4471
|
```
|
|
4698
4472
|
|
|
4699
|
-
</details>
|
|
4700
|
-
|
|
4701
4473
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4702
4474
|
|
|
4703
4475
|
---
|
|
@@ -4711,15 +4483,11 @@ export class TaskSendWaiting extends WalletMonitorTask {
|
|
|
4711
4483
|
run: boolean;
|
|
4712
4484
|
}
|
|
4713
4485
|
async runTask(): Promise<string>
|
|
4714
|
-
async processUnsent(reqApis:
|
|
4486
|
+
async processUnsent(reqApis: TableProvenTxReq[], indent = 0): Promise<string>
|
|
4715
4487
|
}
|
|
4716
4488
|
```
|
|
4717
4489
|
|
|
4718
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4719
|
-
|
|
4720
|
-
<details>
|
|
4721
|
-
|
|
4722
|
-
<summary>Class TaskSendWaiting Details</summary>
|
|
4490
|
+
See also: [Monitor](./monitor.md#class-monitor), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4723
4491
|
|
|
4724
4492
|
###### Method processUnsent
|
|
4725
4493
|
|
|
@@ -4738,10 +4506,9 @@ Add mapi responses to database table if received.
|
|
|
4738
4506
|
Increments attempts if sending was attempted.
|
|
4739
4507
|
|
|
4740
4508
|
```ts
|
|
4741
|
-
async processUnsent(reqApis:
|
|
4509
|
+
async processUnsent(reqApis: TableProvenTxReq[], indent = 0): Promise<string>
|
|
4742
4510
|
```
|
|
4743
|
-
|
|
4744
|
-
</details>
|
|
4511
|
+
See also: [TableProvenTxReq](./storage.md#interface-tableproventxreq)
|
|
4745
4512
|
|
|
4746
4513
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4747
4514
|
|
|
@@ -4759,7 +4526,7 @@ export class TaskSyncWhenIdle extends WalletMonitorTask {
|
|
|
4759
4526
|
}
|
|
4760
4527
|
```
|
|
4761
4528
|
|
|
4762
|
-
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4529
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
4763
4530
|
|
|
4764
4531
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4765
4532
|
|
|
@@ -4774,7 +4541,7 @@ export class WERR_BAD_REQUEST extends WalletError {
|
|
|
4774
4541
|
}
|
|
4775
4542
|
```
|
|
4776
4543
|
|
|
4777
|
-
See also: [WalletError](#class-walleterror)
|
|
4544
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4778
4545
|
|
|
4779
4546
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4780
4547
|
|
|
@@ -4792,11 +4559,7 @@ export class WERR_INSUFFICIENT_FUNDS extends WalletError {
|
|
|
4792
4559
|
}
|
|
4793
4560
|
```
|
|
4794
4561
|
|
|
4795
|
-
See also: [WalletError](#class-walleterror)
|
|
4796
|
-
|
|
4797
|
-
<details>
|
|
4798
|
-
|
|
4799
|
-
<summary>Class WERR_INSUFFICIENT_FUNDS Details</summary>
|
|
4562
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4800
4563
|
|
|
4801
4564
|
###### Constructor
|
|
4802
4565
|
|
|
@@ -4811,8 +4574,6 @@ Argument Details
|
|
|
4811
4574
|
+ **moreSatoshisNeeded**
|
|
4812
4575
|
+ Shortfall on total satoshis required to fund transactions after net of required inputs and outputs.
|
|
4813
4576
|
|
|
4814
|
-
</details>
|
|
4815
|
-
|
|
4816
4577
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4817
4578
|
|
|
4818
4579
|
---
|
|
@@ -4828,7 +4589,7 @@ export class WERR_INTERNAL extends WalletError {
|
|
|
4828
4589
|
}
|
|
4829
4590
|
```
|
|
4830
4591
|
|
|
4831
|
-
See also: [WalletError](#class-walleterror)
|
|
4592
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4832
4593
|
|
|
4833
4594
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4834
4595
|
|
|
@@ -4845,7 +4606,7 @@ export class WERR_INVALID_OPERATION extends WalletError {
|
|
|
4845
4606
|
}
|
|
4846
4607
|
```
|
|
4847
4608
|
|
|
4848
|
-
See also: [WalletError](#class-walleterror)
|
|
4609
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4849
4610
|
|
|
4850
4611
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4851
4612
|
|
|
@@ -4862,7 +4623,7 @@ export class WERR_INVALID_PARAMETER extends WalletError {
|
|
|
4862
4623
|
}
|
|
4863
4624
|
```
|
|
4864
4625
|
|
|
4865
|
-
See also: [WalletError](#class-walleterror)
|
|
4626
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4866
4627
|
|
|
4867
4628
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4868
4629
|
|
|
@@ -4875,11 +4636,7 @@ export class WERR_INVALID_PUBLIC_KEY extends WalletError {
|
|
|
4875
4636
|
}
|
|
4876
4637
|
```
|
|
4877
4638
|
|
|
4878
|
-
See also: [WalletError](#class-walleterror)
|
|
4879
|
-
|
|
4880
|
-
<details>
|
|
4881
|
-
|
|
4882
|
-
<summary>Class WERR_INVALID_PUBLIC_KEY Details</summary>
|
|
4639
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4883
4640
|
|
|
4884
4641
|
###### Constructor
|
|
4885
4642
|
|
|
@@ -4894,8 +4651,6 @@ Argument Details
|
|
|
4894
4651
|
+ **environment**
|
|
4895
4652
|
+ Optional environment flag to control whether the key is included in the message.
|
|
4896
4653
|
|
|
4897
|
-
</details>
|
|
4898
|
-
|
|
4899
4654
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4900
4655
|
|
|
4901
4656
|
---
|
|
@@ -4911,7 +4666,7 @@ export class WERR_MISSING_PARAMETER extends WalletError {
|
|
|
4911
4666
|
}
|
|
4912
4667
|
```
|
|
4913
4668
|
|
|
4914
|
-
See also: [WalletError](#class-walleterror)
|
|
4669
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4915
4670
|
|
|
4916
4671
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4917
4672
|
|
|
@@ -4926,7 +4681,7 @@ export class WERR_NETWORK_CHAIN extends WalletError {
|
|
|
4926
4681
|
}
|
|
4927
4682
|
```
|
|
4928
4683
|
|
|
4929
|
-
See also: [WalletError](#class-walleterror)
|
|
4684
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4930
4685
|
|
|
4931
4686
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4932
4687
|
|
|
@@ -4941,7 +4696,7 @@ export class WERR_NOT_ACTIVE extends WalletError {
|
|
|
4941
4696
|
}
|
|
4942
4697
|
```
|
|
4943
4698
|
|
|
4944
|
-
See also: [WalletError](#class-walleterror)
|
|
4699
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4945
4700
|
|
|
4946
4701
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4947
4702
|
|
|
@@ -4956,7 +4711,7 @@ export class WERR_NOT_IMPLEMENTED extends WalletError {
|
|
|
4956
4711
|
}
|
|
4957
4712
|
```
|
|
4958
4713
|
|
|
4959
|
-
See also: [WalletError](#class-walleterror)
|
|
4714
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4960
4715
|
|
|
4961
4716
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4962
4717
|
|
|
@@ -4971,7 +4726,7 @@ export class WERR_UNAUTHORIZED extends WalletError {
|
|
|
4971
4726
|
}
|
|
4972
4727
|
```
|
|
4973
4728
|
|
|
4974
|
-
See also: [WalletError](#class-walleterror)
|
|
4729
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
4975
4730
|
|
|
4976
4731
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4977
4732
|
|
|
@@ -5032,11 +4787,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
5032
4787
|
}
|
|
5033
4788
|
```
|
|
5034
4789
|
|
|
5035
|
-
See also: [Chain](#type-chain), [KeyPair](#interface-keypair), [Monitor](#class-monitor), [PendingSignAction](#interface-pendingsignaction), [PrivilegedKeyManager](#class-privilegedkeymanager), [StorageIdentity](#interface-storageidentity), [WalletArgs](#interface-walletargs), [WalletServices](#interface-walletservices), [WalletSigner](#class-walletsigner), [WalletStorageManager](#class-walletstoragemanager), [createAction](#function-createaction), [getIdentityKey](#function-getidentitykey), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [proveCertificate](#function-provecertificate), [signAction](#function-signaction)
|
|
5036
|
-
|
|
5037
|
-
<details>
|
|
5038
|
-
|
|
5039
|
-
<summary>Class Wallet Details</summary>
|
|
4790
|
+
See also: [Chain](./client.md#type-chain), [KeyPair](./client.md#interface-keypair), [Monitor](./monitor.md#class-monitor), [PendingSignAction](./client.md#interface-pendingsignaction), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [StorageIdentity](./client.md#interface-storageidentity), [WalletArgs](./client.md#interface-walletargs), [WalletServices](./client.md#interface-walletservices), [WalletSigner](./client.md#class-walletsigner), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [getIdentityKey](./client.md#function-getidentitykey), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [proveCertificate](./client.md#function-provecertificate), [signAction](./client.md#function-signaction)
|
|
5040
4791
|
|
|
5041
4792
|
###### Property beef
|
|
5042
4793
|
|
|
@@ -5076,8 +4827,6 @@ Argument Details
|
|
|
5076
4827
|
+ **newKnownTxids**
|
|
5077
4828
|
+ Optional. Additional new txids known to be valid by the caller to be merged.
|
|
5078
4829
|
|
|
5079
|
-
</details>
|
|
5080
|
-
|
|
5081
4830
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5082
4831
|
|
|
5083
4832
|
---
|
|
@@ -5113,10 +4862,6 @@ export class WalletError extends Error implements WalletErrorObject {
|
|
|
5113
4862
|
}
|
|
5114
4863
|
```
|
|
5115
4864
|
|
|
5116
|
-
<details>
|
|
5117
|
-
|
|
5118
|
-
<summary>Class WalletError Details</summary>
|
|
5119
|
-
|
|
5120
4865
|
###### Method asStatus
|
|
5121
4866
|
|
|
5122
4867
|
```ts
|
|
@@ -5138,9 +4883,7 @@ Recovers all public fields from WalletError derived error classes and relevant E
|
|
|
5138
4883
|
```ts
|
|
5139
4884
|
static fromUnknown(err: unknown): WalletError
|
|
5140
4885
|
```
|
|
5141
|
-
See also: [WalletError](#class-walleterror)
|
|
5142
|
-
|
|
5143
|
-
</details>
|
|
4886
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
5144
4887
|
|
|
5145
4888
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5146
4889
|
|
|
@@ -5174,11 +4917,7 @@ export abstract class WalletMonitorTask {
|
|
|
5174
4917
|
}
|
|
5175
4918
|
```
|
|
5176
4919
|
|
|
5177
|
-
See also: [Monitor](#class-monitor), [MonitorStorage](#type-monitorstorage)
|
|
5178
|
-
|
|
5179
|
-
<details>
|
|
5180
|
-
|
|
5181
|
-
<summary>Class WalletMonitorTask Details</summary>
|
|
4920
|
+
See also: [Monitor](./monitor.md#class-monitor), [MonitorStorage](./monitor.md#type-monitorstorage)
|
|
5182
4921
|
|
|
5183
4922
|
###### Property lastRunMsecsSinceEpoch
|
|
5184
4923
|
|
|
@@ -5208,8 +4947,6 @@ abstract trigger(nowMsecsSinceEpoch: number): {
|
|
|
5208
4947
|
}
|
|
5209
4948
|
```
|
|
5210
4949
|
|
|
5211
|
-
</details>
|
|
5212
|
-
|
|
5213
4950
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5214
4951
|
|
|
5215
4952
|
---
|
|
@@ -5225,7 +4962,7 @@ export class WalletSigner {
|
|
|
5225
4962
|
}
|
|
5226
4963
|
```
|
|
5227
4964
|
|
|
5228
|
-
See also: [Chain](#type-chain), [WalletStorageManager](#class-walletstoragemanager)
|
|
4965
|
+
See also: [Chain](./client.md#type-chain), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
5229
4966
|
|
|
5230
4967
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5231
4968
|
|
|
@@ -5275,12 +5012,12 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
5275
5012
|
async addWalletStorageProvider(provider: sdk.WalletStorageProvider): Promise<void>
|
|
5276
5013
|
setServices(v: sdk.WalletServices)
|
|
5277
5014
|
getServices(): sdk.WalletServices
|
|
5278
|
-
getSettings():
|
|
5279
|
-
async makeAvailable(): Promise<
|
|
5015
|
+
getSettings(): TableSettings
|
|
5016
|
+
async makeAvailable(): Promise<TableSettings>
|
|
5280
5017
|
async migrate(storageName: string, storageIdentityKey: string): Promise<string>
|
|
5281
5018
|
async destroy(): Promise<void>
|
|
5282
5019
|
async findOrInsertUser(identityKey: string): Promise<{
|
|
5283
|
-
user:
|
|
5020
|
+
user: TableUser;
|
|
5284
5021
|
isNew: boolean;
|
|
5285
5022
|
}>
|
|
5286
5023
|
async abortAction(args: AbortActionArgs): Promise<AbortActionResult>
|
|
@@ -5289,14 +5026,14 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
5289
5026
|
async relinquishCertificate(args: RelinquishCertificateArgs): Promise<number>
|
|
5290
5027
|
async relinquishOutput(args: RelinquishOutputArgs): Promise<number>
|
|
5291
5028
|
async processAction(args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
|
|
5292
|
-
async insertCertificate(certificate:
|
|
5029
|
+
async insertCertificate(certificate: TableCertificate): Promise<number>
|
|
5293
5030
|
async listActions(vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>
|
|
5294
5031
|
async listCertificates(args: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>
|
|
5295
5032
|
async listOutputs(vargs: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>
|
|
5296
|
-
async findCertificates(args: sdk.FindCertificatesArgs): Promise<
|
|
5297
|
-
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<
|
|
5298
|
-
async findOutputs(args: sdk.FindOutputsArgs): Promise<
|
|
5299
|
-
async findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<
|
|
5033
|
+
async findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificate[]>
|
|
5034
|
+
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
5035
|
+
async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
5036
|
+
async findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
|
|
5300
5037
|
async syncFromReader(identityKey: string, reader: StorageSyncReader): Promise<void>
|
|
5301
5038
|
async updateBackups(activeSync?: sdk.WalletStorageSync)
|
|
5302
5039
|
async syncToWriter(auth: sdk.AuthId, writer: sdk.WalletStorageProvider, activeSync?: sdk.WalletStorageSync): Promise<{
|
|
@@ -5307,11 +5044,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
5307
5044
|
}
|
|
5308
5045
|
```
|
|
5309
5046
|
|
|
5310
|
-
See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [StorageProvider](#class-storageprovider), [StorageSyncReader](#class-storagesyncreader), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListActionsArgs](#interface-validlistactionsargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [ValidListOutputsArgs](#interface-validlistoutputsargs), [WalletServices](#interface-walletservices), [WalletStorage](#interface-walletstorage), [WalletStorageProvider](#interface-walletstorageprovider), [WalletStorageReader](#interface-walletstoragereader), [WalletStorageSync](#interface-walletstoragesync), [WalletStorageWriter](#interface-walletstoragewriter), [createAction](#function-createaction), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
5311
|
-
|
|
5312
|
-
<details>
|
|
5313
|
-
|
|
5314
|
-
<summary>Class WalletStorageManager Details</summary>
|
|
5047
|
+
See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [StorageSyncReader](./storage.md#class-storagesyncreader), [TableCertificate](./storage.md#interface-tablecertificate), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorage](./client.md#interface-walletstorage), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [WalletStorageReader](./client.md#interface-walletstoragereader), [WalletStorageSync](./client.md#interface-walletstoragesync), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
|
|
5315
5048
|
|
|
5316
5049
|
###### Property _isSingleWriter
|
|
5317
5050
|
|
|
@@ -5355,7 +5088,7 @@ true if the active `WalletStorageProvider` also implements `StorageProvider`
|
|
|
5355
5088
|
```ts
|
|
5356
5089
|
async runAsSync<R>(sync: (active: sdk.WalletStorageSync) => Promise<R>, activeSync?: sdk.WalletStorageSync): Promise<R>
|
|
5357
5090
|
```
|
|
5358
|
-
See also: [WalletStorageSync](#interface-walletstoragesync)
|
|
5091
|
+
See also: [WalletStorageSync](./client.md#interface-walletstoragesync)
|
|
5359
5092
|
|
|
5360
5093
|
Argument Details
|
|
5361
5094
|
|
|
@@ -5377,8 +5110,6 @@ Argument Details
|
|
|
5377
5110
|
+ **storageIdentityKey**
|
|
5378
5111
|
+ of current backup storage provider that is to become the new active provider.
|
|
5379
5112
|
|
|
5380
|
-
</details>
|
|
5381
|
-
|
|
5382
5113
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5383
5114
|
|
|
5384
5115
|
---
|
|
@@ -5435,7 +5166,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5435
5166
|
export async function acquireDirectCertificate(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidAcquireDirectCertificateArgs): Promise<AcquireCertificateResult>
|
|
5436
5167
|
```
|
|
5437
5168
|
|
|
5438
|
-
See also: [AuthId](#interface-authid), [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs), [Wallet](#class-wallet)
|
|
5169
|
+
See also: [AuthId](./client.md#interface-authid), [ValidAcquireDirectCertificateArgs](./client.md#interface-validacquiredirectcertificateargs), [Wallet](./client.md#class-wallet)
|
|
5439
5170
|
|
|
5440
5171
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5441
5172
|
|
|
@@ -5466,17 +5197,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5466
5197
|
export function asBsvSdkPrivateKey(privKey: string): PrivateKey
|
|
5467
5198
|
```
|
|
5468
5199
|
|
|
5469
|
-
<details>
|
|
5470
|
-
|
|
5471
|
-
<summary>Function asBsvSdkPrivateKey Details</summary>
|
|
5472
|
-
|
|
5473
5200
|
Argument Details
|
|
5474
5201
|
|
|
5475
5202
|
+ **privKey**
|
|
5476
5203
|
+ bitcoin private key in 32 byte hex string form
|
|
5477
5204
|
|
|
5478
|
-
</details>
|
|
5479
|
-
|
|
5480
5205
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5481
5206
|
|
|
5482
5207
|
---
|
|
@@ -5486,17 +5211,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5486
5211
|
export function asBsvSdkPublickKey(pubKey: string): PublicKey
|
|
5487
5212
|
```
|
|
5488
5213
|
|
|
5489
|
-
<details>
|
|
5490
|
-
|
|
5491
|
-
<summary>Function asBsvSdkPublickKey Details</summary>
|
|
5492
|
-
|
|
5493
5214
|
Argument Details
|
|
5494
5215
|
|
|
5495
5216
|
+ **pubKey**
|
|
5496
5217
|
+ bitcoin public key in standard compressed key hex string form
|
|
5497
5218
|
|
|
5498
|
-
</details>
|
|
5499
|
-
|
|
5500
5219
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5501
5220
|
|
|
5502
5221
|
---
|
|
@@ -5552,10 +5271,6 @@ export function asString(val: string | number[]): string {
|
|
|
5552
5271
|
}
|
|
5553
5272
|
```
|
|
5554
5273
|
|
|
5555
|
-
<details>
|
|
5556
|
-
|
|
5557
|
-
<summary>Function asString Details</summary>
|
|
5558
|
-
|
|
5559
5274
|
Returns
|
|
5560
5275
|
|
|
5561
5276
|
input val if it is a string; or if number[], converts byte values to hex
|
|
@@ -5565,8 +5280,6 @@ Argument Details
|
|
|
5565
5280
|
+ **val**
|
|
5566
5281
|
+ string or number[]. If string, encoding must be hex. If number[], each value must be 0..255.
|
|
5567
5282
|
|
|
5568
|
-
</details>
|
|
5569
|
-
|
|
5570
5283
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5571
5284
|
|
|
5572
5285
|
---
|
|
@@ -5576,10 +5289,10 @@ Attempt to post one or more `ProvenTxReq` with status 'unsent'
|
|
|
5576
5289
|
to the bitcoin network.
|
|
5577
5290
|
|
|
5578
5291
|
```ts
|
|
5579
|
-
export async function attemptToPostReqsToNetwork(storage: StorageProvider, reqs:
|
|
5292
|
+
export async function attemptToPostReqsToNetwork(storage: StorageProvider, reqs: EntityProvenTxReq[], trx?: sdk.TrxToken): Promise<PostReqsToNetworkResult>
|
|
5580
5293
|
```
|
|
5581
5294
|
|
|
5582
|
-
See also: [PostReqsToNetworkResult](#interface-postreqstonetworkresult), [StorageProvider](#class-storageprovider), [TrxToken](#interface-trxtoken)
|
|
5295
|
+
See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq), [PostReqsToNetworkResult](./storage.md#interface-postreqstonetworkresult), [StorageProvider](./storage.md#class-storageprovider), [TrxToken](./client.md#interface-trxtoken)
|
|
5583
5296
|
|
|
5584
5297
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5585
5298
|
|
|
@@ -5590,7 +5303,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5590
5303
|
export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<Transaction>
|
|
5591
5304
|
```
|
|
5592
5305
|
|
|
5593
|
-
See also: [PendingSignAction](#interface-pendingsignaction), [Wallet](#class-wallet)
|
|
5306
|
+
See also: [PendingSignAction](./client.md#interface-pendingsignaction), [Wallet](./client.md#class-wallet)
|
|
5594
5307
|
|
|
5595
5308
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5596
5309
|
|
|
@@ -5601,7 +5314,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5601
5314
|
export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<BsvTransaction>
|
|
5602
5315
|
```
|
|
5603
5316
|
|
|
5604
|
-
See also: [PendingSignAction](#interface-pendingsignaction), [Wallet](#class-wallet)
|
|
5317
|
+
See also: [PendingSignAction](./client.md#interface-pendingsignaction), [Wallet](./client.md#class-wallet)
|
|
5605
5318
|
|
|
5606
5319
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5607
5320
|
|
|
@@ -5612,7 +5325,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5612
5325
|
export function convertProofToMerklePath(txid: string, proof: TscMerkleProofApi): MerklePath
|
|
5613
5326
|
```
|
|
5614
5327
|
|
|
5615
|
-
See also: [TscMerkleProofApi](#interface-tscmerkleproofapi)
|
|
5328
|
+
See also: [TscMerkleProofApi](./client.md#interface-tscmerkleproofapi)
|
|
5616
5329
|
|
|
5617
5330
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5618
5331
|
|
|
@@ -5623,7 +5336,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5623
5336
|
export async function createAction(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidCreateActionArgs): Promise<CreateActionResult>
|
|
5624
5337
|
```
|
|
5625
5338
|
|
|
5626
|
-
See also: [AuthId](#interface-authid), [ValidCreateActionArgs](#interface-validcreateactionargs), [Wallet](#class-wallet)
|
|
5339
|
+
See also: [AuthId](./client.md#interface-authid), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [Wallet](./client.md#class-wallet)
|
|
5627
5340
|
|
|
5628
5341
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5629
5342
|
|
|
@@ -5634,7 +5347,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5634
5347
|
export async function createAction(storage: StorageProvider, auth: sdk.AuthId, vargs: sdk.ValidCreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<sdk.StorageCreateActionResult>
|
|
5635
5348
|
```
|
|
5636
5349
|
|
|
5637
|
-
See also: [AuthId](#interface-authid), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProvider](#class-storageprovider), [ValidCreateActionArgs](#interface-validcreateactionargs)
|
|
5350
|
+
See also: [AuthId](./client.md#interface-authid), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProvider](./storage.md#class-storageprovider), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs)
|
|
5638
5351
|
|
|
5639
5352
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5640
5353
|
|
|
@@ -5645,7 +5358,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5645
5358
|
export function createDefaultWalletServicesOptions(chain: sdk.Chain): sdk.WalletServicesOptions
|
|
5646
5359
|
```
|
|
5647
5360
|
|
|
5648
|
-
See also: [Chain](#type-chain), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
5361
|
+
See also: [Chain](./client.md#type-chain), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
5649
5362
|
|
|
5650
5363
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5651
5364
|
|
|
@@ -5672,11 +5385,7 @@ export function doubleSha256BE(data: number[]): number[] {
|
|
|
5672
5385
|
}
|
|
5673
5386
|
```
|
|
5674
5387
|
|
|
5675
|
-
See also: [doubleSha256HashLE](#function-doublesha256hashle)
|
|
5676
|
-
|
|
5677
|
-
<details>
|
|
5678
|
-
|
|
5679
|
-
<summary>Function doubleSha256BE Details</summary>
|
|
5388
|
+
See also: [doubleSha256HashLE](./client.md#function-doublesha256hashle)
|
|
5680
5389
|
|
|
5681
5390
|
Returns
|
|
5682
5391
|
|
|
@@ -5687,8 +5396,6 @@ Argument Details
|
|
|
5687
5396
|
+ **data**
|
|
5688
5397
|
+ is an array of bytes.
|
|
5689
5398
|
|
|
5690
|
-
</details>
|
|
5691
|
-
|
|
5692
5399
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5693
5400
|
|
|
5694
5401
|
---
|
|
@@ -5704,10 +5411,6 @@ export function doubleSha256HashLE(data: number[]): number[] {
|
|
|
5704
5411
|
}
|
|
5705
5412
|
```
|
|
5706
5413
|
|
|
5707
|
-
<details>
|
|
5708
|
-
|
|
5709
|
-
<summary>Function doubleSha256HashLE Details</summary>
|
|
5710
|
-
|
|
5711
5414
|
Returns
|
|
5712
5415
|
|
|
5713
5416
|
double sha256 hash of data, byte 0 of hash first.
|
|
@@ -5717,8 +5420,6 @@ Argument Details
|
|
|
5717
5420
|
+ **data**
|
|
5718
5421
|
+ an array of bytes
|
|
5719
5422
|
|
|
5720
|
-
</details>
|
|
5721
|
-
|
|
5722
5423
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5723
5424
|
|
|
5724
5425
|
---
|
|
@@ -5734,7 +5435,7 @@ Confirms for each availbleChange output that it remains available as they are al
|
|
|
5734
5435
|
export async function generateChangeSdk(params: GenerateChangeSdkParams, allocateChangeInput: (targetSatoshis: number, exactSatoshis?: number) => Promise<GenerateChangeSdkChangeInput | undefined>, releaseChangeInput: (outputId: number) => Promise<void>): Promise<GenerateChangeSdkResult>
|
|
5735
5436
|
```
|
|
5736
5437
|
|
|
5737
|
-
See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput), [GenerateChangeSdkParams](#interface-generatechangesdkparams), [GenerateChangeSdkResult](#interface-generatechangesdkresult)
|
|
5438
|
+
See also: [GenerateChangeSdkChangeInput](./storage.md#interface-generatechangesdkchangeinput), [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams), [GenerateChangeSdkResult](./storage.md#interface-generatechangesdkresult)
|
|
5738
5439
|
|
|
5739
5440
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5740
5441
|
|
|
@@ -5749,7 +5450,7 @@ export function generateChangeSdkMakeStorage(availableChange: GenerateChangeSdkC
|
|
|
5749
5450
|
}
|
|
5750
5451
|
```
|
|
5751
5452
|
|
|
5752
|
-
See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput)
|
|
5453
|
+
See also: [GenerateChangeSdkChangeInput](./storage.md#interface-generatechangesdkchangeinput)
|
|
5753
5454
|
|
|
5754
5455
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5755
5456
|
|
|
@@ -5773,11 +5474,7 @@ If `knownTxids` is defined, any 'txid' required by the `Beef` that appears in th
|
|
|
5773
5474
|
export async function getBeefForTransaction(storage: StorageProvider, txid: string, options: sdk.StorageGetBeefOptions): Promise<Beef>
|
|
5774
5475
|
```
|
|
5775
5476
|
|
|
5776
|
-
See also: [StorageGetBeefOptions](#interface-storagegetbeefoptions), [StorageProvider](#class-storageprovider)
|
|
5777
|
-
|
|
5778
|
-
<details>
|
|
5779
|
-
|
|
5780
|
-
<summary>Function getBeefForTransaction Details</summary>
|
|
5477
|
+
See also: [StorageGetBeefOptions](./client.md#interface-storagegetbeefoptions), [StorageProvider](./storage.md#class-storageprovider)
|
|
5781
5478
|
|
|
5782
5479
|
Argument Details
|
|
5783
5480
|
|
|
@@ -5786,8 +5483,6 @@ Argument Details
|
|
|
5786
5483
|
+ **txid**
|
|
5787
5484
|
+ the transaction hash for which an envelope is requested.
|
|
5788
5485
|
|
|
5789
|
-
</details>
|
|
5790
|
-
|
|
5791
5486
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5792
5487
|
|
|
5793
5488
|
---
|
|
@@ -5797,7 +5492,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5797
5492
|
export async function getExchangeRatesIo(key: string): Promise<ExchangeRatesIoApi>
|
|
5798
5493
|
```
|
|
5799
5494
|
|
|
5800
|
-
See also: [ExchangeRatesIoApi](#interface-exchangeratesioapi)
|
|
5495
|
+
See also: [ExchangeRatesIoApi](./services.md#interface-exchangeratesioapi)
|
|
5801
5496
|
|
|
5802
5497
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5803
5498
|
|
|
@@ -5808,7 +5503,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5808
5503
|
export async function getIdentityKey(wallet: CertOpsWallet): Promise<PubKeyHex>
|
|
5809
5504
|
```
|
|
5810
5505
|
|
|
5811
|
-
See also: [CertOpsWallet](#interface-certopswallet)
|
|
5506
|
+
See also: [CertOpsWallet](./client.md#interface-certopswallet)
|
|
5812
5507
|
|
|
5813
5508
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5814
5509
|
|
|
@@ -5819,7 +5514,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5819
5514
|
export async function getMerklePathFromTaalARC(txid: string, config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
5820
5515
|
```
|
|
5821
5516
|
|
|
5822
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathResult](#interface-getmerklepathresult), [WalletServices](#interface-walletservices)
|
|
5517
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
5823
5518
|
|
|
5824
5519
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5825
5520
|
|
|
@@ -5836,7 +5531,7 @@ Duplicate hash values are provided in full instead of being replaced by "*".
|
|
|
5836
5531
|
export async function getMerklePathFromWhatsOnChainTsc(txid: string, chain: sdk.Chain, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
5837
5532
|
```
|
|
5838
5533
|
|
|
5839
|
-
See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathresult), [WalletServices](#interface-walletservices)
|
|
5534
|
+
See also: [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
5840
5535
|
|
|
5841
5536
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5842
5537
|
|
|
@@ -5847,7 +5542,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5847
5542
|
export async function getRawTxFromWhatsOnChain(txid: string, chain: sdk.Chain): Promise<sdk.GetRawTxResult>
|
|
5848
5543
|
```
|
|
5849
5544
|
|
|
5850
|
-
See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
|
|
5545
|
+
See also: [Chain](./client.md#type-chain), [GetRawTxResult](./client.md#interface-getrawtxresult)
|
|
5851
5546
|
|
|
5852
5547
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5853
5548
|
|
|
@@ -5860,7 +5555,7 @@ Gets the next sync chunk of updated data from un-remoted storage (could be using
|
|
|
5860
5555
|
export async function getSyncChunk(storage: StorageReader, args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk>
|
|
5861
5556
|
```
|
|
5862
5557
|
|
|
5863
|
-
See also: [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReader](#class-storagereader), [SyncChunk](#interface-syncchunk)
|
|
5558
|
+
See also: [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReader](./storage.md#class-storagereader), [SyncChunk](./client.md#interface-syncchunk)
|
|
5864
5559
|
|
|
5865
5560
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5866
5561
|
|
|
@@ -5871,7 +5566,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5871
5566
|
export function getTaalArcServiceConfig(chain: sdk.Chain, apiKey: string): ArcServiceConfig
|
|
5872
5567
|
```
|
|
5873
5568
|
|
|
5874
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [Chain](#type-chain)
|
|
5569
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [Chain](./client.md#type-chain)
|
|
5875
5570
|
|
|
5876
5571
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5877
5572
|
|
|
@@ -5882,7 +5577,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5882
5577
|
export async function getUtxoStatusFromWhatsOnChain(output: string, chain: sdk.Chain, outputFormat?: sdk.GetUtxoStatusOutputFormat): Promise<sdk.GetUtxoStatusResult>
|
|
5883
5578
|
```
|
|
5884
5579
|
|
|
5885
|
-
See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult)
|
|
5580
|
+
See also: [Chain](./client.md#type-chain), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
5886
5581
|
|
|
5887
5582
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5888
5583
|
|
|
@@ -5918,7 +5613,7 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
5918
5613
|
export async function internalizeAction(wallet: Wallet, auth: sdk.AuthId, args: InternalizeActionArgs): Promise<InternalizeActionResult>
|
|
5919
5614
|
```
|
|
5920
5615
|
|
|
5921
|
-
See also: [AuthId](#interface-authid), [Wallet](#class-wallet)
|
|
5616
|
+
See also: [AuthId](./client.md#interface-authid), [Wallet](./client.md#class-wallet)
|
|
5922
5617
|
|
|
5923
5618
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5924
5619
|
|
|
@@ -5954,7 +5649,7 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
5954
5649
|
export async function internalizeAction(storage: StorageProvider, auth: sdk.AuthId, args: InternalizeActionArgs): Promise<InternalizeActionResult>
|
|
5955
5650
|
```
|
|
5956
5651
|
|
|
5957
|
-
See also: [AuthId](#interface-authid), [StorageProvider](#class-storageprovider)
|
|
5652
|
+
See also: [AuthId](./client.md#interface-authid), [StorageProvider](./storage.md#class-storageprovider)
|
|
5958
5653
|
|
|
5959
5654
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5960
5655
|
|
|
@@ -5974,7 +5669,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5974
5669
|
export async function listCertificates(storage: StorageProvider, auth: sdk.AuthId, vargs: sdk.ValidListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListCertificatesResult>
|
|
5975
5670
|
```
|
|
5976
5671
|
|
|
5977
|
-
See also: [AuthId](#interface-authid), [StorageProvider](#class-storageprovider), [ValidListCertificatesArgs](#interface-validlistcertificatesargs)
|
|
5672
|
+
See also: [AuthId](./client.md#interface-authid), [StorageProvider](./storage.md#class-storageprovider), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs)
|
|
5978
5673
|
|
|
5979
5674
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5980
5675
|
|
|
@@ -6015,7 +5710,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6015
5710
|
export function makeErrorResult(error: sdk.WalletError, miner: ArcServiceConfig, beef: number[], txids: string[], dd?: ArcMinerPostBeefDataApi): sdk.PostBeefResult
|
|
6016
5711
|
```
|
|
6017
5712
|
|
|
6018
|
-
See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult), [WalletError](#class-walleterror)
|
|
5713
|
+
See also: [ArcMinerPostBeefDataApi](./services.md#interface-arcminerpostbeefdataapi), [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult), [WalletError](./client.md#class-walleterror)
|
|
6019
5714
|
|
|
6020
5715
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6021
5716
|
|
|
@@ -6026,7 +5721,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6026
5721
|
export function makeGetMerklePathFromTaalARC(config: ArcServiceConfig): sdk.GetMerklePathService
|
|
6027
5722
|
```
|
|
6028
5723
|
|
|
6029
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathService](#type-getmerklepathservice)
|
|
5724
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [GetMerklePathService](./client.md#type-getmerklepathservice)
|
|
6030
5725
|
|
|
6031
5726
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6032
5727
|
|
|
@@ -6037,7 +5732,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6037
5732
|
export function makePostBeefResult(dd: ArcMinerPostBeefDataApi, miner: ArcServiceConfig, beef: number[], txids: string[]): sdk.PostBeefResult
|
|
6038
5733
|
```
|
|
6039
5734
|
|
|
6040
|
-
See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult)
|
|
5735
|
+
See also: [ArcMinerPostBeefDataApi](./services.md#interface-arcminerpostbeefdataapi), [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
6041
5736
|
|
|
6042
5737
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6043
5738
|
|
|
@@ -6048,7 +5743,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6048
5743
|
export function makePostBeefToTaalARC(config: ArcServiceConfig): sdk.PostBeefService
|
|
6049
5744
|
```
|
|
6050
5745
|
|
|
6051
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefService](#type-postbeefservice)
|
|
5746
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefService](./client.md#type-postbeefservice)
|
|
6052
5747
|
|
|
6053
5748
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6054
5749
|
|
|
@@ -6059,7 +5754,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6059
5754
|
export function makePostTxsToTaalARC(config: ArcServiceConfig): sdk.PostTxsService
|
|
6060
5755
|
```
|
|
6061
5756
|
|
|
6062
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsService](#type-posttxsservice)
|
|
5757
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostTxsService](./client.md#type-posttxsservice)
|
|
6063
5758
|
|
|
6064
5759
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6065
5760
|
|
|
@@ -6100,7 +5795,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6100
5795
|
export function parseTxScriptOffsets(rawTx: number[]): TxScriptOffsets
|
|
6101
5796
|
```
|
|
6102
5797
|
|
|
6103
|
-
See also: [TxScriptOffsets](#interface-txscriptoffsets)
|
|
5798
|
+
See also: [TxScriptOffsets](./client.md#interface-txscriptoffsets)
|
|
6104
5799
|
|
|
6105
5800
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6106
5801
|
|
|
@@ -6123,7 +5818,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6123
5818
|
export async function postBeefToArcMiner(beef: Beef | number[], txids: string[], config: ArcServiceConfig): Promise<sdk.PostBeefResult>
|
|
6124
5819
|
```
|
|
6125
5820
|
|
|
6126
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult)
|
|
5821
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult)
|
|
6127
5822
|
|
|
6128
5823
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6129
5824
|
|
|
@@ -6134,7 +5829,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6134
5829
|
export async function postBeefToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostBeefResult>
|
|
6135
5830
|
```
|
|
6136
5831
|
|
|
6137
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#interface-postbeefresult), [WalletServices](#interface-walletservices)
|
|
5832
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostBeefResult](./client.md#interface-postbeefresult), [WalletServices](./client.md#interface-walletservices)
|
|
6138
5833
|
|
|
6139
5834
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6140
5835
|
|
|
@@ -6145,19 +5840,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6145
5840
|
export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostTxsResult>
|
|
6146
5841
|
```
|
|
6147
5842
|
|
|
6148
|
-
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface-walletservices)
|
|
6149
|
-
|
|
6150
|
-
<details>
|
|
6151
|
-
|
|
6152
|
-
<summary>Function postTxsToTaalArcMiner Details</summary>
|
|
5843
|
+
See also: [ArcServiceConfig](./services.md#interface-arcserviceconfig), [PostTxsResult](./client.md#interface-posttxsresult), [WalletServices](./client.md#interface-walletservices)
|
|
6153
5844
|
|
|
6154
5845
|
Argument Details
|
|
6155
5846
|
|
|
6156
5847
|
+ **txs**
|
|
6157
5848
|
+ All transactions must have source transactions. Will just source locking scripts and satoshis do?? toHexEF() is used.
|
|
6158
5849
|
|
|
6159
|
-
</details>
|
|
6160
|
-
|
|
6161
5850
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6162
5851
|
|
|
6163
5852
|
---
|
|
@@ -6167,7 +5856,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6167
5856
|
export async function processAction(prior: PendingSignAction | undefined, wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidProcessActionArgs): Promise<SendWithResult[] | undefined>
|
|
6168
5857
|
```
|
|
6169
5858
|
|
|
6170
|
-
See also: [AuthId](#interface-authid), [PendingSignAction](#interface-pendingsignaction), [ValidProcessActionArgs](#interface-validprocessactionargs), [Wallet](#class-wallet)
|
|
5859
|
+
See also: [AuthId](./client.md#interface-authid), [PendingSignAction](./client.md#interface-pendingsignaction), [ValidProcessActionArgs](./client.md#interface-validprocessactionargs), [Wallet](./client.md#class-wallet)
|
|
6171
5860
|
|
|
6172
5861
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6173
5862
|
|
|
@@ -6178,7 +5867,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6178
5867
|
export async function processAction(storage: StorageProvider, auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
|
|
6179
5868
|
```
|
|
6180
5869
|
|
|
6181
|
-
See also: [AuthId](#interface-authid), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [StorageProvider](#class-storageprovider)
|
|
5870
|
+
See also: [AuthId](./client.md#interface-authid), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider)
|
|
6182
5871
|
|
|
6183
5872
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6184
5873
|
|
|
@@ -6189,7 +5878,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6189
5878
|
export async function proveCertificate(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidProveCertificateArgs): Promise<ProveCertificateResult>
|
|
6190
5879
|
```
|
|
6191
5880
|
|
|
6192
|
-
See also: [AuthId](#interface-authid), [ValidProveCertificateArgs](#interface-validprovecertificateargs), [Wallet](#class-wallet)
|
|
5881
|
+
See also: [AuthId](./client.md#interface-authid), [ValidProveCertificateArgs](./client.md#interface-validprovecertificateargs), [Wallet](./client.md#class-wallet)
|
|
6193
5882
|
|
|
6194
5883
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6195
5884
|
|
|
@@ -6200,16 +5889,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6200
5889
|
export function randomBytes(count: number): number[]
|
|
6201
5890
|
```
|
|
6202
5891
|
|
|
6203
|
-
<details>
|
|
6204
|
-
|
|
6205
|
-
<summary>Function randomBytes Details</summary>
|
|
6206
|
-
|
|
6207
5892
|
Returns
|
|
6208
5893
|
|
|
6209
5894
|
count cryptographically secure random bytes as array of bytes
|
|
6210
5895
|
|
|
6211
|
-
</details>
|
|
6212
|
-
|
|
6213
5896
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6214
5897
|
|
|
6215
5898
|
---
|
|
@@ -6219,16 +5902,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6219
5902
|
export function randomBytesBase64(count: number): string
|
|
6220
5903
|
```
|
|
6221
5904
|
|
|
6222
|
-
<details>
|
|
6223
|
-
|
|
6224
|
-
<summary>Function randomBytesBase64 Details</summary>
|
|
6225
|
-
|
|
6226
5905
|
Returns
|
|
6227
5906
|
|
|
6228
5907
|
count cryptographically secure random bytes as base64 encoded string
|
|
6229
5908
|
|
|
6230
|
-
</details>
|
|
6231
|
-
|
|
6232
5909
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6233
5910
|
|
|
6234
5911
|
---
|
|
@@ -6238,16 +5915,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6238
5915
|
export function randomBytesHex(count: number): string
|
|
6239
5916
|
```
|
|
6240
5917
|
|
|
6241
|
-
<details>
|
|
6242
|
-
|
|
6243
|
-
<summary>Function randomBytesHex Details</summary>
|
|
6244
|
-
|
|
6245
5918
|
Returns
|
|
6246
5919
|
|
|
6247
5920
|
count cryptographically secure random bytes as hex encoded string
|
|
6248
5921
|
|
|
6249
|
-
</details>
|
|
6250
|
-
|
|
6251
5922
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6252
5923
|
|
|
6253
5924
|
---
|
|
@@ -6262,16 +5933,10 @@ export function sha256Hash(data: number[]): number[] {
|
|
|
6262
5933
|
}
|
|
6263
5934
|
```
|
|
6264
5935
|
|
|
6265
|
-
<details>
|
|
6266
|
-
|
|
6267
|
-
<summary>Function sha256Hash Details</summary>
|
|
6268
|
-
|
|
6269
5936
|
Returns
|
|
6270
5937
|
|
|
6271
5938
|
sha256 hash of buffer contents.
|
|
6272
5939
|
|
|
6273
|
-
</details>
|
|
6274
|
-
|
|
6275
5940
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6276
5941
|
|
|
6277
5942
|
---
|
|
@@ -6281,7 +5946,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6281
5946
|
export async function signAction(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidSignActionArgs): Promise<SignActionResult>
|
|
6282
5947
|
```
|
|
6283
5948
|
|
|
6284
|
-
See also: [AuthId](#interface-authid), [ValidSignActionArgs](#interface-validsignactionargs), [Wallet](#class-wallet)
|
|
5949
|
+
See also: [AuthId](./client.md#interface-authid), [ValidSignActionArgs](./client.md#interface-validsignactionargs), [Wallet](./client.md#class-wallet)
|
|
6285
5950
|
|
|
6286
5951
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6287
5952
|
|
|
@@ -6296,10 +5961,6 @@ export function stampLog(log: string | undefined | {
|
|
|
6296
5961
|
}, lineToAdd: string): string | undefined
|
|
6297
5962
|
```
|
|
6298
5963
|
|
|
6299
|
-
<details>
|
|
6300
|
-
|
|
6301
|
-
<summary>Function stampLog Details</summary>
|
|
6302
|
-
|
|
6303
5964
|
Returns
|
|
6304
5965
|
|
|
6305
5966
|
undefined or log extended by time stamped `lineToAdd` and new line.
|
|
@@ -6311,8 +5972,6 @@ Argument Details
|
|
|
6311
5972
|
+ **lineToAdd**
|
|
6312
5973
|
+ Content to add to line.
|
|
6313
5974
|
|
|
6314
|
-
</details>
|
|
6315
|
-
|
|
6316
5975
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6317
5976
|
|
|
6318
5977
|
---
|
|
@@ -6326,10 +5985,6 @@ Assumes log built by repeated calls to `stampLog`
|
|
|
6326
5985
|
export function stampLogFormat(log?: string): string
|
|
6327
5986
|
```
|
|
6328
5987
|
|
|
6329
|
-
<details>
|
|
6330
|
-
|
|
6331
|
-
<summary>Function stampLogFormat Details</summary>
|
|
6332
|
-
|
|
6333
5988
|
Returns
|
|
6334
5989
|
|
|
6335
5990
|
reformated multi-line event log
|
|
@@ -6339,8 +5994,6 @@ Argument Details
|
|
|
6339
5994
|
+ **log**
|
|
6340
5995
|
+ Each logged event starts with ISO time stamp, space, rest of line, terminated by `\n`.
|
|
6341
5996
|
|
|
6342
|
-
</details>
|
|
6343
|
-
|
|
6344
5997
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6345
5998
|
|
|
6346
5999
|
---
|
|
@@ -6365,18 +6018,12 @@ export function toBinaryBaseBlockHeader(header: sdk.BaseBlockHeader): number[] {
|
|
|
6365
6018
|
}
|
|
6366
6019
|
```
|
|
6367
6020
|
|
|
6368
|
-
See also: [BaseBlockHeader](#interface-baseblockheader), [asArray](#function-asarray)
|
|
6369
|
-
|
|
6370
|
-
<details>
|
|
6371
|
-
|
|
6372
|
-
<summary>Function toBinaryBaseBlockHeader Details</summary>
|
|
6021
|
+
See also: [BaseBlockHeader](./client.md#interface-baseblockheader), [asArray](./client.md#function-asarray)
|
|
6373
6022
|
|
|
6374
6023
|
Returns
|
|
6375
6024
|
|
|
6376
6025
|
80 byte array
|
|
6377
6026
|
|
|
6378
|
-
</details>
|
|
6379
|
-
|
|
6380
6027
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6381
6028
|
|
|
6382
6029
|
---
|
|
@@ -6386,7 +6033,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6386
6033
|
export function toWalletNetwork(chain: Chain): WalletNetwork
|
|
6387
6034
|
```
|
|
6388
6035
|
|
|
6389
|
-
See also: [Chain](#type-chain)
|
|
6036
|
+
See also: [Chain](./client.md#type-chain)
|
|
6390
6037
|
|
|
6391
6038
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6392
6039
|
|
|
@@ -6397,10 +6044,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6397
6044
|
export function transactionInputSize(scriptSize: number): number
|
|
6398
6045
|
```
|
|
6399
6046
|
|
|
6400
|
-
<details>
|
|
6401
|
-
|
|
6402
|
-
<summary>Function transactionInputSize Details</summary>
|
|
6403
|
-
|
|
6404
6047
|
Returns
|
|
6405
6048
|
|
|
6406
6049
|
serialized byte length a transaction input
|
|
@@ -6410,8 +6053,6 @@ Argument Details
|
|
|
6410
6053
|
+ **scriptSize**
|
|
6411
6054
|
+ byte length of input script
|
|
6412
6055
|
|
|
6413
|
-
</details>
|
|
6414
|
-
|
|
6415
6056
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6416
6057
|
|
|
6417
6058
|
---
|
|
@@ -6421,10 +6062,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6421
6062
|
export function transactionOutputSize(scriptSize: number): number
|
|
6422
6063
|
```
|
|
6423
6064
|
|
|
6424
|
-
<details>
|
|
6425
|
-
|
|
6426
|
-
<summary>Function transactionOutputSize Details</summary>
|
|
6427
|
-
|
|
6428
6065
|
Returns
|
|
6429
6066
|
|
|
6430
6067
|
serialized byte length a transaction output
|
|
@@ -6434,8 +6071,6 @@ Argument Details
|
|
|
6434
6071
|
+ **scriptSize**
|
|
6435
6072
|
+ byte length of output script
|
|
6436
6073
|
|
|
6437
|
-
</details>
|
|
6438
|
-
|
|
6439
6074
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6440
6075
|
|
|
6441
6076
|
---
|
|
@@ -6449,10 +6084,6 @@ and the size of each script.
|
|
|
6449
6084
|
export function transactionSize(inputs: number[], outputs: number[]): number
|
|
6450
6085
|
```
|
|
6451
6086
|
|
|
6452
|
-
<details>
|
|
6453
|
-
|
|
6454
|
-
<summary>Function transactionSize Details</summary>
|
|
6455
|
-
|
|
6456
6087
|
Returns
|
|
6457
6088
|
|
|
6458
6089
|
total transaction size in bytes
|
|
@@ -6464,8 +6095,6 @@ Argument Details
|
|
|
6464
6095
|
+ **outputs**
|
|
6465
6096
|
+ array of output script lengths, in bytes
|
|
6466
6097
|
|
|
6467
|
-
</details>
|
|
6468
|
-
|
|
6469
6098
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6470
6099
|
|
|
6471
6100
|
---
|
|
@@ -6475,7 +6104,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6475
6104
|
export async function updateBsvExchangeRate(rate?: sdk.BsvExchangeRate, updateMsecs?: number): Promise<sdk.BsvExchangeRate>
|
|
6476
6105
|
```
|
|
6477
6106
|
|
|
6478
|
-
See also: [BsvExchangeRate](#interface-bsvexchangerate)
|
|
6107
|
+
See also: [BsvExchangeRate](./client.md#interface-bsvexchangerate)
|
|
6479
6108
|
|
|
6480
6109
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6481
6110
|
|
|
@@ -6486,7 +6115,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6486
6115
|
export async function updateChaintracksFiatExchangeRates(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
|
|
6487
6116
|
```
|
|
6488
6117
|
|
|
6489
|
-
See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
6118
|
+
See also: [FiatExchangeRates](./client.md#interface-fiatexchangerates), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
6490
6119
|
|
|
6491
6120
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6492
6121
|
|
|
@@ -6497,7 +6126,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6497
6126
|
export async function updateExchangeratesapi(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
|
|
6498
6127
|
```
|
|
6499
6128
|
|
|
6500
|
-
See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
6129
|
+
See also: [FiatExchangeRates](./client.md#interface-fiatexchangerates), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
6501
6130
|
|
|
6502
6131
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6503
6132
|
|
|
@@ -6508,7 +6137,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6508
6137
|
export function validateAbortActionArgs(args: AbortActionArgs): ValidAbortActionArgs
|
|
6509
6138
|
```
|
|
6510
6139
|
|
|
6511
|
-
See also: [ValidAbortActionArgs](#interface-validabortactionargs)
|
|
6140
|
+
See also: [ValidAbortActionArgs](./client.md#interface-validabortactionargs)
|
|
6512
6141
|
|
|
6513
6142
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6514
6143
|
|
|
@@ -6519,19 +6148,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6519
6148
|
export async function validateAcquireCertificateArgs(args: AcquireCertificateArgs): Promise<ValidAcquireCertificateArgs>
|
|
6520
6149
|
```
|
|
6521
6150
|
|
|
6522
|
-
See also: [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs)
|
|
6523
|
-
|
|
6524
|
-
<details>
|
|
6525
|
-
|
|
6526
|
-
<summary>Function validateAcquireCertificateArgs Details</summary>
|
|
6151
|
+
See also: [ValidAcquireCertificateArgs](./client.md#interface-validacquirecertificateargs)
|
|
6527
6152
|
|
|
6528
6153
|
Argument Details
|
|
6529
6154
|
|
|
6530
6155
|
+ **subject**
|
|
6531
6156
|
+ Must be valid for "direct" `acquisitionProtocol`. public key of the certificate subject.
|
|
6532
6157
|
|
|
6533
|
-
</details>
|
|
6534
|
-
|
|
6535
6158
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6536
6159
|
|
|
6537
6160
|
---
|
|
@@ -6541,7 +6164,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6541
6164
|
export function validateAcquireDirectCertificateArgs(args: AcquireCertificateArgs): ValidAcquireDirectCertificateArgs
|
|
6542
6165
|
```
|
|
6543
6166
|
|
|
6544
|
-
See also: [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs)
|
|
6167
|
+
See also: [ValidAcquireDirectCertificateArgs](./client.md#interface-validacquiredirectcertificateargs)
|
|
6545
6168
|
|
|
6546
6169
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6547
6170
|
|
|
@@ -6552,7 +6175,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6552
6175
|
export function validateAcquireIssuanceCertificateArgs(args: AcquireCertificateArgs): ValidAcquireIssuanceCertificateArgs
|
|
6553
6176
|
```
|
|
6554
6177
|
|
|
6555
|
-
See also: [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs)
|
|
6178
|
+
See also: [ValidAcquireIssuanceCertificateArgs](./client.md#interface-validacquireissuancecertificateargs)
|
|
6556
6179
|
|
|
6557
6180
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6558
6181
|
|
|
@@ -6563,7 +6186,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6563
6186
|
export function validateBasketInsertion(args?: BasketInsertion): ValidBasketInsertion | undefined
|
|
6564
6187
|
```
|
|
6565
6188
|
|
|
6566
|
-
See also: [ValidBasketInsertion](#interface-validbasketinsertion)
|
|
6189
|
+
See also: [ValidBasketInsertion](./client.md#interface-validbasketinsertion)
|
|
6567
6190
|
|
|
6568
6191
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6569
6192
|
|
|
@@ -6574,7 +6197,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6574
6197
|
export function validateCreateActionArgs(args: CreateActionArgs): ValidCreateActionArgs
|
|
6575
6198
|
```
|
|
6576
6199
|
|
|
6577
|
-
See also: [ValidCreateActionArgs](#interface-validcreateactionargs)
|
|
6200
|
+
See also: [ValidCreateActionArgs](./client.md#interface-validcreateactionargs)
|
|
6578
6201
|
|
|
6579
6202
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6580
6203
|
|
|
@@ -6585,7 +6208,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6585
6208
|
export function validateCreateActionInput(i: CreateActionInput): ValidCreateActionInput
|
|
6586
6209
|
```
|
|
6587
6210
|
|
|
6588
|
-
See also: [ValidCreateActionInput](#interface-validcreateactioninput)
|
|
6211
|
+
See also: [ValidCreateActionInput](./client.md#interface-validcreateactioninput)
|
|
6589
6212
|
|
|
6590
6213
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6591
6214
|
|
|
@@ -6601,7 +6224,7 @@ Convert string outpoints to `{ txid: string, vout: number }`
|
|
|
6601
6224
|
export function validateCreateActionOptions(options?: CreateActionOptions): ValidCreateActionOptions
|
|
6602
6225
|
```
|
|
6603
6226
|
|
|
6604
|
-
See also: [ValidCreateActionOptions](#interface-validcreateactionoptions)
|
|
6227
|
+
See also: [ValidCreateActionOptions](./client.md#interface-validcreateactionoptions)
|
|
6605
6228
|
|
|
6606
6229
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6607
6230
|
|
|
@@ -6612,7 +6235,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6612
6235
|
export function validateCreateActionOutput(o: CreateActionOutput): ValidCreateActionOutput
|
|
6613
6236
|
```
|
|
6614
6237
|
|
|
6615
|
-
See also: [ValidCreateActionOutput](#interface-validcreateactionoutput)
|
|
6238
|
+
See also: [ValidCreateActionOutput](./client.md#interface-validcreateactionoutput)
|
|
6616
6239
|
|
|
6617
6240
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6618
6241
|
|
|
@@ -6623,7 +6246,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6623
6246
|
export function validateDiscoverByAttributesArgs(args: DiscoverByAttributesArgs): ValidDiscoverByAttributesArgs
|
|
6624
6247
|
```
|
|
6625
6248
|
|
|
6626
|
-
See also: [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs)
|
|
6249
|
+
See also: [ValidDiscoverByAttributesArgs](./client.md#interface-validdiscoverbyattributesargs)
|
|
6627
6250
|
|
|
6628
6251
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6629
6252
|
|
|
@@ -6634,7 +6257,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6634
6257
|
export function validateDiscoverByIdentityKeyArgs(args: DiscoverByIdentityKeyArgs): ValidDiscoverByIdentityKeyArgs
|
|
6635
6258
|
```
|
|
6636
6259
|
|
|
6637
|
-
See also: [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs)
|
|
6260
|
+
See also: [ValidDiscoverByIdentityKeyArgs](./client.md#interface-validdiscoverbyidentitykeyargs)
|
|
6638
6261
|
|
|
6639
6262
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6640
6263
|
|
|
@@ -6645,7 +6268,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6645
6268
|
export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams)
|
|
6646
6269
|
```
|
|
6647
6270
|
|
|
6648
|
-
See also: [GenerateChangeSdkParams](#interface-generatechangesdkparams)
|
|
6271
|
+
See also: [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams)
|
|
6649
6272
|
|
|
6650
6273
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6651
6274
|
|
|
@@ -6659,7 +6282,7 @@ export function validateGenerateChangeSdkResult(params: GenerateChangeSdkParams,
|
|
|
6659
6282
|
}
|
|
6660
6283
|
```
|
|
6661
6284
|
|
|
6662
|
-
See also: [GenerateChangeSdkParams](#interface-generatechangesdkparams), [GenerateChangeSdkResult](#interface-generatechangesdkresult)
|
|
6285
|
+
See also: [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams), [GenerateChangeSdkResult](./storage.md#interface-generatechangesdkresult)
|
|
6663
6286
|
|
|
6664
6287
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6665
6288
|
|
|
@@ -6679,7 +6302,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6679
6302
|
export function validateInternalizeActionArgs(args: InternalizeActionArgs): ValidInternalizeActionArgs
|
|
6680
6303
|
```
|
|
6681
6304
|
|
|
6682
|
-
See also: [ValidInternalizeActionArgs](#interface-validinternalizeactionargs)
|
|
6305
|
+
See also: [ValidInternalizeActionArgs](./client.md#interface-validinternalizeactionargs)
|
|
6683
6306
|
|
|
6684
6307
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6685
6308
|
|
|
@@ -6690,7 +6313,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6690
6313
|
export function validateInternalizeOutput(args: InternalizeOutput): ValidInternalizeOutput
|
|
6691
6314
|
```
|
|
6692
6315
|
|
|
6693
|
-
See also: [ValidInternalizeOutput](#interface-validinternalizeoutput)
|
|
6316
|
+
See also: [ValidInternalizeOutput](./client.md#interface-validinternalizeoutput)
|
|
6694
6317
|
|
|
6695
6318
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6696
6319
|
|
|
@@ -6701,11 +6324,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6701
6324
|
export function validateListActionsArgs(args: ListActionsArgs): ValidListActionsArgs
|
|
6702
6325
|
```
|
|
6703
6326
|
|
|
6704
|
-
See also: [ValidListActionsArgs](#interface-validlistactionsargs)
|
|
6705
|
-
|
|
6706
|
-
<details>
|
|
6707
|
-
|
|
6708
|
-
<summary>Function validateListActionsArgs Details</summary>
|
|
6327
|
+
See also: [ValidListActionsArgs](./client.md#interface-validlistactionsargs)
|
|
6709
6328
|
|
|
6710
6329
|
Argument Details
|
|
6711
6330
|
|
|
@@ -6732,8 +6351,6 @@ Argument Details
|
|
|
6732
6351
|
+ **args.seekPermission**
|
|
6733
6352
|
+ — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
|
|
6734
6353
|
|
|
6735
|
-
</details>
|
|
6736
|
-
|
|
6737
6354
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6738
6355
|
|
|
6739
6356
|
---
|
|
@@ -6743,7 +6360,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6743
6360
|
export function validateListCertificatesArgs(args: ListCertificatesArgs): ValidListCertificatesArgs
|
|
6744
6361
|
```
|
|
6745
6362
|
|
|
6746
|
-
See also: [ValidListCertificatesArgs](#interface-validlistcertificatesargs)
|
|
6363
|
+
See also: [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs)
|
|
6747
6364
|
|
|
6748
6365
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6749
6366
|
|
|
@@ -6754,11 +6371,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6754
6371
|
export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputsArgs
|
|
6755
6372
|
```
|
|
6756
6373
|
|
|
6757
|
-
See also: [ValidListOutputsArgs](#interface-validlistoutputsargs)
|
|
6758
|
-
|
|
6759
|
-
<details>
|
|
6760
|
-
|
|
6761
|
-
<summary>Function validateListOutputsArgs Details</summary>
|
|
6374
|
+
See also: [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs)
|
|
6762
6375
|
|
|
6763
6376
|
Argument Details
|
|
6764
6377
|
|
|
@@ -6785,8 +6398,6 @@ Argument Details
|
|
|
6785
6398
|
+ **args.seekPermission**
|
|
6786
6399
|
+ — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
|
|
6787
6400
|
|
|
6788
|
-
</details>
|
|
6789
|
-
|
|
6790
6401
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6791
6402
|
|
|
6792
6403
|
---
|
|
@@ -6841,7 +6452,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6841
6452
|
export function validateProveCertificateArgs(args: ProveCertificateArgs): ValidProveCertificateArgs
|
|
6842
6453
|
```
|
|
6843
6454
|
|
|
6844
|
-
See also: [ValidProveCertificateArgs](#interface-validprovecertificateargs)
|
|
6455
|
+
See also: [ValidProveCertificateArgs](./client.md#interface-validprovecertificateargs)
|
|
6845
6456
|
|
|
6846
6457
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6847
6458
|
|
|
@@ -6852,7 +6463,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6852
6463
|
export function validateRelinquishCertificateArgs(args: RelinquishCertificateArgs): ValidRelinquishCertificateArgs
|
|
6853
6464
|
```
|
|
6854
6465
|
|
|
6855
|
-
See also: [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs)
|
|
6466
|
+
See also: [ValidRelinquishCertificateArgs](./client.md#interface-validrelinquishcertificateargs)
|
|
6856
6467
|
|
|
6857
6468
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6858
6469
|
|
|
@@ -6863,7 +6474,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6863
6474
|
export function validateRelinquishOutputArgs(args: RelinquishOutputArgs): ValidRelinquishOutputArgs
|
|
6864
6475
|
```
|
|
6865
6476
|
|
|
6866
|
-
See also: [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs)
|
|
6477
|
+
See also: [ValidRelinquishOutputArgs](./client.md#interface-validrelinquishoutputargs)
|
|
6867
6478
|
|
|
6868
6479
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6869
6480
|
|
|
@@ -6883,7 +6494,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6883
6494
|
export function validateScriptHash(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat): string
|
|
6884
6495
|
```
|
|
6885
6496
|
|
|
6886
|
-
See also: [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat)
|
|
6497
|
+
See also: [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat)
|
|
6887
6498
|
|
|
6888
6499
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6889
6500
|
|
|
@@ -6903,7 +6514,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6903
6514
|
export function validateSignActionArgs(args: SignActionArgs): ValidSignActionArgs
|
|
6904
6515
|
```
|
|
6905
6516
|
|
|
6906
|
-
See also: [ValidSignActionArgs](#interface-validsignactionargs)
|
|
6517
|
+
See also: [ValidSignActionArgs](./client.md#interface-validsignactionargs)
|
|
6907
6518
|
|
|
6908
6519
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6909
6520
|
|
|
@@ -6919,7 +6530,7 @@ Convert string outpoints to `{ txid: string, vout: number }`
|
|
|
6919
6530
|
export function validateSignActionOptions(options?: SignActionOptions): ValidSignActionOptions
|
|
6920
6531
|
```
|
|
6921
6532
|
|
|
6922
|
-
See also: [ValidSignActionOptions](#interface-validsignactionoptions)
|
|
6533
|
+
See also: [ValidSignActionOptions](./client.md#interface-validsignactionoptions)
|
|
6923
6534
|
|
|
6924
6535
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6925
6536
|
|
|
@@ -6930,7 +6541,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6930
6541
|
export function validateStorageFeeModel(v?: sdk.StorageFeeModel): sdk.StorageFeeModel
|
|
6931
6542
|
```
|
|
6932
6543
|
|
|
6933
|
-
See also: [StorageFeeModel](#interface-storagefeemodel)
|
|
6544
|
+
See also: [StorageFeeModel](./client.md#interface-storagefeemodel)
|
|
6934
6545
|
|
|
6935
6546
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6936
6547
|
|
|
@@ -6950,7 +6561,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6950
6561
|
export function validateWalletPayment(args?: WalletPayment): ValidWalletPayment | undefined
|
|
6951
6562
|
```
|
|
6952
6563
|
|
|
6953
|
-
See also: [ValidWalletPayment](#interface-validwalletpayment)
|
|
6564
|
+
See also: [ValidWalletPayment](./client.md#interface-validwalletpayment)
|
|
6954
6565
|
|
|
6955
6566
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6956
6567
|
|
|
@@ -6967,7 +6578,7 @@ export function varUintSize(val: number): 1 | 3 | 5 | 9 {
|
|
|
6967
6578
|
}
|
|
6968
6579
|
```
|
|
6969
6580
|
|
|
6970
|
-
See also: [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter)
|
|
6581
|
+
See also: [WERR_INVALID_PARAMETER](./client.md#class-werr_invalid_parameter)
|
|
6971
6582
|
|
|
6972
6583
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6973
6584
|
|
|
@@ -7032,10 +6643,6 @@ Helper function.
|
|
|
7032
6643
|
export function verifyOne<T>(results: T[], errorDescrition?: string): T
|
|
7033
6644
|
```
|
|
7034
6645
|
|
|
7035
|
-
<details>
|
|
7036
|
-
|
|
7037
|
-
<summary>Function verifyOne Details</summary>
|
|
7038
|
-
|
|
7039
6646
|
Returns
|
|
7040
6647
|
|
|
7041
6648
|
results[0].
|
|
@@ -7044,8 +6651,6 @@ Throws
|
|
|
7044
6651
|
|
|
7045
6652
|
WERR_BAD_REQUEST if results has length other than one.
|
|
7046
6653
|
|
|
7047
|
-
</details>
|
|
7048
|
-
|
|
7049
6654
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7050
6655
|
|
|
7051
6656
|
---
|
|
@@ -7057,10 +6662,6 @@ Helper function.
|
|
|
7057
6662
|
export function verifyOneOrNone<T>(results: T[]): T | undefined
|
|
7058
6663
|
```
|
|
7059
6664
|
|
|
7060
|
-
<details>
|
|
7061
|
-
|
|
7062
|
-
<summary>Function verifyOneOrNone Details</summary>
|
|
7063
|
-
|
|
7064
6665
|
Returns
|
|
7065
6666
|
|
|
7066
6667
|
results[0] or undefined if length is zero.
|
|
@@ -7069,8 +6670,6 @@ Throws
|
|
|
7069
6670
|
|
|
7070
6671
|
WERR_BAD_REQUEST if results has length greater than one.
|
|
7071
6672
|
|
|
7072
|
-
</details>
|
|
7073
|
-
|
|
7074
6673
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7075
6674
|
|
|
7076
6675
|
---
|
|
@@ -7155,7 +6754,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7155
6754
|
export type GetMerklePathService = (txid: string, chain: sdk.Chain, services: WalletServices) => Promise<GetMerklePathResult>
|
|
7156
6755
|
```
|
|
7157
6756
|
|
|
7158
|
-
See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathresult), [WalletServices](#interface-walletservices)
|
|
6757
|
+
See also: [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [WalletServices](./client.md#interface-walletservices)
|
|
7159
6758
|
|
|
7160
6759
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7161
6760
|
|
|
@@ -7166,7 +6765,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7166
6765
|
export type GetRawTxService = (txid: string, chain: sdk.Chain) => Promise<GetRawTxResult>
|
|
7167
6766
|
```
|
|
7168
6767
|
|
|
7169
|
-
See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
|
|
6768
|
+
See also: [Chain](./client.md#type-chain), [GetRawTxResult](./client.md#interface-getrawtxresult)
|
|
7170
6769
|
|
|
7171
6770
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7172
6771
|
|
|
@@ -7186,7 +6785,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7186
6785
|
export type GetUtxoStatusService = (output: string, chain: sdk.Chain, outputFormat?: GetUtxoStatusOutputFormat) => Promise<GetUtxoStatusResult>
|
|
7187
6786
|
```
|
|
7188
6787
|
|
|
7189
|
-
See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult)
|
|
6788
|
+
See also: [Chain](./client.md#type-chain), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
7190
6789
|
|
|
7191
6790
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7192
6791
|
|
|
@@ -7210,7 +6809,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7210
6809
|
export type MonitorStorage = WalletStorageManager
|
|
7211
6810
|
```
|
|
7212
6811
|
|
|
7213
|
-
See also: [WalletStorageManager](#class-walletstoragemanager)
|
|
6812
|
+
See also: [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
7214
6813
|
|
|
7215
6814
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7216
6815
|
|
|
@@ -7221,7 +6820,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7221
6820
|
export type PostBeefService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostBeefResult>
|
|
7222
6821
|
```
|
|
7223
6822
|
|
|
7224
|
-
See also: [PostBeefResult](#interface-postbeefresult), [WalletServices](#interface-walletservices)
|
|
6823
|
+
See also: [PostBeefResult](./client.md#interface-postbeefresult), [WalletServices](./client.md#interface-walletservices)
|
|
7225
6824
|
|
|
7226
6825
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7227
6826
|
|
|
@@ -7241,7 +6840,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7241
6840
|
export type PostTxsService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostTxsResult>
|
|
7242
6841
|
```
|
|
7243
6842
|
|
|
7244
|
-
See also: [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface-walletservices)
|
|
6843
|
+
See also: [PostTxsResult](./client.md#interface-posttxsresult), [WalletServices](./client.md#interface-walletservices)
|
|
7245
6844
|
|
|
7246
6845
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7247
6846
|
|
|
@@ -7337,7 +6936,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7337
6936
|
export type UpdateFiatExchangeRateService = (targetCurrencies: string[], options: WalletServicesOptions) => Promise<FiatExchangeRates>
|
|
7338
6937
|
```
|
|
7339
6938
|
|
|
7340
|
-
See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
6939
|
+
See also: [FiatExchangeRates](./client.md#interface-fiatexchangerates), [WalletServicesOptions](./client.md#interface-walletservicesoptions)
|
|
7341
6940
|
|
|
7342
6941
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7343
6942
|
|
|
@@ -7370,7 +6969,7 @@ ProvenTxReqNonTerminalStatus: ProvenTxReqStatus[] = [
|
|
|
7370
6969
|
]
|
|
7371
6970
|
```
|
|
7372
6971
|
|
|
7373
|
-
See also: [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
6972
|
+
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus)
|
|
7374
6973
|
|
|
7375
6974
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7376
6975
|
|
|
@@ -7385,7 +6984,7 @@ ProvenTxReqTerminalStatus: ProvenTxReqStatus[] = [
|
|
|
7385
6984
|
]
|
|
7386
6985
|
```
|
|
7387
6986
|
|
|
7388
|
-
See also: [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
6987
|
+
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus)
|
|
7389
6988
|
|
|
7390
6989
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7391
6990
|
|