@aptos-labs/js-pro
Version:
State management and library of utilities for Aptos applications.
137 lines • 10 kB
TypeScript
import { StoreApi } from "zustand/vanilla";
import { Aptos, AptosSettings, Network } from "@aptos-labs/ts-sdk";
import { GraphQLClient } from "graphql-request";
import { Sdk } from "./operations/index.js";
import { AccountInfo, NetworkInfo, SignerClient } from "./types/index.js";
import { getClients, fetchAccountCoins, fetchAptBalance, fetchBalance, fetchProcessorStatus, fetchAddressFromName, fetchNameFromAddress, fetchEstimatedGasPrice, fetchTransaction, fetchResources, fetchResourceType, fetchTokenData, fetchFungibleAssetMetadata, fetchAccountCollections, fetchViewModule, fetchLedgerInfo, fetchAccountTransactions, fetchAccountTokens, fetchUserTransactions, fetchAccountTotalTransactions } from "./queries/index.js";
import { buildTransaction, signAndSubmitTransaction, signTransaction, simulateTransaction, submitTransaction, waitForTransaction } from "./mutations/index.js";
type IndexerClientOptions = ConstructorParameters<typeof GraphQLClient>[1];
export type ClientConfigs = {
/**
* This will be included as `Authorization: Bearer <apiKey>` in all requests to Aptos
* APIs. For the Aptos client this means settings AptosConfig.clientConfig.API_KEY.
* For the indexer client, we provide a custom header.
*
* This argument takes precedence over the relevant argument in the configs for
* `aptos` and `indexerClient`.
*
* It is okay to accept a single argument here because it is standard to use the same
* API key for both APIs (node and indexer APIs).
*/
apiKey?: {
[network: string | Network]: string | undefined;
} | string;
/**
* Will override any Network settings if provided in this config.
*/
aptos?: {
config: AptosSettings;
};
indexerClient?: {
options: IndexerClientOptions;
};
/**
* A function that returns the current server time in milliseconds.
*
* @default Date.now
* @returns The current server time in milliseconds
*/
serverTime?: () => number;
};
export type AptosJSProClientParameters = {
account?: AccountInfo;
config?: ClientConfigs;
network: NetworkInfo;
signer?: SignerClient;
};
export type AptosJSProClientState = {
account?: AccountInfo;
config?: ClientConfigs;
network: NetworkInfo;
signer?: SignerClient;
};
export declare class AptosJSProClient {
#private;
constructor(params: AptosJSProClientParameters);
get state(): AptosJSProClientState;
get store(): Omit<StoreApi<AptosJSProClientState>, "subscribe"> & {
subscribe: {
(listener: (selectedState: AptosJSProClientState, previousSelectedState: AptosJSProClientState) => void): () => void;
<U>(selector: (state: AptosJSProClientState) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
equalityFn?: ((a: U, b: U) => boolean) | undefined;
fireImmediately?: boolean;
} | undefined): () => void;
};
};
get signer(): SignerClient | undefined;
get account(): AccountInfo | undefined;
get network(): NetworkInfo;
get aptos(): Aptos;
get indexer(): {
getAccountTokensTotal(variables: import("./operations/index.js").GetAccountTokensTotalQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetAccountTokensTotalQuery>;
getAccountTokenOwnerships(variables: import("./operations/index.js").GetAccountTokenOwnershipsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetAccountTokenOwnershipsQuery>;
getCurrentTokenData(variables: import("./operations/index.js").GetCurrentTokenDataQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetCurrentTokenDataQuery>;
getAccountCollections(variables: import("./operations/index.js").GetAccountCollectionsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetAccountCollectionsQuery>;
getTokenData(variables: import("./operations/index.js").GetTokenDataQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetTokenDataQuery>;
getActivitiesAggregate(variables: import("./operations/index.js").GetActivitiesAggregateQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetActivitiesAggregateQuery>;
getTokenActivities(variables: import("./operations/index.js").GetTokenActivitiesQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetTokenActivitiesQuery>;
getTokenAcquisitionActivity(variables: import("./operations/index.js").GetTokenAcquisitionActivityQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetTokenAcquisitionActivityQuery>;
getAccountTransactions(variables: import("./operations/index.js").GetAccountTransactionsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetAccountTransactionsQuery>;
getUserTransactions(variables: import("./operations/index.js").GetUserTransactionsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetUserTransactionsQuery>;
getAccountTotalTransactions(variables: import("./operations/index.js").GetAccountTotalTransactionsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetAccountTotalTransactionsQuery>;
getFungibleAssetMetadata(variables: import("./operations/index.js").GetFungibleAssetMetadataQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetFungibleAssetMetadataQuery>;
getFungibleAssetBalances(variables?: import("./operations/index.js").GetFungibleAssetBalancesQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetFungibleAssetBalancesQuery>;
getDelegatedStakingRoyalties(variables: import("./operations/index.js").GetDelegatedStakingRoyaltiesQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetDelegatedStakingRoyaltiesQuery>;
getDelegatedStaking(variables: import("./operations/index.js").GetDelegatedStakingQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetDelegatedStakingQuery>;
getDelegationPools(variables?: import("./operations/index.js").GetDelegationPoolsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetDelegationPoolsQuery>;
getNumberOfDelegators(variables?: import("./operations/index.js").GetNumberOfDelegatorsQueryVariables, requestHeaders?: HeadersInit | undefined, signal?: RequestInit["signal"]): Promise<import("./operations/index.js").GetNumberOfDelegatorsQuery>;
} | undefined;
getServerTime: () => number;
getServerDate: () => Date;
setAccount: (account: AccountInfo | undefined) => void;
setNetwork: (network: NetworkInfo) => void;
setSigner: (signer: SignerClient | undefined) => void;
setConfig: (config: ClientConfigs) => void;
onAccountChange: (callback: (account?: AccountInfo) => void) => () => void;
onNetworkChange: (callback: (network: NetworkInfo) => void) => () => void;
onSignerChange: (callback: (signer?: SignerClient) => void) => () => void;
onConfigChange: (callback: (config?: ClientConfigs) => void) => () => void;
onChange: (callback: (state: AptosJSProClientState) => void) => () => void;
createNetworkConfig: (network?: NetworkInfo) => AptosSettings;
/**
* To support V1 networks, we are case insensitive when matching the network name.
*
* @returns An Aptos instance
*/
createAptos: (clientConfig?: AptosSettings, network?: NetworkInfo) => Aptos;
createIndexer: (clientConfig?: AptosSettings, network?: NetworkInfo) => Sdk | undefined;
private refreshClients;
getClients: typeof getClients;
fetchAccountTransactions: typeof fetchAccountTransactions;
fetchAccountCollections: typeof fetchAccountCollections;
fetchAccountCoins: typeof fetchAccountCoins;
fetchAccountTokens: typeof fetchAccountTokens;
fetchTransaction: typeof fetchTransaction;
fetchResources: typeof fetchResources;
fetchResourceType: typeof fetchResourceType;
fetchProcessorStatus: typeof fetchProcessorStatus;
fetchTokenData: typeof fetchTokenData;
fetchFungibleAssetMetadata: typeof fetchFungibleAssetMetadata;
fetchLedgerInfo: typeof fetchLedgerInfo;
fetchAddressFromName: typeof fetchAddressFromName;
fetchNameFromAddress: typeof fetchNameFromAddress;
fetchAptBalance: typeof fetchAptBalance;
fetchBalance: typeof fetchBalance;
fetchEstimatedGasPrice: typeof fetchEstimatedGasPrice;
fetchViewModule: typeof fetchViewModule;
fetchUserTransactions: typeof fetchUserTransactions;
fetchAccountTotalTransactions: typeof fetchAccountTotalTransactions;
submitTransaction: typeof submitTransaction;
waitForTransaction: typeof waitForTransaction;
simulateTransaction: typeof simulateTransaction;
signTransaction: typeof signTransaction;
signAndSubmitTransaction: typeof signAndSubmitTransaction;
buildTransaction: typeof buildTransaction;
}
export {};
//# sourceMappingURL=client.d.ts.map