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

package/lib/cjs/cli/options.js

@@ -1,470 +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.transferRecordOwnershipOptions = exports.upgradeAntOptions = exports.setAntUndernameOptions = exports.setAntBaseNameOptions = exports.antStateOptions = exports.buyRecordOptions = exports.joinNetworkOptions = exports.updateGatewaySettingsOptions = exports.decreaseDelegateStakeOptions = exports.delegateStakeOptions = exports.redelegateStakeOptions = exports.operatorStakeOptions = exports.vaultedTransferOptions = exports.transferOptions = exports.tokenCostOptions = exports.getVaultOptions = exports.paginationAddressOptions = exports.paginationOptions = exports.nameWriteOptions = exports.addressAndVaultIdOptions = exports.epochOptions = exports.arnsPurchaseOptions = exports.writeActionOptions = exports.globalOptions = exports.walletOptions = exports.optionMap = void 0;
-exports.optionMap = {
-    walletFile: {
-        alias: '-w, --wallet-file <walletFilePath>',
-        description: 'The file path to the wallet to use for the interaction',
-    },
-    // mnemonic: {
-    //   alias: '-m, --mnemonic <phrase>',
-    //   description: 'Mnemonic to use with the action',
-    // },
-    privateKey: {
-        alias: '--private-key <key>',
-        description: 'Stringified private key to use with the action',
-    },
-    mainnet: {
-        alias: '--mainnet',
-        description: 'Run against the AR.IO mainnet process',
-        type: 'boolean',
-    },
-    testnet: {
-        alias: '--testnet',
-        description: 'Run against the AR.IO testnet process',
-        type: 'boolean',
-    },
-    devnet: {
-        alias: '--dev, --devnet',
-        description: 'Run against the AR.IO devnet process',
-        type: 'boolean',
-    },
-    arioProcessId: {
-        alias: '--ario-process-id <arioProcessId>',
-        description: 'Run against a custom AR.IO process id',
-    },
-    antRegistryProcessId: {
-        alias: '--ant-registry-process-id <antRegistryProcessId>',
-        description: 'Run against a custom ANT registry process id',
-    },
-    hyperbeamUrl: {
-        alias: '--hyperbeam-url <hyperbeamUrl>',
-        description: 'The URL for a custom hyperbeam node',
-    },
-    cuUrl: {
-        alias: '--cu-url <cuUrl>',
-        description: 'The URL for a custom compute unit',
-    },
-    paymentUrl: {
-        alias: '--payment-url <paymentUrl>',
-        description: 'The URL for a custom turbo payment service',
-    },
-    processId: {
-        alias: '--process-id <processId>',
-        description: 'The process ID to interact with',
-    },
-    debug: {
-        alias: '--debug',
-        description: 'Enable debug log output',
-        type: 'boolean',
-    },
-    address: {
-        alias: '-a, --address <address>',
-        description: 'The address to interact with',
-    },
-    target: {
-        alias: '--target <target>',
-        description: 'The target address to interact with',
-    },
-    source: {
-        alias: '--source <source>',
-        description: 'The source address to interact with',
-    },
-    quantity: {
-        alias: '-q, --quantity <quantity>',
-        description: 'The quantity of ARIO to interact with',
-    },
-    autoStake: {
-        alias: '--auto-stake',
-        description: 'Enable auto-staking of operator rewards',
-        type: 'boolean',
-    },
-    allowDelegatedStaking: {
-        alias: '--allow-delegated-staking',
-        description: 'Allow delegating stake to the gateway',
-        type: 'boolean',
-    },
-    minDelegatedStake: {
-        alias: '--min-delegated-stake <minDelegatedStake>',
-        description: 'The minimum delegated stake allowed',
-    },
-    delegateRewardShareRatio: {
-        alias: '--delegate-reward-share-ratio <delegateRewardShareRatio>',
-        description: 'The percentage of rewards to share with delegates',
-    },
-    label: {
-        alias: '--label <label>',
-        description: 'The label for the gateway',
-    },
-    note: {
-        alias: '--note <note>',
-        description: 'The note for the gateway',
-    },
-    properties: {
-        alias: '--properties <properties>',
-        description: 'The properties for the gateway',
-    },
-    observerAddress: {
-        alias: '--observer-address <observerAddress>',
-        description: 'The observer wallet address for the gateway',
-    },
-    fqdn: {
-        alias: '--fqdn <fqdn>',
-        description: 'The fully qualified domain name for the gateway',
-    },
-    port: {
-        alias: '--port <port>',
-        description: 'The port for the gateway',
-    },
-    protocol: {
-        alias: '--protocol <protocol>',
-        description: 'The protocol for the gateway',
-    },
-    allowedDelegates: {
-        alias: '--allowed-delegates <allowedDelegates...>',
-        description: 'The allowed delegates for the gateway. By default this is empty, meaning all are allowed delegate stake unless delegating is explicitly disallowed by the gateway',
-        type: 'array',
-    },
-    services: {
-        alias: '--services <services>',
-        description: 'JSON string of gateway services configuration (e.g., \'{"bundlers":[{"fqdn":"bundler.example.com","port":443,"protocol":"https","path":"/bundler"}]}\')',
-    },
-    skipConfirmation: {
-        alias: '--skip-confirmation',
-        description: 'Skip confirmation prompts',
-        type: 'boolean',
-    },
-    vaultId: {
-        alias: '--vault-id <vaultId>',
-        description: 'The vault ID to interact with',
-    },
-    operatorStake: {
-        alias: '--operator-stake <operatorStake>',
-        description: 'The operator stake to interact with',
-    },
-    name: {
-        alias: '--name <name>',
-        description: 'The ArNS name to interact with',
-    },
-    epochIndex: {
-        alias: '--epoch-index <epochIndex>',
-        description: 'The epoch index to interact with',
-    },
-    timestamp: {
-        alias: '--timestamp <timestamp>',
-        description: 'The timestamp to interact with',
-    },
-    initiator: {
-        alias: '--initiator <initiator>',
-        description: 'The initiator of the action',
-    },
-    intent: {
-        alias: '--intent <intent>',
-        description: 'The intent for the cost details action',
-    },
-    type: {
-        alias: '--type <type>',
-        description: 'The type for the cost details action. Either "lease" or "permabuy"',
-    },
-    years: {
-        alias: '--years <years>',
-        description: 'The number of years for the cost details action',
-    },
-    intervalMs: {
-        alias: '--interval-ms <intervalMs>',
-        description: 'The interval in milliseconds for the action',
-    },
-    cursor: {
-        alias: '--cursor <cursor>',
-        description: 'The cursor for pagination',
-    },
-    limit: {
-        alias: '--limit <limit>',
-        description: 'The limit for pagination',
-    },
-    sortBy: {
-        alias: '--sort-by <sortBy>',
-        description: 'The field to sort by',
-    },
-    sortOrder: {
-        alias: '--sort-order <sortOrder>',
-        description: 'The order to sort by, either "asc" or "desc"',
-    },
-    filters: {
-        alias: '--filters <filters...>',
-        description: 'The filters to apply for pagination. Format: --filters key1 value1,value2 key2 value3,value4 key3 value5',
-        type: 'array',
-    },
-    tags: {
-        description: 'An array of additional tags for the write action, in "--tags name1 value1 name2 value2" format',
-        alias: '--tags <tags...>',
-        type: 'array',
-    },
-    instant: {
-        alias: '--instant',
-        description: 'Use the instant transaction method',
-        type: 'boolean',
-    },
-    increaseCount: {
-        alias: '--increase-count <increaseCount>',
-        description: 'Amount to increase the undername count of the record by',
-    },
-    undername: {
-        alias: '--undername <undername>',
-        description: 'The undername to interact with',
-    },
-    controller: {
-        alias: '--controller <controller>',
-        description: 'The controller to interact with',
-    },
-    controllers: {
-        alias: '--controllers <controllers...>',
-        description: 'The controller to interact with',
-        type: 'array',
-    },
-    transactionId: {
-        alias: '--transaction-id <transactionId>',
-        description: 'The transaction ID to interact with',
-    },
-    ttlSeconds: {
-        alias: '--ttl-seconds <ttlSeconds>',
-        description: 'The TTL in seconds for the record',
-    },
-    ticker: {
-        alias: '--ticker <ticker>',
-        description: 'The ticker for the ANT',
-    },
-    description: {
-        alias: '--description <description>',
-        description: 'The description for the ANT',
-    },
-    keywords: {
-        alias: '--keywords <keywords...>',
-        description: 'The keywords for the ANT',
-        type: 'array',
-    },
-    owner: {
-        alias: '--owner <owner>',
-        description: 'The owner address for the record',
-    },
-    displayName: {
-        alias: '--display-name <displayName>',
-        description: 'The display name for the record',
-    },
-    names: {
-        alias: '--names <names...>',
-        description: 'The names to interact with',
-        type: 'array',
-    },
-    failedGateways: {
-        alias: '--failed-gateways <failedGateways...>',
-        description: 'Include failed gateways in the list',
-        type: 'array',
-    },
-    fundFrom: {
-        alias: '--fund-from <fundFrom>',
-        description: 'Where to fund the action from. e.g. "balance", "stakes", or "any',
-    },
-    revokable: {
-        alias: '--revokable',
-        description: 'Whether the vaulted transfer is revokable by the sender. Defaults to false',
-        type: 'boolean',
-    },
-    removeControllers: {
-        alias: '--remove-controllers',
-        description: 'Whether to remove controllers when transferring ANT ownership. Defaults to true',
-        type: 'boolean',
-    },
-    lockLengthMs: {
-        alias: '--lock-length-ms <lockLengthMs>',
-        description: 'The length of time in milliseconds to lock the vault for',
-    },
-    extendLengthMs: {
-        alias: '--extend-length-ms <extendLengthMs>',
-        description: 'The length of time in milliseconds to extend the vault for',
-    },
-    recipient: {
-        alias: '--recipient <recipient>',
-        description: 'The recipient to interact with',
-    },
-    logo: {
-        alias: '--logo <logo>',
-        description: 'The ANT logo',
-    },
-    module: {
-        alias: '--module <module>',
-        description: 'The module ID to use for spawning the ANT process',
-    },
-    token: {
-        alias: '-t, --token <type>',
-        description: 'Crypto token type for wallet or action',
-        default: 'arweave',
-    },
-    paidBy: {
-        alias: '--paid-by <paidBy...>',
-        description: 'Addresses to pay for the interaction',
-        type: 'array',
-    },
-    referrer: {
-        alias: '--referrer <referrer>',
-        description: 'The referrer for ArNS purchase tracking',
-    },
-    reassignAffiliatedNames: {
-        alias: '--reassign-affiliated-names',
-        description: 'Reassign all affiliated names to the new process',
-        type: 'boolean',
-    },
-};
-exports.walletOptions = [
-    exports.optionMap.walletFile,
-    exports.optionMap.token,
-    // optionMap.mnemonic,
-    exports.optionMap.privateKey,
-];
-exports.globalOptions = [
-    ...exports.walletOptions,
-    exports.optionMap.devnet,
-    exports.optionMap.testnet,
-    exports.optionMap.mainnet,
-    exports.optionMap.debug,
-    exports.optionMap.arioProcessId,
-    exports.optionMap.cuUrl,
-    exports.optionMap.hyperbeamUrl,
-];
-exports.writeActionOptions = [exports.optionMap.skipConfirmation, exports.optionMap.tags];
-exports.arnsPurchaseOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.name,
-    exports.optionMap.fundFrom,
-    exports.optionMap.paidBy,
-    exports.optionMap.paymentUrl,
-    exports.optionMap.referrer,
-];
-exports.epochOptions = [exports.optionMap.epochIndex, exports.optionMap.timestamp];
-exports.addressAndVaultIdOptions = [exports.optionMap.address, exports.optionMap.vaultId];
-exports.nameWriteOptions = [...exports.writeActionOptions, exports.optionMap.name];
-exports.paginationOptions = [
-    exports.optionMap.cursor,
-    exports.optionMap.limit,
-    exports.optionMap.sortBy,
-    exports.optionMap.sortOrder,
-    exports.optionMap.filters,
-];
-exports.paginationAddressOptions = [
-    exports.optionMap.address,
-    ...exports.paginationOptions,
-];
-exports.getVaultOptions = exports.addressAndVaultIdOptions;
-exports.tokenCostOptions = [
-    exports.optionMap.name,
-    exports.optionMap.intent,
-    exports.optionMap.type,
-    exports.optionMap.years,
-    exports.optionMap.quantity,
-    exports.optionMap.address,
-    exports.optionMap.fundFrom,
-    exports.optionMap.paymentUrl,
-];
-exports.transferOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.quantity,
-    exports.optionMap.target,
-];
-exports.vaultedTransferOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.quantity,
-    exports.optionMap.recipient,
-    exports.optionMap.lockLengthMs,
-    exports.optionMap.revokable,
-];
-exports.operatorStakeOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.operatorStake,
-];
-exports.redelegateStakeOptions = [...exports.transferOptions, exports.optionMap.source];
-exports.delegateStakeOptions = exports.transferOptions;
-exports.decreaseDelegateStakeOptions = [
-    ...exports.delegateStakeOptions,
-    exports.optionMap.instant,
-];
-exports.updateGatewaySettingsOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.autoStake,
-    exports.optionMap.allowDelegatedStaking,
-    exports.optionMap.allowedDelegates,
-    exports.optionMap.minDelegatedStake,
-    exports.optionMap.delegateRewardShareRatio,
-    exports.optionMap.label,
-    exports.optionMap.note,
-    exports.optionMap.properties,
-    exports.optionMap.observerAddress,
-    exports.optionMap.fqdn,
-    exports.optionMap.port,
-    exports.optionMap.protocol,
-    exports.optionMap.services,
-];
-exports.joinNetworkOptions = [
-    ...exports.updateGatewaySettingsOptions,
-    exports.optionMap.operatorStake,
-];
-exports.buyRecordOptions = [
-    ...exports.arnsPurchaseOptions,
-    exports.optionMap.quantity,
-    exports.optionMap.type,
-    exports.optionMap.years,
-    exports.optionMap.processId,
-];
-exports.antStateOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.target,
-    exports.optionMap.keywords,
-    exports.optionMap.ticker,
-    exports.optionMap.name,
-    exports.optionMap.description,
-    exports.optionMap.controllers,
-    exports.optionMap.ttlSeconds,
-    exports.optionMap.logo,
-    exports.optionMap.module,
-];
-exports.setAntBaseNameOptions = [
-    exports.optionMap.processId,
-    exports.optionMap.transactionId,
-    exports.optionMap.ttlSeconds,
-    exports.optionMap.owner,
-    exports.optionMap.displayName,
-    exports.optionMap.logo,
-    exports.optionMap.description,
-    exports.optionMap.keywords,
-    ...exports.writeActionOptions,
-];
-exports.setAntUndernameOptions = [
-    ...exports.setAntBaseNameOptions,
-    exports.optionMap.undername,
-];
-exports.upgradeAntOptions = [
-    exports.optionMap.processId,
-    exports.optionMap.names,
-    exports.optionMap.reassignAffiliatedNames,
-    ...exports.writeActionOptions,
-];
-exports.transferRecordOwnershipOptions = [
-    exports.optionMap.processId,
-    exports.optionMap.undername,
-    exports.optionMap.recipient,
-    ...exports.writeActionOptions,
-];

package/lib/cjs/cli/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });