From 34539a96eb51c2605f759ec3615624a8489988e9 Mon Sep 17 00:00:00 2001 From: Savely <136869149+savvar9991@users.noreply.github.com> Date: Sat, 28 Dec 2024 07:52:24 +1100 Subject: [PATCH] Correct Typos and Enhance Code Documentation (#607) * Update README.md * Update CHANGELOG.md * Update CONTRIBUTING.md --------- Co-authored-by: Greg Nazario --- CHANGELOG.md | 12 ++++++------ CONTRIBUTING.md | 4 ++-- README.md | 9 ++++----- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 242d6fb18..a463fe57e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,7 +21,7 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T # 1.32.1 (2024-11-11) - Add support for Firebase issuers in the `updateFederatedKeylessJwkSetTransaction` function -- [`Breaking`] Revert new `scriptComposer` api in transactionSubmission api to allower SDK callers to invoke multiple Move functions inside a same transaction and compose the calls dynamically. +- [`Breaking`] Revert new `scriptComposer` api in transactionSubmission api to allow SDK callers to invoke multiple Move functions inside a same transaction and compose the calls dynamically. # 1.32.0 (2024-11-08) @@ -177,11 +177,11 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T # 1.14.0 (2024-05-09) -- [`Fix`] fixed `trasnferFungibleAsset` function +- [`Fix`] fixed `transferFungibleAsset` function - Run all examples in CI -- Introcude cli `Move` class that holds `move` related commands +- Introduce cli `Move` class that holds `move` related commands - Add common cli commands - `move.init()`, `move.compile()`, `move.test()`, `move.publish()` -- [`Fix`] Fix `generateSigningMessage` to check type explicitly instead of using `intanceOf` +- [`Fix`] Fix `generateSigningMessage` to check type explicitly instead of using `instanceOf` - Remove `randomnet` from the known Network enum # 1.13.3 (2024-04-30) @@ -245,7 +245,7 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T # 1.9.1 (2024-02-28) -- [`Fix`] Remove decimals field from `CurrentTokenOwnershipFields` gql fragement +- [`Fix`] Remove decimals field from `CurrentTokenOwnershipFields` gql fragment # 1.9.0 (2024-02-27) @@ -304,7 +304,7 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T - Update dependencies in the Typescript SDK to keep up with latest changes - Updated @aptos-labs/aptos-client dependency - [`Breaking`] Hex string inputs to `vector` entry function arguments will now be interpreted as a string instead of hex -- String inputs to `vector` entry function arguments will now be interpeted as UTF-8 bytes +- String inputs to `vector` entry function arguments will now be interpreted as UTF-8 bytes - ArrayBuffer is now a possible input for `vector` entry function arguments ## 1.1.0 (2023-12-11) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dcae276de..5e300cfc3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ for full details. This page describes [our development process](#our-development ## Aptos SDK To contribute to the Aptos SDK implementation, first fork the [aptos-ts-sdk](https://github.com/aptos-labs/aptos-ts-sdk) -repository. For more information on how to fork see the [Github documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). +repository. For more information on how to fork see the [GitHub documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). ## Our Development Process @@ -155,7 +155,7 @@ After you pulled latest main, it is recommended to first do a dry-run to make su npm publish --dry-run ``` -This command gives us a preview of what we will be releasing to NPM, make sure it does not include hidden files or anything we dont want to publish. Also, compare the package size and the total files with what is on [npm](https://www.npmjs.com/package/@aptos-labs/ts-sdk) and validate it is resonable. +This command gives us a preview of what we will be releasing to NPM, make sure it does not include hidden files or anything we dont want to publish. Also, compare the package size and the total files with what is on [npm](https://www.npmjs.com/package/@aptos-labs/ts-sdk) and validate it is reasonable. Then, when we are ready to publish to NPM, simply run: diff --git a/README.md b/README.md index e92fc2ca3..b4b4ffef3 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ const privateKey = new Secp256k1PrivateKey("mySecp256k1privatekeystring"); // create an AccountAddress instance from the account address string const address = AccountAddress.from("myaccountaddressstring"); -// Derieve an account from private key and address +// Derive an account from private key and address const account = await Account.fromPrivateKeyAndAddress({ privateKey, address }); ``` @@ -136,7 +136,7 @@ import { } 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."); + console.log("This example will create two accounts (Alice and Bob) and send a transaction transferring APT to Bob's account."); // 0. Setup the client and test accounts const config = new AptosConfig({ network: Network.TESTNET }); @@ -220,13 +220,12 @@ It could be your `tsconfig.json` is not using `node`. Make sure your `moduleReso 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/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). +If neither of these describes what you would like to contribute, check 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 [npm-url]: https://npmjs.org/package/@aptos-labs/ts-sdk [experimental-url]: https://www.npmjs.com/package/@aptos-labs/ts-sdk/v/experimental -[discord-image]: https://img.shields.io/discord/945856774056083548?label=Discord&logo=discord&style=flat~~~~ +[discord-image]: https://img.shields.io/discord/945856774056083548?label=Discord&logo=discord&style=flat [discord-url]: https://discord.gg/aptosnetwork [github-license]: https://img.shields.io/github/license/aptos-labs/aptos-ts-sdk -[discord-url]: https://discord.gg/aptosnetwork