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

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

@@ -31,7 +31,13 @@ class AOProcess {
         this.logger = logger;
         this.ao = ao;
     }
-    async read({ tags, retries = 3, }) {
+    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;
         while (attempts < retries) {
@@ -40,27 +46,29 @@ class AOProcess {
                     tags,
                 });
                 // map tags to inputs
-                const result = await this.ao.dryrun({
+                const dryRunInput = {
                     process: this.processId,
                     tags,
-                });
+                };
+                if (fromAddress !== undefined) {
+                    dryRunInput['Owner'] = fromAddress;
+                }
+                const result = await this.ao.dryrun(dryRunInput);
                 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 = (0, json_js_1.safeDecode)(result.Messages[0].Data);
                 return response;
@@ -68,7 +76,7 @@ class AOProcess {
             catch (e) {
                 attempts++;
                 this.logger.debug(`Read attempt ${attempts} failed`, {
-                    error: e,
+                    error: e instanceof Error ? e.message : e,
                     tags,
                 });
                 lastError = e;
@@ -115,11 +123,8 @@ 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 error_js_1.WriteInteractionError(error);
                 }
                 // check if there are any Messages in the output
@@ -129,7 +134,7 @@ 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 = (0, json_js_1.safeDecode)(output.Messages[0].Data);
@@ -167,3 +172,20 @@ class AOProcess {
     }
 }
 exports.AOProcess = AOProcess;
+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;
+}

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,23 +231,45 @@ class ARIOReadable {
     async getDistributions(epoch) {
         const allTags = [
             { name: 'Action', value: 'Epoch-Distributions' },
+            { name: 'Epoch-Index', value: await this.computeEpochIndex(epoch) },
+        ];
+        return this.process.read({
+            tags: (0, arweave_js_1.pruneTags)(allTags),
+        });
+    }
+    async getTokenCost({ intent, type, years, name, quantity, fromAddress, }) {
+        const allTags = [
+            { name: 'Action', value: 'Token-Cost' },
             {
-                name: 'Timestamp',
-                value: epoch?.timestamp?.toString() ??
-                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
+                name: 'Intent',
+                value: intent,
             },
             {
-                name: 'Epoch-Index',
-                value: epoch?.epochIndex?.toString(),
+                name: 'Name',
+                value: name,
+            },
+            {
+                name: 'Years',
+                value: years?.toString(),
+            },
+            {
+                name: 'Quantity',
+                value: quantity?.toString(),
+            },
+            {
+                name: 'Purchase-Type',
+                value: type,
             },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
+            fromAddress,
         });
     }
-    async getTokenCost({ intent, type, years, name, quantity, }) {
+    // TODO: Can overload this function to refine different types of cost details params
+    async getCostDetails({ intent, type, years, name, quantity, fromAddress, fundFrom, }) {
         const allTags = [
-            { name: 'Action', value: 'Token-Cost' },
+            { name: 'Action', value: 'Get-Cost-Details-For-Action' },
             {
                 name: 'Intent',
                 value: intent,
@@ -289,19 +291,13 @@ class ARIOReadable {
                 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(),
+                name: 'Fund-From',
+                value: fundFrom,
             },
         ];
         return this.process.read({
             tags: (0, arweave_js_1.pruneTags)(allTags),
+            fromAddress,
         });
     }
     async getRegistrationFees() {
@@ -667,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,
@@ -683,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),
         });
     }
     /**
@@ -703,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),
         });
     }
     /**
@@ -747,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/types/io.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = void 0;
+exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidFundFrom = exports.fundFromOptions = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = void 0;
 const arweave_js_1 = require("../utils/arweave.js");
 exports.validIntents = [
     'Buy-Record',
@@ -14,6 +14,11 @@ const isValidIntent = (intent) => {
     return exports.validIntents.indexOf(intent) !== -1;
 };
 exports.isValidIntent = isValidIntent;
+exports.fundFromOptions = ['balance', 'stakes', 'any'];
+const isValidFundFrom = (fundFrom) => {
+    return exports.fundFromOptions.indexOf(fundFrom) !== -1;
+};
+exports.isValidFundFrom = isValidFundFrom;
 // Typeguard functions
 function isProcessConfiguration(config) {
     return 'process' in config;

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.0.1-alpha.1';
+exports.version = '3.1.0-alpha.10';