@bsv/sdk 1.1.13 → 1.1.14

package/docs/primitives.md

@@ -6,20 +6,17 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ## Classes
 
-| | |
-| --- | --- |
-| [BasePoint](#class-basepoint) | [Reader](#class-reader) |
-| [BigNumber](#class-bignumber) | [ReductionContext](#class-reductioncontext) |
-| [Curve](#class-curve) | [SHA1](#class-sha1) |
-| [DRBG](#class-drbg) | [SHA1HMAC](#class-sha1hmac) |
-| [JacobianPoint](#class-jacobianpoint) | [SHA256](#class-sha256) |
-| [K256](#class-k256) | [SHA256HMAC](#class-sha256hmac) |
-| [Mersenne](#class-mersenne) | [SHA512](#class-sha512) |
-| [MontgomoryMethod](#class-montgomorymethod) | [SHA512HMAC](#class-sha512hmac) |
-| [Point](#class-point) | [Signature](#class-signature) |
-| [PrivateKey](#class-privatekey) | [SymmetricKey](#class-symmetrickey) |
-| [PublicKey](#class-publickey) | [TransactionSignature](#class-transactionsignature) |
-| [RIPEMD160](#class-ripemd160) | [Writer](#class-writer) |
+| | | |
+| --- | --- | --- |
+| [BasePoint](#class-basepoint) | [Point](#class-point) | [SHA1HMAC](#class-sha1hmac) |
+| [BigNumber](#class-bignumber) | [PointInFiniteField](#class-pointinfinitefield) | [SHA256](#class-sha256) |
+| [Curve](#class-curve) | [Polynomial](#class-polynomial) | [SHA256HMAC](#class-sha256hmac) |
+| [DRBG](#class-drbg) | [PrivateKey](#class-privatekey) | [SHA512](#class-sha512) |
+| [JacobianPoint](#class-jacobianpoint) | [PublicKey](#class-publickey) | [SHA512HMAC](#class-sha512hmac) |
+| [K256](#class-k256) | [RIPEMD160](#class-ripemd160) | [Signature](#class-signature) |
+| [KeyShares](#class-keyshares) | [Reader](#class-reader) | [SymmetricKey](#class-symmetrickey) |
+| [Mersenne](#class-mersenne) | [ReductionContext](#class-reductioncontext) | [TransactionSignature](#class-transactionsignature) |
+| [MontgomoryMethod](#class-montgomorymethod) | [SHA1](#class-sha1) | [Writer](#class-writer) |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
@@ -5349,6 +5346,7 @@ export default class Point extends BasePoint {
     x: BigNumber | null;
     y: BigNumber | null;
     inf: boolean;
+    static fromDER(bytes: number[]): Point 
     static fromString(str: string): Point 
     static fromX(x: BigNumber | number | number[] | string, odd: boolean): Point 
     static fromJSON(obj: string | any[], isRed: boolean): Point 
@@ -5562,6 +5560,38 @@ const p2 = new Point(5, 20);
 const areEqual = p1.eq(p2); // returns true
 ```
 
+#### Method fromDER
+
+Creates a point object from a given Array. These numbers can represent coordinates in hex format, or points
+in multiple established formats.
+The function verifies the integrity of the provided data and throws errors if inconsistencies are found.
+
+```ts
+static fromDER(bytes: number[]): Point 
+```
+
+Returns
+
+Returns a new point representing the given string.
+
+Argument Details
+
++ **bytes**
+  + The point representation number array.
+
+Throws
+
+`Error` If the point number[] value has a wrong length.
+
+`Error` If the point format is unknown.
+
+Example
+
+```ts
+const derPoint = [ 2, 18, 123, 108, 125, 83, 1, 251, 164, 214, 16, 119, 200, 216, 210, 193, 251, 193, 129, 67, 97, 146, 210, 216, 77, 254, 18, 6, 150, 190, 99, 198, 128 ];
+const point = Point.fromDER(derPoint);
+```
+
 #### Method fromJSON
 
 Generates a point from a serialized JSON object. The function accounts for different options in the JSON object,
@@ -6368,6 +6398,85 @@ const isVerified = signature.verify(msg, publicKey);
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+### Class: PointInFiniteField
+
+```ts
+export class PointInFiniteField {
+    x: BigNumber;
+    y: BigNumber;
+    constructor(x: BigNumber, y: BigNumber) 
+    toString(): string 
+    static fromString(str: string): PointInFiniteField 
+}
+```
+
+<details>
+
+<summary>Class PointInFiniteField Details</summary>
+
+#### Method toString
+
+function toString() { [native code] }
+
+```ts
+toString(): string 
+```
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+### Class: Polynomial
+
+Polynomial class
+
+This class is used to create a polynomial with a given threshold and a private key.
+The polynomial is used to create shares of the private key.
+
+Example
+
+```ts
+const key = new PrivateKey()
+const threshold = 2
+const polynomial = new Polynomial(key, threshold)
+```
+
+```ts
+export default class Polynomial {
+    readonly points: PointInFiniteField[];
+    readonly threshold: number;
+    constructor(points: PointInFiniteField[], threshold?: number) 
+    static fromPrivateKey(key: PrivateKey, threshold: number): Polynomial 
+    valueAt(x: BigNumber): BigNumber 
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+### Class: KeyShares
+
+Example
+
+```ts
+const key = PrivateKey.fromShares(shares)
+```
+
+```ts
+export class KeyShares {
+    points: PointInFiniteField[];
+    threshold: number;
+    integrity: string;
+    constructor(points: PointInFiniteField[], threshold: number, integrity: string) 
+    static fromBackupFormat(shares: string[]): KeyShares 
+    toBackupFormat() 
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ### Class: PrivateKey
 
@@ -6394,6 +6503,10 @@ export default class PrivateKey extends BigNumber {
     toAddress(prefix: number[] | string = [0]): string 
     deriveSharedSecret(key: PublicKey): Point 
     deriveChild(publicKey: PublicKey, invoiceNumber: string): PrivateKey 
+    toKeyShares(threshold: number, totalShares: number): KeyShares 
+    toBackupShares(threshold: number, totalShares: number): string[] 
+    static fromBackupShares(shares: string[]): PrivateKey 
+    static fromKeyShares(keyShares: KeyShares): PrivateKey 
 }
 ```
 
@@ -6489,6 +6602,43 @@ const publicKey = privateKey.toPublicKey();
 const sharedSecret = privateKey.deriveSharedSecret(publicKey);
 ```
 
+#### Method fromBackupShares
+
+```ts
+static fromBackupShares(shares: string[]): PrivateKey 
+```
+
+Returns
+
+PrivateKey
+
+#### Method fromKeyShares
+
+Combines shares to reconstruct the private key.
+
+```ts
+static fromKeyShares(keyShares: KeyShares): PrivateKey 
+```
+
+Returns
+
+The reconstructed private key.
+
+Argument Details
+
++ **shares**
+  + An array of points (shares) to be used to reconstruct the private key.
++ **threshold**
+  + The minimum number of shares required to reconstruct the private key.
+
+Example
+
+```ts
+const share1 = '2NWeap6SDBTL5jVnvk9yUxyfLqNrDs2Bw85KNDfLJwRT.4yLtSm327NApsbuP7QXVW3CWDuBRgmS6rRiFkAkTukic'
+const share2 = '7NbgGA8iAsxg2s6mBLkLFtGKQrnc4aCbooHJJV31cWs4.GUgXtudthawE3Eevc1waT3Atr1Ft7j1XxdUguVo3B7x3'
+const reconstructedKey = PrivateKey.fromKeyShares({ shares: [share1, share2], threshold: 2, integrity: '23409547' })
+```
+
 #### Method fromRandom
 
 Generates a private key randomly.
@@ -6620,6 +6770,47 @@ const testnetAddress = privkey.toAddress([0x6f])
 const testnetAddress = privkey.toAddress('testnet')
 ```
 
+#### Method toBackupShares
+
+```ts
+toBackupShares(threshold: number, totalShares: number): string[] 
+```
+
+Argument Details
+
++ **threshold**
+  + The number of shares which will be required to reconstruct the private key.
++ **totalShares**
+  + The number of shares to generate for distribution.
+
+#### Method toKeyShares
+
+Splits the private key into shares using Shamir's Secret Sharing Scheme.
+
+```ts
+toKeyShares(threshold: number, totalShares: number): KeyShares 
+```
+
+Returns
+
+An array of shares.
+
+Argument Details
+
++ **threshold**
+  + The minimum number of shares required to reconstruct the private key.
++ **totalShares**
+  + The total number of shares to generate.
++ **prime**
+  + The prime number to be used in Shamir's Secret Sharing Scheme.
+
+Example
+
+```ts
+const key = PrivateKey.fromRandom()
+const shares = key.toKeyShares(2, 5)
+```
+
 #### Method toPublicKey
 
 Converts the private key to its corresponding public key.
@@ -6716,10 +6907,11 @@ The class comes with static methods to generate PublicKey instances from private
 export default class PublicKey extends Point {
     static fromPrivateKey(key: PrivateKey): PublicKey 
     static fromString(str: string): PublicKey 
+    static fromDER(bytes: number[]): PublicKey 
     constructor(x: Point | BigNumber | number | number[] | string | null, y: BigNumber | number | number[] | string | null = null, isRed: boolean = true) 
     deriveSharedSecret(priv: PrivateKey): Point 
     verify(msg: number[] | string, sig: Signature, enc?: "hex" | "utf8"): boolean 
-    toDER(): string 
+    toDER(enc?: "hex" | undefined): string 
     toHash(enc?: "hex"): number[] | string 
     toAddress(prefix: number[] | string = [0]): string 
     deriveChild(privateKey: PrivateKey, invoiceNumber: string): PublicKey 
@@ -6801,6 +6993,29 @@ const myPrivKey = new PrivateKey(...)
 const sharedSecret = myPubKey.deriveSharedSecret(myPrivKey)
 ```
 
+#### Method fromDER
+
+Static factory method to create a PublicKey instance from a number array.
+
+```ts
+static fromDER(bytes: number[]): PublicKey 
+```
+
+Returns
+
+Returns the PublicKey created from the number array.
+
+Argument Details
+
++ **bytes**
+  + A number array representing a public key.
+
+Example
+
+```ts
+const myPubKey = PublicKey.fromString("03....")
+```
+
 #### Method fromMsgHashAndCompactSignature
 
 Takes an array of numbers or a string and returns a new PublicKey instance.
@@ -6913,7 +7128,7 @@ const testnetAddress = pubkey.toAddress('testnet')
 Encode the public key to DER (Distinguished Encoding Rules) format.
 
 ```ts
-toDER(): string 
+toDER(enc?: "hex" | undefined): string 
 ```
 
 Returns

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.14",
   "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())
+    })
+  })
+})