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

package/lib/cjs/cli/commands/readCommands.js

@@ -1,215 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGateway = getGateway;
-exports.listGateways = listGateways;
-exports.listAllDelegatesCLICommand = listAllDelegatesCLICommand;
-exports.getGatewayDelegates = getGatewayDelegates;
-exports.getDelegations = getDelegations;
-exports.getAllowedDelegates = getAllowedDelegates;
-exports.getArNSRecord = getArNSRecord;
-exports.listArNSRecords = listArNSRecords;
-exports.listArNSRecordsForAddress = listArNSRecordsForAddress;
-exports.getArNSReservedName = getArNSReservedName;
-exports.listArNSReservedNames = listArNSReservedNames;
-exports.getArNSReturnedName = getArNSReturnedName;
-exports.listArNSReturnedNames = listArNSReturnedNames;
-exports.getEpoch = getEpoch;
-exports.getPrescribedObservers = getPrescribedObservers;
-exports.getPrescribedNames = getPrescribedNames;
-exports.getTokenCost = getTokenCost;
-exports.getCostDetails = getCostDetails;
-exports.getPrimaryName = getPrimaryName;
-exports.getGatewayVaults = getGatewayVaults;
-exports.getAllGatewayVaults = getAllGatewayVaults;
-exports.getVault = getVault;
-exports.resolveArNSName = resolveArNSName;
-exports.listAntsForAddress = listAntsForAddress;
-const token_js_1 = require("../../types/token.js");
-const utils_js_1 = require("../utils.js");
-async function getGateway(o) {
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const gateway = await (0, utils_js_1.readARIOFromOptions)(o).getGateway({
-        address,
-    });
-    return gateway ?? { message: `No gateway found for address ${address}` };
-}
-async function listGateways(o) {
-    const gateways = await (0, utils_js_1.readARIOFromOptions)(o).getGateways((0, utils_js_1.paginationParamsFromOptions)(o));
-    return gateways.items.length ? gateways : { message: 'No gateways found' };
-}
-async function listAllDelegatesCLICommand(o) {
-    const delegates = await (0, utils_js_1.readARIOFromOptions)(o).getAllDelegates((0, utils_js_1.paginationParamsFromOptions)(o));
-    return delegates.items.length ? delegates : { message: 'No delegates found' };
-}
-async function getGatewayDelegates(o) {
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getGatewayDelegates({
-        address,
-        ...(0, utils_js_1.paginationParamsFromOptions)(o),
-    });
-    return result.items?.length
-        ? result
-        : {
-            message: `No delegates found for gateway ${address}`,
-        };
-}
-async function getDelegations(o) {
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getDelegations({
-        address,
-        ...(0, utils_js_1.paginationParamsFromOptions)(o),
-    });
-    return result.items?.length
-        ? result
-        : {
-            message: `No delegations found for address ${address}`,
-        };
-}
-async function getAllowedDelegates(o) {
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getAllowedDelegates({
-        address,
-        ...(0, utils_js_1.paginationParamsFromOptions)(o),
-    });
-    return result.items?.length
-        ? result
-        : {
-            message: `No allow list found for gateway delegate ${address}`,
-        };
-}
-async function getArNSRecord(o) {
-    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
-    return ((await (0, utils_js_1.readARIOFromOptions)(o).getArNSRecord({
-        name,
-    })) ?? { message: `No record found for name ${name}` });
-}
-async function listArNSRecords(o) {
-    const records = await (0, utils_js_1.readARIOFromOptions)(o).getArNSRecords((0, utils_js_1.paginationParamsFromOptions)(o));
-    return records.items.length ? records : { message: 'No records found' };
-}
-async function listArNSRecordsForAddress(o) {
-    const paginationParams = (0, utils_js_1.paginationParamsFromOptions)(o);
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const names = await (0, utils_js_1.readARIOFromOptions)(o).getArNSRecordsForAddress({
-        ...paginationParams,
-        address,
-        antRegistryProcessId: o.antRegistryProcessId,
-    });
-    return names.items.length ? names : { message: 'No names found' };
-}
-async function getArNSReservedName(o) {
-    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
-    return ((await (0, utils_js_1.readARIOFromOptions)(o).getArNSReservedName({
-        name,
-    })) ?? { message: `No reserved name found for name ${name}` });
-}
-async function listArNSReservedNames(o) {
-    const reservedNames = await (0, utils_js_1.readARIOFromOptions)(o).getArNSReservedNames((0, utils_js_1.paginationParamsFromOptions)(o));
-    return reservedNames.items.length
-        ? reservedNames
-        : { message: 'No reserved names found' };
-}
-async function getArNSReturnedName(o) {
-    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getArNSReturnedName({ name });
-    return result ?? { message: `No returned name found for name ${name}` };
-}
-async function listArNSReturnedNames(o) {
-    const returnedNames = await (0, utils_js_1.readARIOFromOptions)(o).getArNSReturnedNames((0, utils_js_1.paginationParamsFromOptions)(o));
-    return returnedNames.items.length
-        ? returnedNames
-        : { message: 'No returned names found' };
-}
-async function getEpoch(o) {
-    const epoch = await (0, utils_js_1.readARIOFromOptions)(o).getEpoch((0, utils_js_1.epochInputFromOptions)(o));
-    return epoch ?? { message: `No epoch found for provided input` };
-}
-async function getPrescribedObservers(o) {
-    const epoch = (0, utils_js_1.epochInputFromOptions)(o);
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getPrescribedObservers(epoch);
-    return (result ?? { message: `No prescribed observers found for epoch ${epoch}` });
-}
-async function getPrescribedNames(o) {
-    const epoch = (0, utils_js_1.epochInputFromOptions)(o);
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getPrescribedNames((0, utils_js_1.epochInputFromOptions)(o));
-    return result ?? { message: `No prescribed names found for epoch ${epoch}` };
-}
-async function getTokenCost(o) {
-    const tokenCost = await (0, utils_js_1.readARIOFromOptions)(o).getTokenCost((0, utils_js_1.getTokenCostParamsFromOptions)(o));
-    const output = {
-        mARIOTokenCost: tokenCost,
-        message: `The cost of the provided action is ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(tokenCost).toARIO())} ARIO`,
-    };
-    return output;
-}
-async function getCostDetails(o) {
-    const costDetails = await (0, utils_js_1.readARIOFromOptions)(o).getCostDetails({
-        ...(0, utils_js_1.getTokenCostParamsFromOptions)(o),
-        fundFrom: (0, utils_js_1.fundFromFromOptions)(o),
-    });
-    const output = {
-        ...costDetails,
-        message: `The cost of the provided action is ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(costDetails.tokenCost).toARIO())} ARIO${costDetails.fundingPlan && costDetails.fundingPlan.shortfall > 0
-            ? `. Insufficient funds for action. There is a shortfall of ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(costDetails.fundingPlan.shortfall).toARIO())} ARIO`
-            : ''}`,
-    };
-    return output;
-}
-async function getPrimaryName(o) {
-    const address = (0, utils_js_1.addressFromOptions)(o);
-    const name = o.name;
-    const params = name !== undefined
-        ? { name }
-        : address !== undefined
-            ? { address }
-            : undefined;
-    if (params === undefined) {
-        throw new Error('Either --address or --name is required');
-    }
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getPrimaryName(params);
-    return (result ?? {
-        message: `No primary name found`,
-    });
-}
-async function getGatewayVaults(o) {
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getGatewayVaults({
-        address,
-        ...(0, utils_js_1.paginationParamsFromOptions)(o),
-    });
-    return result.items?.length
-        ? result
-        : {
-            message: `No vaults found for gateway ${address}`,
-        };
-}
-async function getAllGatewayVaults(o) {
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).getAllGatewayVaults((0, utils_js_1.paginationParamsFromOptions)(o));
-    return result.items?.length
-        ? result
-        : {
-            message: `No vaults found`,
-        };
-}
-async function getVault(o) {
-    return (0, utils_js_1.readARIOFromOptions)(o)
-        .getVault({
-        address: (0, utils_js_1.requiredAddressFromOptions)(o),
-        vaultId: (0, utils_js_1.requiredStringFromOptions)(o, 'vaultId'),
-    })
-        .then((r) => r ?? {
-        message: `No vault found for provided address and vault ID`,
-    });
-}
-async function resolveArNSName(o) {
-    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
-    const result = await (0, utils_js_1.readARIOFromOptions)(o).resolveArNSName({ name });
-    return result ?? { message: `No record found for name ${name}` };
-}
-async function listAntsForAddress(o) {
-    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
-    const result = await (0, utils_js_1.readANTRegistryFromOptions)(o).accessControlList({
-        address,
-    });
-    return result ?? { message: `No ANTs found for address ${address}` };
-}

package/lib/cjs/cli/commands/transfer.js

@@ -1,159 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transferCLICommand = transferCLICommand;
-exports.vaultedTransferCLICommand = vaultedTransferCLICommand;
-exports.revokeVaultCLICommand = revokeVaultCLICommand;
-exports.createVaultCLICommand = createVaultCLICommand;
-exports.extendVaultCLICommand = extendVaultCLICommand;
-exports.increaseVaultCLICommand = increaseVaultCLICommand;
-const token_js_1 = require("../../types/token.js");
-const utils_js_1 = require("../utils.js");
-async function transferCLICommand(options) {
-    const { target, arioQuantity } = (0, utils_js_1.requiredTargetAndQuantityFromOptions)(options);
-    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(options);
-    if (!options.skipConfirmation) {
-        await (0, utils_js_1.assertEnoughMARIOBalance)({
-            ario,
-            address: signerAddress,
-            mARIOQuantity: arioQuantity.toMARIO(),
-        });
-        const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want to transfer ${(0, utils_js_1.formatARIOWithCommas)(arioQuantity)} ARIO to ${target}?`);
-        if (!confirm) {
-            return { message: 'Transfer aborted by user' };
-        }
-    }
-    const result = await ario.transfer({
-        target,
-        qty: arioQuantity.toMARIO().valueOf(),
-    }, (0, utils_js_1.customTagsFromOptions)(options));
-    const output = {
-        senderAddress: signerAddress,
-        transferResult: result,
-        message: `Successfully transferred ${(0, utils_js_1.formatARIOWithCommas)(arioQuantity)} ARIO to ${target}`,
-    };
-    return output;
-}
-async function vaultedTransferCLICommand(o) {
-    const mARIOQuantity = (0, utils_js_1.requiredMARIOFromOptions)(o, 'quantity');
-    const recipient = (0, utils_js_1.requiredStringFromOptions)(o, 'recipient');
-    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
-    const lockLengthMs = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'lockLengthMs');
-    (0, utils_js_1.assertLockLengthInRange)(lockLengthMs);
-    if (!o.skipConfirmation) {
-        await (0, utils_js_1.assertEnoughMARIOBalance)({
-            ario,
-            address: signerAddress,
-            mARIOQuantity,
-        });
-        const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want transfer ${(0, utils_js_1.formatMARIOToARIOWithCommas)(mARIOQuantity)} ARIO to ${recipient}, locked in a ${o.revokable ? '' : 'non-'}revokable vault for ${lockLengthMs}ms?`);
-        if (!confirm) {
-            return { message: 'Transfer aborted by user' };
-        }
-    }
-    const result = await ario.vaultedTransfer({
-        recipient,
-        quantity: mARIOQuantity,
-        lockLengthMs,
-        revokable: o.revokable,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
-    const output = {
-        senderAddress: signerAddress,
-        transferResult: result,
-        message: `Successfully vaulted transferred ${(0, utils_js_1.formatMARIOToARIOWithCommas)(mARIOQuantity)} ARIO to ${recipient}`,
-    };
-    return output;
-}
-async function revokeVaultCLICommand(o) {
-    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
-    const vaultId = (0, utils_js_1.requiredStringFromOptions)(o, 'vaultId');
-    const recipient = (0, utils_js_1.requiredStringFromOptions)(o, 'recipient');
-    if (!o.skipConfirmation) {
-        const vault = await ario.getVault({ vaultId, address: recipient });
-        const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want to revoke vault with id ${vaultId} from ${recipient} with balance ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(vault.balance).toARIO())} ARIO?`);
-        if (!confirm) {
-            return { message: 'Revoke aborted by user' };
-        }
-    }
-    const result = await ario.revokeVault({
-        vaultId,
-        recipient,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
-    const output = {
-        senderAddress: signerAddress,
-        transferResult: result,
-        message: `Successfully revoked vault with id ${vaultId}`,
-    };
-    return output;
-}
-async function createVaultCLICommand(o) {
-    const mARIOQuantity = (0, utils_js_1.requiredMARIOFromOptions)(o, 'quantity');
-    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
-    const lockLengthMs = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'lockLengthMs');
-    (0, utils_js_1.assertLockLengthInRange)(lockLengthMs);
-    if (!o.skipConfirmation) {
-        await (0, utils_js_1.assertEnoughMARIOBalance)({
-            ario,
-            address: signerAddress,
-            mARIOQuantity,
-        });
-        const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want to create a vault with ${(0, utils_js_1.formatMARIOToARIOWithCommas)(mARIOQuantity)} ARIO, locked for ${lockLengthMs}ms?`);
-        if (!confirm) {
-            return { message: 'Vault creation aborted by user' };
-        }
-    }
-    const result = await ario.createVault({
-        quantity: mARIOQuantity,
-        lockLengthMs,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
-    const output = {
-        senderAddress: signerAddress,
-        transferResult: result,
-        message: `Successfully created vault with ${(0, utils_js_1.formatMARIOToARIOWithCommas)(mARIOQuantity)} ARIO`,
-    };
-    return output;
-}
-async function extendVaultCLICommand(o) {
-    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
-    const vaultId = (0, utils_js_1.requiredStringFromOptions)(o, 'vaultId');
-    const extendLengthMs = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'extendLengthMs');
-    (0, utils_js_1.assertLockLengthInRange)(extendLengthMs, false);
-    if (!o.skipConfirmation) {
-        const vault = await ario.getVault({ vaultId, address: signerAddress });
-        const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want to extend vault with id ${vaultId} for ${extendLengthMs}ms with balance ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(vault.balance).toARIO())} ARIO?`);
-        if (!confirm) {
-            return { message: 'Vault extension aborted by user' };
-        }
-    }
-    const result = await ario.extendVault({
-        vaultId,
-        extendLengthMs,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
-    const output = {
-        senderAddress: signerAddress,
-        transferResult: result,
-        message: `Successfully extended vault with id ${vaultId}`,
-    };
-    return output;
-}
-async function increaseVaultCLICommand(o) {
-    const mARIOQuantity = (0, utils_js_1.requiredMARIOFromOptions)(o, 'quantity');
-    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
-    const vaultId = (0, utils_js_1.requiredStringFromOptions)(o, 'vaultId');
-    if (!o.skipConfirmation) {
-        const vault = await ario.getVault({ vaultId, address: signerAddress });
-        const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want to increase vault with id ${vaultId} by ${(0, utils_js_1.formatMARIOToARIOWithCommas)(mARIOQuantity)} ARIO with balance ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(vault.balance).toARIO())} ARIO?`);
-        if (!confirm) {
-            return { message: 'Vault increase aborted by user' };
-        }
-    }
-    const result = await ario.increaseVault({
-        vaultId,
-        quantity: mARIOQuantity,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
-    const output = {
-        senderAddress: signerAddress,
-        transferResult: result,
-        message: `Successfully increased vault with id ${vaultId} by ${(0, utils_js_1.formatMARIOToARIOWithCommas)(mARIOQuantity)} ARIO`,
-    };
-    return output;
-}