@ar.io/sdk 1.2.0 → 2.0.0-alpha.1

package/lib/cjs/common/ant.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ANTWritable = exports.ANTReadable = exports.ANT = void 0;
+exports.ANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -18,46 +18,9 @@ exports.ANTWritable = exports.ANTReadable = exports.ANT = void 0;
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 const types_js_1 = require("../types.js");
-const smartweave_js_1 = require("../utils/smartweave.js");
-const remote_contract_js_1 = require("./contracts/remote-contract.js");
 const index_js_1 = require("./index.js");
 class ANT {
-    /**
-     * @param config - @type {ContractConfiguration} The configuration object.
-     * @returns {WarpContract<ANTState>} The contract object.
-     * @example
-     * Using the contract object
-     * ```ts
-     * ANT.createContract({ contract: new WarpContract<ANTState>({ contractTxId: 'myContractTxId' });
-     * ```
-     * Using the contractTxId
-     * ```ts
-     * ANT.createContract({ contractTxId: 'myContractTxId' });
-     * ```
-     */
-    static createWriteableContract(config) {
-        if ((0, smartweave_js_1.isContractConfiguration)(config)) {
-            return config.contract instanceof index_js_1.WarpContract
-                ? config.contract
-                : new index_js_1.WarpContract(config.contract.configuration());
-        }
-        else if ((0, smartweave_js_1.isContractTxIdConfiguration)(config)) {
-            return new index_js_1.WarpContract({ contractTxId: config.contractTxId });
-        }
-        else {
-            throw new index_js_1.InvalidContractConfigurationError();
-        }
-    }
     static init({ signer, ...config }) {
-        // TODO: these will be deprecated in the future
-        if ((0, smartweave_js_1.isContractConfiguration)(config) ||
-            (0, smartweave_js_1.isContractTxIdConfiguration)(config)) {
-            if (!signer) {
-                return new ANTReadable(config);
-            }
-            const contract = this.createWriteableContract(config);
-            return new ANTWritable({ signer, contract });
-        }
         // ao supported implementation
         if ((0, types_js_1.isProcessConfiguration)(config) || (0, types_js_1.isProcessIdConfiguration)(config)) {
             if (!signer) {
@@ -69,316 +32,3 @@ class ANT {
     }
 }
 exports.ANT = ANT;
-class ANTReadable {
-    contract;
-    constructor(config) {
-        if ((0, smartweave_js_1.isContractConfiguration)(config)) {
-            this.contract = config.contract;
-        }
-        else if ((0, smartweave_js_1.isContractTxIdConfiguration)(config)) {
-            this.contract = new remote_contract_js_1.RemoteContract({
-                contractTxId: config.contractTxId,
-            });
-        }
-        else {
-            throw new index_js_1.InvalidContractConfigurationError();
-        }
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<ANTState>} The state of the contract.
-     * @example
-     * Get the current state
-     * ```ts
-     * ant.getState();
-     * ```
-     * Get the state at a specific block height or sortkey
-     * ```ts
-     *  ant.getState({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     *  ant.getState({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getState({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state;
-    }
-    /**
-     * @param domain @type {string} The domain name.
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<ANTRecord>} The record of the undername domain.
-     * @example
-     * Get the current record
-     * ```ts
-     * ant.getRecord({ domain: "john" });
-     * ```
-     * Get the record at a specific block height or sortkey
-     * ```ts
-     *  ant.getRecord({ domain: "john", evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     *  ant.getRecord({  domain: "john", evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getRecord({ domain, evaluationOptions, }) {
-        const records = await this.getRecords({ evaluationOptions });
-        return records[domain];
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<Record<string, ANTRecord>>} All the undernames managed by the ANT.
-     * @example
-     * Get the current records
-     * ```ts
-     * ant.getRecords();
-     * ```
-     * Get the records at a specific block height or sortkey
-     * ```ts
-     *  ant.getRecords({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     *  ant.getRecords({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getRecords({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state.records;
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<string>} The owner of the ANT.
-     * @example
-     * Get the current owner
-     * ```ts
-     *  ant.getOwner();
-     * ```
-     * Get the owner at a specific block height or sortkey
-     * ```ts
-     * ant.getOwner({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     * ant.getOwner({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getOwner({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state.owner;
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<string[]>} The controllers of the ANT.
-     * @example
-     * Get the controllers of the ANT.
-     * ```ts
-     * ant.getControllers();
-     * ```
-     * Get the controllers at a specific block height or sortkey
-     * ```ts
-     * ant.getControllers({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     * ant.getControllers({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getControllers({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state.controllers;
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<string>} The name of the ANT (not the same as ArNS name).
-     * @example
-     * Get the current name
-     * ```ts
-     * ant.getName();
-     * ```
-     * @example
-     * Get the ticker at a specific block height or sortkey
-     * ```ts
-     * ant.getName({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     * ant.getName({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getName({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state.name;
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<string>} The name of the ANT (not the same as ArNS name).
-     * @example
-     * The current ticker of the ANT.
-     * ```ts
-     * ant.getTicker();
-     * ```
-     * @example
-     * Get the ticker at a specific block height or sortkey
-     * ```ts
-     * ant.getTicker({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     * ant.getTicker({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getTicker({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state.ticker;
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @returns {Promise<Record<string, number>>} The balances of the ANT
-     * @example
-     * The current balances of the ANT.
-     * ```ts
-     * ant.getBalances();
-     * ```
-     * @example
-     * Get the balances at a specific block height or sortkey
-     * ```ts
-     * ant.getBalances({ evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     * ant.getBalances({ evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getBalances({ evaluationOptions, } = {}) {
-        const state = await this.contract.getState({ evaluationOptions });
-        return state.balances;
-    }
-    /**
-     * @param evaluationOptions @type {EvaluationOptions} The evaluation options.
-     * @param address @type {string} The address of the account you want the balance of.
-     * @returns {Promise<number>} The balance of the provided address
-     * @example
-     * The current balance of the address.
-     * ```ts
-     * ant.getBalance({ address });
-     * ```
-     * @example
-     * Get the balance at a specific block height or sortkey
-     * ```ts
-     * ant.getBalance({ address, evaluationOptions: { evalTo: { blockHeight: 1000 } } });
-     * ant.getBalance({ address, evaluationOptions: { evalTo: { sortKey: 'mySortKey' } } });
-     * ```
-     */
-    async getBalance({ address, evaluationOptions, }) {
-        const balances = await this.getBalances({ evaluationOptions });
-        return balances[address] || 0;
-    }
-}
-exports.ANTReadable = ANTReadable;
-class ANTWritable extends ANTReadable {
-    signer;
-    constructor({ signer, ...config }) {
-        if ((0, smartweave_js_1.isContractConfiguration)(config)) {
-            super({ contract: config.contract });
-            this.signer = signer;
-        }
-        else if ((0, smartweave_js_1.isContractTxIdConfiguration)(config)) {
-            super({
-                contract: new index_js_1.WarpContract({
-                    contractTxId: config.contractTxId,
-                }),
-            });
-            this.signer = signer;
-        }
-        else {
-            throw new index_js_1.InvalidContractConfigurationError();
-        }
-    }
-    /**
-     * @param target @type {string} The address of the account you want to transfer the ANT to.
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.transfer({ target: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
-     */
-    async transfer({ target, }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.TRANSFER,
-            inputs: { target },
-            signer: this.signer,
-        }, options);
-    }
-    /**
-     * @param controller @type {string} The address of the account you want to set as a controller.
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
-     */
-    async setController({ controller, }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.SET_CONTROLLER,
-            inputs: { target: controller },
-            signer: this.signer,
-        }, options);
-    }
-    /**
-     * @param controller @type {string} The address of the account you want to remove from the controllers list
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.removeController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
-     */
-    async removeController({ controller, }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.REMOVE_CONTROLLER,
-            inputs: { target: controller },
-            signer: this.signer,
-        }, options);
-    }
-    /**
-     * @param subDomain @type {string} The record you want to set the transactionId and ttlSeconds of.
-     * @param transactionId @type {string} The transactionId of the record.
-     * @param ttlSeconds @type {number} The time to live of the record.
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
-     */
-    async setRecord({ subDomain, transactionId, ttlSeconds, }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.SET_RECORD,
-            inputs: { subDomain, transactionId, ttlSeconds },
-            signer: this.signer,
-        }, options);
-    }
-    /**
-     * @param subDomain @type {string} The record you want to remove.
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.removeRecord({ subDomain: "shorts" });
-     * ```
-     */
-    async removeRecord({ subDomain, }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.REMOVE_RECORD,
-            inputs: { subDomain },
-            signer: this.signer,
-        }, options);
-    }
-    /**
-     * @param ticker @type {string} Sets the ANT Ticker.
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setTicker({ ticker: "KAPOW" });
-     * ```
-     */
-    async setTicker({ ticker, }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.SET_TICKER,
-            inputs: { ticker },
-            signer: this.signer,
-        }, options);
-    }
-    /**
-     * @param name @type {string} Sets the Name of the ANT.
-     * @returns {Promise<WriteInteractionResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setName({ name: "ships at sea" });
-     * ```
-     */
-    async setName({ name }, options) {
-        return this.contract.writeInteraction({
-            functionName: types_js_1.ANT_CONTRACT_FUNCTIONS.SET_NAME,
-            inputs: { name },
-            signer: this.signer,
-        }, options);
-    }
-}
-exports.ANTWritable = ANTWritable;

package/lib/cjs/common/index.js

@@ -30,13 +30,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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/>.
  */
-__exportStar(require("./ar-io.js"), exports);
 __exportStar(require("./error.js"), exports);
 __exportStar(require("./logger.js"), exports);
 __exportStar(require("./ant.js"), exports);
-// contracts - deprecated
-__exportStar(require("./contracts/remote-contract.js"), exports);
-__exportStar(require("./contracts/warp-contract.js"), exports);
 // ao
 __exportStar(require("./io.js"), exports);
 __exportStar(require("./ant-ao.js"), exports);

package/lib/cjs/common/io.js

@@ -42,10 +42,10 @@ exports.IO = IO;
 class IOReadable {
     process;
     arweave;
-    constructor(config, arweave = arweave_1.default.init({})) {
+    constructor(config, arweave = new arweave_1.default({})) {
         if (!config) {
             this.process = new ao_process_js_1.AOProcess({
-                processId: constants_js_1.ioDevnetProcessId,
+                processId: constants_js_1.IO_TESTNET_PROCESS_ID,
             });
         }
         else if ((0, io_js_1.isProcessConfiguration)(config)) {
@@ -297,7 +297,7 @@ class IOWriteable extends IOReadable {
         if (Object.keys(config).length === 0) {
             super({
                 process: new ao_process_js_1.AOProcess({
-                    processId: constants_js_1.ioDevnetProcessId,
+                    processId: constants_js_1.IO_TESTNET_PROCESS_ID,
                 }),
             });
             this.signer = signer;

package/lib/cjs/types.js

@@ -30,7 +30,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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/>.
  */
-__exportStar(require("./arns-service.js"), exports);
 __exportStar(require("./contract-state.js"), exports);
 __exportStar(require("./common.js"), exports);
 __exportStar(require("./token.js"), exports);

package/lib/cjs/utils/arweave.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tagsToObject = exports.isTransaction = exports.isBlockHeight = exports.validateArweaveId = void 0;
+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);
@@ -10,17 +10,3 @@ function isBlockHeight(height) {
     return height !== undefined && !isNaN(parseInt(height.toString()));
 }
 exports.isBlockHeight = isBlockHeight;
-const isTransaction = (tx) => {
-    const requiredTxKeys = ['id', 'owner', 'tags', 'signature'];
-    return requiredTxKeys.every((key) => key in tx);
-};
-exports.isTransaction = isTransaction;
-function tagsToObject(tags) {
-    return tags.reduce((decodedTags, tag) => {
-        const key = tag.get('name', { decode: true, string: true });
-        const value = tag.get('value', { decode: true, string: true });
-        decodedTags[key] = value;
-        return decodedTags;
-    }, {});
-}
-exports.tagsToObject = tagsToObject;

package/lib/cjs/utils/graphql/index.js

@@ -30,5 +30,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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/>.
  */
-__exportStar(require("./smartweave.js"), exports);
 __exportStar(require("./processes.js"), exports);

package/lib/cjs/utils/graphql/processes.js

@@ -23,7 +23,7 @@ const ant_js_1 = require("../../common/ant.js");
 const io_js_1 = require("../../common/io.js");
 const constants_js_1 = require("../../constants.js");
 const getANTProcessesOwnedByWallet = async ({ address, contract = io_js_1.IO.init({
-    processId: constants_js_1.ioDevnetProcessId,
+    processId: constants_js_1.IO_TESTNET_PROCESS_ID,
 }), }) => {
     const throttle = (0, plimit_lit_1.pLimit)(50);
     // get the record names of the registry - TODO: this may need to be paginated
@@ -71,7 +71,7 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
     timeoutMs; // timeout for each request to 3 seconds
     throttle;
     constructor({ contract = io_js_1.IO.init({
-        processId: constants_js_1.ioDevnetProcessId,
+        processId: constants_js_1.IO_TESTNET_PROCESS_ID,
     }), timeoutMs = 60_000, concurrency = 30, }) {
         super();
         this.contract = contract;

package/lib/cjs/utils/index.js

@@ -32,7 +32,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./arweave.js"), exports);
 __exportStar(require("./http-client.js"), exports);
-__exportStar(require("./smartweave.js"), exports);
 __exportStar(require("./graphql/index.js"), exports);
 __exportStar(require("./ao.js"), exports);
 __exportStar(require("./json.js"), exports);

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