@ar.io/sdk 3.24.0 → 4.0.0-alpha.2

package/lib/cjs/utils/url.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.urlWithSearchParams = 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 urlWithSearchParams = ({ baseUrl, params, }) => {
-    const urlObj = new URL(baseUrl);
-    Object.entries(params).forEach(([key, value]) => {
-        if (value === undefined || value === null)
-            return;
-        if (Array.isArray(value) && value.length > 0) {
-            for (const v of value) {
-                if (v === undefined || v === null)
-                    continue;
-                urlObj.searchParams.append(key, v.toString());
-            }
-        }
-        else {
-            urlObj.searchParams.set(key, value.toString());
-        }
-    });
-    return urlObj.toString();
-};
-exports.urlWithSearchParams = urlWithSearchParams;

package/lib/cjs/version.js

@@ -1,20 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = void 0;
-// AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.24.0';

package/lib/cjs/web/index.js

@@ -1,41 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EthereumSigner = exports.InjectedEthereumSigner = exports.ArconnectSigner = exports.ArweaveSigner = 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.
- */
-var arbundles_1 = require("@dha-team/arbundles");
-Object.defineProperty(exports, "ArweaveSigner", { enumerable: true, get: function () { return arbundles_1.ArweaveSigner; } });
-Object.defineProperty(exports, "ArconnectSigner", { enumerable: true, get: function () { return arbundles_1.ArconnectSigner; } });
-Object.defineProperty(exports, "InjectedEthereumSigner", { enumerable: true, get: function () { return arbundles_1.InjectedEthereumSigner; } });
-Object.defineProperty(exports, "EthereumSigner", { enumerable: true, get: function () { return arbundles_1.EthereumSigner; } });
-__exportStar(require("../types/index.js"), exports);
-__exportStar(require("../common/index.js"), exports);
-__exportStar(require("../constants.js"), exports);
-__exportStar(require("../utils/index.js"), exports);

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

@@ -1,87 +0,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.
- */
-import { ANT_REGISTRY_ID } from '../constants.js';
-import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/io.js';
-import { createAoSigner } from '../utils/ao.js';
-import { pruneTags } from '../utils/arweave.js';
-import { AOProcess } from './contracts/ao-process.js';
-import { InvalidContractConfigurationError } from './error.js';
-export class ANTVersions {
-    static init(config) {
-        if (config !== undefined && 'signer' in config) {
-            return new ANTVersionsWritable(config);
-        }
-        return new ANTVersionsReadable(config);
-    }
-}
-export class ANTVersionsReadable {
-    process;
-    constructor(config) {
-        if (config === undefined || Object.keys(config).length === 0) {
-            this.process = new AOProcess({
-                processId: ANT_REGISTRY_ID,
-            });
-        }
-        else if (isProcessConfiguration(config)) {
-            this.process = config.process;
-        }
-        else if (isProcessIdConfiguration(config)) {
-            this.process = new AOProcess({
-                processId: config.processId,
-            });
-        }
-        else {
-            throw new InvalidContractConfigurationError();
-        }
-    }
-    async getANTVersions() {
-        const res = await this.process.read({
-            tags: [{ name: 'Action', value: 'Get-Versions' }],
-        });
-        return Object.fromEntries(Object.entries(res).sort(([a], [b]) => a.localeCompare(b)));
-    }
-    async getLatestANTVersion() {
-        const versions = await this.getANTVersions();
-        const lastestVersion = Object.entries(versions).at(-1);
-        if (!lastestVersion)
-            throw new Error('No version found');
-        return {
-            version: lastestVersion[0],
-            ...lastestVersion[1],
-        };
-    }
-}
-export class ANTVersionsWritable extends ANTVersionsReadable {
-    signer;
-    constructor({ signer, ...config }) {
-        super(config);
-        this.signer = createAoSigner(signer);
-    }
-    async addVersion(params, options) {
-        const { version, moduleId, luaSourceId, notes } = params;
-        return this.process.send({
-            tags: pruneTags([
-                { name: 'Action', value: 'Add-Version' },
-                { name: 'Version', value: version },
-                { name: 'Module-Id', value: moduleId },
-                { name: 'Lua-Source-Id', value: luaSourceId },
-                { name: 'Notes', value: notes },
-                ...(options?.tags ?? []),
-            ]),
-            signer: this.signer,
-        });
-    }
-}

package/lib/esm/common/arweave.js

@@ -1,21 +0,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.
- */
-import Arweave from 'arweave/node/index.js';
-export const defaultArweave = Arweave.init({
-    host: 'arweave.net',
-    port: 443,
-    protocol: 'https',
-});

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

@@ -1,220 +0,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.
- */
-import { connect } from '@permaweb/aoconnect';
-import { getRandomText } from '../../utils/base64.js';
-import { errorMessageFromOutput } from '../../utils/index.js';
-import { safeDecode } from '../../utils/json.js';
-import { version } from '../../version.js';
-import { WriteInteractionError } from '../error.js';
-import { Logger } from '../logger.js';
-export class AOProcess {
-    logger;
-    ao;
-    processId;
-    constructor({ processId, ao = connect({
-        MODE: 'legacy',
-    }), logger = Logger.default, }) {
-        this.processId = processId;
-        this.logger = logger;
-        this.ao = ao;
-    }
-    isMessageDataEmpty(messageData) {
-        return (messageData === undefined ||
-            messageData === 'null' || // This is what the CU returns for 'nil' values that are json.encoded
-            messageData === '' ||
-            messageData === null);
-    }
-    async read({ tags, retries = 3, fromAddress, select, }) {
-        this.logger.debug(`Evaluating read interaction on process`, {
-            tags,
-            processId: this.processId,
-        });
-        // map tags to inputs
-        const dryRunInput = {
-            process: this.processId,
-            tags,
-        };
-        if (fromAddress !== undefined) {
-            dryRunInput['Owner'] = fromAddress;
-        }
-        let attempts = 0;
-        let result = undefined;
-        while (attempts < retries) {
-            try {
-                result = await this.ao.dryrun(dryRunInput);
-                // break on successful return of result
-                break;
-            }
-            catch (error) {
-                attempts++;
-                this.logger.debug(`Read attempt ${attempts} failed`, {
-                    error: error?.message,
-                    stack: error?.stack,
-                    tags,
-                    processId: this.processId,
-                });
-                if (attempts >= retries) {
-                    this.logger.debug(`Maximum read attempts exceeded`, {
-                        error: error?.message,
-                        stack: error?.stack,
-                        tags,
-                        processId: this.processId,
-                        ao: JSON.stringify(this.ao),
-                    });
-                    throw new Error(`Failed to evaluate dry-run on process ${this.processId}.`, {
-                        cause: error,
-                    });
-                }
-                // exponential backoff
-                await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 1000));
-            }
-        }
-        if (result === undefined) {
-            throw new Error('Unexpected error when evaluating read interaction');
-        }
-        this.logger.debug(`Read interaction result`, {
-            result,
-            processId: this.processId,
-        });
-        const error = errorMessageFromOutput(result);
-        if (error !== undefined) {
-            throw new Error(error);
-        }
-        if (result.Messages === undefined || result.Messages.length === 0) {
-            this.logger.debug(`Empty result - process ${this.processId} does not support provided action.`, {
-                result,
-                tags,
-                processId: this.processId,
-            });
-            throw new Error(result.message ||
-                `Process ${this.processId} did not return a valid response. Response: ${JSON.stringify(result)}`);
-        }
-        const messageData = select
-            ? result.Messages.find(select)?.Data
-            : result.Messages?.[0]?.Data;
-        // return undefined if no data is returned
-        if (this.isMessageDataEmpty(messageData)) {
-            return undefined;
-        }
-        const response = safeDecode(messageData);
-        return response;
-    }
-    async send({ tags, data, signer, retries = 3, select, }) {
-        let messageId;
-        const anchor = getRandomText(32); // anchor is a random text produce non-deterministic messages IDs when deterministic signers are provided (ETH)
-        try {
-            this.logger.debug(`Evaluating send interaction on contract`, {
-                tags,
-                data,
-                processId: this.processId,
-            });
-            /**
-             * DO NOT retry messaging if a message was already sent.
-             * This could result in a double entry-like condition when sending tokens for example.
-             * If the message fails to send we will throw an error and the caller can retry.
-             */
-            messageId = await this.ao.message({
-                process: this.processId,
-                tags: [...tags, { name: 'AR-IO-SDK', value: version }],
-                data,
-                signer,
-                anchor,
-            });
-            this.logger.debug(`Sent message to process`, {
-                messageId,
-                processId: this.processId,
-                anchor,
-            });
-        }
-        catch (error) {
-            this.logger.debug('Error sending message to process', {
-                error: error?.message,
-                stack: error?.stack,
-                processId: this.processId,
-                tags,
-            });
-            // throw the error so it can be handled by the caller
-            throw error;
-        }
-        if (messageId === undefined) {
-            throw new Error('Failed to send message to process.');
-        }
-        // get the result of the message before returning, using retries to handle network errors/new process delays
-        let result = undefined;
-        let attempts = 0;
-        while (attempts < retries) {
-            try {
-                result = await this.ao.result({
-                    message: messageId,
-                    process: this.processId,
-                });
-                this.logger.debug('Message result', {
-                    result,
-                    messageId,
-                    processId: this.processId,
-                });
-                break;
-            }
-            catch (error) {
-                attempts++;
-                this.logger.debug('Retrying send interaction', {
-                    attempts,
-                    retries,
-                    error: error?.message,
-                    processId: this.processId,
-                });
-                if (attempts >= retries) {
-                    this.logger.debug(`Message was sent to process ${this.processId} with id ${messageId} but result was not returned. Review transactions for more details.`, {
-                        error: error?.message,
-                        stack: error?.stack,
-                        tags,
-                        processId: this.processId,
-                        messageId,
-                    });
-                    return { id: messageId };
-                }
-                // exponential backoff
-                await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 2000));
-            }
-        }
-        if (result === undefined) {
-            this.logger.debug(`Message was sent to process ${this.processId} with id ${messageId} but the result was not returned. Review transactions for more details.`, {
-                tags,
-                processId: this.processId,
-                messageId,
-            });
-            return { id: messageId };
-        }
-        const error = errorMessageFromOutput(result);
-        if (error !== undefined) {
-            throw new WriteInteractionError(error);
-        }
-        // check if there are any Messages in the output
-        if (result.Messages?.length === 0 || result.Messages === undefined) {
-            return { id: messageId };
-        }
-        if (this.isMessageDataEmpty(result.Messages[0].Data)) {
-            return { id: messageId };
-        }
-        const resultData = safeDecode(select ? result.Messages.find(select)?.Data : result.Messages[0].Data);
-        this.logger.debug('Message result data', {
-            resultData,
-            messageId,
-            processId: this.processId,
-        });
-        return { id: messageId, result: resultData };
-    }
-}

package/lib/esm/common/hyperbeam/hb.js

@@ -1,169 +0,0 @@
-import { Logger } from '../logger.js';
-export class HB {
-    url;
-    processId;
-    isHyperBeamCompatible;
-    checkHyperBeamPromise;
-    logger;
-    hbTimeoutMs;
-    constructor(config) {
-        this.url = config.url;
-        this.processId = config.processId;
-        this.logger = config.logger ?? Logger.default;
-        this.hbTimeoutMs = config.hbTimeoutMs ?? 5000;
-        this.isHyperBeamCompatible = undefined;
-        this.checkHyperBeamPromise = this.checkHyperBeamCompatibility();
-    }
-    /**
-     * fetches the meta data for the process
-     *
-     * @returns The meta data for the process
-     *
-     * @example
-     * const hyperbeam = new Hyperbeam({ url: 'https://hyperbeam.ario.permaweb.services', processId: 'qNvAoz0TgcH7DMg8BCVn8jF32QH5L6T29VjHxhHqqGE' });
-     * const meta = await hyperbeam.meta();
-     * console.log(meta);
-     */
-    async meta() {
-        const url = new URL(`${this.url}/${this.processId}~process@1.0/meta`);
-        return this.fetchHyperbeamPath({
-            path: url.toString(),
-        });
-    }
-    /**
-     * calls the process device /now function, which evaluates the current process state pulling new messages
-     * to get the latest state
-     *
-     * @param path - The path to the hb state
-     * @param json - Whether to return the result as JSON, defaults to true
-     * @returns The result of the compute operation
-     *
-     * @example
-     * const hyperbeam = new Hyperbeam({ url: 'https://hyperbeam.ario.permaweb.services', processId: 'qNvAoz0TgcH7DMg8BCVn8jF32QH5L6T29VjHxhHqqGE' });
-     * const result = await hyperbeam.now({ path: 'balances/QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ' });
-     * console.log(result);
-     */
-    async now({ path, json = false, }) {
-        return this.fetchHyperbeamPath({
-            path: `${this.url}/${this.processId}~process@1.0/now/${path}`,
-            json,
-        });
-    }
-    /**
-     * calls the process device /compute function, which uses the currently evaluated state in the node
-     *
-     * @param path - The path to the compute resource
-     * @param json - Whether to return the result as JSON, defaults to true
-     * @returns The result of the compute operation
-     *
-     * @example
-     * const hyperbeam = new Hyperbeam({ url: 'https://hyperbeam.ario.permaweb.services', processId: 'qNvAoz0TgcH7DMg8BCVn8jF32QH5L6T29VjHxhHqqGE' });
-     * const result = await hyperbeam.compute({ path: 'balances/QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ' });
-     * console.log(result);
-     */
-    async compute({ path, json = true, }) {
-        return this.fetchHyperbeamPath({
-            path: `${this.url}/${this.processId}~process@1.0/compute/${path}`,
-            json,
-        });
-    }
-    /**
-     * Checks if the process is HyperBeam compatible and caches the result.
-     *
-     * @returns {Promise<boolean>} True if the process is HyperBeam compatible, false otherwise.
-     */
-    async checkHyperBeamCompatibility({ minSlot, } = {}) {
-        // refetch if min slot is provided
-        if (minSlot !== undefined) {
-            this.isHyperBeamCompatible = undefined;
-            this.checkHyperBeamPromise = undefined;
-        }
-        if (this.checkHyperBeamPromise !== undefined) {
-            return this.checkHyperBeamPromise;
-        }
-        if (this.isHyperBeamCompatible !== undefined) {
-            return Promise.resolve(this.isHyperBeamCompatible);
-        }
-        const result = fetch(
-        // use /now to force a refresh of the cache state, then compute when calling it for keys
-        `${this.url.toString()}/${this.processId}~process@1.0/now`, {
-            method: 'HEAD',
-            signal: AbortSignal.timeout(this.hbTimeoutMs),
-        })
-            .then(async (res) => {
-            if (res.ok) {
-                if (minSlot !== undefined) {
-                    const slotRes = await this.compute({
-                        path: 'at-slot',
-                        json: false,
-                    });
-                    const slot = Number(slotRes);
-                    if (slot < minSlot) {
-                        return false;
-                    }
-                }
-                this.isHyperBeamCompatible = true;
-                return true;
-            }
-            this.isHyperBeamCompatible = false;
-            return false;
-        })
-            .catch((error) => {
-            this.logger.error('Failed to check HyperBeam compatibility', {
-                cause: error,
-            });
-            this.isHyperBeamCompatible = false;
-            return false;
-        });
-        this.checkHyperBeamPromise = result;
-        return result;
-    }
-    async fetchHyperbeamPath({ path, json = true, }) {
-        try {
-            const url = new URL(path);
-            if (json) {
-                this.logger.debug('Fetching path as JSON', { path });
-                /**
-                 * This is the (current) way to access data as json
-                 * the old way is /~json@1.0/serialize path
-                 */
-                url.searchParams.set('require-codec', 'application/json');
-                url.searchParams.set('accept-bundle', 'true');
-                const res = await fetch(url);
-                if (!res.ok) {
-                    throw new Error(`Failed to fetch path as JSON: ${res.statusText}`);
-                }
-                const jsonResult = await res
-                    .json()
-                    .then((json) => json)
-                    .catch((error) => {
-                    this.logger.error('Failed to parse JSON', {
-                        cause: error,
-                    });
-                    throw new Error(`Received response but failed to parse JSON: ${error.message}`);
-                });
-                if (typeof jsonResult !== 'object' ||
-                    jsonResult === null ||
-                    !('body' in jsonResult)) {
-                    throw new Error('Response body missing in JSON response');
-                }
-                return jsonResult.body;
-            }
-            else {
-                this.logger.debug('Fetching path as text', { path });
-                const res = await fetch(url);
-                if (!res.ok) {
-                    throw new Error(`Failed to fetch path: ${res.statusText}`);
-                }
-                const body = await res.text();
-                return body;
-            }
-        }
-        catch (error) {
-            this.logger.error('Failed to fetch path as JSON', {
-                cause: error,
-            });
-            throw error;
-        }
-    }
-}