@bsv/sdk 1.1.13 → 1.1.15

package/docs/transaction.md

@@ -6,14 +6,14 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | | |
 | --- | --- |
-| [ArcConfig](#interface-arcconfig) | [HttpClient](#interface-httpclient) |
-| [BroadcastFailure](#interface-broadcastfailure) | [HttpClientRequestOptions](#interface-httpclientrequestoptions) |
-| [BroadcastResponse](#interface-broadcastresponse) | [HttpsNodejs](#interface-httpsnodejs) |
-| [Broadcaster](#interface-broadcaster) | [MerklePathLeaf](#interface-merklepathleaf) |
-| [ChainTracker](#interface-chaintracker) | [NodejsHttpClientRequest](#interface-nodejshttpclientrequest) |
-| [FeeModel](#interface-feemodel) | [TransactionInput](#interface-transactioninput) |
-| [Fetch](#interface-fetch) | [TransactionOutput](#interface-transactionoutput) |
+| [ArcConfig](#interface-arcconfig) | [HttpClientRequestOptions](#interface-httpclientrequestoptions) |
+| [BroadcastFailure](#interface-broadcastfailure) | [HttpsNodejs](#interface-httpsnodejs) |
+| [BroadcastResponse](#interface-broadcastresponse) | [MerklePathLeaf](#interface-merklepathleaf) |
+| [Broadcaster](#interface-broadcaster) | [NodejsHttpClientRequest](#interface-nodejshttpclientrequest) |
+| [ChainTracker](#interface-chaintracker) | [TransactionInput](#interface-transactioninput) |
+| [FeeModel](#interface-feemodel) | [TransactionOutput](#interface-transactionoutput) |
 | [FetchOptions](#interface-fetchoptions) | [WhatsOnChainConfig](#interface-whatsonchainconfig) |
+| [HttpClient](#interface-httpclient) |  |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
@@ -195,7 +195,7 @@ An interface for HTTP client used to make HTTP requests.
 
 ```ts
 export interface HttpClient {
-    request<T = any, D = any>(url: string, options: HttpClientRequestOptions<D>): Promise<HttpClientResponse<T>>;
+    request: <T = any, D = any>(url: string, options: HttpClientRequestOptions<D>) => Promise<HttpClientResponse<T>>;
 }
 ```
 
@@ -203,21 +203,14 @@ export interface HttpClient {
 
 <summary>Interface HttpClient Details</summary>
 
-#### Method request
+#### Property request
 
 Makes a request to the server.
 
 ```ts
-request<T = any, D = any>(url: string, options: HttpClientRequestOptions<D>): Promise<HttpClientResponse<T>>
+request: <T = any, D = any>(url: string, options: HttpClientRequestOptions<D>) => Promise<HttpClientResponse<T>>
 ```
 
-Argument Details
-
-+ **url**
-  + The URL to make the request to.
-+ **options**
-  + The request configuration.
-
 </details>
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
@@ -274,7 +267,7 @@ Node.js Https module interface limited to options needed by ts-sdk
 
 ```ts
 export interface HttpsNodejs {
-    request(url: string, options: HttpClientRequestOptions, callback: (res: any) => void): NodejsHttpClientRequest;
+    request: (url: string, options: HttpClientRequestOptions, callback: (res: any) => void) => NodejsHttpClientRequest;
 }
 ```
 
@@ -287,23 +280,9 @@ Nodejs result of the Node.js https.request call limited to options needed by ts-
 
 ```ts
 export interface NodejsHttpClientRequest {
-    write(chunk: string): void;
-    end(): void;
-    on(event: string, callback: (data: any) => void): void;
-    end(): void;
-}
-```
-
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
-
----
-### Interface: Fetch
-
-fetch function interface limited to options needed by ts-sdk
-
-```ts
-export interface Fetch {
-    (url: string, options: FetchOptions): Promise<Response>;
+    write: (chunk: string) => void;
+    on: (event: string, callback: (data: any) => void) => void;
+    end: (() => void) & (() => void);
 }
 ```
 
@@ -723,7 +702,7 @@ Adapter for Node.js Https module to be used as HttpClient
 
 ```ts
 export class NodejsHttpClient implements HttpClient {
-    constructor(private https: HttpsNodejs) 
+    constructor(private readonly https: HttpsNodejs) 
     async request(url: string, requestOptions: HttpClientRequestOptions): Promise<HttpClientResponse> 
 }
 ```
@@ -737,7 +716,7 @@ Adapter for Node.js Https module to be used as HttpClient
 
 ```ts
 export class FetchHttpClient implements HttpClient {
-    constructor(private fetch: Fetch) 
+    constructor(private readonly fetch: Fetch) 
     async request<D>(url: string, options: HttpClientRequestOptions): Promise<HttpClientResponse<D>> 
 }
 ```
@@ -1397,6 +1376,15 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ---
 ## Types
 
+| |
+| --- |
+| [Fetch](#type-fetch) |
+| [HttpClientResponse](#type-httpclientresponse) |
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+
 ### Type: HttpClientResponse
 
 An interface for the response returned by the request method.
@@ -1417,6 +1405,19 @@ export type HttpClientResponse<T = any> = {
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+### Type: Fetch
+
+fetch function interface limited to options needed by ts-sdk
+
+Makes a request to the server.
+
+```ts
+export type Fetch = (url: string, options: FetchOptions) => Promise<Response>
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ## Variables
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.1.13",
+  "version": "1.1.15",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/compat/__tests/BSM.test.ts

@@ -6,44 +6,44 @@ import Signature from '../../../dist/cjs/src/primitives/Signature'
 import BigNumber from '../../../dist/cjs/src/primitives/BigNumber'
 
 describe('BSM', () => {
-    describe('magicHash', () => {
-        it('should return a hash', () => {
-            const buf = toArray('001122', 'hex')
-            const hashBuf = magicHash(buf)
-            expect(hashBuf.length).toEqual(32)
-        })
+  describe('magicHash', () => {
+    it('should return a hash', () => {
+      const buf = toArray('001122', 'hex')
+      const hashBuf = magicHash(buf)
+      expect(hashBuf.length).toEqual(32)
     })
-    describe('sign', () => {
-        const messageBuf = toArray('this is my message', 'utf8')
-        const privateKey = new PrivateKey(42)
-        it('should return a signature', () => {
-            const sig = sign(messageBuf, privateKey).toDER()
-            expect(sig.length).toEqual(70)
-        })
+  })
+  describe('sign', () => {
+    const messageBuf = toArray('this is my message', 'utf8')
+    const privateKey = new PrivateKey(42)
+    it('should return a signature', () => {
+      const sig = sign(messageBuf, privateKey).toDER()
+      expect(sig.length).toEqual(70)
     })
-    describe('verify', () => {
-        const messageBuf = toArray('this is my message', 'utf8')
-        const privateKey = new PrivateKey(42)
+  })
+  describe('verify', () => {
+    const messageBuf = toArray('this is my message', 'utf8')
+    const privateKey = new PrivateKey(42)
 
-        it('should verify a signed message', () => {
-            const sig = sign(messageBuf, privateKey)
-            expect(verify(messageBuf, sig, privateKey.toPublicKey())).toEqual(true)
-        })
-        it('Should verify a signed message in base64', () => {
-            const message = toArray("Texas", 'utf8')
-            const signature = Signature.fromCompact('IAV89EkfHSzAIA8cEWbbKHUYzJqcShkpWaXGJ5+mf4+YIlf3XNlr0bj9X60sNe1A7+x9qyk+zmXropMDY4370n8=', 'base64')
-            const publicKey = PublicKey.fromString('03d4d1a6c5d8c03b0e671bc1891b69afaecb40c0686188fe9019f93581b43e8334')
-            expect(verify(message, signature, publicKey)).toBe(true)
-        })
-        it('Should be able to calculate the recovery number for a signature and public key', () => {
-            const message = toArray("Texas", 'utf8')
-            const signature = Signature.fromCompact('IAV89EkfHSzAIA8cEWbbKHUYzJqcShkpWaXGJ5+mf4+YIlf3XNlr0bj9X60sNe1A7+x9qyk+zmXropMDY4370n8=', 'base64')
-            const publicKey = PublicKey.fromString('03d4d1a6c5d8c03b0e671bc1891b69afaecb40c0686188fe9019f93581b43e8334')
-            const msgHash = new BigNumber(magicHash(message))
-            const recovery = signature.CalculateRecoveryFactor(publicKey, msgHash)
-            expect(recovery).toBe(1)
-            const recoveredPubkey = signature.RecoverPublicKey(recovery, msgHash) as PublicKey
-            expect(recoveredPubkey.toDER()).toEqual(publicKey.toDER())
-        })
+    it('should verify a signed message', () => {
+      const sig = sign(messageBuf, privateKey)
+      expect(verify(messageBuf, sig, privateKey.toPublicKey())).toEqual(true)
     })
-})
+    it('Should verify a signed message in base64', () => {
+      const message = toArray('Texas', 'utf8')
+      const signature = Signature.fromCompact('IAV89EkfHSzAIA8cEWbbKHUYzJqcShkpWaXGJ5+mf4+YIlf3XNlr0bj9X60sNe1A7+x9qyk+zmXropMDY4370n8=', 'base64')
+      const publicKey = PublicKey.fromString('03d4d1a6c5d8c03b0e671bc1891b69afaecb40c0686188fe9019f93581b43e8334')
+      expect(verify(message, signature, publicKey)).toBe(true)
+    })
+    it('Should be able to calculate the recovery number for a signature and public key', () => {
+      const message = toArray('Texas', 'utf8')
+      const signature = Signature.fromCompact('IAV89EkfHSzAIA8cEWbbKHUYzJqcShkpWaXGJ5+mf4+YIlf3XNlr0bj9X60sNe1A7+x9qyk+zmXropMDY4370n8=', 'base64')
+      const publicKey = PublicKey.fromString('03d4d1a6c5d8c03b0e671bc1891b69afaecb40c0686188fe9019f93581b43e8334')
+      const msgHash = new BigNumber(magicHash(message))
+      const recovery = signature.CalculateRecoveryFactor(publicKey, msgHash)
+      expect(recovery).toBe(1)
+      const recoveredPubkey = signature.RecoverPublicKey(recovery, msgHash) as PublicKey
+      expect(recoveredPubkey.toDER()).toEqual(publicKey.toDER())
+    })
+  })
+})

package/src/compat/__tests/ECIES.test.ts

@@ -4,87 +4,87 @@ import PrivateKey from '../../../dist/cjs/src/primitives/PrivateKey'
 import { toArray, toHex, encode, toBase64 } from '../../../dist/cjs/src/primitives/utils'
 
 describe('#ECIES', () => {
-    it('should make a new ECIES object', () => {
-        expect(ECIES).toBeDefined()
-    })
+  it('should make a new ECIES object', () => {
+    expect(ECIES).toBeDefined()
+  })
 
-    const fromkey = new PrivateKey(42)
-    const tokey = new PrivateKey(88)
-    const messageBuf = Hash.sha256(toArray('my message is the hash of this string', 'utf8'))
+  const fromkey = new PrivateKey(42)
+  const tokey = new PrivateKey(88)
+  const messageBuf = Hash.sha256(toArray('my message is the hash of this string', 'utf8'))
 
-    describe('@bitcoreEncrypt', () => {
-        it('should return a buffer', () => {
-            const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey(), fromkey)
-            expect(Array.isArray(encBuf)).toEqual(true)
-        })
+  describe('@bitcoreEncrypt', () => {
+    it('should return a buffer', () => {
+      const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey(), fromkey)
+      expect(Array.isArray(encBuf)).toEqual(true)
+    })
 
-        it('should return a buffer if fromkey is not present', () => {
-            const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey())
-            expect(Array.isArray(encBuf)).toEqual(true)
-        })
+    it('should return a buffer if fromkey is not present', () => {
+      const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey())
+      expect(Array.isArray(encBuf)).toEqual(true)
     })
+  })
 
-    describe('@bitcoreDecrypt', () => {
-        it('should decrypt that which was encrypted', () => {
-            const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey(), fromkey)
-            const messageBuf2 = ECIES.bitcoreDecrypt(encBuf, tokey)
-            expect(toHex(messageBuf2)).toEqual(toHex(messageBuf))
-        })
+  describe('@bitcoreDecrypt', () => {
+    it('should decrypt that which was encrypted', () => {
+      const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey(), fromkey)
+      const messageBuf2 = ECIES.bitcoreDecrypt(encBuf, tokey)
+      expect(toHex(messageBuf2)).toEqual(toHex(messageBuf))
+    })
 
-        it('should decrypt that which was encrypted if fromPrivateKey was randomly generated', () => {
-            const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey())
-            const messageBuf2 = ECIES.bitcoreDecrypt(encBuf, tokey)
-            expect(messageBuf2).toEqual(messageBuf)
-        })
+    it('should decrypt that which was encrypted if fromPrivateKey was randomly generated', () => {
+      const encBuf = ECIES.bitcoreEncrypt(messageBuf, tokey.toPublicKey())
+      const messageBuf2 = ECIES.bitcoreDecrypt(encBuf, tokey)
+      expect(messageBuf2).toEqual(messageBuf)
     })
+  })
 
-    describe('Electrum ECIES', () => {
-        // const alicePrivateKey = PrivateKey.fromString('L1Ejc5dAigm5XrM3mNptMEsNnHzS7s51YxU7J61ewGshZTKkbmzJ')
-        // const bobPrivateKey = PrivateKey.fromString('KxfxrUXSMjJQcb3JgnaaA6MqsrKQ1nBSxvhuigdKRyFiEm6BZDgG')
-        const alicePrivateKey = PrivateKey.fromString('77e06abc52bf065cb5164c5deca839d0276911991a2730be4d8d0a0307de7ceb', 16)
-        const bobPrivateKey = PrivateKey.fromString('2b57c7c5e408ce927eef5e2efb49cfdadde77961d342daa72284bb3d6590862d', 16)
+  describe('Electrum ECIES', () => {
+    // const alicePrivateKey = PrivateKey.fromString('L1Ejc5dAigm5XrM3mNptMEsNnHzS7s51YxU7J61ewGshZTKkbmzJ')
+    // const bobPrivateKey = PrivateKey.fromString('KxfxrUXSMjJQcb3JgnaaA6MqsrKQ1nBSxvhuigdKRyFiEm6BZDgG')
+    const alicePrivateKey = PrivateKey.fromString('77e06abc52bf065cb5164c5deca839d0276911991a2730be4d8d0a0307de7ceb', 16)
+    const bobPrivateKey = PrivateKey.fromString('2b57c7c5e408ce927eef5e2efb49cfdadde77961d342daa72284bb3d6590862d', 16)
 
-        it('should do these test vectors correctly', () => {
-            const message = toArray('this is my test message', 'utf8')
+    it('should do these test vectors correctly', () => {
+      const message = toArray('this is my test message', 'utf8')
 
-            expect(ECIES.electrumDecrypt(
-                toArray(
-                    'QklFMQOGFyMXLo9Qv047K3BYJhmnJgt58EC8skYP/R2QU/U0yXXHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbiaH4FsxKIOOvzolIFVAS0FplUmib2HnlAM1yP/iiPsU=',
-                    'base64'
-                ),
-                alicePrivateKey
-            ))
-                .toEqual(message)
-            expect(ECIES.electrumDecrypt(
-                toArray(
-                    'QklFMQM55QTWSSsILaluEejwOXlrBs1IVcEB4kkqbxDz4Fap53XHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbvZJHgyAzxA6SoujduvJXv+A9ri3po9veilrmc8p6dwo=',
-                    'base64'
-                ),
-                bobPrivateKey
-            ))
-                .toEqual(message)
+      expect(ECIES.electrumDecrypt(
+        toArray(
+          'QklFMQOGFyMXLo9Qv047K3BYJhmnJgt58EC8skYP/R2QU/U0yXXHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbiaH4FsxKIOOvzolIFVAS0FplUmib2HnlAM1yP/iiPsU=',
+          'base64'
+        ),
+        alicePrivateKey
+      ))
+        .toEqual(message)
+      expect(ECIES.electrumDecrypt(
+        toArray(
+          'QklFMQM55QTWSSsILaluEejwOXlrBs1IVcEB4kkqbxDz4Fap53XHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbvZJHgyAzxA6SoujduvJXv+A9ri3po9veilrmc8p6dwo=',
+          'base64'
+        ),
+        bobPrivateKey
+      ))
+        .toEqual(message)
 
-            expect(toBase64(
-                ECIES.electrumEncrypt(message, bobPrivateKey.toPublicKey(), alicePrivateKey)
-            ))
-                .toEqual(
-                    'QklFMQM55QTWSSsILaluEejwOXlrBs1IVcEB4kkqbxDz4Fap53XHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbvZJHgyAzxA6SoujduvJXv+A9ri3po9veilrmc8p6dwo='
-                )
-            expect(toBase64(ECIES.electrumEncrypt(message, alicePrivateKey.toPublicKey(), bobPrivateKey)))
-                .toEqual(
-                    'QklFMQOGFyMXLo9Qv047K3BYJhmnJgt58EC8skYP/R2QU/U0yXXHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbiaH4FsxKIOOvzolIFVAS0FplUmib2HnlAM1yP/iiPsU='
-                )
-        })
+      expect(toBase64(
+        ECIES.electrumEncrypt(message, bobPrivateKey.toPublicKey(), alicePrivateKey)
+      ))
+        .toEqual(
+          'QklFMQM55QTWSSsILaluEejwOXlrBs1IVcEB4kkqbxDz4Fap53XHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbvZJHgyAzxA6SoujduvJXv+A9ri3po9veilrmc8p6dwo='
+        )
+      expect(toBase64(ECIES.electrumEncrypt(message, alicePrivateKey.toPublicKey(), bobPrivateKey)))
+        .toEqual(
+          'QklFMQOGFyMXLo9Qv047K3BYJhmnJgt58EC8skYP/R2QU/U0yXXHOt6L3tKmrXho6yj6phfoiMkBOhUldRPnEI4fSZXbiaH4FsxKIOOvzolIFVAS0FplUmib2HnlAM1yP/iiPsU='
+        )
+    })
 
-        it('should encrypt and decrypt symmetrically with matching strings in ECDH noKey mode', () => {
-            const message = toArray('this is my ECDH test message', 'utf8')
-            const ecdhMessageEncryptedBob = ECIES.electrumEncrypt(message, bobPrivateKey.toPublicKey(), alicePrivateKey, true)
-            const ecdhMessageEncryptedAlice = ECIES.electrumEncrypt(message, alicePrivateKey.toPublicKey(), bobPrivateKey, true)
-            expect(ecdhMessageEncryptedBob).toEqual(ecdhMessageEncryptedAlice)
-            expect(ECIES.electrumDecrypt(ecdhMessageEncryptedAlice, bobPrivateKey, alicePrivateKey.toPublicKey()))
-                .toEqual(toArray('this is my ECDH test message', 'utf8'))
-            expect(ECIES.electrumDecrypt(ecdhMessageEncryptedBob, alicePrivateKey, bobPrivateKey.toPublicKey()))
-                .toEqual(toArray('this is my ECDH test message', 'utf8'))
-        })
+    it('should encrypt and decrypt symmetrically with matching strings in ECDH noKey mode', () => {
+      const message = toArray('this is my ECDH test message', 'utf8')
+      const ecdhMessageEncryptedBob = ECIES.electrumEncrypt(message, bobPrivateKey.toPublicKey(), alicePrivateKey, true)
+      const ecdhMessageEncryptedAlice = ECIES.electrumEncrypt(message, alicePrivateKey.toPublicKey(), bobPrivateKey, true)
+      expect(ecdhMessageEncryptedBob).toEqual(ecdhMessageEncryptedAlice)
+      expect(ECIES.electrumDecrypt(ecdhMessageEncryptedAlice, bobPrivateKey, alicePrivateKey.toPublicKey()))
+        .toEqual(toArray('this is my ECDH test message', 'utf8'))
+      expect(ECIES.electrumDecrypt(ecdhMessageEncryptedBob, alicePrivateKey, bobPrivateKey.toPublicKey()))
+        .toEqual(toArray('this is my ECDH test message', 'utf8'))
     })
-})
+  })
+})