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