@koralabs/kora-labs-common 5.1.32 → 5.1.34

package/handles/constants.d.ts

@@ -20,3 +20,5 @@ export declare enum ERROR_TEXT {
     HANDLE_PAGE_AND_SLOT_NUMBER_INVALID = "'page' and 'slot_number' can't be used together"
 }
 export declare const HANDLES_PER_PAGE_MAX = 1000;
+export declare const EMPTY = "|empty|";
+export declare const TWELVE_HOURS_IN_SLOTS = 43200;

package/handles/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HANDLES_PER_PAGE_MAX = exports.ERROR_TEXT = exports.KORA_USER_AGENT = exports.HANDLES_API_KEY = exports.REGEX_SUB_HANDLE = exports.REGEX_HANDLE = exports.REGEX_SPLIT_ON_NUMS = exports.REGEX_SPLIT_ON_CHARS = exports.RESPONSE_NOT_ALLOWED = exports.RESPONSE_INVALID_HANDLE_FORMAT = exports.RESPONSE_UNAVAILABLE_LEGENDARY = exports.RESPONSE_UNAVAILABLE_RESERVED = exports.RESPONSE_UNAVAILABLE_ACTIVE_SESSION = exports.RESPONSE_UNAVAILABLE_PAID = exports.RESPONSE_AVAILABLE = void 0;
+exports.TWELVE_HOURS_IN_SLOTS = exports.EMPTY = exports.HANDLES_PER_PAGE_MAX = exports.ERROR_TEXT = exports.KORA_USER_AGENT = exports.HANDLES_API_KEY = exports.REGEX_SUB_HANDLE = exports.REGEX_HANDLE = exports.REGEX_SPLIT_ON_NUMS = exports.REGEX_SPLIT_ON_CHARS = exports.RESPONSE_NOT_ALLOWED = exports.RESPONSE_INVALID_HANDLE_FORMAT = exports.RESPONSE_UNAVAILABLE_LEGENDARY = exports.RESPONSE_UNAVAILABLE_RESERVED = exports.RESPONSE_UNAVAILABLE_ACTIVE_SESSION = exports.RESPONSE_UNAVAILABLE_PAID = exports.RESPONSE_AVAILABLE = void 0;
 const constants_1 = require("../constants");
 exports.RESPONSE_AVAILABLE = 'Yay! This handle is available.';
 exports.RESPONSE_UNAVAILABLE_PAID = 'Sorry! This Handle is pending mint or already minted.';
@@ -26,3 +26,5 @@ var ERROR_TEXT;
     ERROR_TEXT["HANDLE_PAGE_AND_SLOT_NUMBER_INVALID"] = "'page' and 'slot_number' can't be used together";
 })(ERROR_TEXT = exports.ERROR_TEXT || (exports.ERROR_TEXT = {}));
 exports.HANDLES_PER_PAGE_MAX = 1000;
+exports.EMPTY = '|empty|';
+exports.TWELVE_HOURS_IN_SLOTS = 43200; // value comes from the securityParam here: https://cips.cardano.org/cips/cip9/#nonupdatableparameters then converted to slots

package/handles/index.d.ts

@@ -1,8 +1,8 @@
+export * from './api';
+export * from './constants';
 export * from './interfaces';
 export * from './interfaces/api';
-export * from './interfaces/handlesRepository';
-export * from './constants';
-export * from './api';
+export * from './interfaces/handlesProvider';
+export * from './models';
 export * from './policies';
 export * from './utils';
-export * from './models';

package/handles/index.js

@@ -14,11 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api"), exports);
+__exportStar(require("./constants"), exports);
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./interfaces/api"), exports);
-__exportStar(require("./interfaces/handlesRepository"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./api"), exports);
+__exportStar(require("./interfaces/handlesProvider"), exports);
+__exportStar(require("./models"), exports);
 __exportStar(require("./policies"), exports);
 __exportStar(require("./utils"), exports);
-__exportStar(require("./models"), exports);

package/handles/interfaces/api.d.ts

@@ -40,10 +40,10 @@ export interface HandleHistory {
     old: Partial<StoredHandle> | null;
     new?: Partial<StoredHandle> | null;
 }
-export interface ISlotHistoryIndex {
+export interface ISlotHistory {
     [handleHex: string]: HandleHistory;
 }
-export interface IHandleStoreMetrics {
+export interface IApiMetrics {
     firstSlot?: number;
     lastSlot?: number;
     currentSlot?: number;
@@ -54,6 +54,8 @@ export interface IHandleStoreMetrics {
     tipBlockHash?: string;
     memorySize?: number;
     networkSync?: number;
+    count?: number;
+    schemaVersion?: number;
 }
 export interface SaveMintingTxInput {
     hex: string;
@@ -123,14 +125,15 @@ export interface SaveSubHandleSettingsInput {
     utxoDetails: IUTxO;
     slotNumber: number;
 }
-export interface HolderAddressIndex {
+export interface Holder {
+    address: string;
     handles: Set<string>;
     defaultHandle: string;
     manuallySet: boolean;
     type: string;
     knownOwnerName: string;
 }
-export interface HolderAddressDetails {
+export interface HolderViewModel {
     total_handles: number;
     address: string;
     type: string;
@@ -169,3 +172,18 @@ export interface IGetHolderAddressDetailsRequest {
 export type INormalizedQueryParams = {
     [key: string]: string;
 };
+export declare enum IndexNames {
+    ADDRESS = "address",
+    CHARACTER = "characters",
+    HANDLE = "handle",
+    HASH_OF_STAKE_KEY_HASH = "hashofstakekeyhash",
+    HOLDER = "holder",
+    LENGTH = "length",
+    NUMERIC_MODIFIER = "numericmodifiers",
+    OG = "og",
+    PAYMENT_KEY_HASH = "paymentkeyhashes",
+    RARITY = "rarity",
+    SLOT_HISTORY = "slothistory",
+    SUBHANDLE = "subhandle",
+    STAKE_KEY_HASH = "stakekeyhash"
+}

package/handles/interfaces/api.js

@@ -1,2 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexNames = void 0;
+var IndexNames;
+(function (IndexNames) {
+    IndexNames["ADDRESS"] = "address";
+    IndexNames["CHARACTER"] = "characters";
+    IndexNames["HANDLE"] = "handle";
+    IndexNames["HASH_OF_STAKE_KEY_HASH"] = "hashofstakekeyhash";
+    IndexNames["HOLDER"] = "holder";
+    IndexNames["LENGTH"] = "length";
+    IndexNames["NUMERIC_MODIFIER"] = "numericmodifiers";
+    IndexNames["OG"] = "og";
+    IndexNames["PAYMENT_KEY_HASH"] = "paymentkeyhashes";
+    IndexNames["RARITY"] = "rarity";
+    IndexNames["SLOT_HISTORY"] = "slothistory";
+    IndexNames["SUBHANDLE"] = "subhandle";
+    IndexNames["STAKE_KEY_HASH"] = "stakekeyhash";
+})(IndexNames = exports.IndexNames || (exports.IndexNames = {}));

package/handles/interfaces/handlesProvider.d.ts

@@ -0,0 +1,28 @@
+import { IApiMetrics, IndexNames, StoredHandle } from './api';
+export interface IHandlesProvider {
+    initialize: () => Promise<IHandlesProvider>;
+    destroy: () => void;
+    rollBackToGenesis: () => void;
+    getStartingPoint: (save: ({ handle, oldHandle, saveHistory }: {
+        handle: StoredHandle;
+        oldHandle?: StoredHandle;
+        saveHistory?: boolean;
+    }) => Promise<void>, failed: boolean) => Promise<{
+        slot: number;
+        id: string;
+    } | null>;
+    getHandle: (key: string) => StoredHandle | null;
+    getHandleByHex: (hex: string) => StoredHandle | null;
+    getAllHandles: () => StoredHandle[];
+    setHandle: (key: string, value: StoredHandle) => void;
+    removeHandle: (handleName: string) => void;
+    getIndex: (index: IndexNames) => any;
+    getValuesFromIndex: (index: IndexNames, key: string | number) => any;
+    setValueOnIndex: (index: IndexNames, key: string | number, value: any) => void;
+    removeValueFromIndex: (index: IndexNames, key: string | number, value: string) => void;
+    removeKeyFromIndex: (index: IndexNames, key: string | number) => void;
+    getMetrics: () => IApiMetrics;
+    setMetrics: (metrics: IApiMetrics) => void;
+    count: () => number;
+    getSchemaVersion: () => number;
+}

package/handles/interfaces/index.d.ts

@@ -1,5 +1,5 @@
 import { BoolInt, FeaturedItemType, HexString, HexStringOrEmpty } from '../../types';
-import { ISlotHistoryIndex, StoredHandle } from './api';
+import { ISlotHistory, StoredHandle } from './api';
 export declare enum Rarity {
     basic = "basic",
     common = "common",
@@ -159,7 +159,7 @@ export interface ICip68Handle extends IHandle {
 export interface IPersonalizedHandle extends ICip68Handle {
     personalization?: IPersonalization;
 }
-export interface IHandleStats {
+export interface IApiMetricsViewModel {
     percentage_complete: string;
     current_memory_used: number;
     ogmios_elapsed: string;
@@ -348,7 +348,7 @@ export interface IHandleFileContent {
     hash: string;
     schemaVersion?: number;
     handles: Record<string, StoredHandle>;
-    history: [number, ISlotHistoryIndex][];
+    history: [number, ISlotHistory][];
 }
 export interface IHandleSvgOptions extends IPersonalizationDesigner {
     pfp_image?: string;

package/handles/policies.d.ts

@@ -1,5 +1,5 @@
 import { Network } from '../types';
-interface PolicyIds {
+export interface PolicyIds {
     [key: string]: {
         firstMintingSlot: number;
         lastMintingSlot: number | null;
@@ -7,12 +7,11 @@ interface PolicyIds {
         isDeMi?: boolean;
     };
 }
-interface HandlePolicies {
+export interface HandlePolicies {
     'preview': PolicyIds;
     'preprod': PolicyIds;
     'mainnet': PolicyIds;
-    getActivePolicy(network: Network, atSlot?: number): string | undefined;
+    getActivePolicy(network: Network, isDemi?: boolean, atSlot?: number): string | undefined;
     contains(network: Network, policyId: string): boolean;
 }
 export declare const HANDLE_POLICIES: HandlePolicies;
-export {};

package/handles/policies.js

@@ -9,7 +9,7 @@ exports.HANDLE_POLICIES = {
     },
     'preprod': { 'f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a': { firstMintingSlot: 0, lastMintingSlot: null, sunsetSlot: null } },
     'mainnet': { 'f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a': { firstMintingSlot: 0, lastMintingSlot: null, sunsetSlot: null } },
-    getActivePolicy(network, atSlot, isDeMi = false) {
+    getActivePolicy(network, isDeMi = false, atSlot) {
         var _a;
         const theSlot = atSlot ? atSlot : (0, utils_1.getSlotNumberFromDate)(new Date(Date.now()));
         return (_a = Object.entries(this[network]).find(([, value]) => { var _a; return value.firstMintingSlot <= theSlot && ((_a = value.lastMintingSlot) !== null && _a !== void 0 ? _a : Number.POSITIVE_INFINITY) >= theSlot && value.isDeMi == isDeMi; })) === null || _a === void 0 ? void 0 : _a[0];

package/logger/index.js

@@ -59,8 +59,22 @@ class Logger {
         const log_milliseconds = milliseconds != undefined && milliseconds != null ? `, "milliseconds": ${milliseconds}` : '';
         const log_count = count != undefined && count != null ? `, "count": ${count}` : '';
         const log_dimensions = dimensions && Object.keys(dimensions).length ? `, "dimensions": ${JSON.stringify(dimensions)}` : '';
+        let logFunc = console.log;
+        switch (category) {
+            case LogCategory.DEBUG:
+                logFunc = console.debug;
+                break;
+            case LogCategory.WARN:
+                logFunc = console.warn;
+                break;
+            case LogCategory.ERROR:
+            case LogCategory.FATAL:
+            case LogCategory.NOTIFY:
+                logFunc = console.error;
+                break;
+        }
         // PLEASE KEEP THIS ALL ON ONE LINE SO LOGS AREN'T BROKEN UP
-        console.log(`{"network": "${Logger.network}", "application": "${Logger.application}", "category": "${category !== null && category !== void 0 ? category : LogCategory.INFO}", "message": "${message}"${log_event}, "timestamp": "${now}"${log_milliseconds}${log_count}${log_dimensions} }`);
+        logFunc(`{"network": "${Logger.network}", "application": "${Logger.application}", "category": "${category !== null && category !== void 0 ? category : LogCategory.INFO}", "message": "${message}"${log_event}, "timestamp": "${now}"${log_milliseconds}${log_count}${log_dimensions} }`);
         // PLEASE KEEP THIS ALL ON ONE LINE SO LOGS AREN'T BROKEN UP
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@koralabs/kora-labs-common",
-    "version": "5.1.32",
+    "version": "5.1.34",
     "description": "Kora Labs Common Utilities",
     "main": "index.js",
     "types": "index.d.ts",

package/utils/crypto/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import { AddressDetails, AddressType, AssetNameLabel } from '../../types';
 export declare const getNativeCrypto: () => Promise<any>;
 export declare function dec2hex(dec: number): string;
@@ -17,8 +19,9 @@ export declare const buildPaymentAddressType: (address: string) => AddressType;
 export declare const buildStakeKey: (address: string) => string | null;
 export declare const getPaymentKeyHash: (address: string) => Promise<string | null>;
 export declare const bech32FromHex: (hex: string, isTestnet?: boolean, type?: 'addr' | 'stake' | 'pool' | 'drep' | 'cc_hot' | 'cc_cold') => string;
+export declare const bech32AddressFromHashes: (paymentHash: string, paymentHashType?: 'key' | 'script', stakeHash?: string, stakeHashType?: 'key' | 'script', type?: 'addr' | 'stake', isTestnet?: boolean) => string;
 export declare const getAddressHolderDetails: (addr: string) => AddressDetails;
 export declare const checkKnownSmartContracts: (address: string, stake?: string | null) => string;
 export declare const getDateStringFromSlot: (currentSlot: number) => Date;
 export declare const getSlotNumberFromDate: (date: Date) => number;
-export declare const blake2b: (input: string, outlen?: number) => string;
+export declare const blake2b: (input: string | Buffer | Uint8Array, outlen?: number) => string;

package/utils/crypto/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.blake2b = exports.getSlotNumberFromDate = exports.getDateStringFromSlot = exports.checkKnownSmartContracts = exports.getAddressHolderDetails = exports.bech32FromHex = exports.getPaymentKeyHash = exports.buildStakeKey = exports.buildPaymentAddressType = exports.getPaymentAddressType = exports.checkNameLabel = exports.parseAssetNameLabel = exports.decodeAddress = exports.getChallengeFromVerifier = exports.base64urlencode = exports.sha256 = exports.getRandomCodeVerifier = exports.dec2hex = exports.getNativeCrypto = void 0;
+exports.blake2b = exports.getSlotNumberFromDate = exports.getDateStringFromSlot = exports.checkKnownSmartContracts = exports.getAddressHolderDetails = exports.bech32AddressFromHashes = exports.bech32FromHex = exports.getPaymentKeyHash = exports.buildStakeKey = exports.buildPaymentAddressType = exports.getPaymentAddressType = exports.checkNameLabel = exports.parseAssetNameLabel = exports.decodeAddress = exports.getChallengeFromVerifier = exports.base64urlencode = exports.sha256 = exports.getRandomCodeVerifier = exports.dec2hex = exports.getNativeCrypto = void 0;
 const bech32_1 = require("bech32");
 const blakejs_1 = require("blakejs");
 const bs58_1 = __importDefault(require("bs58"));
@@ -218,6 +218,23 @@ const bech32FromHex = (hex, isTestnet = !constants_1.IS_PRODUCTION, type = 'addr
     return bech32_1.bech32.encode(prefix, words, bytes.length * 2 + prefix.length);
 };
 exports.bech32FromHex = bech32FromHex;
+const bech32AddressFromHashes = (paymentHash, paymentHashType = 'key', stakeHash = '', stakeHashType = 'key', type = 'addr', isTestnet = !constants_1.IS_PRODUCTION) => {
+    let headerByte = 0;
+    if (!stakeHash) {
+        headerByte += 6;
+    }
+    else {
+        if (stakeHashType == 'script') {
+            headerByte += 2;
+        }
+    }
+    if (paymentHashType == 'script') {
+        headerByte += 1;
+    }
+    const hex = `${headerByte.toString(16)}${isTestnet ? 0 : 1}${paymentHash}${stakeHash}`;
+    return (0, exports.bech32FromHex)(hex, isTestnet, type);
+};
+exports.bech32AddressFromHashes = bech32AddressFromHashes;
 const getAddressHolderDetails = (addr) => {
     const addressType = (0, exports.buildPaymentAddressType)(addr);
     let knownOwnerName = (0, exports.checkKnownSmartContracts)(addr);
@@ -290,6 +307,6 @@ const getSlotNumberFromDate = (date) => {
 };
 exports.getSlotNumberFromDate = getSlotNumberFromDate;
 const blake2b = (input, outlen = 32) => {
-    return (0, blakejs_1.blake2bHex)(input, undefined, outlen);
+    return (0, blakejs_1.blake2bHex)(typeof input == 'string' ? Buffer.from(input, 'hex') : input, undefined, outlen);
 };
 exports.blake2b = blake2b;

package/handles/interfaces/handlesRepository.d.ts

@@ -1,63 +0,0 @@
-import { IHandleFileContent, IHandleStats, IUTxO } from '..';
-import { HandlePaginationModel } from '../models/handlePagination.model';
-import { HandleSearchModel } from '../models/handleSearch.model';
-import { HolderPaginationModel } from '../models/holderPagination.model';
-import { HolderAddressDetails, IHandleStoreMetrics, SaveMintingTxInput, SavePersonalizationInput, SaveSubHandleSettingsInput, SaveWalletAddressMoveInput, StoredHandle } from './api';
-export interface IHandlesRepository {
-    initialize: () => IHandlesRepository;
-    getAll: (params: {
-        pagination: HandlePaginationModel;
-        search: HandleSearchModel;
-    }) => Promise<{
-        searchTotal: number;
-        handles: StoredHandle[];
-    }>;
-    getHandlesByPaymentKeyHashes: (hashes: string[]) => string[];
-    getHandlesByAddresses: (addresses: string[]) => string[];
-    getHandlesByHolderAddresses: (addresses: string[]) => string[];
-    getHandlesByStakeKeyHashes: (hashes: string[]) => string[];
-    getAllHandleNames: (search: HandleSearchModel, sort: string) => Promise<string[]>;
-    getHandleByName: (handleName: string) => Promise<StoredHandle | null>;
-    getHandleByHex: (handleHex: string) => Promise<StoredHandle | null>;
-    getHolderAddressDetails: (key: string) => Promise<HolderAddressDetails>;
-    getAllHolders: (params: {
-        pagination: HolderPaginationModel;
-    }) => Promise<HolderAddressDetails[]>;
-    getHandleStats: () => IHandleStats;
-    getTotalHandlesStats: () => {
-        total_handles: number;
-        total_holders: number;
-    };
-    currentHttpStatus: () => number;
-    getHandleDatumByName: (handleName: string) => Promise<string | null>;
-    getSubHandleSettings: (handleName: string) => Promise<{
-        settings?: string;
-        utxo: IUTxO;
-    } | null>;
-    getSubHandles: (handleName: string) => Promise<StoredHandle[]>;
-    getTimeMetrics: () => {
-        elapsedOgmiosExec: number;
-        elapsedBuildingExec: number;
-    };
-    setMetrics: (metrics: IHandleStoreMetrics) => void;
-    getMetrics: () => IHandleStats;
-    getFilesContent(): Promise<IHandleFileContent[] | null>;
-    prepareHandlesStorage: (fileContent: IHandleFileContent) => Promise<void>;
-    rollBackToGenesis: () => Promise<void>;
-    isCaughtUp: () => boolean;
-    burnHandle: (handleName: string, slotNumber: number) => Promise<void>;
-    rewindChangesToSlot: ({ slot, hash, lastSlot }: {
-        slot: number;
-        hash: string;
-        lastSlot: number;
-    }) => Promise<{
-        name: string;
-        action: string;
-        handle: Partial<StoredHandle> | undefined;
-    }[]>;
-    savePersonalizationChange: ({ name, hex, personalization, reference_token, personalizationDatum, slotNumber, metadata }: SavePersonalizationInput) => Promise<void>;
-    saveSubHandleSettingsChange: ({ name, settingsDatum, utxoDetails, slotNumber }: SaveSubHandleSettingsInput) => Promise<void>;
-    saveMintedHandle: (input: SaveMintingTxInput) => Promise<void>;
-    saveHandleUpdate: ({ name, adaAddress, utxo, slotNumber, datum, script }: SaveWalletAddressMoveInput) => Promise<void>;
-    destroy: () => void;
-}