PHP WebShell
Текущая директория: /opt/BitGoJS/node_modules/@aptos-labs/ts-sdk/dist/esm/api
Просмотр файла: fungibleAsset.d.mts
import { GetFungibleAssetMetadataResponse, GetFungibleAssetActivitiesResponse, GetCurrentFungibleAssetBalancesResponse } from '../types/indexer.mjs';
import { AnyNumber, PaginationArgs, WhereArg } from '../types/types.mjs';
import { FungibleAssetMetadataBoolExp, FungibleAssetActivitiesBoolExp, CurrentFungibleAssetBalancesBoolExp } from '../types/generated/types.mjs';
import { AptosConfig } from './aptosConfig.mjs';
import { AccountAddressInput } from '../core/accountAddress.mjs';
import { A as Account } from '../Ed25519Account-B3xHXAQe.mjs';
import { InputGenerateTransactionOptions } from '../transactions/types.mjs';
import { SimpleTransaction } from '../transactions/instances/simpleTransaction.mjs';
import '../types/generated/operations.mjs';
import '../utils/apiEndpoints.mjs';
import '../utils/const.mjs';
import '../bcs/serializer.mjs';
import '../core/hex.mjs';
import '../core/common.mjs';
import '../bcs/deserializer.mjs';
import '../transactions/instances/transactionArgument.mjs';
import '../transactions/authenticator/account.mjs';
import '../core/crypto/ed25519.mjs';
import '../publicKey-BVXX1nVl.mjs';
import '../core/crypto/signature.mjs';
import '../core/crypto/privateKey.mjs';
import '../core/crypto/multiEd25519.mjs';
import '../core/crypto/multiKey.mjs';
import '../core/crypto/singleKey.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/multiAgentTransaction.mjs';
/**
* A class for querying and managing fungible asset-related operations on the Aptos blockchain.
*/
declare class FungibleAsset {
readonly config: AptosConfig;
/**
* Initializes a new instance of the Aptos class with the provided configuration.
* This allows you to interact with the Aptos blockchain using the specified network settings.
*
* @param config - The configuration settings for connecting to the Aptos network.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* async function runExample() {
* // Create a configuration for the Aptos client
* const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed
*
* // Initialize the Aptos client with the configuration
* const aptos = new Aptos(config);
*
* console.log("Aptos client initialized:", aptos);
* }
* runExample().catch(console.error);
* ```
*/
constructor(config: AptosConfig);
/**
* Queries all fungible asset metadata.
*
* @param args Optional parameters for the query.
* @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
* @param args.options Optional configuration for pagination and filtering.
*
* @returns A list of fungible asset metadata.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Fetching fungible asset metadata
* const fungibleAssets = await aptos.getFungibleAssetMetadata();
* console.log(fungibleAssets);
* }
* runExample().catch(console.error);
* ```
*/
getFungibleAssetMetadata(args?: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;
}): Promise<GetFungibleAssetMetadataResponse>;
/**
* Queries the fungible asset metadata for a specific asset type.
* This function helps retrieve detailed information about a fungible asset based on its type.
*
* @param args - The parameters for the query.
* @param args.assetType - The asset type of the fungible asset, e.g., "0x1::aptos_coin::AptosCoin" for Aptos Coin.
* @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
*
* @returns A fungible asset metadata item.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Retrieve fungible asset metadata by asset type
* const fungibleAsset = await aptos.getFungibleAssetMetadataByAssetType({
* assetType: "0x1::aptos_coin::AptosCoin" // replace with your asset type
* });
*
* console.log(fungibleAsset);
* }
* runExample().catch(console.error);
* ```
*/
getFungibleAssetMetadataByAssetType(args: {
assetType: string;
minimumLedgerVersion?: AnyNumber;
}): Promise<GetFungibleAssetMetadataResponse[0]>;
/**
* Retrieves fungible asset metadata based on the creator address.
*
* This function allows you to query metadata for a specific fungible asset created by a given address.
*
* @param args - The parameters for the query.
* @param args.creatorAddress - The creator address of the fungible asset.
* @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
*
* @returns A fungible asset metadata item.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Retrieve fungible asset metadata by creator address
* const fungibleAsset = await aptos.getFungibleAssetMetadataByCreatorAddress({
* creatorAddress: "0x123", // replace with a real creator address
* });
*
* console.log(fungibleAsset);
* }
* runExample().catch(console.error);
* ```
*/
getFungibleAssetMetadataByCreatorAddress(args: {
creatorAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}): Promise<GetFungibleAssetMetadataResponse>;
/**
* Queries all fungible asset activities and returns a list of their metadata.
*
* @param args Optional parameters for the query.
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.
* @param args.options Optional configuration for pagination and filtering.
* @returns A list of fungible asset metadata.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Fetching fungible asset activities
* const fungibleAssetActivities = await aptos.getFungibleAssetActivities();
* console.log(fungibleAssetActivities);
* }
* runExample().catch(console.error);
* ```
*/
getFungibleAssetActivities(args?: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;
}): Promise<GetFungibleAssetActivitiesResponse>;
/**
* Queries all fungible asset balances.
*
* @param args Optional parameters for the query.
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.
* @param args.options Optional configuration for pagination and filtering.
*
* @returns A list of fungible asset metadata.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Fetching current fungible asset balances
* const fungibleAssetBalances = await aptos.getCurrentFungibleAssetBalances();
*
* console.log(fungibleAssetBalances);
* }
* runExample().catch(console.error);
* ```
*/
getCurrentFungibleAssetBalances(args?: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
}): Promise<GetCurrentFungibleAssetBalancesResponse>;
/**
* Transfer a specified amount of fungible asset from the sender's primary store to the recipient's primary store.
* This method allows you to transfer any fungible asset, including fungible tokens.
*
* @param args - The arguments for the transfer operation.
* @param args.sender - The sender account.
* @param args.fungibleAssetMetadataAddress - The fungible asset account address. For example, if you’re transferring USDT,
* this would be the USDT address.
* @param args.recipient - The recipient account address.
* @param args.amount - The number of assets to transfer.
* @param args.options - Optional parameters for generating the transaction.
*
* @returns A SimpleTransaction that can be simulated or submitted to the chain.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Transfer fungible asset from sender to recipient
* const transaction = await aptos.transferFungibleAsset({
* sender: Account.generate(), // replace with a real sender account
* fungibleAssetMetadataAddress: "0x123", // replace with a real fungible asset address
* recipient: "0x456", // replace with a real recipient account
* amount: 5
* });
*
* console.log(transaction);
* }
* runExample().catch(console.error);
* ```
*/
transferFungibleAsset(args: {
sender: Account;
fungibleAssetMetadataAddress: AccountAddressInput;
recipient: AccountAddressInput;
amount: AnyNumber;
options?: InputGenerateTransactionOptions;
}): Promise<SimpleTransaction>;
}
export { FungibleAsset };
Выполнить команду
Для локальной разработки. Не используйте в интернете!