@bsv/sdk 1.3.2 → 1.3.4

package/src/wallet/WalletClient.ts

@@ -4,6 +4,7 @@ import XDMSubstrate from './substrates/XDM.js'
 import WalletWireTransceiver from './substrates/WalletWireTransceiver.js'
 import HTTPWalletWire from './substrates/HTTPWalletWire.js'
 import HTTPWalletJSON from './substrates/HTTPWalletJSON.js'
+import { AuthenticatedResult } from './Wallet.interfaces.js'
 
 const MAX_XDM_RESPONSE_WAIT = 200
 
@@ -177,7 +178,7 @@ export default class WalletClient implements Wallet {
     return await (this.substrate as Wallet).discoverByAttributes(args, this.originator)
   }
 
-  async isAuthenticated (args: {} = {}): Promise<{ authenticated: boolean }> {
+  async isAuthenticated (args: {} = {}): Promise<AuthenticatedResult> {
     await this.connectToSubstrate()
     return await (this.substrate as Wallet).isAuthenticated(args, this.originator)
   }

package/src/wallet/__tests/ProtoWallet.test.ts

@@ -6,52 +6,6 @@ const sampleData = [3, 1, 4, 1, 5, 9]
 describe('ProtoWallet', () => {
   it('Throws when functions are not supported', async () => {
     const wallet = new ProtoWallet('anyone')
-    await expect(() => {
-      return (wallet as any).createAction()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).abortAction()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).signAction()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).listOutputs()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).relinquishOutput()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).listActions()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).internalizeAction()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).acquireCertificate()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).proveCertificate()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).listCertificates()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).relinquishCertificate()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).getHeight()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).getHeaderForHeight()
-    }).rejects.toThrow()
-    // TODO: Remove these two from the throw list once they are implemented.
-    await expect(() => {
-      return (wallet as any).discoverByIdentityKey()
-    }).rejects.toThrow()
-    await expect(() => {
-      return (wallet as any).discoverByAttributes()
-    }).rejects.toThrow()
   })
   it('Throws the privileged error when the privileged flag is set', async () => {
     const wallet = new ProtoWallet('anyone')
@@ -339,13 +293,6 @@ describe('ProtoWallet', () => {
       counterparty: counterpartyKey.toPublicKey().toString()
     })).rejects.toThrow()
   })
-  it('Returns the expected version, network, and authentication status', async () => {
-    const wallet = new ProtoWallet('anyone')
-    expect(await wallet.getVersion({})).toEqual({ version: 'proto-1.0.0' })
-    expect(await wallet.getNetwork({})).toEqual({ network: 'mainnet' })
-    expect(await wallet.isAuthenticated({})).toEqual({ authenticated: true })
-    expect(await wallet.waitForAuthentication({})).toEqual({ authenticated: true })
-  })
   it('Uses anyone for creating signatures and self for other operations if no counterparty is provided', async () => {
     const userKey = PrivateKey.fromRandom()
     const user = new ProtoWallet(userKey)

package/src/wallet/substrates/HTTPWalletJSON.ts

@@ -117,7 +117,7 @@ export default class HTTPWalletJSON implements Wallet {
     return await this.api('discoverByAttributes', args)
   }
 
-  async isAuthenticated(args: {}): Promise<{ authenticated: boolean }> {
+  async isAuthenticated(args: {}): Promise<{ authenticated: true }> {
     return await this.api('isAuthenticated', args)
   }
 

package/src/wallet/substrates/WalletWireTransceiver.ts

@@ -1411,8 +1411,9 @@ export default class WalletWireTransceiver implements Wallet {
     return this.parseDiscoveryResult(result)
   }
 
-  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{ authenticated: boolean }> {
+  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{ authenticated: true }> {
     const result = await this.transmit('isAuthenticated', originator)
+    // @ts-ignore
     return { authenticated: !!result[0] }
   }
 

package/src/wallet/substrates/XDM.ts

@@ -63,7 +63,7 @@ export default class XDMSubstrate implements Wallet {
     return await this.invoke('internalizeAction', args)
   }
 
-  async listOutputs(args: { basket: BasketStringUnder300Bytes, tags?: OutputTagStringUnder300Bytes[], tagQueryMode?: 'all' | 'any', include?: 'locking scripts' | 'entire transactions', includeCustomInstructions?: BooleanDefaultFalse, includeTags?: BooleanDefaultFalse, includeLabels?: BooleanDefaultFalse, limit?: PositiveIntegerDefault10Max10000, offset?: PositiveIntegerOrZero }): Promise<{ totalOutputs: PositiveIntegerOrZero, outputs: Array<{ outpoint: OutpointString, satoshis: SatoshiValue, lockingScript?: HexString, tx?: BEEF, spendable: true, customInstructions?: string, tags?: OutputTagStringUnder300Bytes[], labels?: LabelStringUnder300Bytes[] }> }> {
+  async listOutputs(args: { basket: BasketStringUnder300Bytes, tags?: OutputTagStringUnder300Bytes[], tagQueryMode?: 'all' | 'any', include?: 'locking scripts' | 'entire transactions', includeCustomInstructions?: BooleanDefaultFalse, includeTags?: BooleanDefaultFalse, includeLabels?: BooleanDefaultFalse, limit?: PositiveIntegerDefault10Max10000, offset?: PositiveIntegerOrZero }): Promise<{ totalOutputs: PositiveIntegerOrZero, outputs: Array<{ outpoint: OutpointString, satoshis: SatoshiValue, lockingScript?: HexString, tx?: BEEF, spendable: boolean, customInstructions?: string, tags?: OutputTagStringUnder300Bytes[], labels?: LabelStringUnder300Bytes[] }> }> {
     return await this.invoke('listOutputs', args)
   }
 
@@ -131,7 +131,7 @@ export default class XDMSubstrate implements Wallet {
     return await this.invoke('discoverByAttributes', args)
   }
 
-  async isAuthenticated(args: {}): Promise<{ authenticated: boolean }> {
+  async isAuthenticated(args: {}): Promise<{ authenticated: true }> {
     return await this.invoke('isAuthenticated', args)
   }
 

package/src/wallet/substrates/__tests/WalletWire.integration.test.ts

@@ -1361,7 +1361,7 @@ describe('WalletWire Integration Tests', () => {
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         certifier: '02' + 'b'.repeat(64),
         revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-        signature: '00',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         fields: {
           field1: 'value1',
           field2: 'value2'
@@ -1383,7 +1383,7 @@ describe('WalletWire Integration Tests', () => {
         },
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-        signature: '00',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         keyringRevealer: 'certifier',
         keyringForSubject: {}
       }
@@ -1405,7 +1405,7 @@ describe('WalletWire Integration Tests', () => {
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         certifier: '02' + 'b'.repeat(64),
         revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-        signature: '00',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         fields: {
           field1: 'value1',
           field2: 'value2'
@@ -1427,7 +1427,7 @@ describe('WalletWire Integration Tests', () => {
         },
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-        signature: '00',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         keyringRevealer: 'certifier' as 'certifier',
         keyringForSubject: {
           field1: Utils.toBase64([0x01, 0x02, 0x03]),
@@ -1453,7 +1453,7 @@ describe('WalletWire Integration Tests', () => {
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         certifier: '02' + 'b'.repeat(64),
         revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-        signature: '00',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         fields: {
           field1: 'value1',
           field2: 'value2'
@@ -1476,7 +1476,7 @@ describe('WalletWire Integration Tests', () => {
         },
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-        signature: '00',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         keyringRevealer: keyringRevealerPubKey,
         keyringForSubject: {
           field1: Utils.toBase64([0x01, 0x02, 0x03]),
@@ -1502,7 +1502,7 @@ describe('WalletWire Integration Tests', () => {
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         certifier: '02' + 'b'.repeat(64),
         revocationOutpoint: 'cafebabedeadbeefcafebabedeadbeefdeadbeefdeadbeefdeadbeefdeadbeef.1',
-        signature: '01',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         fields: {
           field3: 'value3',
           field4: 'value4'
@@ -1543,7 +1543,7 @@ describe('WalletWire Integration Tests', () => {
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         certifier: '02' + 'b'.repeat(64),
         revocationOutpoint: 'beadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbead.2',
-        signature: '02',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         fields: {
           field5: 'value5'
         }
@@ -1563,7 +1563,7 @@ describe('WalletWire Integration Tests', () => {
         },
         serialNumber: Utils.toBase64(new Array(32).fill(2)),
         revocationOutpoint: 'beadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbead.2',
-        signature: '02',
+        signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
         keyringRevealer: 'certifier' as 'certifier',
         keyringForSubject: {} // Empty keyring
       }
@@ -1592,7 +1592,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-            signature: '00',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {
               field1: 'value1',
               field2: 'value2'
@@ -1629,7 +1629,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef.0',
-            signature: '00',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {
               field1: 'value1',
               field2: 'value2'
@@ -1641,7 +1641,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'cafebabecafebabecafebabecafebabecafebabecafebabecafebabecafebabe.1',
-            signature: '01',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {
               field3: 'value3',
               field4: 'value4',
@@ -1688,7 +1688,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'e'.repeat(64),
             revocationOutpoint: 'cafecafecafecafecafecafecafecafecafecafecafecafecafecafecafecafe.2',
-            signature: '03',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {
               field6: 'value6'
             }
@@ -1738,7 +1738,7 @@ describe('WalletWire Integration Tests', () => {
           serialNumber: Utils.toBase64(new Array(32).fill(2)),
           certifier: '02' + 'b'.repeat(64),
           revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-          signature: '00',
+          signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
           fields: {
             field1: 'value1',
             field2: 'value2'
@@ -1772,7 +1772,7 @@ describe('WalletWire Integration Tests', () => {
           serialNumber: Utils.toBase64(new Array(32).fill(2)),
           certifier: '02' + 'b'.repeat(64),
           revocationOutpoint: 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef.0',
-          signature: '00',
+          signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
           fields: {
             field1: 'value1',
             field2: 'value2',
@@ -1806,7 +1806,7 @@ describe('WalletWire Integration Tests', () => {
           serialNumber: Utils.toBase64(new Array(32).fill(2)),
           certifier: '02' + 'b'.repeat(64),
           revocationOutpoint: 'cafebabecafebabecafebabecafebabecafebabecafebabecafebabecafebabe.1',
-          signature: '01',
+          signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
           fields: {
             field4: 'value4',
             field5: 'value5'
@@ -1917,7 +1917,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-            signature: '00',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {},
             certifierInfo: {
               name: 'Test Certifier',
@@ -1958,7 +1958,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef.0',
-            signature: '00',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {},
             certifierInfo: {
               name: 'Test Certifier',
@@ -2001,7 +2001,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef.0',
-            signature: '00',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {},
             certifierInfo: {
               name: 'Certifier One',
@@ -2022,7 +2022,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'c'.repeat(64),
             revocationOutpoint: 'cafebabecafebabecafebabecafebabecafebabecafebabecafebabecafebabe.1',
-            signature: '01',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {},
             certifierInfo: {
               name: 'Certifier Two',
@@ -2070,7 +2070,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'b'.repeat(64),
             revocationOutpoint: 'deadbeef20248806deadbeef20248806deadbeef20248806deadbeef20248806.0',
-            signature: '00',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {},
             certifierInfo: {
               name: 'Test Certifier',
@@ -2128,7 +2128,7 @@ describe('WalletWire Integration Tests', () => {
             serialNumber: Utils.toBase64(new Array(32).fill(2)),
             certifier: '02' + 'e'.repeat(64),
             revocationOutpoint: 'beadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbeadbead.2',
-            signature: '02',
+            signature: '3045022100e4d03d959697ed191f9ef7ae7deacd3118b8693d18da0fd76e4ad92664ce05cf02200d753951e766cbf2d2b306e08921c06341d2de67ab75389bf84caf954ee40e88',
             fields: {},
             certifierInfo: {
               name: 'Certifier Three',

package/src/wallet/substrates/window.CWI.ts

@@ -39,7 +39,7 @@ export default class WindowCWISubstrate implements Wallet {
     return this.CWI.internalizeAction(args, originator)
   }
 
-  async listOutputs(args: { basket: BasketStringUnder300Bytes, tags?: OutputTagStringUnder300Bytes[], tagQueryMode?: 'all' | 'any', include?: 'locking scripts' | 'entire transactions', includeCustomInstructions?: BooleanDefaultFalse, includeTags?: BooleanDefaultFalse, includeLabels?: BooleanDefaultFalse, limit?: PositiveIntegerDefault10Max10000, offset?: PositiveIntegerOrZero }, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{ totalOutputs: PositiveIntegerOrZero, outputs: Array<{ outpoint: OutpointString, satoshis: SatoshiValue, lockingScript?: HexString, tx?: BEEF, spendable: true, customInstructions?: string, tags?: OutputTagStringUnder300Bytes[], labels?: LabelStringUnder300Bytes[] }> }> {
+  async listOutputs(args: { basket: BasketStringUnder300Bytes, tags?: OutputTagStringUnder300Bytes[], tagQueryMode?: 'all' | 'any', include?: 'locking scripts' | 'entire transactions', includeCustomInstructions?: BooleanDefaultFalse, includeTags?: BooleanDefaultFalse, includeLabels?: BooleanDefaultFalse, limit?: PositiveIntegerDefault10Max10000, offset?: PositiveIntegerOrZero }, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{ totalOutputs: PositiveIntegerOrZero, outputs: Array<{ outpoint: OutpointString, satoshis: SatoshiValue, lockingScript?: HexString, tx?: BEEF, spendable: boolean, customInstructions?: string, tags?: OutputTagStringUnder300Bytes[], labels?: LabelStringUnder300Bytes[] }> }> {
     return this.CWI.listOutputs(args, originator)
   }
 
@@ -107,7 +107,7 @@ export default class WindowCWISubstrate implements Wallet {
     return this.CWI.discoverByAttributes(args, originator)
   }
 
-  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{ authenticated: boolean }> {
+  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{ authenticated: true }> {
     return this.CWI.isAuthenticated(args, originator)
   }