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

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

@@ -43,19 +43,21 @@ class AOProcess {
                     process: this.processId,
                     tags,
                 });
+                this.logger.debug(`Read interaction result`, {
+                    result,
+                });
                 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 error = tagsOutput.find((tag) => tag.name === 'Error');
                 if (error) {
-                    throw new Error(`${error.Value}: ${result.Messages[0].Data}`);
+                    throw new Error(`${error.value}${messageData ? `: ${messageData}` : ''}`);
                 }
-                this.logger.debug(`Read interaction result`, {
-                    result: result.Messages[0].Data,
-                });
                 // return empty object if no data is returned
-                if (result.Messages[0].Data === undefined) {
+                if (messageData === undefined) {
                     return {};
                 }
                 const response = (0, json_js_1.safeDecode)(result.Messages[0].Data);

package/lib/cjs/common/http.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AxiosHTTPService = void 0;
-const index_js_1 = require("../utils/index.js");
+const http_client_js_1 = require("../utils/http-client.js");
 const error_js_1 = require("./error.js");
 const logger_js_1 = require("./logger.js");
 class AxiosHTTPService {
@@ -9,7 +9,7 @@ class AxiosHTTPService {
     logger;
     constructor({ url, logger = logger_js_1.Logger.default, }) {
         this.logger = logger;
-        this.axios = (0, index_js_1.createAxiosInstance)({
+        this.axios = (0, http_client_js_1.createAxiosInstance)({
             axiosConfig: {
                 baseURL: url,
             },

package/lib/cjs/common/io.js

@@ -4,7 +4,8 @@ exports.IOWriteable = exports.IOReadable = exports.IO = void 0;
 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("./arweave.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 IO {
@@ -23,7 +24,7 @@ exports.IO = IO;
 class IOReadable {
     process;
     arweave;
-    constructor(config, arweave = arweave_js_1.defaultArweave) {
+    constructor(config, arweave = arweave_js_2.defaultArweave) {
         if (!config) {
             this.process = new ao_process_js_1.AOProcess({
                 processId: constants_js_1.IO_TESTNET_PROCESS_ID,
@@ -58,23 +59,15 @@ class IOReadable {
             {
                 name: 'Timestamp',
                 value: params?.timestamp?.toString() ??
-                    (await this.arweave.blocks
-                        .getCurrent()
-                        .then((block) => {
-                        return { timestamp: block.timestamp * 1000 };
-                    })
-                        .catch(() => {
-                        return { timestamp: Date.now() }; // fallback to current time
-                    })).timestamp.toString(),
+                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
             },
             {
                 name: 'Epoch-Index',
                 value: params?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getEpoch(epoch) {
@@ -83,23 +76,15 @@ class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks
-                        .getCurrent()
-                        .then((block) => {
-                        return { timestamp: block.timestamp * 1000 };
-                    })
-                        .catch(() => {
-                        return { timestamp: Date.now() }; // fallback to current time
-                    })).timestamp.toString(),
+                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
             },
             {
                 name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getArNSRecord({ name, }) {
@@ -110,17 +95,16 @@ class IOReadable {
             ],
         });
     }
-    async getArNSRecords(pageParams) {
+    async getArNSRecords(params) {
         const allTags = [
             { name: 'Action', value: 'Paginated-Records' },
-            { name: 'Cursor', value: pageParams?.cursor?.toString() },
-            { name: 'Limit', value: pageParams?.limit?.toString() },
-            { name: 'Sort-By', value: pageParams?.sortBy },
-            { name: 'Sort-Order', value: pageParams?.sortOrder },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getArNSReservedNames() {
@@ -144,17 +128,37 @@ class IOReadable {
             ],
         });
     }
-    async getBalances(pageParams) {
+    async getBalances(params) {
         const allTags = [
             { name: 'Action', value: 'Paginated-Balances' },
-            { name: 'Cursor', value: pageParams?.cursor?.toString() },
-            { name: 'Limit', value: pageParams?.limit?.toString() },
-            { name: 'Sort-By', value: pageParams?.sortBy },
-            { name: 'Sort-Order', value: pageParams?.sortOrder },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
+        ];
+        return this.process.read({
+            tags: (0, arweave_js_1.pruneTags)(allTags),
+        });
+    }
+    async getVault({ address, vaultId, }) {
+        return this.process.read({
+            tags: [
+                { name: 'Action', value: 'Vault' },
+                { name: 'Address', value: address },
+                { name: 'Vault-Id', value: vaultId },
+            ],
+        });
+    }
+    async getVaults(params) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Vaults' },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getGateway({ address, }) {
@@ -165,6 +169,32 @@ class IOReadable {
             ],
         });
     }
+    async getGatewayDelegates({ address, ...pageParams }) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Delegates' },
+            { name: 'Address', value: address },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        return this.process.read({
+            tags: (0, arweave_js_1.pruneTags)(allTags),
+        });
+    }
+    async getGatewayDelegateAllowList({ address, ...pageParams }) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Allowed-Delegates' },
+            { name: 'Address', value: address },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+            // note: sortBy is omitted because it's not supported for this action as table is an of addresses
+        ];
+        return this.process.read({
+            tags: (0, arweave_js_1.pruneTags)(allTags),
+        });
+    }
     async getGateways(pageParams) {
         const allTags = [
             { name: 'Action', value: 'Paginated-Gateways' },
@@ -173,9 +203,8 @@ class IOReadable {
             { name: 'Sort-By', value: pageParams?.sortBy },
             { name: 'Sort-Order', value: pageParams?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getCurrentEpoch() {
@@ -202,23 +231,15 @@ class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks
-                        .getCurrent()
-                        .then((block) => {
-                        return { timestamp: block.timestamp * 1000 };
-                    })
-                        .catch(() => {
-                        return { timestamp: Date.now() }; // fallback to current time
-                    })).timestamp.toString(),
+                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
             },
             {
                 name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getPrescribedNames(epoch) {
@@ -227,23 +248,15 @@ class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks
-                        .getCurrent()
-                        .then((block) => {
-                        return { timestamp: block.timestamp * 1000 };
-                    })
-                        .catch(() => {
-                        return { timestamp: Date.now() }; // fallback to current time
-                    })).timestamp.toString(),
+                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
             },
             {
                 name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getObservations(epoch) {
@@ -266,9 +279,8 @@ class IOReadable {
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getDistributions(epoch) {
@@ -277,23 +289,15 @@ class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks
-                        .getCurrent()
-                        .then((block) => {
-                        return { timestamp: block.timestamp * 1000 };
-                    })
-                        .catch(() => {
-                        return { timestamp: Date.now() }; // fallback to current time
-                    })).timestamp.toString(),
+                    (await (0, arweave_js_1.getCurrentBlockUnixTimestampMs)(this.arweave)).toString(),
             },
             {
                 name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getTokenCost({ intent, type, years, name, quantity, }) {
@@ -331,9 +335,8 @@ class IOReadable {
                 })).timestamp.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getRegistrationFees() {
@@ -355,9 +358,8 @@ class IOReadable {
             { name: 'Sort-By', value: params?.sortBy },
             { name: 'Sort-Order', value: params?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async getArNSAuction({ name, }) {
@@ -451,7 +453,7 @@ class IOWriteable extends IOReadable {
             signer: this.signer,
         });
     }
-    async joinNetwork({ operatorStake, allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
+    async joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -464,6 +466,10 @@ class IOWriteable extends IOReadable {
                 name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking?.toString(),
             },
+            {
+                name: 'Allowed-Delegates',
+                value: allowedDelegates?.join(','),
+            },
             {
                 name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio?.toString(),
@@ -505,10 +511,9 @@ class IOWriteable extends IOReadable {
                 value: observerAddress,
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async leaveNetwork(options) {
@@ -518,7 +523,7 @@ class IOWriteable extends IOReadable {
             tags: [...tags, { name: 'Action', value: 'Leave-Network' }],
         });
     }
-    async updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
+    async updateGatewaySettings({ allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -534,6 +539,10 @@ class IOWriteable extends IOReadable {
                 name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking?.toString(),
             },
+            {
+                name: 'Allowed-Delegates',
+                value: allowedDelegates?.join(','),
+            },
             {
                 name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio?.toString(),
@@ -544,10 +553,9 @@ class IOWriteable extends IOReadable {
             },
             { name: 'Auto-Stake', value: autoStake?.toString() },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async delegateStake(params, options) {
@@ -591,10 +599,9 @@ class IOWriteable extends IOReadable {
             { name: 'Vault-Id', value: params.vaultId },
             { name: 'Address', value: params.gatewayAddress },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async increaseOperatorStake(params, options) {
@@ -647,10 +654,9 @@ class IOWriteable extends IOReadable {
             { 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({
             signer: this.signer,
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     /**
@@ -722,10 +728,9 @@ class IOWriteable extends IOReadable {
             { name: 'Vault-Id', value: params.vaultId },
             { name: 'Address', value: params.gatewayAddress },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
     async submitAuctionBid(params, options) {
@@ -739,10 +744,9 @@ class IOWriteable extends IOReadable {
             { name: 'Purchase-Type', value: params.type || 'lease' },
             { name: 'Years', value: params.years?.toString() ?? undefined },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
 }

package/lib/cjs/types/index.js

@@ -29,6 +29,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+__exportStar(require("./ant-registry.js"), exports);
+__exportStar(require("./ant.js"), exports);
 __exportStar(require("./common.js"), exports);
-__exportStar(require("./token.js"), exports);
 __exportStar(require("./io.js"), exports);
+__exportStar(require("./token.js"), exports);

package/lib/cjs/utils/arweave.js

@@ -1,21 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.
- */
+exports.getCurrentBlockUnixTimestampMs = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = void 0;
 const constants_js_1 = require("../constants.js");
 const validateArweaveId = (id) => {
     return constants_js_1.ARWEAVE_TX_REGEX.test(id);
@@ -25,3 +10,18 @@ function isBlockHeight(height) {
     return height !== undefined && !isNaN(parseInt(height.toString()));
 }
 exports.isBlockHeight = isBlockHeight;
+const pruneTags = (tags) => {
+    return tags.filter((tag) => tag.value !== undefined);
+};
+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;

package/lib/cjs/utils/index.js

@@ -29,9 +29,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-__exportStar(require("./arweave.js"), exports);
-__exportStar(require("./http-client.js"), exports);
 __exportStar(require("./ao.js"), exports);
+__exportStar(require("./arweave.js"), exports);
+__exportStar(require("./base64.js"), exports);
 __exportStar(require("./json.js"), exports);
 __exportStar(require("./processes.js"), exports);
 __exportStar(require("./schema.js"), exports);

package/lib/cjs/utils/processes.js

@@ -52,14 +52,16 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
     timeoutMs; // timeout for each request to 3 seconds
     throttle;
     logger;
+    strict;
     constructor({ contract = io_js_1.IO.init({
         processId: constants_js_1.IO_TESTNET_PROCESS_ID,
-    }), timeoutMs = 60_000, concurrency = 30, logger = logger_js_1.Logger.default, } = {}) {
+    }), timeoutMs = 60_000, concurrency = 30, logger = logger_js_1.Logger.default, strict = false, } = {}) {
         super();
         this.contract = contract;
         this.timeoutMs = timeoutMs;
         this.throttle = (0, plimit_lit_1.pLimit)(concurrency);
         this.logger = logger;
+        this.strict = strict;
     }
     async fetchProcessesOwnedByWallet({ address, pageSize, antRegistry = ant_registry_js_1.ANTRegistry.init(), }) {
         const uniqueContractProcessIds = {};
@@ -98,7 +100,7 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
             }
             const ant = ant_js_1.ANT.init({
                 processId,
-                strict: true,
+                strict: this.strict,
             });
             const state = (await timeout(this.timeoutMs, ant.getState()).catch((e) => {
                 this.emit('error', `Error getting state for process ${processId}: ${e}`);

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 = '2.4.0-alpha.9';
+exports.version = '2.4.0';

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

@@ -40,19 +40,21 @@ export class AOProcess {
                     process: this.processId,
                     tags,
                 });
+                this.logger.debug(`Read interaction result`, {
+                    result,
+                });
                 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 error = tagsOutput.find((tag) => tag.name === 'Error');
                 if (error) {
-                    throw new Error(`${error.Value}: ${result.Messages[0].Data}`);
+                    throw new Error(`${error.value}${messageData ? `: ${messageData}` : ''}`);
                 }
-                this.logger.debug(`Read interaction result`, {
-                    result: result.Messages[0].Data,
-                });
                 // return empty object if no data is returned
-                if (result.Messages[0].Data === undefined) {
+                if (messageData === undefined) {
                     return {};
                 }
                 const response = safeDecode(result.Messages[0].Data);

package/lib/esm/common/http.js

@@ -1,4 +1,4 @@
-import { createAxiosInstance } from '../utils/index.js';
+import { createAxiosInstance } from '../utils/http-client.js';
 import { FailedRequestError, NotFound, UnknownError } from './error.js';
 import { Logger } from './logger.js';
 export class AxiosHTTPService {