@ar.io/sdk 3.24.0 → 4.0.0-alpha.1

package/lib/cjs/types/token.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mARIOToken = exports.ARIOToken = void 0;
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const constants_js_1 = require("../constants.js");
-class PositiveFiniteInteger {
-    positiveFiniteInteger;
-    constructor(positiveFiniteInteger) {
-        this.positiveFiniteInteger = positiveFiniteInteger;
-        if (!Number.isFinite(this.positiveFiniteInteger) ||
-            !Number.isInteger(this.positiveFiniteInteger) ||
-            this.positiveFiniteInteger < 0) {
-            throw new Error(`Number must be a non-negative integer value! ${positiveFiniteInteger}`);
-        }
-    }
-    [Symbol.toPrimitive](hint) {
-        if (hint === 'string') {
-            this.toString();
-        }
-        return this.positiveFiniteInteger;
-    }
-    plus(positiveFiniteInteger) {
-        return new PositiveFiniteInteger(this.positiveFiniteInteger + positiveFiniteInteger.positiveFiniteInteger);
-    }
-    minus(positiveFiniteInteger) {
-        return new PositiveFiniteInteger(this.positiveFiniteInteger - positiveFiniteInteger.positiveFiniteInteger);
-    }
-    isGreaterThan(positiveFiniteInteger) {
-        return (this.positiveFiniteInteger > positiveFiniteInteger.positiveFiniteInteger);
-    }
-    isGreaterThanOrEqualTo(positiveFiniteInteger) {
-        return (this.positiveFiniteInteger >= positiveFiniteInteger.positiveFiniteInteger);
-    }
-    isLessThan(positiveFiniteInteger) {
-        return (this.positiveFiniteInteger < positiveFiniteInteger.positiveFiniteInteger);
-    }
-    isLessThanOrEqualTo(positiveFiniteInteger) {
-        return (this.positiveFiniteInteger <= positiveFiniteInteger.positiveFiniteInteger);
-    }
-    toString() {
-        return `${this.positiveFiniteInteger}`;
-    }
-    valueOf() {
-        return this.positiveFiniteInteger;
-    }
-    toJSON() {
-        return this.positiveFiniteInteger;
-    }
-    equals(other) {
-        return this.positiveFiniteInteger === other.positiveFiniteInteger;
-    }
-}
-class ARIOToken {
-    value;
-    constructor(value) {
-        if (!Number.isFinite(value) || value < 0) {
-            throw new Error('ARIOToken must be a non-negative finite number');
-        }
-        this.value = +value.toFixed(6);
-    }
-    valueOf() {
-        return this.value;
-    }
-    toMARIO() {
-        return new mARIOToken(Math.floor(this.value * constants_js_1.MARIO_PER_ARIO));
-    }
-    toString() {
-        return `${this.value}`;
-    }
-}
-exports.ARIOToken = ARIOToken;
-class mARIOToken extends PositiveFiniteInteger {
-    constructor(value) {
-        super(value);
-    }
-    multiply(multiplier) {
-        // always round down on multiplication and division
-        const result = Math.floor(this.valueOf() * multiplier.valueOf());
-        return new mARIOToken(result);
-    }
-    divide(divisor) {
-        if (divisor.valueOf() === 0) {
-            // TODO: how should we handle this
-            throw new Error('Cannot divide by zero');
-        }
-        // always round down on multiplication and division
-        const result = Math.floor(this.valueOf() / divisor.valueOf());
-        return new mARIOToken(result);
-    }
-    plus(addend) {
-        const result = super.plus(addend);
-        return new mARIOToken(result.valueOf());
-    }
-    minus(subtractHend) {
-        const result = super.minus(subtractHend);
-        return new mARIOToken(result.valueOf());
-    }
-    toARIO() {
-        return new ARIOToken(this.valueOf() / constants_js_1.MARIO_PER_ARIO);
-    }
-}
-exports.mARIOToken = mARIOToken;

package/lib/cjs/utils/ant.js

@@ -1,108 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertHyperBeamStateToAoANTState = exports.isHyperBeamANTState = exports.sortANTRecords = void 0;
-/**
- * Sorts ANT records by priority and then lexicographically.
- *
- * Note: javascript guarantees that the order of objects in an object is persistent. Still, adding index to each record is useful for enforcing against undername limits.
- *
- * Reference: https://github.com/ar-io/ar-io-node/blob/e0a9ec56559cad1b3e35d668563871afb8649913/docs/madr/003-arns-undername-limits.md
- *
- * @param antRecords - The ANT records to sort.
- */
-const sortANTRecords = (antRecords) => {
-    const sortedEntries = Object.entries(antRecords).sort(([a, aRecord], [b, bRecord]) => {
-        // '@' is the root name and should be resolved first
-        if (a === '@') {
-            return -1;
-        }
-        if (b === '@') {
-            return 1;
-        }
-        // if a record has a priority, it should be resolved before any other record without a priority
-        if ('priority' in aRecord && !('priority' in bRecord)) {
-            return -1;
-        }
-        if (!('priority' in aRecord) && 'priority' in bRecord) {
-            return 1;
-        }
-        // if both records have a priority, sort by priority and fallback to lexicographic sorting
-        if (aRecord.priority !== undefined && bRecord.priority !== undefined) {
-            if (aRecord.priority === bRecord.priority) {
-                // use deterministic comparison instead of localeCompare to avoid locale-specific sorting
-                return a < b ? -1 : a > b ? 1 : 0;
-            }
-            return aRecord.priority - bRecord.priority;
-        }
-        // all other records are sorted lexicographically, using deterministic comparison instead of localeCompare to avoid locale-specific sorting
-        return a < b ? -1 : a > b ? 1 : 0;
-    });
-    // now that they are sorted, add the index to each record - this is their position in the sorted list and is used to enforce undername limits
-    return Object.fromEntries(sortedEntries.map(([a, aRecord], index) => [a, { ...aRecord, index }]));
-};
-exports.sortANTRecords = sortANTRecords;
-/**
- * @deprecated - this is no longer necessary because HyperBeam now uses the AoANTState type
- */
-const isHyperBeamANTState = (state) => {
-    return ('name' in state &&
-        'ticker' in state &&
-        'description' in state &&
-        'keywords' in state &&
-        'denomination' in state &&
-        'owner' in state &&
-        'controllers' in state &&
-        'records' in state &&
-        'balances' in state &&
-        'logo' in state &&
-        'totalsupply' in state &&
-        'initialized' in state);
-};
-exports.isHyperBeamANTState = isHyperBeamANTState;
-/**
- * Convert HyperBeam serialized ANT state to backwards compatible format.
- *
- * @deprecated - this is no longer necessary because HyperBeam now uses the AOANTState type
- * @param state - The HyperBeam serialized ANT state.
- */
-const convertHyperBeamStateToAoANTState = (initialState) => {
-    function lowerCaseKeys(obj) {
-        return Object.fromEntries(Object.entries(obj).map(([key, value]) => {
-            if (key.toLowerCase().includes('balances')) {
-                return [key.toLowerCase(), value];
-            }
-            if (typeof value === 'object' &&
-                !Array.isArray(value) &&
-                value !== null) {
-                return [key.toLowerCase(), lowerCaseKeys(value)];
-            }
-            return [key.toLowerCase(), value];
-        }));
-    }
-    // we need to ensure keys are lower cased because hyperbeam json serializes keys to lowercase inconsistently
-    const state = lowerCaseKeys(initialState);
-    return {
-        Name: state.name,
-        Ticker: state.ticker,
-        Description: state.description,
-        Keywords: state.keywords,
-        Denomination: parseInt(state.denomination),
-        Owner: state.owner,
-        Controllers: state.controllers,
-        Records: Object.entries(state.records).reduce((acc, [key, record]) => {
-            acc[key] = {
-                transactionId: record.transactionid,
-                ttlSeconds: record.ttlseconds,
-                ...(record.priority !== undefined
-                    ? { priority: record.priority }
-                    : {}),
-            };
-            return acc;
-        }, {}),
-        Balances: state.balances,
-        Logo: state.logo,
-        TotalSupply: state.totalsupply || 1,
-        Initialized: state.initialized,
-    };
-};
-exports.convertHyperBeamStateToAoANTState = convertHyperBeamStateToAoANTState;

package/lib/cjs/utils/ao.js

@@ -1,432 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultANTLogoId = exports.defaultTargetManifestId = void 0;
-exports.spawnANT = spawnANT;
-exports.forkANT = forkANT;
-exports.evolveANT = evolveANT;
-exports.isAoSigner = isAoSigner;
-exports.createAoSigner = createAoSigner;
-exports.initANTStateForAddress = initANTStateForAddress;
-exports.parseAoEpochData = parseAoEpochData;
-exports.errorMessageFromOutput = errorMessageFromOutput;
-exports.removeUnicodeFromError = removeUnicodeFromError;
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const arbundles_1 = require("@dha-team/arbundles");
-const aoconnect_1 = require("@permaweb/aoconnect");
-const zod_1 = require("zod");
-const ant_registry_js_1 = require("../common/ant-registry.js");
-const ant_versions_js_1 = require("../common/ant-versions.js");
-const arweave_js_1 = require("../common/arweave.js");
-const index_js_1 = require("../common/index.js");
-const constants_js_1 = require("../constants.js");
-const ant_js_1 = require("../types/ant.js");
-const schema_js_1 = require("./schema.js");
-async function spawnANT({ signer, module, ao = (0, aoconnect_1.connect)({
-    MODE: 'legacy',
-}), scheduler = constants_js_1.DEFAULT_SCHEDULER_ID, state, tags = [], antRegistryId = constants_js_1.ANT_REGISTRY_ID, logger = index_js_1.Logger.default, authority = constants_js_1.AO_AUTHORITY, onSigningProgress = (name, payload) => {
-    logger.debug('Signing progress', { name, payload });
-}, hyperbeamUrl, }) {
-    if (state) {
-        (0, schema_js_1.parseSchemaResult)(ant_js_1.SpawnANTStateSchema, state);
-    }
-    let version;
-    if (module === undefined) {
-        const antRegistry = ant_versions_js_1.ANTVersions.init({
-            process: new index_js_1.AOProcess({
-                processId: antRegistryId,
-                ao,
-                logger,
-            }),
-        });
-        const { moduleId: latestAntModule, version: latestVersion } = await antRegistry.getLatestANTVersion();
-        logger.debug('Spawning new ANT with latest module from ANT registry', {
-            moduleId: latestAntModule,
-            version: latestVersion,
-            antRegistryId,
-        });
-        module = latestAntModule;
-        version = latestVersion;
-    }
-    onSigningProgress?.('spawning-ant', {
-        moduleId: module,
-        antRegistryId,
-        version,
-        state,
-    });
-    const processId = await ao.spawn({
-        module,
-        scheduler,
-        signer,
-        data: state ? JSON.stringify(state) : undefined,
-        tags: [
-            // Required for AOS to initialize the authorities table
-            {
-                name: 'Authority',
-                value: authority,
-            },
-            {
-                name: 'ANT-Registry-Id',
-                value: antRegistryId,
-            },
-            ...tags,
-        ],
-    });
-    /**
-     * Note: if we are given a state, ensure the ANT was initialized with it
-     * there is a bug in the ANT source where we try to parse the empty default
-     * 'Data' string as JSON that causes the Invalid-Boot-Notice error, even though
-     * the ANT was initialized with the default state set by the ANT source code.
-     *
-     * Reference: https://github.com/ar-io/ar-io-ant-process/blob/b89018ffcce079add2e90e7ab82d0bbc9b671346/src/common/main.lua#L355-L358
-     */
-    if (state !== undefined) {
-        let bootRes;
-        let attempts = 0;
-        while (attempts < 5 && bootRes === undefined) {
-            try {
-                // TODO: could add a progress event here to show the boot progress and number of attempts
-                if (bootRes === undefined) {
-                    bootRes = await ao.result({
-                        process: processId,
-                        message: processId,
-                    });
-                }
-                break;
-            }
-            catch (error) {
-                logger.debug('Retrying ANT boot result fetch', {
-                    processId,
-                    module,
-                    scheduler,
-                    attempts,
-                    error,
-                });
-                attempts++;
-                await new Promise((resolve) => setTimeout(resolve, 1000 * attempts ** 2));
-            }
-        }
-        if (bootRes === undefined ||
-            bootRes.Messages?.some((m) => m?.Tags?.some((t) => t.value === 'Invalid-Boot-Notice'))) {
-            if (bootRes === undefined) {
-                throw new Error('Failed to get boot result');
-            }
-            const bootError = errorMessageFromOutput(bootRes);
-            logger.error('ANT failed to boot correctly', {
-                processId,
-                module,
-                scheduler,
-                bootRes,
-                bootError,
-            });
-            throw new Error(`ANT failed to boot correctly: ${bootError}`);
-        }
-    }
-    onSigningProgress?.('verifying-state', {
-        processId,
-        moduleId: module,
-        antRegistryId,
-    });
-    // Note: for hyperbeam caching, due to a SU issue, we need to send a second message to the ANT to cache the state
-    // We wait for the first message to be processed before sending the second one to ensure this is the second message
-    // We use the resulting state to check the owner of the ANT is set in the registry. Should this be patched on MUs,
-    // we can convert to just a simple dry-run to avoid sending/signing another message.
-    let owner;
-    try {
-        const processApi = new index_js_1.AOProcess({
-            processId,
-            ao,
-            logger,
-        });
-        const { id } = await processApi.send({
-            tags: [{ name: 'Action', value: 'State' }],
-            signer,
-        });
-        const stateResult = await ao.result({
-            process: processId,
-            message: id,
-        });
-        if (stateResult === undefined) {
-            throw new Error('Failed to get state result');
-        }
-        const { Owner } = JSON.parse(stateResult.Messages?.[0]?.Data ?? '{}');
-        owner = Owner;
-        logger.debug(`Successfully spawned new ANT and validated owner`, {
-            processId,
-            module,
-            owner,
-        });
-    }
-    catch (error) {
-        logger.error('Failed to validate owner of spawned ANT', {
-            processId,
-            module,
-            error,
-        });
-        throw error;
-    }
-    /**
-     * Now confirm the owner of the ANT is set in the registry
-     * This is to ensure the ANT is available via the ANT registry
-     * for the owner to find and use the ANT.
-     */
-    if (owner === undefined) {
-        throw new Error(`Spawning ANT (${processId}) failed to set owner`);
-    }
-    onSigningProgress?.('registering-ant', {
-        processId,
-        antRegistryId,
-        owner,
-    });
-    // check the ACL for the owner
-    const antRegistry = ant_registry_js_1.ANTRegistry.init({
-        signer,
-        process: new index_js_1.AOProcess({
-            processId: antRegistryId,
-            ao,
-            logger,
-        }),
-        hyperbeamUrl,
-    });
-    let attempts = 0;
-    const maxAttempts = 5;
-    while (attempts < maxAttempts) {
-        try {
-            const acl = await antRegistry.accessControlList({ address: owner });
-            if (acl === undefined) {
-                throw new Error('ACL not found for owner');
-            }
-            const { Owned } = acl;
-            if (!Owned.includes(processId)) {
-                throw new Error(`Spawned ANT (${processId}) not found in registry for owner ${owner}`);
-            }
-            return processId;
-        }
-        catch (error) {
-            logger.debug('Retrying ANT registry access control list fetch', {
-                owner,
-                antRegistryId,
-                attempts,
-                error,
-            });
-            attempts++;
-            await new Promise((resolve) => setTimeout(resolve, 1000 * attempts ** 2));
-        }
-    }
-    return processId;
-}
-async function forkANT({ signer, antProcessId, logger = index_js_1.Logger.default, ao, moduleId, antRegistryId = constants_js_1.ANT_REGISTRY_ID, onSigningProgress = (name, payload) => {
-    logger.debug('Forking ANT', { name, payload });
-}, hyperbeamUrl, }) {
-    // get the state of the current ANT and use it to spawn a new ANT
-    const ant = index_js_1.ANT.init({
-        process: new index_js_1.AOProcess({
-            processId: antProcessId,
-            ao,
-            logger,
-        }),
-        hyperbeamUrl,
-    });
-    const state = await ant.getState();
-    if (state === undefined) {
-        throw new Error(`ANT state (${antProcessId}) is undefined and cannot be upgraded`);
-    }
-    const forkedProcessId = await spawnANT({
-        signer,
-        antRegistryId,
-        ao,
-        logger,
-        module: moduleId,
-        onSigningProgress,
-        state: {
-            owner: state.Owner,
-            name: state.Name,
-            ticker: state.Ticker,
-            description: state.Description,
-            keywords: state.Keywords,
-            controllers: state.Controllers,
-            records: state.Records,
-            balances: state.Balances,
-            logo: state.Logo,
-        },
-        hyperbeamUrl,
-    });
-    return forkedProcessId;
-}
-/**
- * @deprecated
- * Direct Evals are not encouraged when dealing with ANTs.
- * Instead, use spawnANT to fork an ANT to new module source code
- */
-async function evolveANT({ signer, processId, luaCodeTxId = constants_js_1.ANT_LUA_ID, ao = (0, aoconnect_1.connect)({
-    MODE: 'legacy',
-}), logger = index_js_1.Logger.default, arweave = arweave_js_1.defaultArweave, }) {
-    const aosClient = new index_js_1.AOProcess({
-        processId,
-        ao,
-        logger,
-    });
-    logger.warn('Directly running an Eval on a process is not encouraged.');
-    //TODO: cache locally and only fetch if not cached
-    // We do not use arweave to get the data because it may throw on l2 tx data
-    const { api: { host, port, protocol }, } = arweave.getConfig();
-    const luaString = await fetch(`${protocol}://${host}:${port}/${luaCodeTxId}`).then((res) => res.text());
-    const { id: evolveMsgId } = await aosClient.send({
-        tags: [
-            { name: 'Action', value: 'Eval' },
-            { name: 'App-Name', value: 'ArNS-ANT' },
-            { name: 'Source-Code-TX-ID', value: luaCodeTxId },
-        ],
-        data: luaString,
-        signer,
-    });
-    logger.debug(`Evolved ANT`, {
-        processId,
-        luaCodeTxId,
-        evalMsgId: evolveMsgId,
-    });
-    return evolveMsgId;
-}
-function isAoSigner(value) {
-    const TagSchema = zod_1.z.object({
-        name: zod_1.z.string(),
-        value: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]),
-    });
-    const AoSignerSchema = zod_1.z
-        .function()
-        .args(zod_1.z.object({
-        data: zod_1.z.union([zod_1.z.string(), zod_1.z.instanceof(Buffer)]),
-        tags: zod_1.z.array(TagSchema).optional(),
-        target: zod_1.z.string().optional(),
-        anchor: zod_1.z.string().optional(),
-    }))
-        .returns(zod_1.z.promise(zod_1.z.object({
-        id: zod_1.z.string(),
-        raw: zod_1.z.instanceof(ArrayBuffer),
-    })));
-    try {
-        AoSignerSchema.parse(value);
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-function createAoSigner(signer) {
-    if (isAoSigner(signer)) {
-        return signer;
-    }
-    if (!('publicKey' in signer)) {
-        return (0, aoconnect_1.createDataItemSigner)(signer);
-    }
-    const aoSigner = async ({ data, tags, target, anchor }) => {
-        // ensure appropriate permissions are granted with injected signers.
-        if (signer.publicKey === undefined &&
-            'setPublicKey' in signer &&
-            typeof signer.setPublicKey === 'function') {
-            await signer.setPublicKey();
-        }
-        if (signer instanceof arbundles_1.ArconnectSigner) {
-            // Sign using Arconnect signDataItem API
-            const signedDataItem = await signer['signer'].signDataItem({
-                data,
-                tags,
-                target,
-                anchor,
-            });
-            const dataItem = new arbundles_1.DataItem(Buffer.from(signedDataItem));
-            return {
-                id: await dataItem.id,
-                raw: await dataItem.getRaw(),
-            };
-        }
-        const dataItem = (0, arbundles_1.createData)(data, signer, { tags, target, anchor });
-        const signedData = dataItem.sign(signer).then(async () => ({
-            id: await dataItem.id,
-            raw: await dataItem.getRaw(),
-        }));
-        return signedData;
-    };
-    // eslint-disable-next-line
-    // @ts-ignore Buffer vs ArrayBuffer type mismatch
-    return aoSigner;
-}
-exports.defaultTargetManifestId = '-k7t8xMoB8hW482609Z9F4bTFMC3MnuW8bTvTyT8pFI';
-exports.defaultANTLogoId = 'Sie_26dvgyok0PZD_-iQAFOhOd5YxDTkczOLoqTTL_A';
-function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords = [], controllers = [], description = '', ticker = 'aos', name = 'ANT', logo = exports.defaultANTLogoId, }) {
-    return {
-        ticker,
-        name,
-        description,
-        keywords,
-        owner,
-        controllers: [owner, ...controllers],
-        balances: { [owner]: 1 },
-        records: {
-            ['@']: {
-                transactionId: targetId ?? exports.defaultTargetManifestId.toString(),
-                ttlSeconds,
-            },
-        },
-        logo,
-    };
-}
-/**
- * Uses zod schema to parse the epoch data
- */
-function parseAoEpochData(value) {
-    const epochDataSchema = zod_1.z.object({
-        startTimestamp: zod_1.z.number(),
-        startHeight: zod_1.z.number(),
-        distributions: zod_1.z.any(), // TODO: add full distributed object type
-        endTimestamp: zod_1.z.number(),
-        prescribedObservers: zod_1.z.any(),
-        prescribedNames: zod_1.z.array(zod_1.z.string()),
-        observations: zod_1.z.any(),
-        epochIndex: zod_1.z.number(),
-        arnsStats: zod_1.z.any(),
-    });
-    return epochDataSchema.parse(value);
-}
-function errorMessageFromOutput(output) {
-    const errorData = output.Error;
-    // Attempt to extract error details from Messages.Tags if Error is undefined
-    const error = errorData ??
-        output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')?.value;
-    if (error !== undefined) {
-        const errorStackTrace = output.Messages?.[0]?.Data;
-        const errorMessage = errorStackTrace ?? error;
-        // Regex to match AO error messages like: [string ".src.main"]:5111: Primary name data not found
-        // or [string "aos"]:128: some error
-        const match = errorMessage?.match(/\[string "(.+)"\]:(\d+):\s*(.*)/);
-        if (match) {
-            // The first group is the src file, the second is the line number, and the third is the error message
-            const [, , lineNumber, errorMessage] = match;
-            const cleanError = removeUnicodeFromError(errorMessage);
-            return `${cleanError.trim()} (line ${lineNumber.trim()})`.trim();
-        }
-        // With no match, just remove unicode
-        return removeUnicodeFromError(error);
-    }
-    return undefined;
-}
-function removeUnicodeFromError(error) {
-    //The regular expression /[\u001b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g is designed to match ANSI escape codes used for terminal formatting. These are sequences that begin with \u001b (ESC character) and are often followed by [ and control codes.
-    const ESC = String.fromCharCode(27); // Represents '\u001b' or '\x1b'
-    return error
-        .replace(new RegExp(`${ESC}[\\[\\]()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]`, 'g'), '')
-        .trim();
-}