@ar.io/sdk 3.1.0-alpha.1 → 3.1.0-alpha.10

package/lib/esm/cli/commands/arnsPurchaseCommands.js

@@ -0,0 +1,159 @@
+import { assertConfirmationPrompt, assertEnoughBalanceForArNSPurchase, fundFromFromOptions, positiveIntegerFromOptions, recordTypeFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+export async function buyRecordCLICommand(o) {
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const name = requiredStringFromOptions(o, 'name');
+    const type = recordTypeFromOptions(o);
+    const years = positiveIntegerFromOptions(o, 'years');
+    const fundFrom = fundFromFromOptions(o);
+    const processId = o.processId;
+    if (processId === undefined) {
+        // TODO: Spawn ANT process, register it to ANT registry, get process ID
+        throw new Error('Process ID must be provided for buy-record');
+    }
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord !== undefined) {
+            throw new Error(`ArNS Record ${name} is already owned`);
+        }
+        await assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Buy-Record',
+                type,
+                name,
+                years,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to ${type} the record ${name}?`, o);
+    }
+    return ario.buyRecord({
+        name: requiredStringFromOptions(o, 'name'),
+        processId,
+        type,
+        years,
+        fundFrom: fundFromFromOptions(o),
+    }, writeActionTagsFromOptions(o));
+}
+export async function upgradeRecordCLICommand(o) {
+    const name = requiredStringFromOptions(o, 'name');
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const fundFrom = fundFromFromOptions(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        if (existingRecord.type === 'permabuy') {
+            throw new Error(`ArNS Record ${name} is already a permabuy`);
+        }
+        await assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Upgrade-Name',
+                name,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to upgrade the lease of ${name} to a permabuy?`, o);
+    }
+    return ario.upgradeRecord({
+        name,
+        fundFrom,
+    });
+}
+export async function extendLeaseCLICommand(o) {
+    const name = requiredStringFromOptions(o, 'name');
+    const years = requiredPositiveIntegerFromOptions(o, 'years');
+    const fundFrom = fundFromFromOptions(o);
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        if (existingRecord.type === 'permabuy') {
+            throw new Error(`ArNS Record ${name} is a permabuy and cannot be extended`);
+        }
+        await assertEnoughBalanceForArNSPurchase({
+            ario: ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Extend-Lease',
+                name,
+                years,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to extend the lease of ${name} by ${years}?`, o);
+    }
+    return ario.extendLease({
+        name,
+        years,
+    }, writeActionTagsFromOptions(o));
+}
+export async function increaseUndernameLimitCLICommand(o) {
+    const name = requiredStringFromOptions(o, 'name');
+    const increaseCount = requiredPositiveIntegerFromOptions(o, 'increaseCount');
+    const fundFrom = fundFromFromOptions(o);
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        await assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Increase-Undername-Limit',
+                name,
+                quantity: increaseCount,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to increase the undername limit of ${name} by ${increaseCount}?`, o);
+    }
+    return ario.increaseUndernameLimit({
+        name,
+        increaseCount,
+    }, writeActionTagsFromOptions(o));
+}
+export async function requestPrimaryNameCLICommand(o) {
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const fundFrom = fundFromFromOptions(o);
+    const name = requiredStringFromOptions(o, 'name');
+    if (!o.skipConfirmation) {
+        // TODO: Assert name requested is not already owned?
+        // TODO: More assertions?
+        await assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Primary-Name-Request',
+                name,
+                fromAddress: signerAddress,
+                fundFrom,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to request the primary name ${name}?`, o);
+    }
+    return ario.requestPrimaryName({
+        name,
+        fundFrom,
+    }, writeActionTagsFromOptions(o));
+}

package/lib/esm/cli/commands/gatewayWriteCommands.js

@@ -15,7 +15,7 @@
  */
 import prompts from 'prompts';
 import { mARIOToken } from '../../node/index.js';
-import { assertConfirmationPrompt, assertEnoughBalance, formatARIOWithCommas, gatewaySettingsFromOptions, redelegateParamsFromOptions, requiredAddressFromOptions, requiredMIOFromOptions as requiredMARIOFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, stringifyJsonForCLIDisplay, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+import { assertConfirmationPrompt, assertEnoughMARIOBalance, formatARIOWithCommas, gatewaySettingsFromOptions, redelegateParamsFromOptions, requiredAddressFromOptions, requiredMARIOFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, stringifyJsonForCLIDisplay, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
 export async function joinNetwork(options) {
     const { ario, signerAddress } = writeARIOFromOptions(options);
     const mARIOQuantity = requiredMARIOFromOptions(options, 'operatorStake');
@@ -34,7 +34,11 @@ export async function joinNetwork(options) {
         if (settings.operators.minStake > mARIOQuantity.valueOf()) {
             throw new Error(`The minimum operator stake is ${formatARIOWithCommas(new mARIOToken(settings.operators.minStake).toARIO())} ARIO. Please provide a higher stake.`);
         }
-        await assertEnoughBalance(ario, signerAddress, mARIOQuantity.toARIO());
+        await assertEnoughMARIOBalance({
+            ario,
+            address: signerAddress,
+            mARIOQuantity,
+        });
         await assertConfirmationPrompt(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${formatARIOWithCommas(mARIOQuantity.toARIO())} ARIO to join the AR.IO network\nAre you sure?\n`, options);
     }
     const result = await ario.joinNetwork(settings, writeActionTagsFromOptions(options));

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

@@ -1,21 +1,5 @@
-/**
- * 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.
- */
-import { fundFromOptions, isValidFundFrom, } from '../../types/io.js';
 import { mARIOToken } from '../../types/token.js';
-import { addressFromOptions, epochInputFromOptions, formatARIOWithCommas, getTokenCostParamsFromOptions, paginationParamsFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredStringFromOptions, } from '../utils.js';
+import { addressFromOptions, epochInputFromOptions, formatARIOWithCommas, fundFromFromOptions, getTokenCostParamsFromOptions, paginationParamsFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredStringFromOptions, } from '../utils.js';
 export async function getGateway(o) {
     const address = requiredAddressFromOptions(o);
     const gateway = await readARIOFromOptions(o).getGateway({
@@ -123,14 +107,9 @@ export async function getTokenCost(o) {
     return output;
 }
 export async function getCostDetails(o) {
-    if (o.fundFrom !== undefined) {
-        if (!isValidFundFrom(o.fundFrom)) {
-            throw new Error(`Invalid fund from: ${o.fundFrom}. Please use one of ${fundFromOptions.join(', ')}`);
-        }
-    }
     const costDetails = await readARIOFromOptions(o).getCostDetails({
         ...getTokenCostParamsFromOptions(o),
-        fundFrom: o.fundFrom,
+        fundFrom: fundFromFromOptions(o),
     });
     const output = {
         ...costDetails,

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

@@ -1,9 +1,13 @@
-import { assertEnoughBalance, confirmationPrompt, formatARIOWithCommas, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+import { assertEnoughMARIOBalance, confirmationPrompt, formatARIOWithCommas, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
 export async function transfer(options) {
     const { target, arioQuantity } = requiredTargetAndQuantityFromOptions(options);
     const { ario, signerAddress } = writeARIOFromOptions(options);
     if (!options.skipConfirmation) {
-        await assertEnoughBalance(ario, signerAddress, arioQuantity);
+        await assertEnoughMARIOBalance({
+            ario,
+            address: signerAddress,
+            mARIOQuantity: arioQuantity.toMARIO(),
+        });
         const confirm = await confirmationPrompt(`Are you sure you want to transfer ${formatARIOWithCommas(arioQuantity)} ARIO to ${target}?`);
         if (!confirm) {
             return { message: 'Transfer aborted by user' };

package/lib/esm/cli/options.js

@@ -252,11 +252,13 @@ export const globalOptions = [
     optionMap.cuUrl,
 ];
 export const writeActionOptions = [optionMap.skipConfirmation, optionMap.tags];
-export const addressOptions = [optionMap.address];
-export const nameOptions = [optionMap.name];
-export const initiatorOptions = [optionMap.initiator];
+export const arnsPurchaseOptions = [
+    ...writeActionOptions,
+    optionMap.name,
+    optionMap.fundFrom,
+];
 export const epochOptions = [optionMap.epochIndex, optionMap.timestamp];
-export const addressAndVaultIdOptions = [...addressOptions, optionMap.vaultId];
+export const addressAndVaultIdOptions = [optionMap.address, optionMap.vaultId];
 export const nameWriteOptions = [...writeActionOptions, optionMap.name];
 export const paginationOptions = [
     optionMap.cursor,
@@ -313,8 +315,7 @@ export const joinNetworkOptions = [
     optionMap.operatorStake,
 ];
 export const buyRecordOptions = [
-    ...writeActionOptions,
-    optionMap.name,
+    ...arnsPurchaseOptions,
     optionMap.quantity,
     optionMap.type,
     optionMap.years,

package/lib/esm/cli/utils.js

@@ -17,7 +17,7 @@ import { connect } from '@permaweb/aoconnect';
 import { program } from 'commander';
 import { readFileSync } from 'fs';
 import prompts from 'prompts';
-import { ANT, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner, Logger, createAoSigner, fromB64Url, initANTStateForAddress, isValidIntent, mARIOToken, sha256B64Url, validIntents, } from '../node/index.js';
+import { ANT, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner, Logger, createAoSigner, fromB64Url, fundFromOptions, initANTStateForAddress, isValidFundFrom, isValidIntent, mARIOToken, sha256B64Url, validIntents, } from '../node/index.js';
 import { globalOptions } from './options.js';
 export function stringifyJsonForCLIDisplay(json) {
     return JSON.stringify(json, null, 2);
@@ -141,6 +141,9 @@ export function formatARIOWithCommas(value) {
     }
     return integerWithCommas + '.' + decimalPart;
 }
+export function formatMARIOToARIOWithCommas(value) {
+    return formatARIOWithCommas(value.toARIO());
+}
 /** helper to get address from --address option first, then check wallet options  */
 export function addressFromOptions(options) {
     if (options.address !== undefined) {
@@ -265,16 +268,34 @@ export function recordTypeFromOptions(options) {
     }
     return options.type;
 }
-export function requiredMIOFromOptions(options, key) {
+export function requiredMARIOFromOptions(options, key) {
     if (options[key] === undefined) {
         throw new Error(`No ${key} provided. Use --${key} denominated in ARIO`);
     }
     return new ARIOToken(+options[key]).toMARIO();
 }
-export async function assertEnoughBalance(ario, address, arioQuantity) {
+export async function assertEnoughBalanceForArNSPurchase({ ario, address, costDetailsParams, }) {
+    const costDetails = await ario.getCostDetails(costDetailsParams);
+    if (costDetails.fundingPlan) {
+        if (costDetails.fundingPlan.shortfall > 0) {
+            throw new Error(`Insufficient balance for action. Shortfall: ${formatMARIOToARIOWithCommas(new mARIOToken(costDetails.fundingPlan.shortfall))}\n${JSON.stringify(costDetails, null, 2)}`);
+        }
+    }
+    else {
+        await assertEnoughMARIOBalance({
+            ario,
+            address,
+            mARIOQuantity: costDetails.tokenCost,
+        });
+    }
+}
+export async function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }) {
+    if (typeof mARIOQuantity === 'number') {
+        mARIOQuantity = new mARIOToken(mARIOQuantity);
+    }
     const balance = await ario.getBalance({ address });
-    if (balance < arioQuantity.toMARIO().valueOf()) {
-        throw new Error(`Insufficient ARIO balance for action. Balance available: ${new mARIOToken(balance).toARIO()} ARIO`);
+    if (balance < mARIOQuantity.valueOf()) {
+        throw new Error(`Insufficient ARIO balance for action. Balance available: ${formatMARIOToARIOWithCommas(new mARIOToken(balance))} ARIO`);
     }
 }
 export async function confirmationPrompt(message) {
@@ -383,3 +404,11 @@ export function getTokenCostParamsFromOptions(o) {
         fromAddress: addressFromOptions(o),
     };
 }
+export function fundFromFromOptions(o) {
+    if (o.fundFrom !== undefined) {
+        if (!isValidFundFrom(o.fundFrom)) {
+            throw new Error(`Invalid fund from: ${o.fundFrom}. Please use one of ${fundFromOptions.join(', ')}`);
+        }
+    }
+    return o.fundFrom ?? 'balance';
+}

package/lib/esm/common/contracts/ao-process.js

@@ -28,6 +28,12 @@ export class AOProcess {
         this.logger = logger;
         this.ao = ao;
     }
+    isMessageDataEmpty(messageData) {
+        return (messageData === undefined ||
+            messageData === 'null' || // This is what the CU returns for 'nil' values that are json.encoded
+            messageData === '' ||
+            messageData === null);
+    }
     async read({ tags, retries = 3, fromAddress, }) {
         let attempts = 0;
         let lastError;
@@ -48,20 +54,18 @@ export class AOProcess {
                 this.logger.debug(`Read interaction result`, {
                     result,
                 });
+                const error = errorMessageFromOutput(result);
+                if (error !== undefined) {
+                    throw new Error(error);
+                }
                 if (result.Messages === undefined || result.Messages.length === 0) {
                     this.logger.debug(`Process ${this.processId} does not support provided action.`, result, tags);
                     throw new Error(`Process ${this.processId} does not support provided action.`);
                 }
-                const tagsOutput = result.Messages?.[0]?.Tags;
                 const messageData = result.Messages?.[0]?.Data;
-                const errorData = result.Error;
-                const error = errorData || tagsOutput?.find((tag) => tag.name === 'Error')?.value;
-                if (error) {
-                    throw new Error(`${error}${messageData ? `: ${messageData}` : ''}`);
-                }
-                // return empty object if no data is returned
-                if (messageData === undefined) {
-                    return {};
+                // return undefined if no data is returned
+                if (this.isMessageDataEmpty(messageData)) {
+                    return undefined;
                 }
                 const response = safeDecode(result.Messages[0].Data);
                 return response;
@@ -69,7 +73,7 @@ export class AOProcess {
             catch (e) {
                 attempts++;
                 this.logger.debug(`Read attempt ${attempts} failed`, {
-                    error: e,
+                    error: e instanceof Error ? e.message : e,
                     tags,
                 });
                 lastError = e;
@@ -116,11 +120,8 @@ export class AOProcess {
                     messageId,
                     processId: this.processId,
                 });
-                const errorData = output.Error;
-                const error = errorData ||
-                    output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')
-                        ?.value;
-                if (error) {
+                const error = errorMessageFromOutput(output);
+                if (error !== undefined) {
                     throw new WriteInteractionError(error);
                 }
                 // check if there are any Messages in the output
@@ -130,7 +131,7 @@ export class AOProcess {
                 if (output.Messages.length === 0) {
                     throw new Error(`Process ${this.processId} does not support provided action.`);
                 }
-                if (output.Messages[0].Data === undefined) {
+                if (this.isMessageDataEmpty(output.Messages[0].Data)) {
                     return { id: messageId };
                 }
                 const resultData = safeDecode(output.Messages[0].Data);
@@ -167,3 +168,20 @@ export class AOProcess {
         throw lastError;
     }
 }
+function errorMessageFromOutput(output) {
+    const errorData = output.Error;
+    if (errorData !== undefined) {
+        // TODO: Could clean this one up too, current error is verbose, but not always deterministic for parsing
+        // Throw the whole raw error if AO process level error
+        return errorData;
+    }
+    const error = output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')?.value;
+    if (error !== undefined) {
+        // from [string "aos"]:6846: Name is already registered
+        const lineNumber = error.match(/\d+/)?.[0];
+        const message = error.replace(/\[string "aos"\]:\d+:/, '');
+        // to more user friendly: Name is already registered (line 6846)
+        return `${message} (line ${lineNumber})`.trim();
+    }
+    return undefined;
+}