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

package/lib/cjs/common/io.js

@@ -1,11 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ARIOWriteable = exports.ARIOReadable = exports.ARIO = 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");
 const io_js_1 = require("../types/io.js");
 const ao_js_1 = require("../utils/ao.js");
 const arweave_js_1 = require("../utils/arweave.js");
-const arweave_js_2 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
 const error_js_1 = require("./error.js");
 class ARIO {
@@ -23,8 +37,8 @@ class ARIO {
 exports.ARIO = ARIO;
 class ARIOReadable {
     process;
-    arweave;
-    constructor(config, arweave = arweave_js_2.defaultArweave) {
+    epochSettings;
+    constructor(config) {
         if (!config) {
             this.process = new ao_process_js_1.AOProcess({
                 processId: constants_js_1.ARIO_TESTNET_PROCESS_ID,
@@ -41,7 +55,6 @@ class ARIOReadable {
         else {
             throw new error_js_1.InvalidContractConfigurationError();
         }
-        this.arweave = arweave;
     }
     async getInfo() {
         return this.process.read({
@@ -53,35 +66,32 @@ class ARIOReadable {
             tags: [{ name: 'Action', value: 'Total-Token-Supply' }],
         });
     }
-    async getEpochSettings(params) {
-        const allTags = [
-            { name: 'Action', value: 'Epoch-Settings' },
-            {
-                name: 'Timestamp',
-                value: params?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-            },
-            {
-                name: 'Epoch-Index',
-                value: params?.epochIndex?.toString(),
-            },
-        ];
-        return this.process.read({
-            tags: (0, arweave_js_1.pruneTags)(allTags),
-        });
+    async computeEpochIndexForTimestamp(timestamp) {
+        const epochSettings = await this.getEpochSettings();
+        const epochZeroStartTimestamp = epochSettings.epochZeroStartTimestamp;
+        const epochLengthMs = epochSettings.durationMs;
+        return Math.floor((timestamp - epochZeroStartTimestamp) / epochLengthMs);
+    }
+    async computeEpochIndex(params) {
+        const epochIndex = params?.epochIndex;
+        if (epochIndex !== undefined) {
+            return epochIndex.toString();
+        }
+        const timestamp = params?.timestamp;
+        if (timestamp !== undefined) {
+            return (await this.computeEpochIndexForTimestamp(timestamp)).toString();
+        }
+        return undefined;
+    }
+    async getEpochSettings() {
+        return (this.epochSettings ??= await this.process.read({
+            tags: [{ name: 'Action', value: 'Epoch-Settings' }],
+        }));
     }
     async getEpoch(epoch) {
         const allTags = [
             { name: 'Action', value: 'Epoch' },
-            {
-                name: 'Timestamp',
-                value: epoch?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-            },
-            {
-                name: 'Epoch-Index',
-                value: epoch?.epochIndex?.toString(),
-            },
+            { name: 'Epoch-Index', value: await this.computeEpochIndex(epoch) },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -188,27 +198,13 @@ class ARIOReadable {
     }
     async getCurrentEpoch() {
         return this.process.read({
-            tags: [
-                { name: 'Action', value: 'Epoch' },
-                {
-                    name: 'Timestamp',
-                    value: (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-                },
-            ],
+            tags: [{ name: 'Action', value: 'Epoch' }],
         });
     }
     async getPrescribedObservers(epoch) {
         const allTags = [
             { name: 'Action', value: 'Epoch-Prescribed-Observers' },
-            {
-                name: 'Timestamp',
-                value: epoch?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-            },
-            {
-                name: 'Epoch-Index',
-                value: epoch?.epochIndex?.toString(),
-            },
+            { name: 'Epoch-Index', value: await this.computeEpochIndex(epoch) },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -217,15 +213,7 @@ class ARIOReadable {
     async getPrescribedNames(epoch) {
         const allTags = [
             { name: 'Action', value: 'Epoch-Prescribed-Names' },
-            {
-                name: 'Timestamp',
-                value: epoch?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-            },
-            {
-                name: 'Epoch-Index',
-                value: epoch?.epochIndex?.toString(),
-            },
+            { name: 'Epoch-Index', value: await this.computeEpochIndex(epoch) },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -234,15 +222,7 @@ class ARIOReadable {
     async getObservations(epoch) {
         const allTags = [
             { name: 'Action', value: 'Epoch-Observations' },
-            {
-                name: 'Timestamp',
-                value: epoch?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-            },
-            {
-                name: 'Epoch-Index',
-                value: epoch?.epochIndex?.toString(),
-            },
+            { name: 'Epoch-Index', value: await this.computeEpochIndex(epoch) },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -251,15 +231,7 @@ class ARIOReadable {
     async getDistributions(epoch) {
         const allTags = [
             { name: 'Action', value: 'Epoch-Distributions' },
-            {
-                name: 'Timestamp',
-                value: epoch?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
-            },
-            {
-                name: 'Epoch-Index',
-                value: epoch?.epochIndex?.toString(),
-            },
+            { name: 'Epoch-Index', value: await this.computeEpochIndex(epoch) },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -288,17 +260,6 @@ class ARIOReadable {
                 name: 'Purchase-Type',
                 value: type,
             },
-            {
-                name: 'Timestamp',
-                value: (await this.arweave.blocks
-                    .getCurrent()
-                    .then((block) => {
-                    return { timestamp: block.timestamp * 1000 };
-                })
-                    .catch(() => {
-                    return { timestamp: Date.now() }; // fallback to current time
-                })).timestamp.toString(),
-            },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -333,17 +294,6 @@ class ARIOReadable {
                 name: 'Fund-From',
                 value: fundFrom,
             },
-            {
-                name: 'Timestamp',
-                value: (await this.arweave.blocks
-                    .getCurrent()
-                    .then((block) => {
-                    return { timestamp: block.timestamp * 1000 };
-                })
-                    .catch(() => {
-                    return { timestamp: Date.now() }; // fallback to current time
-                })).timestamp.toString(),
-            },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
@@ -713,6 +663,7 @@ class ARIOWriteable extends ARIOReadable {
             { name: 'Years', value: params.years?.toString() ?? '1' },
             { name: 'Process-Id', value: params.processId },
             { name: 'Purchase-Type', value: params.type || 'lease' },
+            { name: 'Fund-From', value: params.fundFrom },
         ];
         return this.process.send({
             signer: this.signer,
@@ -729,13 +680,15 @@ class ARIOWriteable extends ARIOReadable {
      */
     async upgradeRecord(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
+            { name: 'Name', value: params.name },
+            { name: 'Fund-From', value: params.fundFrom },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
-                { name: 'Name', value: params.name },
-            ],
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     /**
@@ -749,26 +702,30 @@ class ARIOWriteable extends ARIOReadable {
      */
     async extendLease(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Extend-Lease' },
+            { name: 'Name', value: params.name },
+            { name: 'Years', value: params.years.toString() },
+            { name: 'Fund-From', value: params.fundFrom },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Extend-Lease' },
-                { name: 'Name', value: params.name },
-                { name: 'Years', value: params.years.toString() },
-            ],
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async increaseUndernameLimit(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Increase-Undername-Limit' },
+            { name: 'Name', value: params.name },
+            { name: 'Quantity', value: params.increaseCount.toString() },
+            { name: 'Fund-From', value: params.fundFrom },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Increase-Undername-Limit' },
-                { name: 'Name', value: params.name },
-                { name: 'Quantity', value: params.increaseCount.toString() },
-            ],
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     /**
@@ -793,13 +750,16 @@ class ARIOWriteable extends ARIOReadable {
             tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
-    async requestPrimaryName(params) {
+    async requestPrimaryName(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Request-Primary-Name' },
+            { name: 'Name', value: params.name },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                { name: 'Action', value: 'Request-Primary-Name' },
-                { name: 'Name', value: params.name },
-            ],
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     /**

package/lib/cjs/utils/arweave.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.paginationParamsToTags = exports.getCurrentBlockUnixTimestampMs = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = void 0;
+exports.paginationParamsToTags = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = 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");
 const validateArweaveId = (id) => {
     return constants_js_1.ARWEAVE_TX_REGEX.test(id);
@@ -10,21 +25,15 @@ function isBlockHeight(height) {
     return height !== undefined && !isNaN(parseInt(height.toString()));
 }
 exports.isBlockHeight = isBlockHeight;
+/**
+ * Prune tags that are undefined or empty.
+ * @param tags - The tags to prune.
+ * @returns The pruned tags.
+ */
 const pruneTags = (tags) => {
-    return tags.filter((tag) => tag.value !== undefined);
+    return tags.filter((tag) => tag.value !== undefined && tag.value !== '');
 };
 exports.pruneTags = pruneTags;
-const getCurrentBlockUnixTimestampMs = async (arweave) => {
-    return await arweave.blocks
-        .getCurrent()
-        .then((block) => {
-        return block.timestamp * 1000;
-    })
-        .catch(() => {
-        return Date.now(); // fallback to current time
-    });
-};
-exports.getCurrentBlockUnixTimestampMs = getCurrentBlockUnixTimestampMs;
 const paginationParamsToTags = (params) => {
     const tags = [
         { name: 'Cursor', value: params?.cursor?.toString() },

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.1.0-alpha.1';
+exports.version = '3.1.0-alpha.11';

package/lib/esm/cli/cli.js

@@ -19,11 +19,12 @@ import { program } from 'commander';
 import { spawnANT } from '../node/index.js';
 import { mARIOToken } from '../types/token.js';
 import { version } from '../version.js';
+import { buyRecordCLICommand, extendLeaseCLICommand, increaseUndernameLimitCLICommand, requestPrimaryNameCLICommand, upgradeRecordCLICommand, } from './commands/arnsPurchaseCommands.js';
 import { cancelWithdrawal, decreaseDelegateStake, decreaseOperatorStake, delegateStake, increaseOperatorStake, instantWithdrawal, joinNetwork, leaveNetwork, redelegateStake, saveObservations, updateGatewaySettings, } from './commands/gatewayWriteCommands.js';
 import { getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getCostDetails, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listArNSRecords, listArNSReservedNames, listArNSReturnedNames, listGateways, } from './commands/readCommands.js';
 import { transfer } from './commands/transfer.js';
-import { addressAndVaultIdOptions, addressOptions, antStateOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, initiatorOptions, joinNetworkOptions, nameOptions, nameWriteOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, writeActionOptions, } from './options.js';
-import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, positiveIntegerFromOptions, readANTFromOptions, readARIOFromOptions, recordTypeFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredPositiveIntegerFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from './utils.js';
+import { addressAndVaultIdOptions, antStateOptions, arnsPurchaseOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, joinNetworkOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, writeActionOptions, } from './options.js';
+import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, readANTFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, writeActionTagsFromOptions, } from './utils.js';
 applyOptions(program
     .name('ar.io')
     .version(version)
@@ -52,7 +53,7 @@ makeCommand({
 makeCommand({
     name: 'get-gateway',
     description: 'Get the gateway of an address',
-    options: addressOptions,
+    options: [optionMap.address],
     action: getGateway,
 });
 makeCommand({
@@ -70,7 +71,7 @@ makeCommand({
 makeCommand({
     name: 'get-delegations',
     description: 'Get all stake delegated to gateways from this address',
-    options: addressOptions,
+    options: [optionMap.address],
     action: getDelegations,
 });
 makeCommand({
@@ -82,7 +83,7 @@ makeCommand({
 makeCommand({
     name: 'get-arns-record',
     description: 'Get an ArNS record by name',
-    options: nameOptions,
+    options: [optionMap.name],
     action: getArNSRecord,
 });
 makeCommand({
@@ -94,7 +95,7 @@ makeCommand({
 makeCommand({
     name: 'get-arns-reserved-name',
     description: 'Get a reserved ArNS name',
-    options: nameOptions,
+    options: [optionMap.name],
     action: getArNSReservedName,
 });
 makeCommand({
@@ -106,7 +107,7 @@ makeCommand({
 makeCommand({
     name: 'get-arns-returned-name',
     description: 'Get an ArNS returned name by name',
-    options: nameOptions,
+    options: [optionMap.name],
     action: getArNSReturnedName,
 });
 makeCommand({
@@ -174,7 +175,7 @@ makeCommand({
 makeCommand({
     name: 'get-primary-name-request',
     description: 'Get primary name request',
-    options: initiatorOptions,
+    options: [optionMap.initiator],
     action: (o) => readARIOFromOptions(o)
         .getPrimaryNameRequest({
         initiator: requiredStringFromOptions(o, 'initiator'),
@@ -194,7 +195,7 @@ makeCommand({
 makeCommand({
     name: 'get-primary-name',
     description: 'Get primary name',
-    options: [...addressOptions, optionMap.name],
+    options: [optionMap.address, optionMap.name],
     action: getPrimaryName,
 });
 makeCommand({
@@ -208,7 +209,7 @@ makeCommand({
 makeCommand({
     name: 'balance',
     description: 'Get the balance of an address',
-    options: addressOptions,
+    options: [optionMap.address],
     action: (options) => readARIOFromOptions(options)
         .getBalance({ address: requiredAddressFromOptions(options) })
         .then((result) => ({
@@ -228,7 +229,7 @@ makeCommand({
 makeCommand({
     name: 'get-redelegation-fee',
     description: 'Get redelegation fee',
-    options: addressOptions,
+    options: [optionMap.address],
     action: (options) => readARIOFromOptions(options).getRedelegationFee({
         address: requiredAddressFromOptions(options),
     }),
@@ -324,82 +325,31 @@ makeCommand({
     name: 'buy-record',
     description: 'Buy a record',
     options: buyRecordOptions,
-    action: async (options) => {
-        const ario = writeARIOFromOptions(options).ario;
-        const name = requiredStringFromOptions(options, 'name');
-        const type = recordTypeFromOptions(options);
-        const years = positiveIntegerFromOptions(options, 'years');
-        // TODO: Assert balance is sufficient for action
-        // TODO: Assert record is not already owned
-        const processId = options.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');
-        }
-        await assertConfirmationPrompt(`Are you sure you want to ${type} the record ${name}?`, options);
-        return ario.buyRecord({
-            name: requiredStringFromOptions(options, 'name'),
-            processId,
-            type,
-            years,
-        });
-    },
+    action: buyRecordCLICommand,
 });
 makeCommand({
     name: 'upgrade-record',
     description: 'Upgrade the lease of a record to a permabuy',
-    options: [...nameOptions, ...writeActionOptions],
-    // TODO: could assert record is leased by sender, assert balance is sufficient
-    action: async (options) => {
-        const name = requiredStringFromOptions(options, 'name');
-        await assertConfirmationPrompt(`Are you sure you want to upgrade the lease of ${name} to a permabuy?`, options);
-        return writeARIOFromOptions(options).ario.upgradeRecord({
-            name,
-        });
-    },
+    options: arnsPurchaseOptions,
+    action: upgradeRecordCLICommand,
 });
 makeCommand({
     name: 'extend-lease',
     description: 'Extend the lease of a record',
-    options: [...writeActionOptions, optionMap.name, optionMap.years],
-    action: async (options) => {
-        const name = requiredStringFromOptions(options, 'name');
-        const years = requiredPositiveIntegerFromOptions(options, 'years');
-        await assertConfirmationPrompt(`Are you sure you want to extend the lease of ${name} by ${years}?`, options);
-        return writeARIOFromOptions(options).ario.extendLease({
-            name,
-            years,
-        }, writeActionTagsFromOptions(options));
-    },
+    options: [...arnsPurchaseOptions, optionMap.years],
+    action: extendLeaseCLICommand,
 });
 makeCommand({
     name: 'increase-undername-limit',
     description: 'Increase the limit of a name',
-    options: [...writeActionOptions, optionMap.name, optionMap.increaseCount],
-    action: async (options) => {
-        const name = requiredStringFromOptions(options, 'name');
-        const increaseCount = requiredPositiveIntegerFromOptions(options, 'increaseCount');
-        await assertConfirmationPrompt(`Are you sure you want to increase the undername limit of ${name} by ${increaseCount}?`, options);
-        return writeARIOFromOptions(options).ario.increaseUndernameLimit({
-            name,
-            increaseCount,
-        }, writeActionTagsFromOptions(options));
-    },
+    options: [...arnsPurchaseOptions, optionMap.increaseCount],
+    action: increaseUndernameLimitCLICommand,
 });
 makeCommand({
     name: 'request-primary-name',
     description: 'Request a primary name',
-    options: nameWriteOptions,
-    action: async (options) => {
-        // TODO: Assert balance is sufficient for action?
-        // TODO: Assert name requested is not already owned
-        // TODO: More assertions?
-        const name = requiredStringFromOptions(options, 'name');
-        await assertConfirmationPrompt(`Are you sure you want to request the primary name ${name}?`, options);
-        return writeARIOFromOptions(options).ario.requestPrimaryName({
-            name,
-        });
-    },
+    options: arnsPurchaseOptions,
+    action: requestPrimaryNameCLICommand,
 });
 makeCommand({
     name: 'spawn-ant',