Aptos
Aptos is the main entry point to the SDK's APIs. Instantiate to access all functionalities.
Parameters
AptosConfig to optionally configure the SDK.
Properties
Functions
Add a property to a digital asset
Burn a digital asset by its creator
Creates a new collection within the specified account.
Freeze digital asset transfer ability
This creates an account if it does not exist and mints the specified amount of coins into that account
Queries the account's APT amount
Queries the account's coin amount by the coin type
Queries the current count of an account's coins aggregated
Queries an account's coins data
Queries the current state for an Aptos account given its account address
Queries for a specific account module given account address and module name
Queries for all modules in an account given an account address
Queries a specific account resource given an account address and resource name
Queries all account resources given an account address
Queries account transactions given an account address
Queries the current count of transactions submitted by an account
Queries for block by height
Queries for block by transaction version
Queries for the chain id
Queries top user transactions
Queries data of a specific collection by the collection creator address and the collection name.
Queries data of a specific collection by the collection ID.
Retrieve the expiration time of a domain name or subdomain name from the contract.
Gives an estimate of the gas unit price required to get a transaction on chain in a reasonable amount of time. For more information {@link https://api.mainnet.aptoslabs.com/v1/spec#/operations/estimate_gas_price}
Queries for the last successful indexer version
Queries for the Aptos ledger info
Queries current number of delegators in a pool. Throws an error if the pool is not found.
Retrieve the owner address of a domain name or subdomain name from the contract.
Retrieve the primary name for an account. An account can have multiple names that target it, but only a single name that is primary. An account also may not have a primary name.
Query the processor status for a specific processor type.
Retrieve the target address of a domain or subdomain name. This is the address the name points to for use on chain. Note, the target address can point to addresses that are not the owner of the name
Queries on-chain transaction by transaction hash. This function will return pending transactions.
Queries on-chain transaction by version. This function will not return pending transactions.
Queries on-chain transactions. This function will not return pending transactions. For that, use getTransactionsByHash
.
Returns the current graceFull setting.
Defines if specified transaction is currently in pending state
Create a transaction to mint a digital asset into the creators account within an existing collection.
Mint a soul bound digital asset.
Generates a transaction to publish a move package to chain.
A generic function for retrieving data from Aptos Indexer.
Remove a property from a digital asset
Set the digital asset description
Set the digital asset name
Set the digital asset URI
Sets the target address of a domain or subdomain name. This is the address the name points to for use on chain. Note, the target address can point to addresses that are not the owner of the name
Sign a transaction that can later be submitted to chain
Sign and submit a single signer transaction as the fee payer to chain given an authenticator by the sender of the transaction.
Sign and submit a single signer transaction to chain
Sign a transaction as a fee payer that can later be submitted to chain
Generates a Transaction that can be simulated and/or signed and submitted to the chain.
Transfer a digital asset (non-fungible digital asset) ownership.
Unfreeze digital asset transfer ability