@bsv/sdk 1.6.8 → 1.6.10

package/src/wallet/substrates/__tests/toOriginHeader.test.ts

@@ -0,0 +1,34 @@
+import { toOriginHeader } from "../utils/toOriginHeader"
+
+afterEach(() => jest.resetAllMocks())
+
+type FetchMockCall = Parameters<typeof fetch> // alias for readability
+
+function okJson(body: unknown = {}) {
+  return Promise.resolve({
+    ok: true,
+    status: 200,
+    json: () => Promise.resolve(body),
+  } as Response)
+}
+
+describe("toOriginHeader()", () => {
+  const vectors: Array<[originator: string, baseUrl: string, expected: string | undefined]> = [
+    /* originator,                     baseUrl,                      expected */
+    ["localhost", "http://localhost:3321", "http://localhost"],
+    ["localhost:3000", "http://localhost:3321", "http://localhost:3000"],
+    ["example.com", "https://api.example.com", "https://example.com"],
+    ["https://example.com:8443", "http://localhost:3321", "https://example.com:8443"],
+    // ["metanet://somehost", "http://localhost:3321", "metanet://somehost"], // TODO: Consider adding support in the future
+  ]
+
+  it.each(vectors)("originator=%p, baseUrl=%p → %p", (originator, baseUrl, expected) => {
+    const schemeFromBase = new URL(baseUrl).protocol.replace(":", "")
+    const result = toOriginHeader(originator, schemeFromBase)
+    expect(result).toBe(expected)
+  })
+
+  it("throws on clearly malformed input", () => {
+    expect(() => toOriginHeader("bad url^%", "http")).toThrow()
+  })
+})

package/src/wallet/substrates/utils/toOriginHeader.ts

@@ -0,0 +1,15 @@
+export function toOriginHeader(originator: string, fallbackScheme = 'http'): string | undefined {
+  // If the caller already gave us a scheme, assume it’s fine
+  if (/^[a-z][a-z0-9+.-]*:\/\//i.test(originator)) {
+    try {
+      return new URL(originator).origin       // trims any path/query
+    } catch { /* fall through to fix-up */ }
+  }
+
+  // Otherwise, prepend the fallback scheme and validate
+  try {
+    return new URL(`${fallbackScheme}://${originator}`).origin
+  } catch {
+    throw new Error(`Invalid originator value: ${originator}`)
+  }
+}

package/docs/README.md

@@ -1,21 +0,0 @@
-# TypeScript Library API Documentation
-
-The documentation is split into various pages, each covering a set of related functionality. The pages are as follows:
-
-- [Primitives](./primitives.md) — Covers public and private keys, key derivation, digital signaturs, symmetric keys, and low-level operations
-- [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.md) - Covers the Wallet interface for communication between applications and wallets using a standard interface.
-- [Wallet Substrates](./wallet-substrates.md) - Covers the Wallet Substrates which facilitate communication between apps and wallets.
-- [Overlay Tools](./overlay-tools.md) - Covers the use of Overlays for broadcast of transactions based on topics, as well as distributed lookup of tokens.
-- [Auth](./auth.md) - Mutual Authentication and Service Monetization Framework
-- [Storage](./storage.md) — Covers a UHRP client for storing and retrieving data from distributed data storage services by hash.
-- [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)