@ar.io/sdk/lib/types/cli/types.d.ts

[](https://codecov.io/gh/ar-io/ar-io-sdk)

/**
 * 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 { AoAddressParams, AoArNSNameParams, AoGetVaultParams, AoJoinNetworkParams, AoTokenCostParams, PaginationParams } from '../types/io.js';
export type SupportedCLITokenType = 'ethereum' | 'arweave';
export type WalletCLIOptions = {
    walletFile?: string;
    token?: SupportedCLITokenType;
    privateKey?: string;
};
export type GlobalCLIOptions = WalletCLIOptions & {
    devnet: boolean;
    testnet: boolean;
    mainnet: boolean;
    debug: boolean;
    arioProcessId?: string;
    cuUrl?: string;
    paymentUrl?: string;
};
export type WriteActionCLIOptions = GlobalCLIOptions & {
    tags?: string[];
    skipConfirmation?: boolean;
};
export type ProcessIdWriteActionCLIOptions = WriteActionCLIOptions & {
    processId?: string;
};
/**
 * A utility type to transform `number` properties in a type `T` to `string`
 * properties, while preserving arrays, objects, and other types.
 * Additionally, all properties are made optional.
 *
 * This type is intended to represent how `commander` parses CLI options,
 * where all values are strings, and nested objects are recursively processed.
 *
 * @example
 * ```ts
 * export type MyNewCommandOptions = CLIOptionsFromAoParams<MyNewAoMethodParams> & GlobalOptions;
 * ```
 */
export type CLIOptionsFromAoParams<T> = {
    [K in keyof T]?: T[K] extends number | undefined ? string | undefined : T[K] extends string | boolean | symbol ? string : T[K] extends ReadonlyArray<infer U> ? ReadonlyArray<U> : T[K] extends object ? CLIOptionsFromAoParams<T[K]> : T[K];
};
export type CLIReadOptionsFromAoParams<T> = CLIOptionsFromAoParams<T> & GlobalCLIOptions;
export type CLIWriteOptionsFromAoParams<T> = WriteActionCLIOptions & CLIOptionsFromAoParams<T>;
export type CLIWriteOptionsFromAoAntParams<T> = CLIWriteOptionsFromAoParams<T & {
    processId: string;
}>;
export type PaginationCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<PaginationParams>;
export type AddressCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoAddressParams>;
export type ProcessIdCLIOptions = GlobalCLIOptions & {
    processId?: string;
};
export type InitiatorCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<{
    initiator: string;
}>;
export type AddressAndNameCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<{
    address: string;
    name: string;
}>;
export type EpochCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<{
    epochIndex: number;
    timestamp: number;
}>;
export type GetTokenCostCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoTokenCostParams>;
export type PaginationAddressCLIOptions = AddressCLIOptions & PaginationCLIOptions;
export type NameCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoArNSNameParams>;
export type NameWriteCLIOptions = WriteActionCLIOptions & NameCLIOptions;
export type AddressAndVaultIdCLIOptions = CLIOptionsFromAoParams<AoGetVaultParams> & GlobalCLIOptions;
export type AddressAndVaultIdCLIWriteOptions = WriteActionCLIOptions & AddressAndVaultIdCLIOptions;
export type TransferCLIOptions = WriteActionCLIOptions & {
    quantity?: string;
    target?: string;
};
export type JoinNetworkCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoJoinNetworkParams>;
export type UpdateGatewaySettingsCLIOptions = Omit<JoinNetworkCLIOptions, 'operatorStake'>;
export type DelegateStakeCLIOptions = TransferCLIOptions;
export type RedelegateStakeCLIOptions = TransferCLIOptions & {
    source?: string;
    vaultId?: string;
};
export type OperatorStakeCLIOptions = WriteActionCLIOptions & {
    operatorStake?: string;
};
export type DecreaseDelegateStakeCLIOptions = DelegateStakeCLIOptions & {
    instant: boolean;
};
export type ANTStateCLIOptions = WriteActionCLIOptions & {
    target?: string;
    keywords?: string[];
    ticker?: string;
    name?: string;
    description?: string;
    controllers?: string[];
    ttlSeconds?: string;
    logo?: string;
};
export type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
    [key: string]: JsonSerializable;
};