PHP WebShell
Текущая директория: /opt/BitGoJS/node_modules/@aptos-labs/ts-sdk/dist/esm/internal
Просмотр файла: account.d.mts
import { AptosConfig } from '../api/aptosConfig.mjs';
import { GetAccountOwnedTokensQueryResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountCoinsDataResponse, GetObjectDataQueryResponse } from '../types/indexer.mjs';
import { AccountData, PaginationArgs, LedgerVersionArg, MoveModuleBytecode, TransactionResponse, MoveResource, MoveStructId, TokenStandardArg, OrderByArg, WhereArg } from '../types/types.mjs';
import { AccountAddressInput, AccountAddress } from '../core/accountAddress.mjs';
import { A as AuthenticationKey } from '../publicKey-BVXX1nVl.mjs';
import { PrivateKey } from '../core/crypto/privateKey.mjs';
import { A as Account } from '../Ed25519Account-B3xHXAQe.mjs';
import { CurrentFungibleAssetBalancesBoolExp } from '../types/generated/types.mjs';
import '../utils/apiEndpoints.mjs';
import '../utils/const.mjs';
import '../types/generated/operations.mjs';
import '../bcs/serializer.mjs';
import '../core/hex.mjs';
import '../core/common.mjs';
import '../bcs/deserializer.mjs';
import '../transactions/instances/transactionArgument.mjs';
import '../core/crypto/signature.mjs';
import '../transactions/authenticator/account.mjs';
import '../core/crypto/ed25519.mjs';
import '../core/crypto/multiEd25519.mjs';
import '../core/crypto/multiKey.mjs';
import '../core/crypto/singleKey.mjs';
import '../transactions/types.mjs';
import '../bcs/serializable/moveStructs.mjs';
import '../bcs/serializable/movePrimitives.mjs';
import '../bcs/serializable/fixedBytes.mjs';
import '../transactions/instances/rawTransaction.mjs';
import '../transactions/instances/chainId.mjs';
import '../transactions/instances/transactionPayload.mjs';
import '../transactions/instances/identifier.mjs';
import '../transactions/instances/moduleId.mjs';
import '../transactions/typeTag/index.mjs';
import '../transactions/instances/simpleTransaction.mjs';
import '../transactions/instances/multiAgentTransaction.mjs';
/**
* This file contains the underlying implementations for exposed API surface in
* the {@link api/account}. By moving the methods out into a separate file,
* other namespaces and processes can access these methods without depending on the entire
* account namespace and without having a dependency cycle error.
*/
/**
* Retrieves account information for a specified account address.
*
* @param args - The arguments for retrieving account information.
* @param args.aptosConfig - The configuration object for Aptos.
* @param args.accountAddress - The address of the account to retrieve information for.
*/
declare function getInfo(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
}): Promise<AccountData>;
/**
* Retrieves the modules associated with a specified account address.
*
* @param args - The arguments for retrieving modules.
* @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
* @param args.accountAddress - The address of the account whose modules are to be retrieved.
* @param args.options - Optional parameters for pagination and ledger version.
* @param args.options.limit - The maximum number of modules to retrieve (default is 1000).
* @param args.options.offset - The starting point for pagination.
* @param args.options.ledgerVersion - The specific ledger version to query.
*/
declare function getModules(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: PaginationArgs & LedgerVersionArg;
}): Promise<MoveModuleBytecode[]>;
/**
* Queries for a move module given an account address and module name.
* This function can help you retrieve the module's ABI and other relevant information.
*
* @param args - The arguments for retrieving the module.
* @param args.aptosConfig - The configuration for the Aptos client.
* @param args.accountAddress - The account address in hex-encoded 32 byte format.
* @param args.moduleName - The name of the module to retrieve.
* @param args.options - Optional parameters for the request.
* @param args.options.ledgerVersion - Specifies the ledger version of transactions. By default, the latest version will be used.
* @returns The move module.
*/
declare function getModule(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
moduleName: string;
options?: LedgerVersionArg;
}): Promise<MoveModuleBytecode>;
/**
* Retrieves a list of transactions associated with a specific account address.
* This function allows you to paginate through the transactions for better performance and usability.
*
* @param args - The arguments for retrieving transactions.
* @param args.aptosConfig - The configuration settings for Aptos.
* @param args.accountAddress - The account address for which to retrieve transactions.
* @param args.options - Optional pagination parameters.
* @param args.options.offset - The starting point for pagination.
* @param args.options.limit - The maximum number of transactions to retrieve.
*/
declare function getTransactions(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: PaginationArgs;
}): Promise<TransactionResponse[]>;
/**
* Retrieves a list of resources associated with a specific account address.
*
* @param args - The arguments for retrieving resources.
* @param args.aptosConfig - The configuration settings for Aptos.
* @param args.accountAddress - The address of the account to fetch resources for.
* @param args.options - Optional pagination and ledger version parameters.
* @param args.options.offset - The starting point for pagination.
* @param args.options.limit - The maximum number of resources to retrieve (default is 999).
* @param args.options.ledgerVersion - The specific ledger version to query.
*/
declare function getResources(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: PaginationArgs & LedgerVersionArg;
}): Promise<MoveResource[]>;
/**
* Retrieves a specific resource of a given type for the specified account address.
*
* @param args - The arguments for retrieving the resource.
* @param args.aptosConfig - The configuration settings for Aptos.
* @param args.accountAddress - The address of the account from which to retrieve the resource.
* @param args.resourceType - The type of the resource to retrieve, specified as a MoveStructId.
* @param args.options - Optional parameters for specifying the ledger version.
*/
declare function getResource<T extends {}>(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
resourceType: MoveStructId;
options?: LedgerVersionArg;
}): Promise<T>;
/**
* Retrieves the original account address associated with a given authentication key, which is useful for handling key rotations.
*
* @param args - The arguments for the lookup.
* @param args.aptosConfig - The configuration for the Aptos client.
* @param args.authenticationKey - The authentication key for which to look up the original address.
* @param args.options - Optional parameters for specifying the ledger version.
* @returns The original account address or the provided authentication key address if not found.
* @throws Throws an error if the lookup fails for reasons other than the address not being found.
*/
declare function lookupOriginalAccountAddress(args: {
aptosConfig: AptosConfig;
authenticationKey: AccountAddressInput;
options?: LedgerVersionArg;
}): Promise<AccountAddress>;
/**
* Retrieves the count of tokens owned by a specific account address.
*
* @param args - The arguments for retrieving the account tokens count.
* @param args.aptosConfig - The configuration settings for the Aptos network.
* @param args.accountAddress - The address of the account for which to count the tokens.
* @returns The count of tokens owned by the specified account.
*/
declare function getAccountTokensCount(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
}): Promise<number>;
/**
* Retrieves the tokens owned by a specified account address.
*
* @param args - The arguments for retrieving the account's tokens.
* @param args.aptosConfig - The configuration for the Aptos client.
* @param args.accountAddress - The address of the account whose tokens are being queried.
* @param args.options - Optional parameters for filtering and pagination.
* @param args.options.tokenStandard - The specific token standard to filter the results.
* @param args.options.offset - The number of records to skip before starting to collect the result set.
* @param args.options.limit - The maximum number of records to return.
* @param args.options.orderBy - The criteria for ordering the results.
* @returns A promise that resolves to the current token ownerships of the specified account.
*/
declare function getAccountOwnedTokens(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensQueryResponse[0]>;
}): Promise<GetAccountOwnedTokensQueryResponse>;
/**
* Retrieves the tokens owned by a specific account from a particular collection address.
*
* @param args - The parameters required to fetch the owned tokens.
* @param args.aptosConfig - The Aptos configuration object.
* @param args.accountAddress - The address of the account whose tokens are being queried.
* @param args.collectionAddress - The address of the collection from which tokens are being retrieved.
* @param args.options - Optional parameters for filtering and pagination, including token standard, pagination arguments, and
* order by options.
*/
declare function getAccountOwnedTokensFromCollectionAddress(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
collectionAddress: AccountAddressInput;
options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensFromCollectionResponse[0]>;
}): Promise<GetAccountOwnedTokensFromCollectionResponse>;
/**
* Retrieves the collections owned by a specified account along with the tokens in those collections.
*
* @param args - The arguments for the function.
* @param args.aptosConfig - The configuration for the Aptos client.
* @param args.accountAddress - The address of the account whose collections are being queried.
* @param args.options - Optional parameters for filtering and pagination.
* @param args.options.tokenStandard - An optional token standard to filter the collections.
* @param args.options.offset - An optional offset for pagination.
* @param args.options.limit - An optional limit for the number of results returned.
* @param args.options.orderBy - An optional parameter to specify the order of the results.
*/
declare function getAccountCollectionsWithOwnedTokens(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountCollectionsWithOwnedTokenResponse[0]>;
}): Promise<GetAccountCollectionsWithOwnedTokenResponse>;
/**
* Retrieves the count of transactions associated with a specified account.
*
* @param args - The arguments for the function.
* @param args.aptosConfig - The configuration settings for Aptos.
* @param args.accountAddress - The address of the account for which to retrieve the transaction count.
* @returns The number of transactions associated with the specified account.
*/
declare function getAccountTransactionsCount(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
}): Promise<number>;
/**
* Retrieves the amount of a specific coin held by an account.
*
* @param args - The parameters for the request.
* @param args.aptosConfig - The Aptos configuration object.
* @param args.accountAddress - The address of the account to query.
* @param args.coinType - Optional; the type of coin to check the amount for.
* @param args.faMetadataAddress - Optional; the address of the fungible asset metadata.
* @returns The amount of the specified coin held by the account, or 0 if none is found.
* @throws Error if neither coinType nor faMetadataAddress is provided.
*/
declare function getAccountCoinAmount(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
coinType?: MoveStructId;
faMetadataAddress?: AccountAddressInput;
}): Promise<number>;
/**
* Retrieves the current fungible asset balances for a specified account.
*
* @param args - The arguments for retrieving account coins data.
* @param args.aptosConfig - The configuration for connecting to the Aptos network.
* @param args.accountAddress - The address of the account for which to retrieve coin data.
* @param args.options - Optional parameters for pagination and filtering the results.
* @param args.options.offset - The number of items to skip before starting to collect the result set.
* @param args.options.limit - The maximum number of items to return.
* @param args.options.orderBy - The criteria for ordering the results.
* @param args.options.where - Conditions to filter the results based on the current fungible asset balances.
*/
declare function getAccountCoinsData(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: PaginationArgs & OrderByArg<GetAccountCoinsDataResponse[0]> & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
}): Promise<GetAccountCoinsDataResponse>;
/**
* Retrieves the count of fungible asset coins held by a specified account.
*
* @param args - The arguments for the function.
* @param args.aptosConfig - The configuration settings for the Aptos network.
* @param args.accountAddress - The address of the account for which to retrieve the coin count.
* @throws Error if the count of account coins cannot be retrieved.
*/
declare function getAccountCoinsCount(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
}): Promise<number>;
/**
* Retrieves the objects owned by a specified account.
*
* @param args - The parameters for the request.
* @param args.aptosConfig - The configuration for the Aptos client.
* @param args.accountAddress - The address of the account whose owned objects are to be retrieved.
* @param args.options - Optional parameters for pagination and ordering of the results.
* @param args.options.offset - The number of items to skip before starting to collect the result set.
* @param args.options.limit - The maximum number of items to return.
* @param args.options.orderBy - The criteria to order the results by.
* @returns A promise that resolves to the current objects owned by the specified account.
*/
declare function getAccountOwnedObjects(args: {
aptosConfig: AptosConfig;
accountAddress: AccountAddressInput;
options?: PaginationArgs & OrderByArg<GetObjectDataQueryResponse[0]>;
}): Promise<GetObjectDataQueryResponse>;
/**
* Derives an account from the provided private key and Aptos configuration.
* This function helps in obtaining the account details associated with a given private key,
* considering both unified and legacy authentication schemes.
*
* NOTE: There is a potential issue once the unified single signer scheme is adopted by the community.
* Because one could create two accounts with the same private key with this new authenticator type,
* we’ll need to determine the order in which we look up the accounts: first unified scheme and then legacy scheme,
* or first legacy scheme and then unified scheme.
*
* @param args - The arguments for deriving the account.
* @param args.aptosConfig - The Aptos configuration used for account lookup.
* @param args.privateKey - The private key used to derive the account.
* @throws Error if the account cannot be derived from the private key.
*/
declare function deriveAccountFromPrivateKey(args: {
aptosConfig: AptosConfig;
privateKey: PrivateKey;
}): Promise<Account>;
/**
* Checks if an account exists by verifying its information against the Aptos blockchain.
*
* @param args - The arguments for the function.
* @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
* @param args.authKey - The authentication key used to derive the account address.
* @returns A promise that resolves to a boolean indicating whether the account exists.
*
* @throws Throws an Error if there is an issue while looking for account information.
*/
declare function isAccountExist(args: {
aptosConfig: AptosConfig;
authKey: AuthenticationKey;
}): Promise<boolean>;
export { deriveAccountFromPrivateKey, getAccountCoinAmount, getAccountCoinsCount, getAccountCoinsData, getAccountCollectionsWithOwnedTokens, getAccountOwnedObjects, getAccountOwnedTokens, getAccountOwnedTokensFromCollectionAddress, getAccountTokensCount, getAccountTransactionsCount, getInfo, getModule, getModules, getResource, getResources, getTransactions, isAccountExist, lookupOriginalAccountAddress };
Выполнить команду
Для локальной разработки. Не используйте в интернете!