All files / src/storage map.ts

89.04% Statements 65/73
70.58% Branches 36/51
92.3% Functions 12/13
89.04% Lines 65/73

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294  27x         27x 27x 27x 27x             27x 27x 27x                                                               20x 20x               23x 23x 76x 76x 76x   23x               69x               45x                             7x 7x                               5x                               1x                               8x 8x                               3x 3x 3x         3x 3x 3x 3x 3x 3x 3x 3x   3x                                                       24x                     8x 8x 8x 8x 8x     8x   8x                   8x 8x 26x 26x   26x 26x 26x 26x             26x   17x         17x   5x         5x   3x         3x   1x         1x           8x 8x 8x     8x      
export {
  MapData,
  MinaNFTMapUpdate,
  MinaNFTTextDataUpdate,
  MinaNFTFileDataUpdate,
};
import { Poseidon } from "o1js";
import { BaseMinaNFTObject } from "../baseminanftobject";
import { PrivateMetadata } from "../privatemetadata";
import { MetadataMap } from "../contract/update";
import {
  MinaNFTStringUpdate,
  MinaNFTFieldUpdate,
  MinaNFTFileUpdate,
  MinaNFTTextUpdate,
} from "../update";
import { MinaNFT } from "../minanft";
import { TextData } from "./text";
import { File, FileData } from "./file";
 
/**
 * MinaNFTMapUpdate is the data for the update of the metadata to be written to the NFT state
 * with text value
 * Text can be of any length
 * @property key The key of the metadata
 * @property text The text
 * @property isPrivate True if the text is private, default is false
 */
interface MinaNFTMapUpdate {
  key: string;
  map: MapData;
  isPrivate?: boolean;
}
 
interface MinaNFTTextDataUpdate {
  key: string;
  textData: TextData;
  isPrivate?: boolean;
}
 
interface MinaNFTFileDataUpdate {
  key: string;
  fileData: FileData;
  isPrivate?: boolean;
}
 
class MapData extends BaseMinaNFTObject {
  metadata: Map<string, PrivateMetadata>;
 
  constructor() {
    super("map");
    this.metadata = new Map<string, PrivateMetadata>();
  }
 
  /**
   * Calculates and sets a root of the MapData
   * Should be called before updating the NFT state!!!
   */
  public setRoot() {
    const map: MetadataMap = new MetadataMap();
    this.metadata.forEach((value: PrivateMetadata, key: string) => {
      const keyField = MinaNFT.stringToField(key);
      map.data.set(keyField, value.data);
      map.kind.set(keyField, value.kind);
    });
    this.root = Poseidon.hash([map.data.getRoot(), map.kind.getRoot()]);
  }
  /**
   * updates Metadata
   * @param key key to update
   * @param value value to update
   */
  public updateMetadata(key: string, value: PrivateMetadata): void {
    this.metadata.set(key, value);
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTStringUpdate} update data
   */
  public update(data: MinaNFTStringUpdate): void {
    this.updateMetadata(
      data.key,
      new PrivateMetadata({
        data: MinaNFT.stringToField(data.value),
        kind: MinaNFT.stringToField(data.kind ?? "string"),
        isPrivate: data.isPrivate ?? false,
      })
    );
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTTextUpdate} update data
   */
  public updateText(data: MinaNFTTextUpdate): void {
    const text = new TextData(data.text);
    this.updateMetadata(
      data.key,
      new PrivateMetadata({
        data: text.root,
        kind: MinaNFT.stringToField("text"),
        isPrivate: data.isPrivate ?? false,
        linkedObject: text,
      })
    );
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTTextDataUpdate} update data
   */
  public updateTextData(data: MinaNFTTextDataUpdate): void {
    this.updateMetadata(
      data.key,
      new PrivateMetadata({
        data: data.textData.root,
        kind: MinaNFT.stringToField("text"),
        isPrivate: data.isPrivate ?? false,
        linkedObject: data.textData,
      })
    );
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTFileDataUpdate} update data
   */
  public updateFileData(data: MinaNFTFileDataUpdate): void {
    this.updateMetadata(
      data.key,
      new PrivateMetadata({
        data: data.fileData.root,
        kind: MinaNFT.stringToField(data.fileData.type),
        isPrivate: data.isPrivate ?? false,
        linkedObject: data.fileData,
      })
    );
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTTextUpdate} update data
   */
  public updateMap(data: MinaNFTMapUpdate): void {
    data.map.setRoot();
    this.updateMetadata(
      data.key,
      new PrivateMetadata({
        data: data.map.root,
        kind: MinaNFT.stringToField("map"),
        isPrivate: data.isPrivate ?? false,
        linkedObject: data.map,
      })
    );
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTFileUpdate} update data
   */
  public async updateFile(data: MinaNFTFileUpdate): Promise<void> {
    const file = new File(data.filename, data.fileType, data.fileMetadata);
    console.log("Pinning file to IPFS...");
    await file.pin({
      pinataJWT: data.pinataJWT,
      arweaveKey: data.arweaveKey,
      keyvalues: { project: "MinaNFT", type: "file", nftType: "map" },
    });
    console.log("Calculating file Merkle tree root...");
    console.time("File Merkle tree root calculated");
    await file.treeData(data.calculateRoot ?? true);
    console.timeEnd("File Merkle tree root calculated");
    console.time("Calculated SHA-3 512");
    await file.sha3_512();
    console.timeEnd("Calculated SHA-3 512");
    const fileData: FileData = await file.data();
 
    this.updateMetadata(
      data.key,
      new PrivateMetadata({
        data: fileData.root,
        kind: MinaNFT.stringToField("file"),
        isPrivate: data.isPrivate ?? false,
        linkedObject: fileData,
      })
    );
  }
 
  /**
   * updates PrivateMetadata
   * @param data {@link MinaNFTFieldUpdate} update data
   */
  public updateField(data: MinaNFTFieldUpdate): void {
    this.updateMetadata(data.key, {
      data: data.value,
      kind: MinaNFT.stringToField(data.kind ?? "string"),
      isPrivate: data.isPrivate ?? false,
    } as PrivateMetadata);
  }
 
  /**
   * Converts a MapData to JSON
   * @returns map as JSON object
   */
  public toJSON(): object {
    return {
      type: this.type,
      properties: Object.fromEntries(this.metadata),
    };
  }
  public static fromJSON(
    json: object,
    // eslint-disable-next-line @typescript-eslint/no-inferrable-types
    skipCalculatingMetadataRoot: boolean = false
  ): MapData {
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    const obj = json as any;
    const data = obj.data;
    const kind = obj.kind;
    const linkedObject = obj.linkedObject;
    Iif (data === undefined)
      throw new Error(`uri: NFT metadata: data should present: ${json}`);
 
    Iif (kind === undefined || typeof kind !== "string" || kind !== "map")
      throw new Error("uri: NFT metadata: kind mismatch");
    Iif (
      linkedObject === undefined ||
      typeof linkedObject !== "object" ||
      linkedObject.properties === undefined ||
      typeof linkedObject.properties !== "object" ||
      linkedObject.type === undefined ||
      typeof linkedObject.type !== "string" ||
      linkedObject.type !== "map"
    )
      throw new Error("uri: NFT metadata: map json mismatch");
    const map = new MapData();
    for (const key in linkedObject.properties) {
      const value = linkedObject.properties[key];
      Iif (value === undefined || typeof value !== "object")
        throw new Error("uri: NFT metadata: map json mismatch");
      const kind = value.kind;
      const data = value.data;
      const isPrivate: boolean = value.isPrivate ?? false;
      Iif (
        kind === undefined ||
        typeof kind !== "string" ||
        data === undefined ||
        typeof data !== "string"
      )
        throw new Error("uri: NFT metadata: map kind or data mismatch");
      switch (kind) {
        case "string":
          map.update({
            key,
            value: data,
            isPrivate,
          });
          break;
        case "text":
          map.updateTextData({
            key,
            textData: TextData.fromJSON(value),
            isPrivate,
          });
          break;
        case "map":
          map.updateMap({
            key,
            map: MapData.fromJSON(value, skipCalculatingMetadataRoot),
            isPrivate,
          });
          break;
        case "file":
          map.updateFileData({
            key,
            fileData: FileData.fromJSON(value),
            isPrivate,
          });
          break;
        default:
          throw new Error("uri: NFT metadata: map json mismatch");
      }
    }
 
    if (skipCalculatingMetadataRoot === false) {
      map.setRoot();
      Iif (map.root.toJSON() !== data)
        throw new Error("uri: NFT metadata: map root mismatch");
    }
    return map;
  }
}