@aptos-labs/ts-sdk
Version:
Aptos TypeScript SDK
117 lines • 4.61 kB
TypeScript
/**
* Types of API endpoints used for routing requests in the Aptos network.
* @group Implementation
* @category Utils
*/
export declare enum AptosApiType {
FULLNODE = "Fullnode",
INDEXER = "Indexer",
FAUCET = "Faucet",
PEPPER = "Pepper",
PROVER = "Prover"
}
/**
* The default max gas amount when none is given.
*
* This is the maximum number of gas units that will be used by a transaction before being rejected.
*
* Note that max gas amount varies based on the transaction. A larger transaction will go over this
* default gas amount, and the value will need to be changed for the specific transaction.
* @group Implementation
* @category Utils
*/
export declare const DEFAULT_MAX_GAS_AMOUNT = 2000000;
/**
* The minimum max gas amount that the SDK will allow for a transaction.
*
* This value acts as a floor to prevent transactions from being built with a max gas amount
* below the network's minimum transaction gas units, which would cause
* MAX_GAS_UNITS_BELOW_MIN_TRANSACTION_GAS_UNITS errors.
* @group Implementation
* @category Utils
*/
export declare const MIN_MAX_GAS_AMOUNT = 2000;
/**
* Minimum gas unit price (Octas per gas unit) for encrypted transactions.
* Encrypted transactions require 2× the network base minimum (100) because validators
* bear the decryption compute cost (aptos-core `encrypted_txn_min_price_per_gas_unit`,
* RELEASE_V1_45+). The node rejects encrypted submissions below this price.
*/
export declare const MIN_ENCRYPTED_TXN_GAS_UNIT_PRICE = 200;
/**
* The default transaction expiration seconds from now.
*
* This time is how long until the blockchain nodes will reject the transaction.
*
* Note that the transaction expiration time varies based on network connection and network load. It may need to be
* increased for the transaction to be processed.
* @group Implementation
* @category Utils
*/
export declare const DEFAULT_TXN_EXP_SEC_FROM_NOW = 20;
/**
* The default number of seconds to wait for a transaction to be processed.
*
* This time is the amount of time that the SDK will wait for a transaction to be processed when waiting for
* the results of the transaction. It may take longer based on network connection and network load.
* @group Implementation
* @category Utils
*/
export declare const DEFAULT_TXN_TIMEOUT_SEC = 20;
/**
* The default gas currency for the network.
* @group Implementation
* @category Utils
*/
export declare const APTOS_COIN = "0x1::aptos_coin::AptosCoin";
/**
* @group Implementation
* @category Utils
*/
export declare const APTOS_FA = "0x000000000000000000000000000000000000000000000000000000000000000a";
/**
* @group Implementation
* @category Utils
*/
export declare const RAW_TRANSACTION_SALT = "APTOS::RawTransaction";
/**
* @group Implementation
* @category Utils
*/
export declare const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
export declare const ACCOUNT_ABSTRACTION_SIGNING_DATA_SALT = "APTOS::AASigningData";
/**
* Supported processor types for the indexer API, sourced from the processor_status table in the indexer database.
* {@link https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql}
* @group Implementation
* @category Utils
*/
export declare enum ProcessorType {
ACCOUNT_RESTORATION_PROCESSOR = "account_restoration_processor",
ACCOUNT_TRANSACTION_PROCESSOR = "account_transactions_processor",
DEFAULT = "default_processor",
EVENTS_PROCESSOR = "events_processor",
FUNGIBLE_ASSET_PROCESSOR = "fungible_asset_processor",
STAKE_PROCESSOR = "stake_processor",
TOKEN_V2_PROCESSOR = "token_v2_processor",
USER_TRANSACTION_PROCESSOR = "user_transaction_processor",
OBJECT_PROCESSOR = "objects_processor"
}
/**
* Regular expression pattern for Firebase Auth issuer URLs
* Matches URLs in the format: https://securetoken.google.com/[project-id]
* where project-id can contain letters, numbers, hyphens, and underscores
*/
export declare const FIREBASE_AUTH_ISS_PATTERN: RegExp;
/**
* Shared TextEncoder instance for string serialization to avoid repeated instantiation.
*
* The explicit structural type prevents TypeScript from inferring `import("util").TextEncoder`
* (from `@types/node`) into the emitted `.d.ts`, which would force every SDK consumer to
* have `@types/node` installed. The SDK is runtime-agnostic (browser/Node/Bun/Deno/RN), so
* we expose only the minimal shape the SDK actually uses.
*/
export declare const TEXT_ENCODER: {
encode(input: string): Uint8Array;
};
//# sourceMappingURL=const.d.ts.map