@silvana-one/nft 0.1.0

package/dist/web/metadata/metadata.js

@@ -0,0 +1,439 @@
+import { Field, Poseidon, Struct, Experimental } from "o1js";
+import { fieldFromString } from "../interfaces/index.js";
+import { Text } from "./text.js";
+import { MetadataTree } from "./tree.js";
+export { Metadata, MetadataMap, MetadataFieldTypeValues, MetadataValue, ColorPlugin, };
+/**
+ * The height of the metadata Merkle tree.
+ */
+const METADATA_HEIGHT = 20;
+const IndexedMerkleMap = Experimental.IndexedMerkleMap;
+/**
+ * A specialized IndexedMerkleMap for storing metadata.
+ */
+class MetadataMap extends IndexedMerkleMap(METADATA_HEIGHT) {
+}
+/**
+ * Represents a metadata value with its type and associated data.
+ */
+class MetadataValue extends Struct({
+    value: Field,
+    type: Field,
+    length: Field,
+    height: Field,
+}) {
+    /**
+     * Creates a new MetadataValue instance.
+     * @param params - The parameters including value and type.
+     * @returns A new MetadataValue.
+     */
+    static new(params) {
+        const { value, type } = params;
+        let valueField;
+        let length = Field(0);
+        let height = Field(0);
+        switch (type) {
+            case "string":
+                if (!(value instanceof Field))
+                    throw new Error(`Invalid value type`);
+                valueField = value;
+                break;
+            case "text":
+            case "image":
+            case "url":
+                if (!(value instanceof Text))
+                    throw new Error(`Invalid value type`);
+                valueField = value.root;
+                length = Field(value.size);
+                height = Field(value.height);
+                break;
+            case "field":
+                if (!(value instanceof Field))
+                    throw new Error(`Invalid value type`);
+                valueField = value;
+                break;
+            case "map":
+                if (!(value instanceof Metadata))
+                    throw new Error(`Invalid value type`);
+                valueField = value.map.root;
+                length = Field(value.map.length);
+                height = Field(value.map.height);
+                break;
+            case "tree":
+                if (!(value instanceof MetadataTree))
+                    throw new Error(`Invalid value type`);
+                valueField = value.root;
+                length = Field(value.values.length);
+                height = Field(value.height);
+                break;
+            default:
+                throw new Error(`Unknown value type`);
+        }
+        return new MetadataValue({
+            value: valueField,
+            type: Field(MetadataFieldTypeValues[type].code),
+            length,
+            height,
+        });
+    }
+    /**
+     * Computes the Poseidon hash of the metadata value.
+     * @returns The hash as a Field.
+     */
+    hash() {
+        return Poseidon.hash(MetadataValue.toFields(this));
+    }
+}
+/**
+ * Abstract class for creating custom metadata plugins.
+ */
+class MetadataPlugin {
+}
+/**
+ * A plugin for handling color metadata.
+ */
+class ColorPlugin extends MetadataPlugin {
+    constructor() {
+        super(...arguments);
+        /**
+         * The name of the plugin.
+         */
+        this.name = "color";
+    }
+    /**
+     * Converts a color name or value into its numeric representation.
+     * @param value - The color value (name, string, or number).
+     * @returns The numeric representation of the color.
+     */
+    getColor(value) {
+        if (typeof value === "string" &&
+            ["blue", "red", "green", "yellow", "purple", "orange", "pink"].includes(value)) {
+            const colors = {
+                blue: 0x0000ff,
+                red: 0xff0000,
+                green: 0x00ff00,
+                yellow: 0xffff00,
+                purple: 0x800080,
+                orange: 0xffa500,
+                pink: 0xffc0cb,
+            };
+            return colors[value];
+        }
+        else if (typeof value === "number") {
+            return value;
+        }
+        else if (typeof value === "string") {
+            try {
+                // parse hex color like #0000ff
+                return parseInt(value.slice(1), 16);
+            }
+            catch (e) {
+                throw new Error("Invalid color value");
+            }
+        }
+        throw new Error("Invalid color value");
+    }
+    /**
+     * Retrieves the trait representation of the color value.
+     * @param params - The parameters including key, type, and value.
+     * @returns An object containing the key, value, and canonical representation.
+     */
+    getTrait(params) {
+        const { key, value } = params;
+        const color = this.getColor(value);
+        return {
+            key: fieldFromString(key),
+            value: new MetadataValue({
+                value: Field(color),
+                type: Field(10),
+                length: Field(0),
+                height: Field(0),
+            }),
+            canonicalRepresentation: color,
+        };
+    }
+    /**
+     * Converts the color value to a JSON string.
+     * @param value - The color value.
+     * @returns The JSON string representation.
+     */
+    toJSON(value) {
+        return this.getColor(value).toString(16);
+    }
+    /**
+     * Parses the color value from a JSON string or object.
+     * @param value - The JSON value.
+     * @returns The numeric representation of the color.
+     */
+    fromJSON(value) {
+        if (typeof value !== "string")
+            throw new Error("Invalid color value");
+        return this.getColor(parseInt(value, 16));
+    }
+}
+/**
+ * Represents the metadata for an NFT, including traits and associated data.
+ */
+class Metadata {
+    /**
+     * Creates a new Metadata instance.
+     * @param params - The parameters for the metadata, including name, image, description, banner, and plugins.
+     */
+    constructor(params) {
+        /**
+         * Object containing the traits of the NFT.
+         */
+        this.traits = {};
+        const { name, description, image, banner, plugins } = params;
+        this.plugins = plugins ?? [];
+        this.map = new MetadataMap();
+        this.addTrait({
+            key: "name",
+            type: "string",
+            value: name,
+        });
+        this.addTrait({
+            key: "image",
+            type: "image",
+            value: image,
+        });
+        if (description) {
+            this.addTrait({
+                key: "description",
+                type: "text",
+                value: description,
+            });
+        }
+        if (banner) {
+            this.addTrait({
+                key: "banner",
+                type: "image",
+                value: banner,
+            });
+        }
+        this.name = name;
+        this.image = image;
+        this.banner = banner;
+        this.description = description;
+    }
+    /**
+     * Adds a trait to the metadata.
+     * @param params - The parameters including key, type, value, and isPrivate.
+     * @returns An object containing the key and the metadata value.
+     */
+    addTrait(params) {
+        const { key, type, value, isPrivate = false } = params;
+        let keyField = fieldFromString(key);
+        let metadataValue;
+        let canonicalRepresentation = value;
+        if (type in MetadataFieldTypeValues) {
+            let valueObject;
+            switch (type) {
+                case "string":
+                    if (typeof value !== "string")
+                        throw new Error(`Invalid trait value type`);
+                    valueObject = fieldFromString(value);
+                    break;
+                case "text":
+                case "image":
+                case "url":
+                    if (typeof value !== "string")
+                        throw new Error(`Invalid trait value type`);
+                    valueObject = new Text(value);
+                    break;
+                case "field":
+                    if (!(value instanceof Field))
+                        throw new Error(`Invalid trait value type`);
+                    valueObject = value;
+                    break;
+                case "map":
+                    if (!(value instanceof Metadata))
+                        throw new Error(`Invalid trait value type`);
+                    valueObject = value;
+                    break;
+                case "tree":
+                    if (!(value instanceof MetadataTree))
+                        throw new Error(`Invalid trait value type`);
+                    valueObject = value;
+                    break;
+                default:
+                    throw new Error(`Unknown trait value type - internal error`);
+            }
+            metadataValue = MetadataValue.new({ value: valueObject, type });
+        }
+        else {
+            const index = this.plugins.findIndex((plugin) => plugin.name === type);
+            if (index !== -1) {
+                const plugin = this.plugins[index];
+                const pluginTrait = plugin.getTrait({ key, type, value, isPrivate });
+                metadataValue = pluginTrait.value;
+                keyField = pluginTrait.key;
+                canonicalRepresentation = pluginTrait.canonicalRepresentation;
+            }
+            else
+                throw new Error(`Unknown trait type`);
+        }
+        this.map.set(keyField, metadataValue.hash());
+        this.traits[key] = { type, value: canonicalRepresentation, isPrivate };
+        return { key: keyField, value: metadataValue };
+    }
+    /**
+     * Converts the metadata to a JSON representation.
+     * @param includePrivateTraits - Whether to include private traits.
+     * @returns The JSON representation of the metadata.
+     */
+    toJSON(includePrivateTraits = false) {
+        return {
+            name: this.name,
+            description: this.description,
+            image: this.image,
+            banner: this.banner,
+            metadataRoot: this.map.root.toJSON(),
+            traits: Object.entries(this.traits)
+                .filter(([_, { isPrivate }]) => includePrivateTraits || !isPrivate)
+                .map(([key, { type, value, isPrivate }]) => {
+                let jsonValue;
+                switch (type) {
+                    case "string":
+                    case "text":
+                    case "image":
+                    case "url":
+                        if (typeof value !== "string")
+                            throw new Error(`Invalid trait value type`);
+                        jsonValue = value;
+                        break;
+                    case "field":
+                        if (!(value instanceof Field))
+                            throw new Error(`Invalid trait value type`);
+                        jsonValue = value.toJSON();
+                        break;
+                    case "map":
+                        if (!(value instanceof Metadata))
+                            throw new Error(`Invalid trait value type`);
+                        jsonValue = value.toJSON(includePrivateTraits);
+                        break;
+                    case "tree":
+                        if (!(value instanceof MetadataTree))
+                            throw new Error(`Invalid trait value type`);
+                        jsonValue = value.toJSON();
+                        break;
+                    default:
+                        const plugin = this.plugins.find((plugin) => plugin.name === type);
+                        if (!plugin)
+                            throw new Error(`Unknown trait type`);
+                        jsonValue = plugin.toJSON(value);
+                }
+                return {
+                    key,
+                    type,
+                    ...(isPrivate ? { isPrivate } : {}),
+                    value: jsonValue,
+                };
+            }),
+        };
+    }
+    /**
+     * Constructs a Metadata instance from JSON data.
+     * @param params - The parameters including json data, checkRoot flag, and plugins.
+     * @returns A new Metadata instance.
+     */
+    static fromJSON(params) {
+        const { json, checkRoot = false, plugins } = params;
+        const { name, description, image, banner, metadataRoot, traits } = json;
+        if (!name)
+            throw new Error(`Metadata name is required`);
+        if (typeof name !== "string")
+            throw new Error(`Invalid metadata name`);
+        if (!image || typeof image !== "string")
+            throw new Error(`Invalid metadata image`);
+        if (description && typeof description !== "string")
+            throw new Error(`Invalid metadata description`);
+        if (banner && typeof banner !== "string")
+            throw new Error(`Invalid metadata banner`);
+        if (!metadataRoot || typeof metadataRoot !== "string")
+            throw new Error(`Invalid metadata root`);
+        if (!traits || !Array.isArray(traits))
+            throw new Error(`Metadata traits are required`);
+        for (const { key, type, value, isPrivate } of traits) {
+            if (!key || typeof key !== "string")
+                throw new Error(`Invalid trait key`);
+            if (!type || typeof type !== "string")
+                throw new Error(`Invalid trait type`);
+            if (!value || (typeof value !== "string" && typeof value !== "object"))
+                throw new Error(`Invalid trait value`);
+            if (isPrivate && typeof isPrivate !== "boolean")
+                throw new Error(`Invalid trait isPrivate`);
+        }
+        const metadata = new Metadata({
+            name,
+            description,
+            image,
+            banner,
+            plugins,
+        });
+        for (const { key, type, value, isPrivate } of traits) {
+            let valueField;
+            switch (type) {
+                case "string":
+                case "text":
+                case "image":
+                case "url":
+                    if (typeof value !== "string")
+                        throw new Error(`Invalid trait value type`);
+                    valueField = value;
+                    break;
+                case "field":
+                    if (typeof value !== "string")
+                        throw new Error(`Invalid trait value type`);
+                    valueField = Field.fromJSON(value);
+                    break;
+                case "map":
+                    if (typeof value !== "object")
+                        throw new Error(`Invalid trait value type`);
+                    valueField = Metadata.fromJSON({
+                        json: value,
+                        checkRoot,
+                    });
+                    break;
+                case "tree":
+                    if (typeof value !== "object")
+                        throw new Error(`Invalid trait value type`);
+                    valueField = MetadataTree.fromJSON(value);
+                    break;
+                default:
+                    const plugin = metadata.plugins.find((plugin) => plugin.name === type);
+                    if (!plugin)
+                        throw new Error(`Unknown trait type`);
+                    valueField = plugin.fromJSON(value);
+            }
+            metadata.addTrait({
+                key,
+                type,
+                value: valueField,
+                isPrivate: isPrivate ?? false,
+            });
+        }
+        if (checkRoot === true && metadata.map.root.toJSON() !== metadataRoot) {
+            throw new Error(`Invalid metadata root:${JSON.stringify({
+                params,
+                root: metadata.map.root.toJSON(),
+                checkRoot,
+                metadata: metadata.toJSON(true),
+            }, null, 2)}`);
+        }
+        return metadata;
+    }
+}
+/**
+ * Mapping of metadata field types to their code values and associated types.
+ */
+const MetadataFieldTypeValues = {
+    string: { code: 1n, inputType: "string", storedType: Field }, // Field
+    text: { code: 2n, inputType: "string", storedType: Text }, // Text
+    image: { code: 3n, inputType: "string", storedType: Text }, // Text
+    url: { code: 4n, inputType: "string", storedType: Text }, // Text
+    field: { code: 5n, inputType: Field, storedType: Field }, // Field
+    map: { code: 6n, inputType: Metadata, storedType: Metadata }, // Metadata
+    tree: { code: 7n, inputType: MetadataTree, storedType: MetadataTree }, // MetadataTree
+};
+//# sourceMappingURL=metadata.js.map

package/dist/web/metadata/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/metadata/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EACL,QAAQ,EACR,WAAW,EAEX,uBAAuB,EACvB,aAAa,EACb,WAAW,GACZ,CAAC;AAEF;;GAEG;AACH,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,YAAY,CAAC,gBAAgB,CAAC;AAGvD;;GAEG;AACH,MAAM,WAAY,SAAQ,gBAAgB,CAAC,eAAe,CAAC;CAAG;AAc9D;;GAEG;AACH,MAAM,aAAc,SAAQ,MAAM,CAAC;IACjC,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,KAAK;IACX,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,KAAK;CACd,CAAC;IACA;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,MAGV;QACC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,IAAI,UAAiB,CAAC;QACtB,IAAI,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ;gBACX,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACrE,UAAU,GAAG,KAAK,CAAC;gBACnB,MAAM;YACR,KAAK,MAAM,CAAC;YACZ,KAAK,OAAO,CAAC;YACb,KAAK,KAAK;gBACR,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACpE,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC3B,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC7B,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACrE,UAAU,GAAG,KAAK,CAAC;gBACnB,MAAM;YACR,KAAK,KAAK;gBACR,IAAI,CAAC,CAAC,KAAK,YAAY,QAAQ,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACxE,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;gBAC5B,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACjC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,CAAC,CAAC,KAAK,YAAY,YAAY,CAAC;oBAClC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACxC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACpC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC7B,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,aAAa,CAAC;YACvB,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;YAC/C,MAAM;YACN,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IACD;;;OAGG;IACH,IAAI;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;CACF;AAED;;GAEG;AACH,MAAe,cAAc;CAgC5B;AAMD;;GAEG;AACH,MAAM,WAAY,SAAQ,cAAc;IAAxC;;QACE;;WAEG;QACM,SAAI,GAAG,OAAO,CAAC;IAgF1B,CAAC;IA9EC;;;;OAIG;IACH,QAAQ,CAAC,KAA8B;QACrC,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CACrE,KAAK,CACN,EACD,CAAC;YACD,MAAM,MAAM,GAA+B;gBACzC,IAAI,EAAE,QAAQ;gBACd,GAAG,EAAE,QAAQ;gBACb,KAAK,EAAE,QAAQ;gBACf,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,QAAQ;aACf,CAAC;YACF,OAAO,MAAM,CAAC,KAAc,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,+BAA+B;gBAC/B,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACtC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IACD;;;;OAIG;IACH,QAAQ,CAAC,MAIR;QAKC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO;YACL,GAAG,EAAE,eAAe,CAAC,GAAG,CAAC;YACzB,KAAK,EAAE,IAAI,aAAa,CAAC;gBACvB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;gBACnB,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;gBACf,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;aACjB,CAAC;YACF,uBAAuB,EAAE,KAAK;SAC/B,CAAC;IACJ,CAAC;IACD;;;;OAIG;IACH,MAAM,CAAC,KAA8B;QACnC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD;;;;OAIG;IACH,QAAQ,CAAC,KAAsB;QAC7B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;IAC5C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,QAAQ;IAoCZ;;;OAGG;IACH,YAAY,MAMX;QArBD;;WAEG;QACH,WAAM,GAMF,EAAE,CAAC;QAaL,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,EAAE,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC;YACZ,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC;YACZ,GAAG,EAAE,OAAO;YACZ,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;QACH,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC;gBACZ,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,WAAW;aACnB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,QAAQ,CAAC;gBACZ,GAAG,EAAE,QAAQ;gBACb,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,MAAM;aACd,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAKR;QAIC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvD,IAAI,QAAQ,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,aAA4B,CAAC;QACjC,IAAI,uBAAuB,GAAY,KAAK,CAAC;QAE7C,IAAI,IAAI,IAAI,uBAAuB,EAAE,CAAC;YACpC,IAAI,WAAmD,CAAC;YACxD,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,QAAQ;oBACX,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;oBACrC,MAAM;gBACR,KAAK,MAAM,CAAC;gBACZ,KAAK,OAAO,CAAC;gBACb,KAAK,KAAK;oBACR,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,WAAW,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC9B,MAAM;gBACR,KAAK,OAAO;oBACV,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,WAAW,GAAG,KAAK,CAAC;oBACpB,MAAM;gBACR,KAAK,KAAK;oBACR,IAAI,CAAC,CAAC,KAAK,YAAY,QAAQ,CAAC;wBAC9B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,WAAW,GAAG,KAAK,CAAC;oBACpB,MAAM;gBACR,KAAK,MAAM;oBACT,IAAI,CAAC,CAAC,KAAK,YAAY,YAAY,CAAC;wBAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,WAAW,GAAG,KAAK,CAAC;oBACpB,MAAM;gBACR;oBACE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACjE,CAAC;YACD,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YACvE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACnC,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBACrE,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC;gBAClC,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC;gBAC3B,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC;YAChE,CAAC;;gBAAM,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,uBAAuB,EAAE,SAAS,EAAE,CAAC;QACvE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,GAAG,KAAK;QAajC,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;YACpC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;iBAChC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC;iBAClE,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE;gBACzC,IAAI,SAA0B,CAAC;gBAC/B,QAAQ,IAAI,EAAE,CAAC;oBACb,KAAK,QAAQ,CAAC;oBACd,KAAK,MAAM,CAAC;oBACZ,KAAK,OAAO,CAAC;oBACb,KAAK,KAAK;wBACR,IAAI,OAAO,KAAK,KAAK,QAAQ;4BAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;wBAC9C,SAAS,GAAG,KAAK,CAAC;wBAClB,MAAM;oBACR,KAAK,OAAO;wBACV,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;4BAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;wBAC9C,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;wBAC3B,MAAM;oBACR,KAAK,KAAK;wBACR,IAAI,CAAC,CAAC,KAAK,YAAY,QAAQ,CAAC;4BAC9B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;wBAC9C,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;wBAC/C,MAAM;oBACR,KAAK,MAAM;wBACT,IAAI,CAAC,CAAC,KAAK,YAAY,YAAY,CAAC;4BAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;wBAC9C,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;wBAC3B,MAAM;oBACR;wBACE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAC9B,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CACjC,CAAC;wBACF,IAAI,CAAC,MAAM;4BAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;wBACnD,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACrC,CAAC;gBACD,OAAO;oBACL,GAAG;oBACH,IAAI;oBACJ,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACnC,KAAK,EAAE,SAAS;iBACjB,CAAC;YACJ,CAAC,CAAC;SACL,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,MAgBf;QACC,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QACpD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxE,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACxD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACvE,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACrC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ;YAChD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;YACtC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,IAAI,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ;YACnD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,MAAM,EAAE,CAAC;YACrD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;YAC1E,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;gBACnC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;gBACpE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACzC,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,SAAS;gBAC7C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC5B,IAAI;YACJ,WAAW;YACX,KAAK;YACL,MAAM;YACN,OAAO;SACR,CAAC,CAAC;QACH,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,MAAM,EAAE,CAAC;YACrD,IAAI,UAA8D,CAAC;YACnE,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,QAAQ,CAAC;gBACd,KAAK,MAAM,CAAC;gBACZ,KAAK,OAAO,CAAC;gBACb,KAAK,KAAK;oBACR,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,UAAU,GAAG,KAAK,CAAC;oBACnB,MAAM;gBACR,KAAK,OAAO;oBACV,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBACnC,MAAM;gBACR,KAAK,KAAK;oBACR,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC;wBAC7B,IAAI,EAAE,KAWL;wBACD,SAAS;qBACV,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,MAAM;oBACT,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC9C,UAAU,GAAG,YAAY,CAAC,QAAQ,CAChC,KAIC,CACF,CAAC;oBACF,MAAM;gBACR;oBACE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAClC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CACjC,CAAC;oBACF,IAAI,CAAC,MAAM;wBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;oBACnD,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxC,CAAC;YACD,QAAQ,CAAC,QAAQ,CAAC;gBAChB,GAAG;gBACH,IAAI;gBACJ,KAAK,EAAE,UAAU;gBACjB,SAAS,EAAE,SAAS,IAAI,KAAK;aAC9B,CAAC,CAAC;QACL,CAAC;QACD,IAAI,SAAS,KAAK,IAAI,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,YAAY,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,CAAC,SAAS,CACrC;gBACE,MAAM;gBACN,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChC,SAAS;gBACT,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;aAChC,EACD,IAAI,EACJ,CAAC,CACF,EAAE,CACJ,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,uBAAuB,GAAG;IAC9B,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ;IACtE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,OAAO;IAClE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,OAAO;IACnE,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,OAAO;IACjE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ;IAClE,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,WAAW;IACzE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,eAAe;CAC9E,CAAC"}

package/dist/web/metadata/text.d.ts

@@ -0,0 +1,44 @@
+import { Field } from "o1js";
+export { Text, TEXT_TREE_HEIGHT };
+/**
+ * The default height of the Merkle tree used to represent the text data.
+ */
+declare const TEXT_TREE_HEIGHT = 20;
+/**
+ * The `Text` class represents textual data in the form of a Merkle tree. Each character of the text is converted to its
+ * ASCII code and stored as a leaf in the Merkle tree. The root of the tree can be used as a compact representation
+ * of the text data in cryptographic proofs.
+ */
+declare class Text {
+    /**
+     * The length of the text.
+     */
+    readonly size: number;
+    /**
+     * The original text string.
+     */
+    readonly text: string;
+    /**
+     * The root of the Merkle tree representing the text data.
+     */
+    readonly root: Field;
+    /**
+     * The height of the Merkle tree.
+     */
+    readonly height: number;
+    /**
+     * Constructs a new `Text` instance by creating a Merkle tree from the given text string.
+     * Each character in the text is converted to its ASCII code and stored as a leaf in the tree.
+     *
+     * @param text - The text string to be represented.
+     * @param height - The height of the Merkle tree. Defaults to `TEXT_TREE_HEIGHT`.
+     * @throws Will throw an error if the text length exceeds the number of leaves in the Merkle tree.
+     */
+    constructor(text: string, height?: number);
+    /**
+     * Returns the original text string.
+     *
+     * @returns The text string.
+     */
+    toString(): string;
+}

package/dist/web/metadata/text.js

@@ -0,0 +1,42 @@
+import { MerkleTree, Field } from "o1js";
+export { Text, TEXT_TREE_HEIGHT };
+/**
+ * The default height of the Merkle tree used to represent the text data.
+ */
+const TEXT_TREE_HEIGHT = 20;
+/**
+ * The `Text` class represents textual data in the form of a Merkle tree. Each character of the text is converted to its
+ * ASCII code and stored as a leaf in the Merkle tree. The root of the tree can be used as a compact representation
+ * of the text data in cryptographic proofs.
+ */
+class Text {
+    /**
+     * Constructs a new `Text` instance by creating a Merkle tree from the given text string.
+     * Each character in the text is converted to its ASCII code and stored as a leaf in the tree.
+     *
+     * @param text - The text string to be represented.
+     * @param height - The height of the Merkle tree. Defaults to `TEXT_TREE_HEIGHT`.
+     * @throws Will throw an error if the text length exceeds the number of leaves in the Merkle tree.
+     */
+    constructor(text, height = TEXT_TREE_HEIGHT) {
+        this.text = text;
+        this.size = text.length;
+        const tree = new MerkleTree(height);
+        if (this.size > tree.leafCount)
+            throw new Error(`Text is too long`);
+        for (let i = 0; i < this.size; i++) {
+            tree.setLeaf(BigInt(i), Field.from(this.text.charCodeAt(i)));
+        }
+        this.root = tree.getRoot();
+        this.height = height;
+    }
+    /**
+     * Returns the original text string.
+     *
+     * @returns The text string.
+     */
+    toString() {
+        return this.text;
+    }
+}
+//# sourceMappingURL=text.js.map

package/dist/web/metadata/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../src/metadata/text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;AAElC;;GAEG;AACH,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;;GAIG;AACH,MAAM,IAAI;IAkBR;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,SAAiB,gBAAgB;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/web/metadata/tree.d.ts

@@ -0,0 +1,75 @@
+import { Field } from "o1js";
+/**
+ * Represents a metadata tree using a Merkle tree structure.
+ *
+ * The `MetadataTree` class is used to manage a set of key-value pairs representing metadata,
+ * storing them in a Merkle tree for efficient verification and integrity checks.
+ *
+ * This class is a utility within the NFT standard on Mina Protocol, enabling secure and verifiable
+ * storage of metadata. By leveraging the Merkle tree, clients can prove the inclusion of specific
+ * metadata entries without exposing the entire dataset.
+ */
+export declare class MetadataTree {
+    /**
+     * The list of key-value pairs stored in the tree.
+     * Each key is a `bigint` representing the index in the Merkle tree,
+     * and each value is a `Field` element from o1js.
+     */
+    readonly values: {
+        key: bigint;
+        value: Field;
+    }[];
+    /**
+     * The height of the Merkle tree.
+     * Determines the maximum number of elements the tree can hold.
+     */
+    readonly height: number;
+    /**
+     * The root of the Merkle tree.
+     * Used for verifying the integrity of the tree and its contents.
+     */
+    readonly root: Field;
+    /**
+     * Constructs a new `MetadataTree` with the specified height and key-value pairs.
+     *
+     * @param height - The height of the Merkle tree (must be between 1 and 254).
+     * @param values - An array of key-value pairs to store in the tree.
+     *
+     * @throws Will throw an error if the number of values exceeds the maximum capacity of the tree.
+     * @throws Will throw an error if any key is out of bounds for the tree height.
+     */
+    constructor(height: number, values: {
+        key: bigint;
+        value: Field;
+    }[]);
+    /**
+     * Serializes the `MetadataTree` to a JSON object.
+     *
+     * @returns An object containing the tree's height, root, and values.
+     */
+    toJSON(): {
+        height: number;
+        root: string;
+        values: {
+            key: string;
+            value: string;
+        }[];
+    };
+    /**
+     * Deserializes a JSON object into a `MetadataTree` instance.
+     *
+     * @param json - The JSON object containing the tree data.
+     *
+     * @returns A new `MetadataTree` instance constructed from the JSON data.
+     *
+     * @throws Will throw an error if the JSON data is invalid or inconsistent.
+     */
+    static fromJSON(json: {
+        height: number;
+        root: string;
+        values: {
+            key: string;
+            value: string;
+        }[];
+    }): MetadataTree;
+}