@aptos-labs/ts-sdk 1.28.0 → 1.29.0

package/README.md

@@ -2,33 +2,23 @@
 
 ![License][github-license]
 [![Discord][discord-image]][discord-url]
-[![NPM Package Downloads][npm-image-downloads]][npm-url]
-
-### Reference Docs
- 1. For SDK documentation, check out the [TypeScript SDK documentation](https://aptos.dev/sdks/new-ts-sdk/)
- 2. For detailed reference documentation you can search, check out the [API reference documentation](https://aptos-labs.github.io/aptos-ts-sdk/) for the associated version.
- 3. For in-depth examples, check out the [examples](./examples) folder with ready-made `package.json` files to get you going quickly!
-
-### Latest Version
-
 [![NPM Package Version][npm-image-version]][npm-url]
 ![Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk)
 ![NPM bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk)
+[![NPM Package Downloads][npm-image-downloads]][npm-url]
 
-### Experimental Development Version
-
-[![NPM Experimental Version](https://img.shields.io/npm/v/%40aptos-labs/ts-sdk/experimental)][experimental-url]
-![Experimental Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk/experimental)
-![Experimental bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk/experimental)
+The [TypeScript SDK](https://www.npmjs.com/package/@aptos-labs/ts-sdk) allows you to connect, explore, and interact on the Aptos blockchain. You can use it to request data, send transactions, set up test environments, and more!
 
-The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a
-set of utility functions, classes, and types to simplify the integration process and enhance developer productivity.
+## Learn How To Use The TypeScript SDK
+### [Quickstart](https://aptos.dev/en/build/sdks/ts-sdk/quickstart)
+### [Tutorials](https://aptos.dev/en/build/sdks/ts-sdk)
+### [Examples](./examples)
+### [Reference Docs (For looking up specific functions)](https://aptos-labs.github.io/aptos-ts-sdk/)
 
-This repository supports version >= 0.0.0 of the [Aptos SDK npm package](https://www.npmjs.com/package/@aptos-labs/ts-sdk).
 
 ## Installation
 
-##### For use in Node.js or a web application
+### For use in Node.js or a web application
 
 Install with your favorite package manager such as npm, yarn, or pnpm:
 
@@ -36,7 +26,7 @@ Install with your favorite package manager such as npm, yarn, or pnpm:
 pnpm install @aptos-labs/ts-sdk
 ```
 
-##### For use in a browser (<= 1.9.1 version only)
+### For use in a browser (<= 1.9.1 version only)
 
 You can add the SDK to your web application using a script tag:
 
@@ -48,32 +38,30 @@ Then, the SDK can be accessed through `window.aptosSDK`.
 
 ## Usage
 
-Initialize `Aptos` to access the SDK API.
+Create an `Aptos` client in order to access the SDK's functionality.
 
 ```ts
-// initiate the main entry point into Aptos SDK
-const aptos = new Aptos();
-```
-
-If you want to pass in a custom config
+import {{ Aptos, AptosConfig, Network }} from "@aptos-labs/ts-sdk"
 
-```ts
-// an optional config information for the SDK client instance.
-const config = new AptosConfig({ network: Network.LOCAL }); // default network is devnet
+// You can use AptosConfig to choose which network to connect to
+const config = new AptosConfig({{ network: Network.TESTNET }});
+// Aptos is the main entrypoint for all functions
 const aptos = new Aptos(config);
 ```
 
-### Read data from chain
+### Reading Data From Onchain ([Guide](https://aptos.dev/en/build/sdks/ts-sdk/fetch-data-via-sdk))
 
 ---
 
 ```ts
+const fund = await aptos.getAccountInfo({ accountAddress: "0x123" });
 const modules = await aptos.getAccountModules({ accountAddress: "0x123" });
+const tokens = await aptos.getAccountOwnedTokens({ accountAddress: "0x123" });
 ```
 
 ### Account management (default to Ed25519)
 
-> Note: We introduce a Single Sender authentication (as introduced in [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263)). Generating an account defaults to Legacy Ed25519 authentication with the option to use the Single Sender unified authentication
+> Note: We introduce a Single Sender authentication (as introduced in [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263)). Generating an account defaults to Legacy Ed25519 authentication with the option to use the Single Sender unified authentication.
 
 ---
 
@@ -130,59 +118,92 @@ const mnemonic = "various float stumble...";
 const account = Account.fromDerivationPath({ path, mnemonic });
 ```
 
-### Submit transaction
+### Submit transaction ([Tutorial](https://aptos.dev/en/build/sdks/ts-sdk/building-transactions))
 
 ---
 
-#### Single Signer transaction
-
-Using transaction submission api
-
-```ts
-const alice: Account = Account.generate();
-const bobAddress = "0xb0b";
-// build transaction
-const transaction = await aptos.transaction.build.simple({
-  sender: alice.accountAddress,
-  data: {
-    function: "0x1::coin::transfer",
-    typeArguments: ["0x1::aptos_coin::AptosCoin"],
-    functionArguments: [bobAddress, 100],
-  },
-});
-
-// using sign and submit separately
-const senderAuthenticator = aptos.transaction.sign({ signer: alice, transaction });
-const committedTransaction = await aptos.transaction.submit.simple({ transaction, senderAuthenticator });
-
-// using signAndSubmit combined
-const committedTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
-```
-
-Using built in `transferCoinTransaction`
-
 ```ts
-const alice: Account = Account.generate();
-const bobAddress = "0xb0b";
-// build transaction
-const transaction = await aptos.transferCoinTransaction({
-  sender: alice,
-  recipient: bobAddress,
-  amount: 100,
-});
-
-const pendingTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
-```
-
-### Testing
-
-To run the SDK tests, simply run from the root of this repository:
-
-> Note: for a better experience, make sure there is no aptos local node process up and running (can check if there is a process running on port 8080).
-
-```bash
-pnpm i
-pnpm test
+/**
+ * This example shows how to use the Aptos SDK to send a transaction.
+ * Don't forget to install @aptos-labs/ts-sdk before running this example!
+ */
+ 
+import {
+    Account,
+    Aptos,
+    AptosConfig,
+    Network,
+} from "@aptos-labs/ts-sdk";
+ 
+async function example() {
+    console.log("This example will create two accounts (Alice and Bob) and send a transaction transfering APT to Bob's account.");
+ 
+    // 0. Setup the client and test accounts
+    const config = new AptosConfig({ network: Network.TESTNET });
+    const aptos = new Aptos(config);
+ 
+    let alice = Account.generate();
+    let bob = Account.generate();
+ 
+    console.log("=== Addresses ===\n");
+    console.log(`Alice's address is: ${alice.accountAddress}`);
+    console.log(`Bob's address is: ${bob.accountAddress}`);
+ 
+    console.log("\n=== Funding accounts ===\n");
+    await aptos.fundAccount({
+        accountAddress: alice.accountAddress,
+        amount: 100_000_000,
+    });  
+    await aptos.fundAccount({
+        accountAddress: bob.accountAddress,
+        amount: 100,
+    });
+    console.log("Funded Alice and Bob's accounts!")
+ 
+    // 1. Build
+    console.log("\n=== 1. Building the transaction ===\n");
+    const transaction = await aptos.transaction.build.simple({
+        sender: alice.accountAddress,
+        data: {
+        // All transactions on Aptos are implemented via smart contracts.
+        function: "0x1::aptos_account::transfer",
+        functionArguments: [bob.accountAddress, 100],
+        },
+    });
+    console.log("Built the transaction!")
+ 
+    // 2. Simulate (Optional)
+    console.log("\n === 2. Simulating Response (Optional) === \n")
+    const [userTransactionResponse] = await aptos.transaction.simulate.simple({
+        signerPublicKey: alice.publicKey,
+        transaction,
+    });
+    console.log(userTransactionResponse)
+ 
+    // 3. Sign
+    console.log("\n=== 3. Signing transaction ===\n");
+    const senderAuthenticator = aptos.transaction.sign({
+        signer: alice,
+        transaction,
+    });
+    console.log("Signed the transaction!")
+ 
+    // 4. Submit
+    console.log("\n=== 4. Submitting transaction ===\n");
+    const submittedTransaction = await aptos.transaction.submit.simple({
+        transaction,
+        senderAuthenticator,
+    });
+ 
+    console.log(`Submitted transaction hash: ${submittedTransaction.hash}`);
+ 
+    // 5. Wait for results
+    console.log("\n=== 5. Waiting for result of transaction ===\n");
+    const executedTransaction = await aptos.waitForTransaction({ transactionHash: submittedTransaction.hash });
+    console.log(executedTransaction)
+};
+ 
+example();
 ```
 
 ## Troubleshooting
@@ -193,13 +214,13 @@ If you see import error when you do this
 import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
 ```
 
-It could be your `tsconfig.json` is not incompatible, make sure your `moduleResolution` is set to `node` instead of `bundler`.
+It could be your `tsconfig.json` is not using `node`. Make sure your `moduleResolution` in the `tsconfig.json` is set to `node` instead of `bundler`.
 
 ## Contributing
 
 If you found a bug or would like to request a feature, please file an [issue](https://github.com/aptos-labs/aptos-ts-sdk/issues/new/choose).
-If, based on the discussion on an issue you would like to offer a code change, please make a [pull request](https://github.com/aptos-labs/aptos-ts-sdk/CONTRIBUTING.md).
-If neither of these describes what you would like to contribute, checkout out the [contributing guide](https://github.com/aptos-labs/aptos-ts-sdk/CONTRIBUTING.md).
+If, based on the discussion on an issue you would like to offer a code change, please make a [pull request](https://github.com/aptos-labs/aptos-ts-sdk/pulls).
+If neither of these describes what you would like to contribute, checkout out the [contributing guide](https://github.com/aptos-labs/aptos-ts-sdk/blob/main/CONTRIBUTING.md).
 
 [npm-image-version]: https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk.svg
 [npm-image-downloads]: https://img.shields.io/npm/dm/%40aptos-labs%2Fts-sdk.svg

package/dist/common/{accountAddress-OVl7-qVN.d.ts → accountAddress-DUCC2ffJ.d.ts}

@@ -584,7 +584,8 @@ declare enum AccountAuthenticatorVariant {
 declare enum AnyPublicKeyVariant {
     Ed25519 = 0,
     Secp256k1 = 1,
-    Keyless = 3
+    Keyless = 3,
+    FederatedKeyless = 4
 }
 declare enum AnySignatureVariant {
     Ed25519 = 0,
@@ -1307,6 +1308,12 @@ type MoveStruct = {
      * Whether the struct is a native struct of Move
      */
     is_native: boolean;
+    /**
+     * Whether the struct is a module event (aka v2 event). This will be false for v1
+     * events because the value is derived from the #[event] attribute on the struct in
+     * the Move source code. This attribute is only relevant for v2 events.
+     */
+    is_event: boolean;
     /**
      * Abilities associated with the struct
      */
@@ -2273,4 +2280,4 @@ declare class AccountAddress extends Serializable implements TransactionArgument
     equals(other: AccountAddress): boolean;
 }
 
-export { type GetEventsResponse as $, type AnyNumber as A, type GetAccountOwnedTokensFromCollectionResponse as B, type Client as C, Deserializer as D, type EntryFunctionArgument as E, type FullNodeConfig as F, type GetAccountOwnedTokensQueryResponse as G, type HexInput as H, type IndexerConfig as I, type GetAccountCollectionsWithOwnedTokenResponse as J, type GetAccountCoinsDataResponse as K, type LedgerVersionArg as L, type MoveModuleId as M, Network as N, type OrderByArg as O, type PaginationArgs as P, type GetObjectDataQueryResponse as Q, type GetCollectionDataResponse as R, Serializable as S, type TransactionArgument as T, type Uint8 as U, type GetTokenDataResponse as V, type WhereArg as W, type GetCurrentTokenOwnershipResponse as X, type GetOwnedTokensResponse as Y, ZkpVariant as Z, type GetTokenActivityResponse as _, Serializer as a, type WriteSetChangeWriteTableItem as a$, type WaitForTransactionOptions as a0, type UserTransactionResponse as a1, type MoveFunction as a2, type GetFungibleAssetMetadataResponse as a3, type GetFungibleAssetActivitiesResponse as a4, type GetCurrentFungibleAssetBalancesResponse as a5, type LedgerInfo as a6, type Block as a7, type GetChainTopUserTransactionsResponse as a8, type GraphqlQuery as a9, AccountAuthenticatorVariant as aA, AnySignatureVariant as aB, EphemeralSignatureVariant as aC, type Uint64 as aD, type Uint128 as aE, type Uint256 as aF, type ClientHeadersType as aG, TransactionResponseType as aH, isPendingTransactionResponse as aI, isUserTransactionResponse as aJ, isGenesisTransactionResponse as aK, isBlockMetadataTransactionResponse as aL, isStateCheckpointTransactionResponse as aM, isValidatorTransactionResponse as aN, isBlockEpilogueTransactionResponse as aO, type GenesisTransactionResponse as aP, type BlockMetadataTransactionResponse as aQ, type StateCheckpointTransactionResponse as aR, type ValidatorTransactionResponse as aS, type BlockEndInfo as aT, type BlockEpilogueTransactionResponse as aU, type WriteSetChange as aV, type WriteSetChangeDeleteModule as aW, type WriteSetChangeDeleteResource as aX, type WriteSetChangeDeleteTableItem as aY, type WriteSetChangeWriteModule as aZ, type WriteSetChangeWriteResource as a_, type GetProcessorStatusResponse as aa, type GetANSNameResponse as ab, type GetNumberOfDelegatorsResponse as ac, type GetDelegatedStakingActivitiesResponse as ad, type PendingTransactionResponse as ae, type CommittedTransactionResponse as af, type GasEstimation as ag, type TableItemRequest as ah, type GetTableItemsDataResponse as ai, type GetTableItemsMetadataResponse as aj, type AptosRequest as ak, type ClientRequest as al, type ClientResponse as am, MimeType as an, ensureBoolean as ao, outOfRangeErrorMessage as ap, validateNumberInRange as aq, AddressInvalidReason as ar, ParsingError as as, type ParsingResult as at, HexInvalidReason as au, TypeTagVariants as av, ScriptTransactionArgumentVariants as aw, TransactionPayloadVariants as ax, TransactionVariants as ay, TransactionAuthenticatorVariant as az, type Uint16 as b, type DecodedTableData as b0, type DeletedTableData as b1, type TransactionPayloadResponse as b2, type EntryFunctionPayloadResponse as b3, type ScriptPayloadResponse as b4, type MultisigPayloadResponse as b5, type GenesisPayload as b6, type MoveScriptBytecode as b7, type TransactionSignature as b8, isEd25519Signature as b9, MoveFunctionVisibility as bA, MoveAbility as bB, type MoveStructField as bC, type MoveModule as bD, type MoveStruct as bE, RoleType as bF, DeriveScheme as bG, type GenerateAccountWithEd25519 as bH, type GenerateAccountWithSingleSignerSecp256k1Key as bI, type GenerateAccount as bJ, type OrderBy as bK, type OrderByValue as bL, type TokenStandard as bM, NetworkToIndexerAPI as bN, NetworkToNodeAPI as bO, NetworkToFaucetAPI as bP, NetworkToPepperAPI as bQ, NetworkToProverAPI as bR, NetworkToChainId as bS, NetworkToNetworkName as bT, isSecp256k1Signature as ba, isMultiAgentSignature as bb, isFeePayerSignature as bc, isMultiEd25519Signature as bd, type TransactionEd25519Signature as be, type TransactionSecp256k1Signature as bf, type TransactionMultiEd25519Signature as bg, type TransactionMultiAgentSignature as bh, type TransactionFeePayerSignature as bi, type AccountSignature as bj, type WriteSet as bk, type ScriptWriteSet as bl, type DirectWriteSet as bm, type EventGuid as bn, type Event as bo, type MoveUint8Type as bp, type MoveUint16Type as bq, type MoveUint32Type as br, type MoveUint64Type as bs, type MoveUint128Type as bt, type MoveUint256Type as bu, type MoveAddressType as bv, type MoveObjectType as bw, type MoveOptionType as bx, type MoveStructType as by, type MoveType as bz, type Uint32 as c, type Deserializable as d, Hex as e, type AuthenticationKeyScheme as f, AccountAddress as g, AnyPublicKeyVariant as h, EphemeralPublicKeyVariant as i, type ClientConfig as j, type FaucetConfig as k, type AptosSettings as l, EphemeralCertificateVariant as m, type ScriptFunctionArgument as n, type MoveFunctionId as o, type AccountAddressInput as p, type MoveStructId as q, type MoveValue as r, type MoveFunctionGenericTypeParam as s, SigningSchemeInput as t, SigningScheme as u, type AccountData as v, type MoveModuleBytecode as w, type TransactionResponse as x, type MoveResource as y, type TokenStandardArg as z };
+export { type GetEventsResponse as $, type AnyNumber as A, type GetAccountOwnedTokensFromCollectionResponse as B, type Client as C, Deserializer as D, type EntryFunctionArgument as E, type FullNodeConfig as F, type GetAccountOwnedTokensQueryResponse as G, type HexInput as H, type IndexerConfig as I, type GetAccountCollectionsWithOwnedTokenResponse as J, type GetAccountCoinsDataResponse as K, type LedgerVersionArg as L, type MoveModuleId as M, Network as N, type OrderByArg as O, type PaginationArgs as P, type GetObjectDataQueryResponse as Q, type GetCollectionDataResponse as R, Serializable as S, type TransactionArgument as T, type Uint8 as U, type GetTokenDataResponse as V, type WhereArg as W, type GetCurrentTokenOwnershipResponse as X, type GetOwnedTokensResponse as Y, ZkpVariant as Z, type GetTokenActivityResponse as _, Serializer as a, type WriteSetChangeWriteTableItem as a$, type WaitForTransactionOptions as a0, type UserTransactionResponse as a1, type MoveFunction as a2, type GetFungibleAssetMetadataResponse as a3, type GetFungibleAssetActivitiesResponse as a4, type GetCurrentFungibleAssetBalancesResponse as a5, type LedgerInfo as a6, type Block as a7, type GetChainTopUserTransactionsResponse as a8, type GraphqlQuery as a9, AccountAuthenticatorVariant as aA, AnySignatureVariant as aB, EphemeralSignatureVariant as aC, type Uint64 as aD, type Uint128 as aE, type Uint256 as aF, type ClientHeadersType as aG, TransactionResponseType as aH, isPendingTransactionResponse as aI, isUserTransactionResponse as aJ, isGenesisTransactionResponse as aK, isBlockMetadataTransactionResponse as aL, isStateCheckpointTransactionResponse as aM, isValidatorTransactionResponse as aN, isBlockEpilogueTransactionResponse as aO, type GenesisTransactionResponse as aP, type BlockMetadataTransactionResponse as aQ, type StateCheckpointTransactionResponse as aR, type ValidatorTransactionResponse as aS, type BlockEndInfo as aT, type BlockEpilogueTransactionResponse as aU, type WriteSetChange as aV, type WriteSetChangeDeleteModule as aW, type WriteSetChangeDeleteResource as aX, type WriteSetChangeDeleteTableItem as aY, type WriteSetChangeWriteModule as aZ, type WriteSetChangeWriteResource as a_, type GetProcessorStatusResponse as aa, type GetANSNameResponse as ab, type GetNumberOfDelegatorsResponse as ac, type GetDelegatedStakingActivitiesResponse as ad, type PendingTransactionResponse as ae, type CommittedTransactionResponse as af, type GasEstimation as ag, type TableItemRequest as ah, type GetTableItemsDataResponse as ai, type GetTableItemsMetadataResponse as aj, type AptosRequest as ak, type ClientRequest as al, type ClientResponse as am, MimeType as an, ensureBoolean as ao, outOfRangeErrorMessage as ap, validateNumberInRange as aq, AddressInvalidReason as ar, ParsingError as as, type ParsingResult as at, HexInvalidReason as au, TypeTagVariants as av, ScriptTransactionArgumentVariants as aw, TransactionPayloadVariants as ax, TransactionVariants as ay, TransactionAuthenticatorVariant as az, type Uint16 as b, type DecodedTableData as b0, type DeletedTableData as b1, type TransactionPayloadResponse as b2, type EntryFunctionPayloadResponse as b3, type ScriptPayloadResponse as b4, type MultisigPayloadResponse as b5, type GenesisPayload as b6, type MoveScriptBytecode as b7, type TransactionSignature as b8, isEd25519Signature as b9, MoveFunctionVisibility as bA, MoveAbility as bB, type MoveStructField as bC, type MoveModule as bD, type MoveStruct as bE, RoleType as bF, DeriveScheme as bG, type GenerateAccountWithEd25519 as bH, type GenerateAccountWithSingleSignerSecp256k1Key as bI, type GenerateAccount as bJ, type OrderBy as bK, type OrderByValue as bL, type TokenStandard as bM, NetworkToIndexerAPI as bN, NetworkToNodeAPI as bO, NetworkToFaucetAPI as bP, NetworkToPepperAPI as bQ, NetworkToProverAPI as bR, NetworkToChainId as bS, NetworkToNetworkName as bT, isSecp256k1Signature as ba, isMultiAgentSignature as bb, isFeePayerSignature as bc, isMultiEd25519Signature as bd, type TransactionEd25519Signature as be, type TransactionSecp256k1Signature as bf, type TransactionMultiEd25519Signature as bg, type TransactionMultiAgentSignature as bh, type TransactionFeePayerSignature as bi, type AccountSignature as bj, type WriteSet as bk, type ScriptWriteSet as bl, type DirectWriteSet as bm, type EventGuid as bn, type Event as bo, type MoveUint8Type as bp, type MoveUint16Type as bq, type MoveUint32Type as br, type MoveUint64Type as bs, type MoveUint128Type as bt, type MoveUint256Type as bu, type MoveAddressType as bv, type MoveObjectType as bw, type MoveOptionType as bx, type MoveStructType as by, type MoveType as bz, type Uint32 as c, type Deserializable as d, Hex as e, type AuthenticationKeyScheme as f, AccountAddress as g, AnyPublicKeyVariant as h, EphemeralPublicKeyVariant as i, type ClientConfig as j, type FaucetConfig as k, type AptosSettings as l, EphemeralCertificateVariant as m, type AccountAddressInput as n, type ScriptFunctionArgument as o, type MoveFunctionId as p, type MoveStructId as q, type MoveValue as r, type MoveFunctionGenericTypeParam as s, SigningSchemeInput as t, SigningScheme as u, type AccountData as v, type MoveModuleBytecode as w, type TransactionResponse as x, type MoveResource as y, type TokenStandardArg as z };

package/dist/common/cli/index.d.ts

@@ -1,5 +1,5 @@
 import { ChildProcessWithoutNullStreams } from 'child_process';
-import { N as Network, g as AccountAddress } from '../accountAddress-OVl7-qVN.js';
+import { N as Network, g as AccountAddress } from '../accountAddress-DUCC2ffJ.js';
 
 declare class LocalNode {
     readonly MAXIMUM_WAIT_TIME_SEC = 75;