@bsv/sdk 1.2.10 → 1.2.12

package/docs/README.md

@@ -6,4 +6,13 @@ The documentation is split into various pages, each covering a set of related fu
 - [Script](./script.md) — Covers Bitcoin scripts, the templating system, serialization, and the Spend class (script interpreter)
 - [Transaction](./transaction.md) — Covers transaction construction, signing, broadcasters, fee models, merkle proofs, and SPV structures like BUMP
 - [Messages](./messages.md) — Covers generalizable message signing, verification, encryption and decryption
+- [TOTP](./totp.md) - Covers Time-based One Time Password, useful for validating counterparties across unsecured mediums.
+- [Wallet](./wallet-substrates.md) - Covers the Wallet Substrates for communication between applications and wallets using a standard interface.
+- [Overlay Tools](./overlay-tools.md) - Covers the use of Overlays for broadcast of transactions based on topics, as well as distributed lookup of tokens.
 - [Compat](./compat.md) — Covers deprecated functionality for legacy systems like BIP32 and ECIES
+
+## Swagger
+
+[BRC-100](https://brc.dev/100) defines a Unified, Vendor-Neutral, Unchanging, and Open BSV Blockchain Standard Wallet-to-Application Interface which is implemented in this library within the WalletClient class. The API is laid out here as a swagger openapi document to offer a fast-track to understanding the interface which is implemented across multiple substrates. The JSON api is generally considered a developer friendly introduction to the WalletClient, where an binary equivalent ABI may be preferred for production use cases.
+
+- [Wallet JSON API Swagger](./swagger)

package/docs/primitives.md

@@ -5254,7 +5254,8 @@ create a corresponding public key and derive a shared secret from a public key.
 ```ts
 export default class PrivateKey extends BigNumber {
     static fromRandom(): PrivateKey 
-    static fromString(str: string, base: number | "hex"): PrivateKey 
+    static fromString(str: string, base: number | "hex" = "hex"): PrivateKey 
+    static fromHex(str: string): PrivateKey 
     static fromWif(wif: string, prefixLength: number = 1): PrivateKey 
     constructor(number: BigNumber | number | string | number[] = 0, base: number | "be" | "le" | "hex" = 10, endian: "be" | "le" = "be", modN: "apply" | "nocheck" | "error" = "apply") 
     checkInField(): {
@@ -5267,6 +5268,8 @@ export default class PrivateKey extends BigNumber {
     toPublicKey(): PublicKey 
     toWif(prefix: number[] = [128]): string 
     toAddress(prefix: number[] | string = [0]): string 
+    toHex(): string 
+    toString(base: number | "hex" = "hex", padding: number = 64): string 
     deriveSharedSecret(key: PublicKey): Point 
     deriveChild(publicKey: PublicKey, invoiceNumber: string): PrivateKey 
     toKeyShares(threshold: number, totalShares: number): KeyShares 
@@ -5276,7 +5279,7 @@ export default class PrivateKey extends BigNumber {
 }
 ```
 
-See also: [BigNumber](#class-bignumber), [KeyShares](#class-keyshares), [Point](#class-point), [PublicKey](#class-publickey), [Signature](#class-signature), [sign](#variable-sign), [verify](#variable-verify)
+See also: [BigNumber](#class-bignumber), [KeyShares](#class-keyshares), [Point](#class-point), [PublicKey](#class-publickey), [Signature](#class-signature), [sign](#variable-sign), [toHex](#variable-tohex), [verify](#variable-verify)
 
 <details>
 
@@ -5394,6 +5397,28 @@ const share2 = 'Cm5fuUc39X5xgdedao8Pr1kvCSm8Gk7Cfenc7xUKcfLX.2juyK9BxCWn2DiY5JUA
 const recoveredKey = PrivateKey.fromBackupShares([share1, share2])
 ```
 
+#### Method fromHex
+
+Generates a private key from a hexadecimal string.
+
+```ts
+static fromHex(str: string): PrivateKey 
+```
+See also: [PrivateKey](#class-privatekey)
+
+Returns
+
+The generated Private Key instance.
+
+Argument Details
+
++ **str**
+  + The hexadecimal string representing the private key. The string must represent a valid private key in big-endian format.
+
+Throws
+
+If the string is not a valid hexadecimal or represents an invalid private key.
+
 #### Method fromKeyShares
 
 Combines shares to reconstruct the private key.
@@ -5438,7 +5463,7 @@ const privateKey = PrivateKey.fromRandom();
 Generates a private key from a string.
 
 ```ts
-static fromString(str: string, base: number | "hex"): PrivateKey 
+static fromString(str: string, base: number | "hex" = "hex"): PrivateKey 
 ```
 See also: [PrivateKey](#class-privatekey)
 
@@ -5562,6 +5587,30 @@ Argument Details
 + **totalShares**
   + The number of shares to generate for distribution.
 
+#### Method toHex
+
+Converts this PrivateKey to a hexadecimal string.
+
+```ts
+toHex(): string 
+```
+
+Returns
+
+Returns a string representing the hexadecimal value of this BigNumber.
+
+Argument Details
+
++ **length**
+  + The minimum length of the hex string
+
+Example
+
+```ts
+const bigNumber = new BigNumber(255);
+const hex = bigNumber.toHex();
+```
+
 #### Method toKeyShares
 
 Splits the private key into shares using Shamir's Secret Sharing Scheme.
@@ -5613,6 +5662,27 @@ const privateKey = PrivateKey.fromRandom();
 const publicKey = privateKey.toPublicKey();
 ```
 
+#### Method toString
+
+function toString() { [native code] }
+
+Converts this PrivateKey to a string representation.
+
+```ts
+toString(base: number | "hex" = "hex", padding: number = 64): string 
+```
+
+Returns
+
+A string representation of the PrivateKey in the specified base, padded to the specified length.
+
+Argument Details
+
++ **base**
+  + The base for representing the number. Default is hexadecimal ('hex').
++ **padding**
+  + The minimum number of digits for the output string. Default is 64, ensuring a 256-bit representation in hexadecimal.
+
 #### Method toWif
 
 Converts the private key to a Wallet Import Format (WIF) string.

package/docs/swagger/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Peter Evans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/docs/swagger/dist/index.css

@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}

package/docs/swagger/dist/oauth2-redirect.html

@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1).replace('?', '&');
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>

package/docs/swagger/dist/swagger-initializer.js

@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "swagger.yaml",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};