@bsv/sdk 1.4.0 → 1.4.2

package/dist/esm/src/registry/RegistryClient.js

@@ -0,0 +1,388 @@
+import { WalletClient } from '../wallet/index.js';
+import { Utils } from '../primitives/index.js';
+import { Transaction } from '../transaction/index.js';
+import { LookupResolver, TopicBroadcaster } from '../overlay-tools/index.js';
+import { PushDrop, LockingScript } from '../script/index.js';
+const REGISTRANT_TOKEN_AMOUNT = 1;
+/**
+ * RegistryClient manages on-chain registry definitions for three types:
+ * - BasketMap (basket-based items)
+ * - ProtoMap (protocol-based items)
+ * - CertMap (certificate-based items)
+ *
+ * It provides methods to:
+ * - Register new definitions using pushdrop-based UTXOs.
+ * - Resolve existing definitions using a overlay lookup service.
+ * - List registry entries associated with the operator's wallet.
+ * - Revoke an existing registry entry by spending its UTXO.
+ *
+ * Registry operators use this client to establish and manage
+ * canonical references for baskets, protocols, and certificates types.
+ */
+export class RegistryClient {
+    wallet;
+    network;
+    constructor(wallet = new WalletClient()) {
+        this.wallet = wallet;
+    }
+    /**
+     * Publishes a new on-chain definition for baskets, protocols, or certificates.
+     * The definition data is encoded in a pushdrop-based UTXO.
+     *
+     * Registry operators (i.e., identity key owners) can create these definitions
+     * to establish canonical references for basket IDs, protocol specs, or certificate schemas.
+     *
+     * @param data - The structured information needed to register an item of kind 'basket', 'protocol', or 'certificate'.
+     * @returns A promise with the broadcast result or failure.
+     */
+    async registerDefinition(data) {
+        const registryOperator = (await this.wallet.getPublicKey({ identityKey: true })).publicKey;
+        const pushdrop = new PushDrop(this.wallet);
+        // Build the array of fields, depending on the definition type
+        const fields = this.buildPushDropFields(data, registryOperator);
+        const protocol = this.getWalletProtocol(data.definitionType);
+        // Lock the fields
+        const lockingScript = await pushdrop.lock(fields, protocol, '1', 'self');
+        // Create a transaction
+        const { tx } = await this.wallet.createAction({
+            description: `Register a new ${data.definitionType} item`,
+            outputs: [
+                {
+                    satoshis: REGISTRANT_TOKEN_AMOUNT,
+                    lockingScript: lockingScript.toHex(),
+                    outputDescription: `New ${data.definitionType} registration token`
+                }
+            ]
+        });
+        if (tx === undefined) {
+            throw new Error(`Failed to create ${data.definitionType} registration transaction!`);
+        }
+        // Broadcast
+        const broadcaster = new TopicBroadcaster([this.getBroadcastTopic(data.definitionType)], {
+            networkPreset: this.network ??= (await (this.wallet.getNetwork({}))).network
+        });
+        return await broadcaster.broadcast(Transaction.fromAtomicBEEF(tx));
+    }
+    /**
+     * Resolves registrant tokens of a particular type using a lookup service.
+     *
+     * The query object shape depends on the registry type:
+     * - For "basket", the query is of type BasketMapQuery:
+     *   { basketID?: string; name?: string; registryOperators?: string[]; }
+     * - For "protocol", the query is of type ProtoMapQuery:
+     *   { name?: string; registryOperators?: string[]; protocolID?: string; securityLevel?: number; }
+     * - For "certificate", the query is of type CertMapQuery:
+     *   { type?: string; name?: string; registryOperators?: string[]; }
+     *
+     * @param definitionType - The registry type, which can be 'basket', 'protocol', or 'certificate'.
+     * @param query - The query object used to filter registry records, whose shape is determined by the registry type.
+     * @returns A promise that resolves to an array of matching registry records.
+     */
+    async resolve(definitionType, query) {
+        const resolver = new LookupResolver();
+        // The service name depends on the kind
+        const serviceName = this.getServiceName(definitionType);
+        const result = await resolver.query({
+            service: serviceName,
+            query
+        });
+        if (result.type !== 'output-list') {
+            return [];
+        }
+        const parsedRegistryRecords = [];
+        for (const output of result.outputs) {
+            try {
+                const parsedTx = Transaction.fromAtomicBEEF(output.beef);
+                const record = await this.parseLockingScript(definitionType, parsedTx.outputs[output.outputIndex].lockingScript);
+                parsedRegistryRecords.push(record);
+            }
+            catch {
+                // skip
+            }
+        }
+        return parsedRegistryRecords;
+    }
+    /**
+     * Lists the registry operator's published definitions for the given type.
+     *
+     * Returns parsed registry records including transaction details such as txid, outputIndex, satoshis, and the locking script.
+     *
+     * @param definitionType - The type of registry definition to list ('basket', 'protocol', or 'certificate').
+     * @returns A promise that resolves to an array of RegistryRecord objects.
+     */
+    async listOwnRegistryEntries(definitionType) {
+        const relevantBasketName = this.getBasketName(definitionType);
+        const { outputs } = await this.wallet.listOutputs({
+            basket: relevantBasketName,
+            include: 'locking scripts'
+        });
+        const results = [];
+        for (const output of outputs) {
+            if (output.spendable) {
+                continue;
+            }
+            try {
+                const record = await this.parseLockingScript(definitionType, LockingScript.fromHex(output.lockingScript));
+                const [txid, outputIndex] = output.outpoint.split('.');
+                results.push({
+                    ...record,
+                    txid,
+                    outputIndex: Number(outputIndex),
+                    satoshis: output.satoshis,
+                    lockingScript: output.lockingScript
+                });
+            }
+            catch {
+                // ignore parse errors
+            }
+        }
+        return results;
+    }
+    /**
+     * Revokes a registry record by spending its associated UTXO.
+     *
+     * This function creates a transaction that spends the UTXO corresponding to the provided registry record,
+     * revoking the registry entry. It prepares an unlocker using the appropriate wallet protocol,
+     * builds a signable transaction, signs it, and then broadcasts the finalized transaction.
+     *
+     * @param registryRecord - The registry record to revoke. It must include a valid txid, outputIndex, and lockingScript.
+     * @returns A promise that resolves with either a BroadcastResponse upon success or a BroadcastFailure on error.
+     * @throws If required fields are missing or if transaction creation/signing fails.
+     */
+    async revokeOwnRegistryEntry(registryRecord) {
+        if (registryRecord.txid === undefined || typeof registryRecord.outputIndex === 'undefined' || registryRecord.lockingScript === undefined) {
+            throw new Error('Invalid record. Missing txid, outputIndex, or lockingScript.');
+        }
+        // Prepare the unlocker
+        const pushdrop = new PushDrop(this.wallet);
+        const unlocker = await pushdrop.unlock(this.getWalletProtocol(registryRecord.definitionType), '1', 'anyone');
+        const itemIdentifier = registryRecord.definitionType === 'basket'
+            ? registryRecord.basketID
+            : registryRecord.definitionType === 'protocol'
+                ? registryRecord.name
+                : registryRecord.definitionType === 'certificate'
+                    ? (registryRecord.name !== undefined ? registryRecord.name : registryRecord.type)
+                    : 'unknown';
+        const description = `Revoke ${registryRecord.definitionType} item: ${String(itemIdentifier)}`;
+        // Create a new transaction that spends the UTXO
+        const outpoint = `${registryRecord.txid}.${registryRecord.outputIndex}`;
+        const { signableTransaction } = await this.wallet.createAction({
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            description,
+            inputs: [
+                {
+                    outpoint,
+                    unlockingScriptLength: 73,
+                    inputDescription: `Revoking ${registryRecord.definitionType} token`
+                }
+            ]
+        });
+        if (signableTransaction === undefined) {
+            throw new Error('Failed to create signable transaction.');
+        }
+        // Build a transaction object, sign with the unlock script
+        const tx = Transaction.fromBEEF(signableTransaction.tx);
+        const finalUnlockScript = await unlocker.sign(tx, registryRecord.outputIndex);
+        // Complete the signing
+        const { tx: signedTx } = await this.wallet.signAction({
+            reference: signableTransaction.reference,
+            spends: {
+                [registryRecord.outputIndex]: {
+                    unlockingScript: finalUnlockScript.toHex()
+                }
+            }
+        });
+        if (signedTx === undefined) {
+            throw new Error('Failed to finalize the transaction signature.');
+        }
+        // Broadcast
+        const broadcaster = new TopicBroadcaster([this.getBroadcastTopic(registryRecord.definitionType)], {
+            networkPreset: this.network ??= (await (this.wallet.getNetwork({}))).network
+        });
+        return await broadcaster.broadcast(Transaction.fromAtomicBEEF(signedTx));
+    }
+    // --------------------------------------------------------------------------
+    // INTERNAL HELPER METHODS
+    // --------------------------------------------------------------------------
+    buildPushDropFields(data, registryOperator) {
+        let fields;
+        switch (data.definitionType) {
+            case 'basket':
+                fields = [
+                    data.basketID,
+                    data.name,
+                    data.iconURL,
+                    data.description,
+                    data.documentationURL
+                ];
+                break;
+            case 'protocol':
+                fields = [
+                    data.securityLevel.toString(),
+                    data.protocolID,
+                    data.name,
+                    data.iconURL,
+                    data.description,
+                    data.documentationURL
+                ];
+                break;
+            case 'certificate':
+                fields = [
+                    data.type,
+                    data.name,
+                    data.iconURL,
+                    data.description,
+                    data.documentationURL,
+                    JSON.stringify(data.fields)
+                ];
+                break;
+            default:
+                throw new Error('Invalid registry kind specified');
+        }
+        // Append the registry operator to all cases.
+        fields.push(registryOperator);
+        return fields.map(field => Utils.toArray(field));
+    }
+    /**
+     * Decodes a pushdrop locking script for a given registry kind,
+     * returning a typed record with the appropriate fields.
+     */
+    async parseLockingScript(definitionType, lockingScript) {
+        const decoded = PushDrop.decode(lockingScript);
+        if (decoded.fields.length === 0) {
+            throw new Error('Not a valid registry pushdrop script.');
+        }
+        let registryOperator;
+        let data;
+        switch (definitionType) {
+            case 'basket': {
+                if (decoded.fields.length !== 6) {
+                    throw new Error('Unexpected field count for basket type.');
+                }
+                const [basketID, name, iconURL, description, docURL, operator] = decoded.fields;
+                registryOperator = Utils.toUTF8(operator);
+                data = {
+                    definitionType: 'basket',
+                    basketID: Utils.toUTF8(basketID),
+                    name: Utils.toUTF8(name),
+                    iconURL: Utils.toUTF8(iconURL),
+                    description: Utils.toUTF8(description),
+                    documentationURL: Utils.toUTF8(docURL)
+                };
+                break;
+            }
+            case 'protocol': {
+                if (decoded.fields.length !== 7) {
+                    throw new Error('Unexpected field count for proto type.');
+                }
+                const [securityLevel, protocolID, name, iconURL, description, docURL, operator] = decoded.fields;
+                registryOperator = Utils.toUTF8(operator);
+                data = {
+                    definitionType: 'protocol',
+                    securityLevel: parseInt(Utils.toUTF8(securityLevel), 10),
+                    protocolID: Utils.toUTF8(protocolID),
+                    name: Utils.toUTF8(name),
+                    iconURL: Utils.toUTF8(iconURL),
+                    description: Utils.toUTF8(description),
+                    documentationURL: Utils.toUTF8(docURL)
+                };
+                break;
+            }
+            case 'certificate': {
+                if (decoded.fields.length !== 7) {
+                    throw new Error('Unexpected field count for certificate type.');
+                }
+                const [certType, name, iconURL, description, docURL, fieldsJSON, operator] = decoded.fields;
+                registryOperator = Utils.toUTF8(operator);
+                let parsedFields;
+                try {
+                    parsedFields = JSON.parse(Utils.toUTF8(fieldsJSON));
+                }
+                catch {
+                    parsedFields = {};
+                }
+                data = {
+                    definitionType: 'certificate',
+                    type: Utils.toUTF8(certType),
+                    name: Utils.toUTF8(name),
+                    iconURL: Utils.toUTF8(iconURL),
+                    description: Utils.toUTF8(description),
+                    documentationURL: Utils.toUTF8(docURL),
+                    fields: parsedFields
+                };
+                break;
+            }
+            default:
+                throw new Error('Invalid registry kind for parsing.');
+        }
+        const currentIdentityKey = (await this.wallet.getPublicKey({ identityKey: true })).publicKey;
+        if (registryOperator !== currentIdentityKey) {
+            throw new Error('This registry token does not belong to the current wallet.');
+        }
+        return {
+            ...data,
+            registryOperator
+        };
+    }
+    /**
+     * Returns the (protocolID, keyID) used for pushdrop based on the registry kind.
+     */
+    getWalletProtocol(definitionType) {
+        switch (definitionType) {
+            case 'basket':
+                return [1, 'basketmap'];
+            case 'protocol':
+                return [1, 'protomap'];
+            case 'certificate':
+                return [1, 'certmap'];
+            default:
+                throw new Error(`Unknown registry type: ${definitionType}`);
+        }
+    }
+    /**
+     * Returns the name of the basket used by the wallet
+     */
+    getBasketName(definitionType) {
+        switch (definitionType) {
+            case 'basket':
+                return 'basketmap';
+            case 'protocol':
+                return 'protomap';
+            case 'certificate':
+                return 'certmap';
+            default:
+                throw new Error(`Unknown basket type: ${definitionType}`);
+        }
+    }
+    /**
+     * Returns the broadcast topic to be used with SHIPBroadcaster.
+     */
+    getBroadcastTopic(definitionType) {
+        switch (definitionType) {
+            case 'basket':
+                return 'tm_basketmap';
+            case 'protocol':
+                return 'tm_protomap';
+            case 'certificate':
+                return 'tm_certmap';
+            default:
+                throw new Error(`Unknown topic type: ${definitionType}`);
+        }
+    }
+    /**
+     * Returns the lookup service name to use.
+     */
+    getServiceName(definitionType) {
+        switch (definitionType) {
+            case 'basket':
+                return 'ls_basketmap';
+            case 'protocol':
+                return 'ls_protomap';
+            case 'certificate':
+                return 'ls_certmap';
+            default:
+                throw new Error(`Unknown service type: ${definitionType}`);
+        }
+    }
+}
+//# sourceMappingURL=RegistryClient.js.map

package/dist/esm/src/registry/RegistryClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RegistryClient.js","sourceRoot":"","sources":["../../../../src/registry/RegistryClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAGb,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,KAAK,EACN,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,WAAW,EAGZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,cAAc,EACd,gBAAgB,EACjB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,QAAQ,EACR,aAAa,EACd,MAAM,oBAAoB,CAAA;AAS3B,MAAM,uBAAuB,GAAG,CAAC,CAAA;AAEjC;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,cAAc;IAGN;IAFX,OAAO,CAAuB;IACtC,YACmB,SAA0B,IAAI,YAAY,EAAE;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAC3D,CAAC;IAEL;;;;;;;;;OASG;IACH,KAAK,CAAC,kBAAkB,CAAE,IAAoB;QAC5C,MAAM,gBAAgB,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QAC1F,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE1C,8DAA8D;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAA;QAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAE5D,kBAAkB;QAClB,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,CACvC,MAAM,EACN,QAAQ,EACR,GAAG,EACH,MAAM,CACP,CAAA;QAED,uBAAuB;QACvB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC5C,WAAW,EAAE,kBAAkB,IAAI,CAAC,cAAc,OAAO;YACzD,OAAO,EAAE;gBACP;oBACE,QAAQ,EAAE,uBAAuB;oBACjC,aAAa,EAAE,aAAa,CAAC,KAAK,EAAE;oBACpC,iBAAiB,EAAE,OAAO,IAAI,CAAC,cAAc,qBAAqB;iBACnE;aACF;SACF,CAAC,CAAA;QAEF,IAAI,EAAE,KAAK,SAAS,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,cAAc,4BAA4B,CAAC,CAAA;SACrF;QAED,YAAY;QAEZ,MAAM,WAAW,GAAG,IAAI,gBAAgB,CACtC,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,EAC7C;YACE,aAAa,EAAE,IAAI,CAAC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO;SAC7E,CACF,CAAA;QACD,OAAO,MAAM,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,OAAO,CACX,cAAiB,EACjB,KAA8B;QAE9B,MAAM,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAA;QAErC,uCAAuC;QACvC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAA;QACvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK;SACN,CAAC,CAAA;QAEF,IAAI,MAAM,CAAC,IAAI,KAAK,aAAa,EAAE;YACjC,OAAO,EAAE,CAAA;SACV;QAED,MAAM,qBAAqB,GAAqB,EAAE,CAAA;QAClD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE;YACnC,IAAI;gBACF,MAAM,QAAQ,GAAG,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;gBACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAA;gBAChH,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACnC;YAAC,MAAM;gBACN,OAAO;aACR;SACF;QACD,OAAO,qBAAqB,CAAA;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CAAE,cAA8B;QAC1D,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;QAC7D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAChD,MAAM,EAAE,kBAAkB;YAC1B,OAAO,EAAE,iBAAiB;SAC3B,CAAC,CAAA;QACF,MAAM,OAAO,GAAqB,EAAE,CAAA;QAEpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,MAAM,CAAC,SAAS,EAAE;gBACpB,SAAQ;aACT;YACD,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,aAAuB,CAAC,CAAC,CAAA;gBACnH,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACtD,OAAO,CAAC,IAAI,CAAC;oBACX,GAAG,MAAM;oBACT,IAAI;oBACJ,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;oBAChC,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,aAAa,EAAE,MAAM,CAAC,aAAuB;iBAC9C,CAAC,CAAA;aACH;YAAC,MAAM;gBACN,sBAAsB;aACvB;SACF;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sBAAsB,CAC1B,cAA8B;QAE9B,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,cAAc,CAAC,WAAW,KAAK,WAAW,IAAI,cAAc,CAAC,aAAa,KAAK,SAAS,EAAE;YACxI,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;SAChF;QAED,uBAAuB;QACvB,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC1C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,CACpC,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,cAAc,CAAC,EACrD,GAAG,EACH,QAAQ,CACT,CAAA;QAED,MAAM,cAAc,GAClB,cAAc,CAAC,cAAc,KAAK,QAAQ;YACxC,CAAC,CAAC,cAAc,CAAC,QAAQ;YACzB,CAAC,CAAC,cAAc,CAAC,cAAc,KAAK,UAAU;gBAC5C,CAAC,CAAC,cAAc,CAAC,IAAI;gBACrB,CAAC,CAAC,cAAc,CAAC,cAAc,KAAK,aAAa;oBAC/C,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC;oBACjF,CAAC,CAAC,SAAS,CAAA;QAEnB,MAAM,WAAW,GAAG,UAAU,cAAc,CAAC,cAAc,UAAU,MAAM,CAAC,cAAc,CAAC,EAAE,CAAA;QAE7F,gDAAgD;QAChD,MAAM,QAAQ,GAAG,GAAG,cAAc,CAAC,IAAI,IAAI,cAAc,CAAC,WAAW,EAAE,CAAA;QACvE,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC7D,4EAA4E;YAC5E,WAAW;YACX,MAAM,EAAE;gBACN;oBACE,QAAQ;oBACR,qBAAqB,EAAE,EAAE;oBACzB,gBAAgB,EAAE,YAAY,cAAc,CAAC,cAAc,QAAQ;iBACpE;aACF;SACF,CAAC,CAAA;QAEF,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;SAC1D;QAED,0DAA0D;QAC1D,MAAM,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAA;QACvD,MAAM,iBAAiB,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;QAE7E,uBAAuB;QACvB,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;YACpD,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,MAAM,EAAE;gBACN,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;oBAC5B,eAAe,EAAE,iBAAiB,CAAC,KAAK,EAAE;iBAC3C;aACF;SACF,CAAC,CAAA;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;SACjE;QAED,YAAY;QACZ,MAAM,WAAW,GAAG,IAAI,gBAAgB,CACtC,CAAC,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EACvD;YACE,aAAa,EAAE,IAAI,CAAC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO;SAC7E,CACF,CAAA;QACD,OAAO,MAAM,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED,6EAA6E;IAC7E,0BAA0B;IAC1B,6EAA6E;IAErE,mBAAmB,CACzB,IAAoB,EACpB,gBAAwB;QAExB,IAAI,MAAgB,CAAA;QAEpB,QAAQ,IAAI,CAAC,cAAc,EAAE;YAC3B,KAAK,QAAQ;gBACX,MAAM,GAAG;oBACP,IAAI,CAAC,QAAQ;oBACb,IAAI,CAAC,IAAI;oBACT,IAAI,CAAC,OAAO;oBACZ,IAAI,CAAC,WAAW;oBAChB,IAAI,CAAC,gBAAgB;iBACtB,CAAA;gBACD,MAAK;YACP,KAAK,UAAU;gBACb,MAAM,GAAG;oBACP,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE;oBAC7B,IAAI,CAAC,UAAU;oBACf,IAAI,CAAC,IAAI;oBACT,IAAI,CAAC,OAAO;oBACZ,IAAI,CAAC,WAAW;oBAChB,IAAI,CAAC,gBAAgB;iBACtB,CAAA;gBACD,MAAK;YACP,KAAK,aAAa;gBAChB,MAAM,GAAG;oBACP,IAAI,CAAC,IAAI;oBACT,IAAI,CAAC,IAAI;oBACT,IAAI,CAAC,OAAO;oBACZ,IAAI,CAAC,WAAW;oBAChB,IAAI,CAAC,gBAAgB;oBACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;iBAC5B,CAAA;gBACD,MAAK;YACP;gBACE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;SACrD;QAED,6CAA6C;QAC7C,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAE7B,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAClD,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,kBAAkB,CAC9B,cAA8B,EAC9B,aAA4B;QAE5B,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;QAC9C,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;SACzD;QAED,IAAI,gBAA2B,CAAA;QAC/B,IAAI,IAAoB,CAAA;QACxB,QAAQ,cAAc,EAAE;YACtB,KAAK,QAAQ,CAAC,CAAC;gBACb,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC/B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;iBAC3D;gBACD,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,CAAA;gBAC/E,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBACzC,IAAI,GAAG;oBACL,cAAc,EAAE,QAAQ;oBACxB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAChC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;oBACxB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;oBAC9B,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;oBACtC,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;iBACvC,CAAA;gBACD,MAAK;aACN;YACD,KAAK,UAAU,CAAC,CAAC;gBACf,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC/B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;iBAC1D;gBACD,MAAM,CACJ,aAAa,EACb,UAAU,EACV,IAAI,EACJ,OAAO,EACP,WAAW,EACX,MAAM,EACN,QAAQ,CACT,GAAG,OAAO,CAAC,MAAM,CAAA;gBAClB,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBACzC,IAAI,GAAG;oBACL,cAAc,EAAE,UAAU;oBAC1B,aAAa,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,CAAc;oBACrE,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;oBACpC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;oBACxB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;oBAC9B,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;oBACtC,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;iBACvC,CAAA;gBACD,MAAK;aACN;YACD,KAAK,aAAa,CAAC,CAAC;gBAClB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC/B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;iBAChE;gBACD,MAAM,CACJ,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,WAAW,EACX,MAAM,EACN,UAAU,EACV,QAAQ,CACT,GAAG,OAAO,CAAC,MAAM,CAAA;gBAElB,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBAEzC,IAAI,YAAwD,CAAA;gBAC5D,IAAI;oBACF,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;iBACpD;gBAAC,MAAM;oBACN,YAAY,GAAG,EAAE,CAAA;iBAClB;gBAED,IAAI,GAAG;oBACL,cAAc,EAAE,aAAa;oBAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC5B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;oBACxB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;oBAC9B,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;oBACtC,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;oBACtC,MAAM,EAAE,YAAY;iBACrB,CAAA;gBACD,MAAK;aACN;YACD;gBACE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACxD;QAED,MAAM,kBAAkB,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QAC5F,IAAI,gBAAgB,KAAK,kBAAkB,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;SAC9E;QAED,OAAO;YACL,GAAG,IAAI;YACP,gBAAgB;SACjB,CAAA;IACH,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAE,cAA8B;QACvD,QAAQ,cAAc,EAAE;YACtB,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,CAAA;YACzB,KAAK,UAAU;gBACb,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;YACxB,KAAK,aAAa;gBAChB,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;YACvB;gBACE,MAAM,IAAI,KAAK,CAAC,0BAA0B,cAAwB,EAAE,CAAC,CAAA;SACxE;IACH,CAAC;IAED;;OAEG;IACK,aAAa,CAAE,cAA8B;QACnD,QAAQ,cAAc,EAAE;YACtB,KAAK,QAAQ;gBACX,OAAO,WAAW,CAAA;YACpB,KAAK,UAAU;gBACb,OAAO,UAAU,CAAA;YACnB,KAAK,aAAa;gBAChB,OAAO,SAAS,CAAA;YAClB;gBACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,cAAwB,EAAE,CAAC,CAAA;SACtE;IACH,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAE,cAA8B;QACvD,QAAQ,cAAc,EAAE;YACtB,KAAK,QAAQ;gBACX,OAAO,cAAc,CAAA;YACvB,KAAK,UAAU;gBACb,OAAO,aAAa,CAAA;YACtB,KAAK,aAAa;gBAChB,OAAO,YAAY,CAAA;YACrB;gBACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,cAAwB,EAAE,CAAC,CAAA;SACrE;IACH,CAAC;IAED;;OAEG;IACK,cAAc,CAAE,cAA8B;QACpD,QAAQ,cAAc,EAAE;YACtB,KAAK,QAAQ;gBACX,OAAO,cAAc,CAAA;YACvB,KAAK,UAAU;gBACb,OAAO,aAAa,CAAA;YACtB,KAAK,aAAa;gBAChB,OAAO,YAAY,CAAA;YACrB;gBACE,MAAM,IAAI,KAAK,CAAC,yBAAyB,cAAwB,EAAE,CAAC,CAAA;SACvE;IACH,CAAC;CACF"}

package/dist/esm/src/registry/index.js

@@ -0,0 +1,3 @@
+export * from './RegistryClient.js';
+export * from './types/index.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/src/registry/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/registry/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA"}

package/dist/esm/src/registry/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/esm/src/registry/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/registry/types/index.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,75 @@
+import { LookupResolver } from '../overlay-tools/index.js';
+import { StorageUtils } from './index.js';
+import PushDrop from '../script/templates/PushDrop.js';
+import Transaction from '../transaction/Transaction.js';
+import { Hash, Utils } from '../primitives/index.js';
+/**
+ * Locates HTTP URLs where content can be downloaded. It uses the passed or the default one.
+ *
+ * @param {Object} obj All parameters are passed in an object.
+ * @param {String} obj.uhrpUrl The UHRP url to resolve.
+ * @param {string} obj.confederacyHost HTTPS URL for for the with default setting.
+ *
+ * @return {Array<String>} An array of HTTP URLs where content can be downloaded.
+ * @throws {Error} If UHRP url parameter invalid or is not an array
+ * or there is an error retrieving url(s) stored in the UHRP token.
+ */
+export class StorageDownloader {
+    networkPreset = 'mainnet';
+    constructor(config) {
+        this.networkPreset = config?.networkPreset;
+    }
+    async resolve(uhrpUrl) {
+        // Use UHRP lookup service
+        const lookupResolver = new LookupResolver({ networkPreset: this.networkPreset });
+        const response = await lookupResolver.query({ service: 'ls_uhrp', query: { uhrpUrl } });
+        if (response.type !== 'output-list') {
+            throw new Error('Lookup answer must be an output list');
+        }
+        const decodedResults = [];
+        for (let i = 0; i < response.outputs.length; i++) {
+            const tx = Transaction.fromBEEF(response.outputs[i].beef);
+            const { fields } = PushDrop.decode(tx.outputs[response.outputs[i].outputIndex].lockingScript);
+            decodedResults.push(Utils.toUTF8(fields[2]));
+        }
+        return decodedResults;
+    }
+    async download(uhrpUrl) {
+        if (!StorageUtils.isValidURL(uhrpUrl)) {
+            throw new Error('Invalid parameter UHRP url');
+        }
+        const hash = StorageUtils.getHashFromURL(uhrpUrl);
+        const downloadURLs = await this.resolve(uhrpUrl);
+        if (!Array.isArray(downloadURLs) || downloadURLs.length === 0) {
+            throw new Error('No one currently hosts this file!');
+        }
+        for (let i = 0; i < downloadURLs.length; i++) {
+            try {
+                // The url is fetched
+                const result = await fetch(downloadURLs[i], { method: 'GET' });
+                // If the request fails, continue to the next url
+                if (!result.ok || result.status >= 400) {
+                    continue;
+                }
+                const body = await result.arrayBuffer();
+                // The body is loaded into a number array
+                const content = [...new Uint8Array(body)];
+                const contentHash = Hash.sha256(content);
+                for (let i = 0; i < contentHash.length; ++i) {
+                    if (contentHash[i] !== hash[i]) {
+                        throw new Error('Value of content does not match hash of the url given');
+                    }
+                }
+                return {
+                    data: content,
+                    mimeType: result.headers.get('Content-Type')
+                };
+            }
+            catch (error) {
+                continue;
+            }
+        }
+        throw new Error(`Unable to download content from ${uhrpUrl}`);
+    }
+}
+//# sourceMappingURL=StorageDownloader.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageDownloader.js","sourceRoot":"","sources":["../../../../src/storage/StorageDownloader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,QAAQ,MAAM,iCAAiC,CAAA;AACtD,OAAO,WAAW,MAAM,+BAA+B,CAAA;AACvD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAWpD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,iBAAiB;IACX,aAAa,GAAqC,SAAS,CAAA;IAE5E,YAAa,MAAyB;QACpC,IAAI,CAAC,aAAa,GAAG,MAAM,EAAE,aAAa,CAAA;IAC5C,CAAC;IAEM,KAAK,CAAC,OAAO,CAAE,OAAe;QACnC,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;QAChF,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;QACvF,IAAI,QAAQ,CAAC,IAAI,KAAK,aAAa,EAAE;YACnC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;SACxD;QACD,MAAM,cAAc,GAAa,EAAE,CAAA;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAChD,MAAM,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YACzD,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAA;YAC7F,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;SAC7C;QACD,OAAO,cAAc,CAAA;IACvB,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAE,OAAe;QACpC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;SAC9C;QACD,MAAM,IAAI,GAAG,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QACjD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAEhD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;SACrD;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5C,IAAI;gBACF,qBAAqB;gBACrB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;gBAE9D,iDAAiD;gBACjD,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE;oBACtC,SAAQ;iBACT;gBACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAA;gBAEvC,yCAAyC;gBACzC,MAAM,OAAO,GAAa,CAAC,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;gBACnD,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;oBAC3C,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE;wBAC9B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;qBACzE;iBACF;gBAED,OAAO;oBACL,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;iBAC7C,CAAA;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,SAAQ;aACT;SACF;QACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,OAAO,EAAE,CAAC,CAAA;IAC/D,CAAC;CACF"}

package/dist/esm/src/storage/__test/StorageDownloader.test.js

@@ -0,0 +1,139 @@
+import { StorageDownloader } from '../StorageDownloader.js';
+import { StorageUtils } from '../index.js';
+import { LookupResolver } from '../../overlay-tools/index.js';
+import Transaction from '../../transaction/Transaction.js';
+import PushDrop from '../../script/templates/PushDrop.js';
+import { Utils } from '../../primitives/index.js';
+beforeEach(() => {
+    jest.restoreAllMocks();
+});
+describe('StorageDownloader', () => {
+    let downloader;
+    beforeEach(() => {
+        // Create a fresh instance
+        downloader = new StorageDownloader();
+    });
+    describe('resolve()', () => {
+        it('throws if the lookup response is not "output-list"', async () => {
+            // Mock the LookupResolver to return something invalid
+            jest.spyOn(LookupResolver.prototype, 'query').mockResolvedValue({
+                type: 'something-else',
+                outputs: []
+            });
+            await expect(downloader.resolve('fakeUhrpUrl'))
+                .rejects
+                .toThrow('Lookup answer must be an output list');
+        });
+        it('decodes each output with Transaction.fromBEEF and PushDrop.decode', async () => {
+            // 1) Mock lookup response
+            jest.spyOn(LookupResolver.prototype, 'query').mockResolvedValue({
+                type: 'output-list',
+                outputs: [
+                    { beef: 'fake-beef-a', outputIndex: 0 },
+                    { beef: 'fake-beef-b', outputIndex: 1 }
+                ]
+            });
+            // 2) Mock Transaction.fromBEEF -> returns a dummy transaction
+            jest.spyOn(Transaction, 'fromBEEF').mockImplementation(() => {
+                // Each transaction might have multiple outputs; we only care about `outputIndex`
+                return {
+                    outputs: [
+                        { lockingScript: {} },
+                        { lockingScript: {} } // index 1
+                    ]
+                };
+            });
+            // 3) Mock PushDrop.decode -> returns { fields: number[][] }
+            jest.spyOn(PushDrop, 'decode').mockImplementation(() => {
+                // The decode function returns an object with `fields`,
+                return {
+                    lockingPublicKey: {},
+                    fields: [
+                        [11],
+                        [22],
+                        [104, 116, 116, 112, 58, 47, 47, 97, 46, 99, 111, 109]
+                    ]
+                };
+            });
+            // 4) Mock Utils.toUTF8 to convert that number[] to a string
+            jest.spyOn(Utils, 'toUTF8').mockReturnValue('http://a.com');
+            const resolved = await downloader.resolve('fakeUhrpUrl');
+            expect(resolved).toEqual(['http://a.com', 'http://a.com']);
+        });
+    });
+    describe('download()', () => {
+        it('throws if UHRP URL is invalid', async () => {
+            jest.spyOn(StorageUtils, 'isValidURL').mockReturnValue(false);
+            await expect(downloader.download('invalidUrl'))
+                .rejects
+                .toThrow('Invalid parameter UHRP url');
+        });
+        it('throws if no hosts are found', async () => {
+            // Valid UHRP URL
+            jest.spyOn(StorageUtils, 'isValidURL').mockReturnValue(true);
+            // Return some random 32-byte hash so we can pass the check
+            jest.spyOn(StorageUtils, 'getHashFromURL').mockReturnValue(new Array(32).fill(0));
+            // Force resolve() to return an empty array
+            jest.spyOn(downloader, 'resolve').mockResolvedValue([]);
+            await expect(downloader.download('validButUnhostedUrl'))
+                .rejects
+                .toThrow('No one currently hosts this file!');
+        });
+        it('downloads successfully from the first working host', async () => {
+            jest.spyOn(StorageUtils, 'isValidURL').mockReturnValue(true);
+            const knownHash = [
+                102, 104, 122, 173, 248, 98, 189, 119, 108, 143,
+                193, 139, 142, 159, 142, 32, 8, 151, 20, 133,
+                110, 226, 51, 179, 144, 42, 89, 29, 13, 95,
+                41, 37
+            ];
+            jest.spyOn(StorageUtils, 'getHashFromURL').mockReturnValue(knownHash);
+            // Suppose two possible download URLs
+            jest.spyOn(downloader, 'resolve').mockResolvedValue([
+                'http://host1/404',
+                'http://host2/ok'
+            ]);
+            // The first fetch -> 404, second fetch -> success
+            const fetchSpy = jest.spyOn(global, 'fetch')
+                .mockResolvedValueOnce(new Response(null, { status: 404 }))
+                .mockResolvedValueOnce(new Response(new Uint8Array(32).fill(0), {
+                status: 200,
+                headers: { 'Content-Type': 'application/test' }
+            }));
+            const result = await downloader.download('validUrl');
+            expect(fetchSpy).toHaveBeenCalledTimes(2);
+            expect(result).toEqual({
+                data: new Array(32).fill(0),
+                mimeType: 'application/test'
+            });
+        });
+        it('throws if content hash mismatches the UHRP hash', async () => {
+            jest.spyOn(StorageUtils, 'isValidURL').mockReturnValue(true);
+            // The expected hash is all zeros
+            jest.spyOn(StorageUtils, 'getHashFromURL').mockReturnValue(new Array(32).fill(0));
+            // One potential host
+            jest.spyOn(downloader, 'resolve').mockResolvedValue([
+                'http://bad-content.test'
+            ]);
+            // The fetch returns 32 bytes of all 1's => hash mismatch
+            jest.spyOn(global, 'fetch').mockResolvedValue(new Response(new Uint8Array(32).fill(1), { status: 200 }));
+            await expect(downloader.download('validButBadHashUrl'))
+                .rejects
+                .toThrow();
+        });
+        it('throws if all hosts fail or mismatch', async () => {
+            jest.spyOn(StorageUtils, 'isValidURL').mockReturnValue(true);
+            jest.spyOn(StorageUtils, 'getHashFromURL').mockReturnValue(new Array(32).fill(0));
+            jest.spyOn(downloader, 'resolve').mockResolvedValue([
+                'http://host1.test',
+                'http://host2.test'
+            ]);
+            // Both fetches fail with 500 or something >=400
+            jest.spyOn(global, 'fetch').mockResolvedValue(new Response(null, { status: 500 }));
+            await expect(downloader.download('validButNoGoodHostUrl'))
+                .rejects
+                .toThrow('Unable to download content from validButNoGoodHostUrl');
+        });
+    });
+});
+//# sourceMappingURL=StorageDownloader.test.js.map

package/dist/esm/src/storage/__test/StorageDownloader.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageDownloader.test.js","sourceRoot":"","sources":["../../../../../src/storage/__test/StorageDownloader.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,WAAW,MAAM,kCAAkC,CAAA;AAC1D,OAAO,QAAQ,MAAM,oCAAoC,CAAA;AAEzD,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;AAEjD,UAAU,CAAC,GAAG,EAAE;IACZ,IAAI,CAAC,eAAe,EAAE,CAAA;AAC1B,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,IAAI,UAA6B,CAAA;IAEjC,UAAU,CAAC,GAAG,EAAE;QACZ,0BAA0B;QAC1B,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAA;IACxC,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YAChE,sDAAsD;YACtD,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,iBAAiB,CAAC;gBAC5D,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,EAAE;aACP,CAAC,CAAA;YAET,MAAM,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;iBAC1C,OAAO;iBACP,OAAO,CAAC,sCAAsC,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YAC/E,0BAA0B;YAC1B,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,iBAAiB,CAAC;gBAC5D,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE;oBACL,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,EAAE;oBACvC,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,EAAE;iBAC1C;aACG,CAAC,CAAA;YAET,8DAA8D;YAC9D,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBACxD,iFAAiF;gBACjF,OAAO;oBACH,OAAO,EAAE;wBACL,EAAE,aAAa,EAAE,EAAE,EAAE;wBACrB,EAAE,aAAa,EAAE,EAAE,EAAE,CAAE,UAAU;qBACpC;iBACG,CAAA;YACZ,CAAC,CAAC,CAAA;YAEF,4DAA4D;YAC5D,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBACnD,uDAAuD;gBACvD,OAAO;oBACH,gBAAgB,EAAE,EAAe;oBACjC,MAAM,EAAE;wBACJ,CAAC,EAAE,CAAC;wBACJ,CAAC,EAAE,CAAC;wBACJ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC;qBACzD;iBACJ,CAAA;YACL,CAAC,CAAC,CAAA;YAEF,4DAA4D;YAC5D,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,eAAe,CAAC,cAAc,CAAC,CAAA;YAE3D,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;YACxD,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAA;QAC9D,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC3C,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;YAE7D,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;iBAC1C,OAAO;iBACP,OAAO,CAAC,4BAA4B,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC1C,iBAAiB;YACjB,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;YAC5D,2DAA2D;YAC3D,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;YAEjF,2CAA2C;YAC3C,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAA;YAEvD,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;iBACnD,OAAO;iBACP,OAAO,CAAC,mCAAmC,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YAChE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;YAC5D,MAAM,SAAS,GAAG;gBACd,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;gBAC/C,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG;gBAC5C,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;gBAC1C,EAAE,EAAE,EAAE;aACP,CAAA;YACH,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;YAErE,qCAAqC;YACrC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,iBAAiB,CAAC;gBAChD,kBAAkB;gBAClB,iBAAiB;aACpB,CAAC,CAAA;YAEF,kDAAkD;YAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC;iBACvC,qBAAqB,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;iBAC1D,qBAAqB,CAAC,IAAI,QAAQ,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;gBAC5D,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;aAClD,CAAC,CAAC,CAAA;YAEP,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACpD,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACnB,IAAI,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3B,QAAQ,EAAE,kBAAkB;aAC/B,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC7D,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;YAC5D,iCAAiC;YACjC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;YAEjF,qBAAqB;YACrB,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,iBAAiB,CAAC;gBAChD,yBAAyB;aAC5B,CAAC,CAAA;YAEF,yDAAyD;YACzD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,iBAAiB,CACzC,IAAI,QAAQ,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAC5D,CAAA;YAED,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;iBAClD,OAAO;iBACP,OAAO,EAAE,CAAA;QAClB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YAClD,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;YAC5D,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;YAEjF,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,iBAAiB,CAAC;gBAChD,mBAAmB;gBACnB,mBAAmB;aACtB,CAAC,CAAA;YAEF,gDAAgD;YAChD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,iBAAiB,CACzC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CACtC,CAAA;YAED,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;iBACrD,OAAO;iBACP,OAAO,CAAC,uDAAuD,CAAC,CAAA;QACzE,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}