near-sdk-js/lib/collections/lookup-map.js

High Level JavaScript SDK for building smart contracts on NEAR

import * as near from "../api";
import { getValueWithOptions, serializeValueWithOptions, encode, } from "../utils";
import { SubType } from "./subtype";
/**
 * A lookup map that stores data in NEAR storage.
 */
export class LookupMap extends SubType {
    /**
     * @param keyPrefix - The byte prefix to use when storing elements inside this collection.
     */
    constructor(keyPrefix) {
        super();
        this.keyPrefix = keyPrefix;
    }
    /**
     * Checks whether the collection contains the value.
     *
     * @param key - The value for which to check the presence.
     */
    containsKey(key) {
        const storageKey = this.keyPrefix + key;
        return near.storageHasKey(storageKey);
    }
    /**
     * Get the data stored at the provided key.
     *
     * @param key - The key at which to look for the data.
     * @param options - Options for retrieving the data.
     */
    get(key, options) {
        const storageKey = this.keyPrefix + key;
        const value = near.storageReadRaw(encode(storageKey));
        if (options == undefined) {
            options = {};
        }
        options = this.set_reconstructor(options);
        return getValueWithOptions(this.subtype(), value, options);
    }
    /**
     * Removes and retrieves the element with the provided key.
     *
     * @param key - The key at which to remove data.
     * @param options - Options for retrieving the data.
     */
    remove(key, options) {
        const storageKey = this.keyPrefix + key;
        if (!near.storageRemove(storageKey)) {
            return options?.defaultValue ?? null;
        }
        const value = near.storageGetEvictedRaw();
        return getValueWithOptions(this.subtype(), value, options);
    }
    /**
     * Store a new value at the provided key.
     *
     * @param key - The key at which to store in the collection.
     * @param newValue - The value to store in the collection.
     * @param options - Options for retrieving and storing the data.
     */
    set(key, newValue, options) {
        const storageKey = this.keyPrefix + key;
        const storageValue = serializeValueWithOptions(newValue, options);
        if (!near.storageWriteRaw(encode(storageKey), storageValue)) {
            return options?.defaultValue ?? null;
        }
        const value = near.storageGetEvictedRaw();
        return getValueWithOptions(this.subtype(), value, options);
    }
    /**
     * Extends the current collection with the passed in array of key-value pairs.
     *
     * @param keyValuePairs - The key-value pairs to extend the collection with.
     * @param options - Options for storing the data.
     */
    extend(keyValuePairs, options) {
        for (const [key, value] of keyValuePairs) {
            this.set(key, value, options);
        }
    }
    /**
     * Serialize the collection.
     *
     * @param options - Options for storing the data.
     */
    serialize(options) {
        return serializeValueWithOptions(this, options);
    }
    /**
     * Converts the deserialized data from storage to a JavaScript instance of the collection.
     *
     * @param data - The deserialized data to create an instance from.
     */
    static reconstruct(data) {
        return new LookupMap(data.keyPrefix);
    }
}