@bsv/sdk 1.3.8 → 1.3.10

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.
Files changed (125) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/auth/Peer.js +1 -1
  3. package/dist/cjs/src/auth/Peer.js.map +1 -1
  4. package/dist/cjs/src/auth/certificates/Certificate.js.map +1 -1
  5. package/dist/cjs/src/auth/certificates/MasterCertificate.js +3 -3
  6. package/dist/cjs/src/auth/certificates/MasterCertificate.js.map +1 -1
  7. package/dist/cjs/src/auth/certificates/VerifiableCertificate.js +1 -1
  8. package/dist/cjs/src/auth/certificates/VerifiableCertificate.js.map +1 -1
  9. package/dist/cjs/src/auth/certificates/__tests/CompletedProtoWallet.js +12 -0
  10. package/dist/cjs/src/auth/certificates/__tests/CompletedProtoWallet.js.map +1 -1
  11. package/dist/cjs/src/auth/clients/AuthFetch.js.map +1 -1
  12. package/dist/cjs/src/auth/utils/createNonce.js +9 -3
  13. package/dist/cjs/src/auth/utils/createNonce.js.map +1 -1
  14. package/dist/cjs/src/auth/utils/getVerifiableCertificates.js.map +1 -1
  15. package/dist/cjs/src/auth/utils/validateCertificates.js.map +1 -1
  16. package/dist/cjs/src/auth/utils/verifyNonce.js +3 -2
  17. package/dist/cjs/src/auth/utils/verifyNonce.js.map +1 -1
  18. package/dist/cjs/src/overlay-tools/OverlayAdminTokenTemplate.js.map +1 -1
  19. package/dist/cjs/src/script/templates/PushDrop.js +1 -1
  20. package/dist/cjs/src/script/templates/PushDrop.js.map +1 -1
  21. package/dist/cjs/src/wallet/ProtoWallet.js +10 -58
  22. package/dist/cjs/src/wallet/ProtoWallet.js.map +1 -1
  23. package/dist/cjs/src/wallet/WalletClient.js.map +1 -1
  24. package/dist/cjs/src/wallet/substrates/HTTPWalletJSON.js.map +1 -1
  25. package/dist/cjs/src/wallet/substrates/WalletWireProcessor.js.map +1 -1
  26. package/dist/cjs/src/wallet/substrates/window.CWI.js.map +1 -1
  27. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  28. package/dist/esm/src/auth/Peer.js +1 -1
  29. package/dist/esm/src/auth/Peer.js.map +1 -1
  30. package/dist/esm/src/auth/certificates/Certificate.js +1 -1
  31. package/dist/esm/src/auth/certificates/Certificate.js.map +1 -1
  32. package/dist/esm/src/auth/certificates/MasterCertificate.js +3 -3
  33. package/dist/esm/src/auth/certificates/MasterCertificate.js.map +1 -1
  34. package/dist/esm/src/auth/certificates/VerifiableCertificate.js +1 -1
  35. package/dist/esm/src/auth/certificates/VerifiableCertificate.js.map +1 -1
  36. package/dist/esm/src/auth/certificates/__tests/CompletedProtoWallet.js +12 -0
  37. package/dist/esm/src/auth/certificates/__tests/CompletedProtoWallet.js.map +1 -1
  38. package/dist/esm/src/auth/clients/AuthFetch.js.map +1 -1
  39. package/dist/esm/src/auth/utils/createNonce.js +9 -3
  40. package/dist/esm/src/auth/utils/createNonce.js.map +1 -1
  41. package/dist/esm/src/auth/utils/getVerifiableCertificates.js.map +1 -1
  42. package/dist/esm/src/auth/utils/validateCertificates.js.map +1 -1
  43. package/dist/esm/src/auth/utils/verifyNonce.js +3 -2
  44. package/dist/esm/src/auth/utils/verifyNonce.js.map +1 -1
  45. package/dist/esm/src/overlay-tools/OverlayAdminTokenTemplate.js.map +1 -1
  46. package/dist/esm/src/script/templates/PushDrop.js +1 -1
  47. package/dist/esm/src/script/templates/PushDrop.js.map +1 -1
  48. package/dist/esm/src/wallet/ProtoWallet.js +10 -58
  49. package/dist/esm/src/wallet/ProtoWallet.js.map +1 -1
  50. package/dist/esm/src/wallet/WalletClient.js.map +1 -1
  51. package/dist/esm/src/wallet/substrates/HTTPWalletJSON.js.map +1 -1
  52. package/dist/esm/src/wallet/substrates/WalletWireProcessor.js.map +1 -1
  53. package/dist/esm/src/wallet/substrates/window.CWI.js.map +1 -1
  54. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  55. package/dist/types/src/auth/Peer.d.ts +3 -3
  56. package/dist/types/src/auth/Peer.d.ts.map +1 -1
  57. package/dist/types/src/auth/certificates/Certificate.d.ts +2 -2
  58. package/dist/types/src/auth/certificates/Certificate.d.ts.map +1 -1
  59. package/dist/types/src/auth/certificates/MasterCertificate.d.ts +7 -7
  60. package/dist/types/src/auth/certificates/MasterCertificate.d.ts.map +1 -1
  61. package/dist/types/src/auth/certificates/VerifiableCertificate.d.ts +3 -3
  62. package/dist/types/src/auth/certificates/VerifiableCertificate.d.ts.map +1 -1
  63. package/dist/types/src/auth/certificates/__tests/CompletedProtoWallet.d.ts +6 -2
  64. package/dist/types/src/auth/certificates/__tests/CompletedProtoWallet.d.ts.map +1 -1
  65. package/dist/types/src/auth/clients/AuthFetch.d.ts +2 -2
  66. package/dist/types/src/auth/clients/AuthFetch.d.ts.map +1 -1
  67. package/dist/types/src/auth/utils/createNonce.d.ts +4 -3
  68. package/dist/types/src/auth/utils/createNonce.d.ts.map +1 -1
  69. package/dist/types/src/auth/utils/getVerifiableCertificates.d.ts +2 -2
  70. package/dist/types/src/auth/utils/getVerifiableCertificates.d.ts.map +1 -1
  71. package/dist/types/src/auth/utils/validateCertificates.d.ts +2 -2
  72. package/dist/types/src/auth/utils/validateCertificates.d.ts.map +1 -1
  73. package/dist/types/src/auth/utils/verifyNonce.d.ts +3 -2
  74. package/dist/types/src/auth/utils/verifyNonce.d.ts.map +1 -1
  75. package/dist/types/src/overlay-tools/OverlayAdminTokenTemplate.d.ts +2 -2
  76. package/dist/types/src/overlay-tools/OverlayAdminTokenTemplate.d.ts.map +1 -1
  77. package/dist/types/src/script/templates/PushDrop.d.ts +4 -4
  78. package/dist/types/src/script/templates/PushDrop.d.ts.map +1 -1
  79. package/dist/types/src/wallet/ProtoWallet.d.ts +12 -24
  80. package/dist/types/src/wallet/ProtoWallet.d.ts.map +1 -1
  81. package/dist/types/src/wallet/Wallet.interfaces.d.ts +5 -18
  82. package/dist/types/src/wallet/Wallet.interfaces.d.ts.map +1 -1
  83. package/dist/types/src/wallet/WalletClient.d.ts +4 -4
  84. package/dist/types/src/wallet/WalletClient.d.ts.map +1 -1
  85. package/dist/types/src/wallet/substrates/HTTPWalletJSON.d.ts +2 -2
  86. package/dist/types/src/wallet/substrates/HTTPWalletJSON.d.ts.map +1 -1
  87. package/dist/types/src/wallet/substrates/WalletWireProcessor.d.ts +3 -3
  88. package/dist/types/src/wallet/substrates/WalletWireProcessor.d.ts.map +1 -1
  89. package/dist/types/src/wallet/substrates/WalletWireTransceiver.d.ts +2 -2
  90. package/dist/types/src/wallet/substrates/WalletWireTransceiver.d.ts.map +1 -1
  91. package/dist/types/src/wallet/substrates/XDM.d.ts +2 -2
  92. package/dist/types/src/wallet/substrates/XDM.d.ts.map +1 -1
  93. package/dist/types/src/wallet/substrates/window.CWI.d.ts +2 -2
  94. package/dist/types/src/wallet/substrates/window.CWI.d.ts.map +1 -1
  95. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  96. package/dist/umd/bundle.js +1 -1
  97. package/docs/auth.md +80 -40
  98. package/docs/overlay-tools.md +4 -4
  99. package/docs/script.md +5 -5
  100. package/docs/wallet-substrates.md +11 -11
  101. package/docs/wallet.md +300 -360
  102. package/package.json +1 -1
  103. package/src/auth/Peer.ts +4 -4
  104. package/src/auth/certificates/Certificate.ts +4 -3
  105. package/src/auth/certificates/MasterCertificate.ts +8 -8
  106. package/src/auth/certificates/VerifiableCertificate.ts +3 -3
  107. package/src/auth/certificates/__tests/CompletedProtoWallet.ts +14 -3
  108. package/src/auth/clients/AuthFetch.ts +3 -3
  109. package/src/auth/utils/__tests/cryptononce.test.ts +42 -7
  110. package/src/auth/utils/createNonce.ts +10 -4
  111. package/src/auth/utils/getVerifiableCertificates.ts +2 -2
  112. package/src/auth/utils/validateCertificates.ts +2 -2
  113. package/src/auth/utils/verifyNonce.ts +4 -3
  114. package/src/overlay-tools/OverlayAdminTokenTemplate.ts +2 -2
  115. package/src/script/templates/PushDrop.ts +4 -4
  116. package/src/wallet/ProtoWallet.ts +21 -87
  117. package/src/wallet/Wallet.interfaces.ts +5 -19
  118. package/src/wallet/WalletClient.ts +33 -33
  119. package/src/wallet/__tests/ProtoWallet.test.ts +0 -31
  120. package/src/wallet/substrates/HTTPWalletJSON.ts +3 -3
  121. package/src/wallet/substrates/WalletWireProcessor.ts +3 -3
  122. package/src/wallet/substrates/WalletWireTransceiver.ts +2 -2
  123. package/src/wallet/substrates/XDM.ts +3 -3
  124. package/src/wallet/substrates/__tests/WalletWire.integration.test.ts +0 -104
  125. package/src/wallet/substrates/window.CWI.ts +5 -5
package/docs/wallet.md CHANGED
@@ -6,31 +6,31 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
6
6
 
7
7
  | | | |
8
8
  | --- | --- | --- |
9
- | [AbortActionArgs](#interface-abortactionargs) | [GetVersionResult](#interface-getversionresult) | [SendWithResult](#interface-sendwithresult) |
10
- | [AbortActionResult](#interface-abortactionresult) | [IdentityCertificate](#interface-identitycertificate) | [SignActionArgs](#interface-signactionargs) |
11
- | [AcquireCertificateArgs](#interface-acquirecertificateargs) | [IdentityCertifier](#interface-identitycertifier) | [SignActionOptions](#interface-signactionoptions) |
12
- | [AcquireCertificateResult](#interface-acquirecertificateresult) | [InternalizeActionArgs](#interface-internalizeactionargs) | [SignActionResult](#interface-signactionresult) |
13
- | [AuthenticatedResult](#interface-authenticatedresult) | [InternalizeActionResult](#interface-internalizeactionresult) | [SignActionSpend](#interface-signactionspend) |
14
- | [BasketInsertion](#interface-basketinsertion) | [InternalizeOutput](#interface-internalizeoutput) | [SignableTransaction](#interface-signabletransaction) |
15
- | [CertificateResult](#interface-certificateresult) | [KeyDeriverApi](#interface-keyderiverapi) | [VerifyHmacArgs](#interface-verifyhmacargs) |
16
- | [CreateActionArgs](#interface-createactionargs) | [KeyLinkageResult](#interface-keylinkageresult) | [VerifyHmacResult](#interface-verifyhmacresult) |
17
- | [CreateActionInput](#interface-createactioninput) | [ListActionsArgs](#interface-listactionsargs) | [VerifySignatureArgs](#interface-verifysignatureargs) |
18
- | [CreateActionOptions](#interface-createactionoptions) | [ListActionsResult](#interface-listactionsresult) | [VerifySignatureResult](#interface-verifysignatureresult) |
19
- | [CreateActionOutput](#interface-createactionoutput) | [ListCertificatesArgs](#interface-listcertificatesargs) | [Wallet](#interface-wallet) |
20
- | [CreateActionResult](#interface-createactionresult) | [ListCertificatesResult](#interface-listcertificatesresult) | [WalletAction](#interface-walletaction) |
21
- | [CreateHmacArgs](#interface-createhmacargs) | [ListOutputsArgs](#interface-listoutputsargs) | [WalletActionInput](#interface-walletactioninput) |
22
- | [CreateHmacResult](#interface-createhmacresult) | [ListOutputsResult](#interface-listoutputsresult) | [WalletActionOutput](#interface-walletactionoutput) |
23
- | [CreateSignatureArgs](#interface-createsignatureargs) | [ProtoWalletApi](#interface-protowalletapi) | [WalletCertificate](#interface-walletcertificate) |
24
- | [CreateSignatureResult](#interface-createsignatureresult) | [ProveCertificateArgs](#interface-provecertificateargs) | [WalletDecryptArgs](#interface-walletdecryptargs) |
25
- | [DiscoverByAttributesArgs](#interface-discoverbyattributesargs) | [ProveCertificateResult](#interface-provecertificateresult) | [WalletDecryptResult](#interface-walletdecryptresult) |
26
- | [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs) | [RelinquishCertificateArgs](#interface-relinquishcertificateargs) | [WalletEncryptArgs](#interface-walletencryptargs) |
27
- | [DiscoverCertificatesResult](#interface-discovercertificatesresult) | [RelinquishCertificateResult](#interface-relinquishcertificateresult) | [WalletEncryptResult](#interface-walletencryptresult) |
28
- | [GetHeaderArgs](#interface-getheaderargs) | [RelinquishOutputArgs](#interface-relinquishoutputargs) | [WalletEncryptionArgs](#interface-walletencryptionargs) |
29
- | [GetHeaderResult](#interface-getheaderresult) | [RelinquishOutputResult](#interface-relinquishoutputresult) | [WalletErrorObject](#interface-walleterrorobject) |
30
- | [GetHeightResult](#interface-getheightresult) | [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs) | [WalletOutput](#interface-walletoutput) |
31
- | [GetNetworkResult](#interface-getnetworkresult) | [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult) | [WalletPayment](#interface-walletpayment) |
32
- | [GetPublicKeyArgs](#interface-getpublickeyargs) | [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs) | [WalletWire](#interface-walletwire) |
33
- | [GetPublicKeyResult](#interface-getpublickeyresult) | [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult) | |
9
+ | [AbortActionArgs](#interface-abortactionargs) | [GetVersionResult](#interface-getversionresult) | [SignActionArgs](#interface-signactionargs) |
10
+ | [AbortActionResult](#interface-abortactionresult) | [IdentityCertificate](#interface-identitycertificate) | [SignActionOptions](#interface-signactionoptions) |
11
+ | [AcquireCertificateArgs](#interface-acquirecertificateargs) | [IdentityCertifier](#interface-identitycertifier) | [SignActionResult](#interface-signactionresult) |
12
+ | [AcquireCertificateResult](#interface-acquirecertificateresult) | [InternalizeActionArgs](#interface-internalizeactionargs) | [SignActionSpend](#interface-signactionspend) |
13
+ | [AuthenticatedResult](#interface-authenticatedresult) | [InternalizeActionResult](#interface-internalizeactionresult) | [SignableTransaction](#interface-signabletransaction) |
14
+ | [BasketInsertion](#interface-basketinsertion) | [InternalizeOutput](#interface-internalizeoutput) | [VerifyHmacArgs](#interface-verifyhmacargs) |
15
+ | [CertificateResult](#interface-certificateresult) | [KeyDeriverApi](#interface-keyderiverapi) | [VerifyHmacResult](#interface-verifyhmacresult) |
16
+ | [CreateActionArgs](#interface-createactionargs) | [KeyLinkageResult](#interface-keylinkageresult) | [VerifySignatureArgs](#interface-verifysignatureargs) |
17
+ | [CreateActionInput](#interface-createactioninput) | [ListActionsArgs](#interface-listactionsargs) | [VerifySignatureResult](#interface-verifysignatureresult) |
18
+ | [CreateActionOptions](#interface-createactionoptions) | [ListActionsResult](#interface-listactionsresult) | [WalletAction](#interface-walletaction) |
19
+ | [CreateActionOutput](#interface-createactionoutput) | [ListCertificatesArgs](#interface-listcertificatesargs) | [WalletActionInput](#interface-walletactioninput) |
20
+ | [CreateActionResult](#interface-createactionresult) | [ListCertificatesResult](#interface-listcertificatesresult) | [WalletActionOutput](#interface-walletactionoutput) |
21
+ | [CreateHmacArgs](#interface-createhmacargs) | [ListOutputsArgs](#interface-listoutputsargs) | [WalletCertificate](#interface-walletcertificate) |
22
+ | [CreateHmacResult](#interface-createhmacresult) | [ListOutputsResult](#interface-listoutputsresult) | [WalletDecryptArgs](#interface-walletdecryptargs) |
23
+ | [CreateSignatureArgs](#interface-createsignatureargs) | [ProveCertificateArgs](#interface-provecertificateargs) | [WalletDecryptResult](#interface-walletdecryptresult) |
24
+ | [CreateSignatureResult](#interface-createsignatureresult) | [ProveCertificateResult](#interface-provecertificateresult) | [WalletEncryptArgs](#interface-walletencryptargs) |
25
+ | [DiscoverByAttributesArgs](#interface-discoverbyattributesargs) | [RelinquishCertificateArgs](#interface-relinquishcertificateargs) | [WalletEncryptResult](#interface-walletencryptresult) |
26
+ | [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs) | [RelinquishCertificateResult](#interface-relinquishcertificateresult) | [WalletEncryptionArgs](#interface-walletencryptionargs) |
27
+ | [DiscoverCertificatesResult](#interface-discovercertificatesresult) | [RelinquishOutputArgs](#interface-relinquishoutputargs) | [WalletErrorObject](#interface-walleterrorobject) |
28
+ | [GetHeaderArgs](#interface-getheaderargs) | [RelinquishOutputResult](#interface-relinquishoutputresult) | [WalletInterface](#interface-walletinterface) |
29
+ | [GetHeaderResult](#interface-getheaderresult) | [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs) | [WalletOutput](#interface-walletoutput) |
30
+ | [GetHeightResult](#interface-getheightresult) | [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult) | [WalletPayment](#interface-walletpayment) |
31
+ | [GetNetworkResult](#interface-getnetworkresult) | [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs) | [WalletWire](#interface-walletwire) |
32
+ | [GetPublicKeyArgs](#interface-getpublickeyargs) | [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult) | |
33
+ | [GetPublicKeyResult](#interface-getpublickeyresult) | [SendWithResult](#interface-sendwithresult) | |
34
34
 
35
35
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
36
36
 
@@ -710,124 +710,6 @@ See also: [BEEF](#type-beef), [PositiveIntegerOrZero](#type-positiveintegerorzer
710
710
 
711
711
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
712
712
 
713
- ---
714
- ### Interface: ProtoWalletApi
715
-
716
- The ProtoWalletApi interface defines a wallet cryptographic capabilities including:
717
- key derivation, encryption, decryption, hmac creation and verification, signature generation and verification
718
-
719
- Error Handling
720
-
721
- Every method of the `Wallet` interface has a return value of the form `Promise<object>`.
722
- When an error occurs, an exception object may be thrown which must conform to the `WalletErrorObject` interface.
723
- Serialization layers can rely on the `isError` property being unique to error objects to
724
- deserialize and rethrow `WalletErrorObject` conforming objects.
725
-
726
- ```ts
727
- export interface ProtoWalletApi {
728
- getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>;
729
- revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>;
730
- revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>;
731
- encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>;
732
- decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>;
733
- createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>;
734
- verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>;
735
- createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>;
736
- verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>;
737
- }
738
- ```
739
-
740
- See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
741
-
742
- <details>
743
-
744
- <summary>Interface ProtoWalletApi Details</summary>
745
-
746
- #### Property createHmac
747
-
748
- Creates an HMAC (Hash-based Message Authentication Code) based on the provided data, protocol, key ID, counterparty, and other factors.
749
-
750
- ```ts
751
- createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>
752
- ```
753
- See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
754
-
755
- #### Property createSignature
756
-
757
- Creates a digital signature for the provided data or hash using a specific protocol, key, and optionally considering privilege and counterparty.
758
-
759
- ```ts
760
- createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>
761
- ```
762
- See also: [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
763
-
764
- #### Property decrypt
765
-
766
- Decrypts the provided ciphertext using derived keys, based on the protocol ID, key ID, counterparty, and other factors.
767
-
768
- ```ts
769
- decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>
770
- ```
771
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult)
772
-
773
- #### Property encrypt
774
-
775
- Encrypts the provided plaintext data using derived keys, based on the protocol ID, key ID, counterparty, and other factors.
776
-
777
- ```ts
778
- encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>
779
- ```
780
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
781
-
782
- #### Property getPublicKey
783
-
784
- Retrieves a derived or identity public key based on the requested protocol, key ID, counterparty, and other factors.
785
-
786
- ```ts
787
- getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>
788
- ```
789
- See also: [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
790
-
791
- #### Property revealCounterpartyKeyLinkage
792
-
793
- Reveals the key linkage between ourselves and a counterparty, to a particular verifier, across all interactions with the counterparty.
794
-
795
- ```ts
796
- revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>
797
- ```
798
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult)
799
-
800
- #### Property revealSpecificKeyLinkage
801
-
802
- Reveals the key linkage between ourselves and a counterparty, to a particular verifier, with respect to a specific interaction.
803
-
804
- ```ts
805
- revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>
806
- ```
807
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult)
808
-
809
- #### Property verifyHmac
810
-
811
- Verifies an HMAC (Hash-based Message Authentication Code) based on the provided data, protocol, key ID, counterparty, and other factors.
812
-
813
- ```ts
814
- verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>
815
- ```
816
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult)
817
-
818
- #### Property verifySignature
819
-
820
- Verifies a digital signature for the provided data or hash using a specific protocol, key, and optionally considering privilege and counterparty.
821
-
822
- ```ts
823
- verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>
824
- ```
825
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult)
826
-
827
- </details>
828
-
829
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
830
-
831
713
  ---
832
714
  ### Interface: ProveCertificateArgs
833
715
 
@@ -1114,7 +996,172 @@ export interface VerifySignatureResult {
1114
996
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1115
997
 
1116
998
  ---
1117
- ### Interface: Wallet
999
+ ### Interface: WalletAction
1000
+
1001
+ ```ts
1002
+ export interface WalletAction {
1003
+ txid: TXIDHexString;
1004
+ satoshis: SatoshiValue;
1005
+ status: ActionStatus;
1006
+ isOutgoing: boolean;
1007
+ description: DescriptionString5to50Bytes;
1008
+ labels?: LabelStringUnder300Bytes[];
1009
+ version: PositiveIntegerOrZero;
1010
+ lockTime: PositiveIntegerOrZero;
1011
+ inputs?: WalletActionInput[];
1012
+ outputs?: WalletActionOutput[];
1013
+ }
1014
+ ```
1015
+
1016
+ See also: [ActionStatus](#type-actionstatus), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue), [TXIDHexString](#type-txidhexstring), [WalletActionInput](#interface-walletactioninput), [WalletActionOutput](#interface-walletactionoutput)
1017
+
1018
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1019
+
1020
+ ---
1021
+ ### Interface: WalletActionInput
1022
+
1023
+ ```ts
1024
+ export interface WalletActionInput {
1025
+ sourceOutpoint: OutpointString;
1026
+ sourceSatoshis: SatoshiValue;
1027
+ sourceLockingScript?: HexString;
1028
+ unlockingScript?: HexString;
1029
+ inputDescription: DescriptionString5to50Bytes;
1030
+ sequenceNumber: PositiveIntegerOrZero;
1031
+ }
1032
+ ```
1033
+
1034
+ See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
1035
+
1036
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1037
+
1038
+ ---
1039
+ ### Interface: WalletActionOutput
1040
+
1041
+ ```ts
1042
+ export interface WalletActionOutput {
1043
+ satoshis: SatoshiValue;
1044
+ lockingScript?: HexString;
1045
+ spendable: boolean;
1046
+ customInstructions?: string;
1047
+ tags: OutputTagStringUnder300Bytes[];
1048
+ outputIndex: PositiveIntegerOrZero;
1049
+ outputDescription: DescriptionString5to50Bytes;
1050
+ basket: BasketStringUnder300Bytes;
1051
+ }
1052
+ ```
1053
+
1054
+ See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
1055
+
1056
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1057
+
1058
+ ---
1059
+ ### Interface: WalletCertificate
1060
+
1061
+ ```ts
1062
+ export interface WalletCertificate {
1063
+ type: Base64String;
1064
+ subject: PubKeyHex;
1065
+ serialNumber: Base64String;
1066
+ certifier: PubKeyHex;
1067
+ revocationOutpoint: OutpointString;
1068
+ signature: HexString;
1069
+ fields: Record<CertificateFieldNameUnder50Bytes, string>;
1070
+ }
1071
+ ```
1072
+
1073
+ See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
1074
+
1075
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1076
+
1077
+ ---
1078
+ ### Interface: WalletDecryptArgs
1079
+
1080
+ ```ts
1081
+ export interface WalletDecryptArgs extends WalletEncryptionArgs {
1082
+ ciphertext: Byte[];
1083
+ }
1084
+ ```
1085
+
1086
+ See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
1087
+
1088
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1089
+
1090
+ ---
1091
+ ### Interface: WalletDecryptResult
1092
+
1093
+ ```ts
1094
+ export interface WalletDecryptResult {
1095
+ plaintext: Byte[];
1096
+ }
1097
+ ```
1098
+
1099
+ See also: [Byte](#type-byte)
1100
+
1101
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1102
+
1103
+ ---
1104
+ ### Interface: WalletEncryptArgs
1105
+
1106
+ ```ts
1107
+ export interface WalletEncryptArgs extends WalletEncryptionArgs {
1108
+ plaintext: Byte[];
1109
+ }
1110
+ ```
1111
+
1112
+ See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
1113
+
1114
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1115
+
1116
+ ---
1117
+ ### Interface: WalletEncryptResult
1118
+
1119
+ ```ts
1120
+ export interface WalletEncryptResult {
1121
+ ciphertext: Byte[];
1122
+ }
1123
+ ```
1124
+
1125
+ See also: [Byte](#type-byte)
1126
+
1127
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1128
+
1129
+ ---
1130
+ ### Interface: WalletEncryptionArgs
1131
+
1132
+ ```ts
1133
+ export interface WalletEncryptionArgs {
1134
+ protocolID: WalletProtocol;
1135
+ keyID: KeyIDStringUnder800Bytes;
1136
+ counterparty?: WalletCounterparty;
1137
+ privileged?: BooleanDefaultFalse;
1138
+ privilegedReason?: DescriptionString5to50Bytes;
1139
+ seekPermission?: BooleanDefaultTrue;
1140
+ }
1141
+ ```
1142
+
1143
+ See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
1144
+
1145
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1146
+
1147
+ ---
1148
+ ### Interface: WalletErrorObject
1149
+
1150
+ Every method of the `Wallet` interface has a return value of the form `Promise<object>`.
1151
+ When errors occur, an exception object may be thrown which must conform to the `WalletErrorObject` interface.
1152
+ Serialization layers can rely on the `isError` property being unique to error objects.
1153
+ Deserialization should rethrow `WalletErrorObject` conforming objects.
1154
+
1155
+ ```ts
1156
+ export interface WalletErrorObject extends Error {
1157
+ isError: true;
1158
+ }
1159
+ ```
1160
+
1161
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1162
+
1163
+ ---
1164
+ ### Interface: WalletInterface
1118
1165
 
1119
1166
  The Wallet interface defines a wallet capable of various tasks including transaction creation and signing,
1120
1167
  encryption, decryption, identity certificate management, identity verification, and communication
@@ -1129,7 +1176,16 @@ Serialization layers can rely on the `isError` property being unique to error ob
1129
1176
  deserialize and rethrow `WalletErrorObject` conforming objects.
1130
1177
 
1131
1178
  ```ts
1132
- export interface Wallet extends ProtoWalletApi {
1179
+ export interface WalletInterface {
1180
+ getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>;
1181
+ revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>;
1182
+ revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>;
1183
+ encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>;
1184
+ decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>;
1185
+ createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>;
1186
+ verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>;
1187
+ createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>;
1188
+ verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>;
1133
1189
  createAction: (args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateActionResult>;
1134
1190
  signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>;
1135
1191
  abortAction: (args: AbortActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AbortActionResult>;
@@ -1152,11 +1208,11 @@ export interface Wallet extends ProtoWalletApi {
1152
1208
  }
1153
1209
  ```
1154
1210
 
1155
- See also: [AbortActionArgs](#interface-abortactionargs), [AbortActionResult](#interface-abortactionresult), [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [AuthenticatedResult](#interface-authenticatedresult), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [GetHeaderArgs](#interface-getheaderargs), [GetHeaderResult](#interface-getheaderresult), [GetHeightResult](#interface-getheightresult), [GetNetworkResult](#interface-getnetworkresult), [GetVersionResult](#interface-getversionresult), [InternalizeActionArgs](#interface-internalizeactionargs), [InternalizeActionResult](#interface-internalizeactionresult), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesArgs](#interface-listcertificatesargs), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [ProtoWalletApi](#interface-protowalletapi), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [RelinquishCertificateArgs](#interface-relinquishcertificateargs), [RelinquishCertificateResult](#interface-relinquishcertificateresult), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult)
1211
+ See also: [AbortActionArgs](#interface-abortactionargs), [AbortActionResult](#interface-abortactionresult), [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [AuthenticatedResult](#interface-authenticatedresult), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [GetHeaderArgs](#interface-getheaderargs), [GetHeaderResult](#interface-getheaderresult), [GetHeightResult](#interface-getheightresult), [GetNetworkResult](#interface-getnetworkresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [GetVersionResult](#interface-getversionresult), [InternalizeActionArgs](#interface-internalizeactionargs), [InternalizeActionResult](#interface-internalizeactionresult), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesArgs](#interface-listcertificatesargs), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [RelinquishCertificateArgs](#interface-relinquishcertificateargs), [RelinquishCertificateResult](#interface-relinquishcertificateresult), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
1156
1212
 
1157
1213
  <details>
1158
1214
 
1159
- <summary>Interface Wallet Details</summary>
1215
+ <summary>Interface WalletInterface Details</summary>
1160
1216
 
1161
1217
  #### Property abortAction
1162
1218
 
@@ -1185,6 +1241,33 @@ createAction: (args: CreateActionArgs, originator?: OriginatorDomainNameStringUn
1185
1241
  ```
1186
1242
  See also: [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1187
1243
 
1244
+ #### Property createHmac
1245
+
1246
+ Creates an HMAC (Hash-based Message Authentication Code) based on the provided data, protocol, key ID, counterparty, and other factors.
1247
+
1248
+ ```ts
1249
+ createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>
1250
+ ```
1251
+ See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1252
+
1253
+ #### Property createSignature
1254
+
1255
+ Creates a digital signature for the provided data or hash using a specific protocol, key, and optionally considering privilege and counterparty.
1256
+
1257
+ ```ts
1258
+ createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>
1259
+ ```
1260
+ See also: [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1261
+
1262
+ #### Property decrypt
1263
+
1264
+ Decrypts the provided ciphertext using derived keys, based on the protocol ID, key ID, counterparty, and other factors.
1265
+
1266
+ ```ts
1267
+ decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>
1268
+ ```
1269
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult)
1270
+
1188
1271
  #### Property discoverByAttributes
1189
1272
 
1190
1273
  Discovers identity certificates belonging to other users, where the documents contain specific attributes, issued by a trusted entity.
@@ -1203,6 +1286,15 @@ discoverByIdentityKey: (args: DiscoverByIdentityKeyArgs, originator?: Originator
1203
1286
  ```
1204
1287
  See also: [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1205
1288
 
1289
+ #### Property encrypt
1290
+
1291
+ Encrypts the provided plaintext data using derived keys, based on the protocol ID, key ID, counterparty, and other factors.
1292
+
1293
+ ```ts
1294
+ encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>
1295
+ ```
1296
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
1297
+
1206
1298
  #### Property getHeaderForHeight
1207
1299
 
1208
1300
  Retrieves the block header of a block at a specified height.
@@ -1230,6 +1322,15 @@ getNetwork: (args: {}, originator?: OriginatorDomainNameStringUnder250Bytes) =>
1230
1322
  ```
1231
1323
  See also: [GetNetworkResult](#interface-getnetworkresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1232
1324
 
1325
+ #### Property getPublicKey
1326
+
1327
+ Retrieves a derived or identity public key based on the requested protocol, key ID, counterparty, and other factors.
1328
+
1329
+ ```ts
1330
+ getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>
1331
+ ```
1332
+ See also: [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1333
+
1233
1334
  #### Property getVersion
1234
1335
 
1235
1336
  Retrieves the current version string of the wallet.
@@ -1311,190 +1412,61 @@ relinquishOutput: (args: RelinquishOutputArgs, originator?: OriginatorDomainName
1311
1412
  ```
1312
1413
  See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult)
1313
1414
 
1314
- #### Property signAction
1315
-
1316
- Signs a transaction previously created using `createAction`.
1317
-
1318
- ```ts
1319
- signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>
1320
- ```
1321
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult)
1322
-
1323
- #### Property waitForAuthentication
1324
-
1325
- Continuously waits until the user is authenticated, returning the result once confirmed.
1326
-
1327
- ```ts
1328
- waitForAuthentication: (args: {}, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
1329
- ```
1330
- See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1331
-
1332
- </details>
1333
-
1334
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1335
-
1336
- ---
1337
- ### Interface: WalletAction
1338
-
1339
- ```ts
1340
- export interface WalletAction {
1341
- txid: TXIDHexString;
1342
- satoshis: SatoshiValue;
1343
- status: ActionStatus;
1344
- isOutgoing: boolean;
1345
- description: DescriptionString5to50Bytes;
1346
- labels?: LabelStringUnder300Bytes[];
1347
- version: PositiveIntegerOrZero;
1348
- lockTime: PositiveIntegerOrZero;
1349
- inputs?: WalletActionInput[];
1350
- outputs?: WalletActionOutput[];
1351
- }
1352
- ```
1353
-
1354
- See also: [ActionStatus](#type-actionstatus), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue), [TXIDHexString](#type-txidhexstring), [WalletActionInput](#interface-walletactioninput), [WalletActionOutput](#interface-walletactionoutput)
1355
-
1356
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1357
-
1358
- ---
1359
- ### Interface: WalletActionInput
1360
-
1361
- ```ts
1362
- export interface WalletActionInput {
1363
- sourceOutpoint: OutpointString;
1364
- sourceSatoshis: SatoshiValue;
1365
- sourceLockingScript?: HexString;
1366
- unlockingScript?: HexString;
1367
- inputDescription: DescriptionString5to50Bytes;
1368
- sequenceNumber: PositiveIntegerOrZero;
1369
- }
1370
- ```
1371
-
1372
- See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
1373
-
1374
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1375
-
1376
- ---
1377
- ### Interface: WalletActionOutput
1378
-
1379
- ```ts
1380
- export interface WalletActionOutput {
1381
- satoshis: SatoshiValue;
1382
- lockingScript?: HexString;
1383
- spendable: boolean;
1384
- customInstructions?: string;
1385
- tags: OutputTagStringUnder300Bytes[];
1386
- outputIndex: PositiveIntegerOrZero;
1387
- outputDescription: DescriptionString5to50Bytes;
1388
- basket: BasketStringUnder300Bytes;
1389
- }
1390
- ```
1391
-
1392
- See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
1393
-
1394
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1415
+ #### Property revealCounterpartyKeyLinkage
1395
1416
 
1396
- ---
1397
- ### Interface: WalletCertificate
1417
+ Reveals the key linkage between ourselves and a counterparty, to a particular verifier, across all interactions with the counterparty.
1398
1418
 
1399
1419
  ```ts
1400
- export interface WalletCertificate {
1401
- type: Base64String;
1402
- subject: PubKeyHex;
1403
- serialNumber: Base64String;
1404
- certifier: PubKeyHex;
1405
- revocationOutpoint: OutpointString;
1406
- signature: HexString;
1407
- fields: Record<CertificateFieldNameUnder50Bytes, string>;
1408
- }
1420
+ revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>
1409
1421
  ```
1422
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult)
1410
1423
 
1411
- See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
1412
-
1413
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1424
+ #### Property revealSpecificKeyLinkage
1414
1425
 
1415
- ---
1416
- ### Interface: WalletDecryptArgs
1426
+ Reveals the key linkage between ourselves and a counterparty, to a particular verifier, with respect to a specific interaction.
1417
1427
 
1418
1428
  ```ts
1419
- export interface WalletDecryptArgs extends WalletEncryptionArgs {
1420
- ciphertext: Byte[];
1421
- }
1429
+ revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>
1422
1430
  ```
1431
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult)
1423
1432
 
1424
- See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
1425
-
1426
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1433
+ #### Property signAction
1427
1434
 
1428
- ---
1429
- ### Interface: WalletDecryptResult
1435
+ Signs a transaction previously created using `createAction`.
1430
1436
 
1431
1437
  ```ts
1432
- export interface WalletDecryptResult {
1433
- plaintext: Byte[];
1434
- }
1438
+ signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>
1435
1439
  ```
1440
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult)
1436
1441
 
1437
- See also: [Byte](#type-byte)
1438
-
1439
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1442
+ #### Property verifyHmac
1440
1443
 
1441
- ---
1442
- ### Interface: WalletEncryptArgs
1444
+ Verifies an HMAC (Hash-based Message Authentication Code) based on the provided data, protocol, key ID, counterparty, and other factors.
1443
1445
 
1444
1446
  ```ts
1445
- export interface WalletEncryptArgs extends WalletEncryptionArgs {
1446
- plaintext: Byte[];
1447
- }
1447
+ verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>
1448
1448
  ```
1449
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult)
1449
1450
 
1450
- See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
1451
-
1452
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1451
+ #### Property verifySignature
1453
1452
 
1454
- ---
1455
- ### Interface: WalletEncryptResult
1453
+ Verifies a digital signature for the provided data or hash using a specific protocol, key, and optionally considering privilege and counterparty.
1456
1454
 
1457
1455
  ```ts
1458
- export interface WalletEncryptResult {
1459
- ciphertext: Byte[];
1460
- }
1456
+ verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>
1461
1457
  ```
1458
+ See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult)
1462
1459
 
1463
- See also: [Byte](#type-byte)
1464
-
1465
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1460
+ #### Property waitForAuthentication
1466
1461
 
1467
- ---
1468
- ### Interface: WalletEncryptionArgs
1462
+ Continuously waits until the user is authenticated, returning the result once confirmed.
1469
1463
 
1470
1464
  ```ts
1471
- export interface WalletEncryptionArgs {
1472
- protocolID: WalletProtocol;
1473
- keyID: KeyIDStringUnder800Bytes;
1474
- counterparty?: WalletCounterparty;
1475
- privileged?: BooleanDefaultFalse;
1476
- privilegedReason?: DescriptionString5to50Bytes;
1477
- seekPermission?: BooleanDefaultTrue;
1478
- }
1465
+ waitForAuthentication: (args: {}, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
1479
1466
  ```
1467
+ See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
1480
1468
 
1481
- See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
1482
-
1483
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1484
-
1485
- ---
1486
- ### Interface: WalletErrorObject
1487
-
1488
- Every method of the `Wallet` interface has a return value of the form `Promise<object>`.
1489
- When errors occur, an exception object may be thrown which must conform to the `WalletErrorObject` interface.
1490
- Serialization layers can rely on the `isError` property being unique to error objects.
1491
- Deserialization should rethrow `WalletErrorObject` conforming objects.
1492
-
1493
- ```ts
1494
- export interface WalletErrorObject extends Error {
1495
- isError: true;
1496
- }
1497
- ```
1469
+ </details>
1498
1470
 
1499
1471
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1500
1472
 
@@ -1738,7 +1710,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
1738
1710
  ### Class: HTTPWalletJSON
1739
1711
 
1740
1712
  ```ts
1741
- export default class HTTPWalletJSON implements Wallet {
1713
+ export default class HTTPWalletJSON implements WalletInterface {
1742
1714
  baseUrl: string;
1743
1715
  httpClient: typeof fetch;
1744
1716
  originator: OriginatorDomainNameStringUnder250Bytes | undefined;
@@ -1954,7 +1926,7 @@ export default class HTTPWalletJSON implements Wallet {
1954
1926
  }
1955
1927
  ```
1956
1928
 
1957
- See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [Wallet](#interface-wallet), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
1929
+ See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
1958
1930
 
1959
1931
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1960
1932
 
@@ -2083,10 +2055,6 @@ Argument Details
2083
2055
  + **counterparty**
2084
2056
  + The counterparty's public key or a predefined value ('self' or 'anyone').
2085
2057
 
2086
- Throws
2087
-
2088
- - Throws an error if attempting to derive a symmetric key for 'anyone'.
2089
-
2090
2058
  #### Method revealCounterpartySecret
2091
2059
 
2092
2060
  Reveals the shared secret between the root key and the counterparty.
@@ -2143,55 +2111,27 @@ A ProtoWallet is precursor to a full wallet, capable of performing all foundatio
2143
2111
  It can derive keys, create signatures, facilitate encryption and HMAC operations, and reveal key linkages.
2144
2112
 
2145
2113
  However, ProtoWallet does not create transactions, manage outputs, interact with the blockchain,
2146
- enable the management of identity certificates, or store any data.
2114
+ enable the management of identity certificates, or store any data. It is also not concerned with privileged keys.
2147
2115
 
2148
2116
  ```ts
2149
- export class ProtoWallet implements ProtoWalletApi {
2117
+ export class ProtoWallet {
2150
2118
  keyDeriver: KeyDeriverApi;
2151
2119
  constructor(rootKeyOrKeyDeriver: PrivateKey | "anyone" | KeyDeriverApi)
2152
- async isAuthenticated(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AuthenticatedResult>
2153
- async waitForAuthentication(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AuthenticatedResult>
2154
- async getNetwork(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetNetworkResult>
2155
- async getVersion(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetVersionResult>
2156
- async getIdentityKey(originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
2120
+ async getPublicKey(args: GetPublicKeyArgs): Promise<{
2157
2121
  publicKey: PubKeyHex;
2158
2122
  }>
2159
- async getPublicKey(args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
2160
- publicKey: PubKeyHex;
2161
- }>
2162
- async revealCounterpartyKeyLinkage(args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RevealCounterpartyKeyLinkageResult>
2163
- async revealSpecificKeyLinkage(args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RevealSpecificKeyLinkageResult>
2164
- async encrypt(args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<WalletEncryptResult>
2165
- async decrypt(args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<WalletDecryptResult>
2166
- async createHmac(args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateHmacResult>
2167
- async verifyHmac(args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<VerifyHmacResult>
2168
- async createSignature(args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateSignatureResult>
2169
- async verifySignature(args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<VerifySignatureResult>
2123
+ async revealCounterpartyKeyLinkage(args: RevealCounterpartyKeyLinkageArgs): Promise<RevealCounterpartyKeyLinkageResult>
2124
+ async revealSpecificKeyLinkage(args: RevealSpecificKeyLinkageArgs): Promise<RevealSpecificKeyLinkageResult>
2125
+ async encrypt(args: WalletEncryptArgs): Promise<WalletEncryptResult>
2126
+ async decrypt(args: WalletDecryptArgs): Promise<WalletDecryptResult>
2127
+ async createHmac(args: CreateHmacArgs): Promise<CreateHmacResult>
2128
+ async verifyHmac(args: VerifyHmacArgs): Promise<VerifyHmacResult>
2129
+ async createSignature(args: CreateSignatureArgs): Promise<CreateSignatureResult>
2130
+ async verifySignature(args: VerifySignatureArgs): Promise<VerifySignatureResult>
2170
2131
  }
2171
2132
  ```
2172
2133
 
2173
- See also: [AuthenticatedResult](#interface-authenticatedresult), [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [GetNetworkResult](#interface-getnetworkresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [GetVersionResult](#interface-getversionresult), [KeyDeriverApi](#interface-keyderiverapi), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [PrivateKey](#class-privatekey), [ProtoWalletApi](#interface-protowalletapi), [PubKeyHex](#type-pubkeyhex), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
2174
-
2175
- <details>
2176
-
2177
- <summary>Class ProtoWallet Details</summary>
2178
-
2179
- #### Method getIdentityKey
2180
-
2181
- Convenience method to obtain the identityKey.
2182
-
2183
- ```ts
2184
- async getIdentityKey(originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
2185
- publicKey: PubKeyHex;
2186
- }>
2187
- ```
2188
- See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [PubKeyHex](#type-pubkeyhex)
2189
-
2190
- Returns
2191
-
2192
- `await this.getPublicKey({ identityKey: true }, originator)`
2193
-
2194
- </details>
2134
+ See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [KeyDeriverApi](#interface-keyderiverapi), [PrivateKey](#class-privatekey), [PubKeyHex](#type-pubkeyhex), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
2195
2135
 
2196
2136
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2197
2137
 
@@ -2201,10 +2141,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
2201
2141
  The SDK is how applications communicate with wallets over a communications substrate.
2202
2142
 
2203
2143
  ```ts
2204
- export default class WalletClient implements Wallet {
2205
- public substrate: "auto" | Wallet;
2144
+ export default class WalletClient implements WalletInterface {
2145
+ public substrate: "auto" | WalletInterface;
2206
2146
  originator?: OriginatorDomainNameStringUnder250Bytes;
2207
- constructor(substrate: "auto" | "Cicada" | "XDM" | "window.CWI" | "json-api" | Wallet = "auto", originator?: OriginatorDomainNameStringUnder250Bytes)
2147
+ constructor(substrate: "auto" | "Cicada" | "XDM" | "window.CWI" | "json-api" | WalletInterface = "auto", originator?: OriginatorDomainNameStringUnder250Bytes)
2208
2148
  async connectToSubstrate()
2209
2149
  async createAction(args: CreateActionArgs): Promise<CreateActionResult>
2210
2150
  async signAction(args: SignActionArgs): Promise<SignActionResult>
@@ -2405,7 +2345,7 @@ export default class WalletClient implements Wallet {
2405
2345
  }
2406
2346
  ```
2407
2347
 
2408
- See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [AuthenticatedResult](#interface-authenticatedresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [Wallet](#interface-wallet), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
2348
+ See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [AuthenticatedResult](#interface-authenticatedresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
2409
2349
 
2410
2350
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2411
2351
 
@@ -2429,13 +2369,13 @@ Processes incoming wallet calls received over a wallet wire, with a given wallet
2429
2369
 
2430
2370
  ```ts
2431
2371
  export default class WalletWireProcessor implements WalletWire {
2432
- wallet: Wallet;
2433
- constructor(wallet: Wallet)
2372
+ wallet: WalletInterface;
2373
+ constructor(wallet: WalletInterface)
2434
2374
  async transmitToWallet(message: number[]): Promise<number[]>
2435
2375
  }
2436
2376
  ```
2437
2377
 
2438
- See also: [Wallet](#interface-wallet), [WalletWire](#interface-walletwire)
2378
+ See also: [WalletInterface](#interface-walletinterface), [WalletWire](#interface-walletwire)
2439
2379
 
2440
2380
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2441
2381
 
@@ -2445,7 +2385,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
2445
2385
  A way to make remote calls to a wallet over a wallet wire.
2446
2386
 
2447
2387
  ```ts
2448
- export default class WalletWireTransceiver implements Wallet {
2388
+ export default class WalletWireTransceiver implements WalletInterface {
2449
2389
  wire: WalletWire;
2450
2390
  constructor(wire: WalletWire)
2451
2391
  async createAction(args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateActionResult>
@@ -2658,7 +2598,7 @@ export default class WalletWireTransceiver implements Wallet {
2658
2598
  }
2659
2599
  ```
2660
2600
 
2661
- See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [Wallet](#interface-wallet), [WalletWire](#interface-walletwire), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
2601
+ See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#interface-acquirecertificateresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface), [WalletWire](#interface-walletwire), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
2662
2602
 
2663
2603
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2664
2604
 
@@ -2668,7 +2608,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
2668
2608
  Facilitates wallet operations over the window.CWI interface.
2669
2609
 
2670
2610
  ```ts
2671
- export default class WindowCWISubstrate implements Wallet {
2611
+ export default class WindowCWISubstrate implements WalletInterface {
2672
2612
  constructor()
2673
2613
  async createAction(args: {
2674
2614
  description: DescriptionString5to50Bytes;
@@ -3101,7 +3041,7 @@ export default class WindowCWISubstrate implements Wallet {
3101
3041
  }
3102
3042
  ```
3103
3043
 
3104
- See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [Wallet](#interface-wallet), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
3044
+ See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
3105
3045
 
3106
3046
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3107
3047
 
@@ -3111,7 +3051,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
3111
3051
  Facilitates wallet operations over cross-document messaging.
3112
3052
 
3113
3053
  ```ts
3114
- export default class XDMSubstrate implements Wallet {
3054
+ export default class XDMSubstrate implements WalletInterface {
3115
3055
  constructor(domain: string = "*")
3116
3056
  async invoke(call: CallType, args: any): Promise<any>
3117
3057
  async createAction(args: {
@@ -3545,7 +3485,7 @@ export default class XDMSubstrate implements Wallet {
3545
3485
  }
3546
3486
  ```
3547
3487
 
3548
- See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CallType](#type-calltype), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [Wallet](#interface-wallet), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
3488
+ See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CallType](#type-calltype), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface), [decrypt](#variable-decrypt), [encrypt](#variable-encrypt)
3549
3489
 
3550
3490
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3551
3491