@bsv/sdk 1.3.3 → 1.3.5

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 (79) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/auth/certificates/Certificate.js.map +1 -1
  3. package/dist/cjs/src/auth/certificates/MasterCertificate.js.map +1 -1
  4. package/dist/cjs/src/auth/utils/certificateHelpers.js +2 -2
  5. package/dist/cjs/src/auth/utils/certificateHelpers.js.map +1 -1
  6. package/dist/cjs/src/wallet/CachedKeyDeriver.js +11 -14
  7. package/dist/cjs/src/wallet/CachedKeyDeriver.js.map +1 -1
  8. package/dist/cjs/src/wallet/KeyDeriver.js +14 -11
  9. package/dist/cjs/src/wallet/KeyDeriver.js.map +1 -1
  10. package/dist/cjs/src/wallet/ProtoWallet.js +53 -111
  11. package/dist/cjs/src/wallet/ProtoWallet.js.map +1 -1
  12. package/dist/cjs/src/wallet/WalletClient.js.map +1 -1
  13. package/dist/cjs/src/wallet/index.js +2 -3
  14. package/dist/cjs/src/wallet/index.js.map +1 -1
  15. package/dist/cjs/src/wallet/substrates/WalletWireTransceiver.js +1 -0
  16. package/dist/cjs/src/wallet/substrates/WalletWireTransceiver.js.map +1 -1
  17. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  18. package/dist/esm/src/auth/certificates/Certificate.js.map +1 -1
  19. package/dist/esm/src/auth/certificates/MasterCertificate.js.map +1 -1
  20. package/dist/esm/src/auth/utils/certificateHelpers.js +2 -2
  21. package/dist/esm/src/auth/utils/certificateHelpers.js.map +1 -1
  22. package/dist/esm/src/wallet/CachedKeyDeriver.js +10 -10
  23. package/dist/esm/src/wallet/CachedKeyDeriver.js.map +1 -1
  24. package/dist/esm/src/wallet/KeyDeriver.js +15 -12
  25. package/dist/esm/src/wallet/KeyDeriver.js.map +1 -1
  26. package/dist/esm/src/wallet/ProtoWallet.js +53 -76
  27. package/dist/esm/src/wallet/ProtoWallet.js.map +1 -1
  28. package/dist/esm/src/wallet/WalletClient.js.map +1 -1
  29. package/dist/esm/src/wallet/index.js +1 -1
  30. package/dist/esm/src/wallet/index.js.map +1 -1
  31. package/dist/esm/src/wallet/substrates/WalletWireTransceiver.js +1 -0
  32. package/dist/esm/src/wallet/substrates/WalletWireTransceiver.js.map +1 -1
  33. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  34. package/dist/types/src/auth/certificates/Certificate.d.ts +2 -2
  35. package/dist/types/src/auth/certificates/Certificate.d.ts.map +1 -1
  36. package/dist/types/src/auth/certificates/MasterCertificate.d.ts +2 -2
  37. package/dist/types/src/auth/certificates/MasterCertificate.d.ts.map +1 -1
  38. package/dist/types/src/auth/utils/certificateHelpers.d.ts +5 -5
  39. package/dist/types/src/auth/utils/certificateHelpers.d.ts.map +1 -1
  40. package/dist/types/src/wallet/CachedKeyDeriver.d.ts +16 -15
  41. package/dist/types/src/wallet/CachedKeyDeriver.d.ts.map +1 -1
  42. package/dist/types/src/wallet/KeyDeriver.d.ts +74 -18
  43. package/dist/types/src/wallet/KeyDeriver.d.ts.map +1 -1
  44. package/dist/types/src/wallet/ProtoWallet.d.ts +31 -407
  45. package/dist/types/src/wallet/ProtoWallet.d.ts.map +1 -1
  46. package/dist/types/src/wallet/Wallet.interfaces.d.ts +201 -169
  47. package/dist/types/src/wallet/Wallet.interfaces.d.ts.map +1 -1
  48. package/dist/types/src/wallet/WalletClient.d.ts +2 -3
  49. package/dist/types/src/wallet/WalletClient.d.ts.map +1 -1
  50. package/dist/types/src/wallet/index.d.ts +1 -1
  51. package/dist/types/src/wallet/index.d.ts.map +1 -1
  52. package/dist/types/src/wallet/substrates/HTTPWalletJSON.d.ts +1 -1
  53. package/dist/types/src/wallet/substrates/HTTPWalletJSON.d.ts.map +1 -1
  54. package/dist/types/src/wallet/substrates/WalletWireTransceiver.d.ts +1 -1
  55. package/dist/types/src/wallet/substrates/WalletWireTransceiver.d.ts.map +1 -1
  56. package/dist/types/src/wallet/substrates/XDM.d.ts +2 -2
  57. package/dist/types/src/wallet/substrates/XDM.d.ts.map +1 -1
  58. package/dist/types/src/wallet/substrates/window.CWI.d.ts +2 -2
  59. package/dist/types/src/wallet/substrates/window.CWI.d.ts.map +1 -1
  60. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  61. package/dist/umd/bundle.js +1 -1
  62. package/docs/auth.md +12 -12
  63. package/docs/wallet-substrates.md +6 -6
  64. package/docs/wallet.md +897 -983
  65. package/package.json +1 -1
  66. package/src/auth/certificates/Certificate.ts +1 -1
  67. package/src/auth/certificates/MasterCertificate.ts +3 -2
  68. package/src/auth/utils/certificateHelpers.ts +5 -5
  69. package/src/wallet/CachedKeyDeriver.ts +22 -21
  70. package/src/wallet/KeyDeriver.ts +89 -22
  71. package/src/wallet/ProtoWallet.ts +105 -550
  72. package/src/wallet/Wallet.interfaces.ts +259 -176
  73. package/src/wallet/WalletClient.ts +2 -1
  74. package/src/wallet/__tests/ProtoWallet.test.ts +0 -53
  75. package/src/wallet/index.ts +1 -1
  76. package/src/wallet/substrates/HTTPWalletJSON.ts +1 -1
  77. package/src/wallet/substrates/WalletWireTransceiver.ts +2 -1
  78. package/src/wallet/substrates/XDM.ts +2 -2
  79. package/src/wallet/substrates/window.CWI.ts +2 -2
package/docs/auth.md CHANGED
@@ -217,11 +217,11 @@ export default class Certificate {
217
217
  toBinary(includeSignature: boolean = true): number[]
218
218
  static fromBinary(bin: number[]): Certificate
219
219
  async verify(): Promise<boolean>
220
- async sign(certifier: Wallet): Promise<void>
220
+ async sign(certifier: ProtoWallet): Promise<void>
221
221
  }
222
222
  ```
223
223
 
224
- See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex), [Wallet](#interface-wallet), [sign](#variable-sign), [verify](#variable-verify)
224
+ See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [ProtoWallet](#class-protowallet), [PubKeyHex](#type-pubkeyhex), [sign](#variable-sign), [verify](#variable-verify)
225
225
 
226
226
  <details>
227
227
 
@@ -339,9 +339,9 @@ Argument Details
339
339
  Signs the certificate using the provided certifier wallet.
340
340
 
341
341
  ```ts
342
- async sign(certifier: Wallet): Promise<void>
342
+ async sign(certifier: ProtoWallet): Promise<void>
343
343
  ```
344
- See also: [Wallet](#interface-wallet)
344
+ See also: [ProtoWallet](#class-protowallet)
345
345
 
346
346
  Argument Details
347
347
 
@@ -401,11 +401,11 @@ export class MasterCertificate extends Certificate {
401
401
  declare signature?: HexString;
402
402
  masterKeyring: Record<CertificateFieldNameUnder50Bytes, string>;
403
403
  constructor(type: Base64String, serialNumber: Base64String, subject: PubKeyHex, certifier: PubKeyHex, revocationOutpoint: OutpointString, fields: Record<CertificateFieldNameUnder50Bytes, string>, masterKeyring: Record<CertificateFieldNameUnder50Bytes, string>, signature?: HexString)
404
- async createKeyringForVerifier(subjectWallet: Wallet, verifierIdentityKey: string, fieldsToReveal: string[], originator?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
404
+ async createKeyringForVerifier(subjectWallet: ProtoWallet, verifierIdentityKey: string, fieldsToReveal: string[], originator?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
405
405
  }
406
406
  ```
407
407
 
408
- See also: [Base64String](#type-base64string), [Certificate](#class-certificate), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex), [Wallet](#interface-wallet)
408
+ See also: [Base64String](#type-base64string), [Certificate](#class-certificate), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [ProtoWallet](#class-protowallet), [PubKeyHex](#type-pubkeyhex)
409
409
 
410
410
  <details>
411
411
 
@@ -419,9 +419,9 @@ for the verifier's identity key. The resulting certificate structure includes on
419
419
  revealed and a verifier-specific keyring for field decryption.
420
420
 
421
421
  ```ts
422
- async createKeyringForVerifier(subjectWallet: Wallet, verifierIdentityKey: string, fieldsToReveal: string[], originator?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
422
+ async createKeyringForVerifier(subjectWallet: ProtoWallet, verifierIdentityKey: string, fieldsToReveal: string[], originator?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
423
423
  ```
424
- See also: [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [Wallet](#interface-wallet)
424
+ See also: [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [ProtoWallet](#class-protowallet)
425
425
 
426
426
  Returns
427
427
 
@@ -1003,10 +1003,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
1003
1003
  Creates a Master Certificate by encrypting provided fields and generating a master keyring.
1004
1004
 
1005
1005
  ```ts
1006
- export async function createMasterCertificate(wallet: Wallet, fields: Record<string, string>, certificateType: string, certificateSerialNumber: string, certifierPublicKey: string): Promise<MasterCertificate>
1006
+ export async function createMasterCertificate(wallet: ProtoWallet, fields: Record<string, string>, certificateType: string, certificateSerialNumber: string, certifierPublicKey: string): Promise<MasterCertificate>
1007
1007
  ```
1008
1008
 
1009
- See also: [MasterCertificate](#class-mastercertificate), [Wallet](#interface-wallet)
1009
+ See also: [MasterCertificate](#class-mastercertificate), [ProtoWallet](#class-protowallet)
1010
1010
 
1011
1011
  <details>
1012
1012
 
@@ -1062,10 +1062,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
1062
1062
  Creates a Verifiable Certificate by signing a Master Certificate and generating a keyring for a verifier.
1063
1063
 
1064
1064
  ```ts
1065
- export async function createVerifiableCertificate(masterCertificate: MasterCertificate, wallet: Wallet, verifierIdentityKey: string, fieldsToReveal: string[], certifierPrivateKey: PrivateKey): Promise<VerifiableCertificate>
1065
+ export async function createVerifiableCertificate(masterCertificate: MasterCertificate, wallet: ProtoWallet, verifierIdentityKey: string, fieldsToReveal: string[], certifierPrivateKey: PrivateKey): Promise<VerifiableCertificate>
1066
1066
  ```
1067
1067
 
1068
- See also: [MasterCertificate](#class-mastercertificate), [PrivateKey](#class-privatekey), [VerifiableCertificate](#class-verifiablecertificate), [Wallet](#interface-wallet)
1068
+ See also: [MasterCertificate](#class-mastercertificate), [PrivateKey](#class-privatekey), [ProtoWallet](#class-protowallet), [VerifiableCertificate](#class-verifiablecertificate)
1069
1069
 
1070
1070
  <details>
1071
1071
 
@@ -229,7 +229,7 @@ export default class HTTPWalletJSON implements Wallet {
229
229
  offset?: PositiveIntegerOrZero;
230
230
  }): Promise<DiscoverCertificatesResult>
231
231
  async isAuthenticated(args: {}): Promise<{
232
- authenticated: boolean;
232
+ authenticated: true;
233
233
  }>
234
234
  async waitForAuthentication(args: {}): Promise<{
235
235
  authenticated: true;
@@ -486,7 +486,7 @@ export default class WalletWireTransceiver implements Wallet {
486
486
  offset?: PositiveIntegerOrZero;
487
487
  }, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult>
488
488
  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
489
- authenticated: boolean;
489
+ authenticated: true;
490
490
  }>
491
491
  async waitForAuthentication(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
492
492
  authenticated: true;
@@ -671,7 +671,7 @@ export default class WindowCWISubstrate implements Wallet {
671
671
  satoshis: SatoshiValue;
672
672
  lockingScript?: HexString;
673
673
  tx?: BEEF;
674
- spendable: true;
674
+ spendable: boolean;
675
675
  customInstructions?: string;
676
676
  tags?: OutputTagStringUnder300Bytes[];
677
677
  labels?: LabelStringUnder300Bytes[];
@@ -929,7 +929,7 @@ export default class WindowCWISubstrate implements Wallet {
929
929
  }>;
930
930
  }>
931
931
  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
932
- authenticated: boolean;
932
+ authenticated: true;
933
933
  }>
934
934
  async waitForAuthentication(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
935
935
  authenticated: true;
@@ -1115,7 +1115,7 @@ export default class XDMSubstrate implements Wallet {
1115
1115
  satoshis: SatoshiValue;
1116
1116
  lockingScript?: HexString;
1117
1117
  tx?: BEEF;
1118
- spendable: true;
1118
+ spendable: boolean;
1119
1119
  customInstructions?: string;
1120
1120
  tags?: OutputTagStringUnder300Bytes[];
1121
1121
  labels?: LabelStringUnder300Bytes[];
@@ -1373,7 +1373,7 @@ export default class XDMSubstrate implements Wallet {
1373
1373
  }>;
1374
1374
  }>
1375
1375
  async isAuthenticated(args: {}): Promise<{
1376
- authenticated: boolean;
1376
+ authenticated: true;
1377
1377
  }>
1378
1378
  async waitForAuthentication(args: {}): Promise<{
1379
1379
  authenticated: true;