@bsv/sdk 1.3.35 → 1.4.0

package/docs/primitives.md

@@ -7885,7 +7885,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ### Variable: fromBase58Check
 
 ```ts
-fromBase58Check = (str: string, enc?: "hex", prefixLength: number = 1): any => {
+fromBase58Check = (str: string, enc?: "hex", prefixLength: number = 1): {
+    data: number[] | string;
+    prefix: number[] | string;
+} => {
     const bin = fromBase58(str);
     let prefix: string | number[] = bin.slice(0, prefixLength);
     let data: string | number[] = bin.slice(prefixLength, -4);

package/docs/storage.md

@@ -0,0 +1,210 @@
+# API
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+## Interfaces
+
+| |
+| --- |
+| [UploadFileResult](#interface-uploadfileresult) |
+| [UploadableFile](#interface-uploadablefile) |
+| [UploaderConfig](#interface-uploaderconfig) |
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+
+### Interface: UploadFileResult
+
+```ts
+export interface UploadFileResult {
+    published: boolean;
+    uhrpURL: string;
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Interface: UploadableFile
+
+```ts
+export interface UploadableFile {
+    data: number[];
+    type: string;
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Interface: UploaderConfig
+
+```ts
+export interface UploaderConfig {
+    storageURL: string;
+    wallet: WalletInterface;
+}
+```
+
+See also: [WalletInterface](./wallet.md#interface-walletinterface)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+## Classes
+
+### Class: StorageUploader
+
+```ts
+export class StorageUploader {
+    constructor(config: UploaderConfig) 
+    public async publishFile(params: {
+        file: UploadableFile;
+        retentionPeriod: number;
+    }): Promise<UploadFileResult> 
+}
+```
+
+See also: [UploadFileResult](./storage.md#interface-uploadfileresult), [UploadableFile](./storage.md#interface-uploadablefile), [UploaderConfig](./storage.md#interface-uploaderconfig)
+
+#### Method publishFile
+
+Publishes a file to the storage server with the specified retention period.
+
+This will:
+1. Request an upload URL from the server.
+2. Perform an HTTP PUT to upload the file’s raw bytes.
+3. Return a UHRP URL referencing the file once published.
+
+```ts
+public async publishFile(params: {
+    file: UploadableFile;
+    retentionPeriod: number;
+}): Promise<UploadFileResult> 
+```
+See also: [UploadFileResult](./storage.md#interface-uploadfileresult), [UploadableFile](./storage.md#interface-uploadablefile)
+
+Returns
+
+An object indicating whether the file was published successfully and the resulting UHRP URL.
+
+Argument Details
+
++ **params.file**
+  + An object describing the file’s data (number[] array of bytes) and mime type.
++ **params.retentionPeriod**
+  + Number of minutes to keep the file hosted.
+
+Throws
+
+If either the upload info request or the subsequent file upload request fails (non-OK HTTP status).
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+## Functions
+
+## Types
+
+## Enums
+
+## Variables
+
+| |
+| --- |
+| [getHashFromURL](#variable-gethashfromurl) |
+| [getURLForFile](#variable-geturlforfile) |
+| [getURLForHash](#variable-geturlforhash) |
+| [isValidURL](#variable-isvalidurl) |
+| [normalizeURL](#variable-normalizeurl) |
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+
+### Variable: getHashFromURL
+
+```ts
+getHashFromURL = (URL: string): number[] => {
+    URL = normalizeURL(URL);
+    const { data, prefix } = fromBase58Check(URL, undefined, 2);
+    if (data.length !== 32) {
+        throw new Error("Invalid length!");
+    }
+    if (toHex(prefix as number[]) !== "ce00") {
+        throw new Error("Bad prefix");
+    }
+    return data as number[];
+}
+```
+
+See also: [fromBase58Check](./primitives.md#variable-frombase58check), [normalizeURL](./storage.md#variable-normalizeurl), [toHex](./primitives.md#variable-tohex)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Variable: getURLForFile
+
+```ts
+getURLForFile = (file: number[]): string => {
+    const hash = sha256(file);
+    return getURLForHash(hash);
+}
+```
+
+See also: [getURLForHash](./storage.md#variable-geturlforhash), [sha256](./primitives.md#variable-sha256)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Variable: getURLForHash
+
+```ts
+getURLForHash = (hash: number[]): string => {
+    if (hash.length !== 32) {
+        throw new Error("Hash length must be 32 bytes (sha256)");
+    }
+    return toBase58Check(hash, toArray("ce00", "hex"));
+}
+```
+
+See also: [toArray](./primitives.md#variable-toarray), [toBase58Check](./primitives.md#variable-tobase58check)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Variable: isValidURL
+
+```ts
+isValidURL = (URL: string): boolean => {
+    try {
+        getHashFromURL(URL);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+}
+```
+
+See also: [getHashFromURL](./storage.md#variable-gethashfromurl)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Variable: normalizeURL
+
+```ts
+normalizeURL = (URL: string): string => {
+    if (URL.toLowerCase().startsWith("uhrp:"))
+        URL = URL.slice(5);
+    if (URL.startsWith("//"))
+        URL = URL.slice(2);
+    return URL;
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---

package/docs/wallet-substrates.md

@@ -21,7 +21,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | |
 | --- |
-| [HTTPWalletJSON](#class-httpwalletjson) |
 | [HTTPWalletWire](#class-httpwalletwire) |
 | [WalletWireProcessor](#class-walletwireprocessor) |
 | [WalletWireTransceiver](#class-walletwiretransceiver) |
@@ -32,230 +31,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ---
 
-### Class: HTTPWalletJSON
-
-```ts
-export default class HTTPWalletJSON implements WalletInterface {
-    baseUrl: string;
-    httpClient: typeof fetch;
-    originator: OriginatorDomainNameStringUnder250Bytes | undefined;
-    api: (call: string, args: object) => Promise<unknown>;
-    constructor(originator: OriginatorDomainNameStringUnder250Bytes | undefined, baseUrl: string = "http://localhost:3321", httpClient = fetch) 
-    async createAction(args: CreateActionArgs): Promise<CreateActionResult> 
-    async signAction(args: SignActionArgs): Promise<SignActionResult> 
-    async abortAction(args: {
-        reference: Base64String;
-    }): Promise<{
-        aborted: true;
-    }> 
-    async listActions(args: ListActionsArgs): Promise<ListActionsResult> 
-    async internalizeAction(args: InternalizeActionArgs): Promise<{
-        accepted: true;
-    }> 
-    async listOutputs(args: ListOutputsArgs): Promise<ListOutputsResult> 
-    async relinquishOutput(args: {
-        basket: BasketStringUnder300Bytes;
-        output: OutpointString;
-    }): Promise<{
-        relinquished: true;
-    }> 
-    async getPublicKey(args: {
-        seekPermission?: BooleanDefaultTrue;
-        identityKey?: true;
-        protocolID?: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID?: KeyIDStringUnder800Bytes;
-        privileged?: BooleanDefaultFalse;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        forSelf?: BooleanDefaultFalse;
-    }): Promise<{
-        publicKey: PubKeyHex;
-    }> 
-    async revealCounterpartyKeyLinkage(args: {
-        counterparty: PubKeyHex;
-        verifier: PubKeyHex;
-        privilegedReason?: DescriptionString5to50Bytes;
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        prover: PubKeyHex;
-        verifier: PubKeyHex;
-        counterparty: PubKeyHex;
-        revelationTime: ISOTimestampString;
-        encryptedLinkage: Byte[];
-        encryptedLinkageProof: number[];
-    }> 
-    async revealSpecificKeyLinkage(args: {
-        counterparty: PubKeyHex;
-        verifier: PubKeyHex;
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        prover: PubKeyHex;
-        verifier: PubKeyHex;
-        counterparty: PubKeyHex;
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        encryptedLinkage: Byte[];
-        encryptedLinkageProof: Byte[];
-        proofType: Byte;
-    }> 
-    async encrypt(args: {
-        seekPermission?: BooleanDefaultTrue;
-        plaintext: Byte[];
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        ciphertext: Byte[];
-    }> 
-    async decrypt(args: {
-        seekPermission?: BooleanDefaultTrue;
-        ciphertext: Byte[];
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        plaintext: Byte[];
-    }> 
-    async createHmac(args: {
-        seekPermission?: BooleanDefaultTrue;
-        data: Byte[];
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        hmac: Byte[];
-    }> 
-    async verifyHmac(args: {
-        seekPermission?: BooleanDefaultTrue;
-        data: Byte[];
-        hmac: Byte[];
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        valid: true;
-    }> 
-    async createSignature(args: {
-        seekPermission?: BooleanDefaultTrue;
-        data?: Byte[];
-        hashToDirectlySign?: Byte[];
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        signature: Byte[];
-    }> 
-    async verifySignature(args: {
-        seekPermission?: BooleanDefaultTrue;
-        data?: Byte[];
-        hashToDirectlyVerify?: Byte[];
-        signature: Byte[];
-        protocolID: [
-            SecurityLevel,
-            ProtocolString5To400Bytes
-        ];
-        keyID: KeyIDStringUnder800Bytes;
-        privilegedReason?: DescriptionString5to50Bytes;
-        counterparty?: PubKeyHex | "self" | "anyone";
-        forSelf?: BooleanDefaultFalse;
-        privileged?: BooleanDefaultFalse;
-    }): Promise<{
-        valid: true;
-    }> 
-    async acquireCertificate(args: AcquireCertificateArgs): Promise<AcquireCertificateResult> 
-    async listCertificates(args: {
-        certifiers: PubKeyHex[];
-        types: Base64String[];
-        limit?: PositiveIntegerDefault10Max10000;
-        offset?: PositiveIntegerOrZero;
-        privileged?: BooleanDefaultFalse;
-        privilegedReason?: DescriptionString5to50Bytes;
-    }): Promise<ListCertificatesResult> 
-    async proveCertificate(args: ProveCertificateArgs): Promise<ProveCertificateResult> 
-    async relinquishCertificate(args: {
-        type: Base64String;
-        serialNumber: Base64String;
-        certifier: PubKeyHex;
-    }): Promise<{
-        relinquished: true;
-    }> 
-    async discoverByIdentityKey(args: {
-        seekPermission?: BooleanDefaultTrue;
-        identityKey: PubKeyHex;
-        limit?: PositiveIntegerDefault10Max10000;
-        offset?: PositiveIntegerOrZero;
-    }): Promise<DiscoverCertificatesResult> 
-    async discoverByAttributes(args: {
-        seekPermission?: BooleanDefaultTrue;
-        attributes: Record<CertificateFieldNameUnder50Bytes, string>;
-        limit?: PositiveIntegerDefault10Max10000;
-        offset?: PositiveIntegerOrZero;
-    }): Promise<DiscoverCertificatesResult> 
-    async isAuthenticated(args: object): Promise<{
-        authenticated: true;
-    }> 
-    async waitForAuthentication(args: object): Promise<{
-        authenticated: true;
-    }> 
-    async getHeight(args: object): Promise<{
-        height: PositiveInteger;
-    }> 
-    async getHeaderForHeight(args: {
-        height: PositiveInteger;
-    }): Promise<{
-        header: HexString;
-    }> 
-    async getNetwork(args: object): Promise<{
-        network: "mainnet" | "testnet";
-    }> 
-    async getVersion(args: object): Promise<{
-        version: VersionString7To30Bytes;
-    }> 
-}
-```
-
-See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
-
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
-
----
 ### Class: HTTPWalletWire
 
 ```ts

package/mod.ts

@@ -13,3 +13,4 @@ export * from './src/wallet/index.js'
 export * from './src/wallet/substrates/index.js'
 export * from './src/auth/index.js'
 export * from './src/overlay-tools/index.js'
+export * from './src/storage/index.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.3.35",
+  "version": "1.4.0",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",
@@ -184,6 +184,16 @@
       "require": "./dist/cjs/src/overlay-tools/*.js",
       "types": "./dist/types/src/overlay-tools/*.d.ts"
     },
+    "./storage": {
+      "import": "./dist/esm/src/storage/index.js",
+      "require": "./dist/cjs/src/storage/index.js",
+      "types": "./dist/types/src/storage/index.d.ts"
+    },
+    "./storage/*": {
+      "import": "./dist/esm/src/storage/*.js",
+      "require": "./dist/cjs/src/storage/*.js",
+      "types": "./dist/types/src/storage/*.d.ts"
+    },
     "./umd": {
       "import": "./dist/umd/bundle.js"
     }
@@ -244,4 +254,4 @@
       "src/auth/transports/SimplifiedFetchTransport.ts"
     ]
   }
-}
+}

package/src/auth/Peer.ts

@@ -12,7 +12,9 @@ import {
   Transport
 } from './types.js'
 import { VerifiableCertificate } from './certificates/VerifiableCertificate.js'
-import { Random, Utils, WalletInterface } from '../../mod.js'
+import Random from '../primitives/Random.js'
+import * as Utils from '../primitives/utils.js'
+import { WalletInterface } from '../wallet/Wallet.interfaces.js'
 
 const AUTH_VERSION = '0.1'
 
@@ -82,7 +84,9 @@ export class Peer {
       certifiers: [],
       types: {}
     }
-    this.transport.onData(this.handleIncomingMessage.bind(this)).catch(console.error)
+    this.transport.onData(this.handleIncomingMessage.bind(this)).catch(e => {
+      throw e
+    })
     this.sessionManager =
       sessionManager != null ? sessionManager : new SessionManager()
     if (autoPersistLastSession === false) {
@@ -424,10 +428,9 @@ export class Peer {
    */
   private async handleIncomingMessage (message: AuthMessage): Promise<void> {
     if (typeof message.version !== 'string' || message.version !== AUTH_VERSION) {
-      console.error(
+      throw new Error(
         `Invalid or unsupported message auth version! Received: ${message.version}, expected: ${AUTH_VERSION}`
       )
-      return
     }
 
     switch (message.messageType) {
@@ -447,7 +450,7 @@ export class Peer {
         await this.processGeneralMessage(message)
         break
       default:
-        console.error(
+        throw new Error(
           `Unknown message type of ${String(message.messageType)} from ${String(
             message.identityKey
           )}`