@ar.io/sdk 1.2.0-alpha.9 → 1.2.0

package/lib/cjs/utils/json.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeDecode = void 0;
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+function safeDecode(data) {
+    try {
+        return JSON.parse(data);
+    }
+    catch (e) {
+        return data;
+    }
+}
+exports.safeDecode = safeDecode;

package/lib/cjs/version.js

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

package/lib/esm/common/ant-ao.js

@@ -16,6 +16,13 @@ export class AoANTReadable {
             throw new InvalidContractConfigurationError();
         }
     }
+    async getState() {
+        const tags = [{ name: 'Action', value: 'State' }];
+        const res = await this.process.read({
+            tags,
+        });
+        return res;
+    }
     async getInfo() {
         const tags = [{ name: 'Action', value: 'Info' }];
         const info = await this.process.read({
@@ -35,7 +42,7 @@ export class AoANTReadable {
     async getRecord({ undername }) {
         const tags = [
             { name: 'Sub-Domain', value: undername },
-            { name: 'Action', value: 'Get-Record' },
+            { name: 'Action', value: 'Record' },
         ];
         const record = await this.process.read({
             tags,
@@ -51,7 +58,7 @@ export class AoANTReadable {
      * ````
      */
     async getRecords() {
-        const tags = [{ name: 'Action', value: 'Get-Records' }];
+        const tags = [{ name: 'Action', value: 'Records' }];
         const records = await this.process.read({
             tags,
         });
@@ -78,7 +85,7 @@ export class AoANTReadable {
      * ```
      */
     async getControllers() {
-        const tags = [{ name: 'Action', value: 'Get-Controllers' }];
+        const tags = [{ name: 'Action', value: 'Controllers' }];
         const controllers = await this.process.read({
             tags,
         });
@@ -178,7 +185,7 @@ export class AoANTWriteable extends AoANTReadable {
      */
     async addController({ controller, }) {
         const tags = [
-            { name: 'Action', value: 'Set-Controller' },
+            { name: 'Action', value: 'Add-Controller' },
             { name: 'Controller', value: controller },
         ];
         return this.process.send({

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

@@ -16,6 +16,7 @@
  */
 import { connect } from '@permaweb/aoconnect';
 import { createData } from 'arbundles';
+import { safeDecode } from '../../utils/json.js';
 import { version } from '../../version.js';
 import { WriteInteractionError } from '../error.js';
 import { DefaultLogger } from '../logger.js';
@@ -57,18 +58,22 @@ export class AOProcess {
                     process: this.processId,
                     tags,
                 });
+                if (result.Messages.length === 0) {
+                    throw new Error(`Process ${this.processId} does not support provided action.`);
+                }
                 const tagsOutput = result.Messages[0].Tags;
                 const error = tagsOutput.find((tag) => tag.name === 'Error');
                 if (error) {
                     throw new Error(`${error.Value}: ${result.Messages[0].Data}`);
                 }
-                if (result.Messages.length === 0) {
-                    throw new Error('Process does not support provided action.');
-                }
                 this.logger.debug(`Read interaction result`, {
                     result: result.Messages[0].Data,
                 });
-                const response = JSON.parse(result.Messages[0].Data);
+                // return empty object if no data is returned
+                if (result.Messages[0].Data === undefined) {
+                    return {};
+                }
+                const response = safeDecode(result.Messages[0].Data);
                 return response;
             }
             catch (e) {
@@ -128,7 +133,13 @@ export class AOProcess {
                     const result = output.Messages[0].Data;
                     throw new WriteInteractionError(`${error.Value}: ${result}`);
                 }
-                const resultData = JSON.parse(output.Messages[0].Data);
+                if (output.Messages.length === 0) {
+                    throw new Error(`Process ${this.processId} does not support provided action.`);
+                }
+                if (output.Messages[0].Data === undefined) {
+                    return { id: messageId };
+                }
+                const resultData = safeDecode(output.Messages[0].Data);
                 this.logger.debug('Message result data', {
                     resultData,
                     messageId,

package/lib/esm/common/io.js

@@ -57,31 +57,47 @@ export class IOReadable {
         }
         this.arweave = arweave;
     }
-    async getEpoch(epoch) {
+    async getInfo() {
+        return this.process.read({
+            tags: [{ name: 'Action', value: 'Info' }],
+        });
+    }
+    async getEpochSettings(params) {
         const allTags = [
-            { name: 'Action', value: 'Epoch' },
+            { name: 'Action', value: 'Epoch-Settings' },
             {
-                // TODO: default this to the current network time
                 name: 'Timestamp',
-                value: epoch.timestamp?.toString() ?? '',
+                value: params?.timestamp?.toString() ??
+                    (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: Date.now() }; // fallback to current time
+                    })).timestamp.toString(),
             },
             {
-                name: 'BlockHeight',
-                value: epoch?.blockHeight?.toString(),
+                name: 'Epoch-Index',
+                value: params?.epochIndex?.toString(),
+            },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
+        return this.process.read({
+            tags: prunedTags,
+        });
+    }
+    async getEpoch(epoch) {
+        const allTags = [
+            { name: 'Action', value: 'Epoch' },
+            {
+                name: 'Timestamp',
+                value: epoch?.timestamp?.toString() ??
+                    (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: Date.now() }; // fallback to current time
+                    })).timestamp.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
-        // if it only contains the action, add default timestamp
-        if (prunedTags.length === 1) {
-            prunedTags.push({
-                name: 'Timestamp',
-                value: (await this.arweave.blocks.getCurrent()).timestamp.toString(),
-            });
-        }
         return this.process.read({
             tags: prunedTags,
         });
@@ -101,13 +117,13 @@ export class IOReadable {
     }
     async getArNSReservedNames() {
         return this.process.read({
-            tags: [{ name: 'Action', value: 'ReservedNames' }],
+            tags: [{ name: 'Action', value: 'Reserved-Names' }],
         });
     }
     async getArNSReservedName({ name, }) {
         return this.process.read({
             tags: [
-                { name: 'Action', value: 'ReservedName' },
+                { name: 'Action', value: 'Reserved-Name' },
                 { name: 'Name', value: name },
             ],
         });
@@ -142,125 +158,98 @@ export class IOReadable {
         return this.process.read({
             tags: [
                 { name: 'Action', value: 'Epoch' },
-                { name: 'Timestamp', value: `${Date.now()}` },
+                {
+                    name: 'Timestamp',
+                    value: (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: Date.now() }; // fallback to current time
+                    })).timestamp.toString(),
+                },
             ],
         });
     }
     async getPrescribedObservers(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochPrescribedObservers' },
+            { name: 'Action', value: 'Epoch-Prescribed-Observers' },
             {
                 name: 'Timestamp',
-                value: epoch.timestamp?.toString(),
+                value: epoch?.timestamp?.toString() ??
+                    (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: Date.now() }; // fallback to current time
+                    })).timestamp.toString(),
             },
             {
-                name: 'BlockHeight',
-                value: epoch?.blockHeight?.toString(),
-            },
-            {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
-        // if it only contains the action, add default timestamp
-        if (prunedTags.length === 1) {
-            prunedTags.push({
-                name: 'Timestamp',
-                value: `${Date.now()}`,
-            });
-        }
         return this.process.read({
             tags: prunedTags,
         });
     }
     async getPrescribedNames(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochPrescribedNames' },
+            { name: 'Action', value: 'Epoch-Prescribed-Names' },
             {
                 name: 'Timestamp',
-                value: epoch.timestamp?.toString(),
-            },
-            {
-                name: 'BlockHeight',
-                value: epoch?.blockHeight?.toString(),
+                value: epoch?.timestamp?.toString() ??
+                    (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: Date.now() }; // fallback to current time
+                    })).timestamp.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
-        // if it only contains the action, add default timestamp
-        if (prunedTags.length === 1) {
-            prunedTags.push({
-                name: 'Timestamp',
-                value: `${Date.now()}`, // TODO; replace with fetch the current network time
-            });
-        }
         return this.process.read({
             tags: prunedTags,
         });
     }
     async getObservations(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochObservations' },
+            { name: 'Action', value: 'Epoch-Observations' },
             {
                 name: 'Timestamp',
-                value: epoch.timestamp?.toString(),
-            },
-            {
-                name: 'BlockHeight',
-                value: epoch?.blockHeight?.toString(),
+                value: epoch?.timestamp?.toString() ??
+                    (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: `${Date.now()}` }; // fallback to current time
+                    })).timestamp.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
-        // if it only contains the action, add default timestamp
-        if (prunedTags.length === 1) {
-            prunedTags.push({
-                name: 'Timestamp',
-                value: (await this.arweave.blocks.getCurrent()).timestamp.toString(),
-            });
-        }
         return this.process.read({
             tags: prunedTags,
         });
     }
     async getDistributions(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochDistributions' },
+            { name: 'Action', value: 'Epoch-Distributions' },
             {
                 name: 'Timestamp',
-                value: epoch.timestamp?.toString() ?? '',
+                value: epoch?.timestamp?.toString() ??
+                    (await this.arweave.blocks.getCurrent().catch(() => {
+                        return { timestamp: Date.now() }; // fallback to current time
+                    })).timestamp.toString(),
             },
             {
-                name: 'BlockHeight',
-                value: epoch?.blockHeight?.toString(),
-            },
-            {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
-        // if it only contains the action, add default timestamp
-        if (prunedTags.length === 1) {
-            prunedTags.push({
-                name: 'Timestamp',
-                value: (await this.arweave.blocks.getCurrent()).timestamp.toString(),
-            });
-        }
         return this.process.read({
             tags: prunedTags,
         });
     }
     async getTokenCost({ intent, purchaseType, years, name, quantity, }) {
         const allTags = [
-            { name: 'Action', value: 'TokenCost' },
+            { name: 'Action', value: 'Token-Cost' },
             {
                 name: 'Intent',
                 value: intent,
@@ -278,9 +267,15 @@ export class IOReadable {
                 value: quantity?.toString(),
             },
             {
-                name: 'PurchaseType',
+                name: 'Purchase-Type',
                 value: purchaseType,
             },
+            {
+                name: 'Timestamp',
+                value: (await this.arweave.blocks.getCurrent().catch(() => {
+                    return { timestamp: Date.now() }; // fallback to current time
+                })).timestamp.toString(),
+            },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
@@ -337,17 +332,17 @@ export class IOWriteable extends IOReadable {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
-            { name: 'Action', value: 'JoinNetwork' },
+            { name: 'Action', value: 'Join-Network' },
             {
-                name: 'OperatorStake',
+                name: 'Operator-Stake',
                 value: operatorStake.valueOf().toString(),
             },
             {
-                name: 'AllowDelegatedStaking',
+                name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking.toString(),
             },
             {
-                name: 'DelegateRewardShareRatio',
+                name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio.toString(),
             },
             {
@@ -359,7 +354,7 @@ export class IOWriteable extends IOReadable {
                 value: label,
             },
             {
-                name: 'MinDelegatedStake',
+                name: 'Min-Delegated-Stake',
                 value: minDelegatedStake.valueOf().toString(),
             },
             {
@@ -379,11 +374,11 @@ export class IOWriteable extends IOReadable {
                 value: protocol,
             },
             {
-                name: 'AutoStake',
+                name: 'Auto-Stake',
                 value: autoStake.toString(),
             },
             {
-                name: 'ObserverAddress',
+                name: 'Observer-Address',
                 value: observerAddress,
             },
         ];
@@ -397,27 +392,27 @@ export class IOWriteable extends IOReadable {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
-            { name: 'Action', value: 'UpdateGatewaySettings' },
+            { name: 'Action', value: 'Update-Gateway-Settings' },
             { name: 'Label', value: label },
             { name: 'Note', value: note },
             { name: 'FQDN', value: fqdn },
             { name: 'Port', value: port?.toString() },
             { name: 'Properties', value: properties },
             { name: 'Protocol', value: protocol },
-            { name: 'ObserverAddress', value: observerAddress },
+            { name: 'Observer-Address', value: observerAddress },
             {
-                name: 'AllowDelegatedStaking',
+                name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking?.toString(),
             },
             {
-                name: 'DelegateRewardShareRatio',
+                name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio?.toString(),
             },
             {
-                name: 'MinDelegatedStake',
+                name: 'Min-Delegated-Stake',
                 value: minDelegatedStake?.valueOf().toString(),
             },
-            { name: 'AutoStake', value: autoStake?.toString() },
+            { name: 'Auto-Stake', value: autoStake?.toString() },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
@@ -431,7 +426,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'DelegateStake' },
+                { name: 'Action', value: 'Delegate-Stake' },
                 { name: 'Target', value: params.target },
                 { name: 'Quantity', value: params.stakeQty.valueOf().toString() },
             ],
@@ -443,7 +438,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'DecreaseDelegateStake' },
+                { name: 'Action', value: 'Decrease-Delegate-Stake' },
                 { name: 'Target', value: params.target },
                 { name: 'Quantity', value: params.decreaseQty.valueOf().toString() },
             ],
@@ -455,7 +450,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'IncreaseOperatorStake' },
+                { name: 'Action', value: 'Increase-Operator-Stake' },
                 { name: 'Quantity', value: params.increaseQty.valueOf().toString() },
             ],
         });
@@ -466,7 +461,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'DecreaseOperatorStake' },
+                { name: 'Action', value: 'Decrease-Operator-Stake' },
                 { name: 'Quantity', value: params.decreaseQty.valueOf().toString() },
             ],
         });
@@ -477,13 +472,13 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'SaveObservations' },
+                { name: 'Action', value: 'Save-Observations' },
                 {
-                    name: 'ReportTxId',
+                    name: 'Report-Tx-Id',
                     value: params.reportTxId,
                 },
                 {
-                    name: 'FailedGateways',
+                    name: 'Failed-Gateways',
                     value: params.failedGateways.join(','),
                 },
             ],
@@ -497,11 +492,11 @@ export class IOWriteable extends IOReadable {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
-            { name: 'Action', value: 'BuyRecord' },
+            { name: 'Action', value: 'Buy-Record' },
             { name: 'Name', value: params.name },
             { name: 'Years', value: params.years?.toString() ?? '1' },
-            { name: 'ProcessId', value: params.processId },
-            { name: 'PurchaseType', value: params.type || 'lease' },
+            { name: 'Process-Id', value: params.processId },
+            { name: 'Purchase-Type', value: params.type || 'lease' },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
@@ -515,7 +510,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'ExtendLease' },
+                { name: 'Action', value: 'Extend-Lease' },
                 { name: 'Name', value: params.name },
                 { name: 'Years', value: params.years.toString() },
             ],
@@ -527,7 +522,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'IncreaseUndernameLimit' },
+                { name: 'Action', value: 'Increase-Undername-Limit' },
                 { name: 'Name', value: params.name },
                 { name: 'Quantity', value: params.increaseCount.toString() },
             ],

package/lib/esm/constants.js

@@ -21,8 +21,11 @@ export const FQDN_REGEX = new RegExp('^(?:(?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)+[A-Z
 export const SORT_KEY_REGEX = new RegExp('^[0-9]{12},[0-9]{13},[a-fA-F0-9]{64}$');
 export const ARNS_TESTNET_REGISTRY_TX = process.env.ARNS_REGISTRY_TX ?? 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U';
 export const ARNS_DEVNET_REGISTRY_TX = '_NctcA2sRy1-J4OmIQZbYFPM17piNcbdBPH2ncX2RL8';
-export const ioDevnetProcessId = 'GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc';
+export const IO_DEVNET_PROCESS_ID = 'GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc';
+// backwards compatibility - TODO: remove in v2.0.0
+export const ioDevnetProcessId = IO_DEVNET_PROCESS_ID;
+export const IO_TESTNET_PROCESS_ID = 'agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA';
 export const MIO_PER_IO = 1_000_000;
-export const AOS_MODULE_ID = '9afQ1PLf2mrshqCTZEzzJTR2gWaC9zNPnYgYEqg1Pt4';
-export const ANT_LUA_ID = 'obPBMsBWmG5q2qODj3y-zdKiuhZaJC_nuBaQRvORKkU';
+export const AOS_MODULE_ID = 'cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk';
+export const ANT_LUA_ID = '3OlGzE5mrsN2GsxCYM0Tae1KzWepGOr5a94deOWmApM';
 export const DEFAULT_SCHEDULER_ID = '_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA';