@bsv/sdk 1.4.17 → 1.4.19

package/dist/esm/src/kvstore/LocalKVStore.js

@@ -1,8 +1,8 @@
-import LockingScript from '../script/LockingScript.js';
 import PushDrop from '../script/templates/PushDrop.js';
 import * as Utils from '../primitives/utils.js';
 import WalletClient from '../wallet/WalletClient.js';
 import Transaction from '../transaction/Transaction.js';
+import { Beef } from '../transaction/Beef.js';
 /**
  * Implements a key-value storage system backed by transaction outputs managed by a wallet.
  * Each key-value pair is represented by a PushDrop token output in a specific context (basket).
@@ -37,12 +37,12 @@ export default class LocalKVStore {
      * Creates an instance of the localKVStore.
      *
      * @param {WalletInterface} [wallet=new WalletClient()] - The wallet interface to use. Defaults to a new WalletClient instance.
-     * @param {string} [context='kvstore-default'] - The context (basket) for namespacing keys. Defaults to 'kvstore-default'.
+     * @param {string} [context='kvstoredefault'] - The context (basket) for namespacing keys. Defaults to 'kvstore default'.
      * @param {boolean} [encrypt=true] - Whether to encrypt values. Defaults to true.
      * @param {string} [originator] — An originator to use with PushDrop and the wallet, if provided.
      * @throws {Error} If the context is missing or empty.
      */
-    constructor(wallet = new WalletClient(), context = 'kvstore-default', encrypt = true, originator) {
+    constructor(wallet = new WalletClient(), context = 'kvstore default', encrypt = true, originator) {
         if (typeof context !== 'string' || context.length < 1) {
             throw new Error('A context in which to operate is required.');
         }
@@ -51,6 +51,19 @@ export default class LocalKVStore {
         this.encrypt = encrypt;
         this.originator = originator;
     }
+    getProtocol(key) {
+        return { protocolID: [2, this.context], keyID: key };
+    }
+    async getOutputs(key, limit) {
+        const results = await this.wallet.listOutputs({
+            basket: this.context,
+            tags: [key],
+            tagQueryMode: 'all',
+            include: 'entire transactions',
+            limit
+        });
+        return results;
+    }
     /**
      * Retrieves the value associated with a given key.
      *
@@ -58,46 +71,81 @@ export default class LocalKVStore {
      * @param {string | undefined} [defaultValue=undefined] - The value to return if the key is not found.
      * @returns {Promise<string | undefined>} A promise that resolves to the value as a string,
      *   the defaultValue if the key is not found, or undefined if no defaultValue is provided.
-     * @throws {Error} If multiple outputs are found for the key (ambiguous state).
+     * @throws {Error} If too many outputs are found for the key (ambiguous state).
      * @throws {Error} If the found output's locking script cannot be decoded or represents an invalid token format.
      */
     async get(key, defaultValue = undefined) {
-        const results = await this.wallet.listOutputs({
-            basket: this.context,
-            tags: [key],
-            include: 'locking scripts'
-        });
-        if (results.outputs.length === 0) {
-            return defaultValue;
+        const r = await this.lookupValue(key, defaultValue, 5);
+        return r.value;
+    }
+    getLockingScript(output, beef) {
+        const [txid, vout] = output.outpoint.split('.');
+        const tx = beef.findTxid(txid)?.tx;
+        if (tx == null) {
+            throw new Error(`beef must contain txid ${txid}`);
         }
-        else if (results.outputs.length > 1) {
-            throw new Error('Multiple tokens found for this key. You need to call set to collapse this ambiguous state before you can get this value again.');
+        const lockingScript = tx.outputs[Number(vout)].lockingScript;
+        return lockingScript;
+    }
+    async lookupValue(key, defaultValue, limit) {
+        const lor = await this.getOutputs(key, limit);
+        const r = { value: defaultValue, outpoint: undefined, lor };
+        const { outputs } = lor;
+        if (outputs.length === 0) {
+            return r;
         }
-        let fields;
+        const output = outputs.slice(-1)[0];
+        r.outpoint = output.outpoint;
+        let field;
         try {
-            if (typeof results.outputs[0].lockingScript !== 'string') {
-                throw new Error('No locking script');
+            if (lor.BEEF === undefined) {
+                throw new Error('entire transactions listOutputs option must return valid BEEF');
             }
-            const decoded = PushDrop.decode(LockingScript.fromHex(results.outputs[0].lockingScript));
-            if (decoded.fields.length !== 1) {
+            const lockingScript = this.getLockingScript(output, Beef.fromBinary(lor.BEEF));
+            const decoded = PushDrop.decode(lockingScript);
+            if (decoded.fields.length < 1 || decoded.fields.length > 2) {
                 throw new Error('Invalid token.');
             }
-            fields = decoded.fields;
+            field = decoded.fields[0];
         }
         catch (_) {
-            throw new Error(`Invalid value found. You need to call set to collapse the corrupted state (or relinquish the corrupted ${results.outputs[0].outpoint} output from the ${this.context} basket) before you can get this value again.`);
+            throw new Error(`Invalid value found. You need to call set to collapse the corrupted state (or relinquish the corrupted ${outputs[0].outpoint} output from the ${this.context} basket) before you can get this value again.`);
         }
         if (!this.encrypt) {
-            return Utils.toUTF8(fields[0]);
+            r.value = Utils.toUTF8(field);
         }
         else {
             const { plaintext } = await this.wallet.decrypt({
-                protocolID: [2, this.context],
-                keyID: key,
-                ciphertext: fields[0]
+                ...this.getProtocol(key),
+                ciphertext: field
+            });
+            r.value = Utils.toUTF8(plaintext);
+        }
+        return r;
+    }
+    getInputs(outputs) {
+        const inputs = [];
+        for (let i = 0; i < outputs.length; i++) {
+            inputs.push({
+                outpoint: outputs[i].outpoint,
+                unlockingScriptLength: 74,
+                inputDescription: 'Previous key-value token'
             });
-            return Utils.toUTF8(plaintext);
         }
+        return inputs;
+    }
+    async getSpends(key, outputs, pushdrop, atomicBEEF) {
+        const p = this.getProtocol(key);
+        const tx = Transaction.fromAtomicBEEF(atomicBEEF);
+        const spends = {};
+        for (let i = 0; i < outputs.length; i++) {
+            const unlocker = pushdrop.unlock(p.protocolID, p.keyID, 'self');
+            const unlockingScript = await unlocker.sign(tx, i);
+            spends[i] = {
+                unlockingScript: unlockingScript.toHex()
+            };
+        }
+        return spends;
     }
     /**
      * Sets or updates the value associated with a given key.
@@ -113,87 +161,64 @@ export default class LocalKVStore {
      * @returns {Promise<OutpointString>} A promise that resolves to the outpoint string (txid.vout) of the new or updated token output.
      */
     async set(key, value) {
+        const current = await this.lookupValue(key, undefined, 10);
+        if (current.value === value) {
+            if (current.outpoint === undefined) {
+                throw new Error('outpoint must be valid when value is valid and unchanged');
+            }
+            // Don't create a new transaction if the value doesn't need to change...
+            return current.outpoint;
+        }
+        const protocol = this.getProtocol(key);
         let valueAsArray = Utils.toArray(value, 'utf8');
         if (this.encrypt) {
             const { ciphertext } = await this.wallet.encrypt({
-                plaintext: valueAsArray,
-                protocolID: [2, this.context],
-                keyID: key
+                ...protocol,
+                plaintext: valueAsArray
             });
             valueAsArray = ciphertext;
         }
         const pushdrop = new PushDrop(this.wallet, this.originator);
-        const lockingScript = await pushdrop.lock([valueAsArray], [2, this.context], key, 'self');
-        const results = await this.wallet.listOutputs({
-            basket: this.context,
-            tags: [key],
-            include: 'entire transactions'
-        });
-        if (results.totalOutputs !== 0) {
-            try {
-                const inputs = [];
-                for (let i = 0; i < results.outputs.length; i++) {
-                    inputs.push({
-                        outpoint: results.outputs[i].outpoint,
-                        unlockingScriptLength: 74,
-                        inputDescription: 'Previous key-value token'
-                    });
-                }
-                const { signableTransaction } = await this.wallet.createAction({
-                    description: `Update ${key} in ${this.context}`,
-                    inputBEEF: results.BEEF,
-                    inputs,
-                    outputs: [{
-                            lockingScript: lockingScript.toHex(),
-                            satoshis: 1,
-                            outputDescription: 'Key-value token'
-                        }],
-                    options: {
-                        acceptDelayedBroadcast: false,
-                        randomizeOutputs: false
-                    }
-                });
-                if (typeof signableTransaction !== 'object') {
-                    throw new Error('Wallet did not return a signable transaction when expected.');
-                }
-                const tx = Transaction.fromAtomicBEEF(signableTransaction.tx);
-                const spends = {};
-                for (let i = 0; i < results.outputs.length; i++) {
-                    const unlocker = pushdrop.unlock([2, this.context], key, 'self');
-                    const unlockingScript = await unlocker.sign(tx, i);
-                    spends[i] = {
-                        unlockingScript: unlockingScript.toHex()
-                    };
+        const lockingScript = await pushdrop.lock([valueAsArray], protocol.protocolID, protocol.keyID, 'self');
+        const { outputs, BEEF: inputBEEF } = current.lor;
+        let outpoint;
+        try {
+            const inputs = this.getInputs(outputs);
+            const { txid, signableTransaction } = await this.wallet.createAction({
+                description: `Update ${key} in ${this.context}`,
+                inputBEEF,
+                inputs,
+                outputs: [{
+                        basket: this.context,
+                        tags: [key],
+                        lockingScript: lockingScript.toHex(),
+                        satoshis: 1,
+                        outputDescription: 'Key-value token'
+                    }],
+                options: {
+                    acceptDelayedBroadcast: false,
+                    randomizeOutputs: false
                 }
+            });
+            if (outputs.length > 0 && typeof signableTransaction !== 'object') {
+                throw new Error('Wallet did not return a signable transaction when expected.');
+            }
+            if (signableTransaction == null) {
+                outpoint = `${txid}.0`;
+            }
+            else {
+                const spends = await this.getSpends(key, outputs, pushdrop, signableTransaction.tx);
                 const { txid } = await this.wallet.signAction({
                     reference: signableTransaction.reference,
                     spends
                 });
-                return `${txid}.0`;
-            }
-            catch (_) {
-                // Signing failed, relinquish original outputs
-                for (let i = 0; i < results.outputs.length; i++) {
-                    await this.wallet.relinquishOutput({
-                        output: results.outputs[i].outpoint,
-                        basket: this.context
-                    });
-                }
+                outpoint = `${txid}.0`;
             }
         }
-        const { txid } = await this.wallet.createAction({
-            description: `Set ${key} in ${this.context}`,
-            outputs: [{
-                    lockingScript: lockingScript.toHex(),
-                    satoshis: 1,
-                    outputDescription: 'Key-value token'
-                }],
-            options: {
-                acceptDelayedBroadcast: false,
-                randomizeOutputs: false
-            }
-        });
-        return `${txid}.0`;
+        catch (_) {
+            throw new Error(`There are ${outputs.length} outputs with tag ${key} that cannot be unlocked.`);
+        }
+        return outpoint;
     }
     /**
      * Removes the key-value pair associated with the given key.
@@ -203,61 +228,46 @@ export default class LocalKVStore {
      * If signing the removal transaction fails, it relinquishes the original outputs instead of spending.
      *
      * @param {string} key - The key to remove.
-     * @returns {Promise<string | void>} A promise that resolves to the txid of the removal transaction if successful.
+     * @returns {Promise<string[]>} A promise that resolves to the txids of the removal transactions if successful.
      */
     async remove(key) {
-        const results = await this.wallet.listOutputs({
-            basket: this.context,
-            tags: [key],
-            include: 'entire transactions'
-        });
-        if (results.totalOutputs === 0) {
-            return; // Key not found, do nothing
-        }
-        const pushdrop = new PushDrop(this.wallet, this.originator);
-        try {
-            const inputs = [];
-            for (let i = 0; i < results.outputs.length; i++) {
-                inputs.push({
-                    outpoint: results.outputs[i].outpoint,
-                    unlockingScriptLength: 74,
-                    inputDescription: 'Previous key-value token'
-                });
-            }
-            const { signableTransaction } = await this.wallet.createAction({
-                description: `Remove ${key} in ${this.context}`,
-                inputBEEF: results.BEEF,
-                inputs,
-                options: {
-                    acceptDelayedBroadcast: false
+        const txids = [];
+        for (;;) {
+            const { outputs, BEEF: inputBEEF, totalOutputs } = await this.getOutputs(key);
+            if (outputs.length > 0) {
+                const pushdrop = new PushDrop(this.wallet, this.originator);
+                try {
+                    const inputs = this.getInputs(outputs);
+                    const { signableTransaction } = await this.wallet.createAction({
+                        description: `Remove ${key} in ${this.context}`,
+                        inputBEEF,
+                        inputs,
+                        options: {
+                            acceptDelayedBroadcast: false
+                        }
+                    });
+                    if (typeof signableTransaction !== 'object') {
+                        throw new Error('Wallet did not return a signable transaction when expected.');
+                    }
+                    const spends = await this.getSpends(key, outputs, pushdrop, signableTransaction.tx);
+                    const { txid } = await this.wallet.signAction({
+                        reference: signableTransaction.reference,
+                        spends
+                    });
+                    if (txid === undefined) {
+                        throw new Error('signAction must return a valid txid');
+                    }
+                    txids.push(txid);
+                }
+                catch (_) {
+                    throw new Error(`There are ${totalOutputs} outputs with tag ${key} that cannot be unlocked.`);
                 }
-            });
-            if (typeof signableTransaction !== 'object') {
-                throw new Error('Wallet did not return a signable transaction when expected.');
-            }
-            const tx = Transaction.fromAtomicBEEF(signableTransaction.tx);
-            const spends = {};
-            for (let i = 0; i < results.outputs.length; i++) {
-                const unlocker = pushdrop.unlock([2, this.context], key, 'self');
-                const unlockingScript = await unlocker.sign(tx, i);
-                spends[i] = {
-                    unlockingScript: unlockingScript.toHex()
-                };
             }
-            const { txid } = await this.wallet.signAction({
-                reference: signableTransaction.reference,
-                spends
-            });
-            return txid;
-        }
-        catch (_) {
-            for (let i = 0; i < results.outputs.length; i++) {
-                await this.wallet.relinquishOutput({
-                    output: results.outputs[i].outpoint,
-                    basket: this.context
-                });
+            if (outputs.length === totalOutputs) {
+                break;
             }
         }
+        return txids;
     }
 }
 //# sourceMappingURL=LocalKVStore.js.map

package/dist/esm/src/kvstore/LocalKVStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"LocalKVStore.js","sourceRoot":"","sources":["../../../../src/kvstore/LocalKVStore.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,QAAQ,MAAM,iCAAiC,CAAA;AACtD,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAA;AAE/C,OAAO,YAAY,MAAM,2BAA2B,CAAA;AACpD,OAAO,WAAW,MAAM,+BAA+B,CAAA;AAEvD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;OAIG;IACc,MAAM,CAAiB;IACxC;;;;OAIG;IACc,OAAO,CAAQ;IAChC;;;;OAIG;IACc,OAAO,CAAS;IAEjC;;;;OAIG;IACc,UAAU,CAAS;IAEpC;;;;;;;;OAQG;IACH,YACE,SAA0B,IAAI,YAAY,EAAE,EAC5C,OAAO,GAAG,iBAAiB,EAC3B,OAAO,GAAG,IAAI,EACd,UAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;SAC9D;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,CAAE,GAAW,EAAE,eAAmC,SAAS;QAClE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,IAAI,EAAE,CAAC,GAAG,CAAC;YACX,OAAO,EAAE,iBAAiB;SAC3B,CAAC,CAAA;QACF,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,OAAO,YAAY,CAAA;SACpB;aAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,gIAAgI,CAAC,CAAA;SAClJ;QACD,IAAI,MAAkB,CAAA;QACtB,IAAI;YACF,IAAI,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,KAAK,QAAQ,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;aACrC;YACD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAA;YACxF,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC/B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;aAClC;YACD,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;SACxB;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,0GAA0G,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,oBAAoB,IAAI,CAAC,OAAO,+CAA+C,CAAC,CAAA;SACtO;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SAC/B;aAAM;YACL,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC9C,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;gBAC7B,KAAK,EAAE,GAAG;gBACV,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;aACtB,CAAC,CAAA;YACF,OAAO,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SAC/B;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,GAAG,CAAE,GAAW,EAAE,KAAa;QACnC,IAAI,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC/C,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC/C,SAAS,EAAE,YAAY;gBACvB,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;gBAC7B,KAAK,EAAE,GAAG;aACX,CAAC,CAAA;YACF,YAAY,GAAG,UAAU,CAAA;SAC1B;QACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QAC3D,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,CACvC,CAAC,YAAY,CAAC,EACd,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EACjB,GAAG,EACH,MAAM,CACP,CAAA;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,IAAI,EAAE,CAAC,GAAG,CAAC;YACX,OAAO,EAAE,qBAAqB;SAC/B,CAAC,CAAA;QACF,IAAI,OAAO,CAAC,YAAY,KAAK,CAAC,EAAE;YAC9B,IAAI;gBACF,MAAM,MAAM,GAAwB,EAAE,CAAA;gBACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBAC/C,MAAM,CAAC,IAAI,CAAC;wBACV,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;wBACrC,qBAAqB,EAAE,EAAE;wBACzB,gBAAgB,EAAE,0BAA0B;qBAC7C,CAAC,CAAA;iBACH;gBACD,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;oBAC7D,WAAW,EAAE,UAAU,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE;oBAC/C,SAAS,EAAE,OAAO,CAAC,IAAI;oBACvB,MAAM;oBACN,OAAO,EAAE,CAAC;4BACR,aAAa,EAAE,aAAa,CAAC,KAAK,EAAE;4BACpC,QAAQ,EAAE,CAAC;4BACX,iBAAiB,EAAE,iBAAiB;yBACrC,CAAC;oBACF,OAAO,EAAE;wBACP,sBAAsB,EAAE,KAAK;wBAC7B,gBAAgB,EAAE,KAAK;qBACxB;iBACF,CAAC,CAAA;gBACF,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;oBAC3C,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;iBAC/E;gBACD,MAAM,EAAE,GAAG,WAAW,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAA;gBAC7D,MAAM,MAAM,GAAoC,EAAE,CAAA;gBAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAC9B,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EACjB,GAAG,EACH,MAAM,CACP,CAAA;oBACD,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;oBAClD,MAAM,CAAC,CAAC,CAAC,GAAG;wBACV,eAAe,EAAE,eAAe,CAAC,KAAK,EAAE;qBACzC,CAAA;iBACF;gBACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;oBAC5C,SAAS,EAAE,mBAAmB,CAAC,SAAS;oBACxC,MAAM;iBACP,CAAC,CAAA;gBACF,OAAO,GAAG,IAAc,IAAI,CAAA;aAC7B;YAAC,OAAO,CAAC,EAAE;gBACV,8CAA8C;gBAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBAC/C,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;wBACjC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;wBACnC,MAAM,EAAE,IAAI,CAAC,OAAO;qBACrB,CAAC,CAAA;iBACH;aACF;SACF;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC9C,WAAW,EAAE,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE;YAC5C,OAAO,EAAE,CAAC;oBACR,aAAa,EAAE,aAAa,CAAC,KAAK,EAAE;oBACpC,QAAQ,EAAE,CAAC;oBACX,iBAAiB,EAAE,iBAAiB;iBACrC,CAAC;YACF,OAAO,EAAE;gBACP,sBAAsB,EAAE,KAAK;gBAC7B,gBAAgB,EAAE,KAAK;aACxB;SACF,CAAC,CAAA;QACF,OAAO,GAAG,IAAc,IAAI,CAAA;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAE,GAAW;QACvB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,IAAI,EAAE,CAAC,GAAG,CAAC;YACX,OAAO,EAAE,qBAAqB;SAC/B,CAAC,CAAA;QACF,IAAI,OAAO,CAAC,YAAY,KAAK,CAAC,EAAE;YAC9B,OAAM,CAAC,4BAA4B;SACpC;QACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QAC3D,IAAI;YACF,MAAM,MAAM,GAAwB,EAAE,CAAA;YACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC/C,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACrC,qBAAqB,EAAE,EAAE;oBACzB,gBAAgB,EAAE,0BAA0B;iBAC7C,CAAC,CAAA;aACH;YACD,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC7D,WAAW,EAAE,UAAU,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE;gBAC/C,SAAS,EAAE,OAAO,CAAC,IAAI;gBACvB,MAAM;gBACN,OAAO,EAAE;oBACP,sBAAsB,EAAE,KAAK;iBAC9B;aACF,CAAC,CAAA;YACF,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;aAC/E;YACD,MAAM,EAAE,GAAG,WAAW,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAA;YAC7D,MAAM,MAAM,GAAoC,EAAE,CAAA;YAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAC9B,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EACjB,GAAG,EACH,MAAM,CACP,CAAA;gBACD,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;gBAClD,MAAM,CAAC,CAAC,CAAC,GAAG;oBACV,eAAe,EAAE,eAAe,CAAC,KAAK,EAAE;iBACzC,CAAA;aACF;YACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC5C,SAAS,EAAE,mBAAmB,CAAC,SAAS;gBACxC,MAAM;aACP,CAAC,CAAA;YACF,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC/C,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;oBACjC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACnC,MAAM,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC,CAAA;aACH;SACF;IACH,CAAC;CACF"}
+{"version":3,"file":"LocalKVStore.js","sourceRoot":"","sources":["../../../../src/kvstore/LocalKVStore.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,iCAAiC,CAAA;AACtD,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAA;AAE/C,OAAO,YAAY,MAAM,2BAA2B,CAAA;AACpD,OAAO,WAAW,MAAM,+BAA+B,CAAA;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAE7C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;OAIG;IACc,MAAM,CAAiB;IACxC;;;;OAIG;IACc,OAAO,CAAQ;IAChC;;;;OAIG;IACc,OAAO,CAAS;IAEjC;;;;OAIG;IACc,UAAU,CAAS;IAEpC;;;;;;;;OAQG;IACH,YACE,SAA0B,IAAI,YAAY,EAAE,EAC5C,OAAO,GAAG,iBAAiB,EAC3B,OAAO,GAAG,IAAI,EACd,UAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;SAC9D;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAEO,WAAW,CAAE,GAAW;QAC9B,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IACtD,CAAC;IAEO,KAAK,CAAC,UAAU,CAAE,GAAW,EAAE,KAAc;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,IAAI,EAAE,CAAC,GAAG,CAAC;YACX,YAAY,EAAE,KAAK;YACnB,OAAO,EAAE,qBAAqB;YAC9B,KAAK;SACN,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,CAAE,GAAW,EAAE,eAAmC,SAAS;QAClE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC,CAAA;QACtD,OAAO,CAAC,CAAC,KAAK,CAAA;IAChB,CAAC;IAEO,gBAAgB,CAAE,MAAoB,EAAE,IAAU;QACxD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC/C,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAA;QAClC,IAAI,EAAE,IAAI,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,EAAE,CAAC,CAAA;SAAE;QACrE,MAAM,aAAa,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAA;QAC5D,OAAO,aAAa,CAAA;IACtB,CAAC;IAEO,KAAK,CAAC,WAAW,CAAE,GAAW,EAAE,YAAgC,EAAE,KAAc;QACtF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC7C,MAAM,CAAC,GAAsB,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE,CAAA;QAC9E,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAA;QACvB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,OAAO,CAAC,CAAA;SACT;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACnC,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QAC5B,IAAI,KAAe,CAAA;QACnB,IAAI;YACF,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;aAAE;YAChH,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;YAC9E,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;YAC9C,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;aAClC;YACD,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;SAC1B;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,0GAA0G,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,oBAAoB,IAAI,CAAC,OAAO,+CAA+C,CAAC,CAAA;SAC9N;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;SAC9B;aAAM;YACL,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC9C,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;gBACxB,UAAU,EAAE,KAAK;aAClB,CAAC,CAAA;YACF,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SAClC;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAEO,SAAS,CAAE,OAAuB;QACxC,MAAM,MAAM,GAAwB,EAAE,CAAA;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;gBAC7B,qBAAqB,EAAE,EAAE;gBACzB,gBAAgB,EAAE,0BAA0B;aAC7C,CAAC,CAAA;SACH;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,KAAK,CAAC,SAAS,CAAE,GAAW,EAAE,OAAuB,EAAE,QAAkB,EAAE,UAAsB;QACvG,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QAC/B,MAAM,EAAE,GAAG,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;QACjD,MAAM,MAAM,GAAoC,EAAE,CAAA;QAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YAC/D,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;YAClD,MAAM,CAAC,CAAC,CAAC,GAAG;gBACV,eAAe,EAAE,eAAe,CAAC,KAAK,EAAE;aACzC,CAAA;SACF;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,GAAG,CAAE,GAAW,EAAE,KAAa;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,CAAA;QAC1D,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE;YAC3B,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;aAAE;YACnH,wEAAwE;YACxE,OAAO,OAAO,CAAC,QAAQ,CAAA;SACxB;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC/C,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC/C,GAAG,QAAQ;gBACX,SAAS,EAAE,YAAY;aACxB,CAAC,CAAA;YACF,YAAY,GAAG,UAAU,CAAA;SAC1B;QACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QAC3D,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,CACvC,CAAC,YAAY,CAAC,EACd,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,KAAK,EACd,MAAM,CACP,CAAA;QACD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,GAAG,CAAA;QAChD,IAAI,QAAwB,CAAA;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;YACtC,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;gBACnE,WAAW,EAAE,UAAU,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE;gBAC/C,SAAS;gBACT,MAAM;gBACN,OAAO,EAAE,CAAC;wBACR,MAAM,EAAE,IAAI,CAAC,OAAO;wBACpB,IAAI,EAAE,CAAC,GAAG,CAAC;wBACX,aAAa,EAAE,aAAa,CAAC,KAAK,EAAE;wBACpC,QAAQ,EAAE,CAAC;wBACX,iBAAiB,EAAE,iBAAiB;qBACrC,CAAC;gBACF,OAAO,EAAE;oBACP,sBAAsB,EAAE,KAAK;oBAC7B,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAA;YACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;aAC/E;YACD,IAAI,mBAAmB,IAAI,IAAI,EAAE;gBAC/B,QAAQ,GAAG,GAAG,IAAc,IAAI,CAAA;aACjC;iBAAM;gBACL,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAA;gBACnF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;oBAC5C,SAAS,EAAE,mBAAmB,CAAC,SAAS;oBACxC,MAAM;iBACP,CAAC,CAAA;gBACF,QAAQ,GAAG,GAAG,IAAc,IAAI,CAAA;aACjC;SACF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,aAAa,OAAO,CAAC,MAAM,qBAAqB,GAAG,2BAA2B,CAAC,CAAA;SAChG;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAE,GAAW;QACvB,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,SAAU;YACR,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;YAC7E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtB,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;gBAC3D,IAAI;oBACF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;oBACtC,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;wBAC7D,WAAW,EAAE,UAAU,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE;wBAC/C,SAAS;wBACT,MAAM;wBACN,OAAO,EAAE;4BACP,sBAAsB,EAAE,KAAK;yBAC9B;qBACF,CAAC,CAAA;oBACF,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;wBAC3C,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;qBAC/E;oBACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAA;oBACnF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;wBAC5C,SAAS,EAAE,mBAAmB,CAAC,SAAS;wBACxC,MAAM;qBACP,CAAC,CAAA;oBACF,IAAI,IAAI,KAAK,SAAS,EAAE;wBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;qBAAE;oBAClF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;iBACjB;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,IAAI,KAAK,CAAC,aAAa,YAAY,qBAAqB,GAAG,2BAA2B,CAAC,CAAA;iBAC9F;aACF;YACD,IAAI,OAAO,CAAC,MAAM,KAAK,YAAY,EAAE;gBAAE,MAAK;aAAE;SAC/C;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}

package/dist/esm/src/storage/StorageUploader.js

@@ -1,12 +1,31 @@
 import { AuthFetch } from '../auth/clients/AuthFetch.js';
 import * as StorageUtils from './StorageUtils.js';
+/**
+ * The StorageUploader class provides client-side methods for:
+ * - Uploading files with a specified retention period
+ * - Finding file metadata by UHRP URL
+ * - Listing all user uploads
+ * - Renewing an existing advertisement's expiry time
+ */
 export class StorageUploader {
     authFetch;
     baseURL;
+    /**
+     * Creates a new StorageUploader instance.
+     * @param {UploaderConfig} config - An object containing the storage server's URL and a wallet interface
+     */
     constructor(config) {
         this.baseURL = config.storageURL;
         this.authFetch = new AuthFetch(config.wallet);
     }
+    /**
+     * Requests information from the server to upload a file (including presigned URL and headers).
+     * @private
+     * @param {number} fileSize - The size of the file, in bytes
+     * @param {number} retentionPeriod - The desired hosting time, in minutes
+     * @returns {Promise<{ uploadURL: string; requiredHeaders: Record<string, string>; amount?: number }>}
+     * @throws {Error} If the server returns a non-OK response or an error status
+     */
     async getUploadInfo(fileSize, retentionPeriod) {
         const url = `${this.baseURL}/upload`;
         const body = { fileSize, retentionPeriod };
@@ -28,6 +47,15 @@ export class StorageUploader {
             amount: data.amount
         };
     }
+    /**
+     * Performs the actual file upload (HTTP PUT) to the presigned URL returned by the server.
+     * @private
+     * @param {string} uploadURL - The presigned URL where the file is to be uploaded
+     * @param {UploadableFile} file - The file to upload, including its raw data and MIME type
+     * @param {Record<string, string>} requiredHeaders - Additional headers required by the server (e.g. content-length)
+     * @returns {Promise<UploadFileResult>} An object indicating whether publishing was successful and the resulting UHRP URL
+     * @throws {Error} If the server returns a non-OK response
+     */
     async uploadFile(uploadURL, file, requiredHeaders) {
         const body = Uint8Array.from(file.data);
         const response = await fetch(uploadURL, {
@@ -48,25 +76,102 @@ export class StorageUploader {
         };
     }
     /**
-       * 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.
-       *
-       * @param params.file - An object describing the file’s data (number[] array of bytes) and mime type.
-       * @param params.retentionPeriod - Number of minutes to keep the file hosted.
-       *
-       * @returns An object indicating whether the file was published successfully and the resulting UHRP URL.
-       *
-       * @throws If either the upload info request or the subsequent file upload request fails (non-OK HTTP status).
-       */
+     * 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.
+     *
+     * @param {Object} params
+     * @param {UploadableFile} params.file - The file data + type
+     * @param {number} params.retentionPeriod - Number of minutes to host the file
+     * @returns {Promise<UploadFileResult>} An object with the file's UHRP URL
+     * @throws {Error} If the server or upload step returns a non-OK response
+     */
     async publishFile(params) {
         const { file, retentionPeriod } = params;
         const fileSize = file.data.length;
         const { uploadURL, requiredHeaders } = await this.getUploadInfo(fileSize, retentionPeriod);
         return await this.uploadFile(uploadURL, file, requiredHeaders);
     }
+    /**
+     * Retrieves metadata for a file matching the given UHRP URL from the `/find` route.
+     * @param {string} uhrpUrl - The UHRP URL, e.g. "uhrp://abcd..."
+     * @returns {Promise<FindFileData>} An object with file name, size, MIME type, and expiry time
+     * @throws {Error} If the server or the route returns an error
+     */
+    async findFile(uhrpUrl) {
+        const url = new URL(`${this.baseURL}/find`);
+        url.searchParams.set('uhrpUrl', uhrpUrl);
+        const response = await this.authFetch.fetch(url.toString(), {
+            method: 'GET'
+        });
+        if (!response.ok) {
+            throw new Error(`findFile request failed: HTTP ${response.status}`);
+        }
+        const data = await response.json();
+        if (data.status === 'error') {
+            const errCode = data.code ?? 'unknown-code';
+            const errDesc = data.description ?? 'no-description';
+            throw new Error(`findFile returned an error: ${errCode} - ${errDesc}`);
+        }
+        return data.data;
+    }
+    /**
+     * Lists all advertisements belonging to the user from the `/list` route.
+     * @returns {Promise<any>} The array of uploads returned by the server
+     * @throws {Error} If the server or the route returns an error
+     */
+    async listUploads() {
+        const url = `${this.baseURL}/list`;
+        const response = await this.authFetch.fetch(url, {
+            method: 'GET'
+        });
+        if (!response.ok) {
+            throw new Error(`listUploads request failed: HTTP ${response.status}`);
+        }
+        const data = await response.json();
+        if (data.status === 'error') {
+            const errCode = data.code ?? 'unknown-code';
+            const errDesc = data.description ?? 'no-description';
+            throw new Error(`listUploads returned an error: ${errCode} - ${errDesc}`);
+        }
+        return data.uploads;
+    }
+    /**
+     * Renews the hosting time for an existing file advertisement identified by uhrpUrl.
+     * Calls the `/renew` route to add `additionalMinutes` to the GCS customTime
+     * and re-mint the advertisement token on-chain.
+     *
+     * @param {string} uhrpUrl - The UHRP URL of the file (e.g., "uhrp://abcd1234...")
+     * @param {number} additionalMinutes - The number of minutes to extend
+     * @returns {Promise<RenewFileResult>} An object with the new and previous expiry times, plus any cost
+     * @throws {Error} If the request fails or the server returns an error
+     */
+    async renewFile(uhrpUrl, additionalMinutes) {
+        const url = `${this.baseURL}/renew`;
+        const body = { uhrpUrl, additionalMinutes };
+        const response = await this.authFetch.fetch(url, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(body)
+        });
+        if (!response.ok) {
+            throw new Error(`renewFile request failed: HTTP ${response.status}`);
+        }
+        const data = await response.json();
+        if (data.status === 'error') {
+            const errCode = data.code ?? 'unknown-code';
+            const errDesc = data.description ?? 'no-description';
+            throw new Error(`renewFile returned an error: ${errCode} - ${errDesc}`);
+        }
+        return {
+            status: data.status,
+            prevExpiryTime: data.prevExpiryTime,
+            newExpiryTime: data.newExpiryTime,
+            amount: data.amount
+        };
+    }
 }
 //# sourceMappingURL=StorageUploader.js.map

package/dist/esm/src/storage/StorageUploader.js.map

@@ -1 +1 @@
-{"version":3,"file":"StorageUploader.js","sourceRoot":"","sources":["../../../../src/storage/StorageUploader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAExD,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAiBjD,MAAM,OAAO,eAAe;IACT,SAAS,CAAW;IACpB,OAAO,CAAQ;IAEhC,YAAa,MAAsB;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAA;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,QAAgB,EAChB,eAAuB;QAMvB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,SAAS,CAAA;QACpC,MAAM,IAAI,GAAG,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAA;QAE1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE;YAC/C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SACvE;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAK/B,CAAA;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;SACnD;QACD,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,SAAiB,EACjB,IAAoB,EACpB,eAAuC;QAEvC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;YACtC,MAAM,EAAE,KAAK;YACb,IAAI;YACJ,OAAO,EAAE;gBACP,cAAc,EAAE,IAAI,CAAC,IAAI;gBACzB,GAAG,eAAe;aACnB;SACF,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SAC/D;QAED,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3D,OAAO;YACL,SAAS,EAAE,IAAI;YACf,OAAO;SACR,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;SAcK;IACE,KAAK,CAAC,WAAW,CAAE,MAGzB;QACC,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAA;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QAEjC,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAC1F,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,EAAE,eAAe,CAAC,CAAA;IAChE,CAAC;CACF"}
+{"version":3,"file":"StorageUploader.js","sourceRoot":"","sources":["../../../../src/storage/StorageUploader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAExD,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AA+BjD;;;;;;GAMG;AACH,MAAM,OAAO,eAAe;IACT,SAAS,CAAW;IACpB,OAAO,CAAQ;IAEhC;;;OAGG;IACH,YAAa,MAAsB;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAA;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,aAAa,CACzB,QAAgB,EAChB,eAAuB;QAMvB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,SAAS,CAAA;QACpC,MAAM,IAAI,GAAG,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAA;QAE1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE;YAC/C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SACvE;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAK/B,CAAA;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;SACnD;QACD,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,UAAU,CACtB,SAAiB,EACjB,IAAoB,EACpB,eAAuC;QAEvC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;YACtC,MAAM,EAAE,KAAK;YACb,IAAI;YACJ,OAAO,EAAE;gBACP,cAAc,EAAE,IAAI,CAAC,IAAI;gBACzB,GAAG,eAAe;aACnB;SACF,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SAC/D;QAED,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3D,OAAO;YACL,SAAS,EAAE,IAAI;YACf,OAAO;SACR,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,WAAW,CAAE,MAGzB;QACC,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAA;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QAEjC,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAC1F,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,EAAE,eAAe,CAAC,CAAA;IAChE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAE,OAAe;QACpC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,OAAO,CAAC,CAAA;QAC3C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;QAExC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC1D,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,iCAAiC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SACpE;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAK/B,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,cAAc,CAAA;YAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,gBAAgB,CAAA;YACpD,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,MAAM,OAAO,EAAE,CAAC,CAAA;SACvE;QACD,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,OAAO,CAAA;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE;YAC/C,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SACvE;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAc,IAAI,cAAc,CAAA;YACrD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAqB,IAAI,gBAAgB,CAAA;YAC9D,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,MAAM,OAAO,EAAE,CAAC,CAAA;SAC1E;QACD,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,SAAS,CAAE,OAAe,EAAE,iBAAyB;QAChE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,QAAQ,CAAA;QACnC,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAA;QAE3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE;YAC/C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SACrE;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAO/B,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,cAAc,CAAA;YAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,gBAAgB,CAAA;YACpD,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,MAAM,OAAO,EAAE,CAAC,CAAA;SACxE;QAED,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAA;IACH,CAAC;CACF"}