@aptos-labs/ts-sdk 1.12.2 → 1.13.0

package/dist/common/index.d.ts

@@ -962,6 +962,7 @@ type ClientHeadersType = {
 interface ClientRequest<Req> {
     url: string;
     method: "GET" | "POST";
+    originMethod?: string;
     body?: Req;
     contentType?: string;
     params?: any;
@@ -3020,7 +3021,7 @@ declare class Ed25519PrivateKey extends Serializable implements PrivateKey {
      * The Ed25519 signing key
      * @private
      */
-    private readonly signingKeyPair;
+    private readonly signingKey;
     /**
      * Create a new PrivateKey instance from a Uint8Array or String.
      *
@@ -3104,6 +3105,13 @@ declare class Ed25519Signature extends Signature {
     toUint8Array(): Uint8Array;
     serialize(serializer: Serializer): void;
     static deserialize(deserializer: Deserializer): Ed25519Signature;
+    /**
+     * Checks if an ED25519 signature is non-canonical.
+     *
+     * Comes from Aptos Core
+     * https://github.com/aptos-labs/aptos-core/blob/main/crates/aptos-crypto/src/ed25519/ed25519_sigs.rs#L47-L85
+     */
+    isCanonicalSignature(): boolean;
 }
 
 type DerivedKeys = {
@@ -3440,6 +3448,11 @@ declare class Secp256k1PublicKey extends PublicKey {
      * @param hexInput A HexInput (string or Uint8Array)
      */
     constructor(hexInput: HexInput);
+    /**
+     * Verifies a Secp256k1 signature against the public key
+     *
+     * Note signatures are validated to be canonical as a malleability check
+     */
     verifySignature(args: VerifySignatureArgs): boolean;
     toUint8Array(): Uint8Array;
     serialize(serializer: Serializer): void;
@@ -3497,6 +3510,8 @@ declare class Secp256k1PrivateKey extends Serializable implements PrivateKey {
     /**
      * Sign the given message with the private key.
      *
+     * Note: signatures are canonical, and non-malleable
+     *
      * @param message a message as a string or Uint8Array
      * @returns Signature
      */
@@ -3986,6 +4001,10 @@ declare enum ProcessorType {
 
 /**
  * This class holds the config information for the SDK client instance.
+ *
+ * @example
+ *
+ * const aptosConfig = new AptosConfig({network:Network.TESTNET})
  */
 declare class AptosConfig {
     /**
@@ -4088,7 +4107,9 @@ declare class Account {
      *
      * @returns Account module
      *
-     * @example An example of an account module
+     * @example
+     * const module = await aptos.getAccountModule({accountAddress:"0x456"})
+     * // An example of an account module response
      * ```
      * {
      *    bytecode: "0xa11ceb0b0600000006010002030206050807070f0d081c200",
@@ -4107,6 +4128,9 @@ declare class Account {
      * Note: In order to get all account transactions, this function may call the API
      * multiple times as it auto paginates.
      *
+     * @example
+     * const transactions = await aptos.getAccountTransactions({accountAddress:"0x456"})
+     *
      * @param args.accountAddress Aptos account address
      * @param args.options.offset The number transaction to start returning results from
      * @param args.options.limit The number of results to return
@@ -4123,6 +4147,9 @@ declare class Account {
      * Note: In order to get all account resources, this function may call the API
      * multiple times as it auto paginates.
      *
+     * @example
+     * const resources = await aptos.getAccountResources({accountAddress:"0x456"})
+     *
      * @param args.accountAddress Aptos account address
      * @param args.options.offset The number resource to start returning results from
      * @param args.options.limit The number of results to return
@@ -4144,12 +4171,9 @@ declare class Account {
      *
      * @returns Account resource
      *
-     * @example An example of an account resource
-     * ```
-     * {
-     *    value: 6
-     * }
-     * ```
+     * @example
+     * const resource = await aptos.getAccountResource({accountAddress:"0x456"})
+     *
      */
     getAccountResource<T extends {} = any>(args: {
         accountAddress: AccountAddressInput;
@@ -4161,6 +4185,9 @@ declare class Account {
      *
      * This handles both if the account's authentication key has been rotated or not.
      *
+     * @example
+     * const accountAddress = await aptos.lookupOriginalAccountAddress({authenticationKey:account.accountAddress})
+     *
      * @param args.authenticationKey The authentication key
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
@@ -4174,6 +4201,9 @@ declare class Account {
     /**
      * Queries the current count of tokens owned by an account
      *
+     * @example
+     * const tokensCount = await aptos.getAccountTokensCount({accountAddress:"0x456"})
+     *
      * @param args.accountAddress The account address
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns Current count of tokens owned by the account
@@ -4188,6 +4218,9 @@ declare class Account {
      * This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc.
      * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
      *
+     * @example
+     * const accountOwnedTokens = await aptos.getAccountOwnedTokens({accountAddress:"0x456"})
+     *
      * @param args.accountAddress The account address we want to get the tokens for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @param args.options.tokenStandard The NFT standard to query for
@@ -4207,6 +4240,9 @@ declare class Account {
      * This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc.
      * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
      *
+     * @example
+     * const accountOwnedTokens = await aptos.getAccountOwnedTokensFromCollectionAddress({accountAddress:"0x123", collectionAddress:"0x456"})
+     *
      * @param args.accountAddress The account address we want to get the tokens for
      * @param args.collectionAddress The address of the collection being queried
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -4228,6 +4264,9 @@ declare class Account {
      * This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc.
      * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
      *
+     * @example
+     * const accountCollectionsWithOwnedTokens = await aptos.getAccountCollectionsWithOwnedTokens({accountAddress:"0x123"})
+     *
      * @param args.accountAddress The account address we want to get the collections for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @param args.options.tokenStandard The NFT standard to query for
@@ -4244,6 +4283,9 @@ declare class Account {
     /**
      * Queries the current count of transactions submitted by an account
      *
+     * @example
+     * const accountTransactionsCount = await aptos.getAccountTransactionsCount({accountAddress:"0x123"})
+     *
      * @param args.accountAddress The account address we want to get the total count for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns Current count of transactions made by an account
@@ -4255,6 +4297,9 @@ declare class Account {
     /**
      * Queries an account's coins data
      *
+     * @example
+     * const accountCoinsData = await aptos.getAccountCoinsData({accountAddress:"0x123"})
+     *
      * @param args.accountAddress The account address we want to get the coins data for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @param args.options.offset optional. The number coin to start returning results from
@@ -4271,6 +4316,9 @@ declare class Account {
     /**
      * Queries the current count of an account's coins aggregated
      *
+     * @example
+     * const accountCoinsCount = await aptos.getAccountCoinsCount({accountAddress:"0x123"})
+     *
      * @param args.accountAddress The account address we want to get the total count for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns Current count of the aggregated count of all account's coins
@@ -4282,6 +4330,9 @@ declare class Account {
     /**
      * Queries the account's APT amount
      *
+     * @example
+     * const accountAPTAmount = await aptos.getAccountAPTAmount({accountAddress:"0x123"})
+     *
      * @param args.accountAddress The account address we want to get the total count for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns Current amount of account's APT
@@ -4293,6 +4344,9 @@ declare class Account {
     /**
      * Queries the account's coin amount by the coin type
      *
+     * @example
+     * const accountCoinAmount = await aptos.getAccountCoinAmount({accountAddress:"0x123", coinType:"0x1::aptos_coin::AptosCoin"})
+     *
      * @param args.accountAddress The account address we want to get the total count for
      * @param args.coinType The coin type to query
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -4306,6 +4360,9 @@ declare class Account {
     /**
      * Queries an account's owned objects
      *
+     * @example
+     * const accountOwnedObjects = await aptos.getAccountOwnedObjects({accountAddress:"0x123"})
+     *
      * @param args.accountAddress The account address we want to get the objects for
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @param args.options.offset The starting position to start returning results from
@@ -4329,6 +4386,9 @@ declare class Account {
      * whether it is a Legacy ED25519 key or a Unified ED25519 key. It then derives the account based
      * on that.
      *
+     * @example
+     * const account = await aptos.deriveAccountFromPrivateKey({privateKey:new Ed25519PrivateKey("0x123")})
+     *
      * @param args.privateKey An account private key
      * @returns Account type
      */
@@ -5156,6 +5216,13 @@ declare class Coin {
     /**
      * Generate a transfer coin transaction that can be simulated and/or signed and submitted
      *
+     * @example
+     * const transferCoinTransaction = await aptos.transferCoinTransaction({
+     * sender: "0x123",
+     * recipient:"0x456",
+     * amount: 10,
+     * })
+     *
      * @param args.sender The sender account
      * @param args.recipient The recipient address
      * @param args.amount The amount to transfer
@@ -5220,6 +5287,9 @@ declare class DigitalAsset {
      * If, for some reason, a creator account has 2 collections with the same name in v1 and v2,
      * can pass an optional `tokenStandard` parameter to query a specific standard
      *
+     * @example
+     * const collection = await aptos.getCollectionData({creatorAddress:"0x123",collectionName:"myCollection"})
+     *
      * @param args.creatorAddress the address of the collection's creator
      * @param args.collectionName the name of the collection
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -5235,6 +5305,9 @@ declare class DigitalAsset {
     /**
      * Queries data of a specific collection by the collection ID.
      *
+     * @example
+     * const collection = await aptos.getCollectionDataByCollectionId({collectionId:"0x123"})
+     *
      * @param args.collectionId the ID of the collection, it's the same thing as the address of the collection object
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns GetCollectionDataResponse response type
@@ -5249,6 +5322,9 @@ declare class DigitalAsset {
      * This is the same as the collection's object address in V2, but V1 does
      * not use objects, and does not have an address
      *
+     * @example
+     * const collection = await aptos.getCollectionId({creatorAddress:"0x123",collectionName:"myCollection"})
+     *
      * @param args.creatorAddress the address of the collection's creator
      * @param args.collectionName the name of the collection
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -5264,6 +5340,9 @@ declare class DigitalAsset {
     /**
      * Gets digital asset data given the address of a digital asset.
      *
+     * @example
+     * const digitalAsset = await aptos.getDigitalAssetData({digitalAssetAddress:"0x123"})
+     *
      * @param args.tokenAddress The address of the digital asset
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns GetTokenDataResponse containing relevant data to the digital asset.
@@ -5275,6 +5354,9 @@ declare class DigitalAsset {
     /**
      * Gets digital asset ownership data given the address of a digital asset.
      *
+     * @example
+     * const digitalAssetOwner = await aptos.getCurrentDigitalAssetOwnership({digitalAssetAddress:"0x123"})
+     *
      * @param args.tokenAddress The address of the digital asset
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      *
@@ -5287,6 +5369,9 @@ declare class DigitalAsset {
     /**
      * Gets the digital assets that the given address owns.
      *
+     * @example
+     * const digitalAssets = await aptos.getOwnedDigitalAssets({ownerAddress:"0x123"})
+     *
      * @param args.ownerAddress The address of the owner
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      *
@@ -5300,6 +5385,9 @@ declare class DigitalAsset {
     /**
      * Gets the activity data given the address of a digital asset.
      *
+     * @example
+     * const digitalAssetActivity = await aptos.getDigitalAssetActivity({digitalAssetAddress:"0x123"})
+     *
      * @param args.tokenAddress The address of the digital asset
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      *
@@ -5313,6 +5401,14 @@ declare class DigitalAsset {
     /**
      * Creates a new collection within the specified account
      *
+     * @example
+     * const transaction = await aptos.createCollectionTransaction({
+     *  creator: alice,
+     *  description: "collectionDescription",
+     *  name: "collectionName",
+     *  uri: "collection-uri.com",
+     * });
+     *
      * @param args.creator the account of the collection's creator
      * @param args.description the description of the collection
      * @param args.name the name of the collection
@@ -5346,6 +5442,15 @@ declare class DigitalAsset {
     /**
      * Create a transaction to mint a digital asset into the creators account within an existing collection.
      *
+     * @example
+     * const transaction = await aptos.mintDigitalAssetTransaction({
+     *  creator: alice,
+     *  description: "collectionDescription",
+     *  collection: "collectionName",
+     *  name: "digitalAssetName",
+     *  uri: "digital-asset-uri.com",
+     * });
+     *
      * @param args.creator the creator of the collection
      * @param args.collection the name of the collection the digital asset belongs to
      * @param args.description the description of the digital asset
@@ -5371,6 +5476,13 @@ declare class DigitalAsset {
      * We can transfer a digital asset only when the digital asset is not frozen
      * (i.e. owner transfer is not disabled such as for soul bound digital assets)
      *
+     * @example
+     * const transaction = await aptos.transferDigitalAssetTransaction({
+     *  sender: alice,
+     *  digitalAssetAddress: "0x123",
+     *  recipient: "0x456",
+     * });
+     *
      * @param args.sender The sender account of the current digital asset owner
      * @param args.digitalAssetAddress The digital asset address
      * @param args.recipient The recipient account address
@@ -5388,6 +5500,16 @@ declare class DigitalAsset {
     /**
      * Mint a soul bound digital asset into a recipient's account
      *
+     * @example
+     * const transaction = await aptos.mintSoulBoundTransaction({
+     *  account: alice,
+     *  collection: "collectionName",
+     *  description: "collectionDescription",
+     *  name: "digitalAssetName",
+     *  uri: "digital-asset-uri.com",
+     *  recipient: "0x123"
+     * });
+     *
      * @param args.account The account that mints the digital asset
      * @param args.collection The collection name that the digital asset belongs to
      * @param args.description The digital asset description
@@ -5406,7 +5528,7 @@ declare class DigitalAsset {
         description: string;
         name: string;
         uri: string;
-        recipient: AccountAddress;
+        recipient: AccountAddressInput;
         propertyKeys?: Array<string>;
         propertyTypes?: Array<PropertyType>;
         propertyValues?: Array<PropertyValue>;
@@ -5415,6 +5537,12 @@ declare class DigitalAsset {
     /**
      * Burn a digital asset by its creator
      *
+     * @example
+     * const transaction = await aptos.burnDigitalAssetTransaction({
+     *  creator: alice,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.creator The creator account
      * @param args.digitalAssetAddress The digital asset address
      *
@@ -5429,6 +5557,12 @@ declare class DigitalAsset {
     /**
      * Freeze digital asset transfer ability
      *
+     * @example
+     * const transaction = await aptos.freezeDigitalAssetTransaferTransaction({
+     *  creator: alice,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.creator The creator account
      * @param args.digitalAssetAddress The digital asset address
      *
@@ -5443,6 +5577,12 @@ declare class DigitalAsset {
     /**
      * Unfreeze digital asset transfer ability
      *
+     * @example
+     * const transaction = await aptos.unfreezeDigitalAssetTransaferTransaction({
+     *  creator: alice,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.creator The creator account
      * @param args.digitalAssetAddress The digital asset address
      *
@@ -5457,6 +5597,13 @@ declare class DigitalAsset {
     /**
      * Set the digital asset description
      *
+     * @example
+     * const transaction = await aptos.setDigitalAssetDescriptionTransaction({
+     *  creator: alice,
+     *  description: "digitalAssetDescription",
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.creator The creator account
      * @param args.description The digital asset description
      * @param args.digitalAssetAddress The digital asset address
@@ -5473,6 +5620,13 @@ declare class DigitalAsset {
     /**
      * Set the digital asset name
      *
+     * @example
+     * const transaction = await aptos.setDigitalAssetNameTransaction({
+     *  creator: alice,
+     *  name: "digitalAssetName",
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.creator The creator account
      * @param args.name The digital asset name
      * @param args.digitalAssetAddress The digital asset address
@@ -5489,6 +5643,13 @@ declare class DigitalAsset {
     /**
      * Set the digital asset name
      *
+     * @example
+     * const transaction = await aptos.setDigitalAssetURITransaction({
+     *  creator: alice,
+     *  uri: "digital-asset-uri.com",
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.creator The creator account
      * @param args.uri The digital asset uri
      * @param args.digitalAssetAddress The digital asset address
@@ -5505,6 +5666,15 @@ declare class DigitalAsset {
     /**
      * Add a digital asset property
      *
+     * @example
+     * const transaction = await aptos.addDigitalAssetPropertyTransaction({
+     *  creator: alice,
+     *  propertyKey: "newKey",
+     *  propertyType: "BOOLEAN",
+     *  propertyValue: true,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.account The account that mints the digital asset
      * @param args.digitalAssetAddress The digital asset address
      * @param args.propertyKey The property key for storing on-chain properties
@@ -5525,6 +5695,15 @@ declare class DigitalAsset {
     /**
      * Remove a digital asset property
      *
+     * @example
+     * const transaction = await aptos.removeDigitalAssetPropertyTransaction({
+     *  creator: alice,
+     *  propertyKey: "newKey",
+     *  propertyType: "BOOLEAN",
+     *  propertyValue: true,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.account The account that mints the digital asset
      * @param args.digitalAssetAddress The digital asset address
      * @param args.propertyKey The property key for storing on-chain properties
@@ -5545,6 +5724,15 @@ declare class DigitalAsset {
     /**
      * Update a digital asset property
      *
+     * @example
+     * const transaction = await aptos.updateDigitalAssetPropertyTransaction({
+     *  creator: alice,
+     *  propertyKey: "newKey",
+     *  propertyType: "BOOLEAN",
+     *  propertyValue: false,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.account The account that mints the digital asset
      * @param args.digitalAssetAddress The digital asset address
      * @param args.propertyKey The property key for storing on-chain properties
@@ -5565,6 +5753,15 @@ declare class DigitalAsset {
     /**
      * Add a typed digital asset property
      *
+     * @example
+     * const transaction = await aptos.addDigitalAssetTypedPropertyTransaction({
+     *  creator: alice,
+     *  propertyKey: "typedKey",
+     *  propertyType: "STRING",
+     *  propertyValue: "hello",
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.account The account that mints the digital asset
      * @param args.digitalAssetAddress The digital asset address
      * @param args.propertyKey The property key for storing on-chain properties
@@ -5585,6 +5782,15 @@ declare class DigitalAsset {
     /**
      * Update a typed digital asset property
      *
+     * @example
+     * const transaction = await aptos.updateDigitalAssetTypedPropertyTransaction({
+     *  creator: alice,
+     *  propertyKey: "typedKey",
+     *  propertyType: "U8",
+     *  propertyValue: 2,
+     *  digitalAssetAddress: "0x123",
+     * });
+     *
      * @param args.account The account that mints the digital asset
      * @param args.digitalAssetAddress The digital asset address
      * @param args.propertyKey The property key for storing on-chain properties
@@ -5613,6 +5819,9 @@ declare class Event {
     /**
      * Get module events by event type
      *
+     * @example
+     * const events = await aptos.getModuleEventsByEventType({eventType:"0x1::transaction_fee::FeeStatement"})
+     *
      * @param args.eventType - The event type
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      *
@@ -5626,6 +5835,9 @@ declare class Event {
     /**
      * Get events by creation number and an account address
      *
+     * @example
+     * const events = await aptos.getAccountEventsByCreationNumber({accountAddress:"0x123",creationNumber: 0})
+     *
      * @param args.accountAddress - The account address
      * @param args.creationNumber - The event creation number
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -5640,6 +5852,9 @@ declare class Event {
     /**
      * Get events by event type and an account address
      *
+     * @example
+     * const events = await aptos.getAccountEventsByEventType({accountAddress:"0x123",eventType: "0x1::transaction_fee::FeeStatement"})
+     *
      * @param args.accountAddress - The account address
      * @param args.eventType - The event type
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -5656,15 +5871,11 @@ declare class Event {
      * Get all events
      *
      * An optional `where` can be passed in to filter out the response.
-     *@param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @example
-     * ```
-     * { where:
-     *  {
-     *   transaction_version: { _eq: 123456 },
-     *  }
-     * }
-     * ```
+     * const events = await aptos.getEvents()
+     * // with filtering
+     * const events = await aptos.getEvents({options: { where: { account_address: { _eq: "0x123" } } }});
      *
      * @returns GetEventsQuery response type
      */
@@ -5684,6 +5895,9 @@ declare class Faucet {
      * This creates an account if it does not exist and mints the specified amount of
      * coins into that account
      *
+     * @example
+     * const transaction = await aptos.fundAccount({accountAddress:"0x123", amount: 100})
+     *
      * @param args.accountAddress Address of the account to fund
      * @param args.amount Amount of tokens to fund the account with
      * @param args.options Configuration options for waitForTransaction
@@ -5912,7 +6126,11 @@ declare class FungibleAsset {
     /**
      * Queries all fungible asset metadata.
      *
+     * @example
+     * const fungibleAsset = await aptos.getFungibleAssetMetadata()
+     *
      * @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
      */
@@ -5925,6 +6143,9 @@ declare class FungibleAsset {
      *
      * This query returns the fungible asset metadata for a specific fungible asset.
      *
+     * @example
+     * const fungibleAsset = await aptos.getFungibleAssetMetadataByAssetType({assetType:"0x123::test_coin::TestCoin"})
+     *
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @param args.assetType The asset type of the fungible asset.
      * e.g
@@ -5940,7 +6161,11 @@ declare class FungibleAsset {
     /**
      * Queries all fungible asset activities
      *
+     * @example
+     * const fungibleAssetActivities = await aptos.getFungibleAssetActivities()
+     *
      * @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
      */
@@ -5951,7 +6176,11 @@ declare class FungibleAsset {
     /**
      * Queries all fungible asset balances
      *
+     * @example
+     * const fungibleAssetBalances = await aptos.getCurrentFungibleAssetBalances()
+     *
      * @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
      */
@@ -5960,10 +6189,18 @@ declare class FungibleAsset {
         options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
     }): Promise<GetCurrentFungibleAssetBalancesResponse>;
     /**
-     *  Transfer `amount` of fungible asset from sender's primary store to recipient's primary store.
+     * Transfer `amount` of fungible asset from sender's primary store to recipient's primary store.
      *
      * Use this method to transfer any fungible asset including fungible token.
      *
+     * @example
+     * const transaction = await aptos.transferFungibleAsset({
+     *  sender: alice,
+     *  fungibleAssetMetadataAddress: "0x123",
+     *  recipient: "0x456",
+     *  amount: 5
+     * })
+     *
      * @param sender The sender account
      * @param fungibleAssetMetadataAddress The fungible asset account address.
      * For example if you’re transferring USDT this would be the USDT address
@@ -5974,8 +6211,8 @@ declare class FungibleAsset {
      */
     transferFungibleAsset(args: {
         sender: Account$1;
-        fungibleAssetMetadataAddress: AccountAddress;
-        recipient: AccountAddress;
+        fungibleAssetMetadataAddress: AccountAddressInput;
+        recipient: AccountAddressInput;
         amount: AnyNumber;
         options?: InputGenerateTransactionOptions;
     }): Promise<SimpleTransaction>;
@@ -5992,7 +6229,9 @@ declare class General {
      *
      * @returns Aptos Ledger Info
      *
-     * @example An example of the returned data
+     * @example
+     * const ledgerInfo = await aptos.getLedgerInfo()
+     * // an example of the returned data
      * ```
      * {
      * "chain_id": 4,
@@ -6011,12 +6250,18 @@ declare class General {
     /**
      * Queries for the chain id
      *
+     * @example
+     * const chainId = await aptos.getChainId()
+     *
      * @returns The chain id
      */
     getChainId(): Promise<number>;
     /**
      * Queries for block by transaction version
      *
+     * @example
+     * const block = await aptos.getBlockByVersion({ledgerVersion:5})
+     *
      * @param args.ledgerVersion Ledger version to lookup block information for
      * @param args.options.withTransactions If set to true, include all transactions in the block
      *
@@ -6031,6 +6276,9 @@ declare class General {
     /**
      * Get block by block height
      *
+     * @example
+     * const block = await aptos.getBlockByVersion({blockHeight:5})
+     *
      * @param args.blockHeight Block height to lookup.  Starts at 0
      * @param args.options.withTransactions If set to true, include all transactions in the block
      *
@@ -6045,17 +6293,21 @@ declare class General {
     /**
      * Queries for a table item for a table identified by the handle and the key for the item.
      * Key and value types need to be passed in to help with key serialization and value deserialization.
+     *
+     * @example https://api.devnet.aptoslabs.com/v1/accounts/0x1/resource/0x1::coin::CoinInfo%3C0x1::aptos_coin::AptosCoin%3E
+     * const tableItem = await aptos.getTableItem({
+     *  handle: "0x123",
+     *  data: {
+     *   key_type: "address", // Move type of table key
+     *   value_type: "u128", // Move type of table value
+     *   key: "0x619dc29a0aac8fa146714058e8dd6d2d0f3bdf5f6331907bf91f3acd81e6935" // Value of table key
+     *  },
+     * })
+     *
      * @param args.handle A pointer to where that table is stored
      * @param args.data Object that describes table item
      * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
      *
-     * @example https://api.devnet.aptoslabs.com/v1/accounts/0x1/resource/0x1::coin::CoinInfo%3C0x1::aptos_coin::AptosCoin%3E
-     * {
-     *  data.key_type = "address" // Move type of table key
-     *  data.value_type = "u128" // Move type of table value
-     *  data.key = "0x619dc29a0aac8fa146714058e8dd6d2d0f3bdf5f6331907bf91f3acd81e6935" // Value of table key
-     * }
-     *
      * @returns Table item value rendered in JSON
      */
     getTableItem<T>(args: {
@@ -6067,14 +6319,15 @@ declare class General {
      * Queries for a Move view function
      * @param args.payload Payload for the view function
      * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
+     *
      * @example
-     * `
-     * const payload: ViewRequest = {
-     *  function: "0x1::coin::balance",
-     *  typeArguments: ["0x1::aptos_coin::AptosCoin"],
-     *  functionArguments: [accountAddress],
-     * };
-     * `
+     * const data = await aptos.view({
+     *  payload: {
+     *   function: "0x1::coin::balance",
+     *   typeArguments: ["0x1::aptos_coin::AptosCoin"],
+     *   functionArguments: [accountAddress],
+     *  }
+     * })
      *
      * @returns an array of Move values
      */
@@ -6085,6 +6338,9 @@ declare class General {
     /**
      * Queries top user transactions
      *
+     * @example
+     * const topUserTransactions = await aptos.getChainTopUserTransactions({limit:5})
+     *
      * @param args.limit The number of transactions to return
      * @returns GetChainTopUserTransactionsResponse
      */
@@ -6096,18 +6352,16 @@ declare class General {
      * For more detailed queries specification see
      * {@link https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql}
      *
-     * @param args.query.query A GraphQL query
-     * @param args.query.variables The variables for the query
      * @example
-     * ```
-     * {
+     * const topUserTransactions = await aptos.queryIndexer({
      *  query: `query MyQuery {
-          ledger_infos {
-            chain_id
-          }
-        }`;
-     * }
-     * ```
+     *   ledger_infos {
+     *     chain_id
+     *   }}`;
+     * })
+     *
+     * @param args.query.query A GraphQL query
+     * @param args.query.variables The variables for the query
      *
      * @return The provided T type
      */
@@ -6118,11 +6372,17 @@ declare class General {
      * Queries for the last successful indexer version
      *
      * This is useful to tell what ledger version the indexer is updated to, as it can be behind the full nodes.
+     *
+     * @example
+     * const version = await aptos.getIndexerLastSuccessVersion()
      */
     getIndexerLastSuccessVersion(): Promise<bigint>;
     /**
      * Query the processor status for a specific processor type.
      *
+     * @example
+     * const status = await aptos.getProcessorStatus({processorType:"account_transactions_processor"})
+     *
      * @param processorType The processor type to query
      * @returns
      */
@@ -6179,11 +6439,10 @@ declare class ANS {
     /**
      * Retrieve the owner address of a domain name or subdomain name from the contract.
      *
-     * ```ts
+     * @example
      * // Will return the owner address of "test.aptos.apt" or undefined
      * const owner = await aptos.getOwnerAddress({name: "test.aptos"})
      * // owner = 0x123...
-     * ```
      *
      * @param args.name - A string of the name to retrieve
      *
@@ -6195,11 +6454,10 @@ declare class ANS {
     /**
      * Retrieve the expiration time of a domain name or subdomain name from the contract.
      *
-     * ```ts
+     * @example
      * // Will return the expiration of "test.aptos.apt" or undefined
      * const exp = await aptos.getExpiration({name: "test.aptos"})
      * // new Date(exp) would give you the date in question: 2021-01-01T00:00:00.000Z
-     * ```
      *
      * @param args.name - A string of the name to retrieve
      *
@@ -6213,10 +6471,9 @@ declare class ANS {
      * 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
      *
-     * ```ts
+     * @example
      * const targetAddr = await aptos.getTargetAddress({name: "test.aptos"})
      * // targetAddr = 0x123...
-     * ```
      *
      * @param args.name - A string of the name: primary, primary.apt, secondary.primary, secondary.primary.apt, etc.
      *
@@ -6230,11 +6487,10 @@ declare class ANS {
      * 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
      *
-     * ```ts
+     * @example
      * await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress})
      * const address = await aptos.getTargetAddress({name: "test.aptos"})
      * // address = bob.accountAddress
-     * ```
      *
      * @param args.name - A string of the name: test.aptos.apt, test.apt, test, test.aptos, etc.
      * @param args.address - A AccountAddressInput of the address to set the domain or subdomain to
@@ -6252,10 +6508,9 @@ declare class ANS {
      * multiple names that target it, but only a single name that is primary. An
      * account also may not have a primary name.
      *
-     * ```ts
+     * @example
      * const name = await aptos.getPrimaryName({address: alice.accountAddress})
      * // name = test.aptos
-     * ```
      *
      * @param args.address - A AccountAddressInput (address) of the account
      *
@@ -6269,11 +6524,10 @@ declare class ANS {
      * multiple names that target it, but only a single name that is primary. An
      * account also may not have a primary name.
      *
-     * ```ts
+     * @example
      * await aptos.setPrimaryName({sender: alice, name: "test.aptos"})
      * const primaryName = await aptos.getPrimaryName({address: alice.accountAddress})
      * // primaryName = test.aptos
-     * ```
      *
      * @param args.sender - The sender account
      * @param args.name - A string of the name: test, test.apt, test.aptos, test.aptos.apt, etc.
@@ -6288,7 +6542,7 @@ declare class ANS {
     /**
      * Registers a new name
      *
-     * ```ts
+     * @example
      * // An example of registering a subdomain name assuming def.apt is already registered
      * // and belongs to the sender alice.
      *  const txn = aptos.registerName({
@@ -6299,7 +6553,6 @@ declare class ANS {
      *      expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000,
      *    },
      *  });
-     * ```
      *
      * @param args.sender - The sender account
      * @param args.name - A string of the name to register. This can be inclusive or exclusive of the .apt suffix.
@@ -6326,10 +6579,9 @@ declare class ANS {
      *
      * Note: If a domain name was minted with V1 of the contract, it will automatically be upgraded to V2 via this transaction.
      *
-     * ```ts
+     * @example
      * await aptos.renewDomain({sender: alice, name: "test"})
      * // test.apt will be renewed for one year
-     * ```
      *
      * @param args.sender - The sender account
      * @param args.name - A string of the domain the subdomain will be under. The signer must be the domain owner.
@@ -6418,6 +6670,9 @@ declare class Staking {
     /**
      * Queries current number of delegators in a pool.  Throws an error if the pool is not found.
      *
+     * @example
+     * const delegators = await aptos.getNumberOfDelegators({poolAddress:"0x123"})
+     *
      * @param args.poolAddress Pool address
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns The number of delegators for the given pool
@@ -6429,6 +6684,9 @@ declare class Staking {
     /**
      * Queries current number of delegators in a pool.  Throws an error if the pool is not found.
      *
+     * @example
+     * const delegators = await aptos.getNumberOfDelegatorsForAllPools()
+     *
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @returns GetNumberOfDelegatorsForAllPoolsResponse response type
      */
@@ -6439,6 +6697,9 @@ declare class Staking {
     /**
      * Queries delegated staking activities
      *
+     * @example
+     * const delegators = await aptos.getDelegatedStakingActivities({delegatorAddress:"0x123",poolAddress:"0x456"})
+     *
      * @param args.delegatorAddress Delegator address
      * @param args.poolAddress Pool address
      * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -6889,6 +7150,9 @@ declare class Transaction {
      * Queries on-chain transactions. This function will not return pending
      * transactions. For that, use `getTransactionsByHash`.
      *
+     * @example
+     * const transactions = await aptos.getTransactions()
+     *
      * @param args.options.offset The number transaction to start with
      * @param args.options.limit Number of results to return
      *
@@ -6900,6 +7164,9 @@ declare class Transaction {
     /**
      * Queries on-chain transaction by version. This function will not return pending transactions.
      *
+     * @example
+     * const transaction = await aptos.getTransactions({ledgerVersion:1})
+     *
      * @param args.ledgerVersion - Transaction version is an unsigned 64-bit number.
      * @returns On-chain transaction. Only on-chain transactions have versions, so this
      * function cannot be used to query pending transactions.
@@ -6909,6 +7176,10 @@ declare class Transaction {
     }): Promise<TransactionResponse>;
     /**
      * Queries on-chain transaction by transaction hash. This function will return pending transactions.
+     *
+     * @example
+     * const transaction = await aptos.getTransactionByHash({transactionHash:"0x123"})
+     *
      * @param args.transactionHash - Transaction hash should be hex-encoded bytes string with 0x prefix.
      * @returns Transaction from mempool (pending) or on-chain (committed) transaction
      */
@@ -6924,6 +7195,9 @@ declare class Transaction {
      * 2. Apply hash algorithm SHA3-256 to the hash message bytes.
      * 3. Hex-encode the hash bytes with 0x prefix.
      *
+     * @example
+     * const isPendingTransaction = await aptos.isPendingTransaction({transactionHash:"0x123"})
+     *
      * @param args.transactionHash A hash of transaction
      * @returns `true` if transaction is in pending state and `false` otherwise
      */
@@ -6945,6 +7219,8 @@ declare class Transaction {
      * 4. Transaction does not move past the pending state within `args.options.timeoutSecs` seconds.
      *    - The function will throw a WaitForTransactionError
      *
+     * @example
+     * const transaction = await aptos.waitForTransaction({transactionHash:"0x123"})
      *
      * @param args.transactionHash The hash of a transaction previously submitted to the blockchain.
      * @param args.options.timeoutSecs Timeout in seconds. Defaults to 20 seconds.
@@ -6962,14 +7238,9 @@ declare class Transaction {
      * For more information {@link https://api.mainnet.aptoslabs.com/v1/spec#/operations/estimate_gas_price}
      *
      * @returns Object holding the outputs of the estimate gas API
+     *
      * @example
-     * ```
-     * {
-     *  gas_estimate: number;
-     *  deprioritized_gas_estimate?: number;
-     *  prioritized_gas_estimate?: number;
-     * }
-     * ```
+     * const gasPrice = await aptos.waitForTransaction()
      */
     getGasPriceEstimation(): Promise<GasEstimation>;
     /**
@@ -6977,6 +7248,11 @@ declare class Transaction {
      *
      * This allows a user to sign a transaction using their own preferred signing method, and
      * then submit it to the network.
+     *
+     * @example
+     * const transaction = await aptos.transaction.build.simple({...})
+     * const message = await aptos.getSigningMessage({transaction})
+     *
      * @param args.transaction A raw transaction for signing elsewhere
      */
     getSigningMessage(args: {
@@ -6989,6 +7265,13 @@ declare class Transaction {
      * `aptos move compile --save-metadata ...`,
      * For more info {@link https://aptos.dev/tutorials/your-first-dapp/#step-4-publish-a-move-module}
      *
+     * @example
+     * const transaction = await aptos.publishPackageTransaction({
+     *  account: alice,
+     *  metadataBytes,
+     *  moduleBytecode: [byteCode],
+     * })
+     *
      * @param args.account The publisher account
      * @param args.metadataBytes The package metadata bytes
      * @param args.moduleBytecode An array of the bytecode of each module in the package in compiler output order
@@ -7006,6 +7289,13 @@ declare class Transaction {
      * the account.
      * Note: Only legacy Ed25519 scheme is supported for now.
      * More info: {@link https://aptos.dev/guides/account-management/key-rotation/}
+     *
+     * @example
+     * const response = await aptos.rotateAuthKey({
+     *  fromAccount: alice,
+     *  toNewPrivateKey: new ED25519PublicKey("0x123"),
+     * })
+     *
      * @param args.fromAccount The account to rotate the auth key for
      * @param args.toNewPrivateKey The new private key to rotate to
      *
@@ -7018,6 +7308,13 @@ declare class Transaction {
     /**
      * Sign a transaction that can later be submitted to chain
      *
+     * @example
+     * const transaction = await aptos.transaction.build.simple({...})
+     * const transaction = await aptos.transaction.sign({
+     *  signer: alice,
+     *  transaction
+     * })
+     *
      * @param args.signer The signer account
      * @param args.transaction A raw transaction to sign on
      *
@@ -7030,6 +7327,13 @@ declare class Transaction {
     /**
      * Sign a transaction as a fee payer that can later be submitted to chain
      *
+     * @example
+     * const transaction = await aptos.transaction.build.simple({...})
+     * const transaction = await aptos.transaction.signAsFeePayer({
+     *  signer: alice,
+     *  transaction
+     * })
+     *
      * @param args.signer The fee payer signer account
      * @param args.transaction A raw transaction to sign on
      *
@@ -7067,13 +7371,13 @@ declare class Transaction {
      *
      * @param args.signer The signer account to sign the transaction
      * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
-     * ```
-     * {
-     *  rawTransaction: RawTransaction,
-     *  secondarySignerAddresses? : Array<AccountAddress>,
-     *  feePayerAddress?: AccountAddress
-     * }
-     * ```
+     *
+     * @example
+     * const transaction = await aptos.transaction.build.simple({...})
+     * const transaction = await aptos.signAndSubmitTransaction({
+     *  signer: alice,
+     *  transaction
+     * })
      *
      * @return PendingTransactionResponse
      */
@@ -7089,6 +7393,10 @@ declare class Transaction {
  *
  * To use the SDK, create a new Aptos instance to get access
  * to all the sdk functionality.
+ *
+ * @example
+ *
+ * const aptos = new Aptos();
  */
 declare class Aptos {
     readonly config: AptosConfig;