@yoroi/common/src/storage/helpers/storage-deserializer-maker.ts

The Common package of Yoroi SDK

import BigNumber from 'bignumber.js'
import {isRecord} from '../../utils/parsers'

export enum StorageReviverType {
  AsBigInt = 'AsBigInt',
  AsBigNumber = 'AsBigNumber',
}

export type StorageReviverMapping = {
  [key: string]: StorageReviverType
}

/**
 * Creates a storage deserializer function based on the provided mapping.
 * Since BigInt and BigNumber are not supported by JSON.parse, it stores as strings and revive as BigInt or BigNumber.
 *
 * @param mapping - The mapping of keys to reviver types.
 * @returns JSON object revived according to the mapping, string -> BigInt or BigNumber.
 */
export const storageDeserializerMaker = (mapping: StorageReviverMapping) => {
  const reviver = (key: string, value: any) => {
    switch (mapping[key]) {
      case StorageReviverType.AsBigInt:
        return value == null ? value : BigInt(value)
      case StorageReviverType.AsBigNumber:
      default:
        return value === null ? value : new BigNumber(value)
    }
  }

  const convertProperties = (obj: unknown): unknown => {
    if (Array.isArray(obj)) return obj.map((item) => convertProperties(item))

    if (isRecord(obj)) {
      Object.keys(obj).forEach((key) => {
        obj[key] = convertProperties(obj[key])
      })
      return obj
    }

    return obj
  }

  return (jsonString: string | null) => {
    if (jsonString == null) return null
    try {
      const parsed = JSON.parse(jsonString, (key, value) => {
        if (key && mapping[key]) {
          return reviver(key as any, value)
        }
        return value
      })
      return convertProperties(parsed)
    } catch (e) {
      return null
    }
  }
}