@siafoundation/sia-storage 0.1.6 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siafoundation/sia-storage",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -72,10 +72,10 @@
     "typescript": "5.9.3"
   },
   "optionalDependencies": {
-    "@siafoundation/sia-storage-darwin-arm64": "0.1.6",
-    "@siafoundation/sia-storage-darwin-x64": "0.1.6",
-    "@siafoundation/sia-storage-linux-x64-gnu": "0.1.6",
-    "@siafoundation/sia-storage-linux-arm64-gnu": "0.1.6",
-    "@siafoundation/sia-storage-win32-x64-msvc": "0.1.6"
+    "@siafoundation/sia-storage-darwin-arm64": "0.2.0",
+    "@siafoundation/sia-storage-darwin-x64": "0.2.0",
+    "@siafoundation/sia-storage-linux-x64-gnu": "0.2.0",
+    "@siafoundation/sia-storage-linux-arm64-gnu": "0.2.0",
+    "@siafoundation/sia-storage-win32-x64-msvc": "0.2.0"
   }
 }

package/wasm/sia_storage_wasm.d.ts

@@ -58,6 +58,40 @@ export interface PackedUploadOptions {
 }
 
 
+/**
+ * A signed request to create a pre-authorized key in indexd.
+ */
+export type SignedPreAuthorizedKeyRequest = {
+    publicKey: string;
+    signature: string;
+    connectKey: string;
+    expiration: string;
+    totalUses: number;
+    allowedAppID?: string;
+};
+
+/**
+ * An unsigned request to create a pre-authorized key in indexd.
+ */
+export interface PreAuthorizedKeyRequest {
+    /**
+     * The connect key used to authorize connections.
+     */
+    connectKey: string;
+    /**
+     * When the authorization expires.
+     */
+    expiration: Date;
+    /**
+     * The maximum number of authorized connections.
+     */
+    totalUses: number;
+    /**
+     * The permitted application, or any application when absent.
+     */
+    allowedAppID?: string | null;
+}
+
 /**
  * Application info registered with the indexer.
  */
@@ -206,10 +240,9 @@ export class Builder {
     [Symbol.dispose](): void;
     /**
      * Connects using a pre-authorized key, bypassing the interactive approval
-     * flow, and returns a Sdk. `preAuthorizedKeySeed` is the 32-byte
-     * pre-authorized private key (Uint8Array); `mnemonic` derives the app key.
+     * flow, and returns a Sdk. `mnemonic` derives the app key.
      */
-    connectPreAuthorized(pre_authorized_key_seed: Uint8Array, mnemonic: string): Promise<Sdk>;
+    connectPreAuthorized(pre_authorized_key: PreAuthorizedKey, mnemonic: string): Promise<Sdk>;
     /**
      * Attempts to connect using an existing AppKey.
      * Returns a Sdk if the key is valid, or undefined if not registered.
@@ -498,6 +531,42 @@ export class PinnedObject {
     updatedAt(): Date;
 }
 
+/**
+ * A key used to authorize application connections with indexd.
+ */
+export class PreAuthorizedKey {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Exports the key as a 32-byte seed.
+     */
+    export(): Uint8Array;
+    /**
+     * Imports a pre-authorized key from a 32-byte seed.
+     */
+    static import(seed: Uint8Array): PreAuthorizedKey;
+    /**
+     * Generates a new pre-authorized key.
+     */
+    constructor();
+    /**
+     * Returns the Ed25519 public key as a string.
+     */
+    publicKey(): string;
+    /**
+     * Signs a message and returns its 64-byte signature.
+     */
+    sign(message: Uint8Array): Uint8Array;
+    /**
+     * Returns a signed request for creating a pre-authorized key in indexd.
+     */
+    signRequest(request: PreAuthorizedKeyRequest): SignedPreAuthorizedKeyRequest;
+    /**
+     * Verifies a message signature using this key.
+     */
+    verifySignature(message: Uint8Array, signature: Uint8Array): boolean;
+}
+
 /**
  * The main Sia storage SDK. Provides methods for uploading, downloading,
  * and managing objects on the Sia storage network via an indexer.
@@ -753,7 +822,7 @@ export interface InitOutput {
     readonly appkey_publicKey: (a: number) => [number, number];
     readonly appkey_sign: (a: number, b: number, c: number) => [number, number];
     readonly appkey_verifySignature: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
-    readonly builder_connectPreAuthorized: (a: number, b: number, c: number, d: number, e: number) => any;
+    readonly builder_connectPreAuthorized: (a: number, b: number, c: number, d: number) => any;
     readonly builder_connected: (a: number, b: number) => any;
     readonly builder_matchesExistingAppKey: (a: number, b: number, c: number) => any;
     readonly builder_new: (a: number, b: number, c: any) => [number, number, number];
@@ -800,6 +869,13 @@ export interface InitOutput {
     readonly pinnedobject_truncate: (a: number, b: bigint) => number;
     readonly pinnedobject_updateMetadata: (a: number, b: number, c: number) => void;
     readonly pinnedobject_updatedAt: (a: number) => any;
+    readonly preauthorizedkey_export: (a: number) => [number, number];
+    readonly preauthorizedkey_import: (a: number, b: number) => [number, number, number];
+    readonly preauthorizedkey_new: () => number;
+    readonly preauthorizedkey_publicKey: (a: number) => [number, number];
+    readonly preauthorizedkey_sign: (a: number, b: number, c: number) => [number, number];
+    readonly preauthorizedkey_signRequest: (a: number, b: any) => [number, number, number];
+    readonly preauthorizedkey_verifySignature: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
     readonly sdk_account: (a: number) => any;
     readonly sdk_appKey: (a: number) => number;
     readonly sdk_createSharingKey: (a: number, b: number, c: number, d: number) => any;
@@ -834,6 +910,7 @@ export interface InitOutput {
     readonly sharingkey_publicKey: (a: number) => [number, number];
     readonly sharingkey_seed: (a: number) => [number, number];
     readonly validateRecoveryPhrase: (a: number, b: number) => [number, number];
+    readonly __wbg_preauthorizedkey_free: (a: number, b: number) => void;
     readonly __wbg_sharingkey_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingsink_free: (a: number, b: number) => void;

package/wasm/sia_storage_wasm.js

@@ -116,18 +116,16 @@ export class Builder {
     }
     /**
      * Connects using a pre-authorized key, bypassing the interactive approval
-     * flow, and returns a Sdk. `preAuthorizedKeySeed` is the 32-byte
-     * pre-authorized private key (Uint8Array); `mnemonic` derives the app key.
-     * @param {Uint8Array} pre_authorized_key_seed
+     * flow, and returns a Sdk. `mnemonic` derives the app key.
+     * @param {PreAuthorizedKey} pre_authorized_key
      * @param {string} mnemonic
      * @returns {Promise<Sdk>}
      */
-    connectPreAuthorized(pre_authorized_key_seed, mnemonic) {
-        const ptr0 = passArray8ToWasm0(pre_authorized_key_seed, wasm.__wbindgen_malloc);
+    connectPreAuthorized(pre_authorized_key, mnemonic) {
+        _assertClass(pre_authorized_key, PreAuthorizedKey);
+        const ptr0 = passStringToWasm0(mnemonic, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ptr1 = passStringToWasm0(mnemonic, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len1 = WASM_VECTOR_LEN;
-        const ret = wasm.builder_connectPreAuthorized(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        const ret = wasm.builder_connectPreAuthorized(this.__wbg_ptr, pre_authorized_key.__wbg_ptr, ptr0, len0);
         return ret;
     }
     /**
@@ -871,6 +869,120 @@ export class PinnedObject {
 }
 if (Symbol.dispose) PinnedObject.prototype[Symbol.dispose] = PinnedObject.prototype.free;
 
+/**
+ * A key used to authorize application connections with indexd.
+ */
+export class PreAuthorizedKey {
+    static __wrap(ptr) {
+        const obj = Object.create(PreAuthorizedKey.prototype);
+        obj.__wbg_ptr = ptr;
+        PreAuthorizedKeyFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        PreAuthorizedKeyFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_preauthorizedkey_free(ptr, 0);
+    }
+    /**
+     * Exports the key as a 32-byte seed.
+     * @returns {Uint8Array}
+     */
+    export() {
+        const ret = wasm.preauthorizedkey_export(this.__wbg_ptr);
+        var v1 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v1;
+    }
+    /**
+     * Imports a pre-authorized key from a 32-byte seed.
+     * @param {Uint8Array} seed
+     * @returns {PreAuthorizedKey}
+     */
+    static import(seed) {
+        const ptr0 = passArray8ToWasm0(seed, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.preauthorizedkey_import(ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return PreAuthorizedKey.__wrap(ret[0]);
+    }
+    /**
+     * Generates a new pre-authorized key.
+     */
+    constructor() {
+        const ret = wasm.preauthorizedkey_new();
+        this.__wbg_ptr = ret;
+        PreAuthorizedKeyFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * Returns the Ed25519 public key as a string.
+     * @returns {string}
+     */
+    publicKey() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.preauthorizedkey_publicKey(this.__wbg_ptr);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * Signs a message and returns its 64-byte signature.
+     * @param {Uint8Array} message
+     * @returns {Uint8Array}
+     */
+    sign(message) {
+        const ptr0 = passArray8ToWasm0(message, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.preauthorizedkey_sign(this.__wbg_ptr, ptr0, len0);
+        var v2 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v2;
+    }
+    /**
+     * Returns a signed request for creating a pre-authorized key in indexd.
+     * @param {PreAuthorizedKeyRequest} request
+     * @returns {SignedPreAuthorizedKeyRequest}
+     */
+    signRequest(request) {
+        const ret = wasm.preauthorizedkey_signRequest(this.__wbg_ptr, request);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * Verifies a message signature using this key.
+     * @param {Uint8Array} message
+     * @param {Uint8Array} signature
+     * @returns {boolean}
+     */
+    verifySignature(message, signature) {
+        const ptr0 = passArray8ToWasm0(message, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passArray8ToWasm0(signature, wasm.__wbindgen_malloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.preauthorizedkey_verifySignature(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return ret[0] !== 0;
+    }
+}
+if (Symbol.dispose) PreAuthorizedKey.prototype[Symbol.dispose] = PreAuthorizedKey.prototype.free;
+
 /**
  * The main Sia storage SDK. Provides methods for uploading, downloading,
  * and managing objects on the Sia storage network via an indexer.
@@ -1607,11 +1719,11 @@ function __wbg_get_imports() {
             const ret = arg0.createBidirectionalStream();
             return ret;
         },
-        __wbg_done_71c9042440891178: function(arg0) {
+        __wbg_done_89b2b13e91a60321: function(arg0) {
             const ret = arg0.done;
             return ret;
         },
-        __wbg_done_89b2b13e91a60321: function(arg0) {
+        __wbg_done_ccbb9708a558f0a5: function(arg0) {
             const ret = arg0.done;
             return ret;
         },
@@ -2072,11 +2184,11 @@ function __wbg_get_imports() {
             getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
             getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
         },
-        __wbg_value_41539d323b7919ad: function(arg0) {
+        __wbg_value_a5d5488a9589444a: function(arg0) {
             const ret = arg0.value;
             return ret;
         },
-        __wbg_value_a5d5488a9589444a: function(arg0) {
+        __wbg_value_b3f5a8463f26cd7e: function(arg0) {
             const ret = arg0.value;
             return ret;
         },
@@ -2283,6 +2395,9 @@ const PackedUploadFinalization = (typeof FinalizationRegistry === 'undefined')
 const PinnedObjectFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_pinnedobject_free(ptr, 1));
+const PreAuthorizedKeyFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_preauthorizedkey_free(ptr, 1));
 const SdkFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_sdk_free(ptr, 1));

package/wasm/sia_storage_wasm_bg.wasm.d.ts

@@ -16,7 +16,7 @@ export const appkey_new: (a: number, b: number) => [number, number, number];
 export const appkey_publicKey: (a: number) => [number, number];
 export const appkey_sign: (a: number, b: number, c: number) => [number, number];
 export const appkey_verifySignature: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
-export const builder_connectPreAuthorized: (a: number, b: number, c: number, d: number, e: number) => any;
+export const builder_connectPreAuthorized: (a: number, b: number, c: number, d: number) => any;
 export const builder_connected: (a: number, b: number) => any;
 export const builder_matchesExistingAppKey: (a: number, b: number, c: number) => any;
 export const builder_new: (a: number, b: number, c: any) => [number, number, number];
@@ -63,6 +63,13 @@ export const pinnedobject_slabs: (a: number) => [number, number, number];
 export const pinnedobject_truncate: (a: number, b: bigint) => number;
 export const pinnedobject_updateMetadata: (a: number, b: number, c: number) => void;
 export const pinnedobject_updatedAt: (a: number) => any;
+export const preauthorizedkey_export: (a: number) => [number, number];
+export const preauthorizedkey_import: (a: number, b: number) => [number, number, number];
+export const preauthorizedkey_new: () => number;
+export const preauthorizedkey_publicKey: (a: number) => [number, number];
+export const preauthorizedkey_sign: (a: number, b: number, c: number) => [number, number];
+export const preauthorizedkey_signRequest: (a: number, b: any) => [number, number, number];
+export const preauthorizedkey_verifySignature: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
 export const sdk_account: (a: number) => any;
 export const sdk_appKey: (a: number) => number;
 export const sdk_createSharingKey: (a: number, b: number, c: number, d: number) => any;
@@ -97,6 +104,7 @@ export const sharingkey_fromSeed: (a: number, b: number) => [number, number, num
 export const sharingkey_publicKey: (a: number) => [number, number];
 export const sharingkey_seed: (a: number) => [number, number];
 export const validateRecoveryPhrase: (a: number, b: number) => [number, number];
+export const __wbg_preauthorizedkey_free: (a: number, b: number) => void;
 export const __wbg_sharingkey_free: (a: number, b: number) => void;
 export const __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
 export const __wbg_intounderlyingsink_free: (a: number, b: number) => void;