@qrkit/bc-ur 2.0.0-beta.9-qrkit.1

package/dist/esm/classes/FountainDecoder.js

@@ -0,0 +1,447 @@
+import { difference, isSubset } from "../helpers/utils.js";
+import { concatUint8Arrays, isUint8Array } from "../helpers/uintArrayHelper.js";
+import { InvalidChecksumError } from "../errors.js";
+import { chooseFragments } from "../helpers/fountainUtils.js";
+import { arrayContains, arraysEqual, bufferXOR, getCRC, setDifference } from "../helpers/utils.js";
+import { CborEncoding } from "../encodingMethods/CborEncoding.js";
+const cborEncoder = new CborEncoding();
+class FountainBlock {
+    _indexes;
+    _fragment;
+    constructor(_indexes, _fragment) {
+        this._indexes = _indexes;
+        this._fragment = _fragment;
+    }
+    /** What blocks is mixed in this block */
+    get indexes() {
+        return this._indexes;
+    }
+    /** Data */
+    get fragment() {
+        return this._fragment;
+    }
+    isSimple() {
+        return this.indexes.length === 1;
+    }
+    isSubsetOf(other) {
+        // Dont use set use array
+        // return isSubset(new Set(this.indexes), new Set(other.indexes));
+        return arrayContains(other.indexes, this.indexes);
+    }
+    isSupersetOf(other) {
+        // return isSubset(new Set(other.indexes), new Set(this.indexes));
+        return arrayContains(this.indexes, other.indexes);
+    }
+    reduceBy(other) {
+        // Check if the other block is a subset of this block
+        if (!this.isSupersetOf(other)) {
+            return this;
+        }
+        // Otherwise reduce the other block from this block
+        // const newIndexes = difference(new Set(this.indexes), new Set(other.indexes));
+        const newIndexes = setDifference(this.indexes, other.indexes);
+        const newFragment = bufferXOR(this.fragment, other.fragment);
+        return new FountainBlock([...newIndexes], newFragment);
+    }
+}
+export class FountainDecoder {
+    /** Did we received any parts and started decoding */
+    started = false;
+    done = false;
+    /** Stores the error if decoding fauls */
+    error;
+    /** Stores the decoded data*/
+    resultRaw = undefined;
+    /** Stores the expected length of the final message */
+    expectedMessageLength = 0;
+    /** Stores the expected checksum of the final message */
+    expectedChecksum = 0;
+    /** Stores the expected message length of each fragment */
+    expectedFragmentLength = 0;
+    /** Total number of simple fragments */
+    expectedPartCount = 0;
+    /** Mixed Parts that we cannot reduce to simple parts yet */
+    mixedBlocks = [];
+    /** Non-mixed single parts */
+    simpleBlocks = [];
+    /** Queue of parts that may take part in reduction */
+    queuedBlocks = [];
+    // For tracking the progress of decoding we can keep seen indexes and decoded indexes
+    /** Bitmap array of seen block */
+    seenBlocks = [];
+    /** Bitmap array of decoded blocks */
+    decodedBlocks = [];
+    /** Keeps track of the how many parts have been processed */
+    processedPartsCount = 0;
+    get result() {
+        return this.resultRaw || this.error;
+    }
+    isSuccessful() {
+        return this.done && !this.error;
+    }
+    isComplete() {
+        return this.done;
+    }
+    constructor(parts = []) {
+        parts.forEach((part) => this.receivePart(part));
+    }
+    reset() {
+        this.error = undefined;
+        this.resultRaw = undefined;
+        this.expectedMessageLength = 0;
+        this.expectedChecksum = 0;
+        this.expectedFragmentLength = 0;
+        this.mixedBlocks = [];
+        this.simpleBlocks = [];
+        this.queuedBlocks = [];
+        this.seenBlocks = [];
+        this.decodedBlocks = [];
+        this.processedPartsCount = 0;
+    }
+    setExpectedValues(decodedPart) {
+        this.expectedPartCount = decodedPart.seqLength;
+        this.expectedMessageLength = decodedPart.messageLength;
+        this.expectedChecksum = decodedPart.checksum;
+        this.expectedFragmentLength = decodedPart.fragment.length;
+        this.seenBlocks = new Array(this.expectedPartCount).fill(0);
+        this.decodedBlocks = new Array(this.expectedPartCount).fill(0);
+        // Set started so we know we have expected values
+        this.started = true;
+        this.done = false;
+    }
+    /**
+     * Set the expected values on the initial run the current decoder.
+     * And check if the next multipart ur is a 'member' of the originally scanned ur with the current decoder.
+     * @param decodedPart received multipart ur
+     * @returns boolean indicating if the multipart ur is a 'member' of the originally scanned ur with the current decoder.
+     */
+    validatePart(decodedPart) {
+        // If this part's values don't match the first part's values, throw away the part
+        if (this.expectedPartCount !== decodedPart.seqLength) {
+            // TODO: display proper error message
+            return false;
+        }
+        if (this.expectedMessageLength !== decodedPart.messageLength) {
+            return false;
+        }
+        if (this.expectedChecksum !== decodedPart.checksum) {
+            return false;
+        }
+        if (this.expectedFragmentLength !== decodedPart.fragment.length) {
+            return false;
+        }
+        // This part should be processed
+        return true;
+    }
+    finalize() {
+        if (this.simpleBlocks.length !== this.expectedPartCount) {
+            console.warn("Not all parts have been received");
+            return;
+        }
+        // Sort the simple blocks by their index
+        const sortedParts = [...this.simpleBlocks].sort((a, b) => a.indexes[0] - b.indexes[0]);
+        // Get fragments in order and combine them to message
+        const message = joinFragments(sortedParts.map((p) => p.fragment), this.expectedMessageLength);
+        // Get the final checksum
+        const checksum = getCRC(message);
+        if (checksum === this.expectedChecksum) {
+            this.resultRaw = message;
+        }
+        else {
+            this.error = new InvalidChecksumError();
+        }
+        this.done = true;
+    }
+    parseInput(input) {
+        // Check the type of input payload
+        if (input instanceof Uint8Array) {
+            return parseMultipartCbor(input);
+        }
+        else if (typeof input === "object") {
+            // Check its correct type
+            if (!validateMultipartPayload(input)) {
+                throw new Error("Invalid multipart payload");
+            }
+            return input;
+        }
+        throw new Error("Invalid input type");
+    }
+    receivePart(encodedPart) {
+        // If we already have a result, we're done
+        if (this.done) {
+            return false;
+        }
+        let decodedPart;
+        try {
+            decodedPart = this.parseInput(encodedPart);
+        }
+        catch (error) {
+            // Skip receiving invalid parts
+            console.warn("Cannot parse part", error);
+            return false;
+        }
+        try {
+            // If this is the first part we've seen then set expected values
+            if (!this.started)
+                this.setExpectedValues(decodedPart);
+            // Validate part
+            if (!this.validatePart(decodedPart)) {
+                return false;
+            }
+            // Now we can start processing the part
+            // Find which original data fragments are in this fragment what is mixed in this
+            let indexes = chooseFragments(decodedPart.seqNum, decodedPart.seqLength, decodedPart.checksum);
+            // order the indexes
+            indexes = indexes.sort((a, b) => a - b);
+            // Get the data
+            const fragment = decodedPart.fragment;
+            const block = new FountainBlock(indexes, fragment);
+            this.queuedBlocks.push(block);
+            this.processQueue();
+            this.processedPartsCount += 1;
+        }
+        catch (error) {
+            // Skip receiving invalid parts
+            console.warn("Error receiving part", error);
+            return false;
+        }
+        return true;
+    }
+    // http://blog.notdot.net/2012/01/Damn-Cool-Algorithms-Fountain-Codes
+    processQueue() {
+        // Process the queued blocks until queue is empty or we're done
+        while (!this.done && this.queuedBlocks.length > 0) {
+            const block = this.queuedBlocks.shift();
+            // Add indexes to seen indexes
+            block.indexes.forEach((index) => {
+                this.seenBlocks[index] = 1;
+            });
+            if (block.isSimple()) {
+                this.processSimpleBlock(block);
+            }
+            else {
+                this.processMixedBlock(block);
+            }
+        }
+    }
+    /**
+     * Process a "pure" fragment. this is a original fragment that is not mixed with any other fragments.
+     * @param block object with the indexes and the fragment payload buffer.
+     * @returns
+     */
+    processSimpleBlock(block) {
+        if (!block.isSimple()) {
+            throw new Error("Part is not simple");
+        }
+        // Don't process duplicate blocks
+        // if (this.simpleBlocks.has(block.indexes)) return;
+        if (this.simpleBlocks.some((b) => arraysEqual(b.indexes, block.indexes)))
+            return;
+        // Add our block to simple blocks
+        this.simpleBlocks.push(block);
+        // Keep track of the decoded blocks
+        this.decodedBlocks[block.indexes[0]] = 1;
+        // If we've received all the parts
+        if (this.simpleBlocks.length == this.expectedPartCount) {
+            this.finalize();
+        }
+        else {
+            // Otherwise try to reduce the all the mixed parts by this simple part
+            this.reduceAllMixedBlocksBy(block);
+        }
+    }
+    /**
+     * Process the mixed parts
+     * @param newPart
+     * @returns
+     */
+    processMixedBlock(newPart) {
+        // Check if already have this block, if so pass
+        // if (this.mixedBlocks.has(newPart.indexes)) {
+        //   return;
+        // }
+        if (this.mixedBlocks.some((b) => arraysEqual(b.indexes, newPart.indexes))) {
+            return;
+        }
+        // Get all simple blocks that we have that makes up this part and reduce current block by whatever we have
+        let reducedBlock = this.simpleBlocks.reduce((proccessed, currentSimple) => proccessed.reduceBy(currentSimple), newPart);
+        // Now check if we have a simple part if so add it to the queue
+        if (reducedBlock.isSimple()) {
+            this.queuedBlocks.push(reducedBlock);
+            return;
+        }
+        // We still have have a mixed block
+        // So we will check if there are any subsets of this block that we can reduce
+        // So if we have 1x2x3 try to find subparts (1x2, 2x3, 1x3) that will directly reduce this part to simple part
+        // For now we will go though all the parts and try to reduce them so if we have 1x2x3x4 XOR 1x2 we will get 3x4
+        reducedBlock = this.mixedBlocks.reduce((proccessed, currentMixed) => proccessed.reduceBy(currentMixed), reducedBlock);
+        // If after all the operations we have a simple part add it to the queue
+        if (reducedBlock.isSimple()) {
+            this.queuedBlocks.push(reducedBlock);
+            return;
+        }
+        // If we dont have a simple part we will try to reduce all the mixed parts by this part
+        this.reduceAllMixedBlocksBy(reducedBlock);
+        // Then add our part to the mixed parts
+        this.mixedBlocks.push(reducedBlock);
+    }
+    /**
+     * Process all the mixed blocks by the given block
+     * If the mixed part can be reduced to a simple part, add it to the queue
+     * If a mixed part is reduced to simpler part add it to the mixed
+     * @param block
+     */
+    reduceAllMixedBlocksBy(block) {
+        const newMixed = [];
+        // Try to reduce all the mixed parts by this simple part
+        this.mixedBlocks
+            .map((mixedPart) => mixedPart.reduceBy(block))
+            .forEach((reducedPart) => {
+            if (reducedPart.isSimple()) {
+                // Add to the queue if it is a simple part
+                this.queuedBlocks.push(reducedPart);
+            }
+            else {
+                // Otherwise add it to as a new mixed part
+                newMixed.push(reducedPart);
+            }
+        });
+        // Override the mixed parts with new reduces parts
+        this.mixedBlocks = newMixed;
+    }
+    /**
+     *
+     *
+     * The next part it receives is 3: A ⊕ B ⊕ C ⊕ D.
+     * Each time a part is received, the decoder checks to see whether the set of fragments it contains
+     *  is a proper subset or superset of the set of fragments in any part is has received.
+     *  If so, it can reduce the superset part by the subset part. In this case,
+     *  it discovers it can reduce the incoming part 3: A ⊕ B ⊕ C ⊕ D by XORing it with part 1: A ⊕ B ⊕ C,
+     *  yielding the simple part 3: D.
+     */
+    /**
+     *
+     * Try the reduce mixed part A by the part B
+     * If B is a subset of A then we can reduce A by B
+     * Otherwise return A
+     *
+     * @param a existing mixedpart
+     * @param b newly received mixedpart
+     * @returns
+     */
+    reducePartByPart_(a, b) {
+        // If the fragments mixed into `b` are a strict (proper) subset of those in `a`...
+        const aSet = new Set(a.indexes);
+        const bSet = new Set(b.indexes);
+        // If B is a subset of A then we can reduce A by B
+        if (isSubset(bSet, aSet)) {
+            // A - B => new indexes in the mixed part
+            const newIndexes = difference(aSet, bSet);
+            const newFragment = bufferXOR(a.fragment, b.fragment);
+            return new FountainBlock([...newIndexes], newFragment);
+        }
+        // If A is a subset of B then we can reduce B by A
+        // else if (isSubset(aSet, bSet)) {
+        //   // B - A => new indexes in the mixed part
+        //   const newIndexes = difference(bSet, aSet);
+        //   const newFragment = bufferXOR(b.fragment, a.fragment);
+        //   return new FountainEncodedPart([...newIndexes], newFragment);
+        // }
+        else {
+            // If A is not reducable by B then return A
+            return a;
+        }
+    }
+    reducePartByPart(a, b) {
+        // If the fragments mixed into `b` are a strict (proper) subset of those in `a`...
+        if (arrayContains(a.indexes, b.indexes)) {
+            const newIndexes = setDifference(a.indexes, b.indexes);
+            const newFragment = bufferXOR(a.fragment, b.fragment);
+            return new FountainBlock(newIndexes, newFragment);
+        }
+        else {
+            // `a` is not reducable by `b`, so return a
+            return a;
+        }
+    }
+    estimatedPercentComplete() {
+        if (this.done) {
+            return 1;
+        }
+        const expectedPartCount = this.expectedPartCount;
+        if (expectedPartCount === 0) {
+            return 0;
+        }
+        // We multiply the expectedPartCount by `1.75` as a way to compensate for the facet
+        // that `this.processedPartsCount` also tracks the duplicate parts that have been
+        // processeed.
+        return Math.min(0.99, this.processedPartsCount / (expectedPartCount * 1.75));
+    }
+    getProgress() {
+        if (this.done) {
+            return 1;
+        }
+        const expectedPartCount = this.expectedPartCount;
+        if (expectedPartCount === 0) {
+            return 0;
+        }
+        return this.simpleBlocks.length / expectedPartCount;
+    }
+    getDecodedData() {
+        if (!this.isSuccessful()) {
+            console.log('Fountain decoding was not successful');
+            return undefined;
+        }
+        return cborEncoder.decode(this.resultRaw);
+    }
+    getError() {
+        return this.error;
+    }
+}
+/**
+ * Parse CBOR encoded Multipart Payload
+ * @param encodeded
+ * @returns
+ */
+export function parseMultipartCbor(encodeded) {
+    const decoded = cborEncoder.decode(encodeded);
+    return validateDecodedMultipart(decoded);
+}
+/**
+ * Validate and convert the decoded multipart payload to MultipartPayload object
+ * @param decoded
+ * @returns
+ */
+export function validateDecodedMultipart(decoded) {
+    const [seqNum, seqLength, messageLength, checksum, fragment] = decoded;
+    if (!validateMultipartPayload({ seqNum, seqLength, messageLength, checksum, fragment })) {
+        throw new Error("Invalid  multipart payload");
+    }
+    return { seqNum, seqLength, messageLength, checksum, fragment };
+}
+function validateMultipartPayload(decoded) {
+    if (typeof decoded.seqNum !== "number" ||
+        typeof decoded.seqLength !== "number" ||
+        typeof decoded.messageLength !== "number" ||
+        typeof decoded.checksum !== "number" ||
+        !isUint8Array(decoded.fragment) ||
+        decoded.fragment.length === 0) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Join the fragments together.
+ * @param fragments fragments to join
+ * @param messageLength length of the expected message, full if not provided.
+ * @returns the concatenated fragments with the expected length.
+ */
+function joinFragments(fragments, messageLength) {
+    let result = concatUint8Arrays(fragments);
+    if (messageLength) {
+        // with 'slice', we remove the additionally created buffer parts, needed to achieve the minimum fragment length.
+        result = result.slice(0, messageLength);
+    }
+    return result;
+}
+//# sourceMappingURL=FountainDecoder.js.map

package/dist/esm/classes/FountainDecoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FountainDecoder.js","sourceRoot":"","sources":["../../../src/classes/FountainDecoder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAEhF,OAAO,EAAE,oBAAoB,EAAsB,MAAM,cAAc,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEnG,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,MAAM,WAAW,GAAG,IAAI,YAAY,EAAE,CAAC;AAUvC,MAAM,aAAa;IACK;IAA8B;IAApD,YAAsB,QAAkB,EAAY,SAAqB;QAAnD,aAAQ,GAAR,QAAQ,CAAU;QAAY,cAAS,GAAT,SAAS,CAAY;IAAG,CAAC;IAC7E,yCAAyC;IACzC,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,WAAW;IACX,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;IACnC,CAAC;IAEM,UAAU,CAAC,KAAoB;QACpC,yBAAyB;QACzB,kEAAkE;QAClE,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAEM,YAAY,CAAC,KAAoB;QACtC,kEAAkE;QAClE,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAEM,QAAQ,CAAC,KAAoB;QAClC,qDAAqD;QACrD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,mDAAmD;QACnD,gFAAgF;QAChF,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE7D,OAAO,IAAI,aAAa,CAAC,CAAC,GAAG,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;CACF;AAGD,MAAM,OAAO,eAAe;IAC1B,qDAAqD;IAC9C,OAAO,GAAY,KAAK,CAAC;IACzB,IAAI,GAAY,KAAK,CAAC;IAE7B,yCAAyC;IAC/B,KAAK,CAAoB;IACnC,6BAA6B;IACnB,SAAS,GAA2B,SAAS,CAAC;IAExD,sDAAsD;IAC5C,qBAAqB,GAAW,CAAC,CAAC;IAC5C,wDAAwD;IAC9C,gBAAgB,GAAW,CAAC,CAAC;IACvC,0DAA0D;IAChD,sBAAsB,GAAW,CAAC,CAAC;IAC7C,uCAAuC;IAC7B,iBAAiB,GAAW,CAAC,CAAC;IAExC,4DAA4D;IAClD,WAAW,GAAoB,EAAE,CAAC;IAC5C,6BAA6B;IACnB,YAAY,GAAoB,EAAE,CAAC;IAC7C,qDAAqD;IAC3C,YAAY,GAAoB,EAAE,CAAC;IAE7C,qFAAqF;IACrF,iCAAiC;IAC1B,UAAU,GAAa,EAAE,CAAC;IACjC,qCAAqC;IAC9B,aAAa,GAAa,EAAE,CAAC;IACpC,4DAA4D;IAClD,mBAAmB,GAAW,CAAC,CAAC;IAE1C,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC;IACtC,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,YAAY,QAAsB,EAAE;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,sBAAsB,GAAG,CAAC,CAAC;QAEhC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;IAC/B,CAAC;IAES,iBAAiB,CAAC,WAA6B;QACvD,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAAC,SAAS,CAAC;QAC/C,IAAI,CAAC,qBAAqB,GAAG,WAAW,CAAC,aAAa,CAAC;QACvD,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,QAAQ,CAAC;QAC7C,IAAI,CAAC,sBAAsB,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;QAE1D,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/D,iDAAiD;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACO,YAAY,CAAC,WAA6B;QAClD,iFAAiF;QACjF,IAAI,IAAI,CAAC,iBAAiB,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;YACrD,qCAAqC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,qBAAqB,KAAK,WAAW,CAAC,aAAa,EAAE,CAAC;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,sBAAsB,KAAK,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,gCAAgC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,QAAQ;QACb,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;YACjD,OAAO;QACT,CAAC;QAED,wCAAwC;QACxC,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvF,qDAAqD;QACrD,MAAM,OAAO,GAAG,aAAa,CAC3B,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAClC,IAAI,CAAC,qBAAqB,CAC3B,CAAC;QAEF,yBAAyB;QACzB,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAEjC,IAAI,QAAQ,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,UAAU,CAAC,KAAoC;QAC7C,kCAAkC;QAClC,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,yBAAyB;YACzB,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAC/C,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,WAA0C;QACpD,0CAA0C;QAC1C,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,WAA6B,CAAC;QAClC,IAAI,CAAC;YACH,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,+BAA+B;YAC/B,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC;YACH,gEAAgE;YAChE,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAEvD,gBAAgB;YAChB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,uCAAuC;YACvC,gFAAgF;YAChF,IAAI,OAAO,GAAG,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC/F,oBAAoB;YACpB,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACxC,eAAe;YACf,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;YAEtC,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAEnD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE9B,IAAI,CAAC,YAAY,EAAE,CAAC;YAEpB,IAAI,CAAC,mBAAmB,IAAI,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,+BAA+B;YAC/B,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;YAC5C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qEAAqE;IAC3D,YAAY;QACpB,+DAA+D;QAC/D,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAG,CAAC;YAEzC,8BAA8B;YAC9B,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;YAEH,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACrB,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACO,kBAAkB,CAAC,KAAoB;QAC/C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,iCAAiC;QACjC,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAAE,OAAO;QAEjF,iCAAiC;QACjC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE9B,mCAAmC;QACnC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAEzC,kCAAkC;QAClC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,sEAAsE;YACtE,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACO,iBAAiB,CAAC,OAAsB;QAChD,+CAA+C;QAC/C,+CAA+C;QAC/C,YAAY;QACZ,IAAI;QAEJ,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,0GAA0G;QAC1G,IAAI,YAAY,GAAkB,IAAI,CAAC,YAAY,CAAC,MAAM,CACxD,CAAC,UAAU,EAAE,aAAa,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,EACjE,OAAO,CACR,CAAC;QAEF,+DAA+D;QAC/D,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,OAAO;QACT,CAAC;QAED,mCAAmC;QACnC,6EAA6E;QAC7E,8GAA8G;QAC9G,+GAA+G;QAC/G,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CACpC,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,EAC/D,YAAY,CACb,CAAC;QAEF,wEAAwE;QACxE,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,OAAO;QACT,CAAC;QAED,uFAAuF;QACvF,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;QAE1C,uCAAuC;QACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACO,sBAAsB,CAAC,KAAoB;QACnD,MAAM,QAAQ,GAAoB,EAAE,CAAC;QAErC,wDAAwD;QACxD,IAAI,CAAC,WAAW;aACb,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC7C,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACvB,IAAI,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAC3B,0CAA0C;gBAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,0CAA0C;gBAC1C,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,kDAAkD;QAClD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD;;;;;;;;;OASG;IAEH;;;;;;;;;OASG;IACK,iBAAiB,CAAC,CAAgB,EAAE,CAAgB;QAC1D,kFAAkF;QAClF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAEhC,kDAAkD;QAClD,IAAI,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YACzB,yCAAyC;YACzC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;YAEtD,OAAO,IAAI,aAAa,CAAC,CAAC,GAAG,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC;QACD,kDAAkD;QAClD,mCAAmC;QACnC,8CAA8C;QAC9C,+CAA+C;QAC/C,2DAA2D;QAE3D,kEAAkE;QAClE,IAAI;aACC,CAAC;YACJ,2CAA2C;YAC3C,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,CAAgB,EAAE,CAAgB;QACzD,kFAAkF;QAClF,IAAI,aAAa,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;YAEtD,OAAO,IAAI,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,2CAA2C;YAC3C,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAEM,wBAAwB;QAC7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEjD,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,CAAC;QACX,CAAC;QAED,mFAAmF;QACnF,iFAAiF;QACjF,cAAc;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/E,CAAC;IAEM,WAAW;QAChB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEjD,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,CAAC;IACtD,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF;AAID;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAAqB;IACtD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAmC,CAAC;IAChF,OAAO,wBAAwB,CAAC,OAAO,CAAC,CAAC;AAC3C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAA4B;IACnE,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC;IACvE,IAAI,CAAC,wBAAwB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;QACxF,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAClE,CAAC;AAED,SAAS,wBAAwB,CAAC,OAAyB;IACzD,IACE,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ;QAClC,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ;QACrC,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ;QACzC,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ;QACpC,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAC7B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,SAAuB,EAAE,aAAsB;IACpE,IAAI,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC1C,IAAI,aAAa,EAAE,CAAC;QAClB,gHAAgH;QAChH,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/esm/classes/FountainEncoder.d.ts

@@ -0,0 +1,63 @@
+import { findNominalFragmentLength } from "../helpers/fountainUtils.js";
+/** [seqNum, seqLength, messageLength, checksum, fragment] */
+export type IMultipartUrPayload = [number, number, number, number, Uint8Array];
+/**
+ * Encode data on the fly. This encoder uses an internal state to keep generating ur fragments of the payload.
+ */
+export declare class FountainEncoder {
+    fragmentLenghtFinder: typeof findNominalFragmentLength;
+    /** Total data size of the input message */
+    _messageLength: number;
+    /** Maximum data size in the fragment */
+    protected _maxFragmentLength: number;
+    /** Minumum data size in the fragment */
+    protected _minFragmentLength: number;
+    /** Calculated data size in the fragment */
+    _nominalFragmentLength: number;
+    /** Array of pure fragments (without any fountain encoded) */
+    _pureFragments: Uint8Array[];
+    /** Current index of the fragment start from 1 */
+    protected _seqNum: number;
+    /** Checksum of the original data */
+    protected _checksum: number;
+    /** Original Input data as UR */
+    protected _input: Uint8Array;
+    constructor(input: Uint8Array, maxFragmentLength?: number, minFragmentLength?: number, firstSeqNum?: number);
+    setFragmentLengthFinder(fn: typeof findNominalFragmentLength): void;
+    /**
+     * Return all the fragments based on the fountain ratio at once as an array of Uint8Arrays.
+     * @param fountainRatio The ratio of the fountain fragments to the pure fragments. Default is 0.
+     * @returns
+     */
+    getAllParts(fountainRatio?: number): Uint8Array[];
+    protected encodeFragment(seqNum: number, fragment: Uint8Array): Uint8Array;
+    /**
+     * Reset the state of the encoder to start generating fragments from the beginning.
+     */
+    reset(): void;
+    /**
+     * Checks if all the pure fragments (full payload data) for this ur is generated.
+     * @returns boolean indicating if generated fragments have included all the data.
+     */
+    isComplete(): boolean;
+    /**
+     * Checks if there is only one fragment generated for the ur.
+     * @returns boolean if the ur payload is contained in one fragment.
+     */
+    isSinglePart(): boolean;
+    /**
+     * Gets the count of the "pure" fragments. These are fragments where the data is not mixed.
+     * @returns The count of the "pure" fragments.
+     */
+    getPureFragmentCount(): number;
+    /**
+     * Get the pure fragments of the ur.
+     * @returns the pure fragments of the ur as an array of Uint8Arrays.
+     */
+    getPureFragments(): Uint8Array[];
+    /**
+     * Give the 'next' fragment for the ur for which the fountainEncoder was created.
+     * @returns the 'next' fragment, represented as a Ur multipart string.
+     */
+    nextPart(): Uint8Array;
+}