PHP WebShell
Текущая директория: /usr/lib/node_modules/bitgo/node_modules/@iota/iota-sdk/dist/esm/client
Просмотр файла: client.d.ts
import type { Signer } from '../cryptography/index.js';
import type { Transaction } from '../transactions/index.js';
import type { IotaTransport } from './http-transport.js';
import type { AddressMetrics, AllEpochsAddressMetrics, Checkpoint, CheckpointPage, CoinBalance, CoinMetadata, CoinSupply, CommitteeInfo, DelegatedStake, DevInspectResults, DevInspectTransactionBlockParams, DryRunTransactionBlockParams, DryRunTransactionBlockResponse, DynamicFieldPage, EpochInfo, EpochMetricsPage, EpochPage, ExecuteTransactionBlockParams, GetAllBalancesParams, GetAllCoinsParams, GetBalanceParams, GetCheckpointParams, GetCheckpointsParams, GetCoinMetadataParams, GetCoinsParams, GetCommitteeInfoParams, GetDynamicFieldObjectParams, GetDynamicFieldsParams, GetMoveFunctionArgTypesParams, GetNormalizedMoveFunctionParams, GetNormalizedMoveModuleParams, GetNormalizedMoveModulesByPackageParams, GetNormalizedMoveStructParams, GetObjectParams, GetOwnedObjectsParams, GetProtocolConfigParams, GetStakesByIdsParams, GetStakesParams, GetTotalSupplyParams, GetTransactionBlockParams, MoveCallMetrics, MultiGetObjectsParams, MultiGetTransactionBlocksParams, NetworkMetrics, ObjectRead, Order, PaginatedCoins, PaginatedEvents, PaginatedObjectsResponse, PaginatedTransactionResponse, ProtocolConfig, QueryEventsParams, QueryTransactionBlocksParams, SubscribeEventParams, SubscribeTransactionParams, IotaEvent, IotaMoveFunctionArgType, IotaMoveNormalizedFunction, IotaMoveNormalizedModule, IotaMoveNormalizedModules, IotaMoveNormalizedStruct, IotaObjectResponse, IotaSystemStateSummary, IotaTransactionBlockResponse, TransactionEffects, TryGetPastObjectParams, Unsubscribe, ValidatorsApy, GetTimelockedStakesParams, DelegatedTimelockedStake, GetTimelockedStakesByIdsParams, IotaSystemStateSummaryV1, LatestIotaSystemStateSummary, ParticipationMetrics, IotaCirculatingSupply, GetDynamicFieldObjectV2Params, IotaNamesLookupParams, IotaNameRecord, IotaNamesReverseLookupParams, IotaNamesFindAllRegistrationNFTsParams } from './types/index.js';
export interface PaginationArguments<Cursor> {
/** Optional paging cursor */
cursor?: Cursor;
/** Maximum item returned per page */
limit?: number | null;
}
export interface OrderArguments {
order?: Order | null;
}
/**
* Configuration options for the IotaClient
* You must provide either a `url` or a `transport`
*/
export type IotaClientOptions = NetworkOrTransport;
type NetworkOrTransport = {
url: string;
transport?: never;
} | {
transport: IotaTransport;
url?: never;
};
export declare function isIotaClient(client: unknown): client is IotaClient;
export declare class IotaClient {
protected transport: IotaTransport;
/**
* Establish a connection to an IOTA RPC endpoint
*
* @param options configuration options for the API Client
*/
constructor(options: IotaClientOptions);
getRpcApiVersion(): Promise<string | undefined>;
/**
* Get all Coin<`coin_type`> objects owned by an address.
*/
getCoins(input: GetCoinsParams): Promise<PaginatedCoins>;
/**
* Get all Coin objects owned by an address.
*/
getAllCoins(input: GetAllCoinsParams): Promise<PaginatedCoins>;
/**
* Get the total coin balance for one coin type, owned by the address owner.
*/
getBalance(input: GetBalanceParams): Promise<CoinBalance>;
/**
* Get the total coin balance for all coin types, owned by the address owner.
*/
getAllBalances(input: GetAllBalancesParams): Promise<CoinBalance[]>;
/**
* Fetch CoinMetadata for a given coin type
*/
getCoinMetadata(input: GetCoinMetadataParams): Promise<CoinMetadata | null>;
/**
* Fetch total supply for a coin
*/
getTotalSupply(input: GetTotalSupplyParams): Promise<CoinSupply>;
/**
* Fetch circulating supply for a coin
*/
getCirculatingSupply(): Promise<IotaCirculatingSupply>;
/**
* Invoke any RPC method
* @param method the method to be invoked
* @param args the arguments to be passed to the RPC request
*/
call<T = unknown>(method: string, params: unknown[]): Promise<T>;
/**
* Get Move function argument types like read, write and full access
*/
getMoveFunctionArgTypes(input: GetMoveFunctionArgTypesParams): Promise<IotaMoveFunctionArgType[]>;
/**
* Get a map from module name to
* structured representations of Move modules
*/
getNormalizedMoveModulesByPackage(input: GetNormalizedMoveModulesByPackageParams): Promise<IotaMoveNormalizedModules>;
/**
* Get a structured representation of Move module
*/
getNormalizedMoveModule(input: GetNormalizedMoveModuleParams): Promise<IotaMoveNormalizedModule>;
/**
* Get a structured representation of Move function
*/
getNormalizedMoveFunction(input: GetNormalizedMoveFunctionParams): Promise<IotaMoveNormalizedFunction>;
/**
* Get a structured representation of Move struct
*/
getNormalizedMoveStruct(input: GetNormalizedMoveStructParams): Promise<IotaMoveNormalizedStruct>;
/**
* Get all objects owned by an address
*/
getOwnedObjects(input: GetOwnedObjectsParams): Promise<PaginatedObjectsResponse>;
/**
* Get details about an object
*/
getObject(input: GetObjectParams): Promise<IotaObjectResponse>;
tryGetPastObject(input: TryGetPastObjectParams): Promise<ObjectRead>;
/**
* Batch get details about a list of objects. If any of the object ids are duplicates the call will fail
*/
multiGetObjects(input: MultiGetObjectsParams): Promise<IotaObjectResponse[]>;
/**
* Get transaction blocks for a given query criteria
*/
queryTransactionBlocks(input: QueryTransactionBlocksParams): Promise<PaginatedTransactionResponse>;
getTransactionBlock(input: GetTransactionBlockParams): Promise<IotaTransactionBlockResponse>;
multiGetTransactionBlocks(input: MultiGetTransactionBlocksParams): Promise<IotaTransactionBlockResponse[]>;
executeTransactionBlock({ transactionBlock, signature, options, }: ExecuteTransactionBlockParams): Promise<IotaTransactionBlockResponse>;
signAndExecuteTransaction({ transaction, signer, ...input }: {
transaction: Uint8Array | Transaction;
signer: Signer;
} & Omit<ExecuteTransactionBlockParams, 'transactionBlock' | 'signature'>): Promise<IotaTransactionBlockResponse>;
/**
* Get total number of transactions
*/
getTotalTransactionBlocks(): Promise<bigint>;
/**
* Getting the reference gas price for the network
*/
getReferenceGasPrice(): Promise<bigint>;
/**
* Return the delegated stakes for an address
*/
getStakes(input: GetStakesParams): Promise<DelegatedStake[]>;
/**
* Return the timelocked delegated stakes for an address
*/
getTimelockedStakes(input: GetTimelockedStakesParams): Promise<DelegatedTimelockedStake[]>;
/**
* Return the delegated stakes queried by id.
*/
getStakesByIds(input: GetStakesByIdsParams): Promise<DelegatedStake[]>;
/**
* Return the timelocked delegated stakes queried by id.
*/
getTimelockedStakesByIds(input: GetTimelockedStakesByIdsParams): Promise<DelegatedTimelockedStake[]>;
/**
* Return the latest IOTA system state object on networks supporting protocol version `< 5`.
* These are networks with node software release version `< 0.11`.
* @deprecated Use `getLatestIotaSystemState` instead.
*/
getLatestIotaSystemStateV1(): Promise<IotaSystemStateSummaryV1>;
/**
* Return the latest IOTA system state object on networks supporting protocol version `>= 5`.
* These are networks with node software release version `>= 0.11`.
*
* You probably want to use `getLatestIotaSystemState` instead to prevent issues with future deprecations
* or in case the node does not support protocol version `>= 5`.
*/
getLatestIotaSystemStateV2(): Promise<IotaSystemStateSummary>;
/**
* Return the latest supported IOTA system state object.
*
* This returns a backwards-compatible system state object that dynamically uses the V1 or V2
* depending on the protocol version supported by the node. This method will continue to be supported
* as more protocol versions are released with changes to the system state.
*
* This is quite useful in case your app does not know in advance what node is it going to be using,
* this way you as developer dont need to handle each possible system state variant,
* this is already handled by this method.
*/
getLatestIotaSystemState(): Promise<LatestIotaSystemStateSummary>;
/**
* Get events for a given query criteria
*/
queryEvents(input: QueryEventsParams): Promise<PaginatedEvents>;
/**
* Subscribe to get notifications whenever an event matching the filter occurs
*
* @deprecated
*/
subscribeEvent(input: SubscribeEventParams & {
/** function to run when we receive a notification of a new event matching the filter */
onMessage: (event: IotaEvent) => void;
}): Promise<Unsubscribe>;
/**
* @deprecated
*/
subscribeTransaction(input: SubscribeTransactionParams & {
/** function to run when we receive a notification of a new event matching the filter */
onMessage: (event: TransactionEffects) => void;
}): Promise<Unsubscribe>;
/**
* Runs the transaction block in dev-inspect mode. Which allows for nearly any
* transaction (or Move call) with any arguments. Detailed results are
* provided, including both the transaction effects and any return values.
*/
devInspectTransactionBlock(input: DevInspectTransactionBlockParams): Promise<DevInspectResults>;
/**
* Dry run a transaction block and return the result.
*/
dryRunTransactionBlock(input: DryRunTransactionBlockParams): Promise<DryRunTransactionBlockResponse>;
/**
* Return the list of dynamic field objects owned by an object
*/
getDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage>;
/**
* Return the dynamic field object information for a specified object
*/
getDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<IotaObjectResponse>;
/**
* Return the dynamic field object information for a specified object with content options.
*/
getDynamicFieldObjectV2(input: GetDynamicFieldObjectV2Params): Promise<IotaObjectResponse>;
/**
* Get the sequence number of the latest checkpoint that has been executed
*/
getLatestCheckpointSequenceNumber(): Promise<string>;
/**
* Returns information about a given checkpoint
*/
getCheckpoint(input: GetCheckpointParams): Promise<Checkpoint>;
/**
* Returns historical checkpoints paginated
*/
getCheckpoints(input: PaginationArguments<CheckpointPage['nextCursor']> & GetCheckpointsParams): Promise<CheckpointPage>;
/**
* Return the committee information for the asked epoch
*/
getCommitteeInfo(input?: GetCommitteeInfoParams): Promise<CommitteeInfo>;
getNetworkMetrics(): Promise<NetworkMetrics>;
getAddressMetrics(): Promise<AddressMetrics>;
getEpochMetrics(input?: {
descendingOrder?: boolean;
} & PaginationArguments<EpochMetricsPage['nextCursor']>): Promise<EpochMetricsPage>;
getAllEpochAddressMetrics(input?: {
descendingOrder?: boolean;
}): Promise<AllEpochsAddressMetrics>;
getCheckpointAddressMetrics(input?: {
checkpoint: string;
}): Promise<AddressMetrics>;
/**
* Return the committee information for the asked epoch
*/
getEpochs(input?: {
descendingOrder?: boolean;
} & PaginationArguments<EpochPage['nextCursor']>): Promise<EpochPage>;
/**
* Returns list of top move calls by usage
*/
getMoveCallMetrics(): Promise<MoveCallMetrics>;
/**
* Return the committee information for the asked epoch
*/
getCurrentEpoch(): Promise<EpochInfo>;
getTotalTransactions(): Promise<string>;
/**
* Return the Validators APYs
*/
getValidatorsApy(): Promise<ValidatorsApy>;
getChainIdentifier(): Promise<string>;
getProtocolConfig(input?: GetProtocolConfigParams): Promise<ProtocolConfig>;
/**
* Returns the participation metrics (total unique addresses with delegated stake in the current epoch).
*/
getParticipationMetrics(): Promise<ParticipationMetrics>;
/**
* Wait for a transaction block result to be available over the API.
* This can be used in conjunction with `executeTransactionBlock` to wait for the transaction to
* be available via the API.
* This currently polls the `getTransactionBlock` API to check for the transaction.
*/
waitForTransaction({ signal, timeout, pollInterval, ...input }: {
/** An optional abort signal that can be used to cancel */
signal?: AbortSignal;
/** The amount of time to wait for a transaction block. Defaults to one minute. */
timeout?: number;
/** The amount of time to wait between checks for the transaction block. Defaults to 2 seconds. */
pollInterval?: number;
} & Parameters<IotaClient['getTransactionBlock']>[0]): Promise<IotaTransactionBlockResponse>;
/**
* Return the resolved record for the given name.
*/
iotaNamesLookup(input: IotaNamesLookupParams): Promise<IotaNameRecord | undefined>;
/**
* Return the resolved name for the given address.
*/
iotaNamesReverseLookup(input: IotaNamesReverseLookupParams): Promise<string | undefined>;
/**
* Find all registration NFTs for the given address.
*/
iotaNamesFindAllRegistrationNFTs(input: IotaNamesFindAllRegistrationNFTsParams): Promise<PaginatedObjectsResponse>;
}
export {};
Выполнить команду
Для локальной разработки. Не используйте в интернете!