@ar.io/sdk 2.6.0 → 2.7.0-alpha.2

package/lib/cjs/cli/utils.js

@@ -0,0 +1,406 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughBalance = exports.requiredMIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.writeActionTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatIOWithCommas = exports.writeIOFromOptions = exports.requiredAoSignerFromOptions = exports.requiredContractSignerFromOptions = exports.readIOFromOptions = exports.getLoggerFromOptions = exports.jwkToAddress = exports.requiredJwkFromOptions = exports.ioProcessIdFromOptions = exports.makeCommand = exports.runCommand = exports.stringifyJsonForCLIDisplay = 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 aoconnect_1 = require("@permaweb/aoconnect");
+const commander_1 = require("commander");
+const fs_1 = require("fs");
+const prompts_1 = __importDefault(require("prompts"));
+const index_js_1 = require("../node/index.js");
+const options_js_1 = require("./options.js");
+function stringifyJsonForCLIDisplay(json) {
+    return JSON.stringify(json, null, 2);
+}
+exports.stringifyJsonForCLIDisplay = stringifyJsonForCLIDisplay;
+function logCommandOutput(output) {
+    console.log(stringifyJsonForCLIDisplay(output));
+}
+function exitWithErrorLog(error, debug = false) {
+    let errorLog;
+    if (error instanceof Error) {
+        errorLog = error.message;
+        if (debug && error.stack !== undefined) {
+            errorLog = error.stack;
+        }
+    }
+    else {
+        errorLog = stringifyJsonForCLIDisplay(error);
+    }
+    console.error(errorLog);
+    process.exit(1);
+}
+async function runCommand(command, action) {
+    const options = command.optsWithGlobals();
+    try {
+        const output = await action(options);
+        logCommandOutput(output);
+        process.exit(0);
+    }
+    catch (error) {
+        exitWithErrorLog(error, options.debug);
+    }
+}
+exports.runCommand = runCommand;
+function applyOptions(command, options) {
+    [...options].forEach((option) => {
+        command.option(option.alias, option.description, option.default);
+    });
+    return command;
+}
+function makeCommand({ description, name, options = [], action, }) {
+    const command = commander_1.program.command(name).description(description);
+    const appliedCommand = applyOptions(command, [...options, ...options_js_1.globalOptions]);
+    if (action !== undefined) {
+        appliedCommand.action(() => runCommand(appliedCommand, action));
+    }
+    return appliedCommand;
+}
+exports.makeCommand = makeCommand;
+function ioProcessIdFromOptions({ ioProcessId, dev, }) {
+    return ioProcessId !== undefined
+        ? ioProcessId
+        : dev
+            ? index_js_1.IO_DEVNET_PROCESS_ID
+            : index_js_1.IO_TESTNET_PROCESS_ID;
+}
+exports.ioProcessIdFromOptions = ioProcessIdFromOptions;
+function jwkFromOptions({ privateKey, walletFile, }) {
+    if (privateKey !== undefined) {
+        return JSON.parse(privateKey);
+    }
+    if (walletFile !== undefined) {
+        return JSON.parse((0, fs_1.readFileSync)(walletFile, 'utf-8'));
+    }
+    return undefined;
+}
+function requiredJwkFromOptions(options) {
+    const jwk = jwkFromOptions(options);
+    if (jwk === undefined) {
+        throw new Error('No JWK provided for signing!\nPlease provide a stringified JWK with `--private-key` or the file path of a jwk.json file with `--wallet-file`');
+    }
+    return jwk;
+}
+exports.requiredJwkFromOptions = requiredJwkFromOptions;
+function jwkToAddress(jwk) {
+    return (0, index_js_1.sha256B64Url)((0, index_js_1.fromB64Url)(jwk.n));
+}
+exports.jwkToAddress = jwkToAddress;
+function setLoggerIfDebug(options) {
+    if (options.debug) {
+        index_js_1.Logger.default.setLogLevel('debug');
+    }
+}
+function getLoggerFromOptions(options) {
+    setLoggerIfDebug(options);
+    return index_js_1.Logger.default;
+}
+exports.getLoggerFromOptions = getLoggerFromOptions;
+function aoProcessFromOptions(options) {
+    return new index_js_1.AOProcess({
+        processId: ioProcessIdFromOptions(options),
+        ao: (0, aoconnect_1.connect)({
+            CU_URL: options.cuUrl,
+        }),
+    });
+}
+function readIOFromOptions(options) {
+    setLoggerIfDebug(options);
+    return index_js_1.IO.init({
+        process: aoProcessFromOptions(options),
+    });
+}
+exports.readIOFromOptions = readIOFromOptions;
+function requiredContractSignerFromOptions(options) {
+    // TODO: Support other wallet types
+    const jwk = requiredJwkFromOptions(options);
+    const signer = new index_js_1.ArweaveSigner(jwk);
+    return { signer, signerAddress: jwkToAddress(jwk) };
+}
+exports.requiredContractSignerFromOptions = requiredContractSignerFromOptions;
+function requiredAoSignerFromOptions(options) {
+    return (0, index_js_1.createAoSigner)(requiredContractSignerFromOptions(options).signer);
+}
+exports.requiredAoSignerFromOptions = requiredAoSignerFromOptions;
+function writeIOFromOptions(options) {
+    const { signer, signerAddress } = requiredContractSignerFromOptions(options);
+    setLoggerIfDebug(options);
+    return {
+        io: index_js_1.IO.init({
+            process: aoProcessFromOptions(options),
+            signer,
+        }),
+        signerAddress,
+    };
+}
+exports.writeIOFromOptions = writeIOFromOptions;
+function formatIOWithCommas(value) {
+    const [integerPart, decimalPart] = value.toString().split('.');
+    const integerWithCommas = integerPart.replace(/\B(?=(\d{3})+(?!\d))/g, ',');
+    if (decimalPart === undefined) {
+        return integerWithCommas;
+    }
+    return integerWithCommas + '.' + decimalPart;
+}
+exports.formatIOWithCommas = formatIOWithCommas;
+/** helper to get address from --address option first, then check wallet options  */
+function addressFromOptions(options) {
+    if (options.address !== undefined) {
+        return options.address;
+    }
+    // TODO: Support other wallet types
+    const jwk = jwkFromOptions(options);
+    if (jwk !== undefined) {
+        return jwkToAddress(jwk);
+    }
+    return undefined;
+}
+exports.addressFromOptions = addressFromOptions;
+function requiredAddressFromOptions(options) {
+    const address = addressFromOptions(options);
+    if (address !== undefined) {
+        return address;
+    }
+    throw new Error('No address provided. Use --address or --wallet-file');
+}
+exports.requiredAddressFromOptions = requiredAddressFromOptions;
+const defaultCliPaginationLimit = 10; // more friendly UX than 100
+function paginationParamsFromOptions(options) {
+    const { cursor, limit, sortBy, sortOrder } = options;
+    if (sortOrder !== undefined && !['asc', 'desc'].includes(sortOrder)) {
+        throw new Error(`Invalid sort order: ${sortOrder}, must be "asc" or "desc"`);
+    }
+    const numberLimit = limit !== undefined ? +limit : defaultCliPaginationLimit;
+    if (isNaN(numberLimit) || numberLimit <= 0) {
+        throw new Error(`Invalid limit: ${numberLimit}, must be a positive number`);
+    }
+    return {
+        cursor,
+        limit: numberLimit,
+        sortBy,
+        sortOrder,
+    };
+}
+exports.paginationParamsFromOptions = paginationParamsFromOptions;
+function epochInputFromOptions(options) {
+    if (options.epochIndex !== undefined) {
+        return { epochIndex: +options.epochIndex };
+    }
+    if (options.timestamp !== undefined) {
+        return { timestamp: +options.timestamp };
+    }
+    return undefined;
+}
+exports.epochInputFromOptions = epochInputFromOptions;
+function requiredInitiatorFromOptions(options) {
+    if (options.initiator !== undefined) {
+        return options.initiator;
+    }
+    return requiredAddressFromOptions(options);
+}
+exports.requiredInitiatorFromOptions = requiredInitiatorFromOptions;
+function writeActionTagsFromOptions(options) {
+    if (options.tags === undefined) {
+        return {};
+    }
+    if (!Array.isArray(options.tags)) {
+        throw new Error('Tags must be an array');
+    }
+    if (options.tags.length === 0) {
+        return {};
+    }
+    if (options.tags.length % 2 !== 0) {
+        throw new Error('Tags must be an array of key-value pairs');
+    }
+    const tags = [];
+    for (let i = 0; i < options.tags.length; i += 2) {
+        tags.push({
+            name: options.tags[i],
+            value: options.tags[i + 1],
+        });
+    }
+    return {
+        tags,
+    };
+}
+exports.writeActionTagsFromOptions = writeActionTagsFromOptions;
+function gatewaySettingsFromOptions({ allowDelegatedStaking, autoStake, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, observerAddress, port, properties, allowedDelegates, }) {
+    return {
+        observerAddress,
+        allowDelegatedStaking,
+        autoStake,
+        delegateRewardShareRatio: delegateRewardShareRatio !== undefined
+            ? +delegateRewardShareRatio
+            : undefined,
+        allowedDelegates,
+        fqdn,
+        label,
+        minDelegatedStake: minDelegatedStake !== undefined ? +minDelegatedStake : undefined,
+        note,
+        port: port !== undefined ? +port : undefined,
+        properties,
+    };
+}
+exports.gatewaySettingsFromOptions = gatewaySettingsFromOptions;
+function requiredTargetAndQuantityFromOptions(options) {
+    if (options.target === undefined) {
+        throw new Error('No target provided. Use --target');
+    }
+    if (options.quantity === undefined) {
+        throw new Error('No quantity provided. Use --quantity');
+    }
+    return {
+        target: options.target,
+        ioQuantity: new index_js_1.IOToken(+options.quantity),
+    };
+}
+exports.requiredTargetAndQuantityFromOptions = requiredTargetAndQuantityFromOptions;
+function redelegateParamsFromOptions(options) {
+    const { target, ioQuantity } = requiredTargetAndQuantityFromOptions(options);
+    const source = options.source;
+    if (source === undefined) {
+        throw new Error('No source provided. Use --source');
+    }
+    return {
+        target,
+        source,
+        vaultId: options.vaultId,
+        stakeQty: ioQuantity.toMIO(),
+    };
+}
+exports.redelegateParamsFromOptions = redelegateParamsFromOptions;
+function recordTypeFromOptions(options) {
+    options.type ??= 'lease';
+    if (options.type !== 'lease' && options.type !== 'permabuy') {
+        throw new Error(`Invalid type. Valid types are: lease, permabuy`);
+    }
+    return options.type;
+}
+exports.recordTypeFromOptions = recordTypeFromOptions;
+function requiredMIOFromOptions(options, key) {
+    if (options[key] === undefined) {
+        throw new Error(`No ${key} provided. Use --${key} denominated in IO`);
+    }
+    return new index_js_1.IOToken(+options[key]).toMIO();
+}
+exports.requiredMIOFromOptions = requiredMIOFromOptions;
+async function assertEnoughBalance(io, address, ioQuantity) {
+    const balance = await io.getBalance({ address });
+    if (balance < ioQuantity.toMIO().valueOf()) {
+        throw new Error(`Insufficient IO balance for action. Balance available: ${new index_js_1.mIOToken(balance).toIO()} IO`);
+    }
+}
+exports.assertEnoughBalance = assertEnoughBalance;
+async function confirmationPrompt(message) {
+    const { confirm } = await (0, prompts_1.default)({
+        type: 'confirm',
+        name: 'confirm',
+        message,
+    });
+    return confirm;
+}
+exports.confirmationPrompt = confirmationPrompt;
+async function assertConfirmationPrompt(message, options) {
+    if (options.skipConfirmation) {
+        return true;
+    }
+    return confirmationPrompt(message);
+}
+exports.assertConfirmationPrompt = assertConfirmationPrompt;
+function requiredProcessIdFromOptions(o) {
+    if (o.processId === undefined) {
+        throw new Error('--process-id is required');
+    }
+    return o.processId;
+}
+exports.requiredProcessIdFromOptions = requiredProcessIdFromOptions;
+function ANTProcessFromOptions(options) {
+    return new index_js_1.AOProcess({
+        processId: requiredProcessIdFromOptions(options),
+        ao: (0, aoconnect_1.connect)({
+            CU_URL: options.cuUrl,
+        }),
+    });
+}
+function readANTFromOptions(options) {
+    return index_js_1.ANT.init({
+        process: ANTProcessFromOptions(options),
+    });
+}
+exports.readANTFromOptions = readANTFromOptions;
+function writeANTFromOptions(options, signer) {
+    signer ??= requiredContractSignerFromOptions(options).signer;
+    return index_js_1.ANT.init({
+        process: ANTProcessFromOptions(options),
+        signer,
+    });
+}
+exports.writeANTFromOptions = writeANTFromOptions;
+function requiredStringFromOptions(options, key) {
+    const value = options[key];
+    if (value === undefined) {
+        throw new Error(`--${key} is required`);
+    }
+    return value;
+}
+exports.requiredStringFromOptions = requiredStringFromOptions;
+function requiredStringArrayFromOptions(options, key) {
+    const value = options[key];
+    if (value === undefined) {
+        throw new Error(`--${key} is required`);
+    }
+    if (!Array.isArray(value)) {
+        throw new Error(`--${key} must be an array`);
+    }
+    return value;
+}
+exports.requiredStringArrayFromOptions = requiredStringArrayFromOptions;
+function positiveIntegerFromOptions(options, key) {
+    const value = options[key];
+    if (value === undefined) {
+        return undefined;
+    }
+    const numberValue = +value;
+    if (isNaN(numberValue) || numberValue <= 0) {
+        throw new Error(`Invalid ${key}: ${value}, must be a positive number`);
+    }
+    return numberValue;
+}
+exports.positiveIntegerFromOptions = positiveIntegerFromOptions;
+function requiredPositiveIntegerFromOptions(options, key) {
+    const value = positiveIntegerFromOptions(options, key);
+    if (value === undefined) {
+        throw new Error(`--${key} is required`);
+    }
+    return value;
+}
+exports.requiredPositiveIntegerFromOptions = requiredPositiveIntegerFromOptions;
+function getANTStateFromOptions(options) {
+    return (0, index_js_1.initANTStateForAddress)({
+        owner: requiredAddressFromOptions(options),
+        targetId: options.target,
+        controllers: options.controllers,
+        description: options.description,
+        ticker: options.ticker,
+        name: options.name,
+        keywords: options.keywords,
+        ttlSeconds: options.ttlSeconds !== undefined ? +options.ttlSeconds : 0,
+    });
+}
+exports.getANTStateFromOptions = getANTStateFromOptions;

package/lib/cjs/common/io.js

@@ -384,13 +384,7 @@ class IOReadable {
         });
     }
     async getAllowedDelegates(params) {
-        return this.process.read({
-            tags: [
-                { name: 'Action', value: 'Paginated-Allowed-Delegates' },
-                { name: 'Address', value: params.address },
-                ...(0, arweave_js_1.paginationParamsToTags)(params),
-            ],
-        });
+        return this.getGatewayDelegateAllowList(params);
     }
     async getGatewayVaults(params) {
         return this.process.read({
@@ -679,6 +673,7 @@ class IOWriteable extends IOReadable {
                 ...tags,
                 { name: 'Action', value: 'Decrease-Operator-Stake' },
                 { name: 'Quantity', value: params.decreaseQty.valueOf().toString() },
+                { name: 'Instant', value: `${params.instant || false}` },
             ],
         });
     }

package/lib/cjs/types/io.js

@@ -1,7 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = void 0;
+exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = void 0;
 const arweave_js_1 = require("../utils/arweave.js");
+exports.validIntents = [
+    'Buy-Record',
+    'Extend-Lease',
+    'Increase-Undername-Limit',
+    'Upgrade-Name',
+    'Primary-Name-Request',
+];
+exports.intentsUsingYears = ['Buy-Record', 'Extend-Lease'];
+const isValidIntent = (intent) => {
+    return exports.validIntents.indexOf(intent) !== -1;
+};
+exports.isValidIntent = isValidIntent;
 // Typeguard functions
 function isProcessConfiguration(config) {
     return 'process' in config;

package/lib/cjs/utils/ao.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
+exports.initANTStateForAddress = exports.defaultTargetManifestId = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -23,14 +23,6 @@ const arweave_js_1 = require("../common/arweave.js");
 const index_js_1 = require("../common/index.js");
 const constants_js_1 = require("../constants.js");
 async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, luaCodeTxId = constants_js_1.ANT_LUA_ID, ao = (0, aoconnect_1.connect)(), scheduler = constants_js_1.DEFAULT_SCHEDULER_ID, state, stateContractTxId, antRegistryId = constants_js_1.ANT_REGISTRY_ID, logger = index_js_1.Logger.default, arweave = arweave_js_1.defaultArweave, }) {
-    const registryClient = index_js_1.ANTRegistry.init({
-        process: new index_js_1.AOProcess({
-            processId: antRegistryId,
-            ao,
-            logger,
-        }),
-        signer: signer,
-    });
     //TODO: cache locally and only fetch if not cached
     const luaString = (await arweave.transactions.getData(luaCodeTxId, {
         decode: true,
@@ -65,7 +57,7 @@ async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, luaCode
         data: luaString,
         signer,
     });
-    logger.info(`Spawned ANT`, {
+    logger.debug(`Spawned ANT`, {
         processId,
         module,
         scheduler,
@@ -83,17 +75,25 @@ async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, luaCode
             data: JSON.stringify(state),
             signer,
         });
-        logger.info(`Initialized ANT`, {
+        logger.debug(`Initialized ANT`, {
             processId,
             module,
             scheduler,
             initializeMsgId,
         });
     }
+    const registryClient = index_js_1.ANTRegistry.init({
+        process: new index_js_1.AOProcess({
+            processId: antRegistryId,
+            ao,
+            logger,
+        }),
+        signer: signer,
+    });
     const { id: antRegistrationMsgId } = await registryClient.register({
         processId,
     });
-    logger.info(`Registered ANT to ANT Registry`, {
+    logger.debug(`Registered ANT to ANT Registry`, {
         processId,
         module,
         scheduler,
@@ -123,7 +123,7 @@ async function evolveANT({ signer, processId, luaCodeTxId = constants_js_1.ANT_L
         data: luaString,
         signer,
     });
-    logger.info(`Evolved ANT`, {
+    logger.debug(`Evolved ANT`, {
         processId,
         luaCodeTxId,
         evalMsgId: evolveMsgId,
@@ -181,3 +181,22 @@ function createAoSigner(signer) {
     return aoSigner;
 }
 exports.createAoSigner = createAoSigner;
+exports.defaultTargetManifestId = '-k7t8xMoB8hW482609Z9F4bTFMC3MnuW8bTvTyT8pFI';
+function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords = [], controllers = [], description = '', ticker = 'aos', name = 'ANT', }) {
+    return {
+        ticker,
+        name,
+        description,
+        keywords,
+        owner,
+        controllers: [owner, ...controllers],
+        balances: { [owner]: 1 },
+        records: {
+            ['@']: {
+                transactionId: targetId ?? exports.defaultTargetManifestId.toString(),
+                ttlSeconds,
+            },
+        },
+    };
+}
+exports.initANTStateForAddress = initANTStateForAddress;

package/lib/cjs/utils/base64.js

@@ -49,6 +49,6 @@ function toB64Url(buffer) {
 }
 exports.toB64Url = toB64Url;
 function sha256B64Url(input) {
-    return toB64Url((0, crypto_1.createHash)('sha256').update(input).digest());
+    return toB64Url((0, crypto_1.createHash)('sha256').update(Uint8Array.from(input)).digest());
 }
 exports.sha256B64Url = sha256B64Url;

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.6.0';
+exports.version = '2.7.0-alpha.2';