@ar.io/sdk
Version:
[](https://codecov.io/gh/ar-io/ar-io-sdk)
72 lines (71 loc) • 4.62 kB
TypeScript
/**
* 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 { AoArNSNameData, AoDelegation, AoGatewayDelegateWithAddress, AoGatewayVault, AoGetCostDetailsParams } from '../../types/io.js';
import { AddressAndNameCLIOptions, AddressAndVaultIdCLIOptions, AddressCLIOptions, CLIOptionsFromAoParams, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, NameCLIOptions, PaginationAddressCLIOptions, PaginationCLIOptions } from '../types.js';
export declare function getGateway(o: AddressCLIOptions): Promise<import("../../types/io.js").AoGateway>;
export declare function listGateways(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoGatewayWithAddress> | {
message: string;
}>;
export declare function listAllDelegatesCLICommand(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoAllDelegates> | {
message: string;
}>;
export declare function getGatewayDelegates(o: AddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoGatewayDelegateWithAddress> | {
message: string;
}>;
export declare function getDelegations(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoDelegation> | {
message: string;
}>;
export declare function getAllowedDelegates(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<string> | {
message: string;
}>;
export declare function getArNSRecord(o: NameCLIOptions): Promise<AoArNSNameData>;
export declare function listArNSRecords(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoArNSNameDataWithName> | {
message: string;
}>;
export declare function getArNSReservedName(o: NameCLIOptions): Promise<import("../../types/io.js").AoArNSReservedNameData>;
export declare function listArNSReservedNames(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoArNSReservedNameDataWithName> | {
message: string;
}>;
export declare function getArNSReturnedName(o: NameCLIOptions): Promise<import("../../types/io.js").AoReturnedName>;
export declare function listArNSReturnedNames(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoReturnedName> | {
message: string;
}>;
export declare function getEpoch(o: EpochCLIOptions): Promise<import("../../types/io.js").AoEpochData<import("../../types/io.js").AoEpochDistributionData>>;
export declare function getPrescribedObservers(o: EpochCLIOptions): Promise<import("../../types/io.js").AoWeightedObserver[]>;
export declare function getPrescribedNames(o: EpochCLIOptions): Promise<string[]>;
export declare function getTokenCost(o: GetTokenCostCLIOptions): Promise<{
mARIOTokenCost: number;
message: string;
}>;
export declare function getCostDetails(o: GlobalCLIOptions & CLIOptionsFromAoParams<AoGetCostDetailsParams>): Promise<{
message: string;
tokenCost: number;
discounts: import("../../types/io.js").CostDiscount[];
returnedNameDetails?: import("../../types/io.js").AoReturnedName & {
basePrice: number;
};
fundingPlan?: import("../../types/io.js").AoFundingPlan;
wincQty?: string;
}>;
export declare function getPrimaryName(o: AddressAndNameCLIOptions): Promise<import("../../types/common.js").AoPrimaryName>;
export declare function getGatewayVaults(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoGatewayVault> | {
message: string;
}>;
export declare function getAllGatewayVaults(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoAllGatewayVaults> | {
message: string;
}>;
export declare function getVault(o: AddressAndVaultIdCLIOptions): Promise<import("../../types/io.js").AoVaultData>;
export declare function resolveArNSName(o: NameCLIOptions): Promise<import("../../types/io.js").ArNSNameResolutionData>;